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