(calendar-goto-french-date): Fix prompt to match the actual code.
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
b4990dde
GM
3;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
4;;; 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 70
5c6d31a4 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
ffc0e1ca
AS
87`backup-by-copying', `backup-by-copying-when-linked',
88`backup-by-copying-when-mismatch' and
89`backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
21540597
RS
90 :type 'boolean
91 :group 'backup)
b4da00e9
RM
92
93;; Do this so that local variables based on the file name
94;; are not overridden by the major mode.
95(defvar backup-inhibited nil
f862241d
RS
96 "Non-nil means don't make a backup, regardless of the other parameters.
97This variable is intended for use by making it local to a buffer.
98But it is local only if you make it local.")
b4da00e9
RM
99(put 'backup-inhibited 'permanent-local t)
100
21540597 101(defcustom backup-by-copying nil
b4da00e9 102 "*Non-nil means always use copying to create backup files.
21540597
RS
103See documentation of variable `make-backup-files'."
104 :type 'boolean
105 :group 'backup)
b4da00e9 106
21540597 107(defcustom backup-by-copying-when-linked nil
b4da00e9
RM
108 "*Non-nil means use copying to create backups for files with multiple names.
109This causes the alternate names to refer to the latest version as edited.
21540597
RS
110This variable is relevant only if `backup-by-copying' is nil."
111 :type 'boolean
112 :group 'backup)
b4da00e9 113
21540597 114(defcustom backup-by-copying-when-mismatch nil
b4da00e9
RM
115 "*Non-nil means create backups by copying if this preserves owner or group.
116Renaming may still be used (subject to control of other variables)
117when it would not result in changing the owner or group of the file;
118that is, for files which are owned by you and whose group matches
119the default for a new file created there by you.
21540597
RS
120This variable is relevant only if `backup-by-copying' is nil."
121 :type 'boolean
122 :group 'backup)
b4da00e9 123
ffc0e1ca
AS
124(defcustom backup-by-copying-when-privileged-mismatch 200
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126Renaming may still be used (subject to control of other variables)
127when it would not result in changing the owner of the file or if the owner
128has a user id greater than the value of this variable. This is useful
129when low-numbered uid's are used for special system users (such as root)
130that must maintain ownership of certain files.
131This variable is relevant only if `backup-by-copying' and
132`backup-by-copying-when-mismatch' are nil."
133 :type '(choice (const nil) integer)
134 :group 'backup)
135
ffc0e1ca 136(defvar backup-enable-predicate 'normal-backup-enable-predicate
b4da00e9 137 "Predicate that looks at a file name and decides whether to make backups.
37193ee6 138Called with an absolute file name as argument, it returns t to enable backup.")
b4da00e9 139
21540597 140(defcustom buffer-offer-save nil
ffc0e1ca
AS
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142Do so even if the buffer is not visiting a file.
21540597
RS
143Automatically local in all buffers."
144 :type 'boolean
145 :group 'backup)
b4da00e9
RM
146(make-variable-buffer-local 'buffer-offer-save)
147
21540597 148(defcustom find-file-existing-other-name t
f3e23606
RS
149 "*Non-nil means find a file under alternative names, in existing buffers.
150This means if any existing buffer is visiting the file you want
21540597
RS
151under another name, you get the existing buffer instead of a new buffer."
152 :type 'boolean
153 :group 'find-file)
f3e23606 154
21540597 155(defcustom find-file-visit-truename nil
f3e23606
RS
156 "*Non-nil means visit a file under its truename.
157The truename of a file is found by chasing all links
21540597
RS
158both at the file level and at the levels of the containing directories."
159 :type 'boolean
160 :group 'find-file)
f3e23606 161
db8c4866 162(defcustom revert-without-query
d7fa5aa2 163 nil
ebeb898f
RS
164 "*Specify which files should be reverted without query.
165The value is a list of regular expressions.
166If the file name matches one of these regular expressions,
db8c4866 167then `revert-buffer' reverts the file without querying
21540597 168if the file has changed on disk and you have not edited the buffer."
a0d809f2 169 :type '(repeat regexp)
21540597 170 :group 'find-file)
ebeb898f 171
f3e23606
RS
172(defvar buffer-file-number nil
173 "The device number and file number of the file visited in the current buffer.
174The value is a list of the form (FILENUM DEVNUM).
175This pair of numbers uniquely identifies the file.
176If the buffer is visiting a new file, the value is nil.")
177(make-variable-buffer-local 'buffer-file-number)
178(put 'buffer-file-number 'permanent-local t)
179
de88363f
RS
180(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
181 "Non-nil means that buffer-file-number uniquely identifies files.")
182
e554eeb7
RS
183(defvar buffer-file-read-only nil
184 "Non-nil if visited file was read-only when visited.")
185(make-variable-buffer-local 'buffer-file-read-only)
186
388d6ab5 187(defcustom temporary-file-directory
eb61b61b
RS
188 (file-name-as-directory
189 (cond ((memq system-type '(ms-dos windows-nt))
190 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
191 ((memq system-type '(vax-vms axp-vms))
192 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
193 (t
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
388d6ab5
RS
195 "The directory for writing temporary files."
196 :group 'files
197 :type 'directory)
eb61b61b 198
388d6ab5 199(defcustom small-temporary-file-directory
eb61b61b
RS
200 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
201 "The directory for writing small temporary files.
202If non-nil, this directory is used instead of `temporary-file-directory'
203by programs that create small temporary files. This is for systems that
388d6ab5
RS
204have fast storage with limited space, such as a RAM disk."
205 :group 'files
206 :type 'directory)
eb61b61b
RS
207
208;; The system null device. (Should reference NULL_DEVICE from C.)
209(defvar null-device "/dev/null" "The system null device.")
210
30966847
EZ
211(defvar file-name-invalid-regexp
212 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
9959c16e 213 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
30966847 214 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
edfc7f25 215 "[\000-\031]\\|" ; control characters
30966847
EZ
216 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
217 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
218 ((memq system-type '(ms-dos windows-nt))
9959c16e 219 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
106a57a4 220 "[|<>\"?*\000-\031]")) ; invalid characters
30966847
EZ
221 (t "[\000]"))
222 "Regexp recognizing file names which aren't allowed by the filesystem.")
223
21540597 224(defcustom file-precious-flag nil
b4da00e9 225 "*Non-nil means protect against I/O errors while saving files.
560f4415 226Some modes set this non-nil in particular buffers.
4b7271c1
KH
227
228This feature works by writing the new contents into a temporary file
229and then renaming the temporary file to replace the original.
230In this way, any I/O error in writing leaves the original untouched,
231and there is never any instant where the file is nonexistent.
232
233Note that this feature forces backups to be made by copying.
560f4415 234Yet, at the same time, saving a precious file
21540597
RS
235breaks any hard links between it and other files."
236 :type 'boolean
237 :group 'backup)
b4da00e9 238
21540597 239(defcustom version-control nil
b4da00e9
RM
240 "*Control use of version numbers for backup files.
241t means make numeric backup versions unconditionally.
242nil means make them for files that have some already.
21540597 243`never' means do not make them."
e48807d1
AS
244 :type '(choice (const :tag "Never" never)
245 (const :tag "If existing" nil)
246 (other :tag "Always" t))
21540597
RS
247 :group 'backup
248 :group 'vc)
249
250(defcustom dired-kept-versions 2
251 "*When cleaning directory, number of versions to keep."
252 :type 'integer
253 :group 'backup
254 :group 'dired)
255
256(defcustom delete-old-versions nil
de7d5e1b 257 "*If t, delete excess backup versions silently.
21540597
RS
258If nil, ask confirmation. Any other value prevents any trimming."
259 :type '(choice (const :tag "Delete" t)
260 (const :tag "Ask" nil)
e48807d1 261 (other :tag "Leave" other))
21540597
RS
262 :group 'backup)
263
264(defcustom kept-old-versions 2
265 "*Number of oldest versions to keep when a new numbered backup is made."
266 :type 'integer
267 :group 'backup)
268
269(defcustom kept-new-versions 2
b4da00e9 270 "*Number of newest versions to keep when a new numbered backup is made.
21540597
RS
271Includes the new backup. Must be > 0"
272 :type 'integer
273 :group 'backup)
b4da00e9 274
21540597 275(defcustom require-final-newline nil
b4da00e9
RM
276 "*Value of t says silently ensure a file ends in a newline when it is saved.
277Non-nil but not t says ask user whether to add a newline when there isn't one.
21540597 278nil means don't add newlines."
ad375092
RS
279 :type '(choice (const :tag "Off" nil)
280 (const :tag "Add" t)
e48807d1 281 (other :tag "Ask" ask))
21540597 282 :group 'editing-basics)
b4da00e9 283
21540597
RS
284(defcustom auto-save-default t
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
286 :type 'boolean
287 :group 'auto-save)
b4da00e9 288
21540597 289(defcustom auto-save-visited-file-name nil
b4da00e9 290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
21540597
RS
291Normally auto-save files are written under other names."
292 :type 'boolean
293 :group 'auto-save)
b4da00e9 294
ffc0e1ca 295(defcustom auto-save-file-name-transforms
a2899d6c
KG
296 `(("\\`/[^/]*:\\(.+/\\)*\\(.*\\)"
297 ,(expand-file-name "\\2" temporary-file-directory)))
ffc0e1ca
AS
298 "*Transforms to apply to buffer file name before making auto-save file name.
299Each transform is a list (REGEXP REPLACEMENT):
300REGEXP is a regular expression to match against the file name.
301If it matches, `replace-match' is used to replace the
302matching part with REPLACEMENT.
303All the transforms in the list are tried, in the order they are listed.
304When one transform applies, its result is final;
305no further transforms are tried.
306
a2899d6c
KG
307The default value is set up to put the auto-save file into the
308temporary directory (see the variable `temporary-file-directory') for
309editing a remote file."
ffc0e1ca
AS
310 :group 'auto-save
311 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")))
312 :version "21.1")
313
88b36776 314(defcustom save-abbrevs t
02c6a1cc
EZ
315 "*Non-nil means save word abbrevs too when files are saved.
316If `silently', don't ask the user before saving."
317 :type '(choice (const t) (const nil) (const silently))
21540597 318 :group 'abbrev)
b4da00e9 319
21540597 320(defcustom find-file-run-dired t
ffc0e1ca
AS
321 "*Non-nil means allow `find-file' to visit directories.
322To visit the directory, `find-file' runs `find-directory-functions'."
21540597
RS
323 :type 'boolean
324 :group 'find-file)
b4da00e9 325
ffc0e1ca
AS
326(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
327 "*List of functions to try in sequence to visit a directory.
328Each function is called with the directory name as the sole argument
329and should return either a buffer or nil."
330 :type '(hook :options (cvs-dired-noselect dired-noselect))
331 :group 'find-file)
332
92966e6f
RS
333;;;It is not useful to make this a local variable.
334;;;(put 'find-file-not-found-hooks 'permanent-local t)
b4da00e9
RM
335(defvar find-file-not-found-hooks nil
336 "List of functions to be called for `find-file' on nonexistent file.
337These functions are called as soon as the error is detected.
ffc0e1ca 338Variable `buffer-file-name' is already set up.
b4da00e9
RM
339The functions are called in the order given until one of them returns non-nil.")
340
92966e6f
RS
341;;;It is not useful to make this a local variable.
342;;;(put 'find-file-hooks 'permanent-local t)
b4da00e9
RM
343(defvar find-file-hooks nil
344 "List of functions to be called after a buffer is loaded from a file.
345The buffer's local variables (if any) will have been processed before the
346functions are called.")
347
b4da00e9
RM
348(defvar write-file-hooks nil
349 "List of functions to be called before writing out a buffer to a file.
350If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
351and the rest are not called.
352These hooks are considered to pertain to the visited file.
ffc0e1ca
AS
353So any buffer-local binding of `write-file-hooks' is
354discarded if you change the visited file name with \\[set-visited-file-name].
f82966e4
KH
355
356Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
357See also `write-contents-hooks'.")
b19f1da4
BF
358;;; However, in case someone does make it local...
359(put 'write-file-hooks 'permanent-local t)
c9dca4e0 360
c9dca4e0
RS
361(defvar local-write-file-hooks nil
362 "Just like `write-file-hooks', except intended for per-buffer use.
363The functions in this list are called before the ones in
f82966e4
KH
364`write-file-hooks'.
365
366This variable is meant to be used for hooks that have to do with a
367particular visited file. Therefore, it is a permanent local, so that
368changing the major mode does not clear it. However, calling
369`set-visited-file-name' does clear it.")
b19f1da4
BF
370(make-variable-buffer-local 'local-write-file-hooks)
371(put 'local-write-file-hooks 'permanent-local t)
8c0e7b73
JB
372
373(defvar write-contents-hooks nil
374 "List of functions to be called before writing out a buffer to a file.
375If one of them returns non-nil, the file is considered already written
376and the rest are not called.
f82966e4
KH
377
378This variable is meant to be used for hooks that pertain to the
379buffer's contents, not to the particular visited file; thus,
380`set-visited-file-name' does not clear this variable; but changing the
693f800d
RS
381major mode does clear it.
382
383This variable automatically becomes buffer-local whenever it is set.
659ebcc6 384If you use `add-hook' to add elements to the list, use nil for the
693f800d 385LOCAL argument.
f82966e4 386
8c0e7b73 387See also `write-file-hooks'.")
f82966e4 388(make-variable-buffer-local 'write-contents-hooks)
b4da00e9 389
21540597 390(defcustom enable-local-variables t
93a2702d 391 "*Control use of local variables in files you visit.
b4da00e9 392The value can be t, nil or something else.
93a2702d 393A value of t means file local variables specifications are obeyed;
b4da00e9 394nil means they are ignored; anything else means query.
aa5fcebf
KH
395This variable also controls use of major modes specified in
396a -*- line.
b4da00e9 397
aa5fcebf
KH
398The command \\[normal-mode], when used interactively,
399always obeys file local variable specifications and the -*- line,
400and ignores this variable."
21540597
RS
401 :type '(choice (const :tag "Obey" t)
402 (const :tag "Ignore" nil)
e48807d1 403 (other :tag "Query" other))
21540597 404 :group 'find-file)
b4da00e9 405
da09b92b
RS
406(defvar local-enable-local-variables t
407 "Like `enable-local-variables' but meant for buffer-local bindings.
aa5fcebf 408The meaningful values are nil and non-nil. The default is non-nil.
da09b92b 409If a major mode sets this to nil, buffer-locally, then any local
aa5fcebf
KH
410variables list in the file will be ignored.
411
412This variable does not affect the use of major modes
413specified in a -*- line.")
da09b92b 414
21540597 415(defcustom enable-local-eval 'maybe
d207b766
RS
416 "*Control processing of the \"variable\" `eval' in a file's local variables.
417The value can be t, nil or something else.
418A value of t means obey `eval' variables;
419nil means ignore them; anything else means query.
420
421The command \\[normal-mode] always obeys local-variables lists
21540597
RS
422and ignores this variable."
423 :type '(choice (const :tag "Obey" t)
424 (const :tag "Ignore" nil)
e48807d1 425 (other :tag "Query" other))
21540597 426 :group 'find-file)
b4da00e9
RM
427
428;; Avoid losing in versions where CLASH_DETECTION is disabled.
429(or (fboundp 'lock-buffer)
231c4e10 430 (defalias 'lock-buffer 'ignore))
b4da00e9 431(or (fboundp 'unlock-buffer)
231c4e10 432 (defalias 'unlock-buffer 'ignore))
a7305f6e
RS
433(or (fboundp 'file-locked-p)
434 (defalias 'file-locked-p 'ignore))
93fe0a35 435
2a9fe1e2
RS
436(defvar view-read-only nil
437 "*Non-nil means buffers visiting files read-only, do it in view mode.")
438
93fe0a35 439(defun ange-ftp-completion-hook-function (op &rest args)
ffc0e1ca
AS
440 "Provides support for ange-ftp host name completion.
441Runs the usual ange-ftp hook, but only for completion operations."
442 ;; Having this here avoids the need to load ange-ftp when it's not
443 ;; really in use.
93fe0a35
RS
444 (if (memq op '(file-name-completion file-name-all-completions))
445 (apply 'ange-ftp-hook-function op args)
57e81f57
RS
446 (let ((inhibit-file-name-handlers
447 (cons 'ange-ftp-completion-hook-function
448 (and (eq inhibit-file-name-operation op)
449 inhibit-file-name-handlers)))
450 (inhibit-file-name-operation op))
93fe0a35 451 (apply op args))))
567c1ca9
RS
452
453(defun convert-standard-filename (filename)
454 "Convert a standard file's name to something suitable for the current OS.
455This function's standard definition is trivial; it just returns the argument.
ffc0e1ca
AS
456However, on some systems, the function is redefined with a definition
457that really does change some file names to canonicalize certain
458patterns and to guarantee valid names."
567c1ca9 459 filename)
b4da00e9
RM
460\f
461(defun pwd ()
462 "Show the current default directory."
463 (interactive nil)
464 (message "Directory %s" default-directory))
465
231c4e10
ER
466(defvar cd-path nil
467 "Value of the CDPATH environment variable, as a list.
9ee45b2c 468Not actually set up until the first time you use it.")
231c4e10
ER
469
470(defun parse-colon-path (cd-path)
ffc0e1ca
AS
471 "Explode a colon-separated search path into a list of directory names.
472\(For values of `colon' equal to `path-separator'.)"
473 ;; We could use split-string here.
231c4e10
ER
474 (and cd-path
475 (let (cd-prefix cd-list (cd-start 0) cd-colon)
306faa42
RS
476 (setq cd-path (concat cd-path path-separator))
477 (while (setq cd-colon (string-match path-separator cd-path cd-start))
231c4e10 478 (setq cd-list
9daefb36 479 (nconc cd-list
c52e4104
RS
480 (list (if (= cd-start cd-colon)
481 nil
482 (substitute-in-file-name
e33e80e4
RS
483 (file-name-as-directory
484 (substring cd-path cd-start cd-colon)))))))
231c4e10
ER
485 (setq cd-start (+ cd-colon 1)))
486 cd-list)))
487
488(defun cd-absolute (dir)
30c5ce9c 489 "Change current directory to given absolute file name DIR."
f4a0f59b
RS
490 ;; Put the name into directory syntax now,
491 ;; because otherwise expand-file-name may give some bad results.
b4da00e9
RM
492 (if (not (eq system-type 'vax-vms))
493 (setq dir (file-name-as-directory dir)))
f4a0f59b 494 (setq dir (abbreviate-file-name (expand-file-name dir)))
b4da00e9 495 (if (not (file-directory-p dir))
83c6f446
RS
496 (if (file-exists-p dir)
497 (error "%s is not a directory" dir)
31c691c1 498 (error "%s: no such directory" dir))
b4da00e9
RM
499 (if (file-executable-p dir)
500 (setq default-directory dir)
9daefb36 501 (error "Cannot cd to %s: Permission denied" dir))))
b4da00e9 502
231c4e10
ER
503(defun cd (dir)
504 "Make DIR become the current buffer's default directory.
30c5ce9c
RS
505If your environment includes a `CDPATH' variable, try each one of that
506colon-separated list of directories when resolving a relative directory name."
dac4ea74
RS
507 (interactive
508 (list (read-file-name "Change default directory: "
2121cd9c
RM
509 default-directory default-directory
510 (and (member cd-path '(nil ("./")))
511 (null (getenv "CDPATH"))))))
30c5ce9c
RS
512 (if (file-name-absolute-p dir)
513 (cd-absolute (expand-file-name dir))
514 (if (null cd-path)
515 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
516 (setq cd-path (or trypath (list "./")))))
517 (if (not (catch 'found
518 (mapcar
519 (function (lambda (x)
520 (let ((f (expand-file-name (concat x dir))))
521 (if (file-directory-p f)
522 (progn
523 (cd-absolute f)
524 (throw 'found t))))))
525 cd-path)
526 nil))
527 (error "No such directory found via CDPATH environment variable"))))
231c4e10 528
b4da00e9
RM
529(defun load-file (file)
530 "Load the Lisp file named FILE."
58195faa
DL
531 ;; This is a case where .elc makes a lot of sense.
532 (interactive (list (let ((completion-ignored-extensions
9ab80679 533 (remove ".elc" completion-ignored-extensions)))
58195faa
DL
534 (read-file-name "Load file: "))))
535 (load (expand-file-name file) nil nil t))
b4da00e9
RM
536
537(defun load-library (library)
538 "Load the library named LIBRARY.
539This is an interface to the function `load'."
540 (interactive "sLoad library: ")
541 (load library))
5d68c2c2 542
ffc0e1ca 543(defun file-local-copy (file)
5d68c2c2
RS
544 "Copy the file FILE into a temporary file on this machine.
545Returns the name of the local copy, or nil, if FILE is directly
546accessible."
ffc0e1ca
AS
547 ;; This formerly had an optional BUFFER argument that wasn't used by
548 ;; anything.
6eaebaa2 549 (let ((handler (find-file-name-handler file 'file-local-copy)))
5d68c2c2
RS
550 (if handler
551 (funcall handler 'file-local-copy file)
552 nil)))
f3e23606 553
05ef1cda 554(defun file-truename (filename &optional counter prev-dirs)
f3e23606
RS
555 "Return the truename of FILENAME, which should be absolute.
556The truename of a file name is found by chasing symbolic links
557both at the level of the file and at the level of the directories
05ef1cda
RS
558containing it, until no links are left at any level.
559
560The arguments COUNTER and PREV-DIRS are used only in recursive calls.
561Do not specify them in other calls."
562 ;; COUNTER can be a cons cell whose car is the count of how many more links
563 ;; to chase before getting an error.
564 ;; PREV-DIRS can be a cons cell whose car is an alist
565 ;; of truenames we've just recently computed.
cc37a58c 566
cc37a58c
SM
567 ;; The last test looks dubious, maybe `+' is meant here? --simon.
568 (if (or (string= filename "") (string= filename "~")
7a5a26a6
RS
569 (and (string= (substring filename 0 1) "~")
570 (string-match "~[^/]*" filename)))
1cc2fbeb
RS
571 (progn
572 (setq filename (expand-file-name filename))
573 (if (string= filename "")
574 (setq filename "/"))))
05ef1cda 575 (or counter (setq counter (list 100)))
b505828b
RS
576 (let (done
577 ;; For speed, remove the ange-ftp completion handler from the list.
578 ;; We know it's not needed here.
579 ;; For even more speed, do this only on the outermost call.
580 (file-name-handler-alist
581 (if prev-dirs file-name-handler-alist
582 (let ((tem (copy-sequence file-name-handler-alist)))
583 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
584 (or prev-dirs (setq prev-dirs (list nil)))
b1667e6c
GV
585
586 ;; andrewi@harlequin.co.uk - none of the following code (except for
587 ;; invoking the file-name handler) currently applies on Windows
588 ;; (ie. there are no native symlinks), but there is an issue with
589 ;; case differences being ignored by the OS, and short "8.3 DOS"
590 ;; name aliases existing for all files. (The short names are not
591 ;; reported by directory-files, but can be used to refer to files.)
592 ;; It seems appropriate for file-truename to resolve these issues in
593 ;; the most natural way, which on Windows is to call the function
594 ;; `w32-long-file-name' - this returns the exact name of a file as
595 ;; it is stored on disk (expanding short name aliases with the full
596 ;; name in the process).
597 (if (eq system-type 'windows-nt)
598 (let ((handler (find-file-name-handler filename 'file-truename))
599 newname)
600 ;; For file name that has a special handler, call handler.
601 ;; This is so that ange-ftp can save time by doing a no-op.
602 (if handler
603 (setq filename (funcall handler 'file-truename filename))
604 ;; If filename contains a wildcard, newname will be the old name.
ffc0e1ca 605 (if (string-match "[[*?]" filename)
b1667e6c
GV
606 (setq newname filename)
607 ;; If filename doesn't exist, newname will be nil.
608 (setq newname (w32-long-file-name filename)))
609 (setq filename (or newname filename)))
610 (setq done t)))
611
05ef1cda
RS
612 ;; If this file directly leads to a link, process that iteratively
613 ;; so that we don't use lots of stack.
614 (while (not done)
615 (setcar counter (1- (car counter)))
616 (if (< (car counter) 0)
617 (error "Apparent cycle of symbolic links for %s" filename))
618 (let ((handler (find-file-name-handler filename 'file-truename)))
619 ;; For file name that has a special handler, call handler.
620 ;; This is so that ange-ftp can save time by doing a no-op.
621 (if handler
622 (setq filename (funcall handler 'file-truename filename)
623 done t)
fb145562 624 (let ((dir (or (file-name-directory filename) default-directory))
05ef1cda
RS
625 target dirfile)
626 ;; Get the truename of the directory.
627 (setq dirfile (directory-file-name dir))
628 ;; If these are equal, we have the (or a) root directory.
629 (or (string= dir dirfile)
630 ;; If this is the same dir we last got the truename for,
631 ;; save time--don't recalculate.
632 (if (assoc dir (car prev-dirs))
633 (setq dir (cdr (assoc dir (car prev-dirs))))
634 (let ((old dir)
635 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
636 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
637 (setq dir new))))
638 (if (equal ".." (file-name-nondirectory filename))
639 (setq filename
640 (directory-file-name (file-name-directory (directory-file-name dir)))
641 done t)
642 (if (equal "." (file-name-nondirectory filename))
643 (setq filename (directory-file-name dir)
644 done t)
645 ;; Put it back on the file name.
646 (setq filename (concat dir (file-name-nondirectory filename)))
647 ;; Is the file name the name of a link?
648 (setq target (file-symlink-p filename))
649 (if target
650 ;; Yes => chase that link, then start all over
651 ;; since the link may point to a directory name that uses links.
652 ;; We can't safely use expand-file-name here
653 ;; since target might look like foo/../bar where foo
654 ;; is itself a link. Instead, we handle . and .. above.
655 (setq filename
656 (if (file-name-absolute-p target)
657 target
658 (concat dir target))
659 done nil)
660 ;; No, we are done!
661 (setq done t))))))))
662 filename))
5dbfdacd 663
5dadeb29
RS
664(defun file-chase-links (filename)
665 "Chase links in FILENAME until a name that is not a link.
666Does not examine containing directories for links,
667unlike `file-truename'."
668 (let (tem (count 100) (newname filename))
669 (while (setq tem (file-symlink-p newname))
9695aac6
RS
670 (save-match-data
671 (if (= count 0)
672 (error "Apparent cycle of symbolic links for %s" filename))
673 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
674 (while (string-match "//+" tem)
675 (setq tem (replace-match "/" nil nil tem)))
676 ;; Handle `..' by hand, since it needs to work in the
677 ;; target of any directory symlink.
678 ;; This code is not quite complete; it does not handle
679 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
680 (while (string-match "\\`\\.\\./" tem)
681 (setq tem (substring tem 3))
682 (setq newname (expand-file-name newname))
683 ;; Chase links in the default dir of the symlink.
684 (setq newname
685 (file-chase-links
686 (directory-file-name (file-name-directory newname))))
687 ;; Now find the parent of that dir.
688 (setq newname (file-name-directory newname)))
689 (setq newname (expand-file-name tem (file-name-directory newname)))
690 (setq count (1- count))))
5dadeb29 691 newname))
b4da00e9 692\f
467ff692
RS
693(defun switch-to-buffer-other-window (buffer &optional norecord)
694 "Select buffer BUFFER in another window.
695Optional second arg NORECORD non-nil means
4c6a4739
EZ
696do not put this buffer at the front of the list of recently selected ones.
697
698This uses the function `display-buffer' as a subroutine; see its
699documentation for additional customization information."
b4da00e9
RM
700 (interactive "BSwitch to buffer in other window: ")
701 (let ((pop-up-windows t))
467ff692 702 (pop-to-buffer buffer t norecord)))
b4da00e9 703
467ff692
RS
704(defun switch-to-buffer-other-frame (buffer &optional norecord)
705 "Switch to buffer BUFFER in another frame.
706Optional second arg NORECORD non-nil means
4c6a4739
EZ
707do not put this buffer at the front of the list of recently selected ones.
708
709This uses the function `display-buffer' as a subroutine; see its
710documentation for additional customization information."
f98955ea
JB
711 (interactive "BSwitch to buffer in other frame: ")
712 (let ((pop-up-frames t))
467ff692 713 (pop-to-buffer buffer t norecord)
336b7f41 714 (raise-frame (window-frame (selected-window)))))
5bbbceb1 715
243ce842 716(defun find-file (filename &optional wildcards)
b4da00e9
RM
717 "Edit file FILENAME.
718Switch to a buffer visiting file FILENAME,
243ce842
RS
719creating one if none already exists.
720Interactively, or if WILDCARDS is non-nil in a call from Lisp,
ffc0e1ca
AS
721expand wildcards (if any) and visit multiple files. Wildcard expansion
722can be suppressed by setting `find-file-wildcards'."
243ce842 723 (interactive "FFind file: \np")
5b8ed07b
RS
724 (let ((value (find-file-noselect filename nil nil wildcards)))
725 (if (listp value)
726 (mapcar 'switch-to-buffer (nreverse value))
727 (switch-to-buffer value))))
82d0954a 728
243ce842 729(defun find-file-other-window (filename &optional wildcards)
b4da00e9
RM
730 "Edit file FILENAME, in another window.
731May create a new window, or reuse an existing one.
243ce842
RS
732See the function `display-buffer'.
733Interactively, or if WILDCARDS is non-nil in a call from Lisp,
734expand wildcards (if any) and visit multiple files."
735 (interactive "FFind file in other window: \np")
5b8ed07b
RS
736 (let ((value (find-file-noselect filename nil nil wildcards)))
737 (if (listp value)
738 (progn
739 (setq value (nreverse value))
740 (switch-to-buffer-other-window (car value))
741 (mapcar 'switch-to-buffer (cdr value)))
742 (switch-to-buffer-other-window value))))
243ce842
RS
743
744(defun find-file-other-frame (filename &optional wildcards)
f98955ea
JB
745 "Edit file FILENAME, in another frame.
746May create a new frame, or reuse an existing one.
243ce842
RS
747See the function `display-buffer'.
748Interactively, or if WILDCARDS is non-nil in a call from Lisp,
749expand wildcards (if any) and visit multiple files."
750 (interactive "FFind file in other frame: \np")
5b8ed07b
RS
751 (let ((value (find-file-noselect filename nil nil wildcards)))
752 (if (listp value)
753 (progn
754 (setq value (nreverse value))
755 (switch-to-buffer-other-frame (car value))
756 (mapcar 'switch-to-buffer (cdr value)))
757 (switch-to-buffer-other-frame value))))
243ce842
RS
758
759(defun find-file-read-only (filename &optional wildcards)
b4da00e9 760 "Edit file FILENAME but don't allow changes.
ffc0e1ca 761Like `find-file' but marks buffer as read-only.
b4da00e9 762Use \\[toggle-read-only] to permit editing."
243ce842
RS
763 (interactive "fFind file read-only: \np")
764 (find-file filename wildcards)
2a9fe1e2 765 (toggle-read-only 1)
320b4233 766 (current-buffer))
b4da00e9 767
243ce842 768(defun find-file-read-only-other-window (filename &optional wildcards)
b4da00e9
RM
769 "Edit file FILENAME in another window but don't allow changes.
770Like \\[find-file-other-window] but marks buffer as read-only.
771Use \\[toggle-read-only] to permit editing."
243ce842
RS
772 (interactive "fFind file read-only other window: \np")
773 (find-file-other-window filename wildcards)
2a9fe1e2 774 (toggle-read-only 1)
320b4233 775 (current-buffer))
b4da00e9 776
243ce842 777(defun find-file-read-only-other-frame (filename &optional wildcards)
f98955ea
JB
778 "Edit file FILENAME in another frame but don't allow changes.
779Like \\[find-file-other-frame] but marks buffer as read-only.
5bbbceb1 780Use \\[toggle-read-only] to permit editing."
243ce842
RS
781 (interactive "fFind file read-only other frame: \np")
782 (find-file-other-frame filename wildcards)
2a9fe1e2 783 (toggle-read-only 1)
320b4233 784 (current-buffer))
5bbbceb1 785
912192d1 786(defun find-alternate-file-other-window (filename)
60eaf370 787 "Find file FILENAME as a replacement for the file in the next window.
912192d1 788This command does not select that window."
60eaf370
RS
789 (interactive
790 (save-selected-window
791 (other-window 1)
792 (let ((file buffer-file-name)
793 (file-name nil)
794 (file-dir nil))
795 (and file
796 (setq file-name (file-name-nondirectory file)
797 file-dir (file-name-directory file)))
798 (list (read-file-name
912192d1 799 "Find alternate file: " file-dir nil nil file-name)))))
60eaf370 800 (if (one-window-p)
912192d1 801 (find-file-other-window filename)
60eaf370
RS
802 (save-selected-window
803 (other-window 1)
912192d1 804 (find-alternate-file filename))))
60eaf370 805
912192d1 806(defun find-alternate-file (filename)
b4da00e9
RM
807 "Find file FILENAME, select its buffer, kill previous buffer.
808If the current buffer now contains an empty file that you just visited
912192d1 809\(presumably by mistake), use this command to visit the file you really want."
b4da00e9
RM
810 (interactive
811 (let ((file buffer-file-name)
812 (file-name nil)
813 (file-dir nil))
814 (and file
815 (setq file-name (file-name-nondirectory file)
816 file-dir (file-name-directory file)))
a61f59b4 817 (list (read-file-name
912192d1 818 "Find alternate file: " file-dir nil nil file-name))))
2aa8cc2d 819 (and (buffer-modified-p) (buffer-file-name)
b4da00e9
RM
820 ;; (not buffer-read-only)
821 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
822 (buffer-name))))
823 (error "Aborted"))
824 (let ((obuf (current-buffer))
825 (ofile buffer-file-name)
8bb27285
RS
826 (onum buffer-file-number)
827 (otrue buffer-file-truename)
b4da00e9 828 (oname (buffer-name)))
baf9b8c4
RS
829 (if (get-buffer " **lose**")
830 (kill-buffer " **lose**"))
b4da00e9 831 (rename-buffer " **lose**")
b4da00e9
RM
832 (unwind-protect
833 (progn
834 (unlock-buffer)
a4ad4d96
RS
835 (setq buffer-file-name nil)
836 (setq buffer-file-number nil)
837 (setq buffer-file-truename nil)
912192d1 838 (find-file filename))
b4da00e9
RM
839 (cond ((eq obuf (current-buffer))
840 (setq buffer-file-name ofile)
8bb27285
RS
841 (setq buffer-file-number onum)
842 (setq buffer-file-truename otrue)
b4da00e9
RM
843 (lock-buffer)
844 (rename-buffer oname))))
845 (or (eq (current-buffer) obuf)
846 (kill-buffer obuf))))
9b8ef27d 847\f
b4da00e9
RM
848(defun create-file-buffer (filename)
849 "Create a suitably named buffer for visiting FILENAME, and return it.
850FILENAME (sans directory) is used unchanged if that name is free;
851otherwise a string <2> or <3> or ... is appended to get an unused name."
852 (let ((lastname (file-name-nondirectory filename)))
853 (if (string= lastname "")
854 (setq lastname filename))
855 (generate-new-buffer lastname)))
856
5bbbceb1
JB
857(defun generate-new-buffer (name)
858 "Create and return a buffer with a name based on NAME.
29165787 859Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
860 (get-buffer-create (generate-new-buffer-name name)))
861
ffc0e1ca
AS
862(defcustom automount-dir-prefix "^/tmp_mnt/"
863 "Regexp to match the automounter prefix in a directory name."
864 :group 'files
865 :type 'regexp)
e373f201 866
ffb3a4db 867(defvar abbreviated-home-dir nil
ffc0e1ca 868 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
ffb3a4db 869
5bbbceb1 870(defun abbreviate-file-name (filename)
29165787 871 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
5bbbceb1 872This also substitutes \"~\" for the user's home directory.
29165787 873Type \\[describe-variable] directory-abbrev-alist RET for more information."
e373f201 874 ;; Get rid of the prefixes added by the automounter.
a8f34fc0
RS
875 (if (and automount-dir-prefix
876 (string-match automount-dir-prefix filename)
e373f201
JB
877 (file-exists-p (file-name-directory
878 (substring filename (1- (match-end 0))))))
879 (setq filename (substring filename (1- (match-end 0)))))
5bbbceb1 880 (let ((tail directory-abbrev-alist))
ffb3a4db
RS
881 ;; If any elt of directory-abbrev-alist matches this name,
882 ;; abbreviate accordingly.
5bbbceb1
JB
883 (while tail
884 (if (string-match (car (car tail)) filename)
885 (setq filename
886 (concat (cdr (car tail)) (substring filename (match-end 0)))))
887 (setq tail (cdr tail)))
ffb3a4db
RS
888 ;; Compute and save the abbreviated homedir name.
889 ;; We defer computing this until the first time it's needed, to
890 ;; give time for directory-abbrev-alist to be set properly.
e98dda89
RS
891 ;; We include a slash at the end, to avoid spurious matches
892 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
ffb3a4db
RS
893 (or abbreviated-home-dir
894 (setq abbreviated-home-dir
895 (let ((abbreviated-home-dir "$foo"))
3a8a836d
RS
896 (concat "^" (abbreviate-file-name (expand-file-name "~"))
897 "\\(/\\|$\\)"))))
76d5492b 898
ffb3a4db
RS
899 ;; If FILENAME starts with the abbreviated homedir,
900 ;; make it start with `~' instead.
ca33ccb5
RS
901 (if (and (string-match abbreviated-home-dir filename)
902 ;; If the home dir is just /, don't change it.
903 (not (and (= (match-end 0) 1)
288201bd 904 (= (aref filename 0) ?/)))
567c1ca9
RS
905 ;; MS-DOS root directories can come with a drive letter;
906 ;; Novell Netware allows drive letters beyond `Z:'.
76d5492b 907 (not (and (or (eq system-type 'ms-dos)
c32d49e8 908 (eq system-type 'windows-nt))
288201bd 909 (save-match-data
567c1ca9 910 (string-match "^[a-zA-`]:/$" filename)))))
5bbbceb1 911 (setq filename
28dbf501 912 (concat "~"
3a8a836d 913 (substring filename (match-beginning 1) (match-end 1))
28dbf501 914 (substring filename (match-end 0)))))
5bbbceb1
JB
915 filename))
916
21540597 917(defcustom find-file-not-true-dirname-list nil
1770543d
RS
918 "*List of logical names for which visiting shouldn't save the true dirname.
919On VMS, when you visit a file using a logical name that searches a path,
920you may or may not want the visited file name to record the specific
921directory where the file was found. If you *do not* want that, add the logical
21540597
RS
922name to this list as a string."
923 :type '(repeat (string :tag "Name"))
924 :group 'find-file)
1770543d 925
138c44f6
KH
926(defun find-buffer-visiting (filename)
927 "Return the buffer visiting file FILENAME (a string).
928This is like `get-file-buffer', except that it checks for any buffer
929visiting the same file, possibly under a different name.
930If there is no such live buffer, return nil."
931 (let ((buf (get-file-buffer filename))
932 (truename (abbreviate-file-name (file-truename filename))))
933 (or buf
934 (let ((list (buffer-list)) found)
935 (while (and (not found) list)
936 (save-excursion
937 (set-buffer (car list))
938 (if (and buffer-file-name
939 (string= buffer-file-truename truename))
940 (setq found (car list))))
941 (setq list (cdr list)))
942 found)
d5798fa7
SM
943 (let* ((attributes (file-attributes truename))
944 (number (nthcdr 10 attributes))
945 (list (buffer-list)) found)
de88363f
RS
946 (and buffer-file-numbers-unique
947 number
181c830f 948 (while (and (not found) list)
d5798fa7 949 (with-current-buffer (car list)
d49ab5a0
RS
950 (if (and buffer-file-name
951 (equal buffer-file-number number)
181c830f
RS
952 ;; Verify this buffer's file number
953 ;; still belongs to its file.
954 (file-exists-p buffer-file-name)
d5798fa7
SM
955 (equal (file-attributes buffer-file-name)
956 attributes))
181c830f
RS
957 (setq found (car list))))
958 (setq list (cdr list))))
138c44f6 959 found))))
9b8ef27d 960\f
5de148a2
RS
961(defcustom find-file-wildcards t
962 "*Non-nil means file-visiting commands should handle wildcards.
963For example, if you specify `*.c', that would visit all the files
964whose names match the pattern."
965 :group 'files
3957c982 966 :version "20.4"
5de148a2
RS
967 :type 'boolean)
968
ffc0e1ca
AS
969(defcustom find-file-suppress-same-file-warnings nil
970 "*Non-nil means suppress warning messages for symlinked files.
971When nil, Emacs prints a warning when visiting a file that is already
972visited, but with a different name. Setting this option to t
973suppresses this warning."
974 :group 'files
975 :version "21.1"
976 :type 'boolean)
977
243ce842 978(defun find-file-noselect (filename &optional nowarn rawfile wildcards)
b4da00e9
RM
979 "Read file FILENAME into a buffer and return the buffer.
980If a buffer exists visiting FILENAME, return that one, but
981verify that the file has not changed since visited or saved.
82d0954a
KH
982The buffer is not selected, just returned to the caller.
983Optional first arg NOWARN non-nil means suppress any warning messages.
243ce842
RS
984Optional second arg RAWFILE non-nil means the file is read literally.
985Optional third arg WILDCARDS non-nil means do wildcard processing
5b8ed07b
RS
986and visit all the matching files. When wildcards are actually
987used and expanded, the value is a list of buffers
988that are visiting the various files."
e373f201
JB
989 (setq filename
990 (abbreviate-file-name
991 (expand-file-name filename)))
b4da00e9 992 (if (file-directory-p filename)
ffc0e1ca
AS
993 (or (and find-file-run-dired
994 (run-hook-with-args-until-success
995 'find-directory-functions
996 (if find-file-visit-truename
997 (abbreviate-file-name (file-truename filename))
998 filename)))
999 (error "%s is a directory" filename))
243ce842
RS
1000 (if (and wildcards
1001 find-file-wildcards
f91fe604 1002 (not (string-match "\\`/:" filename))
5de148a2 1003 (string-match "[[*?]" filename))
ffc0e1ca
AS
1004 (let ((files (condition-case nil
1005 (file-expand-wildcards filename t)
1006 (error (list filename))))
5de148a2 1007 (find-file-wildcards nil))
f91fe604 1008 (if (null files)
ffc0e1ca 1009 (find-file-noselect filename)
648ec2ff 1010 (mapcar #'find-file-noselect files)))
5de148a2
RS
1011 (let* ((buf (get-file-buffer filename))
1012 (truename (abbreviate-file-name (file-truename filename)))
1013 (number (nthcdr 10 (file-attributes truename)))
1014 ;; Find any buffer for a file which has same truename.
1015 (other (and (not buf) (find-buffer-visiting filename))))
1016 ;; Let user know if there is a buffer with the same truename.
1017 (if other
1018 (progn
1019 (or nowarn
ffc0e1ca 1020 find-file-suppress-same-file-warnings
5de148a2
RS
1021 (string-equal filename (buffer-file-name other))
1022 (message "%s and %s are the same file"
1023 filename (buffer-file-name other)))
1024 ;; Optionally also find that buffer.
1025 (if (or find-file-existing-other-name find-file-visit-truename)
1026 (setq buf other))))
1027 (if buf
1028 ;; We are using an existing buffer.
1029 (progn
1030 (or nowarn
1031 (verify-visited-file-modtime buf)
1032 (cond ((not (file-exists-p filename))
1033 (error "File %s no longer exists!" filename))
1034 ;; Certain files should be reverted automatically
1035 ;; if they have changed on disk and not in the buffer.
1036 ((and (not (buffer-modified-p buf))
1037 (let ((tail revert-without-query)
1038 (found nil))
1039 (while tail
1040 (if (string-match (car tail) filename)
1041 (setq found t))
1042 (setq tail (cdr tail)))
1043 found))
1044 (with-current-buffer buf
1045 (message "Reverting file %s..." filename)
1046 (revert-buffer t t)
1047 (message "Reverting file %s...done" filename)))
1048 ((yes-or-no-p
1049 (if (string= (file-name-nondirectory filename)
1050 (buffer-name buf))
1051 (format
1052 (if (buffer-modified-p buf)
1053 "File %s changed on disk. Discard your edits? "
1054 "File %s changed on disk. Reread from disk? ")
1055 (file-name-nondirectory filename))
ddd64da9
RS
1056 (format
1057 (if (buffer-modified-p buf)
5de148a2
RS
1058 "File %s changed on disk. Discard your edits in %s? "
1059 "File %s changed on disk. Reread from disk into %s? ")
1060 (file-name-nondirectory filename)
1061 (buffer-name buf))))
1062 (with-current-buffer buf
1063 (revert-buffer t t)))))
1064 (with-current-buffer buf
a8d002d2
GM
1065
1066 ;; Check if a formerly read-only file has become
e554eeb7
RS
1067 ;; writable and vice versa, but if the buffer agrees
1068 ;; with the new state of the file, that is ok too.
a8d002d2 1069 (let ((read-only (not (file-writable-p buffer-file-name))))
e554eeb7
RS
1070 (unless (or (eq read-only buffer-file-read-only)
1071 (eq read-only buffer-read-only))
a8d002d2
GM
1072 (when (or nowarn
1073 (let ((question
1074 (format "File %s is %s on disk. Change buffer mode? "
1075 buffer-file-name
1076 (if read-only "read-only" "writable"))))
1077 (y-or-n-p question)))
e554eeb7
RS
1078 (setq buffer-read-only read-only)))
1079 (setq buffer-file-read-only read-only))
a8d002d2 1080
ef59dd3b
EZ
1081 (when (and (not (eq (not (null rawfile))
1082 (not (null find-file-literally))))
1083 ;; It is confusing to ask whether to visit
1084 ;; non-literally if they have the file in
1085 ;; hexl-mode.
1086 (not (eq major-mode 'hexl-mode)))
5de148a2 1087 (if (buffer-modified-p)
ddd64da9 1088 (if (y-or-n-p (if rawfile
5de148a2
RS
1089 "Save file and revisit literally? "
1090 "Save file and revisit non-literally? "))
1091 (progn
1092 (save-buffer)
1093 (find-file-noselect-1 buf filename nowarn
1094 rawfile truename number))
1095 (if (y-or-n-p (if rawfile
1096 "Discard your edits and revisit file literally? "
1097 "Discard your edits and revisit file non-literally? "))
1098 (find-file-noselect-1 buf filename nowarn
1099 rawfile truename number)
1100 (error (if rawfile "File already visited non-literally"
1101 "File already visited literally"))))
1102 (if (y-or-n-p (if rawfile
1103 "Revisit file literally? "
1104 "Revisit file non-literally? "))
1105 (find-file-noselect-1 buf filename nowarn
1106 rawfile truename number)
1107 (error (if rawfile "File already visited non-literally"
1108 "File already visited literally"))))))
1109 ;; Return the buffer we are using.
1110 buf)
1111 ;; Create a new buffer.
1112 (setq buf (create-file-buffer filename))
1113 (set-buffer-major-mode buf)
1114 ;; find-file-noselect-1 may use a different buffer.
1115 (find-file-noselect-1 buf filename nowarn
1116 rawfile truename number))))))
ddd64da9
RS
1117
1118(defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
666c1d8b
RS
1119 (let ((inhibit-read-only t)
1120 error)
ddd64da9
RS
1121 (with-current-buffer buf
1122 (kill-local-variable 'find-file-literally)
b296cbd4
RS
1123 ;; Needed in case we are re-visiting the file with a different
1124 ;; text representation.
e73ec04b 1125 (kill-local-variable 'buffer-file-coding-system)
ddd64da9
RS
1126 (erase-buffer)
1127 (and (default-value 'enable-multibyte-characters)
1128 (not rawfile)
1129 (set-buffer-multibyte t))
1130 (if rawfile
1131 (condition-case ()
1132 (insert-file-contents-literally filename t)
1133 (file-error
1134 (when (and (file-exists-p filename)
1135 (not (file-readable-p filename)))
1136 (kill-buffer buf)
1137 (signal 'file-error (list "File is not readable"
1138 filename)))
1139 ;; Unconditionally set error
1140 (setq error t)))
1141 (condition-case ()
1142 (insert-file-contents filename t)
1143 (file-error
1144 (when (and (file-exists-p filename)
1145 (not (file-readable-p filename)))
1146 (kill-buffer buf)
1147 (signal 'file-error (list "File is not readable"
1148 filename)))
1149 ;; Run find-file-not-found-hooks until one returns non-nil.
1150 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
1151 ;; If they fail too, set error.
1152 (setq error t)))))
b120e713
KH
1153 ;; Record the file's truename, and maybe use that as visited name.
1154 (if (equal filename buffer-file-name)
1155 (setq buffer-file-truename truename)
9ab19105
DL
1156 (setq buffer-file-truename
1157 (abbreviate-file-name (file-truename buffer-file-name))))
ddd64da9
RS
1158 (setq buffer-file-number number)
1159 ;; On VMS, we may want to remember which directory in a search list
1160 ;; the file was found in.
1161 (and (eq system-type 'vax-vms)
1162 (let (logical)
1163 (if (string-match ":" (file-name-directory filename))
1164 (setq logical (substring (file-name-directory filename)
1165 0 (match-beginning 0))))
1166 (not (member logical find-file-not-true-dirname-list)))
1167 (setq buffer-file-name buffer-file-truename))
1168 (if find-file-visit-truename
1169 (setq buffer-file-name
1170 (setq filename
1171 (expand-file-name buffer-file-truename))))
1172 ;; Set buffer's default directory to that of the file.
b120e713 1173 (setq default-directory (file-name-directory buffer-file-name))
ddd64da9
RS
1174 ;; Turn off backup files for certain file names. Since
1175 ;; this is a permanent local, the major mode won't eliminate it.
1176 (and (not (funcall backup-enable-predicate buffer-file-name))
1177 (progn
1178 (make-local-variable 'backup-inhibited)
1179 (setq backup-inhibited t)))
1180 (if rawfile
1181 (progn
1182 (set-buffer-multibyte nil)
1183 (setq buffer-file-coding-system 'no-conversion)
1184 (make-local-variable 'find-file-literally)
1185 (setq find-file-literally t))
b296cbd4
RS
1186 (after-find-file error (not nowarn)))
1187 (current-buffer))))
9b8ef27d
RS
1188\f
1189(defun insert-file-contents-literally (filename &optional visit beg end replace)
1190 "Like `insert-file-contents', but only reads in the file literally.
1191A buffer may be modified in several ways after reading into the buffer,
1192to Emacs features such as format decoding, character code
d5798fa7 1193conversion, `find-file-hooks', automatic uncompression, etc.
9b8ef27d
RS
1194
1195This function ensures that none of these modifications will take place."
1196 (let ((format-alist nil)
1197 (after-insert-file-functions nil)
1198 (coding-system-for-read 'no-conversion)
1199 (coding-system-for-write 'no-conversion)
9b8ef27d
RS
1200 (find-buffer-file-type-function
1201 (if (fboundp 'find-buffer-file-type)
1202 (symbol-function 'find-buffer-file-type)
7e365285
DL
1203 nil))
1204 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
1205 (inhibit-file-name-operation 'insert-file-contents))
9b8ef27d
RS
1206 (unwind-protect
1207 (progn
1208 (fset 'find-buffer-file-type (lambda (filename) t))
1209 (insert-file-contents filename visit beg end replace))
1210 (if find-buffer-file-type-function
1211 (fset 'find-buffer-file-type find-buffer-file-type-function)
1212 (fmakunbound 'find-buffer-file-type)))))
1213
1214(defun insert-file-literally (filename)
1215 "Insert contents of file FILENAME into buffer after point with no conversion.
1216
1217This function is meant for the user to run interactively.
1218Don't call it from programs! Use `insert-file-contents-literally' instead.
1219\(Its calling sequence is different; see its documentation)."
1220 (interactive "*fInsert file literally: ")
1221 (if (file-directory-p filename)
1222 (signal 'file-error (list "Opening input file" "file is a directory"
1223 filename)))
1224 (let ((tem (insert-file-contents-literally filename)))
1225 (push-mark (+ (point) (car (cdr tem))))))
1226
1227(defvar find-file-literally nil
1228 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1229This is a permanent local.")
1230(put 'find-file-literally 'permanent-local t)
5fc196af 1231
ffc0e1ca 1232(defun find-file-literally (filename)
5fc196af
RS
1233 "Visit file FILENAME with no conversion of any kind.
1234Format conversion and character code conversion are both disabled,
1235and multibyte characters are disabled in the resulting buffer.
e65db7b8
RS
1236The major mode used is Fundamental mode regardless of the file name,
1237and local variable specifications in the file are ignored.
407b4328
GM
1238Automatic uncompression and adding a newline at the end of the
1239file due to `require-final-newline' is also disabled.
9b8ef27d
RS
1240
1241You cannot absolutely rely on this function to result in
b9aa9537 1242visiting the file literally. If Emacs already has a buffer
9b8ef27d
RS
1243which is visiting the file, you get the existing buffer,
1244regardless of whether it was created literally or not.
1245
1246In a Lisp program, if you want to be sure of accessing a file's
1247contents literally, you should create a temporary buffer and then read
1248the file contents into it using `insert-file-contents-literally'."
5fc196af 1249 (interactive "FFind file literally: ")
9b8ef27d 1250 (switch-to-buffer (find-file-noselect filename nil t)))
b4da00e9 1251\f
f7d786d0
RS
1252(defvar after-find-file-from-revert-buffer nil)
1253
e0ab8879 1254(defun after-find-file (&optional error warn noauto
9a30563f
RS
1255 after-find-file-from-revert-buffer
1256 nomodes)
b4da00e9
RM
1257 "Called after finding a file and by the default revert function.
1258Sets buffer mode, parses local variables.
8cfb9d46 1259Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
1260error in reading the file. WARN non-nil means warn if there
1261exists an auto-save file more recent than the visited file.
8cfb9d46 1262NOAUTO means don't mess with auto-save mode.
e0ab8879
RS
1263Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1264 means this call was from `revert-buffer'.
9a30563f
RS
1265Fifth arg NOMODES non-nil means don't alter the file's modes.
1266Finishes by calling the functions in `find-file-hooks'
1267unless NOMODES is non-nil."
b4da00e9
RM
1268 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1269 (if noninteractive
1270 nil
1271 (let* (not-serious
1272 (msg
fe50b6ab
GM
1273 (cond
1274 ((not warn) nil)
1275 ((and error (file-attributes buffer-file-name))
1276 (setq buffer-read-only t)
1277 "File exists, but cannot be read")
1278 ((not buffer-read-only)
1279 (if (and warn
1280 ;; No need to warn if buffer is auto-saved
1281 ;; under the name of the visited file.
1282 (not (and buffer-file-name
1283 auto-save-visited-file-name))
1284 (file-newer-than-file-p (or buffer-auto-save-file-name
1285 (make-auto-save-file-name))
1286 buffer-file-name))
1287 (format "%s has auto save data; consider M-x recover-file"
1288 (file-name-nondirectory buffer-file-name))
1289 (setq not-serious t)
1290 (if error "(New file)" nil)))
1291 ((not error)
1292 (setq not-serious t)
1293 "Note: file is write protected")
1294 ((file-attributes (directory-file-name default-directory))
1295 "File not found and directory write-protected")
1296 ((file-exists-p (file-name-directory buffer-file-name))
1297 (setq buffer-read-only nil))
1298 (t
1299 (setq buffer-read-only nil)
1300 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1301 "Use M-x make-directory RET RET to create the directory"
1302 "Use C-u M-x make-directory RET RET to create directory and its parents")))))
1303 (when msg
1304 (message msg)
1305 (or not-serious (sit-for 1 nil t))))
1306 (when (and auto-save-default (not noauto))
1307 (auto-save-mode t)))
ffc0e1ca
AS
1308 ;; Make people do a little extra work (C-x C-q)
1309 ;; before altering a backup file.
fe50b6ab
GM
1310 (when (backup-file-name-p buffer-file-name)
1311 (setq buffer-read-only t))
1312 (unless nomodes
1313 (when (and view-read-only view-mode)
1314 (view-mode-disable))
9a30563f 1315 (normal-mode t)
fe50b6ab
GM
1316 (when (and buffer-read-only
1317 view-read-only
1318 (not (eq (get major-mode 'mode-class) 'special)))
1319 (view-mode-enter))
9a30563f 1320 (run-hooks 'find-file-hooks)))
b4da00e9
RM
1321
1322(defun normal-mode (&optional find-file)
1323 "Choose the major mode for this buffer automatically.
1324Also sets up any specified local variables of the file.
1325Uses the visited file name, the -*- line, and the local variables spec.
1326
1327This function is called automatically from `find-file'. In that case,
aa5fcebf
KH
1328we may set up the file-specified mode and local variables,
1329depending on the value of `enable-local-variables': if it is t, we do;
1330if it is nil, we don't; otherwise, we query.
1331In addition, if `local-enable-local-variables' is nil, we do
1332not set local variables (though we do notice a mode specified with -*-.)
1333
1334`enable-local-variables' is ignored if you run `normal-mode' interactively,
1335or from Lisp without specifying the optional argument FIND-FILE;
1336in that case, this function acts as if `enable-local-variables' were t."
b4da00e9
RM
1337 (interactive)
1338 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1339 (condition-case err
1340 (set-auto-mode)
1341 (error (message "File mode specification error: %s"
1342 (prin1-to-string err))))
1343 (condition-case err
7b3f3dc2
JB
1344 (let ((enable-local-variables (or (not find-file)
1345 enable-local-variables)))
1346 (hack-local-variables))
b4da00e9
RM
1347 (error (message "File local-variables error: %s"
1348 (prin1-to-string err)))))
1349
f76e0cd0 1350(defvar auto-mode-alist
ffc0e1ca
AS
1351 (mapc
1352 (lambda (elt)
1353 (cons (purecopy (car elt)) (cdr elt)))
1354 '(("\\.te?xt\\'" . text-mode)
1355 ("\\.c\\'" . c-mode)
1356 ("\\.h\\'" . c-mode)
1357 ("\\.tex\\'" . tex-mode)
1358 ("\\.ltx\\'" . latex-mode)
1359 ("\\.el\\'" . emacs-lisp-mode)
1360 ("\\.scm\\'" . scheme-mode)
1361 ("\\.l\\'" . lisp-mode)
1362 ("\\.lisp\\'" . lisp-mode)
1363 ("\\.f\\'" . fortran-mode)
1364 ("\\.F\\'" . fortran-mode)
1365 ("\\.for\\'" . fortran-mode)
1366 ("\\.p\\'" . pascal-mode)
1367 ("\\.pas\\'" . pascal-mode)
1368 ("\\.ad[abs]\\'" . ada-mode)
5c6d31a4 1369 ("\\.\\([pP]\\([Llm]\\|erl\\)\\|al\\)\\'" . perl-mode)
ffc0e1ca
AS
1370 ("\\.s?html?\\'" . html-mode)
1371 ("\\.cc\\'" . c++-mode)
1372 ("\\.hh\\'" . c++-mode)
1373 ("\\.hpp\\'" . c++-mode)
1374 ("\\.C\\'" . c++-mode)
1375 ("\\.H\\'" . c++-mode)
1376 ("\\.cpp\\'" . c++-mode)
1377 ("\\.cxx\\'" . c++-mode)
1378 ("\\.hxx\\'" . c++-mode)
1379 ("\\.c\\+\\+\\'" . c++-mode)
1380 ("\\.h\\+\\+\\'" . c++-mode)
1381 ("\\.m\\'" . objc-mode)
1382 ("\\.java\\'" . java-mode)
1383 ("\\.mk\\'" . makefile-mode)
1384 ("\\(M\\|m\\|GNUm\\)akefile\\(\\.in\\)?\\'" . makefile-mode)
1385 ("\\.am\\'" . makefile-mode) ;For Automake.
5c6d31a4
SM
1386 ;; Less common extensions come here
1387 ;; so more common ones above are found faster.
ffc0e1ca
AS
1388 ("\\.texinfo\\'" . texinfo-mode)
1389 ("\\.te?xi\\'" . texinfo-mode)
1390 ("\\.s\\'" . asm-mode)
1391 ("\\.S\\'" . asm-mode)
1392 ("\\.asm\\'" . asm-mode)
1393 ("ChangeLog\\'" . change-log-mode)
1394 ("change\\.log\\'" . change-log-mode)
1395 ("changelo\\'" . change-log-mode)
1396 ("ChangeLog\\.[0-9]+\\'" . change-log-mode)
1397 ;; for MSDOS and MS-Windows (which are case-insensitive)
1398 ("changelog\\'" . change-log-mode)
1399 ("changelog\\.[0-9]+\\'" . change-log-mode)
1400 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1401 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1402 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1403 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1404 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1405 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
d5798fa7 1406 ("\\.m?spec\\'" . sh-mode)
ffc0e1ca
AS
1407 ("\\.mm\\'" . nroff-mode)
1408 ("\\.me\\'" . nroff-mode)
1409 ("\\.ms\\'" . nroff-mode)
1410 ("\\.man\\'" . nroff-mode)
1411 ("\\.\\(u?lpc\\|pike\\|pmod\\)\\'" . pike-mode)
ffc0e1ca
AS
1412 ("\\.TeX\\'" . tex-mode)
1413 ("\\.sty\\'" . latex-mode)
1414 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1415 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
1416 ("\\.bbl\\'" . latex-mode)
1417 ("\\.bib\\'" . bibtex-mode)
1418 ("\\.sql\\'" . sql-mode)
1419 ("\\.m4\\'" . m4-mode)
1420 ("\\.mc\\'" . m4-mode)
1421 ("\\.mf\\'" . metafont-mode)
1422 ("\\.mp\\'" . metapost-mode)
1423 ("\\.vhdl?\\'" . vhdl-mode)
1424 ("\\.article\\'" . text-mode)
1425 ("\\.letter\\'" . text-mode)
1426 ("\\.tcl\\'" . tcl-mode)
1427 ("\\.exp\\'" . tcl-mode)
1428 ("\\.itcl\\'" . tcl-mode)
1429 ("\\.itk\\'" . tcl-mode)
1430 ("\\.icn\\'" . icon-mode)
1431 ("\\.sim\\'" . simula-mode)
1432 ("\\.mss\\'" . scribe-mode)
1433 ("\\.f90\\'" . f90-mode)
8f9495e7 1434 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
ffc0e1ca
AS
1435 ("\\.pro\\'" . idlwave-mode)
1436 ("\\.lsp\\'" . lisp-mode)
1437 ("\\.awk\\'" . awk-mode)
1438 ("\\.prolog\\'" . prolog-mode)
1439 ("\\.tar\\'" . tar-mode)
1440 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\)\\'" . archive-mode)
1441 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\)\\'" . archive-mode)
1442 ;; Mailer puts message to be edited in
1443 ;; /tmp/Re.... or Message
1444 ("\\`/tmp/Re" . text-mode)
1445 ("/Message[0-9]*\\'" . text-mode)
1446 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1447 ("\\.zone\\'" . zone-mode)
1448 ;; some news reader is reported to use this
1449 ("\\`/tmp/fol/" . text-mode)
1450 ("\\.y\\'" . c-mode)
1451 ("\\.lex\\'" . c-mode)
1452 ("\\.oak\\'" . scheme-mode)
1453 ("\\.sgml?\\'" . sgml-mode)
1454 ("\\.xml\\'" . sgml-mode)
1455 ("\\.dtd\\'" . sgml-mode)
1456 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1457 ("\\.idl\\'" . idl-mode)
1458 ;; .emacs following a directory delimiter
1459 ;; in Unix, MSDOG or VMS syntax.
1460 ("[]>:/\\]\\..*emacs\\'" . emacs-lisp-mode)
1461 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1462 ;; _emacs following a directory delimiter
1463 ;; in MsDos syntax
1464 ("[:/]_emacs\\'" . emacs-lisp-mode)
1465 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1466 ("\\.ml\\'" . lisp-mode)
d5798fa7
SM
1467 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1468 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
ffc0e1ca 1469 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
e854cc22 1470 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
d5798fa7 1471 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
e55c4863 1472 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
ffc0e1ca
AS
1473 ("BROWSE\\'" . ebrowse-tree-mode)
1474 ("\\.ebrowse\\'" . ebrowse-tree-mode)
9ee45b2c
SM
1475 ("#\\*mail\\*" . mail-mode)
1476 ;; Get rid of any trailing .n.m and try again.
1477 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
5c6d31a4
SM
1478 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1479 ;; Using mode nil rather than `ignore' would let the search continue
1480 ;; through this list (with the shortened name) rather than start over.
1481 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" ignore t)
1482 ;; The following should come after the ChangeLog pattern
1483 ;; for the sake of ChangeLog.1, etc.
1484 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
e043664a 1485 ("\\.[1-9]\\'" . nroff-mode)
7423978d 1486 ("\\.g\\'" . antlr-mode)))
ffc0e1ca 1487 "Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
1488Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1489\(NON-NIL stands for anything that is not nil; the value does not matter.)
1490Visiting a file whose name matches REGEXP specifies FUNCTION as the
1491mode function to use. FUNCTION will be called, unless it is nil.
1492
1493If the element has the form (REGEXP FUNCTION NON-NIL), then after
1494calling FUNCTION (if it's not nil), we delete the suffix that matched
1495REGEXP and search the list again for another match.")
7b3f3dc2 1496
e13322a0 1497
d7fa5aa2 1498(defvar interpreter-mode-alist
ffc0e1ca
AS
1499 (mapc
1500 (lambda (l)
1501 (cons (purecopy (car l)) (cdr l)))
1502 '(("perl" . perl-mode)
1503 ("perl5" . perl-mode)
1504 ("miniperl" . perl-mode)
1505 ("wish" . tcl-mode)
1506 ("wishx" . tcl-mode)
1507 ("tcl" . tcl-mode)
1508 ("tclsh" . tcl-mode)
1509 ("awk" . awk-mode)
1510 ("mawk" . awk-mode)
1511 ("nawk" . awk-mode)
1512 ("gawk" . awk-mode)
1513 ("scm" . scheme-mode)
1514 ("ash" . sh-mode)
1515 ("bash" . sh-mode)
1516 ("bash2" . sh-mode)
1517 ("csh" . sh-mode)
1518 ("dtksh" . sh-mode)
1519 ("es" . sh-mode)
1520 ("itcsh" . sh-mode)
1521 ("jsh" . sh-mode)
1522 ("ksh" . sh-mode)
1523 ("oash" . sh-mode)
1524 ("pdksh" . sh-mode)
1525 ("rc" . sh-mode)
1526 ("rpm" . sh-mode)
1527 ("sh" . sh-mode)
1528 ("sh5" . sh-mode)
1529 ("tcsh" . sh-mode)
1530 ("wksh" . sh-mode)
1531 ("wsh" . sh-mode)
1532 ("zsh" . sh-mode)
1533 ("tail" . text-mode)
1534 ("more" . text-mode)
1535 ("less" . text-mode)
1536 ("pg" . text-mode)
1537 ("make" . makefile-mode) ; Debian uses this
1538 ("guile" . scheme-mode)
1539 ("clisp" . lisp-mode)))
c907d156
RS
1540 "Alist mapping interpreter names to major modes.
1541This alist applies to files whose first line starts with `#!'.
1542Each element looks like (INTERPRETER . MODE).
1543The car of each element is compared with
1544the name of the interpreter specified in the first line.
1545If it matches, mode MODE is selected.")
1546
d7fa5aa2 1547(defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
45fb3bb8 1548 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 1549
d7fa5aa2 1550(defvar inhibit-first-line-modes-suffixes nil
b20ff6d0
RS
1551 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1552When checking `inhibit-first-line-modes-regexps', we first discard
1553from the end of the file name anything that matches one of these regexps.")
1554
ffc0e1ca
AS
1555(defvar auto-mode-interpreter-regexp
1556 "#![ \t]?\\([^ \t\n]*\
1557/bin/env[ \t]\\)?\\([^ \t\n]+\\)"
1558 "Regular expression matching interpreters, for file mode determination.
1559This regular expression is matched against the first line of a file
1560to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1561a mode from the file's name. If it matches, the file is assumed to
1562be interpreted by the interpreter matched by the second group of the
1563regular expression. The mode is then determined as the mode associated
1564with that interpreter in `interpreter-mode-alist'.")
0720b68b 1565
9de9b6a2 1566(defun set-auto-mode (&optional just-from-file-name)
b4da00e9 1567 "Select major mode appropriate for current buffer.
e3998da1
RS
1568This checks for a -*- mode tag in the buffer's text,
1569compares the filename against the entries in `auto-mode-alist',
1570or checks the interpreter that runs this file against
1571`interpreter-mode-alist'.
1572
1573It does not check for the `mode:' local variable in the
1574Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 1575
f3e23606 1576If `enable-local-variables' is nil, this function does not check for a
9de9b6a2
RS
1577-*- mode tag.
1578
1579If the optional argument JUST-FROM-FILE-NAME is non-nil,
1580then we do not set anything but the major mode,
1581and we don't even do that unless it would come from the file name."
b4da00e9 1582 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2d2ab9da 1583 (let (end done modes)
b4da00e9
RM
1584 (save-excursion
1585 (goto-char (point-min))
1586 (skip-chars-forward " \t\n")
9fa7bfe5 1587 (and enable-local-variables
e3f9b9c0 1588 (setq end (set-auto-mode-1))
2d2ab9da
RS
1589 (if (save-excursion (search-forward ":" end t))
1590 ;; Find all specifications for the `mode:' variable
1591 ;; and execute them left to right.
1592 (while (let ((case-fold-search t))
1593 (or (and (looking-at "mode:")
1594 (goto-char (match-end 0)))
1595 (re-search-forward "[ \t;]mode:" end t)))
1596 (skip-chars-forward " \t")
1597 (let ((beg (point)))
9fa7bfe5
RS
1598 (if (search-forward ";" end t)
1599 (forward-char -1)
1600 (goto-char end))
1601 (skip-chars-backward " \t")
9ee45b2c 1602 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2d2ab9da
RS
1603 modes)))
1604 ;; Simple -*-MODE-*- case.
1605 (push (intern (concat (downcase (buffer-substring (point) end))
1606 "-mode"))
1607 modes))))
d0fc03ef
RS
1608 ;; If we found modes to use, invoke them now,
1609 ;; outside the save-excursion.
9ee45b2c
SM
1610 (unless just-from-file-name
1611 (dolist (mode (nreverse modes))
1612 (if (not (functionp mode))
1613 (message "Ignoring unknown mode `%s'" mode)
1614 (setq done t)
1615 (funcall mode))))
d0fc03ef
RS
1616 ;; If we didn't find a mode from a -*- line, try using the file name.
1617 (if (and (not done) buffer-file-name)
1618 (let ((name buffer-file-name)
1619 (keep-going t))
1620 ;; Remove backup-suffixes from file name.
1621 (setq name (file-name-sans-versions name))
1622 (while keep-going
1623 (setq keep-going nil)
1624 (let ((alist auto-mode-alist)
1625 (mode nil))
1626 ;; Find first matching alist entry.
76d5492b 1627 (let ((case-fold-search
d0fc03ef
RS
1628 (memq system-type '(vax-vms windows-nt))))
1629 (while (and (not mode) alist)
1630 (if (string-match (car (car alist)) name)
1631 (if (and (consp (cdr (car alist)))
1632 (nth 2 (car alist)))
ffc0e1ca
AS
1633 (setq mode (car (cdr (car alist)))
1634 name (substring name 0 (match-beginning 0))
1635 keep-going t)
d0fc03ef
RS
1636 (setq mode (cdr (car alist))
1637 keep-going nil)))
1638 (setq alist (cdr alist))))
1639 (if mode
3b9ffb77
RS
1640 ;; When JUST-FROM-FILE-NAME is set,
1641 ;; we are working on behalf of set-visited-file-name.
1642 ;; In that case, if the major mode specified is the
1643 ;; same one we already have, don't actually reset it.
1644 ;; We don't want to lose minor modes such as Font Lock.
1645 (unless (and just-from-file-name (eq mode major-mode))
1646 (funcall mode))
d0fc03ef
RS
1647 ;; If we can't deduce a mode from the file name,
1648 ;; look for an interpreter specified in the first line.
1540e4e9
KH
1649 ;; As a special case, allow for things like "#!/bin/env perl",
1650 ;; which finds the interpreter anywhere in $PATH.
d0fc03ef
RS
1651 (let ((interpreter
1652 (save-excursion
1653 (goto-char (point-min))
ffc0e1ca
AS
1654 (if (looking-at auto-mode-interpreter-regexp)
1655 (match-string 2)
d0fc03ef
RS
1656 "")))
1657 elt)
1658 ;; Map interpreter name to a mode.
1659 (setq elt (assoc (file-name-nondirectory interpreter)
1660 interpreter-mode-alist))
9de9b6a2
RS
1661 (unless just-from-file-name
1662 (if elt
1663 (funcall (cdr elt))))))))))))
b4da00e9 1664
e3f9b9c0
RS
1665
1666(defun set-auto-mode-1 ()
1667 "Find the -*- spec in the buffer.
1668Call with point at the place to start searching from.
1669If one is found, set point to the beginning
1670and return the position of the end.
1671Otherwise, return nil; point may be changed."
1672 (let (beg end)
1673 (and
1674 ;; Don't look for -*- if this file name matches any
1675 ;; of the regexps in inhibit-first-line-modes-regexps.
1676 (let ((temp inhibit-first-line-modes-regexps)
1677 (name (if buffer-file-name
1678 (file-name-sans-versions buffer-file-name)
1679 (buffer-name))))
1680 (while (let ((sufs inhibit-first-line-modes-suffixes))
1681 (while (and sufs (not (string-match (car sufs) name)))
1682 (setq sufs (cdr sufs)))
1683 sufs)
1684 (setq name (substring name 0 (match-beginning 0))))
1685 (while (and temp
1686 (not (string-match (car temp) name)))
1687 (setq temp (cdr temp)))
1688 (not temp))
1689
1690 (search-forward "-*-" (save-excursion
1691 ;; If the file begins with "#!"
1692 ;; (exec interpreter magic), look
1693 ;; for mode frobs in the first two
1694 ;; lines. You cannot necessarily
1695 ;; put them in the first line of
1696 ;; such a file without screwing up
1697 ;; the interpreter invocation.
1698 (end-of-line (and (looking-at "^#!") 2))
1699 (point)) t)
1700 (progn
1701 (skip-chars-forward " \t")
1702 (setq beg (point))
1703 (search-forward "-*-"
1704 (save-excursion (end-of-line) (point))
1705 t))
1706 (progn
1707 (forward-char -3)
1708 (skip-chars-backward " \t")
1709 (setq end (point))
1710 (goto-char beg)
1711 end))))
1712
f3e23606 1713(defun hack-local-variables-prop-line ()
ffc0e1ca
AS
1714 "Set local variables specified in the -*- line.
1715Ignore any specification for `mode:' and `coding:';
1716`set-auto-mode' should already have handled `mode:',
1717`set-auto-coding' should already have handled `coding:'."
f3e23606
RS
1718 (save-excursion
1719 (goto-char (point-min))
13a66180 1720 (let ((result nil)
e3f9b9c0 1721 (end (set-auto-mode-1))
aa5fcebf
KH
1722 (enable-local-variables
1723 (and local-enable-local-variables enable-local-variables)))
f3e23606 1724 ;; Parse the -*- line into the `result' alist.
e3f9b9c0 1725 (cond ((not end)
f3e23606
RS
1726 nil)
1727 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180
KH
1728 ;; Simple form: "-*- MODENAME -*-". Already handled.
1729 nil)
f3e23606
RS
1730 (t
1731 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1732 ;; (last ";" is optional).
f3e23606
RS
1733 (while (< (point) end)
1734 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
ffc0e1ca 1735 (error "Malformed -*- line"))
f3e23606 1736 (goto-char (match-end 0))
1c26a6f3
KH
1737 ;; There used to be a downcase here,
1738 ;; but the manual didn't say so,
1739 ;; and people want to set var names that aren't all lc.
1740 (let ((key (intern (buffer-substring
1741 (match-beginning 1)
1742 (match-end 1))))
f3e23606
RS
1743 (val (save-restriction
1744 (narrow-to-region (point) end)
1745 (read (current-buffer)))))
93a2702d
RS
1746 ;; It is traditional to ignore
1747 ;; case when checking for `mode' in set-auto-mode,
1748 ;; so we must do that here as well.
1749 ;; That is inconsistent, but we're stuck with it.
3fa0a9aa 1750 ;; The same can be said for `coding' in set-auto-coding.
93a2702d 1751 (or (equal (downcase (symbol-name key)) "mode")
3fa0a9aa 1752 (equal (downcase (symbol-name key)) "coding")
13a66180 1753 (setq result (cons (cons key val) result)))
f3e23606
RS
1754 (skip-chars-forward " \t;")))
1755 (setq result (nreverse result))))
76d5492b 1756
f3e23606
RS
1757 (if (and result
1758 (or (eq enable-local-variables t)
1759 (and enable-local-variables
1760 (save-window-excursion
6f931919
RS
1761 (condition-case nil
1762 (switch-to-buffer (current-buffer))
1763 (error
1764 ;; If we fail to switch in the selected window,
1765 ;; it is probably a minibuffer.
1766 ;; So try another window.
1767 (condition-case nil
1768 (switch-to-buffer-other-window (current-buffer))
1769 (error
1770 (switch-to-buffer-other-frame (current-buffer))))))
f3e23606
RS
1771 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1772 (file-name-nondirectory buffer-file-name)))))))
2837b9df
RS
1773 (let ((enable-local-eval enable-local-eval))
1774 (while result
1775 (hack-one-local-variable (car (car result)) (cdr (car result)))
1776 (setq result (cdr result))))))))
f3e23606 1777
1d517019
RS
1778(defvar hack-local-variables-hook nil
1779 "Normal hook run after processing a file's local variables specs.
1780Major modes can use this to examine user-specified local variables
1781in order to initialize other data structure based on them.")
1782
9de9b6a2
RS
1783(defun hack-local-variables (&optional mode-only)
1784 "Parse and put into effect this buffer's local variables spec.
1785If MODE-ONLY is non-nil, all we do is check whether the major mode
1786is specified, returning t if it is specified."
1787 (unless mode-only
1788 (hack-local-variables-prop-line))
b4da00e9 1789 ;; Look for "Local variables:" line in last page.
aa5fcebf
KH
1790 (let (mode-specified
1791 (enable-local-variables
1792 (and local-enable-local-variables enable-local-variables)))
9de9b6a2
RS
1793 (save-excursion
1794 (goto-char (point-max))
1795 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1796 (if (let ((case-fold-search t))
1797 (and (search-forward "Local Variables:" nil t)
1798 (or (eq enable-local-variables t)
1799 mode-only
1800 (and enable-local-variables
1801 (save-window-excursion
1802 (switch-to-buffer (current-buffer))
1803 (save-excursion
1804 (beginning-of-line)
1805 (set-window-start (selected-window) (point)))
1806 (y-or-n-p (format "Set local variables as specified at end of %s? "
1807 (if buffer-file-name
1808 (file-name-nondirectory
1809 buffer-file-name)
1810 (concat "buffer "
1811 (buffer-name))))))))))
1812 (let ((continue t)
1813 prefix prefixlen suffix beg
1814 mode-specified
1815 (enable-local-eval enable-local-eval))
1816 ;; The prefix is what comes before "local variables:" in its line.
1817 ;; The suffix is what comes after "local variables:" in its line.
b4da00e9 1818 (skip-chars-forward " \t")
9de9b6a2
RS
1819 (or (eolp)
1820 (setq suffix (buffer-substring (point)
1821 (progn (end-of-line) (point)))))
1822 (goto-char (match-beginning 0))
1823 (or (bolp)
1824 (setq prefix
1825 (buffer-substring (point)
1826 (progn (beginning-of-line) (point)))))
1827
1828 (if prefix (setq prefixlen (length prefix)
1829 prefix (regexp-quote prefix)))
1830 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1831 (while continue
1832 ;; Look at next local variable spec.
1833 (if selective-display (re-search-forward "[\n\C-m]")
1834 (forward-line 1))
1835 ;; Skip the prefix, if any.
1836 (if prefix
1837 (if (looking-at prefix)
1838 (forward-char prefixlen)
1839 (error "Local variables entry is missing the prefix")))
1840 ;; Find the variable name; strip whitespace.
1841 (skip-chars-forward " \t")
1842 (setq beg (point))
1843 (skip-chars-forward "^:\n")
1844 (if (eolp) (error "Missing colon in local variables entry"))
1845 (skip-chars-backward " \t")
1846 (let* ((str (buffer-substring beg (point)))
1847 (var (read str))
1848 val)
1849 ;; Setting variable named "end" means end of list.
1850 (if (string-equal (downcase str) "end")
1851 (setq continue nil)
1852 ;; Otherwise read the variable value.
1853 (skip-chars-forward "^:")
1854 (forward-char 1)
1855 (setq val (read (current-buffer)))
1856 (skip-chars-backward "\n")
1857 (skip-chars-forward " \t")
1858 (or (if suffix (looking-at suffix) (eolp))
1859 (error "Local variables entry is terminated incorrectly"))
1860 (if mode-only
1861 (if (eq var 'mode)
1862 (setq mode-specified t))
1863 ;; Set the variable. "Variables" mode and eval are funny.
1864 (hack-one-local-variable var val))))))))
1865 (unless mode-only
1866 (run-hooks 'hack-local-variables-hook))
1867 mode-specified))
f3e23606 1868
d7fa5aa2 1869(defvar ignored-local-variables
f3e23606
RS
1870 '(enable-local-eval)
1871 "Variables to be ignored in a file's local variable spec.")
1872
be0218a8 1873;; Get confirmation before setting these variables as locals in a file.
05ef1cda 1874(put 'debugger 'risky-local-variable t)
f6fa3ee3 1875(put 'enable-local-eval 'risky-local-variable t)
fce47eea 1876(put 'ignored-local-variables 'risky-local-variable t)
be0218a8
RS
1877(put 'eval 'risky-local-variable t)
1878(put 'file-name-handler-alist 'risky-local-variable t)
1879(put 'minor-mode-map-alist 'risky-local-variable t)
1880(put 'after-load-alist 'risky-local-variable t)
f6fa3ee3
RS
1881(put 'buffer-file-name 'risky-local-variable t)
1882(put 'buffer-auto-save-file-name 'risky-local-variable t)
1883(put 'buffer-file-truename 'risky-local-variable t)
b0ffcc0d
RS
1884(put 'exec-path 'risky-local-variable t)
1885(put 'load-path 'risky-local-variable t)
1886(put 'exec-directory 'risky-local-variable t)
1887(put 'process-environment 'risky-local-variable t)
eba1c87a
RS
1888(put 'dabbrev-case-fold-search 'risky-local-variable t)
1889(put 'dabbrev-case-replace 'risky-local-variable t)
9afa8bf7
RS
1890;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1891(put 'outline-level 'risky-local-variable t)
d98b741d 1892(put 'rmail-output-file-alist 'risky-local-variable t)
f4d04672 1893(put 'font-lock-defaults 'risky-local-variable t)
f6fa3ee3 1894
6672c42b
RS
1895;; This one is safe because the user gets to check it before it is used.
1896(put 'compile-command 'safe-local-variable t)
1897
d0bd3513
RS
1898(defun hack-one-local-variable-quotep (exp)
1899 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1900
f3e23606 1901(defun hack-one-local-variable (var val)
ffc0e1ca
AS
1902 "\"Set\" one variable in a local variables spec.
1903A few variable names are treated specially."
f3e23606
RS
1904 (cond ((eq var 'mode)
1905 (funcall (intern (concat (downcase (symbol-name val))
1906 "-mode"))))
3fa0a9aa
KH
1907 ((eq var 'coding)
1908 ;; We have already handled coding: tag in set-auto-coding.
1909 nil)
f3e23606
RS
1910 ((memq var ignored-local-variables)
1911 nil)
1912 ;; "Setting" eval means either eval it or do nothing.
7d3221d7 1913 ;; Likewise for setting hook variables.
be0218a8 1914 ((or (get var 'risky-local-variable)
6672c42b 1915 (and
f4d04672 1916 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$"
6672c42b
RS
1917 (symbol-name var))
1918 (not (get var 'safe-local-variable))))
0225ae5e 1919 ;; Permit evalling a put of a harmless property.
d0bd3513
RS
1920 ;; if the args do nothing tricky.
1921 (if (or (and (eq var 'eval)
1922 (consp val)
1923 (eq (car val) 'put)
1924 (hack-one-local-variable-quotep (nth 1 val))
1925 (hack-one-local-variable-quotep (nth 2 val))
1926 ;; Only allow safe values of lisp-indent-hook;
1927 ;; not functions.
1928 (or (numberp (nth 3 val))
dc417415 1929 (equal (nth 3 val) ''defun))
d0bd3513
RS
1930 (memq (nth 1 (nth 2 val))
1931 '(lisp-indent-hook)))
1932 ;; Permit eval if not root and user says ok.
c7e62660 1933 (and (not (zerop (user-uid)))
d0bd3513
RS
1934 (or (eq enable-local-eval t)
1935 (and enable-local-eval
1936 (save-window-excursion
1937 (switch-to-buffer (current-buffer))
1938 (save-excursion
1939 (beginning-of-line)
1940 (set-window-start (selected-window) (point)))
1941 (setq enable-local-eval
abf16d5e
RS
1942 (y-or-n-p (format "Process `eval' or hook local variables in %s? "
1943 (if buffer-file-name
1944 (concat "file " (file-name-nondirectory buffer-file-name))
1945 (concat "buffer " (buffer-name)))))))))))
7d3221d7
RS
1946 (if (eq var 'eval)
1947 (save-excursion (eval val))
1948 (make-local-variable var)
1949 (set var val))
abf16d5e 1950 (message "Ignoring `eval:' in the local variables list")))
f3e23606
RS
1951 ;; Ordinary variable, really set it.
1952 (t (make-local-variable var)
1953 (set var val))))
1954
b4da00e9 1955\f
21540597 1956(defcustom change-major-mode-with-file-name t
9de9b6a2
RS
1957 "*Non-nil means \\[write-file] should set the major mode from the file name.
1958However, the mode will not be changed if
1959\(1) a local variables list or the `-*-' line specifies a major mode, or
1960\(2) the current major mode is a \"special\" mode,
8609911b 1961\ not suitable for ordinary files, or
21540597
RS
1962\(3) the new file name does not particularly specify any mode."
1963 :type 'boolean
1964 :group 'editing-basics)
9de9b6a2 1965
f36012a6 1966(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9
RM
1967 "Change name of file visited in current buffer to FILENAME.
1968The next time the buffer is saved it will go in the newly specified file.
1969nil or empty string as argument means make buffer not be visiting any file.
1970Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
1971if you wish to pass an empty string as the argument.
1972
1973The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
1974confirmation in the case where another buffer is already visiting FILENAME.
1975
1976The optional third argument ALONG-WITH-FILE, if non-nil, means that
1977the old visited file has been renamed to the new name FILENAME."
b4da00e9 1978 (interactive "FSet visited file name: ")
c11a94fe
RS
1979 (if (buffer-base-buffer)
1980 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
1981 (let (truename)
1982 (if filename
1983 (setq filename
1984 (if (string-equal filename "")
1985 nil
1986 (expand-file-name filename))))
1987 (if filename
1988 (progn
1989 (setq truename (file-truename filename))
1990 (if find-file-visit-truename
a522e5bf 1991 (setq filename truename))))
11e314fa 1992 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 1993 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 1994 (not no-query)
7b89d38e
RS
1995 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1996 filename)))
1997 (error "Aborted")))
a522e5bf
RS
1998 (or (equal filename buffer-file-name)
1999 (progn
2000 (and filename (lock-buffer filename))
2001 (unlock-buffer)))
2002 (setq buffer-file-name filename)
2003 (if filename ; make buffer name reflect filename.
2004 (let ((new-name (file-name-nondirectory buffer-file-name)))
2005 (if (string= new-name "")
2006 (error "Empty file name"))
2007 (if (eq system-type 'vax-vms)
2008 (setq new-name (downcase new-name)))
2009 (setq default-directory (file-name-directory buffer-file-name))
2010 (or (string= new-name (buffer-name))
2011 (rename-buffer new-name t))))
2012 (setq buffer-backed-up nil)
f36012a6
RS
2013 (or along-with-file
2014 (clear-visited-file-modtime))
8ccdc29e 2015 ;; Abbreviate the file names of the buffer.
4826e97f 2016 (if truename
8ccdc29e
RS
2017 (progn
2018 (setq buffer-file-truename (abbreviate-file-name truename))
2019 (if find-file-visit-truename
2020 (setq buffer-file-name buffer-file-truename))))
a522e5bf
RS
2021 (setq buffer-file-number
2022 (if filename
2a47b4f5 2023 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 2024 nil)))
b4da00e9
RM
2025 ;; write-file-hooks is normally used for things like ftp-find-file
2026 ;; that visit things that are not local files as if they were files.
2027 ;; Changing to visit an ordinary local file instead should flush the hook.
2028 (kill-local-variable 'write-file-hooks)
c9dca4e0 2029 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
2030 (kill-local-variable 'revert-buffer-function)
2031 (kill-local-variable 'backup-inhibited)
ee81c959
RS
2032 ;; If buffer was read-only because of version control,
2033 ;; that reason is gone now, so make it writable.
2034 (if vc-mode
2035 (setq buffer-read-only nil))
2036 (kill-local-variable 'vc-mode)
b4da00e9
RM
2037 ;; Turn off backup files for certain file names.
2038 ;; Since this is a permanent local, the major mode won't eliminate it.
4d49551a
KH
2039 (and buffer-file-name
2040 (not (funcall backup-enable-predicate buffer-file-name))
b4da00e9
RM
2041 (progn
2042 (make-local-variable 'backup-inhibited)
2043 (setq backup-inhibited t)))
c77a81cf
RS
2044 (let ((oauto buffer-auto-save-file-name))
2045 ;; If auto-save was not already on, turn it on if appropriate.
2046 (if (not buffer-auto-save-file-name)
2047 (and buffer-file-name auto-save-default
2048 (auto-save-mode t))
2049 ;; If auto save is on, start using a new name.
2050 ;; We deliberately don't rename or delete the old auto save
2051 ;; for the old visited file name. This is because perhaps
2052 ;; the user wants to save the new state and then compare with the
2053 ;; previous state from the auto save file.
2054 (setq buffer-auto-save-file-name
2055 (make-auto-save-file-name)))
2056 ;; Rename the old auto save file if any.
2057 (and oauto buffer-auto-save-file-name
e6f0e76c 2058 (file-exists-p oauto)
c77a81cf 2059 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
2060 (and buffer-file-name
2061 (not along-with-file)
9de9b6a2
RS
2062 (set-buffer-modified-p t))
2063 ;; Update the major mode, if the file name determines it.
2064 (condition-case nil
2065 ;; Don't change the mode if it is special.
2066 (or (not change-major-mode-with-file-name)
2067 (get major-mode 'mode-class)
2068 ;; Don't change the mode if the local variable list specifies it.
2069 (hack-local-variables t)
2070 (set-auto-mode t))
2071 (error nil)))
b4da00e9 2072
912192d1 2073(defun write-file (filename &optional confirm)
b4da00e9 2074 "Write current buffer into file FILENAME.
7f99999a 2075This makes the buffer visit that file, and marks it as not modified.
7458cc35 2076
7f99999a
KH
2077If you specify just a directory name as FILENAME, that means to use
2078the default file name but in that directory. You can also yank
2079the default file name into the minibuffer to edit it, using M-n.
2080
2081If the buffer is not already visiting a file, the default file name
2082for the output file is the buffer name.
2083
2084If optional second arg CONFIRM is non-nil, this function
2085asks for confirmation before overwriting an existing file.
912192d1 2086Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
2087;; (interactive "FWrite file: ")
2088 (interactive
2089 (list (if buffer-file-name
2090 (read-file-name "Write file: "
2091 nil nil nil nil)
7f99999a
KH
2092 (read-file-name "Write file: " default-directory
2093 (expand-file-name
2094 (file-name-nondirectory (buffer-name))
2095 default-directory)
2096 nil nil))
912192d1 2097 (not current-prefix-arg)))
b4da00e9 2098 (or (null filename) (string-equal filename "")
41f48cb1
RS
2099 (progn
2100 ;; If arg is just a directory,
7f99999a
KH
2101 ;; use the default file name, but in that directory.
2102 (if (file-directory-p filename)
41f48cb1 2103 (setq filename (concat (file-name-as-directory filename)
7f99999a
KH
2104 (file-name-nondirectory
2105 (or buffer-file-name (buffer-name))))))
c2fb8488
RS
2106 (and confirm
2107 (file-exists-p filename)
2108 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2109 (error "Canceled")))
5f65549e 2110 (set-visited-file-name filename (not confirm))))
b4da00e9 2111 (set-buffer-modified-p t)
6492b55d
KH
2112 ;; Make buffer writable if file is writable.
2113 (and buffer-file-name
2114 (file-writable-p buffer-file-name)
2115 (setq buffer-read-only nil))
912192d1 2116 (save-buffer))
b4da00e9
RM
2117\f
2118(defun backup-buffer ()
2119 "Make a backup of the disk file visited by the current buffer, if appropriate.
2120This is normally done before saving the buffer the first time.
2121If the value is non-nil, it is the result of `file-modes' on the original
2122file; this means that the caller, after saving the buffer, should change
27ab6944
KH
2123the modes of the new file to agree with the old modes.
2124
2125A backup may be done by renaming or by copying; see documentation of
2126variable `make-backup-files'. If it's done by renaming, then the file is
2127no longer accessible under its old name."
b4da00e9
RM
2128 (if (and make-backup-files (not backup-inhibited)
2129 (not buffer-backed-up)
2130 (file-exists-p buffer-file-name)
2131 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2132 '(?- ?l)))
2133 (let ((real-file-name buffer-file-name)
2134 backup-info backupname targets setmodes)
2135 ;; If specified name is a symbolic link, chase it to the target.
2136 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 2137 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
2138 (setq backup-info (find-backup-file-name real-file-name)
2139 backupname (car backup-info)
2140 targets (cdr backup-info))
5c6d31a4
SM
2141 ;; (if (file-directory-p buffer-file-name)
2142 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
2143 (if backup-info
2144 (condition-case ()
2145 (let ((delete-old-versions
2146 ;; If have old versions to maybe delete,
2147 ;; ask the user to confirm now, before doing anything.
2148 ;; But don't actually delete til later.
2149 (and targets
2150 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2151 (or delete-old-versions
2152 (y-or-n-p (format "Delete excess backup versions of %s? "
2153 real-file-name))))))
2154 ;; Actually write the back up file.
2155 (condition-case ()
2156 (if (or file-precious-flag
ffc0e1ca 2157 ; (file-symlink-p buffer-file-name)
eb650569
RS
2158 backup-by-copying
2159 (and backup-by-copying-when-linked
2160 (> (file-nlinks real-file-name) 1))
ffc0e1ca
AS
2161 (and (or backup-by-copying-when-mismatch
2162 (integerp backup-by-copying-when-privileged-mismatch))
eb650569 2163 (let ((attr (file-attributes real-file-name)))
ffc0e1ca
AS
2164 (and (or backup-by-copying-when-mismatch
2165 (and (integerp (nth 2 attr))
2166 (integerp backup-by-copying-when-privileged-mismatch)
2167 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2168 (or (nth 9 attr)
2169 (not (file-ownership-preserved-p real-file-name)))))))
eb650569
RS
2170 (condition-case ()
2171 (copy-file real-file-name backupname t t)
2172 (file-error
2173 ;; If copying fails because file BACKUPNAME
2174 ;; is not writable, delete that file and try again.
2175 (if (and (file-exists-p backupname)
2176 (not (file-writable-p backupname)))
2177 (delete-file backupname))
2178 (copy-file real-file-name backupname t t)))
2179 ;; rename-file should delete old backup.
2180 (rename-file real-file-name backupname t)
2181 (setq setmodes (file-modes backupname)))
2182 (file-error
2183 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
2184 (setq backupname (expand-file-name
2185 (convert-standard-filename
2186 "~/%backup%~")))
2187 (message "Cannot write backup file; backing up in %s"
2188 (file-name-nondirectory backupname))
eb650569
RS
2189 (sleep-for 1)
2190 (condition-case ()
2191 (copy-file real-file-name backupname t t)
2192 (file-error
2193 ;; If copying fails because file BACKUPNAME
2194 ;; is not writable, delete that file and try again.
2195 (if (and (file-exists-p backupname)
2196 (not (file-writable-p backupname)))
2197 (delete-file backupname))
2198 (copy-file real-file-name backupname t t)))))
2199 (setq buffer-backed-up t)
2200 ;; Now delete the old versions, if desired.
2201 (if delete-old-versions
2202 (while targets
2203 (condition-case ()
2204 (delete-file (car targets))
2205 (file-error nil))
2206 (setq targets (cdr targets))))
2207 setmodes)
2208 (file-error nil))))))
b4da00e9 2209
c3554e95 2210(defun file-name-sans-versions (name &optional keep-backup-version)
ffc0e1ca 2211 "Return file NAME sans backup versions or strings.
b4da00e9 2212This is a separate procedure so your site-init or startup file can
c3554e95
RS
2213redefine it.
2214If the optional argument KEEP-BACKUP-VERSION is non-nil,
2215we do not remove backup version numbers, only true file version numbers."
6eaebaa2 2216 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
2217 (if handler
2218 (funcall handler 'file-name-sans-versions name keep-backup-version)
2219 (substring name 0
2220 (if (eq system-type 'vax-vms)
2221 ;; VMS version number is (a) semicolon, optional
2222 ;; sign, zero or more digits or (b) period, option
2223 ;; sign, zero or more digits, provided this is the
2224 ;; second period encountered outside of the
2225 ;; device/directory part of the file name.
26add1bf
KH
2226 (or (string-match ";[-+]?[0-9]*\\'" name)
2227 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
2228 name)
2229 (match-beginning 1))
2230 (length name))
2231 (if keep-backup-version
2232 (length name)
dbb12f2c 2233 (or (string-match "\\.~[0-9.]+~\\'" name)
c3554e95
RS
2234 (string-match "~\\'" name)
2235 (length name))))))))
b4da00e9 2236
cb0cd911 2237(defun file-ownership-preserved-p (file)
ffc0e1ca 2238 "Return t if deleting FILE and rewriting it would preserve the owner."
cb0cd911
RS
2239 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2240 (if handler
2241 (funcall handler 'file-ownership-preserved-p file)
ec5533be 2242 (let ((attributes (file-attributes file)))
306faa42
RS
2243 ;; Return t if the file doesn't exist, since it's true that no
2244 ;; information would be lost by an (attempted) delete and create.
2245 (or (null attributes)
2246 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 2247
20b5d24c
RS
2248(defun file-name-sans-extension (filename)
2249 "Return FILENAME sans final \"extension\".
2531b0c3
EZ
2250The extension, in a file name, is the part that follows the last `.',
2251except that a leading `.', if any, doesn't count."
20b5d24c
RS
2252 (save-match-data
2253 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2254 directory)
2531b0c3
EZ
2255 (if (and (string-match "\\.[^.]*\\'" file)
2256 (not (eq 0 (match-beginning 0))))
20b5d24c
RS
2257 (if (setq directory (file-name-directory filename))
2258 (expand-file-name (substring file 0 (match-beginning 0))
2259 directory)
2260 (substring file 0 (match-beginning 0)))
2261 filename))))
2262
93a2702d
RS
2263(defun file-name-extension (filename &optional period)
2264 "Return FILENAME's final \"extension\".
2531b0c3
EZ
2265The extension, in a file name, is the part that follows the last `.',
2266except that a leading `.', if any, doesn't count.
93a2702d
RS
2267Return nil for extensionless file names such as `foo'.
2268Return the empty string for file names such as `foo.'.
2269
2270If PERIOD is non-nil, then the returned value includes the period
2271that delimits the extension, and if FILENAME has no extension,
2272the value is \"\"."
2273 (save-match-data
2274 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2531b0c3
EZ
2275 (if (and (string-match "\\.[^.]*\\'" file)
2276 (not (eq 0 (match-beginning 0))))
93a2702d
RS
2277 (substring file (+ (match-beginning 0) (if period 0 1)))
2278 (if period
2279 "")))))
2280
ffc0e1ca
AS
2281(defcustom make-backup-file-name-function nil
2282 "A function to use instead of the default `make-backup-file-name'.
2283A value of nil gives the default `make-backup-file-name' behaviour.
2284
d5798fa7 2285This could be buffer-local to do something special for specific
ffc0e1ca
AS
2286files. If you define it, you may need to change `backup-file-name-p'
2287and `file-name-sans-versions' too.
2288
2289See also `backup-directory-alist'."
2290 :group 'backup
2291 :type '(choice (const :tag "Default" nil)
2292 (function :tag "Your function")))
2293
2294(defcustom backup-directory-alist nil
2295 "Alist of filename patterns and backup directory names.
2296Each element looks like (REGEXP . DIRECTORY). Backups of files with
2297names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2298relative or absolute. If it is absolute, so that all matching files
2299are backed up into the same directory, the file names in this
2300directory will be the full name of the file backed up with all
2301directory separators changed to `!' to prevent clashes. This will not
2302work correctly if your filesystem truncates the resulting name.
2303
2304For the common case of all backups going into one directory, the alist
2305should contain a single element pairing \".\" with the appropriate
2306directory name.
2307
2308If this variable is nil, or it fails to match a filename, the backup
2309is made in the original file's directory.
2310
2311On MS-DOS filesystems without long names this variable is always
2312ignored."
2313 :group 'backup
dca5e71d 2314 :type '(repeat (cons (regexp :tag "Regexp matching filename")
ffc0e1ca
AS
2315 (directory :tag "Backup directory name"))))
2316
388d6ab5
RS
2317(defun normal-backup-enable-predicate (name)
2318 "Default `backup-enable-predicate' function.
2319Checks for files in `temporary-file-directory' or
2320`small-temporary-file-directory'."
2321 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2322 name 0 nil)))
2323 ;; Directory is under temporary-file-directory.
2324 (and (not (eq comp t))
2325 (< comp (- (length temporary-file-directory)))))
2326 (if small-temporary-file-directory
2327 (let ((comp (compare-strings small-temporary-file-directory
2328 0 nil
2329 name 0 nil)))
2330 ;; Directory is under small-temporary-file-directory.
2331 (and (not (eq comp t))
2332 (< comp (- (length small-temporary-file-directory)))))))))
2333
b4da00e9
RM
2334(defun make-backup-file-name (file)
2335 "Create the non-numeric backup file name for FILE.
ffc0e1ca
AS
2336Normally this will just be the file's name with `~' appended.
2337Customization hooks are provided as follows.
2338
2339If the variable `make-backup-file-name-function' is non-nil, its value
2340should be a function which will be called with FILE as its argument;
2341the resulting name is used.
2342
2343Otherwise a match for FILE is sought in `backup-directory-alist'; see
2344the documentation of that variable. If the directory for the backup
2345doesn't exist, it is created."
2346 (if make-backup-file-name-function
2347 (funcall make-backup-file-name-function file)
2348 (if (and (eq system-type 'ms-dos)
2349 (not (msdos-long-file-names)))
2350 (let ((fn (file-name-nondirectory file)))
2351 (concat (file-name-directory file)
2352 (or (and (string-match "\\`[^.]+\\'" fn)
2353 (concat (match-string 0 fn) ".~"))
2354 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2355 (concat (match-string 0 fn) "~")))))
2356 (concat (make-backup-file-name-1 file) "~"))))
2357
2358(defun make-backup-file-name-1 (file)
2359 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2360 (let ((alist backup-directory-alist)
2361 elt backup-directory dir-sep-string)
2362 (while alist
2363 (setq elt (pop alist))
2364 (if (string-match (car elt) file)
2365 (setq backup-directory (cdr elt)
2366 alist nil)))
2367 (if (null backup-directory)
2368 file
2369 (unless (file-exists-p backup-directory)
2370 (condition-case nil
2371 (make-directory backup-directory 'parents)
2372 (file-error file)))
2373 (if (file-name-absolute-p backup-directory)
2374 (progn
2375 (when (memq system-type '(windows-nt ms-dos))
2376 ;; Normalize DOSish file names: convert all slashes to
2377 ;; directory-sep-char, downcase the drive letter, if any,
2378 ;; and replace the leading "x:" with "/drive_x".
2379 (or (file-name-absolute-p file)
2380 (setq file (expand-file-name file))) ; make defaults explicit
2381 ;; Replace any invalid file-name characters (for the
2382 ;; case of backing up remote files).
446c097e 2383 (setq file (expand-file-name (convert-standard-filename file)))
ffc0e1ca 2384 (setq dir-sep-string (char-to-string directory-sep-char))
ffc0e1ca
AS
2385 (if (eq (aref file 1) ?:)
2386 (setq file (concat dir-sep-string
2387 "drive_"
2388 (char-to-string (downcase (aref file 0)))
2389 (if (eq (aref file 2) directory-sep-char)
2390 ""
2391 dir-sep-string)
2392 (substring file 2)))))
2393 ;; Make the name unique by substituting directory
2394 ;; separators. It may not really be worth bothering about
2395 ;; doubling `!'s in the original name...
2396 (expand-file-name
2397 (subst-char-in-string
2398 directory-sep-char ?!
2399 (replace-regexp-in-string "!" "!!" file))
2400 backup-directory))
2401 (expand-file-name (file-name-nondirectory file)
2402 (file-name-as-directory
2403 (expand-file-name backup-directory
2404 (file-name-directory file))))))))
b4da00e9
RM
2405
2406(defun backup-file-name-p (file)
2407 "Return non-nil if FILE is a backup file name (numeric or not).
2408This is a separate function so you can redefine it for customization.
2409You may need to redefine `file-name-sans-versions' as well."
066327ae 2410 (string-match "~\\'" file))
b4da00e9 2411
e2b30772
RS
2412(defvar backup-extract-version-start)
2413
2d051399 2414;; This is used in various files.
a7aa942a
KH
2415;; The usage of backup-extract-version-start is not very clean,
2416;; but I can't see a good alternative, so as of now I am leaving it alone.
2d051399 2417(defun backup-extract-version (fn)
ffc0e1ca 2418 "Given the name of a numeric backup file, FN, return the backup number.
e2b30772 2419Uses the free variable `backup-extract-version-start', whose value should be
2d051399 2420the index in the name where the version number begins."
e2b30772
RS
2421 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2422 (= (match-beginning 0) backup-extract-version-start))
2423 (string-to-int (substring fn backup-extract-version-start -1))
2d051399
RS
2424 0))
2425
b4da00e9
RM
2426;; I believe there is no need to alter this behavior for VMS;
2427;; since backup files are not made on VMS, it should not get called.
2428(defun find-backup-file-name (fn)
ffc0e1ca 2429 "Find a file name for a backup file FN, and suggestions for deletions.
b4da00e9 2430Value is a list whose car is the name for the backup file
ffc0e1ca
AS
2431and whose cdr is a list of old versions to consider deleting now.
2432If the value is nil, don't make a backup.
2433Uses `backup-directory-alist' in the same way as does
2434`make-backup-file-name'."
eb650569
RS
2435 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2436 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2437 (if handler
2438 (funcall handler 'find-backup-file-name fn)
f26d858e
EZ
2439 (if (or (eq version-control 'never)
2440 ;; We don't support numbered backups on plain MS-DOS
2441 ;; when long file names are unavailable.
2442 (and (eq system-type 'ms-dos)
2443 (not (msdos-long-file-names))))
b4da00e9 2444 (list (make-backup-file-name fn))
ffc0e1ca
AS
2445 (let* ((basic-name (make-backup-file-name-1 fn))
2446 (base-versions (concat (file-name-nondirectory basic-name)
2447 ".~"))
e2b30772 2448 (backup-extract-version-start (length base-versions))
eb650569 2449 (high-water-mark 0)
ffc0e1ca
AS
2450 (number-to-delete 0)
2451 possibilities deserve-versions-p versions)
eb650569
RS
2452 (condition-case ()
2453 (setq possibilities (file-name-all-completions
2454 base-versions
ffc0e1ca
AS
2455 (file-name-directory basic-name))
2456 versions (sort (mapcar #'backup-extract-version
2457 possibilities)
2458 #'<)
eb650569
RS
2459 high-water-mark (apply 'max 0 versions)
2460 deserve-versions-p (or version-control
2461 (> high-water-mark 0))
2462 number-to-delete (- (length versions)
ffc0e1ca
AS
2463 kept-old-versions
2464 kept-new-versions
2465 -1))
2466 (file-error (setq possibilities nil)))
eb650569 2467 (if (not deserve-versions-p)
8767d866 2468 (list (make-backup-file-name fn))
ffc0e1ca 2469 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
eb650569
RS
2470 (if (and (> number-to-delete 0)
2471 ;; Delete nothing if there is overflow
2472 ;; in the number of versions to keep.
2473 (>= (+ kept-new-versions kept-old-versions -1) 0))
ffc0e1ca
AS
2474 (mapcar (lambda (n)
2475 (format "%s.~%d~" basic-name n))
eb650569
RS
2476 (let ((v (nthcdr kept-old-versions versions)))
2477 (rplacd (nthcdr (1- number-to-delete) v) ())
2478 v))))))))))
b4da00e9 2479
b4da00e9
RM
2480(defun file-nlinks (filename)
2481 "Return number of names file FILENAME has."
2482 (car (cdr (file-attributes filename))))
6c636af9
RM
2483
2484(defun file-relative-name (filename &optional directory)
ffc0e1ca 2485 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2d6562a5
RS
2486This function returns a relative file name which is equivalent to FILENAME
2487when used with that default directory as the default.
2488If this is impossible (which can happen on MSDOS and Windows
2489when the file name and directory use different drive names)
2490then it returns FILENAME."
96c188b0 2491 (save-match-data
e2b30772
RS
2492 (let ((fname (expand-file-name filename)))
2493 (setq directory (file-name-as-directory
2494 (expand-file-name (or directory default-directory))))
2495 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2496 ;; drive names, they can't be relative, so return the absolute name.
2497 (if (and (or (eq system-type 'ms-dos)
2498 (eq system-type 'windows-nt))
2499 (not (string-equal (substring fname 0 2)
2500 (substring directory 0 2))))
2501 filename
9695aac6
RS
2502 (let ((ancestor ".")
2503 (fname-dir (file-name-as-directory fname)))
2504 (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2505 (not (string-match (concat "^" (regexp-quote directory)) fname)))
e2b30772 2506 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
2507 ancestor (if (equal ancestor ".")
2508 ".."
2509 (concat "../" ancestor))))
2510 ;; Now ancestor is empty, or .., or ../.., etc.
2511 (if (string-match (concat "^" (regexp-quote directory)) fname)
2512 ;; We matched within FNAME's directory part.
2513 ;; Add the rest of FNAME onto ANCESTOR.
2514 (let ((rest (substring fname (match-end 0))))
2515 (if (and (equal ancestor ".")
2516 (not (equal rest "")))
2517 ;; But don't bother with ANCESTOR if it would give us `./'.
2518 rest
2519 (concat (file-name-as-directory ancestor) rest)))
2520 ;; We matched FNAME's directory equivalent.
2521 ancestor))))))
b4da00e9
RM
2522\f
2523(defun save-buffer (&optional args)
2524 "Save current buffer in visited file if modified. Versions described below.
2525By default, makes the previous version into a backup file
2526 if previously requested or if this is the first save.
ac9650be 2527With 1 \\[universal-argument], marks this version
b4da00e9 2528 to become a backup when the next save is done.
ac9650be 2529With 2 \\[universal-argument]'s,
b4da00e9 2530 unconditionally makes the previous version into a backup file.
ac9650be
RS
2531With 3 \\[universal-argument]'s, marks this version
2532 to become a backup when the next save is done,
2533 and unconditionally makes the previous version into a backup file.
2534
749d2ee6 2535With argument of 0, never make the previous version into a backup file.
b4da00e9
RM
2536
2537If a file's name is FOO, the names of its numbered backup versions are
2538 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2539Numeric backups (rather than FOO~) will be made if value of
2540 `version-control' is not the atom `never' and either there are already
2541 numeric versions of the file being backed up, or `version-control' is
2542 non-nil.
2543We don't want excessive versions piling up, so there are variables
2544 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2545 and `kept-new-versions', which tells how many newest versions to keep.
2546 Defaults are 2 old versions and 2 new.
2547`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 2548If `delete-old-versions' is nil, system will query user
e73ec04b
RS
2549 before trimming versions. Otherwise it does it silently.
2550
749d2ee6
RS
2551If `vc-make-backup-files' is nil, which is the default,
2552 no backup files are made for files managed by version control.
2553 (This is because the version control system itself records previous versions.)
2554
e73ec04b 2555See the subroutine `basic-save-buffer' for more information."
b4da00e9
RM
2556 (interactive "p")
2557 (let ((modp (buffer-modified-p))
2558 (large (> (buffer-size) 50000))
b5a8e0fc
RS
2559 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2560 (memq args '(16 64)))))
b4da00e9 2561 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
b4990dde
GM
2562 (if (and modp large (buffer-file-name))
2563 (message "Saving file %s..." (buffer-file-name)))
b4da00e9
RM
2564 (basic-save-buffer)
2565 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2566
2567(defun delete-auto-save-file-if-necessary (&optional force)
2568 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2569Normally delete only if the file was written by this Emacs since
2570the last real save, but optional arg FORCE non-nil means delete anyway."
2571 (and buffer-auto-save-file-name delete-auto-save-files
2572 (not (string= buffer-file-name buffer-auto-save-file-name))
2573 (or force (recent-auto-save-p))
2574 (progn
2575 (condition-case ()
2576 (delete-file buffer-auto-save-file-name)
2577 (file-error nil))
2578 (set-buffer-auto-saved))))
2579
481f215b
KH
2580(defvar auto-save-hook nil
2581 "Normal hook run just before auto-saving.")
2582
ffc0e1ca
AS
2583(defcustom after-save-hook nil
2584 "Normal hook that is run after a buffer is saved to its file."
2585 :options '(executable-make-buffer-file-executable-if-script-p)
2586 :type 'hook
2587 :group 'files)
1cc852cc 2588
0516edee
RS
2589(defvar save-buffer-coding-system nil
2590 "If non-nil, use this coding system for saving the buffer.
2591More precisely, use this coding system in place of the
2592value of `buffer-file-coding-system', when saving the buffer.
2593Calling `write-region' for any purpose other than saving the buffer
2594will still use `buffer-file-coding-system'; this variable has no effect
2595in such cases.")
2596
d5fe94cc
RS
2597(make-variable-buffer-local 'save-buffer-coding-system)
2598(put 'save-buffer-coding-system 'permanent-local t)
2599
b4da00e9 2600(defun basic-save-buffer ()
1cc852cc 2601 "Save the current buffer in its visited file, if it has been modified.
e73ec04b
RS
2602The hooks `write-contents-hooks', `local-write-file-hooks' and
2603`write-file-hooks' get a chance to do the job of saving; if they do not,
2604then the buffer is saved in the visited file file in the usual way.
2605After saving the buffer, this function runs `after-save-hook'."
b4da00e9 2606 (interactive)
19618231 2607 (save-current-buffer
c11a94fe
RS
2608 ;; In an indirect buffer, save its base buffer instead.
2609 (if (buffer-base-buffer)
2610 (set-buffer (buffer-base-buffer)))
2611 (if (buffer-modified-p)
2612 (let ((recent-save (recent-auto-save-p))
2613 setmodes tempsetmodes)
2614 ;; On VMS, rename file and buffer to get rid of version number.
2615 (if (and (eq system-type 'vax-vms)
2616 (not (string= buffer-file-name
2617 (file-name-sans-versions buffer-file-name))))
2618 (let (buffer-new-name)
2619 ;; Strip VMS version number before save.
2620 (setq buffer-file-name
2621 (file-name-sans-versions buffer-file-name))
2622 ;; Construct a (unique) buffer name to correspond.
2623 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2624 (setq buffer-new-name (buffer-name buf))
2625 (kill-buffer buf))
2626 (rename-buffer buffer-new-name)))
2627 ;; If buffer has no file name, ask user for one.
2628 (or buffer-file-name
182891ef
RS
2629 (let ((filename
2630 (expand-file-name
2631 (read-file-name "File to save in: ") nil)))
2632 (and (file-exists-p filename)
2633 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2634 filename))
2635 (error "Canceled")))
2636 (set-visited-file-name filename)))
c11a94fe
RS
2637 (or (verify-visited-file-modtime (current-buffer))
2638 (not (file-exists-p buffer-file-name))
2639 (yes-or-no-p
2640 (format "%s has changed since visited or saved. Save anyway? "
2641 (file-name-nondirectory buffer-file-name)))
2642 (error "Save not confirmed"))
2643 (save-restriction
2644 (widen)
19618231
RS
2645 (save-excursion
2646 (and (> (point-max) 1)
407b4328 2647 (not find-file-literally)
19618231
RS
2648 (/= (char-after (1- (point-max))) ?\n)
2649 (not (and (eq selective-display t)
2650 (= (char-after (1- (point-max))) ?\r)))
2651 (or (eq require-final-newline t)
2652 (and require-final-newline
2653 (y-or-n-p
2654 (format "Buffer %s does not end in newline. Add one? "
2655 (buffer-name)))))
2656 (save-excursion
2657 (goto-char (point-max))
2658 (insert ?\n))))
fa5867f6
AS
2659 ;; Support VC version backups.
2660 (vc-before-save)
c11a94fe
RS
2661 (or (run-hook-with-args-until-success 'write-contents-hooks)
2662 (run-hook-with-args-until-success 'local-write-file-hooks)
2663 (run-hook-with-args-until-success 'write-file-hooks)
0ba5894b
RS
2664 ;; If a hook returned t, file is already "written".
2665 ;; Otherwise, write it the usual way now.
2666 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
2667 ;; Now we have saved the current buffer. Let's make sure
2668 ;; that buffer-file-coding-system is fixed to what
2669 ;; actually used for saving by binding it locally.
0516edee
RS
2670 (if save-buffer-coding-system
2671 (setq save-buffer-coding-system last-coding-system-used)
2672 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
2673 (setq buffer-file-number
2674 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
2675 (if setmodes
2676 (condition-case ()
2677 (set-file-modes buffer-file-name setmodes)
2678 (error nil))))
2679 ;; If the auto-save file was recent before this command,
2680 ;; delete it now.
2681 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
2682 ;; Support VC `implicit' locking.
2683 (vc-after-save)
c11a94fe
RS
2684 (run-hooks 'after-save-hook))
2685 (message "(No changes need to be saved)"))))
b4da00e9 2686
87d26afc
RS
2687;; This does the "real job" of writing a buffer into its visited file
2688;; and making a backup file. This is what is normally done
2689;; but inhibited if one of write-file-hooks returns non-nil.
2690;; It returns a value to store in setmodes.
2691(defun basic-save-buffer-1 ()
d5fe94cc
RS
2692 (if save-buffer-coding-system
2693 (let ((coding-system-for-write save-buffer-coding-system))
2694 (basic-save-buffer-2))
2695 (basic-save-buffer-2)))
2696
2697(defun basic-save-buffer-2 ()
2698 (let (tempsetmodes setmodes)
87d26afc
RS
2699 (if (not (file-writable-p buffer-file-name))
2700 (let ((dir (file-name-directory buffer-file-name)))
2701 (if (not (file-directory-p dir))
83c6f446
RS
2702 (if (file-exists-p dir)
2703 (error "%s is not a directory" dir)
cb2fdcfa 2704 (error "%s: no such directory" buffer-file-name))
87d26afc
RS
2705 (if (not (file-exists-p buffer-file-name))
2706 (error "Directory %s write-protected" dir)
2707 (if (yes-or-no-p
2708 (format "File %s is write-protected; try to save anyway? "
2709 (file-name-nondirectory
2710 buffer-file-name)))
2711 (setq tempsetmodes t)
2712 (error "Attempt to save to a file which you aren't allowed to write"))))))
2713 (or buffer-backed-up
2714 (setq setmodes (backup-buffer)))
76d5492b 2715 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
2716 (if (and file-precious-flag
2717 (file-writable-p dir))
2718 ;; If file is precious, write temp name, then rename it.
2719 ;; This requires write access to the containing dir,
2720 ;; which is why we don't try it if we don't have that access.
2721 (let ((realname buffer-file-name)
6782610c
RS
2722 tempname temp nogood i succeed
2723 (old-modtime (visited-file-modtime)))
f4a0f59b
RS
2724 (setq i 0)
2725 (setq nogood t)
2726 ;; Find the temporary name to write under.
2727 (while nogood
567c1ca9 2728 (setq tempname (format
28ee503c
KH
2729 (if (and (eq system-type 'ms-dos)
2730 (not (msdos-long-file-names)))
567c1ca9 2731 "%s#%d.tm#" ; MSDOS limits files to 8+3
ffc0e1ca
AS
2732 (if (memq system-type '(vax-vms axp-vms))
2733 "%s$tmp$%d"
2734 "%s#tmp#%d"))
567c1ca9 2735 dir i))
f4a0f59b
RS
2736 (setq nogood (file-exists-p tempname))
2737 (setq i (1+ i)))
2738 (unwind-protect
2739 (progn (clear-visited-file-modtime)
2740 (write-region (point-min) (point-max)
89095962
RS
2741 tempname nil realname
2742 buffer-file-truename)
f4a0f59b
RS
2743 (setq succeed t))
2744 ;; If writing the temp file fails,
2745 ;; delete the temp file.
76d5492b 2746 (or succeed
6782610c 2747 (progn
c9783dfe
RS
2748 (condition-case nil
2749 (delete-file tempname)
2750 (file-error nil))
6782610c 2751 (set-visited-file-modtime old-modtime))))
f4a0f59b
RS
2752 ;; Since we have created an entirely new file
2753 ;; and renamed it, make sure it gets the
2754 ;; right permission bits set.
2755 (setq setmodes (file-modes buffer-file-name))
2756 ;; We succeeded in writing the temp file,
2757 ;; so rename it.
2758 (rename-file tempname buffer-file-name t))
2759 ;; If file not writable, see if we can make it writable
2760 ;; temporarily while we write it.
2761 ;; But no need to do so if we have just backed it up
2762 ;; (setmodes is set) because that says we're superseding.
2763 (cond ((and tempsetmodes (not setmodes))
2764 ;; Change the mode back, after writing.
2765 (setq setmodes (file-modes buffer-file-name))
ffc0e1ca 2766 (set-file-modes buffer-file-name (logior setmodes 128))))
f4a0f59b 2767 (write-region (point-min) (point-max)
89095962 2768 buffer-file-name nil t buffer-file-truename)))
87d26afc
RS
2769 setmodes))
2770
ffc0e1ca 2771(defun save-some-buffers (&optional arg pred)
b4da00e9 2772 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1 2773Optional argument (the prefix) non-nil means save all with no questions.
ffc0e1ca
AS
2774Optional second argument PRED determines which buffers are considered:
2775If PRED is nil, all the file-visiting buffers are considered.
2776If PRED is t, then certain non-file buffers will also be considered.
2777If PRED is a zero-argument function, it indicates for each buffer whether
2778to consider it or not when called with that buffer current."
b4da00e9 2779 (interactive "P")
907482b9 2780 (save-window-excursion
76d5492b
RM
2781 (let* ((queried nil)
2782 (files-done
2783 (map-y-or-n-p
2784 (function
2785 (lambda (buffer)
2786 (and (buffer-modified-p buffer)
2787 (not (buffer-base-buffer buffer))
2788 (or
2789 (buffer-file-name buffer)
ffc0e1ca 2790 (and pred
76d5492b
RM
2791 (progn
2792 (set-buffer buffer)
2793 (and buffer-offer-save (> (buffer-size) 0)))))
ffc0e1ca
AS
2794 (or (not (functionp pred))
2795 (with-current-buffer buffer (funcall pred)))
76d5492b
RM
2796 (if arg
2797 t
2798 (setq queried t)
2799 (if (buffer-file-name buffer)
2800 (format "Save file %s? "
2801 (buffer-file-name buffer))
2802 (format "Save buffer %s? "
2803 (buffer-name buffer)))))))
2804 (function
2805 (lambda (buffer)
2806 (set-buffer buffer)
2807 (save-buffer)))
2808 (buffer-list)
2809 '("buffer" "buffers" "save")
2810 (list (list ?\C-r (lambda (buf)
2a9fe1e2
RS
2811 (view-buffer buf
2812 (function
2813 (lambda (ignore)
2814 (exit-recursive-edit))))
76d5492b
RM
2815 (recursive-edit)
2816 ;; Return nil to ask about BUF again.
2817 nil)
2818 "display the current buffer"))))
2819 (abbrevs-done
2820 (and save-abbrevs abbrevs-changed
2821 (progn
2822 (if (or arg
02c6a1cc 2823 (eq save-abbrevs 'silently)
76d5492b
RM
2824 (y-or-n-p (format "Save abbrevs in %s? "
2825 abbrev-file-name)))
2826 (write-abbrev-file nil))
2827 ;; Don't keep bothering user if he says no.
2828 (setq abbrevs-changed nil)
2829 t))))
2830 (or queried (> files-done 0) abbrevs-done
5625c2fc 2831 (message "(No files need saving)")))))
b4da00e9
RM
2832\f
2833(defun not-modified (&optional arg)
2834 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
2835With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2836
2837It is not a good idea to use this function in Lisp programs, because it
2838prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
2839 (interactive "P")
2840 (message (if arg "Modification-flag set"
2841 "Modification-flag cleared"))
2842 (set-buffer-modified-p arg))
2843
2844(defun toggle-read-only (&optional arg)
2845 "Change whether this buffer is visiting its file read-only.
2a9fe1e2
RS
2846With arg, set read-only iff arg is positive.
2847If visiting file read-only and `view-read-only' is non-nil, enter view mode."
b4da00e9 2848 (interactive "P")
2a9fe1e2
RS
2849 (cond
2850 ((and arg (if (> (prefix-numeric-value arg) 0) buffer-read-only
2851 (not buffer-read-only))) ; If buffer-read-only is set correctly,
2852 nil) ; do nothing.
2853 ;; Toggle.
2854 ((and buffer-read-only view-mode)
ca597f41
KH
2855 (View-exit-and-edit)
2856 (make-local-variable 'view-read-only)
2857 (setq view-read-only t)) ; Must leave view mode.
2a9fe1e2
RS
2858 ((and (not buffer-read-only) view-read-only
2859 (not (eq (get major-mode 'mode-class) 'special)))
2860 (view-mode-enter))
2861 (t (setq buffer-read-only (not buffer-read-only))
2862 (force-mode-line-update))))
b4da00e9 2863
912192d1 2864(defun insert-file (filename)
b4da00e9
RM
2865 "Insert contents of file FILENAME into buffer after point.
2866Set mark after the inserted text.
2867
2868This function is meant for the user to run interactively.
2869Don't call it from programs! Use `insert-file-contents' instead.
2870\(Its calling sequence is different; see its documentation)."
912192d1 2871 (interactive "*fInsert file: ")
3be6243a
RS
2872 (if (file-directory-p filename)
2873 (signal 'file-error (list "Opening input file" "file is a directory"
2874 filename)))
912192d1 2875 (let ((tem (insert-file-contents filename)))
b4da00e9
RM
2876 (push-mark (+ (point) (car (cdr tem))))))
2877
912192d1 2878(defun append-to-file (start end filename)
b4da00e9
RM
2879 "Append the contents of the region to the end of file FILENAME.
2880When called from a function, expects three arguments,
2881START, END and FILENAME. START and END are buffer positions
da30bf98 2882saying what text to write."
912192d1
KH
2883 (interactive "r\nFAppend to file: ")
2884 (write-region start end filename t))
b4da00e9
RM
2885
2886(defun file-newest-backup (filename)
2887 "Return most recent backup file for FILENAME or nil if no backups exist."
ffc0e1ca
AS
2888 ;; `make-backup-file-name' will get us the right directory for
2889 ;; ordinary or numeric backups. It might create a directory for
2890 ;; backups as a side-effect, according to `backup-directory-alist'.
4803e625 2891 (let* ((filename (make-backup-file-name filename))
b4da00e9
RM
2892 (file (file-name-nondirectory filename))
2893 (dir (file-name-directory filename))
2894 (comp (file-name-all-completions file dir))
cf7e94a0
RS
2895 (newest nil)
2896 tem)
b4da00e9 2897 (while comp
ffc0e1ca 2898 (setq tem (pop comp))
cf7e94a0
RS
2899 (cond ((and (backup-file-name-p tem)
2900 (string= (file-name-sans-versions tem) file))
2901 (setq tem (concat dir tem))
2902 (if (or (null newest)
2903 (file-newer-than-file-p tem newest))
2904 (setq newest tem)))))
b4da00e9
RM
2905 newest))
2906
2907(defun rename-uniquely ()
2908 "Rename current buffer to a similar name not already taken.
2909This function is useful for creating multiple shell process buffers
2910or multiple mail buffers, etc."
2911 (interactive)
40eb8038 2912 (save-match-data
e0df3aef
KH
2913 (let ((base-name (buffer-name)))
2914 (and (string-match "<[0-9]+>\\'" base-name)
2915 (not (and buffer-file-name
2916 (string= base-name
2917 (file-name-nondirectory buffer-file-name))))
2918 ;; If the existing buffer name has a <NNN>,
2919 ;; which isn't part of the file name (if any),
2920 ;; then get rid of that.
2921 (setq base-name (substring base-name 0 (match-beginning 0))))
2922 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 2923 (force-mode-line-update))))
5bbbceb1 2924
4e43240a 2925(defun make-directory (dir &optional parents)
5ce8bb89
RS
2926 "Create the directory DIR and any nonexistent parent dirs.
2927Interactively, the default choice of directory to create
2928is the current default directory for file names.
0225ae5e 2929That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
2930
2931Noninteractively, the second (optional) argument PARENTS says whether
2932to create parent directories if they don't exist."
2933 (interactive
2934 (list (read-file-name "Make directory: " default-directory default-directory
2935 nil nil)
2936 t))
6eaebaa2 2937 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
2938 (if handler
2939 (funcall handler 'make-directory dir parents)
2940 (if (not parents)
2941 (make-directory-internal dir)
2942 (let ((dir (directory-file-name (expand-file-name dir)))
2943 create-list)
2944 (while (not (file-exists-p dir))
76d5492b 2945 (setq create-list (cons dir create-list)
4e43240a
RS
2946 dir (directory-file-name (file-name-directory dir))))
2947 (while create-list
2948 (make-directory-internal (car create-list))
2949 (setq create-list (cdr create-list))))))))
b4da00e9
RM
2950\f
2951(put 'revert-buffer-function 'permanent-local t)
2952(defvar revert-buffer-function nil
0973d78b
RS
2953 "Function to use to revert this buffer, or nil to do the default.
2954The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2955which are the arguments that `revert-buffer' received.")
b4da00e9
RM
2956
2957(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2958(defvar revert-buffer-insert-file-contents-function nil
2959 "Function to use to insert contents when reverting this buffer.
2960Gets two args, first the nominal file name to use,
2df32500
RS
2961and second, t if reading the auto-save file.
2962
2963The function you specify is responsible for updating (or preserving) point.")
b4da00e9 2964
5f76e7d4
KH
2965(defvar before-revert-hook nil
2966 "Normal hook for `revert-buffer' to run before reverting.
2967If `revert-buffer-function' is used to override the normal revert
2968mechanism, this hook is not used.")
2969
2970(defvar after-revert-hook nil
2971 "Normal hook for `revert-buffer' to run after reverting.
2972Note that the hook value that it runs is the value that was in effect
2973before reverting; that makes a difference if you have buffer-local
2974hook functions.
2975
2976If `revert-buffer-function' is used to override the normal revert
2977mechanism, this hook is not used.")
2978
1554c03b
RS
2979(defvar revert-buffer-internal-hook)
2980
9a30563f 2981(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 2982 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 2983This undoes all changes since the file was visited or saved.
8c0e7b73
JB
2984With a prefix argument, offer to revert from latest auto-save file, if
2985that is more recent than the visited file.
1ab31687 2986
7e7c9c4e
RS
2987This command also works for special buffers that contain text which
2988doesn't come from a file, but reflects some other data base instead:
2989for example, Dired buffers and buffer-list buffers. In these cases,
2990it reconstructs the buffer contents from the appropriate data base.
2991
65ee6096 2992When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
2993to revert from the auto-save file when this is nil. Note that the
2994sense of this argument is the reverse of the prefix argument, for the
2995sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2996to nil.
2997
2998Optional second argument NOCONFIRM means don't ask for confirmation at
ffc0e1ca 2999all. (The local variable `revert-without-query', if non-nil, prevents
d1f04130 3000confirmation.)
b4da00e9 3001
5b2b26d5
RS
3002Optional third argument PRESERVE-MODES non-nil means don't alter
3003the files modes. Normally we reinitialize them using `normal-mode'.
3004
8c0e7b73 3005If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
3006do all the work for this command. Otherwise, the hooks
3007`before-revert-hook' and `after-revert-hook' are run at the beginning
3008and the end, and if `revert-buffer-insert-file-contents-function' is
3009non-nil, it is called instead of rereading visited file contents."
fb6208a6 3010
1ab31687
JB
3011 ;; I admit it's odd to reverse the sense of the prefix argument, but
3012 ;; there is a lot of code out there which assumes that the first
3013 ;; argument should be t to avoid consulting the auto-save file, and
3014 ;; there's no straightforward way to encourage authors to notice a
3015 ;; reversal of the argument sense. So I'm just changing the user
3016 ;; interface, but leaving the programmatic interface the same.
e0867e99 3017 (interactive (list (not current-prefix-arg)))
b4da00e9 3018 (if revert-buffer-function
1ab31687 3019 (funcall revert-buffer-function ignore-auto noconfirm)
2df32500 3020 (let* ((auto-save-p (and (not ignore-auto)
1ab31687 3021 (recent-auto-save-p)
b4da00e9
RM
3022 buffer-auto-save-file-name
3023 (file-readable-p buffer-auto-save-file-name)
3024 (y-or-n-p
3025 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3026 (file-name (if auto-save-p
3027 buffer-auto-save-file-name
3028 buffer-file-name)))
3029 (cond ((null file-name)
3030 (error "Buffer does not seem to be associated with any file"))
3031 ((or noconfirm
db8c4866
RS
3032 (and (not (buffer-modified-p))
3033 (let ((tail revert-without-query)
3034 (found nil))
3035 (while tail
3036 (if (string-match (car tail) file-name)
3037 (setq found t))
3038 (setq tail (cdr tail)))
3039 found))
b4da00e9
RM
3040 (yes-or-no-p (format "Revert buffer from file %s? "
3041 file-name)))
4fbf62ee 3042 (run-hooks 'before-revert-hook)
b4da00e9
RM
3043 ;; If file was backed up but has changed since,
3044 ;; we shd make another backup.
3045 (and (not auto-save-p)
5bbbceb1 3046 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
3047 (setq buffer-backed-up nil))
3048 ;; Get rid of all undo records for this buffer.
3049 (or (eq buffer-undo-list t)
3050 (setq buffer-undo-list nil))
ba5c8c93
KH
3051 ;; Effectively copy the after-revert-hook status,
3052 ;; since after-find-file will clobber it.
3053 (let ((global-hook (default-value 'after-revert-hook))
3054 (local-hook-p (local-variable-p 'after-revert-hook))
3055 (local-hook (and (local-variable-p 'after-revert-hook)
3056 after-revert-hook)))
3057 (let (buffer-read-only
3058 ;; Don't make undo records for the reversion.
3059 (buffer-undo-list t))
3060 (if revert-buffer-insert-file-contents-function
3061 (funcall revert-buffer-insert-file-contents-function
3062 file-name auto-save-p)
3063 (if (not (file-exists-p file-name))
3064 (error "File %s no longer exists!" file-name))
3065 ;; Bind buffer-file-name to nil
3066 ;; so that we don't try to lock the file.
3067 (let ((buffer-file-name nil))
3068 (or auto-save-p
3069 (unlock-buffer)))
3070 (widen)
b77d8211
KH
3071 (let ((coding-system-for-read
3072 ;; Auto-saved file shoule be read without
3073 ;; any code conversion.
68875f0e 3074 (if auto-save-p 'emacs-mule-unix
b77d8211 3075 coding-system-for-read)))
2df32500 3076 ;; Note that this preserves point in an intelligent way.
b77d8211
KH
3077 (insert-file-contents file-name (not auto-save-p)
3078 nil nil t))))
ba5c8c93
KH
3079 ;; Recompute the truename in case changes in symlinks
3080 ;; have changed the truename.
3081 (setq buffer-file-truename
3082 (abbreviate-file-name (file-truename buffer-file-name)))
9a30563f 3083 (after-find-file nil nil t t preserve-modes)
ba5c8c93
KH
3084 ;; Run after-revert-hook as it was before we reverted.
3085 (setq-default revert-buffer-internal-hook global-hook)
3086 (if local-hook-p
3087 (progn
3088 (make-local-variable 'revert-buffer-internal-hook)
3089 (setq revert-buffer-internal-hook local-hook))
3090 (kill-local-variable 'revert-buffer-internal-hook))
3091 (run-hooks 'revert-buffer-internal-hook))
4fbf62ee 3092 t)))))
b4da00e9
RM
3093
3094(defun recover-file (file)
3095 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
3096 ;; Actually putting the file name in the minibuffer should be used
3097 ;; only rarely.
3098 ;; Not just because users often use the default.
e1dadc17 3099 (interactive "FRecover file: ")
b4da00e9 3100 (setq file (expand-file-name file))
f7da6740
RS
3101 (if (auto-save-file-name-p (file-name-nondirectory file))
3102 (error "%s is an auto-save file" file))
b4da00e9
RM
3103 (let ((file-name (let ((buffer-file-name file))
3104 (make-auto-save-file-name))))
945e1965
RS
3105 (cond ((if (file-exists-p file)
3106 (not (file-newer-than-file-p file-name file))
3107 (not (file-exists-p file-name)))
b4da00e9
RM
3108 (error "Auto-save file %s not current" file-name))
3109 ((save-window-excursion
ffc0e1ca
AS
3110 (with-output-to-temp-buffer "*Directory*"
3111 (buffer-disable-undo standard-output)
3112 (save-excursion
3113 (let ((switches dired-listing-switches))
3114 (if (file-symlink-p file)
3115 (setq switches (concat switches "L")))
3116 (set-buffer standard-output)
bc22fd18
EZ
3117 ;; Use insert-directory-safely, not insert-directory,
3118 ;; because these files might not exist. In particular,
3119 ;; FILE might not exist if the auto-save file was for
3120 ;; a buffer that didn't visit a file, such as "*mail*".
3121 ;; The code in v20.x called `ls' directly, so we need
3122 ;; to emulate what `ls' did in that case.
3123 (insert-directory-safely file switches)
3124 (insert-directory-safely file-name switches))))
b4da00e9
RM
3125 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3126 (switch-to-buffer (find-file-noselect file t))
82d0954a 3127 (let ((buffer-read-only nil)
1e87edf5
KH
3128 ;; Keep the current buffer-file-coding-system.
3129 (coding-system buffer-file-coding-system)
82d0954a 3130 ;; Auto-saved file shoule be read without any code conversion.
68875f0e 3131 (coding-system-for-read 'emacs-mule-unix))
b4da00e9 3132 (erase-buffer)
1e87edf5
KH
3133 (insert-file-contents file-name nil)
3134 (set-buffer-file-coding-system coding-system))
8cfb9d46 3135 (after-find-file nil nil t))
ffa7ab70 3136 (t (error "Recover-file cancelled")))))
b4da00e9 3137
6598027d 3138(defun recover-session ()
9aee5392
RS
3139 "Recover auto save files from a previous Emacs session.
3140This command first displays a Dired buffer showing you the
3141previous sessions that you could recover from.
3142To choose one, move point to the proper line and then type C-c C-c.
3143Then you'll be asked about a number of files to recover."
3144 (interactive)
363a5030
RS
3145 (if (null auto-save-list-file-prefix)
3146 (error "You set `auto-save-list-file-prefix' to disable making session files"))
ffc0e1ca
AS
3147 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3148 (unless (file-directory-p dir)
3149 (make-directory dir t)))
6f4983e6 3150 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
3151 (dired (concat auto-save-list-file-prefix "*")
3152 (concat dired-listing-switches "t")))
05e076c7
AS
3153 (save-excursion
3154 (goto-char (point-min))
3155 (or (looking-at " Move to the session you want to recover,")
3156 (let ((inhibit-read-only t))
3157 ;; Each line starts with a space
3158 ;; so that Font Lock mode won't highlight the first character.
3159 (insert " Move to the session you want to recover,\n"
3160 " then type C-c C-c to select it.\n\n"
3161 " You can also delete some of these files;\n"
3162 " type d on a line to mark that file for deletion.\n\n"))))
9aee5392 3163 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 3164 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 3165
80280bb7 3166(defun recover-session-finish ()
9aee5392
RS
3167 "Choose one saved session to recover auto-save files from.
3168This command is used in the special Dired buffer created by
80280bb7 3169\\[recover-session]."
9aee5392
RS
3170 (interactive)
3171 ;; Get the name of the session file to recover from.
3172 (let ((file (dired-get-filename))
953a03b2 3173 files
9aee5392 3174 (buffer (get-buffer-create " *recover*")))
c11032b9 3175 (dired-unmark 1)
033ef863 3176 (dired-do-flagged-delete t)
9aee5392
RS
3177 (unwind-protect
3178 (save-excursion
3179 ;; Read in the auto-save-list file.
3180 (set-buffer buffer)
3181 (erase-buffer)
3182 (insert-file-contents file)
953a03b2
RS
3183 ;; Loop thru the text of that file
3184 ;; and get out the names of the files to recover.
3185 (while (not (eobp))
3186 (let (thisfile autofile)
3187 (if (eolp)
3188 ;; This is a pair of lines for a non-file-visiting buffer.
3189 ;; Get the auto-save file name and manufacture
3190 ;; a "visited file name" from that.
3191 (progn
3192 (forward-line 1)
3193 (setq autofile
3194 (buffer-substring-no-properties
3195 (point)
3196 (save-excursion
3197 (end-of-line)
3198 (point))))
3199 (setq thisfile
3200 (expand-file-name
3201 (substring
3202 (file-name-nondirectory autofile)
3203 1 -1)
3204 (file-name-directory autofile)))
3205 (forward-line 1))
3206 ;; This pair of lines is a file-visiting
3207 ;; buffer. Use the visited file name.
3208 (progn
3209 (setq thisfile
3210 (buffer-substring-no-properties
3211 (point) (progn (end-of-line) (point))))
3212 (forward-line 1)
3213 (setq autofile
3214 (buffer-substring-no-properties
3215 (point) (progn (end-of-line) (point))))
3216 (forward-line 1)))
3217 ;; Ignore a file if its auto-save file does not exist now.
3218 (if (file-exists-p autofile)
3219 (setq files (cons thisfile files)))))
3220 (setq files (nreverse files))
945e1965
RS
3221 ;; The file contains a pair of line for each auto-saved buffer.
3222 ;; The first line of the pair contains the visited file name
3223 ;; or is empty if the buffer was not visiting a file.
3224 ;; The second line is the auto-save file name.
953a03b2
RS
3225 (if files
3226 (map-y-or-n-p "Recover %s? "
3227 (lambda (file)
3228 (condition-case nil
3229 (save-excursion (recover-file file))
76d5492b 3230 (error
953a03b2
RS
3231 "Failed to recover `%s'" file)))
3232 files
3233 '("file" "files" "recover"))
3234 (message "No files can be recovered from this session now")))
9aee5392
RS
3235 (kill-buffer buffer))))
3236
73ba610a
RS
3237(defun kill-some-buffers (&optional list)
3238 "For each buffer in LIST, ask whether to kill it.
3239LIST defaults to all existing live buffers."
b4da00e9 3240 (interactive)
73ba610a
RS
3241 (if (null list)
3242 (setq list (buffer-list)))
3243 (while list
3244 (let* ((buffer (car list))
3245 (name (buffer-name buffer)))
3246 (and (not (string-equal name ""))
3247 (/= (aref name 0) ? )
3248 (yes-or-no-p
3249 (format "Buffer %s %s. Kill? "
3250 name
3251 (if (buffer-modified-p buffer)
3252 "HAS BEEN EDITED" "is unmodified")))
3253 (kill-buffer buffer)))
3254 (setq list (cdr list))))
b4da00e9
RM
3255\f
3256(defun auto-save-mode (arg)
3257 "Toggle auto-saving of contents of current buffer.
f3e23606 3258With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
3259 (interactive "P")
3260 (setq buffer-auto-save-file-name
3261 (and (if (null arg)
74b9c2af 3262 (or (not buffer-auto-save-file-name)
4e0c8650 3263 ;; If auto-save is off because buffer has shrunk,
74b9c2af
RS
3264 ;; then toggling should turn it on.
3265 (< buffer-saved-size 0))
b4da00e9
RM
3266 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
3267 (if (and buffer-file-name auto-save-visited-file-name
3268 (not buffer-read-only))
3269 buffer-file-name
3270 (make-auto-save-file-name))))
0b7f1ef2
RS
3271 ;; If -1 was stored here, to temporarily turn off saving,
3272 ;; turn it back on.
3273 (and (< buffer-saved-size 0)
3274 (setq buffer-saved-size 0))
b4da00e9
RM
3275 (if (interactive-p)
3276 (message "Auto-save %s (in this buffer)"
3277 (if buffer-auto-save-file-name "on" "off")))
3278 buffer-auto-save-file-name)
3279
3280(defun rename-auto-save-file ()
3281 "Adjust current buffer's auto save file name for current conditions.
3282Also rename any existing auto save file, if it was made in this session."
3283 (let ((osave buffer-auto-save-file-name))
3284 (setq buffer-auto-save-file-name
3285 (make-auto-save-file-name))
3286 (if (and osave buffer-auto-save-file-name
3287 (not (string= buffer-auto-save-file-name buffer-file-name))
3288 (not (string= buffer-auto-save-file-name osave))
3289 (file-exists-p osave)
3290 (recent-auto-save-p))
3291 (rename-file osave buffer-auto-save-file-name t))))
3292
3293(defun make-auto-save-file-name ()
3294 "Return file name to use for auto-saves of current buffer.
3295Does not consider `auto-save-visited-file-name' as that variable is checked
3296before calling this function. You can redefine this for customization.
3297See also `auto-save-file-name-p'."
3298 (if buffer-file-name
ffc0e1ca
AS
3299 (let ((list auto-save-file-name-transforms)
3300 (filename buffer-file-name)
3301 result)
3302 ;; Apply user-specified translations
3303 ;; to the file name.
3304 (while (and list (not result))
3305 (if (string-match (car (car list)) filename)
3306 (setq result (replace-match (cadr (car list)) t nil
3307 filename)))
3308 (setq list (cdr list)))
3309 (if result (setq filename result))
3310
1e57a696
EZ
3311 (setq result
3312 (if (and (eq system-type 'ms-dos)
3313 (not (msdos-long-file-names)))
3314 ;; We truncate the file name to DOS 8+3 limits
3315 ;; before doing anything else, because the regexp
3316 ;; passed to string-match below cannot handle
3317 ;; extensions longer than 3 characters, multiple
3318 ;; dots, and other atrocities.
3319 (let ((fn (dos-8+3-filename
3320 (file-name-nondirectory buffer-file-name))))
3321 (string-match
3322 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
3323 fn)
3324 (concat (file-name-directory buffer-file-name)
3325 "#" (match-string 1 fn)
3326 "." (match-string 3 fn) "#"))
3327 (concat (file-name-directory filename)
3328 "#"
3329 (file-name-nondirectory filename)
3330 "#")))
3331 ;; Make sure auto-save file names don't contain characters
3332 ;; invalid for the underlying filesystem.
3333 (if (and (memq system-type '(ms-dos windows-nt))
3334 ;; Don't modify remote (ange-ftp) filenames
3335 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
3336 (convert-standard-filename result)
3337 result))
0a1763b4
RS
3338
3339 ;; Deal with buffers that don't have any associated files. (Mail
3340 ;; mode tends to create a good number of these.)
3341
7d483e8c 3342 (let ((buffer-name (buffer-name))
0a1763b4 3343 (limit 0))
c3348e10
RS
3344 ;; Eliminate all slashes and backslashes by
3345 ;; replacing them with sequences that start with %.
3346 ;; Quote % also, to keep distinct names distinct.
3347 (while (string-match "[/\\%]" buffer-name limit)
3348 (let* ((character (aref buffer-name (match-beginning 0)))
3349 (replacement
3350 (cond ((eq character ?%) "%%")
3351 ((eq character ?/) "%+")
3352 ((eq character ?\\) "%-"))))
3353 (setq buffer-name (replace-match replacement t t buffer-name))
3354 (setq limit (1+ (match-end 0)))))
a8abaf83 3355 ;; Generate the file name.
75244a67 3356 (make-temp-file
1e57a696
EZ
3357 (let ((fname
3358 (expand-file-name
3359 (format "#%s#" buffer-name)
3360 ;; Try a few alternative directories, to get one we can
3361 ;; write it.
3362 (cond
3363 ((file-writable-p default-directory) default-directory)
3364 ((file-writable-p "/var/tmp/") "/var/tmp/")
3365 ("~/")))))
3366 (if (and (memq system-type '(ms-dos windows-nt))
3367 ;; Don't modify remote (ange-ftp) filenames
3368 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
3369 ;; The call to convert-standard-filename is in case
3370 ;; buffer-name includes characters not allowed by the
3371 ;; DOS/Windows filesystems. make-temp-file writes to the
3372 ;; file it creates, so we must fix the file name _before_
3373 ;; make-temp-file is called.
3374 (convert-standard-filename fname)
3375 fname))))))
b4da00e9
RM
3376
3377(defun auto-save-file-name-p (filename)
3378 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3379FILENAME should lack slashes. You can redefine this for customization."
3380 (string-match "^#.*#$" filename))
3381\f
6f4983e6
RS
3382(defun wildcard-to-regexp (wildcard)
3383 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3384The generated regexp will match a filename iff the filename
3385matches that wildcard according to shell rules. Only wildcards known
3386by `sh' are supported."
3387 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3388 ;; Copy the initial run of non-special characters.
3389 (result (substring wildcard 0 i))
3390 (len (length wildcard)))
3391 ;; If no special characters, we're almost done.
3392 (if i
3393 (while (< i len)
3394 (let ((ch (aref wildcard i))
3395 j)
3396 (setq
3397 result
3398 (concat result
3399 (cond
7e7c9c4e
RS
3400 ((and (eq ch ?\[)
3401 (< (1+ i) len)
3402 (eq (aref wildcard (1+ i)) ?\]))
3403 "\\[")
6f4983e6
RS
3404 ((eq ch ?\[) ; [...] maps to regexp char class
3405 (progn
3406 (setq i (1+ i))
3407 (concat
3408 (cond
3409 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3410 (progn
3411 (setq i (1+ i))
3412 (if (eq (aref wildcard i) ?\])
3413 (progn
3414 (setq i (1+ i))
3415 "[^]")
3416 "[^")))
3417 ((eq (aref wildcard i) ?^)
3418 ;; Found "[^". Insert a `\0' character
3419 ;; (which cannot happen in a filename)
3420 ;; into the character class, so that `^'
3421 ;; is not the first character after `[',
3422 ;; and thus non-special in a regexp.
3423 (progn
3424 (setq i (1+ i))
3425 "[\000^"))
3426 ((eq (aref wildcard i) ?\])
3427 ;; I don't think `]' can appear in a
3428 ;; character class in a wildcard, but
3429 ;; let's be general here.
3430 (progn
3431 (setq i (1+ i))
3432 "[]"))
3433 (t "["))
3434 (prog1 ; copy everything upto next `]'.
3435 (substring wildcard
3436 i
3437 (setq j (string-match
3438 "]" wildcard i)))
3439 (setq i (if j (1- j) (1- len)))))))
3440 ((eq ch ?.) "\\.")
3441 ((eq ch ?*) "[^\000]*")
3442 ((eq ch ?+) "\\+")
3443 ((eq ch ?^) "\\^")
3444 ((eq ch ?$) "\\$")
3445 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3446 ((eq ch ??) "[^\000]")
3447 (t (char-to-string ch)))))
3448 (setq i (1+ i)))))
3449 ;; Shell wildcards should match the entire filename,
3450 ;; not its part. Make the regexp say so.
3451 (concat "\\`" result "\\'")))
3452\f
21540597 3453(defcustom list-directory-brief-switches
b4da00e9 3454 (if (eq system-type 'vax-vms) "" "-CF")
ffc0e1ca 3455 "*Switches for `list-directory' to pass to `ls' for brief listing."
21540597
RS
3456 :type 'string
3457 :group 'dired)
b4da00e9 3458
21540597 3459(defcustom list-directory-verbose-switches
b4da00e9
RM
3460 (if (eq system-type 'vax-vms)
3461 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3462 "-l")
ffc0e1ca 3463 "*Switches for `list-directory' to pass to `ls' for verbose listing."
21540597
RS
3464 :type 'string
3465 :group 'dired)
b4da00e9 3466
5de148a2
RS
3467(defun file-expand-wildcards (pattern &optional full)
3468 "Expand wildcard pattern PATTERN.
4db2a7de
RS
3469This returns a list of file names which match the pattern.
3470
3471If PATTERN is written as an absolute relative file name,
3472the values are absolute also.
3473
3474If PATTERN is written as a relative file name, it is interpreted
3475relative to the current default directory, `default-directory'.
3476The file names returned are normally also relative to the current
3477default directory. However, if FULL is non-nil, they are absolute."
3478 (let* ((nondir (file-name-nondirectory pattern))
3479 (dirpart (file-name-directory pattern))
3480 ;; A list of all dirs that DIRPART specifies.
3481 ;; This can be more than one dir
3482 ;; if DIRPART contains wildcards.
18b0f8cf 3483 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4db2a7de
RS
3484 (mapcar 'file-name-as-directory
3485 (file-expand-wildcards (directory-file-name dirpart)))
3486 (list dirpart)))
3487 contents)
3488 (while dirs
3489 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
3490 (file-directory-p (directory-file-name (car dirs))))
3491 (let ((this-dir-contents
18b0f8cf
AS
3492 ;; Filter out "." and ".."
3493 (delq nil
3494 (mapcar #'(lambda (name)
3495 (unless (string-match "\\`\\.\\.?\\'"
3496 (file-name-nondirectory name))
3497 name))
3498 (directory-files (or (car dirs) ".") full
3499 (wildcard-to-regexp nondir))))))
4db2a7de
RS
3500 (setq contents
3501 (nconc
3502 (if (and (car dirs) (not full))
3503 (mapcar (function (lambda (name) (concat (car dirs) name)))
3504 this-dir-contents)
3505 this-dir-contents)
3506 contents))))
3507 (setq dirs (cdr dirs)))
3508 contents))
5de148a2 3509
b4da00e9
RM
3510(defun list-directory (dirname &optional verbose)
3511 "Display a list of files in or matching DIRNAME, a la `ls'.
3512DIRNAME is globbed by the shell if necessary.
3513Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3514Actions controlled by variables `list-directory-brief-switches'
3515and `list-directory-verbose-switches'."
3516 (interactive (let ((pfx current-prefix-arg))
3517 (list (read-file-name (if pfx "List directory (verbose): "
3518 "List directory (brief): ")
3519 nil default-directory nil)
3520 pfx)))
3521 (let ((switches (if verbose list-directory-verbose-switches
3522 list-directory-brief-switches)))
3523 (or dirname (setq dirname default-directory))
3524 (setq dirname (expand-file-name dirname))
3525 (with-output-to-temp-buffer "*Directory*"
3526 (buffer-disable-undo standard-output)
3527 (princ "Directory ")
3528 (princ dirname)
3529 (terpri)
c3554e95
RS
3530 (save-excursion
3531 (set-buffer "*Directory*")
5a8a160e
RS
3532 (setq default-directory
3533 (if (file-directory-p dirname)
3534 (file-name-as-directory dirname)
3535 (file-name-directory dirname)))
c3554e95
RS
3536 (let ((wildcard (not (file-directory-p dirname))))
3537 (insert-directory dirname switches wildcard (not wildcard)))))))
3538
ffc0e1ca
AS
3539(defun shell-quote-wildcard-pattern (pattern)
3540 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3541
3542PATTERN is assumed to represent a file-name wildcard suitable for the
3543underlying filesystem. For Unix and GNU/Linux, the characters from the
3544set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
3545the parts of the pattern which don't include wildcard characters are
3546quoted with double quotes.
3547Existing quote characters in PATTERN are left alone, so you can pass
3548PATTERN that already quotes some of the special characters."
3549 (save-match-data
3550 (cond
3551 ((memq system-type '(ms-dos windows-nt))
3552 ;; DOS/Windows don't allow `"' in file names. So if the
3553 ;; argument has quotes, we can safely assume it is already
3554 ;; quoted by the caller.
3555 (if (or (string-match "[\"]" pattern)
3556 ;; We quote [&()#$'] in case their shell is a port of a
3557 ;; Unixy shell. We quote [,=+] because stock DOS and
3558 ;; Windows shells require that in some cases, such as
3559 ;; passing arguments to batch files that use positional
3560 ;; arguments like %1.
3561 (not (string-match "[ \t;&()#$',=+]" pattern)))
3562 pattern
3563 (let ((result "\"")
3564 (beg 0)
3565 end)
3566 (while (string-match "[*?]+" pattern beg)
3567 (setq end (match-beginning 0)
3568 result (concat result (substring pattern beg end)
3569 "\""
3570 (substring pattern end (match-end 0))
3571 "\"")
3572 beg (match-end 0)))
3573 (concat result (substring pattern beg) "\""))))
3574 (t
3575 (let ((beg 0))
3576 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3577 (setq pattern
3578 (concat (substring pattern 0 (match-beginning 0))
3579 "\\"
3580 (substring pattern (match-beginning 0)))
3581 beg (1+ (match-end 0)))))
3582 pattern))))
3583
3584
c3554e95
RS
3585(defvar insert-directory-program "ls"
3586 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3587
f4d04672
RS
3588(defcustom directory-free-space-program "df"
3589 "*Program to get the amount of free space on a file system.
3590We assume the output has the format of `df'.
3591The value of this variable must be just a command name or file name;
3592if you want to specify options, use `directory-free-space-args'.
3593
01b26b90
EZ
3594A value of nil disables this feature.
3595
3596If the function `file-system-info' is defined, it is always used in
3597preference to the program given by this variable."
f4d04672
RS
3598 :type '(choice (string :tag "Program") (const :tag "None" nil))
3599 :group 'dired)
3600
3601(defcustom directory-free-space-args "-Pk"
3602 "*Options to use when running `directory-free-space-program'."
3603 :type 'string
3604 :group 'dired)
3605
01b26b90
EZ
3606(defun get-free-disk-space (dir)
3607 "Return the mount of free space on directory DIR's file system.
3608The result is a string that gives the number of free 1KB blocks,
3609or nil if the system call or the program which retrieve the infornmation
3610fail.
3611
3612This function calls `file-system-info' if it is available, or invokes the
3613program specified by `directory-free-space-program' if that is non-nil."
3614 ;; Try to find the number of free blocks. Non-Posix systems don't
3615 ;; always have df, but might have an equivalent system call.
3616 (if (fboundp 'file-system-info)
3617 (let ((fsinfo (file-system-info dir)))
3618 (if fsinfo
3619 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
3620 (save-match-data
3621 (with-temp-buffer
3622 (when (and directory-free-space-program
3623 (zerop (call-process directory-free-space-program
3624 nil t nil
3625 directory-free-space-args
3626 dir)))
3627 ;; Usual format is a header line followed by a line of
3628 ;; numbers.
3629 (goto-char (point-min))
3630 (forward-line 1)
3631 (if (not (eobp))
3632 (progn
3633 ;; Move to the end of the "available blocks" number.
3634 (skip-chars-forward "^ \t")
3635 (forward-word 3)
3636 ;; Copy it into AVAILABLE.
3637 (let ((end (point)))
3638 (forward-word -1)
3639 (buffer-substring (point) end)))))))))
3640
3641
c3554e95
RS
3642;; insert-directory
3643;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3644;; FULL-DIRECTORY-P is nil.
3645;; The single line of output must display FILE's name as it was
3646;; given, namely, an absolute path name.
3647;; - must insert exactly one line for each file if WILDCARD or
3648;; FULL-DIRECTORY-P is t, plus one optional "total" line
3649;; before the file lines, plus optional text after the file lines.
3650;; Lines are delimited by "\n", so filenames containing "\n" are not
3651;; allowed.
3652;; File lines should display the basename.
3653;; - must be consistent with
3654;; - functions dired-move-to-filename, (these two define what a file line is)
3655;; dired-move-to-end-of-filename,
3656;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3657;; dired-insert-headerline
3658;; dired-after-subdir-garbage (defines what a "total" line is)
3659;; - variable dired-subdir-regexp
3660(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 3661 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 3662Leaves point after the inserted text.
727d277d 3663SWITCHES may be a string of options, or a list of strings.
c3554e95
RS
3664Optional third arg WILDCARD means treat FILE as shell wildcard.
3665Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3666switches do not contain `d', so that a full listing is expected.
3667
3668This works by running a directory listing program
406e12d9 3669whose name is in the variable `insert-directory-program'.
c3554e95 3670If WILDCARD, it also runs the shell specified by `shell-file-name'."
c870ab8e 3671 ;; We need the directory in order to find the right handler.
d2473540
AS
3672 (let ((handler (find-file-name-handler (expand-file-name file)
3673 'insert-directory)))
ebad92dc 3674 (if handler
c3554e95
RS
3675 (funcall handler 'insert-directory file switches
3676 wildcard full-directory-p)
b4da00e9 3677 (if (eq system-type 'vax-vms)
c3554e95 3678 (vms-read-directory file switches (current-buffer))
ebad92dc
RS
3679 (let (result available)
3680
3681 ;; Read the actual directory using `insert-directory-program'.
3682 ;; RESULT gets the status code.
3683 (let ((coding-system-for-read
3684 (and enable-multibyte-characters
3685 (or file-name-coding-system
3686 default-file-name-coding-system)))
3687 ;; This is to control encoding the arguments in call-process.
3688 (coding-system-for-write coding-system-for-read))
3689 (setq result
3690 (if wildcard
3691 ;; Run ls in the directory part of the file pattern
3692 ;; using the last component as argument.
3693 (let ((default-directory
3694 (if (file-name-absolute-p file)
3695 (file-name-directory file)
3696 (file-name-directory (expand-file-name file))))
3697 (pattern (file-name-nondirectory file)))
3698 (call-process
3699 shell-file-name nil t nil
3700 "-c"
3701 (concat (if (memq system-type '(ms-dos windows-nt))
3702 ""
3703 "\\") ; Disregard Unix shell aliases!
3704 insert-directory-program
3705 " -d "
3706 (if (stringp switches)
3707 switches
3708 (mapconcat 'identity switches " "))
3709 " -- "
3710 ;; Quote some characters that have
3711 ;; special meanings in shells; but
3712 ;; don't quote the wildcards--we want
3713 ;; them to be special. We also
3714 ;; currently don't quote the quoting
3715 ;; characters in case people want to
3716 ;; use them explicitly to quote
3717 ;; wildcard characters.
3718 (shell-quote-wildcard-pattern pattern))))
3719 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3720 ;; directory if FILE is a symbolic link.
3721 (apply 'call-process
3722 insert-directory-program nil t nil
3723 (append
3724 (if (listp switches) switches
3725 (unless (equal switches "")
3726 ;; Split the switches at any spaces so we can
3727 ;; pass separate options as separate args.
3728 (split-string switches)))
3729 ;; Avoid lossage if FILE starts with `-'.
3730 '("--")
3731 (progn
3732 (if (string-match "\\`~" file)
3733 (setq file (expand-file-name file)))
3734 (list
3735 (if full-directory-p
3736 (concat (file-name-as-directory file) ".")
3737 file))))))))
3738
3739 ;; If `insert-directory-program' failed, signal an error.
73ba53dc 3740 (if (/= result 0)
ffc0e1ca
AS
3741 ;; On non-Posix systems, we cannot open a directory, so
3742 ;; don't even try, because that will always result in
ebad92dc
RS
3743 ;; the ubiquitous "Access denied". Instead, show the
3744 ;; command line so the user can try to guess what went wrong.
ffc0e1ca
AS
3745 (if (and (file-directory-p file)
3746 (memq system-type '(ms-dos windows-nt)))
3747 (error
3748 "Reading directory: \"%s %s -- %s\" exited with status %s"
3749 insert-directory-program
3750 (if (listp switches) (concat switches) switches)
3751 file result)
3752 ;; Unix. Access the file to get a suitable error.
ebad92dc
RS
3753 (access-file file "Reading directory")
3754 (error "Listing directory failed but `access-file' worked")))
3755
3756 ;; Try to insert the amount of free space.
3757 (save-excursion
3758 (goto-char (point-min))
3759 ;; First find the line to put it on.
3760 (when (re-search-forward "^total" nil t)
01b26b90
EZ
3761 (let ((available (get-free-disk-space ".")))
3762 (when available
3763 ;; Replace "total" with "used", to avoid confusion.
14be1bc2 3764 (replace-match "total used in directory")
01b26b90
EZ
3765 (end-of-line)
3766 (insert " available " available))))))))))
34342a07 3767
bc22fd18
EZ
3768(defun insert-directory-safely (file switches
3769 &optional wildcard full-directory-p)
3770 "Insert directory listing for FILE, formatted according to SWITCHES.
3771
3772Like `insert-directory', but if FILE does not exist, it inserts a
3773message to that effect instead of signaling an error."
3774 (if (file-exists-p file)
3775 (insert-directory file switches wildcard full-directory-p)
3776 ;; Simulate the message printed by `ls'.
3777 (insert (format "%s: No such file or directory\n" file))))
3778
88902b35 3779(defvar kill-emacs-query-functions nil
65d5c6de 3780 "Functions to call with no arguments to query about killing Emacs.
78c793d1
RS
3781If any of these functions returns nil, killing Emacs is cancelled.
3782`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3783but `kill-emacs', the low level primitive, does not.
3784See also `kill-emacs-hook'.")
88902b35 3785
11f15305 3786(defcustom confirm-kill-emacs nil
9c2ba08f
EZ
3787 "How to ask for confirmation when leaving Emacs.
3788If nil, the default, don't ask at all. If the value is non-nil, it should
3789be a predicate function such as `yes-or-no-p'."
11f15305
GM
3790 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
3791 (const :tag "Ask with y-or-n-p" y-or-n-p)
3792 (const :tag "Don't confirm" nil))
3793 :group 'emacs
3794 :version "21.1")
3795
b4da00e9
RM
3796(defun save-buffers-kill-emacs (&optional arg)
3797 "Offer to save each buffer, then kill this Emacs process.
3798With prefix arg, silently save all file-visiting buffers, then kill."
3799 (interactive "P")
3800 (save-some-buffers arg t)
3801 (and (or (not (memq t (mapcar (function
3802 (lambda (buf) (and (buffer-file-name buf)
3803 (buffer-modified-p buf))))
3804 (buffer-list))))
3805 (yes-or-no-p "Modified buffers exist; exit anyway? "))
3806 (or (not (fboundp 'process-list))
3807 ;; process-list is not defined on VMS.
3808 (let ((processes (process-list))
3809 active)
3810 (while processes
528415e7 3811 (and (memq (process-status (car processes)) '(run stop open))
b4da00e9
RM
3812 (let ((val (process-kill-without-query (car processes))))
3813 (process-kill-without-query (car processes) val)
3814 val)
3815 (setq active t))
3816 (setq processes (cdr processes)))
3817 (or (not active)
71a3bb4b 3818 (list-processes)
b4da00e9 3819 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 3820 ;; Query the user for other things, perhaps.
fb15c113 3821 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
11f15305
GM
3822 (or (null confirm-kill-emacs)
3823 (funcall confirm-kill-emacs "Really exit Emacs? "))
b4da00e9
RM
3824 (kill-emacs)))
3825\f
ffc0e1ca 3826;; We use /: as a prefix to "quote" a file name
47afc068
RS
3827;; so that magic file name handlers will not apply to it.
3828
3829(setq file-name-handler-alist
3830 (cons '("\\`/:" . file-name-non-special)
3831 file-name-handler-alist))
3832
3833;; We depend on being the last handler on the list,
3834;; so that anything else which does need handling
3835;; has been handled already.
3836;; So it is safe for us to inhibit *all* magic file name handlers.
3837
3838(defun file-name-non-special (operation &rest arguments)
3839 (let ((file-name-handler-alist nil)
5cb1f728
KH
3840 (default-directory
3841 (if (eq operation 'insert-directory)
3842 (directory-file-name
ffc0e1ca 3843 (expand-file-name
5cb1f728
KH
3844 (unhandled-file-name-directory default-directory)))
3845 default-directory))
47afc068
RS
3846 ;; Get a list of the indices of the args which are file names.
3847 (file-arg-indices
3848 (cdr (or (assq operation
c736f678 3849 ;; The first five are special because they
47afc068
RS
3850 ;; return a file name. We want to include the /:
3851 ;; in the return value.
3852 ;; So just avoid stripping it in the first place.
3853 '((expand-file-name . nil)
3854 (file-name-directory . nil)
3855 (file-name-as-directory . nil)
3856 (directory-file-name . nil)
c736f678
RS
3857 (file-name-sans-versions . nil)
3858 ;; `identity' means just return the first arg
3859 ;; as stripped of its quoting.
3860 (substitute-in-file-name . identity)
feaec97d
RS
3861 (file-name-completion 0 1)
3862 (file-name-all-completions 0 1)
47afc068
RS
3863 (rename-file 0 1)
3864 (copy-file 0 1)
3865 (make-symbolic-link 0 1)
3866 (add-name-to-file 0 1)))
3867 ;; For all other operations, treat the first argument only
3868 ;; as the file name.
3869 '(nil 0))))
3870 ;; Copy ARGUMENTS so we can replace elements in it.
3871 (arguments (copy-sequence arguments)))
3872 ;; Strip off the /: from the file names that have this handler.
3873 (save-match-data
18b9dced 3874 (while (consp file-arg-indices)
fe4d9852
KH
3875 (let ((pair (nthcdr (car file-arg-indices) arguments)))
3876 (and (car pair)
3877 (string-match "\\`/:" (car pair))
3878 (setcar pair
3879 (if (= (length (car pair)) 2)
3880 "/"
3881 (substring (car pair) 2)))))
47afc068 3882 (setq file-arg-indices (cdr file-arg-indices))))
18b9dced
RS
3883 (if (eq file-arg-indices 'identity)
3884 (car arguments)
c736f678
RS
3885 (let ((value (apply operation arguments)))
3886 (cond ((memq operation '(file-name-completion))
3887 (and value (concat "/:" value)))
3888 ((memq operation '(file-name-all-completions))
3889 (mapcar (lambda (name) (concat "/:" name)) value))
3890 (t value))))))
47afc068 3891\f
b4da00e9 3892(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
3893(define-key ctl-x-map "\C-r" 'find-file-read-only)
3894(define-key ctl-x-map "\C-v" 'find-alternate-file)
3895(define-key ctl-x-map "\C-s" 'save-buffer)
3896(define-key ctl-x-map "s" 'save-some-buffers)
3897(define-key ctl-x-map "\C-w" 'write-file)
3898(define-key ctl-x-map "i" 'insert-file)
3899(define-key esc-map "~" 'not-modified)
3900(define-key ctl-x-map "\C-d" 'list-directory)
3901(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
3902
3903(define-key ctl-x-4-map "f" 'find-file-other-window)
3904(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
3905(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
3906(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 3907(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 3908
f98955ea
JB
3909(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
3910(define-key ctl-x-5-map "f" 'find-file-other-frame)
3911(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
3912(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38
ER
3913
3914;;; files.el ends here