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