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