(calc-invalidate-units-table): Use inhibit-read-only.
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
e5cb26a8
SM
3;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4;; 1999, 2000, 2001, 2002, 2003, 2004, 2005 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
564af258 45Note that the auto-save file will not be deleted if the buffer is killed
92631216 46when it has unsaved changes."
21540597
RS
47 :type 'boolean
48 :group 'auto-save)
49
50(defcustom directory-abbrev-alist
b4da00e9
RM
51 nil
52 "*Alist of abbreviations for file directories.
53A list of elements of the form (FROM . TO), each meaning to replace
54FROM with TO when it appears in a directory name. This replacement is
55done when setting up the default directory of a newly visited file.
56*Every* FROM string should start with `^'.
57
65151a1b
RS
58Do not use `~' in the TO strings.
59They should be ordinary absolute directory names.
60
b4da00e9
RM
61Use this feature when you have directories which you normally refer to
62via absolute symbolic links. Make TO the name of the link, and FROM
21540597
RS
63the name it is linked to."
64 :type '(repeat (cons :format "%v"
65 :value ("" . "")
66 (regexp :tag "From")
67 (regexp :tag "To")))
68 :group 'abbrev
69 :group 'find-file)
b4da00e9 70
5c6d31a4 71;; Turn off backup files on VMS since it has version numbers.
21540597 72(defcustom make-backup-files (not (eq system-type 'vax-vms))
4ea836c1 73 "*Non-nil means make a backup of a file the first time it is saved.
b4da00e9
RM
74This can be done by renaming the file or by copying.
75
76Renaming means that Emacs renames the existing file so that it is a
77backup file, then writes the buffer into a new file. Any other names
78that the old file had will now refer to the backup file. The new file
79is owned by you and its group is defaulted.
80
81Copying means that Emacs copies the existing file into the backup
82file, then writes the buffer on top of the existing file. Any other
83names that the old file had will now refer to the new (edited) file.
84The file's owner and group are unchanged.
85
86The choice of renaming or copying is controlled by the variables
ffc0e1ca
AS
87`backup-by-copying', `backup-by-copying-when-linked',
88`backup-by-copying-when-mismatch' and
89`backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
21540597
RS
90 :type 'boolean
91 :group 'backup)
b4da00e9
RM
92
93;; Do this so that local variables based on the file name
94;; are not overridden by the major mode.
95(defvar backup-inhibited nil
f862241d
RS
96 "Non-nil means don't make a backup, regardless of the other parameters.
97This variable is intended for use by making it local to a buffer.
98But it is local only if you make it local.")
b4da00e9
RM
99(put 'backup-inhibited 'permanent-local t)
100
21540597 101(defcustom backup-by-copying nil
b4da00e9 102 "*Non-nil means always use copying to create backup files.
21540597
RS
103See documentation of variable `make-backup-files'."
104 :type 'boolean
105 :group 'backup)
b4da00e9 106
21540597 107(defcustom backup-by-copying-when-linked nil
b4da00e9
RM
108 "*Non-nil means use copying to create backups for files with multiple names.
109This causes the alternate names to refer to the latest version as edited.
21540597
RS
110This variable is relevant only if `backup-by-copying' is nil."
111 :type 'boolean
112 :group 'backup)
b4da00e9 113
21540597 114(defcustom backup-by-copying-when-mismatch nil
b4da00e9
RM
115 "*Non-nil means create backups by copying if this preserves owner or group.
116Renaming may still be used (subject to control of other variables)
117when it would not result in changing the owner or group of the file;
118that is, for files which are owned by you and whose group matches
119the default for a new file created there by you.
21540597
RS
120This variable is relevant only if `backup-by-copying' is nil."
121 :type 'boolean
122 :group 'backup)
b4da00e9 123
ffc0e1ca
AS
124(defcustom backup-by-copying-when-privileged-mismatch 200
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126Renaming may still be used (subject to control of other variables)
127when it would not result in changing the owner of the file or if the owner
128has a user id greater than the value of this variable. This is useful
129when low-numbered uid's are used for special system users (such as root)
130that must maintain ownership of certain files.
131This variable is relevant only if `backup-by-copying' and
132`backup-by-copying-when-mismatch' are nil."
133 :type '(choice (const nil) integer)
134 :group 'backup)
135
ffc0e1ca 136(defvar backup-enable-predicate 'normal-backup-enable-predicate
b4da00e9 137 "Predicate that looks at a file name and decides whether to make backups.
37193ee6 138Called with an absolute file name as argument, it returns t to enable backup.")
b4da00e9 139
21540597 140(defcustom buffer-offer-save nil
ffc0e1ca
AS
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142Do so even if the buffer is not visiting a file.
21540597
RS
143Automatically local in all buffers."
144 :type 'boolean
145 :group 'backup)
b4da00e9
RM
146(make-variable-buffer-local 'buffer-offer-save)
147
21540597 148(defcustom find-file-existing-other-name t
f3e23606
RS
149 "*Non-nil means find a file under alternative names, in existing buffers.
150This means if any existing buffer is visiting the file you want
21540597
RS
151under another name, you get the existing buffer instead of a new buffer."
152 :type 'boolean
153 :group 'find-file)
f3e23606 154
21540597 155(defcustom find-file-visit-truename nil
f3e23606
RS
156 "*Non-nil means visit a file under its truename.
157The truename of a file is found by chasing all links
21540597
RS
158both at the file level and at the levels of the containing directories."
159 :type 'boolean
160 :group 'find-file)
f3e23606 161
db8c4866 162(defcustom revert-without-query
d7fa5aa2 163 nil
ebeb898f
RS
164 "*Specify which files should be reverted without query.
165The value is a list of regular expressions.
166If the file name matches one of these regular expressions,
db8c4866 167then `revert-buffer' reverts the file without querying
21540597 168if the file has changed on disk and you have not edited the buffer."
a0d809f2 169 :type '(repeat regexp)
21540597 170 :group 'find-file)
ebeb898f 171
f3e23606
RS
172(defvar buffer-file-number nil
173 "The device number and file number of the file visited in the current buffer.
174The value is a list of the form (FILENUM DEVNUM).
175This pair of numbers uniquely identifies the file.
176If the buffer is visiting a new file, the value is nil.")
177(make-variable-buffer-local 'buffer-file-number)
178(put 'buffer-file-number 'permanent-local t)
179
de88363f
RS
180(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
181 "Non-nil means that buffer-file-number uniquely identifies files.")
182
e554eeb7
RS
183(defvar buffer-file-read-only nil
184 "Non-nil if visited file was read-only when visited.")
185(make-variable-buffer-local 'buffer-file-read-only)
186
388d6ab5 187(defcustom temporary-file-directory
eb61b61b
RS
188 (file-name-as-directory
189 (cond ((memq system-type '(ms-dos windows-nt))
190 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
191 ((memq system-type '(vax-vms axp-vms))
192 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
193 (t
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
388d6ab5
RS
195 "The directory for writing temporary files."
196 :group 'files
197 :type 'directory)
eb61b61b 198
388d6ab5 199(defcustom small-temporary-file-directory
eb61b61b
RS
200 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
201 "The directory for writing small temporary files.
202If non-nil, this directory is used instead of `temporary-file-directory'
203by programs that create small temporary files. This is for systems that
388d6ab5
RS
204have fast storage with limited space, such as a RAM disk."
205 :group 'files
bab6eadb 206 :type '(choice (const nil) directory))
eb61b61b
RS
207
208;; The system null device. (Should reference NULL_DEVICE from C.)
209(defvar null-device "/dev/null" "The system null device.")
210
30966847
EZ
211(defvar file-name-invalid-regexp
212 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
9959c16e 213 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
30966847 214 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
edfc7f25 215 "[\000-\031]\\|" ; control characters
30966847
EZ
216 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
217 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
c60ee5e7 218 ((memq system-type '(ms-dos windows-nt cygwin))
9959c16e 219 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
106a57a4 220 "[|<>\"?*\000-\031]")) ; invalid characters
30966847
EZ
221 (t "[\000]"))
222 "Regexp recognizing file names which aren't allowed by the filesystem.")
223
21540597 224(defcustom file-precious-flag nil
b4da00e9 225 "*Non-nil means protect against I/O errors while saving files.
560f4415 226Some modes set this non-nil in particular buffers.
4b7271c1
KH
227
228This feature works by writing the new contents into a temporary file
229and then renaming the temporary file to replace the original.
230In this way, any I/O error in writing leaves the original untouched,
231and there is never any instant where the file is nonexistent.
232
233Note that this feature forces backups to be made by copying.
560f4415 234Yet, at the same time, saving a precious file
21540597
RS
235breaks any hard links between it and other files."
236 :type 'boolean
237 :group 'backup)
b4da00e9 238
21540597 239(defcustom version-control nil
b4da00e9
RM
240 "*Control use of version numbers for backup files.
241t means make numeric backup versions unconditionally.
242nil means make them for files that have some already.
21540597 243`never' means do not make them."
e48807d1
AS
244 :type '(choice (const :tag "Never" never)
245 (const :tag "If existing" nil)
246 (other :tag "Always" t))
21540597
RS
247 :group 'backup
248 :group 'vc)
249
250(defcustom dired-kept-versions 2
251 "*When cleaning directory, number of versions to keep."
252 :type 'integer
253 :group 'backup
254 :group 'dired)
255
256(defcustom delete-old-versions nil
de7d5e1b 257 "*If t, delete excess backup versions silently.
21540597
RS
258If nil, ask confirmation. Any other value prevents any trimming."
259 :type '(choice (const :tag "Delete" t)
260 (const :tag "Ask" nil)
e48807d1 261 (other :tag "Leave" other))
21540597
RS
262 :group 'backup)
263
264(defcustom kept-old-versions 2
265 "*Number of oldest versions to keep when a new numbered backup is made."
266 :type 'integer
267 :group 'backup)
268
269(defcustom kept-new-versions 2
b4da00e9 270 "*Number of newest versions to keep when a new numbered backup is made.
21540597
RS
271Includes the new backup. Must be > 0"
272 :type 'integer
273 :group 'backup)
b4da00e9 274
21540597 275(defcustom require-final-newline nil
f4206092
RS
276 "*Whether to add a newline automatically at the end of the file.
277
278A value of t means do this only when the file is about to be saved.
279A value of `visit' means do this right after the file is visited.
280A value of `visit-save' means do it at both of those times.
281Any other non-nil value means ask user whether to add a newline, when saving.
282nil means don't add newlines.
283
284Certain major modes set this locally to the value obtained
285from `mode-require-final-newline'."
286 :type '(choice (const :tag "When visiting" visit)
287 (const :tag "When saving" t)
288 (const :tag "When visiting or saving" visit-save)
93d1963d 289 (const :tag "Don't add newlines" nil)
0776da52 290 (other :tag "Ask each time" ask))
21540597 291 :group 'editing-basics)
b4da00e9 292
f4206092 293(defcustom mode-require-final-newline t
5e9961be 294 "*Whether to add a newline at end of file, in certain major modes.
f4206092 295Those modes set `require-final-newline' to this value when you enable them.
0776da52 296They do so because they are often used for files that are supposed
f4206092
RS
297to end in newlines, and the question is how to arrange that.
298
299A value of t means do this only when the file is about to be saved.
300A value of `visit' means do this right after the file is visited.
301A value of `visit-save' means do it at both of those times.
5e9961be 302Any other non-nil value means ask user whether to add a newline, when saving.
5e9961be 303
93d1963d
RS
304nil means do not add newlines. That is a risky choice in this variable
305since this value is used for modes for files that ought to have final newlines.
306So if you set this to nil, you must explicitly check and add
307a final newline, whenever you save a file that really needs one."
f4206092
RS
308 :type '(choice (const :tag "When visiting" visit)
309 (const :tag "When saving" t)
310 (const :tag "When visiting or saving" visit-save)
93d1963d
RS
311 (const :tag "Don't add newlines" nil)
312 (other :tag "Ask each time" ask))
f4206092 313 :group 'editing-basics
bf247b6e 314 :version "22.1")
f4206092 315
21540597
RS
316(defcustom auto-save-default t
317 "*Non-nil says by default do auto-saving of every file-visiting buffer."
318 :type 'boolean
319 :group 'auto-save)
b4da00e9 320
21540597 321(defcustom auto-save-visited-file-name nil
b4da00e9 322 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
21540597
RS
323Normally auto-save files are written under other names."
324 :type 'boolean
325 :group 'auto-save)
b4da00e9 326
ffc0e1ca 327(defcustom auto-save-file-name-transforms
b1e5937c 328 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
747981b0
EZ
329 ;; Don't put "\\2" inside expand-file-name, since it will be
330 ;; transformed to "/2" on DOS/Windows.
a0b60c33 331 ,(concat temporary-file-directory "\\2") t))
ffc0e1ca 332 "*Transforms to apply to buffer file name before making auto-save file name.
a0b60c33 333Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
ffc0e1ca
AS
334REGEXP is a regular expression to match against the file name.
335If it matches, `replace-match' is used to replace the
336matching part with REPLACEMENT.
a0b60c33 337If the optional element UNIQUIFY is non-nil, the auto-save file name is
36236b72 338constructed by taking the directory part of the replaced file-name,
a0b60c33
GM
339concatenated with the buffer file name with all directory separators
340changed to `!' to prevent clashes. This will not work
341correctly if your filesystem truncates the resulting name.
342
ffc0e1ca
AS
343All the transforms in the list are tried, in the order they are listed.
344When one transform applies, its result is final;
345no further transforms are tried.
346
a2899d6c
KG
347The default value is set up to put the auto-save file into the
348temporary directory (see the variable `temporary-file-directory') for
a0b60c33
GM
349editing a remote file.
350
351On MS-DOS filesystems without long names this variable is always
352ignored."
ffc0e1ca 353 :group 'auto-save
a0b60c33
GM
354 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
355 (boolean :tag "Uniquify")))
ffc0e1ca
AS
356 :version "21.1")
357
88b36776 358(defcustom save-abbrevs t
02c6a1cc
EZ
359 "*Non-nil means save word abbrevs too when files are saved.
360If `silently', don't ask the user before saving."
361 :type '(choice (const t) (const nil) (const silently))
21540597 362 :group 'abbrev)
b4da00e9 363
21540597 364(defcustom find-file-run-dired t
ffc0e1ca
AS
365 "*Non-nil means allow `find-file' to visit directories.
366To visit the directory, `find-file' runs `find-directory-functions'."
21540597
RS
367 :type 'boolean
368 :group 'find-file)
b4da00e9 369
ffc0e1ca
AS
370(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
371 "*List of functions to try in sequence to visit a directory.
372Each function is called with the directory name as the sole argument
373and should return either a buffer or nil."
374 :type '(hook :options (cvs-dired-noselect dired-noselect))
375 :group 'find-file)
376
92966e6f
RS
377;;;It is not useful to make this a local variable.
378;;;(put 'find-file-not-found-hooks 'permanent-local t)
0370fe77 379(defvar find-file-not-found-functions nil
b4da00e9
RM
380 "List of functions to be called for `find-file' on nonexistent file.
381These functions are called as soon as the error is detected.
ffc0e1ca 382Variable `buffer-file-name' is already set up.
b4da00e9 383The functions are called in the order given until one of them returns non-nil.")
0370fe77
SM
384(defvaralias 'find-file-not-found-hooks 'find-file-not-found-functions)
385(make-obsolete-variable
bf247b6e 386 'find-file-not-found-hooks 'find-file-not-found-functions "22.1")
b4da00e9 387
92966e6f
RS
388;;;It is not useful to make this a local variable.
389;;;(put 'find-file-hooks 'permanent-local t)
564af258 390(defcustom find-file-hook nil
b4da00e9
RM
391 "List of functions to be called after a buffer is loaded from a file.
392The buffer's local variables (if any) will have been processed before the
564af258
DL
393functions are called."
394 :group 'find-file
395 :type 'hook
396 :options '(auto-insert)
bf247b6e 397 :version "22.1")
0370fe77 398(defvaralias 'find-file-hooks 'find-file-hook)
bf247b6e 399(make-obsolete-variable 'find-file-hooks 'find-file-hook "22.1")
b4da00e9 400
0370fe77 401(defvar write-file-functions nil
b4da00e9
RM
402 "List of functions to be called before writing out a buffer to a file.
403If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
404and the rest are not called.
405These hooks are considered to pertain to the visited file.
0370fe77
SM
406So any buffer-local binding of this variable is discarded if you change
407the visited file name with \\[set-visited-file-name], but not when you
408change the major mode.
409
0eb0202f
LT
410This hook is not run if any of the functions in
411`write-contents-functions' returns non-nil. Both hooks pertain
412to how to save a buffer to file, for instance, choosing a suitable
413coding system and setting mode bits. (See Info
414node `(elisp)Saving Buffers'.) To perform various checks or
415updates before the buffer is saved, use `before-save-hook' .")
0370fe77
SM
416(put 'write-file-functions 'permanent-local t)
417(defvaralias 'write-file-hooks 'write-file-functions)
bf247b6e 418(make-obsolete-variable 'write-file-hooks 'write-file-functions "22.1")
0370fe77
SM
419
420(defvar local-write-file-hooks nil)
b19f1da4
BF
421(make-variable-buffer-local 'local-write-file-hooks)
422(put 'local-write-file-hooks 'permanent-local t)
bf247b6e 423(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
8c0e7b73 424
0370fe77 425(defvar write-contents-functions nil
8c0e7b73
JB
426 "List of functions to be called before writing out a buffer to a file.
427If one of them returns non-nil, the file is considered already written
7dd11b37
LH
428and the rest are not called and neither are the functions in
429`write-file-functions'.
f82966e4
KH
430
431This variable is meant to be used for hooks that pertain to the
432buffer's contents, not to the particular visited file; thus,
433`set-visited-file-name' does not clear this variable; but changing the
693f800d
RS
434major mode does clear it.
435
0eb0202f
LT
436For hooks that _do_ pertain to the particular visited file, use
437`write-file-functions'. Both this variable and
438`write-file-functions' relate to how a buffer is saved to file.
439To perform various checks or updates before the buffer is saved,
440use `before-save-hook'.")
0370fe77
SM
441(make-variable-buffer-local 'write-contents-functions)
442(defvaralias 'write-contents-hooks 'write-contents-functions)
bf247b6e 443(make-obsolete-variable 'write-contents-hooks 'write-contents-functions "22.1")
b4da00e9 444
21540597 445(defcustom enable-local-variables t
93a2702d 446 "*Control use of local variables in files you visit.
b4da00e9 447The value can be t, nil or something else.
93a2702d 448A value of t means file local variables specifications are obeyed;
b4da00e9 449nil means they are ignored; anything else means query.
aa5fcebf
KH
450This variable also controls use of major modes specified in
451a -*- line.
b4da00e9 452
aa5fcebf
KH
453The command \\[normal-mode], when used interactively,
454always obeys file local variable specifications and the -*- line,
455and ignores this variable."
21540597
RS
456 :type '(choice (const :tag "Obey" t)
457 (const :tag "Ignore" nil)
e48807d1 458 (other :tag "Query" other))
21540597 459 :group 'find-file)
b4da00e9 460
da09b92b
RS
461(defvar local-enable-local-variables t
462 "Like `enable-local-variables' but meant for buffer-local bindings.
aa5fcebf 463The meaningful values are nil and non-nil. The default is non-nil.
da09b92b 464If a major mode sets this to nil, buffer-locally, then any local
aa5fcebf
KH
465variables list in the file will be ignored.
466
467This variable does not affect the use of major modes
468specified in a -*- line.")
da09b92b 469
21540597 470(defcustom enable-local-eval 'maybe
d207b766
RS
471 "*Control processing of the \"variable\" `eval' in a file's local variables.
472The value can be t, nil or something else.
473A value of t means obey `eval' variables;
e0b2a2d9 474nil means ignore them; anything else means query."
21540597
RS
475 :type '(choice (const :tag "Obey" t)
476 (const :tag "Ignore" nil)
e48807d1 477 (other :tag "Query" other))
21540597 478 :group 'find-file)
b4da00e9
RM
479
480;; Avoid losing in versions where CLASH_DETECTION is disabled.
481(or (fboundp 'lock-buffer)
231c4e10 482 (defalias 'lock-buffer 'ignore))
b4da00e9 483(or (fboundp 'unlock-buffer)
231c4e10 484 (defalias 'unlock-buffer 'ignore))
a7305f6e
RS
485(or (fboundp 'file-locked-p)
486 (defalias 'file-locked-p 'ignore))
93fe0a35 487
cb211eb2 488(defcustom view-read-only nil
4c91443d
RS
489 "*Non-nil means buffers visiting files read-only do so in view mode.
490In fact, this means that all read-only buffers normally have
491View mode enabled, including buffers that are read-only because
492you visit a file you cannot alter, and buffers you make read-only
493using \\[toggle-read-only]."
cb211eb2
SM
494 :type 'boolean
495 :group 'view)
2a9fe1e2 496
1aa8fe46 497(put 'ange-ftp-completion-hook-function 'safe-magic t)
93fe0a35 498(defun ange-ftp-completion-hook-function (op &rest args)
ffc0e1ca
AS
499 "Provides support for ange-ftp host name completion.
500Runs the usual ange-ftp hook, but only for completion operations."
501 ;; Having this here avoids the need to load ange-ftp when it's not
502 ;; really in use.
93fe0a35
RS
503 (if (memq op '(file-name-completion file-name-all-completions))
504 (apply 'ange-ftp-hook-function op args)
57e81f57
RS
505 (let ((inhibit-file-name-handlers
506 (cons 'ange-ftp-completion-hook-function
507 (and (eq inhibit-file-name-operation op)
508 inhibit-file-name-handlers)))
509 (inhibit-file-name-operation op))
93fe0a35 510 (apply op args))))
567c1ca9
RS
511
512(defun convert-standard-filename (filename)
a576d8e2 513 "Convert a standard file's name to something suitable for the OS.
915b0bf0
JB
514This means to guarantee valid names and perhaps to canonicalize
515certain patterns.
516
517This function's standard definition is trivial; it just returns
518the argument. However, on Windows and DOS, replace invalid
519characters. On DOS, make sure to obey the 8.3 limitations. On
520Windows, turn Cygwin names into native names, and also turn
521slashes into backslashes if the shell requires it (see
a576d8e2
LT
522`w32-shell-dos-semantics').
523
524See Info node `(elisp)Standard File Names' for more details."
567c1ca9 525 filename)
5d4d17b8
KS
526
527(defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
528 "Read directory name, prompting with PROMPT and completing in directory DIR.
529Value is not expanded---you must call `expand-file-name' yourself.
25802eac
LT
530Default name to DEFAULT-DIRNAME if user exits with the same
531non-empty string that was inserted by this function.
44dce0fb
RS
532 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
533 or just DIR if INITIAL is nil.)
25802eac
LT
534If the user exits with an empty minibuffer, this function returns
535an empty string. (This can only happen if the user erased the
536pre-inserted contents or if `insert-default-directory' is nil.)
5d4d17b8
KS
537Fourth arg MUSTMATCH non-nil means require existing directory's name.
538 Non-nil and non-t means also require confirmation after completion.
539Fifth arg INITIAL specifies text to start with.
25802eac
LT
540DIR should be an absolute directory name. It defaults to
541the value of `default-directory'."
5d4d17b8
KS
542 (unless dir
543 (setq dir default-directory))
54005870 544 (read-file-name prompt dir (or default-dirname
44dce0fb
RS
545 (if initial (expand-file-name initial dir)
546 dir))
547 mustmatch initial
5d4d17b8
KS
548 'file-directory-p))
549
b4da00e9
RM
550\f
551(defun pwd ()
552 "Show the current default directory."
553 (interactive nil)
554 (message "Directory %s" default-directory))
555
231c4e10
ER
556(defvar cd-path nil
557 "Value of the CDPATH environment variable, as a list.
9ee45b2c 558Not actually set up until the first time you use it.")
231c4e10
ER
559
560(defun parse-colon-path (cd-path)
ae135939 561 "Explode a search path into a list of directory names.
c5994cfa
JB
562Directories are separated by occurrences of `path-separator'
563\(which is colon in GNU and GNU-like systems)."
ffc0e1ca 564 ;; We could use split-string here.
231c4e10 565 (and cd-path
818286f4 566 (let (cd-list (cd-start 0) cd-colon)
306faa42
RS
567 (setq cd-path (concat cd-path path-separator))
568 (while (setq cd-colon (string-match path-separator cd-path cd-start))
231c4e10 569 (setq cd-list
9daefb36 570 (nconc cd-list
c52e4104
RS
571 (list (if (= cd-start cd-colon)
572 nil
573 (substitute-in-file-name
e33e80e4
RS
574 (file-name-as-directory
575 (substring cd-path cd-start cd-colon)))))))
231c4e10
ER
576 (setq cd-start (+ cd-colon 1)))
577 cd-list)))
578
579(defun cd-absolute (dir)
30c5ce9c 580 "Change current directory to given absolute file name DIR."
f4a0f59b
RS
581 ;; Put the name into directory syntax now,
582 ;; because otherwise expand-file-name may give some bad results.
b4da00e9
RM
583 (if (not (eq system-type 'vax-vms))
584 (setq dir (file-name-as-directory dir)))
f4a0f59b 585 (setq dir (abbreviate-file-name (expand-file-name dir)))
b4da00e9 586 (if (not (file-directory-p dir))
83c6f446
RS
587 (if (file-exists-p dir)
588 (error "%s is not a directory" dir)
31c691c1 589 (error "%s: no such directory" dir))
b4da00e9
RM
590 (if (file-executable-p dir)
591 (setq default-directory dir)
9daefb36 592 (error "Cannot cd to %s: Permission denied" dir))))
b4da00e9 593
231c4e10
ER
594(defun cd (dir)
595 "Make DIR become the current buffer's default directory.
ae135939
JB
596If your environment includes a `CDPATH' variable, try each one of
597that list of directories (separated by occurrences of
c5994cfa
JB
598`path-separator') when resolving a relative directory name.
599The path separator is colon in GNU and GNU-like systems."
dac4ea74 600 (interactive
5d4d17b8 601 (list (read-directory-name "Change default directory: "
2121cd9c
RM
602 default-directory default-directory
603 (and (member cd-path '(nil ("./")))
604 (null (getenv "CDPATH"))))))
30c5ce9c
RS
605 (if (file-name-absolute-p dir)
606 (cd-absolute (expand-file-name dir))
607 (if (null cd-path)
608 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
609 (setq cd-path (or trypath (list "./")))))
610 (if (not (catch 'found
611 (mapcar
612 (function (lambda (x)
613 (let ((f (expand-file-name (concat x dir))))
614 (if (file-directory-p f)
615 (progn
616 (cd-absolute f)
617 (throw 'found t))))))
618 cd-path)
619 nil))
620 (error "No such directory found via CDPATH environment variable"))))
231c4e10 621
b4da00e9
RM
622(defun load-file (file)
623 "Load the Lisp file named FILE."
58195faa
DL
624 ;; This is a case where .elc makes a lot of sense.
625 (interactive (list (let ((completion-ignored-extensions
9ab80679 626 (remove ".elc" completion-ignored-extensions)))
58195faa
DL
627 (read-file-name "Load file: "))))
628 (load (expand-file-name file) nil nil t))
b4da00e9 629
38eea7c7
SM
630(defun locate-file (filename path &optional suffixes predicate)
631 "Search for FILENAME through PATH.
c7c4bc11
EZ
632If found, return the absolute file name of FILENAME, with its suffixes;
633otherwise return nil.
634PATH should be a list of directories to look in, like the lists in
635`exec-path' or `load-path'.
38eea7c7
SM
636If SUFFIXES is non-nil, it should be a list of suffixes to append to
637file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
c7c4bc11 638Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
38eea7c7 639If non-nil, PREDICATE is used instead of `file-readable-p'.
e6f0ff92
RS
640PREDICATE can also be an integer to pass to the `access' system call,
641in which case file-name handlers are ignored. This usage is deprecated.
642
643For compatibility, PREDICATE can also be one of the symbols
644`executable', `readable', `writable', or `exists', or a list of
645one or more of those symbols."
38eea7c7
SM
646 (if (and predicate (symbolp predicate) (not (functionp predicate)))
647 (setq predicate (list predicate)))
648 (when (and (consp predicate) (not (functionp predicate)))
649 (setq predicate
650 (logior (if (memq 'executable predicate) 1 0)
651 (if (memq 'writable predicate) 2 0)
652 (if (memq 'readable predicate) 4 0))))
653 (locate-file-internal filename path suffixes predicate))
654
655(defun locate-file-completion (string path-and-suffixes action)
656 "Do completion for file names passed to `locate-file'.
657PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
2c3d8820 658 (if (file-name-absolute-p string)
38eea7c7 659 (read-file-name-internal string nil action)
2c3d8820 660 (let ((names nil)
38eea7c7 661 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
2c3d8820 662 (string-dir (file-name-directory string)))
38eea7c7 663 (dolist (dir (car path-and-suffixes))
f2440e42
RS
664 (unless dir
665 (setq dir default-directory))
2c3d8820
SM
666 (if string-dir (setq dir (expand-file-name string-dir dir)))
667 (when (file-directory-p dir)
668 (dolist (file (file-name-all-completions
669 (file-name-nondirectory string) dir))
670 (push (if string-dir (concat string-dir file) file) names)
671 (when (string-match suffix file)
672 (setq file (substring file 0 (match-beginning 0)))
673 (push (if string-dir (concat string-dir file) file) names)))))
0370fe77
SM
674 (cond
675 ((eq action t) (all-completions string names))
676 ((null action) (try-completion string names))
677 (t (test-completion string names))))))
2c3d8820 678
c3f6aa20
SM
679(defun executable-find (command)
680 "Search for COMMAND in `exec-path' and return the absolute file name.
681Return nil if COMMAND is not found anywhere in `exec-path'."
682 ;; Use 1 rather than file-executable-p to better match the behavior of
683 ;; call-process.
684 (locate-file command exec-path exec-suffixes 1))
685
b4da00e9
RM
686(defun load-library (library)
687 "Load the library named LIBRARY.
688This is an interface to the function `load'."
38eea7c7
SM
689 (interactive
690 (list (completing-read "Load library: "
691 'locate-file-completion
692 (cons load-path load-suffixes))))
b4da00e9 693 (load library))
5d68c2c2 694
ff7affeb 695(defun file-remote-p (file)
3f788773
KG
696 "Test whether FILE specifies a location on a remote system.
697Return an identification of the system if the location is indeed
698remote. The identification of the system may comprise a method
699to access the system and its hostname, amongst other things.
700
701For example, the filename \"/user@host:/foo\" specifies a location
702on the system \"/user@host:\"."
04621aaa 703 (let ((handler (find-file-name-handler file 'file-remote-p)))
ff7affeb 704 (if handler
04621aaa
MA
705 (funcall handler 'file-remote-p file)
706 nil)))
ff7affeb 707
ffc0e1ca 708(defun file-local-copy (file)
5d68c2c2
RS
709 "Copy the file FILE into a temporary file on this machine.
710Returns the name of the local copy, or nil, if FILE is directly
711accessible."
ffc0e1ca
AS
712 ;; This formerly had an optional BUFFER argument that wasn't used by
713 ;; anything.
6eaebaa2 714 (let ((handler (find-file-name-handler file 'file-local-copy)))
5d68c2c2
RS
715 (if handler
716 (funcall handler 'file-local-copy file)
717 nil)))
f3e23606 718
05ef1cda 719(defun file-truename (filename &optional counter prev-dirs)
f3e23606
RS
720 "Return the truename of FILENAME, which should be absolute.
721The truename of a file name is found by chasing symbolic links
722both at the level of the file and at the level of the directories
05ef1cda
RS
723containing it, until no links are left at any level.
724
89bf74f8 725\(fn FILENAME)" ;; Don't document the optional arguments.
b9963e32
JB
726 ;; COUNTER and PREV-DIRS are only used in recursive calls.
727 ;; COUNTER can be a cons cell whose car is the count of how many
728 ;; more links to chase before getting an error.
05ef1cda
RS
729 ;; PREV-DIRS can be a cons cell whose car is an alist
730 ;; of truenames we've just recently computed.
f2440e42
RS
731 (cond ((or (string= filename "") (string= filename "~"))
732 (setq filename (expand-file-name filename))
733 (if (string= filename "")
734 (setq filename "/")))
735 ((and (string= (substring filename 0 1) "~")
736 (string-match "~[^/]*/?" filename))
737 (let ((first-part
738 (substring filename 0 (match-end 0)))
739 (rest (substring filename (match-end 0))))
740 (setq filename (concat (expand-file-name first-part) rest)))))
741
05ef1cda 742 (or counter (setq counter (list 100)))
b505828b
RS
743 (let (done
744 ;; For speed, remove the ange-ftp completion handler from the list.
745 ;; We know it's not needed here.
746 ;; For even more speed, do this only on the outermost call.
747 (file-name-handler-alist
748 (if prev-dirs file-name-handler-alist
749 (let ((tem (copy-sequence file-name-handler-alist)))
750 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
751 (or prev-dirs (setq prev-dirs (list nil)))
b1667e6c
GV
752
753 ;; andrewi@harlequin.co.uk - none of the following code (except for
754 ;; invoking the file-name handler) currently applies on Windows
755 ;; (ie. there are no native symlinks), but there is an issue with
756 ;; case differences being ignored by the OS, and short "8.3 DOS"
757 ;; name aliases existing for all files. (The short names are not
758 ;; reported by directory-files, but can be used to refer to files.)
759 ;; It seems appropriate for file-truename to resolve these issues in
760 ;; the most natural way, which on Windows is to call the function
761 ;; `w32-long-file-name' - this returns the exact name of a file as
762 ;; it is stored on disk (expanding short name aliases with the full
763 ;; name in the process).
764 (if (eq system-type 'windows-nt)
06dd5ef7 765 (let ((handler (find-file-name-handler filename 'file-truename)))
b1667e6c
GV
766 ;; For file name that has a special handler, call handler.
767 ;; This is so that ange-ftp can save time by doing a no-op.
768 (if handler
769 (setq filename (funcall handler 'file-truename filename))
770 ;; If filename contains a wildcard, newname will be the old name.
06dd5ef7 771 (unless (string-match "[[*?]" filename)
5b373bd3
JB
772 ;; If filename exists, use the long name
773 (setq filename (or (w32-long-file-name filename) filename))))
b1667e6c
GV
774 (setq done t)))
775
05ef1cda
RS
776 ;; If this file directly leads to a link, process that iteratively
777 ;; so that we don't use lots of stack.
778 (while (not done)
779 (setcar counter (1- (car counter)))
780 (if (< (car counter) 0)
781 (error "Apparent cycle of symbolic links for %s" filename))
782 (let ((handler (find-file-name-handler filename 'file-truename)))
783 ;; For file name that has a special handler, call handler.
784 ;; This is so that ange-ftp can save time by doing a no-op.
785 (if handler
786 (setq filename (funcall handler 'file-truename filename)
787 done t)
fb145562 788 (let ((dir (or (file-name-directory filename) default-directory))
05ef1cda
RS
789 target dirfile)
790 ;; Get the truename of the directory.
791 (setq dirfile (directory-file-name dir))
792 ;; If these are equal, we have the (or a) root directory.
793 (or (string= dir dirfile)
794 ;; If this is the same dir we last got the truename for,
795 ;; save time--don't recalculate.
796 (if (assoc dir (car prev-dirs))
797 (setq dir (cdr (assoc dir (car prev-dirs))))
798 (let ((old dir)
799 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
800 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
801 (setq dir new))))
802 (if (equal ".." (file-name-nondirectory filename))
803 (setq filename
804 (directory-file-name (file-name-directory (directory-file-name dir)))
805 done t)
806 (if (equal "." (file-name-nondirectory filename))
807 (setq filename (directory-file-name dir)
808 done t)
809 ;; Put it back on the file name.
810 (setq filename (concat dir (file-name-nondirectory filename)))
811 ;; Is the file name the name of a link?
812 (setq target (file-symlink-p filename))
813 (if target
814 ;; Yes => chase that link, then start all over
815 ;; since the link may point to a directory name that uses links.
816 ;; We can't safely use expand-file-name here
817 ;; since target might look like foo/../bar where foo
818 ;; is itself a link. Instead, we handle . and .. above.
819 (setq filename
820 (if (file-name-absolute-p target)
821 target
822 (concat dir target))
823 done nil)
824 ;; No, we are done!
825 (setq done t))))))))
826 filename))
5dbfdacd 827
302fcc98 828(defun file-chase-links (filename &optional limit)
5dadeb29 829 "Chase links in FILENAME until a name that is not a link.
302fcc98
RS
830Unlike `file-truename', this does not check whether a parent
831directory name is a symbolic link.
832If the optional argument LIMIT is a number,
833it means chase no more than that many links and then stop."
834 (let (tem (newname filename)
92464ae6 835 (count 0))
302fcc98
RS
836 (while (and (or (null limit) (< count limit))
837 (setq tem (file-symlink-p newname)))
9695aac6 838 (save-match-data
92464ae6 839 (if (and (null limit) (= count 100))
9695aac6
RS
840 (error "Apparent cycle of symbolic links for %s" filename))
841 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
842 (while (string-match "//+" tem)
843 (setq tem (replace-match "/" nil nil tem)))
844 ;; Handle `..' by hand, since it needs to work in the
845 ;; target of any directory symlink.
846 ;; This code is not quite complete; it does not handle
847 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
848 (while (string-match "\\`\\.\\./" tem)
849 (setq tem (substring tem 3))
850 (setq newname (expand-file-name newname))
851 ;; Chase links in the default dir of the symlink.
852 (setq newname
853 (file-chase-links
854 (directory-file-name (file-name-directory newname))))
855 ;; Now find the parent of that dir.
856 (setq newname (file-name-directory newname)))
857 (setq newname (expand-file-name tem (file-name-directory newname)))
92464ae6 858 (setq count (1+ count))))
5dadeb29 859 newname))
9bdbd98e
KH
860
861(defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
862 "Change the encoding of FILE's name from CODING to NEW-CODING.
863The value is a new name of FILE.
864Signals a `file-already-exists' error if a file of the new name
865already exists unless optional third argument OK-IF-ALREADY-EXISTS
866is non-nil. A number as third arg means request confirmation if
867the new name already exists. This is what happens in interactive
868use with M-x."
869 (interactive
870 (let ((default-coding (or file-name-coding-system
871 default-file-name-coding-system))
872 (filename (read-file-name "Recode filename: " nil nil t))
873 from-coding to-coding)
874 (if (and default-coding
875 ;; We provide the default coding only when it seems that
876 ;; the filename is correctly decoded by the default
877 ;; coding.
878 (let ((charsets (find-charset-string filename)))
879 (and (not (memq 'eight-bit-control charsets))
880 (not (memq 'eight-bit-graphic charsets)))))
881 (setq from-coding (read-coding-system
882 (format "Recode filename %s from (default %s): "
883 filename default-coding)
884 default-coding))
885 (setq from-coding (read-coding-system
886 (format "Recode filename %s from: " filename))))
cdec2ad7 887
9bdbd98e
KH
888 ;; We provide the default coding only when a user is going to
889 ;; change the encoding not from the default coding.
890 (if (eq from-coding default-coding)
891 (setq to-coding (read-coding-system
892 (format "Recode filename %s from %s to: "
893 filename from-coding)))
894 (setq to-coding (read-coding-system
895 (format "Recode filename %s from %s to (default %s): "
896 filename from-coding default-coding)
897 default-coding)))
898 (list filename from-coding to-coding)))
899
900 (let* ((default-coding (or file-name-coding-system
901 default-file-name-coding-system))
902 ;; FILE should have been decoded by DEFAULT-CODING.
903 (encoded (encode-coding-string file default-coding))
904 (newname (decode-coding-string encoded coding))
905 (new-encoded (encode-coding-string newname new-coding))
906 ;; Suppress further encoding.
907 (file-name-coding-system nil)
908 (default-file-name-coding-system nil)
909 (locale-coding-system nil))
910 (rename-file encoded new-encoded ok-if-already-exists)
911 newname))
b4da00e9 912\f
467ff692
RS
913(defun switch-to-buffer-other-window (buffer &optional norecord)
914 "Select buffer BUFFER in another window.
839857c7
LT
915If BUFFER does not identify an existing buffer, then this function
916creates a buffer with that name.
917
918When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
919or nil. If BUFFER is nil, then this function chooses a buffer
920using `other-buffer'.
467ff692 921Optional second arg NORECORD non-nil means
4c6a4739 922do not put this buffer at the front of the list of recently selected ones.
839857c7 923This function returns the buffer it switched to.
4c6a4739
EZ
924
925This uses the function `display-buffer' as a subroutine; see its
926documentation for additional customization information."
b4da00e9 927 (interactive "BSwitch to buffer in other window: ")
cf44b9b7
RS
928 (let ((pop-up-windows t)
929 ;; Don't let these interfere.
930 same-window-buffer-names same-window-regexps)
467ff692 931 (pop-to-buffer buffer t norecord)))
b4da00e9 932
467ff692
RS
933(defun switch-to-buffer-other-frame (buffer &optional norecord)
934 "Switch to buffer BUFFER in another frame.
935Optional second arg NORECORD non-nil means
4c6a4739
EZ
936do not put this buffer at the front of the list of recently selected ones.
937
938This uses the function `display-buffer' as a subroutine; see its
939documentation for additional customization information."
f98955ea 940 (interactive "BSwitch to buffer in other frame: ")
cf44b9b7
RS
941 (let ((pop-up-frames t)
942 same-window-buffer-names same-window-regexps)
467ff692 943 (pop-to-buffer buffer t norecord)
336b7f41 944 (raise-frame (window-frame (selected-window)))))
5bbbceb1 945
a49a58f9
RS
946(defvar find-file-default nil
947 "Used within `find-file-read-args'.")
948
a42e7db0
SM
949(defmacro minibuffer-with-setup-hook (fun &rest body)
950 "Add FUN to `minibuffer-setup-hook' while executing BODY.
951BODY should use the minibuffer at most once.
952Recursive uses of the minibuffer will not be affected."
953 (declare (indent 1) (debug t))
954 (let ((hook (make-symbol "setup-hook")))
44dce0fb
RS
955 `(let (,hook)
956 (setq ,hook
957 (lambda ()
958 ;; Clear out this hook so it does not interfere
959 ;; with any recursive minibuffer usage.
960 (remove-hook 'minibuffer-setup-hook ,hook)
961 (,fun)))
a42e7db0
SM
962 (unwind-protect
963 (progn
964 (add-hook 'minibuffer-setup-hook ,hook)
965 ,@body)
966 (remove-hook 'minibuffer-setup-hook ,hook)))))
967
05a7cb3d 968(defun find-file-read-args (prompt mustmatch)
e6f0ff92
RS
969 (list (let ((find-file-default
970 (and buffer-file-name
a42e7db0
SM
971 (abbreviate-file-name buffer-file-name))))
972 (minibuffer-with-setup-hook
973 (lambda () (setq minibuffer-default find-file-default))
974 (read-file-name prompt nil default-directory mustmatch)))
b2a26f4e 975 t))
e6f0ff92 976
243ce842 977(defun find-file (filename &optional wildcards)
b4da00e9
RM
978 "Edit file FILENAME.
979Switch to a buffer visiting file FILENAME,
243ce842 980creating one if none already exists.
e6f0ff92
RS
981Interactively, the default if you just type RET is the current directory,
982but the visited file name is available through the minibuffer history:
983type M-n to pull it into the minibuffer.
984
243ce842 985Interactively, or if WILDCARDS is non-nil in a call from Lisp,
91174d63
RS
986expand wildcards (if any) and visit multiple files. You can
987suppress wildcard expansion by setting `find-file-wildcards'.
988
989To visit a file without any kind of conversion and without
990automatically choosing a major mode, use \\[find-file-literally]."
a9d6a617 991 (interactive (find-file-read-args "Find file: " nil))
5b8ed07b
RS
992 (let ((value (find-file-noselect filename nil nil wildcards)))
993 (if (listp value)
994 (mapcar 'switch-to-buffer (nreverse value))
995 (switch-to-buffer value))))
82d0954a 996
243ce842 997(defun find-file-other-window (filename &optional wildcards)
b4da00e9
RM
998 "Edit file FILENAME, in another window.
999May create a new window, or reuse an existing one.
243ce842 1000See the function `display-buffer'.
e6f0ff92
RS
1001
1002Interactively, the default if you just type RET is the current directory,
1003but the visited file name is available through the minibuffer history:
1004type M-n to pull it into the minibuffer.
1005
243ce842
RS
1006Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1007expand wildcards (if any) and visit multiple files."
05a7cb3d 1008 (interactive (find-file-read-args "Find file in other window: " nil))
5b8ed07b
RS
1009 (let ((value (find-file-noselect filename nil nil wildcards)))
1010 (if (listp value)
1011 (progn
1012 (setq value (nreverse value))
a9d6a617
JL
1013 (cons (switch-to-buffer-other-window (car value))
1014 (mapcar 'switch-to-buffer (cdr value))))
5b8ed07b 1015 (switch-to-buffer-other-window value))))
243ce842
RS
1016
1017(defun find-file-other-frame (filename &optional wildcards)
f98955ea
JB
1018 "Edit file FILENAME, in another frame.
1019May create a new frame, or reuse an existing one.
243ce842 1020See the function `display-buffer'.
e6f0ff92
RS
1021
1022Interactively, the default if you just type RET is the current directory,
1023but the visited file name is available through the minibuffer history:
1024type M-n to pull it into the minibuffer.
1025
243ce842
RS
1026Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1027expand wildcards (if any) and visit multiple files."
05a7cb3d 1028 (interactive (find-file-read-args "Find file in other frame: " nil))
5b8ed07b
RS
1029 (let ((value (find-file-noselect filename nil nil wildcards)))
1030 (if (listp value)
1031 (progn
1032 (setq value (nreverse value))
a9d6a617
JL
1033 (cons (switch-to-buffer-other-frame (car value))
1034 (mapcar 'switch-to-buffer (cdr value))))
5b8ed07b 1035 (switch-to-buffer-other-frame value))))
243ce842 1036
46bfc73b
JD
1037(defun find-file-existing (filename &optional wildcards)
1038 "Edit the existing file FILENAME.
1039Like \\[find-file] but only allow files that exists."
1040 (interactive (find-file-read-args "Find existing file: " t))
1041 (unless (file-exists-p filename) (error "%s does not exist" filename))
1042 (find-file filename wildcards)
1043 (current-buffer))
1044
243ce842 1045(defun find-file-read-only (filename &optional wildcards)
b4da00e9 1046 "Edit file FILENAME but don't allow changes.
e6f0ff92 1047Like \\[find-file] but marks buffer as read-only.
b4da00e9 1048Use \\[toggle-read-only] to permit editing."
a9d6a617
JL
1049 (interactive (find-file-read-args "Find file read-only: " nil))
1050 (unless (or (and wildcards find-file-wildcards
1051 (not (string-match "\\`/:" filename))
1052 (string-match "[[*?]" filename))
1053 (file-exists-p filename))
1054 (error "%s does not exist" filename))
1055 (let ((value (find-file filename wildcards)))
1056 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1057 (if (listp value) value (list value)))
1058 value))
b4da00e9 1059
243ce842 1060(defun find-file-read-only-other-window (filename &optional wildcards)
b4da00e9
RM
1061 "Edit file FILENAME in another window but don't allow changes.
1062Like \\[find-file-other-window] but marks buffer as read-only.
1063Use \\[toggle-read-only] to permit editing."
a9d6a617
JL
1064 (interactive (find-file-read-args "Find file read-only other window: " nil))
1065 (unless (or (and wildcards find-file-wildcards
1066 (not (string-match "\\`/:" filename))
1067 (string-match "[[*?]" filename))
1068 (file-exists-p filename))
1069 (error "%s does not exist" filename))
1070 (let ((value (find-file-other-window filename wildcards)))
1071 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1072 (if (listp value) value (list value)))
1073 value))
b4da00e9 1074
243ce842 1075(defun find-file-read-only-other-frame (filename &optional wildcards)
f98955ea
JB
1076 "Edit file FILENAME in another frame but don't allow changes.
1077Like \\[find-file-other-frame] but marks buffer as read-only.
5bbbceb1 1078Use \\[toggle-read-only] to permit editing."
a9d6a617
JL
1079 (interactive (find-file-read-args "Find file read-only other frame: " nil))
1080 (unless (or (and wildcards find-file-wildcards
1081 (not (string-match "\\`/:" filename))
1082 (string-match "[[*?]" filename))
1083 (file-exists-p filename))
1084 (error "%s does not exist" filename))
1085 (let ((value (find-file-other-frame filename wildcards)))
1086 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1087 (if (listp value) value (list value)))
1088 value))
1089
1090(defun find-alternate-file-other-window (filename &optional wildcards)
60eaf370 1091 "Find file FILENAME as a replacement for the file in the next window.
a9d6a617
JL
1092This command does not select that window.
1093
1094Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1095expand wildcards (if any) and replace the file with multiple files."
60eaf370
RS
1096 (interactive
1097 (save-selected-window
1098 (other-window 1)
1099 (let ((file buffer-file-name)
1100 (file-name nil)
1101 (file-dir nil))
1102 (and file
1103 (setq file-name (file-name-nondirectory file)
1104 file-dir (file-name-directory file)))
1105 (list (read-file-name
a9d6a617
JL
1106 "Find alternate file: " file-dir nil nil file-name)
1107 t))))
60eaf370 1108 (if (one-window-p)
a9d6a617 1109 (find-file-other-window filename wildcards)
60eaf370
RS
1110 (save-selected-window
1111 (other-window 1)
a9d6a617 1112 (find-alternate-file filename wildcards))))
60eaf370 1113
a9d6a617 1114(defun find-alternate-file (filename &optional wildcards)
b4da00e9
RM
1115 "Find file FILENAME, select its buffer, kill previous buffer.
1116If the current buffer now contains an empty file that you just visited
a9d6a617
JL
1117\(presumably by mistake), use this command to visit the file you really want.
1118
1119Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1120expand wildcards (if any) and replace the file with multiple files."
b4da00e9
RM
1121 (interactive
1122 (let ((file buffer-file-name)
1123 (file-name nil)
1124 (file-dir nil))
1125 (and file
1126 (setq file-name (file-name-nondirectory file)
1127 file-dir (file-name-directory file)))
a61f59b4 1128 (list (read-file-name
a9d6a617
JL
1129 "Find alternate file: " file-dir nil nil file-name)
1130 t)))
63fabbb4
RS
1131 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1132 (error "Aborted"))
1133 (when (and (buffer-modified-p) (buffer-file-name))
1134 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1135 (buffer-name)))
1136 (save-buffer)
1137 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1138 (error "Aborted"))))
b4da00e9
RM
1139 (let ((obuf (current-buffer))
1140 (ofile buffer-file-name)
8bb27285 1141 (onum buffer-file-number)
37c58ca6 1142 (odir dired-directory)
8bb27285 1143 (otrue buffer-file-truename)
b4da00e9 1144 (oname (buffer-name)))
baf9b8c4
RS
1145 (if (get-buffer " **lose**")
1146 (kill-buffer " **lose**"))
b4da00e9 1147 (rename-buffer " **lose**")
b4da00e9
RM
1148 (unwind-protect
1149 (progn
1150 (unlock-buffer)
7906c044
RS
1151 ;; This prevents us from finding the same buffer
1152 ;; if we specified the same file again.
a4ad4d96
RS
1153 (setq buffer-file-name nil)
1154 (setq buffer-file-number nil)
1155 (setq buffer-file-truename nil)
7906c044
RS
1156 ;; Likewise for dired buffers.
1157 (setq dired-directory nil)
a9d6a617 1158 (find-file filename wildcards))
63fabbb4
RS
1159 (when (eq obuf (current-buffer))
1160 ;; This executes if find-file gets an error
1161 ;; and does not really find anything.
1162 ;; We put things back as they were.
1163 ;; If find-file actually finds something, we kill obuf below.
1164 (setq buffer-file-name ofile)
1165 (setq buffer-file-number onum)
1166 (setq buffer-file-truename otrue)
7906c044 1167 (setq dired-directory odir)
63fabbb4
RS
1168 (lock-buffer)
1169 (rename-buffer oname)))
1170 (unless (eq (current-buffer) obuf)
d97a9ff3
RS
1171 (with-current-buffer obuf
1172 ;; We already asked; don't ask again.
1173 (let ((kill-buffer-query-functions))
1174 (kill-buffer obuf))))))
9b8ef27d 1175\f
b4da00e9
RM
1176(defun create-file-buffer (filename)
1177 "Create a suitably named buffer for visiting FILENAME, and return it.
1178FILENAME (sans directory) is used unchanged if that name is free;
1179otherwise a string <2> or <3> or ... is appended to get an unused name."
1180 (let ((lastname (file-name-nondirectory filename)))
1181 (if (string= lastname "")
1182 (setq lastname filename))
1183 (generate-new-buffer lastname)))
1184
5bbbceb1
JB
1185(defun generate-new-buffer (name)
1186 "Create and return a buffer with a name based on NAME.
29165787 1187Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
1188 (get-buffer-create (generate-new-buffer-name name)))
1189
ffc0e1ca
AS
1190(defcustom automount-dir-prefix "^/tmp_mnt/"
1191 "Regexp to match the automounter prefix in a directory name."
1192 :group 'files
1193 :type 'regexp)
e373f201 1194
ffb3a4db 1195(defvar abbreviated-home-dir nil
ffc0e1ca 1196 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
ffb3a4db 1197
5bbbceb1 1198(defun abbreviate-file-name (filename)
29165787 1199 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
b69a0de9 1200This also substitutes \"~\" for the user's home directory and
5baabf7b 1201removes automounter prefixes (see the variable `automount-dir-prefix')."
e373f201 1202 ;; Get rid of the prefixes added by the automounter.
a8f34fc0
RS
1203 (if (and automount-dir-prefix
1204 (string-match automount-dir-prefix filename)
e373f201
JB
1205 (file-exists-p (file-name-directory
1206 (substring filename (1- (match-end 0))))))
1207 (setq filename (substring filename (1- (match-end 0)))))
5bbbceb1 1208 (let ((tail directory-abbrev-alist))
ffb3a4db
RS
1209 ;; If any elt of directory-abbrev-alist matches this name,
1210 ;; abbreviate accordingly.
5bbbceb1
JB
1211 (while tail
1212 (if (string-match (car (car tail)) filename)
1213 (setq filename
1214 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1215 (setq tail (cdr tail)))
ffb3a4db
RS
1216 ;; Compute and save the abbreviated homedir name.
1217 ;; We defer computing this until the first time it's needed, to
1218 ;; give time for directory-abbrev-alist to be set properly.
e98dda89
RS
1219 ;; We include a slash at the end, to avoid spurious matches
1220 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
ffb3a4db
RS
1221 (or abbreviated-home-dir
1222 (setq abbreviated-home-dir
1223 (let ((abbreviated-home-dir "$foo"))
3a8a836d
RS
1224 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1225 "\\(/\\|$\\)"))))
76d5492b 1226
ffb3a4db
RS
1227 ;; If FILENAME starts with the abbreviated homedir,
1228 ;; make it start with `~' instead.
ca33ccb5
RS
1229 (if (and (string-match abbreviated-home-dir filename)
1230 ;; If the home dir is just /, don't change it.
1231 (not (and (= (match-end 0) 1)
288201bd 1232 (= (aref filename 0) ?/)))
567c1ca9
RS
1233 ;; MS-DOS root directories can come with a drive letter;
1234 ;; Novell Netware allows drive letters beyond `Z:'.
76d5492b 1235 (not (and (or (eq system-type 'ms-dos)
c60ee5e7 1236 (eq system-type 'cygwin)
c32d49e8 1237 (eq system-type 'windows-nt))
288201bd 1238 (save-match-data
567c1ca9 1239 (string-match "^[a-zA-`]:/$" filename)))))
5bbbceb1 1240 (setq filename
28dbf501 1241 (concat "~"
3a8a836d 1242 (substring filename (match-beginning 1) (match-end 1))
28dbf501 1243 (substring filename (match-end 0)))))
5bbbceb1
JB
1244 filename))
1245
21540597 1246(defcustom find-file-not-true-dirname-list nil
1770543d
RS
1247 "*List of logical names for which visiting shouldn't save the true dirname.
1248On VMS, when you visit a file using a logical name that searches a path,
1249you may or may not want the visited file name to record the specific
1250directory where the file was found. If you *do not* want that, add the logical
21540597
RS
1251name to this list as a string."
1252 :type '(repeat (string :tag "Name"))
1253 :group 'find-file)
1770543d 1254
3a64a3cf 1255(defun find-buffer-visiting (filename &optional predicate)
138c44f6
KH
1256 "Return the buffer visiting file FILENAME (a string).
1257This is like `get-file-buffer', except that it checks for any buffer
1258visiting the same file, possibly under a different name.
a1b0c2a7
RS
1259If PREDICATE is non-nil, only buffers satisfying it are eligible,
1260and others are ignored.
138c44f6 1261If there is no such live buffer, return nil."
3a64a3cf
JB
1262 (let ((predicate (or predicate #'identity))
1263 (truename (abbreviate-file-name (file-truename filename))))
1264 (or (let ((buf (get-file-buffer filename)))
1265 (when (and buf (funcall predicate buf)) buf))
1266 (let ((list (buffer-list)) found)
1267 (while (and (not found) list)
1268 (save-excursion
1269 (set-buffer (car list))
1270 (if (and buffer-file-name
1271 (string= buffer-file-truename truename)
1272 (funcall predicate (current-buffer)))
1273 (setq found (car list))))
1274 (setq list (cdr list)))
1275 found)
1276 (let* ((attributes (file-attributes truename))
1277 (number (nthcdr 10 attributes))
1278 (list (buffer-list)) found)
1279 (and buffer-file-numbers-unique
1280 number
1281 (while (and (not found) list)
1282 (with-current-buffer (car list)
1283 (if (and buffer-file-name
1284 (equal buffer-file-number number)
1285 ;; Verify this buffer's file number
1286 ;; still belongs to its file.
1287 (file-exists-p buffer-file-name)
1288 (equal (file-attributes buffer-file-truename)
1289 attributes)
1290 (funcall predicate (current-buffer)))
1291 (setq found (car list))))
1292 (setq list (cdr list))))
1293 found))))
9b8ef27d 1294\f
5de148a2
RS
1295(defcustom find-file-wildcards t
1296 "*Non-nil means file-visiting commands should handle wildcards.
1297For example, if you specify `*.c', that would visit all the files
1298whose names match the pattern."
1299 :group 'files
3957c982 1300 :version "20.4"
5de148a2
RS
1301 :type 'boolean)
1302
ffc0e1ca
AS
1303(defcustom find-file-suppress-same-file-warnings nil
1304 "*Non-nil means suppress warning messages for symlinked files.
1305When nil, Emacs prints a warning when visiting a file that is already
1306visited, but with a different name. Setting this option to t
1307suppresses this warning."
1308 :group 'files
1309 :version "21.1"
1310 :type 'boolean)
1311
818286f4 1312(defcustom large-file-warning-threshold 10000000
5d648479
JPW
1313 "Maximum size of file above which a confirmation is requested.
1314When nil, never request confirmation."
1315 :group 'files
1316 :group 'find-file
bf247b6e 1317 :version "22.1"
5d648479 1318 :type '(choice integer (const :tag "Never request confirmation" nil)))
818286f4 1319
243ce842 1320(defun find-file-noselect (filename &optional nowarn rawfile wildcards)
b4da00e9
RM
1321 "Read file FILENAME into a buffer and return the buffer.
1322If a buffer exists visiting FILENAME, return that one, but
1323verify that the file has not changed since visited or saved.
82d0954a
KH
1324The buffer is not selected, just returned to the caller.
1325Optional first arg NOWARN non-nil means suppress any warning messages.
243ce842
RS
1326Optional second arg RAWFILE non-nil means the file is read literally.
1327Optional third arg WILDCARDS non-nil means do wildcard processing
5b8ed07b 1328and visit all the matching files. When wildcards are actually
a9d6a617
JL
1329used and expanded, return a list of buffers that are visiting
1330the various files."
e373f201
JB
1331 (setq filename
1332 (abbreviate-file-name
1333 (expand-file-name filename)))
b4da00e9 1334 (if (file-directory-p filename)
ffc0e1ca
AS
1335 (or (and find-file-run-dired
1336 (run-hook-with-args-until-success
1337 'find-directory-functions
1338 (if find-file-visit-truename
1339 (abbreviate-file-name (file-truename filename))
1340 filename)))
1341 (error "%s is a directory" filename))
243ce842
RS
1342 (if (and wildcards
1343 find-file-wildcards
f91fe604 1344 (not (string-match "\\`/:" filename))
5de148a2 1345 (string-match "[[*?]" filename))
ffc0e1ca
AS
1346 (let ((files (condition-case nil
1347 (file-expand-wildcards filename t)
1348 (error (list filename))))
5de148a2 1349 (find-file-wildcards nil))
f91fe604 1350 (if (null files)
ffc0e1ca 1351 (find-file-noselect filename)
648ec2ff 1352 (mapcar #'find-file-noselect files)))
5de148a2
RS
1353 (let* ((buf (get-file-buffer filename))
1354 (truename (abbreviate-file-name (file-truename filename)))
818286f4
SM
1355 (attributes (file-attributes truename))
1356 (number (nthcdr 10 attributes))
5de148a2
RS
1357 ;; Find any buffer for a file which has same truename.
1358 (other (and (not buf) (find-buffer-visiting filename))))
1359 ;; Let user know if there is a buffer with the same truename.
1360 (if other
1361 (progn
1362 (or nowarn
ffc0e1ca 1363 find-file-suppress-same-file-warnings
5de148a2
RS
1364 (string-equal filename (buffer-file-name other))
1365 (message "%s and %s are the same file"
1366 filename (buffer-file-name other)))
1367 ;; Optionally also find that buffer.
1368 (if (or find-file-existing-other-name find-file-visit-truename)
1369 (setq buf other))))
818286f4
SM
1370 ;; Check to see if the file looks uncommonly large.
1371 (when (and large-file-warning-threshold (nth 7 attributes)
1372 ;; Don't ask again if we already have the file or
1373 ;; if we're asked to be quiet.
1374 (not (or buf nowarn))
1375 (> (nth 7 attributes) large-file-warning-threshold)
1376 (not (y-or-n-p
1377 (format "File %s is large (%sMB), really open? "
1378 (file-name-nondirectory filename)
1379 (/ (nth 7 attributes) 1048576)))))
1380 (error "Aborted"))
5de148a2
RS
1381 (if buf
1382 ;; We are using an existing buffer.
1383 (progn
1384 (or nowarn
1385 (verify-visited-file-modtime buf)
1386 (cond ((not (file-exists-p filename))
1387 (error "File %s no longer exists!" filename))
1388 ;; Certain files should be reverted automatically
1389 ;; if they have changed on disk and not in the buffer.
1390 ((and (not (buffer-modified-p buf))
1391 (let ((tail revert-without-query)
1392 (found nil))
1393 (while tail
1394 (if (string-match (car tail) filename)
1395 (setq found t))
1396 (setq tail (cdr tail)))
1397 found))
1398 (with-current-buffer buf
1399 (message "Reverting file %s..." filename)
1400 (revert-buffer t t)
1401 (message "Reverting file %s...done" filename)))
1402 ((yes-or-no-p
1403 (if (string= (file-name-nondirectory filename)
1404 (buffer-name buf))
1405 (format
1406 (if (buffer-modified-p buf)
1407 "File %s changed on disk. Discard your edits? "
1408 "File %s changed on disk. Reread from disk? ")
1409 (file-name-nondirectory filename))
ddd64da9
RS
1410 (format
1411 (if (buffer-modified-p buf)
5de148a2
RS
1412 "File %s changed on disk. Discard your edits in %s? "
1413 "File %s changed on disk. Reread from disk into %s? ")
1414 (file-name-nondirectory filename)
1415 (buffer-name buf))))
1416 (with-current-buffer buf
1417 (revert-buffer t t)))))
1418 (with-current-buffer buf
a8d002d2
GM
1419
1420 ;; Check if a formerly read-only file has become
e554eeb7
RS
1421 ;; writable and vice versa, but if the buffer agrees
1422 ;; with the new state of the file, that is ok too.
a8d002d2 1423 (let ((read-only (not (file-writable-p buffer-file-name))))
e554eeb7
RS
1424 (unless (or (eq read-only buffer-file-read-only)
1425 (eq read-only buffer-read-only))
a8d002d2 1426 (when (or nowarn
36236b72 1427 (let ((question
a8d002d2
GM
1428 (format "File %s is %s on disk. Change buffer mode? "
1429 buffer-file-name
1430 (if read-only "read-only" "writable"))))
1431 (y-or-n-p question)))
e554eeb7
RS
1432 (setq buffer-read-only read-only)))
1433 (setq buffer-file-read-only read-only))
a8d002d2 1434
ef59dd3b
EZ
1435 (when (and (not (eq (not (null rawfile))
1436 (not (null find-file-literally))))
1437 ;; It is confusing to ask whether to visit
1438 ;; non-literally if they have the file in
1439 ;; hexl-mode.
1440 (not (eq major-mode 'hexl-mode)))
5de148a2 1441 (if (buffer-modified-p)
ddd64da9 1442 (if (y-or-n-p (if rawfile
5de148a2
RS
1443 "Save file and revisit literally? "
1444 "Save file and revisit non-literally? "))
1445 (progn
1446 (save-buffer)
1447 (find-file-noselect-1 buf filename nowarn
1448 rawfile truename number))
1449 (if (y-or-n-p (if rawfile
1450 "Discard your edits and revisit file literally? "
1451 "Discard your edits and revisit file non-literally? "))
1452 (find-file-noselect-1 buf filename nowarn
1453 rawfile truename number)
1454 (error (if rawfile "File already visited non-literally"
1455 "File already visited literally"))))
1456 (if (y-or-n-p (if rawfile
1457 "Revisit file literally? "
1458 "Revisit file non-literally? "))
1459 (find-file-noselect-1 buf filename nowarn
1460 rawfile truename number)
1461 (error (if rawfile "File already visited non-literally"
1462 "File already visited literally"))))))
1463 ;; Return the buffer we are using.
1464 buf)
1465 ;; Create a new buffer.
1466 (setq buf (create-file-buffer filename))
1467 (set-buffer-major-mode buf)
1468 ;; find-file-noselect-1 may use a different buffer.
1469 (find-file-noselect-1 buf filename nowarn
1470 rawfile truename number))))))
ddd64da9
RS
1471
1472(defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
4edcfd17 1473 (let (error)
ddd64da9
RS
1474 (with-current-buffer buf
1475 (kill-local-variable 'find-file-literally)
b296cbd4
RS
1476 ;; Needed in case we are re-visiting the file with a different
1477 ;; text representation.
e73ec04b 1478 (kill-local-variable 'buffer-file-coding-system)
4ad1689f 1479 (kill-local-variable 'cursor-type)
4edcfd17 1480 (let ((inhibit-read-only t))
0a11c70b
LT
1481 (erase-buffer))
1482 (and (default-value 'enable-multibyte-characters)
1483 (not rawfile)
1484 (set-buffer-multibyte t))
1485 (if rawfile
74dca654 1486 (condition-case ()
0a11c70b
LT
1487 (let ((inhibit-read-only t))
1488 (insert-file-contents-literally filename t))
74dca654
LT
1489 (file-error
1490 (when (and (file-exists-p filename)
1491 (not (file-readable-p filename)))
1492 (kill-buffer buf)
1493 (signal 'file-error (list "File is not readable"
1494 filename)))
0a11c70b
LT
1495 ;; Unconditionally set error
1496 (setq error t)))
1497 (condition-case ()
1498 (let ((inhibit-read-only t))
1499 (insert-file-contents filename t))
1500 (file-error
1501 (when (and (file-exists-p filename)
1502 (not (file-readable-p filename)))
1503 (kill-buffer buf)
1504 (signal 'file-error (list "File is not readable"
1505 filename)))
1506 ;; Run find-file-not-found-hooks until one returns non-nil.
1507 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1508 ;; If they fail too, set error.
1509 (setq error t)))))
b120e713
KH
1510 ;; Record the file's truename, and maybe use that as visited name.
1511 (if (equal filename buffer-file-name)
1512 (setq buffer-file-truename truename)
9ab19105
DL
1513 (setq buffer-file-truename
1514 (abbreviate-file-name (file-truename buffer-file-name))))
ddd64da9
RS
1515 (setq buffer-file-number number)
1516 ;; On VMS, we may want to remember which directory in a search list
1517 ;; the file was found in.
1518 (and (eq system-type 'vax-vms)
1519 (let (logical)
1520 (if (string-match ":" (file-name-directory filename))
1521 (setq logical (substring (file-name-directory filename)
1522 0 (match-beginning 0))))
1523 (not (member logical find-file-not-true-dirname-list)))
1524 (setq buffer-file-name buffer-file-truename))
1525 (if find-file-visit-truename
1526 (setq buffer-file-name
1527 (setq filename
1528 (expand-file-name buffer-file-truename))))
1529 ;; Set buffer's default directory to that of the file.
b120e713 1530 (setq default-directory (file-name-directory buffer-file-name))
ddd64da9
RS
1531 ;; Turn off backup files for certain file names. Since
1532 ;; this is a permanent local, the major mode won't eliminate it.
1533 (and (not (funcall backup-enable-predicate buffer-file-name))
1534 (progn
1535 (make-local-variable 'backup-inhibited)
1536 (setq backup-inhibited t)))
f402ba38
RS
1537 (if rawfile
1538 (progn
1539 (set-buffer-multibyte nil)
1540 (setq buffer-file-coding-system 'no-conversion)
1541 (make-local-variable 'find-file-literally)
1542 (setq find-file-literally t))
1543 (after-find-file error (not nowarn)))
1544 (current-buffer))))
9b8ef27d
RS
1545\f
1546(defun insert-file-contents-literally (filename &optional visit beg end replace)
1547 "Like `insert-file-contents', but only reads in the file literally.
1548A buffer may be modified in several ways after reading into the buffer,
1549to Emacs features such as format decoding, character code
0370fe77 1550conversion, `find-file-hook', automatic uncompression, etc.
9b8ef27d
RS
1551
1552This function ensures that none of these modifications will take place."
1553 (let ((format-alist nil)
1554 (after-insert-file-functions nil)
1555 (coding-system-for-read 'no-conversion)
1556 (coding-system-for-write 'no-conversion)
9b8ef27d 1557 (find-buffer-file-type-function
cdec2ad7
JB
1558 (if (fboundp 'find-buffer-file-type)
1559 (symbol-function 'find-buffer-file-type)
1560 nil))
1561 (inhibit-file-name-handlers
1562 (append '(jka-compr-handler image-file-handler)
1563 inhibit-file-name-handlers))
1564 (inhibit-file-name-operation 'insert-file-contents))
9b8ef27d 1565 (unwind-protect
cdec2ad7
JB
1566 (progn
1567 (fset 'find-buffer-file-type (lambda (filename) t))
1568 (insert-file-contents filename visit beg end replace))
9b8ef27d
RS
1569 (if find-buffer-file-type-function
1570 (fset 'find-buffer-file-type find-buffer-file-type-function)
1571 (fmakunbound 'find-buffer-file-type)))))
1572
3a64a3cf
JB
1573(defun insert-file-1 (filename insert-func)
1574 (if (file-directory-p filename)
1575 (signal 'file-error (list "Opening input file" "file is a directory"
1576 filename)))
1577 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1578 #'buffer-modified-p))
1579 (tem (funcall insert-func filename)))
1580 (push-mark (+ (point) (car (cdr tem))))
1581 (when buffer
1582 (message "File %s already visited and modified in buffer %s"
1583 filename (buffer-name buffer)))))
1584
9b8ef27d
RS
1585(defun insert-file-literally (filename)
1586 "Insert contents of file FILENAME into buffer after point with no conversion.
1587
1588This function is meant for the user to run interactively.
1589Don't call it from programs! Use `insert-file-contents-literally' instead.
1590\(Its calling sequence is different; see its documentation)."
1591 (interactive "*fInsert file literally: ")
3a64a3cf 1592 (insert-file-1 filename #'insert-file-contents-literally))
9b8ef27d
RS
1593
1594(defvar find-file-literally nil
1595 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1596This is a permanent local.")
1597(put 'find-file-literally 'permanent-local t)
5fc196af 1598
ffc0e1ca 1599(defun find-file-literally (filename)
5fc196af
RS
1600 "Visit file FILENAME with no conversion of any kind.
1601Format conversion and character code conversion are both disabled,
1602and multibyte characters are disabled in the resulting buffer.
e65db7b8
RS
1603The major mode used is Fundamental mode regardless of the file name,
1604and local variable specifications in the file are ignored.
407b4328
GM
1605Automatic uncompression and adding a newline at the end of the
1606file due to `require-final-newline' is also disabled.
9b8ef27d
RS
1607
1608You cannot absolutely rely on this function to result in
b9aa9537 1609visiting the file literally. If Emacs already has a buffer
9b8ef27d
RS
1610which is visiting the file, you get the existing buffer,
1611regardless of whether it was created literally or not.
1612
1613In a Lisp program, if you want to be sure of accessing a file's
1614contents literally, you should create a temporary buffer and then read
1615the file contents into it using `insert-file-contents-literally'."
5fc196af 1616 (interactive "FFind file literally: ")
9b8ef27d 1617 (switch-to-buffer (find-file-noselect filename nil t)))
b4da00e9 1618\f
f7d786d0
RS
1619(defvar after-find-file-from-revert-buffer nil)
1620
e0ab8879 1621(defun after-find-file (&optional error warn noauto
9a30563f
RS
1622 after-find-file-from-revert-buffer
1623 nomodes)
b4da00e9
RM
1624 "Called after finding a file and by the default revert function.
1625Sets buffer mode, parses local variables.
8cfb9d46 1626Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
1627error in reading the file. WARN non-nil means warn if there
1628exists an auto-save file more recent than the visited file.
8cfb9d46 1629NOAUTO means don't mess with auto-save mode.
e0ab8879
RS
1630Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1631 means this call was from `revert-buffer'.
9a30563f 1632Fifth arg NOMODES non-nil means don't alter the file's modes.
0370fe77 1633Finishes by calling the functions in `find-file-hook'
9a30563f 1634unless NOMODES is non-nil."
b4da00e9
RM
1635 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1636 (if noninteractive
1637 nil
1638 (let* (not-serious
1639 (msg
fe50b6ab
GM
1640 (cond
1641 ((not warn) nil)
1642 ((and error (file-attributes buffer-file-name))
1643 (setq buffer-read-only t)
1644 "File exists, but cannot be read")
1645 ((not buffer-read-only)
1646 (if (and warn
1647 ;; No need to warn if buffer is auto-saved
1648 ;; under the name of the visited file.
1649 (not (and buffer-file-name
1650 auto-save-visited-file-name))
1651 (file-newer-than-file-p (or buffer-auto-save-file-name
1652 (make-auto-save-file-name))
1653 buffer-file-name))
64d18e8f 1654 (format "%s has auto save data; consider M-x recover-this-file"
fe50b6ab
GM
1655 (file-name-nondirectory buffer-file-name))
1656 (setq not-serious t)
1657 (if error "(New file)" nil)))
1658 ((not error)
1659 (setq not-serious t)
1660 "Note: file is write protected")
1661 ((file-attributes (directory-file-name default-directory))
1662 "File not found and directory write-protected")
1663 ((file-exists-p (file-name-directory buffer-file-name))
1664 (setq buffer-read-only nil))
1665 (t
1666 (setq buffer-read-only nil)
07703430 1667 "Use M-x make-directory RET RET to create the directory and its parents"))))
fe50b6ab 1668 (when msg
a74357d4 1669 (message "%s" msg)
e09f3bff 1670 (or not-serious (sit-for 1 t))))
fe50b6ab
GM
1671 (when (and auto-save-default (not noauto))
1672 (auto-save-mode t)))
ffc0e1ca
AS
1673 ;; Make people do a little extra work (C-x C-q)
1674 ;; before altering a backup file.
fe50b6ab
GM
1675 (when (backup-file-name-p buffer-file-name)
1676 (setq buffer-read-only t))
8fd9c174
RS
1677 ;; When a file is marked read-only,
1678 ;; make the buffer read-only even if root is looking at it.
879365c6
KS
1679 (when (and (file-modes (buffer-file-name))
1680 (zerop (logand (file-modes (buffer-file-name)) #o222)))
8fd9c174 1681 (setq buffer-read-only t))
fe50b6ab
GM
1682 (unless nomodes
1683 (when (and view-read-only view-mode)
1684 (view-mode-disable))
9a30563f 1685 (normal-mode t)
f4206092
RS
1686 ;; If requested, add a newline at the end of the file.
1687 (and (memq require-final-newline '(visit visit-save))
1688 (> (point-max) (point-min))
1689 (/= (char-after (1- (point-max))) ?\n)
1690 (not (and (eq selective-display t)
1691 (= (char-after (1- (point-max))) ?\r)))
1692 (save-excursion
1693 (goto-char (point-max))
1694 (insert "\n")))
fe50b6ab
GM
1695 (when (and buffer-read-only
1696 view-read-only
1697 (not (eq (get major-mode 'mode-class) 'special)))
1698 (view-mode-enter))
0370fe77 1699 (run-hooks 'find-file-hook)))
b4da00e9 1700
818286f4
SM
1701(defmacro report-errors (format &rest body)
1702 "Eval BODY and turn any error into a FORMAT message.
1703FORMAT can have a %s escape which will be replaced with the actual error.
1704If `debug-on-error' is set, errors are not caught, so that you can
1705debug them.
1706Avoid using a large BODY since it is duplicated."
1707 (declare (debug t) (indent 1))
1708 `(if debug-on-error
1709 (progn . ,body)
1710 (condition-case err
1711 (progn . ,body)
1712 (error (message ,format (prin1-to-string err))))))
1713
b4da00e9
RM
1714(defun normal-mode (&optional find-file)
1715 "Choose the major mode for this buffer automatically.
1716Also sets up any specified local variables of the file.
1717Uses the visited file name, the -*- line, and the local variables spec.
1718
1719This function is called automatically from `find-file'. In that case,
aa5fcebf
KH
1720we may set up the file-specified mode and local variables,
1721depending on the value of `enable-local-variables': if it is t, we do;
1722if it is nil, we don't; otherwise, we query.
1723In addition, if `local-enable-local-variables' is nil, we do
1724not set local variables (though we do notice a mode specified with -*-.)
1725
1726`enable-local-variables' is ignored if you run `normal-mode' interactively,
1727or from Lisp without specifying the optional argument FIND-FILE;
1728in that case, this function acts as if `enable-local-variables' were t."
b4da00e9
RM
1729 (interactive)
1730 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
0fc205c6
LT
1731 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
1732 (report-errors "File mode specification error: %s"
1733 (set-auto-mode))
1734 (report-errors "File local-variables error: %s"
818286f4 1735 (hack-local-variables)))
24c9eeeb
DL
1736 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1737 (ucs-set-table-for-input)))
b4da00e9 1738
f76e0cd0 1739(defvar auto-mode-alist
f209c999
MS
1740 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1741 ;; c++-mode, java-mode and more) are added through autoload
1742 ;; directives in that file. That way is discouraged since it
1743 ;; spreads out the definition of the initial value.
ffc0e1ca
AS
1744 (mapc
1745 (lambda (elt)
1746 (cons (purecopy (car elt)) (cdr elt)))
9e6f5419
DP
1747 '(;; do this first, so that .html.pl is Polish html, not Perl
1748 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
1749 ("\\.te?xt\\'" . text-mode)
bbc67516 1750 ("\\.[tT]e[xX]\\'" . tex-mode)
4e163715 1751 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
ffc0e1ca 1752 ("\\.ltx\\'" . latex-mode)
4e163715 1753 ("\\.dtx\\'" . doctex-mode)
ffc0e1ca 1754 ("\\.el\\'" . emacs-lisp-mode)
21575d92 1755 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
ffc0e1ca 1756 ("\\.l\\'" . lisp-mode)
bbc67516
DP
1757 ("\\.li?sp\\'" . lisp-mode)
1758 ("\\.[fF]\\'" . fortran-mode)
ffc0e1ca
AS
1759 ("\\.for\\'" . fortran-mode)
1760 ("\\.p\\'" . pascal-mode)
1761 ("\\.pas\\'" . pascal-mode)
1762 ("\\.ad[abs]\\'" . ada-mode)
7defe888 1763 ("\\.ad[bs].dg\\'" . ada-mode)
bbc67516 1764 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
27a7c83f
DP
1765 ("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
1766 ("[Mm]akefile\\'" . makefile-mode)
1767 ("GNUmakefile\\'" . makefile-gmake-mode)
1768 ("Makeppfile\\'" . makefile-makepp-mode)
1769 ("\\.am\\'" . makefile-automake-mode)
5c6d31a4
SM
1770 ;; Less common extensions come here
1771 ;; so more common ones above are found faster.
ffc0e1ca
AS
1772 ("\\.texinfo\\'" . texinfo-mode)
1773 ("\\.te?xi\\'" . texinfo-mode)
bbc67516 1774 ("\\.[sS]\\'" . asm-mode)
ffc0e1ca 1775 ("\\.asm\\'" . asm-mode)
bbc67516
DP
1776 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
1777 ("[cC]hange[lL]og\\.[0-9]+\\'" . change-log-mode)
ffc0e1ca
AS
1778 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1779 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1780 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
b921b596 1781 ("\\.bash\\'" . sh-mode)
ffc0e1ca
AS
1782 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1783 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1784 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
d5798fa7 1785 ("\\.m?spec\\'" . sh-mode)
bbc67516 1786 ("\\.m[mes]\\'" . nroff-mode)
ffc0e1ca 1787 ("\\.man\\'" . nroff-mode)
ffc0e1ca 1788 ("\\.sty\\'" . latex-mode)
bbc67516 1789 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
ffc0e1ca
AS
1790 ("\\.bbl\\'" . latex-mode)
1791 ("\\.bib\\'" . bibtex-mode)
1792 ("\\.sql\\'" . sql-mode)
bbc67516 1793 ("\\.m[4c]\\'" . m4-mode)
9e6f5419
DP
1794 ("\\.mf\\'" . metafont-mode)
1795 ("\\.mp\\'" . metapost-mode)
ffc0e1ca
AS
1796 ("\\.vhdl?\\'" . vhdl-mode)
1797 ("\\.article\\'" . text-mode)
1798 ("\\.letter\\'" . text-mode)
bbc67516 1799 ("\\.i?tcl\\'" . tcl-mode)
ffc0e1ca 1800 ("\\.exp\\'" . tcl-mode)
ffc0e1ca
AS
1801 ("\\.itk\\'" . tcl-mode)
1802 ("\\.icn\\'" . icon-mode)
1803 ("\\.sim\\'" . simula-mode)
1804 ("\\.mss\\'" . scribe-mode)
bbc67516 1805 ("\\.f9[05]\\'" . f90-mode)
8f9495e7 1806 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
ffc0e1ca 1807 ("\\.pro\\'" . idlwave-mode)
ffc0e1ca
AS
1808 ("\\.prolog\\'" . prolog-mode)
1809 ("\\.tar\\'" . tar-mode)
0ee6e7b7
JL
1810 ;; The list of archive file extensions should be in sync with
1811 ;; `auto-coding-alist' with `no-conversion' coding system.
e084f8c3
EZ
1812 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|[jew]ar\\|xpi\\)\\'" . archive-mode)
1813 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|[JEW]AR\\|XPI\\)\\'" . archive-mode)
c25773c4 1814 ("\\.sx[dmicw]\\'" . archive-mode) ; OpenOffice.org
ffc0e1ca
AS
1815 ;; Mailer puts message to be edited in
1816 ;; /tmp/Re.... or Message
1817 ("\\`/tmp/Re" . text-mode)
1818 ("/Message[0-9]*\\'" . text-mode)
1819 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1820 ("\\.zone\\'" . zone-mode)
1821 ;; some news reader is reported to use this
1822 ("\\`/tmp/fol/" . text-mode)
ffc0e1ca
AS
1823 ("\\.oak\\'" . scheme-mode)
1824 ("\\.sgml?\\'" . sgml-mode)
bbc67516 1825 ("\\.x[ms]l\\'" . xml-mode)
ffc0e1ca
AS
1826 ("\\.dtd\\'" . sgml-mode)
1827 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
bbc67516
DP
1828 ("\\.js\\'" . java-mode) ; javascript-mode would be better
1829 ("\\.x[bp]m\\'" . c-mode)
709d45e1
KG
1830 ;; .emacs or .gnus or .viper following a directory delimiter in
1831 ;; Unix, MSDOG or VMS syntax.
1832 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
ffc0e1ca
AS
1833 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1834 ;; _emacs following a directory delimiter
1835 ;; in MsDos syntax
1836 ("[:/]_emacs\\'" . emacs-lisp-mode)
1837 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1838 ("\\.ml\\'" . lisp-mode)
d5798fa7
SM
1839 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1840 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
ffc0e1ca 1841 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
e854cc22 1842 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
d5798fa7 1843 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
e55c4863 1844 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
ffc0e1ca
AS
1845 ("BROWSE\\'" . ebrowse-tree-mode)
1846 ("\\.ebrowse\\'" . ebrowse-tree-mode)
9ee45b2c 1847 ("#\\*mail\\*" . mail-mode)
80174d35
DP
1848 ("\\.g\\'" . antlr-mode)
1849 ("\\.ses\\'" . ses-mode)
1850 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
1851 ("\\.docbook\\'" . sgml-mode)
00daa381 1852 ("\\.com\\'" . dcl-mode)
80174d35
DP
1853 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
1854 ;; Windows candidates may be opened case sensitively on Unix
1855 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
1856 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
08adf84e 1857 ("\\.ppd\\'" . conf-ppd-mode)
80174d35
DP
1858 ("java.+\\.conf\\'" . conf-javaprop-mode)
1859 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
1860 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1861 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode)
a35d9075
AS
1862 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1863 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
80174d35
DP
1864 ;; either user's dot-files or under /etc or some such
1865 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
1866 ;; alas not all ~/.*rc files are like this
b14f1885 1867 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
80174d35
DP
1868 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
1869 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
1870 ("/X11.+app-defaults/" . conf-xdefaults-mode)
1871 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
1872 ;; this contains everything twice, with space and with colon :-(
1873 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
9ee45b2c
SM
1874 ;; Get rid of any trailing .n.m and try again.
1875 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
5c6d31a4
SM
1876 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1877 ;; Using mode nil rather than `ignore' would let the search continue
1878 ;; through this list (with the shortened name) rather than start over.
bbc67516 1879 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
5c6d31a4
SM
1880 ;; The following should come after the ChangeLog pattern
1881 ;; for the sake of ChangeLog.1, etc.
1882 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
e043664a 1883 ("\\.[1-9]\\'" . nroff-mode)
80174d35 1884 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
ffc0e1ca 1885 "Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
1886Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1887\(NON-NIL stands for anything that is not nil; the value does not matter.)
1888Visiting a file whose name matches REGEXP specifies FUNCTION as the
1889mode function to use. FUNCTION will be called, unless it is nil.
1890
1891If the element has the form (REGEXP FUNCTION NON-NIL), then after
1892calling FUNCTION (if it's not nil), we delete the suffix that matched
969be033 1893REGEXP and search the list again for another match.
7b3f3dc2 1894
969be033
RS
1895If the file name matches `inhibit-first-line-modes-regexps',
1896then `auto-mode-alist' is not processed.
1897
1898See also `interpreter-mode-alist', which detects executable script modes
1899based on the interpreters they specify to run,
1900and `magic-mode-alist', which determines modes based on file contents.")
e13322a0 1901
d7fa5aa2 1902(defvar interpreter-mode-alist
f209c999
MS
1903 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1904 ;; and pike-mode) are added through autoload directives in that
1905 ;; file. That way is discouraged since it spreads out the
1906 ;; definition of the initial value.
ffc0e1ca
AS
1907 (mapc
1908 (lambda (l)
1909 (cons (purecopy (car l)) (cdr l)))
1910 '(("perl" . perl-mode)
1911 ("perl5" . perl-mode)
1912 ("miniperl" . perl-mode)
1913 ("wish" . tcl-mode)
1914 ("wishx" . tcl-mode)
1915 ("tcl" . tcl-mode)
1916 ("tclsh" . tcl-mode)
ffc0e1ca
AS
1917 ("scm" . scheme-mode)
1918 ("ash" . sh-mode)
1919 ("bash" . sh-mode)
1920 ("bash2" . sh-mode)
1921 ("csh" . sh-mode)
1922 ("dtksh" . sh-mode)
1923 ("es" . sh-mode)
1924 ("itcsh" . sh-mode)
1925 ("jsh" . sh-mode)
1926 ("ksh" . sh-mode)
1927 ("oash" . sh-mode)
1928 ("pdksh" . sh-mode)
1929 ("rc" . sh-mode)
1930 ("rpm" . sh-mode)
1931 ("sh" . sh-mode)
1932 ("sh5" . sh-mode)
1933 ("tcsh" . sh-mode)
1934 ("wksh" . sh-mode)
1935 ("wsh" . sh-mode)
1936 ("zsh" . sh-mode)
1937 ("tail" . text-mode)
1938 ("more" . text-mode)
1939 ("less" . text-mode)
1940 ("pg" . text-mode)
27a7c83f 1941 ("make" . makefile-gmake-mode) ; Debian uses this
ffc0e1ca
AS
1942 ("guile" . scheme-mode)
1943 ("clisp" . lisp-mode)))
c907d156 1944 "Alist mapping interpreter names to major modes.
969be033 1945This is used for files whose first lines match `auto-mode-interpreter-regexp'.
c907d156 1946Each element looks like (INTERPRETER . MODE).
54005870 1947The car of each element, a regular expression, is compared with
c907d156 1948the name of the interpreter specified in the first line.
969be033
RS
1949If it matches, mode MODE is selected.
1950
1951See also `auto-mode-alist'.")
c907d156 1952
d7fa5aa2 1953(defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
45fb3bb8 1954 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 1955
d7fa5aa2 1956(defvar inhibit-first-line-modes-suffixes nil
b20ff6d0
RS
1957 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1958When checking `inhibit-first-line-modes-regexps', we first discard
1959from the end of the file name anything that matches one of these regexps.")
1960
ffc0e1ca
AS
1961(defvar auto-mode-interpreter-regexp
1962 "#![ \t]?\\([^ \t\n]*\
1963/bin/env[ \t]\\)?\\([^ \t\n]+\\)"
54005870 1964 "Regexp matching interpreters, for file mode determination.
ffc0e1ca 1965This regular expression is matched against the first line of a file
54005870
LT
1966to determine the file's mode in `set-auto-mode'. If it matches, the file
1967is assumed to be interpreted by the interpreter matched by the second group
1968of the regular expression. The mode is then determined as the mode
1969associated with that interpreter in `interpreter-mode-alist'.")
0720b68b 1970
4ac1d37a 1971(defvar magic-mode-alist
32a0479a 1972 `(;; The < comes before the groups (but the first) to reduce backtracking.
4ac1d37a 1973 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
32a0479a
SM
1974 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
1975 (comment-re (concat "\\(?:!--" incomment-re "*-->\\s *<\\)")))
1976 (concat "\\(?:<\\?xml\\s +[^>]*>\\)?\\s *<"
1977 comment-re "*"
1978 "\\(?:!DOCTYPE\\s +[^>]*>\\s *<\\s *" comment-re "*\\)?"
969be033
RS
1979 "[Hh][Tt][Mm][Ll]"))
1980 . html-mode)
4ac1d37a
DP
1981 ;; These two must come after html, because they are more general:
1982 ("<\\?xml " . xml-mode)
811cab86
JL
1983 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
1984 (comment-re (concat "\\(?:!--" incomment-re "*-->\\s *<\\)")))
969be033
RS
1985 (concat "\\s *<" comment-re "*!DOCTYPE "))
1986 . sgml-mode)
80174d35
DP
1987 ("%![^V]" . ps-mode)
1988 ("# xmcd " . conf-unix-mode))
1989 "Alist of buffer beginnings vs. corresponding major mode functions.
44dce0fb
RS
1990Each element looks like (REGEXP . FUNCTION). After visiting a file,
1991if REGEXP matches the text at the beginning of the buffer,
1992`normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
1993to decide the buffer's major mode.
1994
1995If FUNCTION is nil, then it is not called. (That is a way of saying
0fc205c6 1996\"allow `auto-mode-alist' to decide for these files.)")
bbc67516 1997
9e6f5419 1998(defun set-auto-mode (&optional keep-mode-if-same)
b4da00e9 1999 "Select major mode appropriate for current buffer.
4ac1d37a 2000
bbc67516
DP
2001This checks for a -*- mode tag in the buffer's text, checks the
2002interpreter that runs this file against `interpreter-mode-alist',
811cab86
JL
2003compares the buffer beginning against `magic-mode-alist', or
2004compares the filename against the entries in `auto-mode-alist'.
e3998da1
RS
2005
2006It does not check for the `mode:' local variable in the
2007Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 2008
f3e23606 2009If `enable-local-variables' is nil, this function does not check for a
9de9b6a2
RS
2010-*- mode tag.
2011
521cf174
DP
2012If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2013only set the major mode, if that would change it."
b4da00e9 2014 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
811cab86 2015 (let (end done mode modes)
9e6f5419
DP
2016 ;; Find a -*- mode tag
2017 (save-excursion
2018 (goto-char (point-min))
2019 (skip-chars-forward " \t\n")
9e6f5419
DP
2020 (and enable-local-variables
2021 (setq end (set-auto-mode-1))
2022 (if (save-excursion (search-forward ":" end t))
2023 ;; Find all specifications for the `mode:' variable
2024 ;; and execute them left to right.
2025 (while (let ((case-fold-search t))
2026 (or (and (looking-at "mode:")
2027 (goto-char (match-end 0)))
2028 (re-search-forward "[ \t;]mode:" end t)))
2029 (skip-chars-forward " \t")
2030 (let ((beg (point)))
2031 (if (search-forward ";" end t)
2032 (forward-char -1)
2033 (goto-char end))
2034 (skip-chars-backward " \t")
2035 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2036 modes)))
2037 ;; Simple -*-MODE-*- case.
2038 (push (intern (concat (downcase (buffer-substring (point) end))
2039 "-mode"))
2040 modes))))
2041 ;; If we found modes to use, invoke them now, outside the save-excursion.
2042 (if modes
521cf174
DP
2043 (catch 'nop
2044 (dolist (mode (nreverse modes))
2045 (if (not (functionp mode))
2046 (message "Ignoring unknown mode `%s'" mode)
2047 (setq done t)
3467488e 2048 (or (set-auto-mode-0 mode keep-mode-if-same)
df4d0613 2049 ;; continuing would call minor modes again, toggling them off
8a9cdb8d 2050 (throw 'nop nil)))))
9e6f5419
DP
2051 ;; If we didn't, look for an interpreter specified in the first line.
2052 ;; As a special case, allow for things like "#!/bin/env perl", which
2053 ;; finds the interpreter anywhere in $PATH.
2054 (setq mode (save-excursion
2055 (goto-char (point-min))
2056 (if (looking-at auto-mode-interpreter-regexp)
2057 (match-string 2)
2058 ""))
2059 ;; Map interpreter name to a mode, signalling we're done at the
2060 ;; same time.
2061 done (assoc (file-name-nondirectory mode)
df4d0613 2062 interpreter-mode-alist))
811cab86 2063 ;; If we found an interpreter mode to use, invoke it now.
df4d0613
DP
2064 (if done
2065 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
811cab86 2066 ;; If we didn't, match the buffer beginning against magic-mode-alist.
df4d0613 2067 (unless done
4ac1d37a
DP
2068 (if (setq done (save-excursion
2069 (goto-char (point-min))
2070 (assoc-default nil magic-mode-alist
2071 (lambda (re dummy)
2072 (looking-at re)))))
2073 (set-auto-mode-0 done keep-mode-if-same)
811cab86 2074 ;; Compare the filename against the entries in auto-mode-alist.
4ac1d37a
DP
2075 (if buffer-file-name
2076 (let ((name buffer-file-name))
2077 ;; Remove backup-suffixes from file name.
2078 (setq name (file-name-sans-versions name))
2079 (while name
2080 ;; Find first matching alist entry.
2081 (let ((case-fold-search
2082 (memq system-type '(vax-vms windows-nt cygwin))))
2083 (if (and (setq mode (assoc-default name auto-mode-alist
811cab86 2084 'string-match))
4ac1d37a
DP
2085 (consp mode)
2086 (cadr mode))
2087 (setq mode (car mode)
2088 name (substring name 0 (match-beginning 0)))
2089 (setq name)))
2090 (when mode
2091 (set-auto-mode-0 mode keep-mode-if-same)))))))))
521cf174 2092
521cf174
DP
2093;; When `keep-mode-if-same' is set, we are working on behalf of
2094;; set-visited-file-name. In that case, if the major mode specified is the
2095;; same one we already have, don't actually reset it. We don't want to lose
2096;; minor modes such as Font Lock.
3467488e 2097(defun set-auto-mode-0 (mode &optional keep-mode-if-same)
521cf174 2098 "Apply MODE and return it.
3467488e
KS
2099If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2100any aliases and compared to current major mode. If they are the
2101same, do nothing and return nil."
521cf174
DP
2102 (when keep-mode-if-same
2103 (while (symbolp (symbol-function mode))
2104 (setq mode (symbol-function mode)))
2105 (if (eq mode major-mode)
3467488e 2106 (setq mode nil)))
521cf174
DP
2107 (when mode
2108 (funcall mode)
2109 mode))
b4da00e9 2110
e3f9b9c0
RS
2111(defun set-auto-mode-1 ()
2112 "Find the -*- spec in the buffer.
2113Call with point at the place to start searching from.
2114If one is found, set point to the beginning
2115and return the position of the end.
2116Otherwise, return nil; point may be changed."
2117 (let (beg end)
2118 (and
2119 ;; Don't look for -*- if this file name matches any
2120 ;; of the regexps in inhibit-first-line-modes-regexps.
2121 (let ((temp inhibit-first-line-modes-regexps)
2122 (name (if buffer-file-name
2123 (file-name-sans-versions buffer-file-name)
2124 (buffer-name))))
2125 (while (let ((sufs inhibit-first-line-modes-suffixes))
2126 (while (and sufs (not (string-match (car sufs) name)))
2127 (setq sufs (cdr sufs)))
2128 sufs)
2129 (setq name (substring name 0 (match-beginning 0))))
2130 (while (and temp
2131 (not (string-match (car temp) name)))
2132 (setq temp (cdr temp)))
2133 (not temp))
2134
f587e30b
SM
2135 (search-forward "-*-" (line-end-position
2136 ;; If the file begins with "#!"
2137 ;; (exec interpreter magic), look
2138 ;; for mode frobs in the first two
2139 ;; lines. You cannot necessarily
2140 ;; put them in the first line of
2141 ;; such a file without screwing up
2142 ;; the interpreter invocation.
2143 (and (looking-at "^#!") 2)) t)
e3f9b9c0
RS
2144 (progn
2145 (skip-chars-forward " \t")
2146 (setq beg (point))
f587e30b 2147 (search-forward "-*-" (line-end-position) t))
e3f9b9c0
RS
2148 (progn
2149 (forward-char -3)
2150 (skip-chars-backward " \t")
2151 (setq end (point))
2152 (goto-char beg)
2153 end))))
2154
56b19636 2155(defun hack-local-variables-confirm (string)
cc45837e
RS
2156 (or (eq enable-local-variables t)
2157 (and enable-local-variables
2158 (save-window-excursion
2159 (condition-case nil
2160 (switch-to-buffer (current-buffer))
2161 (error
2162 ;; If we fail to switch in the selected window,
2163 ;; it is probably a minibuffer or dedicated window.
2164 ;; So try another window.
2165 (let ((pop-up-frames nil))
2166 ;; Refrain from popping up frames since it can't
2167 ;; be undone by save-window-excursion.
2168 (pop-to-buffer (current-buffer)))))
2169 (save-excursion
2170 (beginning-of-line)
2171 (set-window-start (selected-window) (point)))
56b19636
LT
2172 (y-or-n-p (format string
2173 (if buffer-file-name
2174 (file-name-nondirectory buffer-file-name)
2175 (concat "buffer " (buffer-name)))))))))
cc45837e 2176
a0e74e72 2177(defun hack-local-variables-prop-line (&optional mode-only)
ffc0e1ca
AS
2178 "Set local variables specified in the -*- line.
2179Ignore any specification for `mode:' and `coding:';
2180`set-auto-mode' should already have handled `mode:',
a0e74e72
RS
2181`set-auto-coding' should already have handled `coding:'.
2182If MODE-ONLY is non-nil, all we do is check whether the major mode
2183is specified, returning t if it is specified."
f3e23606
RS
2184 (save-excursion
2185 (goto-char (point-min))
13a66180 2186 (let ((result nil)
e3f9b9c0 2187 (end (set-auto-mode-1))
a0e74e72 2188 mode-specified
aa5fcebf
KH
2189 (enable-local-variables
2190 (and local-enable-local-variables enable-local-variables)))
a0e74e72
RS
2191 ;; Parse the -*- line into the RESULT alist.
2192 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
e3f9b9c0 2193 (cond ((not end)
f3e23606
RS
2194 nil)
2195 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180 2196 ;; Simple form: "-*- MODENAME -*-". Already handled.
a0e74e72 2197 (setq mode-specified t)
13a66180 2198 nil)
f3e23606
RS
2199 (t
2200 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2201 ;; (last ";" is optional).
f3e23606
RS
2202 (while (< (point) end)
2203 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
ffc0e1ca 2204 (error "Malformed -*- line"))
f3e23606 2205 (goto-char (match-end 0))
1c26a6f3
KH
2206 ;; There used to be a downcase here,
2207 ;; but the manual didn't say so,
2208 ;; and people want to set var names that aren't all lc.
2209 (let ((key (intern (buffer-substring
2210 (match-beginning 1)
2211 (match-end 1))))
f3e23606
RS
2212 (val (save-restriction
2213 (narrow-to-region (point) end)
2214 (read (current-buffer)))))
93a2702d
RS
2215 ;; It is traditional to ignore
2216 ;; case when checking for `mode' in set-auto-mode,
2217 ;; so we must do that here as well.
2218 ;; That is inconsistent, but we're stuck with it.
3fa0a9aa 2219 ;; The same can be said for `coding' in set-auto-coding.
93a2702d 2220 (or (equal (downcase (symbol-name key)) "mode")
3fa0a9aa 2221 (equal (downcase (symbol-name key)) "coding")
13a66180 2222 (setq result (cons (cons key val) result)))
a0e74e72
RS
2223 (if (equal (downcase (symbol-name key)) "mode")
2224 (setq mode-specified t))
f3e23606
RS
2225 (skip-chars-forward " \t;")))
2226 (setq result (nreverse result))))
76d5492b 2227
a0e74e72
RS
2228 (if mode-only mode-specified
2229 (if (and result
2230 (or mode-only
56b19636
LT
2231 (hack-local-variables-confirm
2232 "Set local variables as specified in -*- line of %s? ")))
a0e74e72
RS
2233 (let ((enable-local-eval enable-local-eval))
2234 (while result
2235 (hack-one-local-variable (car (car result)) (cdr (car result)))
2236 (setq result (cdr result)))))
2237 nil))))
f3e23606 2238
1d517019
RS
2239(defvar hack-local-variables-hook nil
2240 "Normal hook run after processing a file's local variables specs.
2241Major modes can use this to examine user-specified local variables
2242in order to initialize other data structure based on them.")
2243
9de9b6a2
RS
2244(defun hack-local-variables (&optional mode-only)
2245 "Parse and put into effect this buffer's local variables spec.
2246If MODE-ONLY is non-nil, all we do is check whether the major mode
2247is specified, returning t if it is specified."
a0e74e72
RS
2248 (let ((mode-specified
2249 ;; If MODE-ONLY is t, we check here for specifying the mode
2250 ;; in the -*- line. If MODE-ONLY is nil, we process
2251 ;; the -*- line here.
2252 (hack-local-variables-prop-line mode-only))
aa5fcebf
KH
2253 (enable-local-variables
2254 (and local-enable-local-variables enable-local-variables)))
a0e74e72 2255 ;; Look for "Local variables:" line in last page.
9de9b6a2
RS
2256 (save-excursion
2257 (goto-char (point-max))
2258 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
50292b6e
SM
2259 (when (let ((case-fold-search t))
2260 (and (search-forward "Local Variables:" nil t)
cc45837e 2261 (or mode-only
56b19636
LT
2262 (hack-local-variables-confirm
2263 "Set local variables as specified at end of %s? "))))
50292b6e
SM
2264 (skip-chars-forward " \t")
2265 (let ((enable-local-eval enable-local-eval)
2266 ;; suffix is what comes after "local variables:" in its line.
2267 (suffix
2268 (concat
2269 (regexp-quote (buffer-substring (point) (line-end-position)))
2270 "$"))
2271 ;; prefix is what comes before "local variables:" in its line.
2272 (prefix
2273 (concat "^" (regexp-quote
2274 (buffer-substring (line-beginning-position)
2275 (match-beginning 0)))))
2276 beg)
2277
2278 (forward-line 1)
2279 (let ((startpos (point))
2280 endpos
2281 (thisbuf (current-buffer)))
2282 (save-excursion
5a146628
DP
2283 (unless (let ((case-fold-search t))
2284 (re-search-forward
2285 (concat prefix "[ \t]*End:[ \t]*" suffix)
2286 nil t))
2287 (error "Local variables list is not properly terminated"))
50292b6e
SM
2288 (beginning-of-line)
2289 (setq endpos (point)))
2290
2291 (with-temp-buffer
2292 (insert-buffer-substring thisbuf startpos endpos)
2293 (goto-char (point-min))
2294 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2295 (while (not (eobp))
2296 ;; Discard the prefix.
2297 (if (looking-at prefix)
2298 (delete-region (point) (match-end 0))
2299 (error "Local variables entry is missing the prefix"))
2300 (end-of-line)
2301 ;; Discard the suffix.
2302 (if (looking-back suffix)
2303 (delete-region (match-beginning 0) (point))
2304 (error "Local variables entry is missing the suffix"))
2305 (forward-line 1))
2306 (goto-char (point-min))
2307
2308 (while (not (eobp))
2309 ;; Find the variable name; strip whitespace.
2310 (skip-chars-forward " \t")
2311 (setq beg (point))
2312 (skip-chars-forward "^:\n")
2313 (if (eolp) (error "Missing colon in local variables entry"))
2314 (skip-chars-backward " \t")
2315 (let* ((str (buffer-substring beg (point)))
2316 (var (read str))
2317 val)
2318 ;; Read the variable value.
2319 (skip-chars-forward "^:")
2320 (forward-char 1)
2321 (setq val (read (current-buffer)))
2322 (if mode-only
2323 (if (eq var 'mode)
2324 (setq mode-specified t))
2325 ;; Set the variable. "Variables" mode and eval are funny.
2326 (with-current-buffer thisbuf
2327 (hack-one-local-variable var val))))
2328 (forward-line 1)))))))
9de9b6a2
RS
2329 (unless mode-only
2330 (run-hooks 'hack-local-variables-hook))
2331 mode-specified))
f3e23606 2332
e0b2a2d9 2333(defvar ignored-local-variables ()
f3e23606
RS
2334 "Variables to be ignored in a file's local variable spec.")
2335
be0218a8 2336;; Get confirmation before setting these variables as locals in a file.
05ef1cda 2337(put 'debugger 'risky-local-variable t)
f6fa3ee3 2338(put 'enable-local-eval 'risky-local-variable t)
fce47eea 2339(put 'ignored-local-variables 'risky-local-variable t)
be0218a8
RS
2340(put 'eval 'risky-local-variable t)
2341(put 'file-name-handler-alist 'risky-local-variable t)
7ed9159a 2342(put 'inhibit-quit 'risky-local-variable t)
7078d9d2 2343(put 'minor-mode-alist 'risky-local-variable t)
be0218a8 2344(put 'minor-mode-map-alist 'risky-local-variable t)
7078d9d2
RS
2345(put 'minor-mode-overriding-map-alist 'risky-local-variable t)
2346(put 'overriding-local-map 'risky-local-variable t)
2347(put 'overriding-terminal-local-map 'risky-local-variable t)
2348(put 'auto-mode-alist 'risky-local-variable t)
be0218a8 2349(put 'after-load-alist 'risky-local-variable t)
f6fa3ee3 2350(put 'buffer-file-name 'risky-local-variable t)
7078d9d2 2351(put 'buffer-undo-list 'risky-local-variable t)
f6fa3ee3
RS
2352(put 'buffer-auto-save-file-name 'risky-local-variable t)
2353(put 'buffer-file-truename 'risky-local-variable t)
7078d9d2 2354(put 'default-text-properties 'risky-local-variable t)
b0ffcc0d
RS
2355(put 'exec-path 'risky-local-variable t)
2356(put 'load-path 'risky-local-variable t)
2357(put 'exec-directory 'risky-local-variable t)
2358(put 'process-environment 'risky-local-variable t)
eba1c87a
RS
2359(put 'dabbrev-case-fold-search 'risky-local-variable t)
2360(put 'dabbrev-case-replace 'risky-local-variable t)
9afa8bf7
RS
2361;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2362(put 'outline-level 'risky-local-variable t)
d98b741d 2363(put 'rmail-output-file-alist 'risky-local-variable t)
f4d04672 2364(put 'font-lock-defaults 'risky-local-variable t)
7078d9d2
RS
2365(put 'special-display-buffer-names 'risky-local-variable t)
2366(put 'frame-title-format 'risky-local-variable t)
2367(put 'global-mode-string 'risky-local-variable t)
2368(put 'header-line-format 'risky-local-variable t)
2369(put 'icon-title-format 'risky-local-variable t)
2370(put 'input-method-alist 'risky-local-variable t)
032388f3 2371(put 'format-alist 'risky-local-variable t)
7078d9d2
RS
2372(put 'vc-mode 'risky-local-variable t)
2373(put 'imenu-generic-expression 'risky-local-variable t)
cfdd394e 2374(put 'imenu--index-alist 'risky-local-variable t)
7078d9d2
RS
2375(put 'standard-input 'risky-local-variable t)
2376(put 'standard-output 'risky-local-variable t)
2377(put 'unread-command-events 'risky-local-variable t)
2378(put 'max-lisp-eval-depth 'risky-local-variable t)
2379(put 'max-specpdl-size 'risky-local-variable t)
ec4ba9e3
RS
2380(put 'mode-line-format 'risky-local-variable t)
2381(put 'mode-line-modified 'risky-local-variable t)
2382(put 'mode-line-mule-info 'risky-local-variable t)
2383(put 'mode-line-buffer-identification 'risky-local-variable t)
2384(put 'mode-line-modes 'risky-local-variable t)
2385(put 'mode-line-position 'risky-local-variable t)
b459083c 2386(put 'mode-line-process 'risky-local-variable t)
fbafc3bd 2387(put 'mode-name 'risky-local-variable t)
2bbbe4f6 2388(put 'display-time-string 'risky-local-variable t)
fecddd0d 2389(put 'parse-time-rules 'risky-local-variable t)
f6fa3ee3 2390
472514b7
RS
2391;; This case is safe because the user gets to check it before it is used.
2392(put 'compile-command 'safe-local-variable 'stringp)
2393
40ebe9bd 2394(defun risky-local-variable-p (sym &optional val)
0d8781d8 2395 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
40ebe9bd
LT
2396If VAL is nil or omitted, the question is whether any value might be
2397dangerous."
472514b7 2398 (let ((safep (get sym 'safe-local-variable)))
e0b2a2d9 2399 (or (get sym 'risky-local-variable)
472514b7
RS
2400 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2401 (symbol-name sym))
2402 (not safep))
2403 ;; If the safe-local-variable property isn't t or nil,
2404 ;; then it must return non-nil on the proposed value to be safe.
2405 (and (not (memq safep '(t nil)))
0d8781d8
RS
2406 (or (null val)
2407 (not (funcall safep val)))))))
7ed9159a 2408
8fd9c174
RS
2409(defcustom safe-local-eval-forms nil
2410 "*Expressions that are considered \"safe\" in an `eval:' local variable.
2411Add expressions to this list if you want Emacs to evaluate them, when
2412they appear in an `eval' local variable specification, without first
2413asking you for confirmation."
2414 :group 'find-file
bf247b6e 2415 :version "22.1"
8fd9c174
RS
2416 :type '(repeat sexp))
2417
ff7affeb
RS
2418(put 'c-set-style 'safe-local-eval-function t)
2419
d0bd3513
RS
2420(defun hack-one-local-variable-quotep (exp)
2421 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2422
ff7affeb
RS
2423(defun hack-one-local-variable-constantp (exp)
2424 (or (and (not (symbolp exp)) (not (consp exp)))
2425 (memq exp '(t nil))
2426 (keywordp exp)
2427 (hack-one-local-variable-quotep exp)))
2428
2429(defun hack-one-local-variable-eval-safep (exp)
2430 "Return t if it is safe to eval EXP when it is found in a file."
8fd9c174
RS
2431 (or (not (consp exp))
2432 ;; Detect certain `put' expressions.
2433 (and (eq (car exp) 'put)
2434 (hack-one-local-variable-quotep (nth 1 exp))
2435 (hack-one-local-variable-quotep (nth 2 exp))
2436 (memq (nth 1 (nth 2 exp))
2437 '(lisp-indent-hook))
2438 ;; Only allow safe values of lisp-indent-hook;
2439 ;; not functions.
2440 (or (numberp (nth 3 exp))
2441 (equal (nth 3 exp) ''defun)))
2442 ;; Allow expressions that the user requested.
2443 (member exp safe-local-eval-forms)
2444 ;; Certain functions can be allowed with safe arguments
2445 ;; or can specify verification functions to try.
2446 (and (symbolp (car exp))
2447 (let ((prop (get (car exp) 'safe-local-eval-function)))
2448 (cond ((eq prop t)
2449 (let ((ok t))
2450 (dolist (arg (cdr exp))
2451 (unless (hack-one-local-variable-constantp arg)
2452 (setq ok nil)))
2453 ok))
2454 ((functionp prop)
2455 (funcall prop exp))
2456 ((listp prop)
2457 (let ((ok nil))
2458 (dolist (function prop)
2459 (if (funcall function exp)
2460 (setq ok t)))
2461 ok)))))))
ff7affeb 2462
f3e23606 2463(defun hack-one-local-variable (var val)
ffc0e1ca 2464 "\"Set\" one variable in a local variables spec.
7078d9d2
RS
2465A few patterns are specified so that any name which matches one
2466is considered risky."
f3e23606
RS
2467 (cond ((eq var 'mode)
2468 (funcall (intern (concat (downcase (symbol-name val))
2469 "-mode"))))
3fa0a9aa
KH
2470 ((eq var 'coding)
2471 ;; We have already handled coding: tag in set-auto-coding.
2472 nil)
e0b2a2d9
RS
2473 ((memq var ignored-local-variables)
2474 nil)
f3e23606 2475 ;; "Setting" eval means either eval it or do nothing.
7d3221d7 2476 ;; Likewise for setting hook variables.
472514b7 2477 ((risky-local-variable-p var val)
0225ae5e 2478 ;; Permit evalling a put of a harmless property.
d0bd3513
RS
2479 ;; if the args do nothing tricky.
2480 (if (or (and (eq var 'eval)
ff7affeb 2481 (hack-one-local-variable-eval-safep val))
d0bd3513 2482 ;; Permit eval if not root and user says ok.
c7e62660 2483 (and (not (zerop (user-uid)))
56b19636
LT
2484 (hack-local-variables-confirm
2485 "Process `eval' or hook local variables in %s? ")))
7d3221d7
RS
2486 (if (eq var 'eval)
2487 (save-excursion (eval val))
2488 (make-local-variable var)
2489 (set var val))
472514b7 2490 (message "Ignoring risky spec in the local variables list")))
f3e23606
RS
2491 ;; Ordinary variable, really set it.
2492 (t (make-local-variable var)
87a6a5d8
RS
2493 ;; Make sure the string has no text properties.
2494 ;; Some text properties can get evaluated in various ways,
2495 ;; so it is risky to put them on with a local variable list.
2496 (if (stringp val)
2497 (set-text-properties 0 (length val) nil val))
f3e23606
RS
2498 (set var val))))
2499
b4da00e9 2500\f
21540597 2501(defcustom change-major-mode-with-file-name t
9de9b6a2
RS
2502 "*Non-nil means \\[write-file] should set the major mode from the file name.
2503However, the mode will not be changed if
2504\(1) a local variables list or the `-*-' line specifies a major mode, or
2505\(2) the current major mode is a \"special\" mode,
8609911b 2506\ not suitable for ordinary files, or
21540597
RS
2507\(3) the new file name does not particularly specify any mode."
2508 :type 'boolean
2509 :group 'editing-basics)
9de9b6a2 2510
f36012a6 2511(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9
RM
2512 "Change name of file visited in current buffer to FILENAME.
2513The next time the buffer is saved it will go in the newly specified file.
814af837 2514FILENAME nil or an empty string means make buffer not be visiting any file.
b4da00e9 2515Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
2516if you wish to pass an empty string as the argument.
2517
2518The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
2519confirmation in the case where another buffer is already visiting FILENAME.
2520
2521The optional third argument ALONG-WITH-FILE, if non-nil, means that
2522the old visited file has been renamed to the new name FILENAME."
b4da00e9 2523 (interactive "FSet visited file name: ")
c11a94fe
RS
2524 (if (buffer-base-buffer)
2525 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
2526 (let (truename)
2527 (if filename
2528 (setq filename
2529 (if (string-equal filename "")
2530 nil
2531 (expand-file-name filename))))
2532 (if filename
2533 (progn
2534 (setq truename (file-truename filename))
2535 (if find-file-visit-truename
a522e5bf 2536 (setq filename truename))))
11e314fa 2537 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 2538 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 2539 (not no-query)
7b89d38e
RS
2540 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
2541 filename)))
2542 (error "Aborted")))
a522e5bf
RS
2543 (or (equal filename buffer-file-name)
2544 (progn
2545 (and filename (lock-buffer filename))
2546 (unlock-buffer)))
2547 (setq buffer-file-name filename)
2548 (if filename ; make buffer name reflect filename.
2549 (let ((new-name (file-name-nondirectory buffer-file-name)))
2550 (if (string= new-name "")
2551 (error "Empty file name"))
2552 (if (eq system-type 'vax-vms)
2553 (setq new-name (downcase new-name)))
2554 (setq default-directory (file-name-directory buffer-file-name))
67b6fd1c
SM
2555 ;; If new-name == old-name, renaming would add a spurious <2>
2556 ;; and it's considered as a feature in rename-buffer.
a522e5bf
RS
2557 (or (string= new-name (buffer-name))
2558 (rename-buffer new-name t))))
2559 (setq buffer-backed-up nil)
f36012a6
RS
2560 (or along-with-file
2561 (clear-visited-file-modtime))
8ccdc29e 2562 ;; Abbreviate the file names of the buffer.
4826e97f 2563 (if truename
8ccdc29e
RS
2564 (progn
2565 (setq buffer-file-truename (abbreviate-file-name truename))
2566 (if find-file-visit-truename
b1f1ceb8 2567 (setq buffer-file-name truename))))
a522e5bf
RS
2568 (setq buffer-file-number
2569 (if filename
2a47b4f5 2570 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 2571 nil)))
0370fe77 2572 ;; write-file-functions is normally used for things like ftp-find-file
b4da00e9
RM
2573 ;; that visit things that are not local files as if they were files.
2574 ;; Changing to visit an ordinary local file instead should flush the hook.
0370fe77 2575 (kill-local-variable 'write-file-functions)
c9dca4e0 2576 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
2577 (kill-local-variable 'revert-buffer-function)
2578 (kill-local-variable 'backup-inhibited)
ee81c959
RS
2579 ;; If buffer was read-only because of version control,
2580 ;; that reason is gone now, so make it writable.
2581 (if vc-mode
2582 (setq buffer-read-only nil))
2583 (kill-local-variable 'vc-mode)
b4da00e9
RM
2584 ;; Turn off backup files for certain file names.
2585 ;; Since this is a permanent local, the major mode won't eliminate it.
4d49551a
KH
2586 (and buffer-file-name
2587 (not (funcall backup-enable-predicate buffer-file-name))
b4da00e9
RM
2588 (progn
2589 (make-local-variable 'backup-inhibited)
2590 (setq backup-inhibited t)))
c77a81cf
RS
2591 (let ((oauto buffer-auto-save-file-name))
2592 ;; If auto-save was not already on, turn it on if appropriate.
2593 (if (not buffer-auto-save-file-name)
2594 (and buffer-file-name auto-save-default
2595 (auto-save-mode t))
2596 ;; If auto save is on, start using a new name.
2597 ;; We deliberately don't rename or delete the old auto save
2598 ;; for the old visited file name. This is because perhaps
2599 ;; the user wants to save the new state and then compare with the
2600 ;; previous state from the auto save file.
2601 (setq buffer-auto-save-file-name
2602 (make-auto-save-file-name)))
2603 ;; Rename the old auto save file if any.
2604 (and oauto buffer-auto-save-file-name
e6f0e76c 2605 (file-exists-p oauto)
c77a81cf 2606 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
2607 (and buffer-file-name
2608 (not along-with-file)
9de9b6a2
RS
2609 (set-buffer-modified-p t))
2610 ;; Update the major mode, if the file name determines it.
2611 (condition-case nil
2612 ;; Don't change the mode if it is special.
2613 (or (not change-major-mode-with-file-name)
2614 (get major-mode 'mode-class)
2615 ;; Don't change the mode if the local variable list specifies it.
2616 (hack-local-variables t)
2617 (set-auto-mode t))
2618 (error nil)))
b4da00e9 2619
912192d1 2620(defun write-file (filename &optional confirm)
b4da00e9 2621 "Write current buffer into file FILENAME.
7f99999a 2622This makes the buffer visit that file, and marks it as not modified.
7458cc35 2623
7f99999a
KH
2624If you specify just a directory name as FILENAME, that means to use
2625the default file name but in that directory. You can also yank
074eb6ac 2626the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
7f99999a
KH
2627
2628If the buffer is not already visiting a file, the default file name
2629for the output file is the buffer name.
2630
2631If optional second arg CONFIRM is non-nil, this function
2632asks for confirmation before overwriting an existing file.
912192d1 2633Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
2634;; (interactive "FWrite file: ")
2635 (interactive
2636 (list (if buffer-file-name
2637 (read-file-name "Write file: "
2638 nil nil nil nil)
7f99999a
KH
2639 (read-file-name "Write file: " default-directory
2640 (expand-file-name
2641 (file-name-nondirectory (buffer-name))
2642 default-directory)
2643 nil nil))
912192d1 2644 (not current-prefix-arg)))
b4da00e9 2645 (or (null filename) (string-equal filename "")
41f48cb1
RS
2646 (progn
2647 ;; If arg is just a directory,
7f99999a
KH
2648 ;; use the default file name, but in that directory.
2649 (if (file-directory-p filename)
41f48cb1 2650 (setq filename (concat (file-name-as-directory filename)
7f99999a
KH
2651 (file-name-nondirectory
2652 (or buffer-file-name (buffer-name))))))
c2fb8488
RS
2653 (and confirm
2654 (file-exists-p filename)
2655 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2656 (error "Canceled")))
5f65549e 2657 (set-visited-file-name filename (not confirm))))
b4da00e9 2658 (set-buffer-modified-p t)
6492b55d
KH
2659 ;; Make buffer writable if file is writable.
2660 (and buffer-file-name
2661 (file-writable-p buffer-file-name)
2662 (setq buffer-read-only nil))
912192d1 2663 (save-buffer))
b4da00e9
RM
2664\f
2665(defun backup-buffer ()
2666 "Make a backup of the disk file visited by the current buffer, if appropriate.
2667This is normally done before saving the buffer the first time.
27ab6944
KH
2668
2669A backup may be done by renaming or by copying; see documentation of
2670variable `make-backup-files'. If it's done by renaming, then the file is
f3f9e207
RS
2671no longer accessible under its old name.
2672
2673The value is non-nil after a backup was made by renaming.
2674It has the form (MODES . BACKUPNAME).
2675MODES is the result of `file-modes' on the original
2676file; this means that the caller, after saving the buffer, should change
2677the modes of the new file to agree with the old modes.
2678BACKUPNAME is the backup file name, which is the old file renamed."
b4da00e9
RM
2679 (if (and make-backup-files (not backup-inhibited)
2680 (not buffer-backed-up)
2681 (file-exists-p buffer-file-name)
2682 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2683 '(?- ?l)))
2684 (let ((real-file-name buffer-file-name)
2685 backup-info backupname targets setmodes)
2686 ;; If specified name is a symbolic link, chase it to the target.
2687 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 2688 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
2689 (setq backup-info (find-backup-file-name real-file-name)
2690 backupname (car backup-info)
2691 targets (cdr backup-info))
5c6d31a4
SM
2692 ;; (if (file-directory-p buffer-file-name)
2693 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
2694 (if backup-info
2695 (condition-case ()
2696 (let ((delete-old-versions
2697 ;; If have old versions to maybe delete,
2698 ;; ask the user to confirm now, before doing anything.
2699 ;; But don't actually delete til later.
2700 (and targets
2701 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2702 (or delete-old-versions
2703 (y-or-n-p (format "Delete excess backup versions of %s? "
446c63b0
RS
2704 real-file-name)))))
2705 (modes (file-modes buffer-file-name)))
eb650569
RS
2706 ;; Actually write the back up file.
2707 (condition-case ()
2708 (if (or file-precious-flag
ffc0e1ca 2709 ; (file-symlink-p buffer-file-name)
eb650569 2710 backup-by-copying
446c63b0 2711 ;; Don't rename a suid or sgid file.
7da6bf00 2712 (and modes (< 0 (logand modes #o6000)))
79d2d279 2713 (not (file-writable-p (file-name-directory real-file-name)))
eb650569
RS
2714 (and backup-by-copying-when-linked
2715 (> (file-nlinks real-file-name) 1))
ffc0e1ca
AS
2716 (and (or backup-by-copying-when-mismatch
2717 (integerp backup-by-copying-when-privileged-mismatch))
eb650569 2718 (let ((attr (file-attributes real-file-name)))
ffc0e1ca
AS
2719 (and (or backup-by-copying-when-mismatch
2720 (and (integerp (nth 2 attr))
2721 (integerp backup-by-copying-when-privileged-mismatch)
2722 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2723 (or (nth 9 attr)
2724 (not (file-ownership-preserved-p real-file-name)))))))
446c63b0 2725 (backup-buffer-copy real-file-name backupname modes)
eb650569
RS
2726 ;; rename-file should delete old backup.
2727 (rename-file real-file-name backupname t)
446c63b0 2728 (setq setmodes (cons modes backupname)))
eb650569
RS
2729 (file-error
2730 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
2731 (setq backupname (expand-file-name
2732 (convert-standard-filename
2733 "~/%backup%~")))
2734 (message "Cannot write backup file; backing up in %s"
2735 (file-name-nondirectory backupname))
eb650569 2736 (sleep-for 1)
446c63b0 2737 (backup-buffer-copy real-file-name backupname modes)))
eb650569
RS
2738 (setq buffer-backed-up t)
2739 ;; Now delete the old versions, if desired.
2740 (if delete-old-versions
2741 (while targets
2742 (condition-case ()
2743 (delete-file (car targets))
2744 (file-error nil))
2745 (setq targets (cdr targets))))
2746 setmodes)
2747 (file-error nil))))))
b4da00e9 2748
446c63b0 2749(defun backup-buffer-copy (from-name to-name modes)
44dce0fb
RS
2750 (let ((umask (default-file-modes)))
2751 (unwind-protect
2752 (progn
2753 ;; Create temp files with strict access rights. It's easy to
2754 ;; loosen them later, whereas it's impossible to close the
2755 ;; time-window of loose permissions otherwise.
2756 (set-default-file-modes ?\700)
2757 (while (condition-case ()
2758 (progn
2759 (condition-case nil
2760 (delete-file to-name)
2761 (file-error nil))
689accb8 2762 (copy-file from-name to-name t t 'excl)
44dce0fb
RS
2763 nil)
2764 (file-already-exists t))
689accb8
RS
2765 ;; The file was somehow created by someone else between
2766 ;; `delete-file' and `copy-file', so let's try again.
2767 nil))
44dce0fb
RS
2768 ;; Reset the umask.
2769 (set-default-file-modes umask)))
147fbf70
RS
2770 (and modes
2771 (set-file-modes to-name (logand modes #o1777))))
446c63b0 2772
c3554e95 2773(defun file-name-sans-versions (name &optional keep-backup-version)
ffc0e1ca 2774 "Return file NAME sans backup versions or strings.
b4da00e9 2775This is a separate procedure so your site-init or startup file can
c3554e95
RS
2776redefine it.
2777If the optional argument KEEP-BACKUP-VERSION is non-nil,
2778we do not remove backup version numbers, only true file version numbers."
6eaebaa2 2779 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
2780 (if handler
2781 (funcall handler 'file-name-sans-versions name keep-backup-version)
2782 (substring name 0
2783 (if (eq system-type 'vax-vms)
2784 ;; VMS version number is (a) semicolon, optional
2785 ;; sign, zero or more digits or (b) period, option
2786 ;; sign, zero or more digits, provided this is the
2787 ;; second period encountered outside of the
2788 ;; device/directory part of the file name.
26add1bf
KH
2789 (or (string-match ";[-+]?[0-9]*\\'" name)
2790 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
2791 name)
2792 (match-beginning 1))
2793 (length name))
2794 (if keep-backup-version
2795 (length name)
dbb12f2c 2796 (or (string-match "\\.~[0-9.]+~\\'" name)
c3554e95
RS
2797 (string-match "~\\'" name)
2798 (length name))))))))
b4da00e9 2799
cb0cd911 2800(defun file-ownership-preserved-p (file)
ffc0e1ca 2801 "Return t if deleting FILE and rewriting it would preserve the owner."
cb0cd911
RS
2802 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2803 (if handler
2804 (funcall handler 'file-ownership-preserved-p file)
ec5533be 2805 (let ((attributes (file-attributes file)))
306faa42
RS
2806 ;; Return t if the file doesn't exist, since it's true that no
2807 ;; information would be lost by an (attempted) delete and create.
2808 (or (null attributes)
2809 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 2810
20b5d24c
RS
2811(defun file-name-sans-extension (filename)
2812 "Return FILENAME sans final \"extension\".
2531b0c3
EZ
2813The extension, in a file name, is the part that follows the last `.',
2814except that a leading `.', if any, doesn't count."
20b5d24c
RS
2815 (save-match-data
2816 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2817 directory)
2531b0c3
EZ
2818 (if (and (string-match "\\.[^.]*\\'" file)
2819 (not (eq 0 (match-beginning 0))))
20b5d24c 2820 (if (setq directory (file-name-directory filename))
6ee24f1e
RS
2821 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2822 ;; we don't want to expand it.
2823 (concat directory (substring file 0 (match-beginning 0)))
20b5d24c
RS
2824 (substring file 0 (match-beginning 0)))
2825 filename))))
2826
93a2702d
RS
2827(defun file-name-extension (filename &optional period)
2828 "Return FILENAME's final \"extension\".
2531b0c3
EZ
2829The extension, in a file name, is the part that follows the last `.',
2830except that a leading `.', if any, doesn't count.
93a2702d
RS
2831Return nil for extensionless file names such as `foo'.
2832Return the empty string for file names such as `foo.'.
2833
2834If PERIOD is non-nil, then the returned value includes the period
2835that delimits the extension, and if FILENAME has no extension,
2836the value is \"\"."
2837 (save-match-data
2838 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2531b0c3
EZ
2839 (if (and (string-match "\\.[^.]*\\'" file)
2840 (not (eq 0 (match-beginning 0))))
93a2702d
RS
2841 (substring file (+ (match-beginning 0) (if period 0 1)))
2842 (if period
2843 "")))))
2844
ffc0e1ca
AS
2845(defcustom make-backup-file-name-function nil
2846 "A function to use instead of the default `make-backup-file-name'.
2847A value of nil gives the default `make-backup-file-name' behaviour.
2848
d5798fa7 2849This could be buffer-local to do something special for specific
ffc0e1ca
AS
2850files. If you define it, you may need to change `backup-file-name-p'
2851and `file-name-sans-versions' too.
2852
2853See also `backup-directory-alist'."
2854 :group 'backup
2855 :type '(choice (const :tag "Default" nil)
2856 (function :tag "Your function")))
2857
2858(defcustom backup-directory-alist nil
2859 "Alist of filename patterns and backup directory names.
2860Each element looks like (REGEXP . DIRECTORY). Backups of files with
2861names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2862relative or absolute. If it is absolute, so that all matching files
2863are backed up into the same directory, the file names in this
2864directory will be the full name of the file backed up with all
2865directory separators changed to `!' to prevent clashes. This will not
2866work correctly if your filesystem truncates the resulting name.
2867
2868For the common case of all backups going into one directory, the alist
2869should contain a single element pairing \".\" with the appropriate
2870directory name.
2871
2872If this variable is nil, or it fails to match a filename, the backup
2873is made in the original file's directory.
2874
2875On MS-DOS filesystems without long names this variable is always
2876ignored."
2877 :group 'backup
dca5e71d 2878 :type '(repeat (cons (regexp :tag "Regexp matching filename")
ffc0e1ca
AS
2879 (directory :tag "Backup directory name"))))
2880
388d6ab5
RS
2881(defun normal-backup-enable-predicate (name)
2882 "Default `backup-enable-predicate' function.
0c2f6dda
RS
2883Checks for files in `temporary-file-directory',
2884`small-temporary-file-directory', and /tmp."
388d6ab5
RS
2885 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2886 name 0 nil)))
2887 ;; Directory is under temporary-file-directory.
2888 (and (not (eq comp t))
2889 (< comp (- (length temporary-file-directory)))))
0c2f6dda
RS
2890 (let ((comp (compare-strings "/tmp" 0 nil
2891 name 0 nil)))
2892 ;; Directory is under /tmp.
2893 (and (not (eq comp t))
2894 (< comp (- (length "/tmp")))))
388d6ab5
RS
2895 (if small-temporary-file-directory
2896 (let ((comp (compare-strings small-temporary-file-directory
2897 0 nil
2898 name 0 nil)))
2899 ;; Directory is under small-temporary-file-directory.
2900 (and (not (eq comp t))
2901 (< comp (- (length small-temporary-file-directory)))))))))
2902
b4da00e9
RM
2903(defun make-backup-file-name (file)
2904 "Create the non-numeric backup file name for FILE.
ffc0e1ca
AS
2905Normally this will just be the file's name with `~' appended.
2906Customization hooks are provided as follows.
2907
2908If the variable `make-backup-file-name-function' is non-nil, its value
2909should be a function which will be called with FILE as its argument;
2910the resulting name is used.
2911
2912Otherwise a match for FILE is sought in `backup-directory-alist'; see
2913the documentation of that variable. If the directory for the backup
2914doesn't exist, it is created."
2915 (if make-backup-file-name-function
2916 (funcall make-backup-file-name-function file)
2917 (if (and (eq system-type 'ms-dos)
2918 (not (msdos-long-file-names)))
2919 (let ((fn (file-name-nondirectory file)))
2920 (concat (file-name-directory file)
2921 (or (and (string-match "\\`[^.]+\\'" fn)
2922 (concat (match-string 0 fn) ".~"))
2923 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2924 (concat (match-string 0 fn) "~")))))
2925 (concat (make-backup-file-name-1 file) "~"))))
2926
2927(defun make-backup-file-name-1 (file)
2928 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2929 (let ((alist backup-directory-alist)
818286f4 2930 elt backup-directory)
ffc0e1ca
AS
2931 (while alist
2932 (setq elt (pop alist))
2933 (if (string-match (car elt) file)
2934 (setq backup-directory (cdr elt)
2935 alist nil)))
ee291b46 2936 (if (and backup-directory (not (file-exists-p backup-directory)))
ffc0e1ca
AS
2937 (condition-case nil
2938 (make-directory backup-directory 'parents)
ee291b46
RS
2939 (file-error (setq backup-directory nil))))
2940 (if (null backup-directory)
2941 file
ffc0e1ca
AS
2942 (if (file-name-absolute-p backup-directory)
2943 (progn
c60ee5e7 2944 (when (memq system-type '(windows-nt ms-dos cygwin))
d7b6ca4a
RS
2945 ;; Normalize DOSish file names: downcase the drive
2946 ;; letter, if any, and replace the leading "x:" with
2947 ;; "/drive_x".
ffc0e1ca
AS
2948 (or (file-name-absolute-p file)
2949 (setq file (expand-file-name file))) ; make defaults explicit
2950 ;; Replace any invalid file-name characters (for the
2951 ;; case of backing up remote files).
446c097e 2952 (setq file (expand-file-name (convert-standard-filename file)))
ffc0e1ca 2953 (if (eq (aref file 1) ?:)
d7b6ca4a 2954 (setq file (concat "/"
ffc0e1ca
AS
2955 "drive_"
2956 (char-to-string (downcase (aref file 0)))
d7b6ca4a 2957 (if (eq (aref file 2) ?/)
ffc0e1ca 2958 ""
d7b6ca4a 2959 "/")
ffc0e1ca
AS
2960 (substring file 2)))))
2961 ;; Make the name unique by substituting directory
2962 ;; separators. It may not really be worth bothering about
2963 ;; doubling `!'s in the original name...
2964 (expand-file-name
2965 (subst-char-in-string
d7b6ca4a 2966 ?/ ?!
ffc0e1ca
AS
2967 (replace-regexp-in-string "!" "!!" file))
2968 backup-directory))
2969 (expand-file-name (file-name-nondirectory file)
2970 (file-name-as-directory
2971 (expand-file-name backup-directory
2972 (file-name-directory file))))))))
b4da00e9
RM
2973
2974(defun backup-file-name-p (file)
2975 "Return non-nil if FILE is a backup file name (numeric or not).
2976This is a separate function so you can redefine it for customization.
2977You may need to redefine `file-name-sans-versions' as well."
066327ae 2978 (string-match "~\\'" file))
b4da00e9 2979
e2b30772
RS
2980(defvar backup-extract-version-start)
2981
2d051399 2982;; This is used in various files.
a7aa942a
KH
2983;; The usage of backup-extract-version-start is not very clean,
2984;; but I can't see a good alternative, so as of now I am leaving it alone.
2d051399 2985(defun backup-extract-version (fn)
ffc0e1ca 2986 "Given the name of a numeric backup file, FN, return the backup number.
e2b30772 2987Uses the free variable `backup-extract-version-start', whose value should be
2d051399 2988the index in the name where the version number begins."
e2b30772
RS
2989 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2990 (= (match-beginning 0) backup-extract-version-start))
027a4b6b 2991 (string-to-number (substring fn backup-extract-version-start -1))
2d051399
RS
2992 0))
2993
b4da00e9
RM
2994;; I believe there is no need to alter this behavior for VMS;
2995;; since backup files are not made on VMS, it should not get called.
2996(defun find-backup-file-name (fn)
ffc0e1ca 2997 "Find a file name for a backup file FN, and suggestions for deletions.
b4da00e9 2998Value is a list whose car is the name for the backup file
ffc0e1ca
AS
2999and whose cdr is a list of old versions to consider deleting now.
3000If the value is nil, don't make a backup.
3001Uses `backup-directory-alist' in the same way as does
3002`make-backup-file-name'."
eb650569
RS
3003 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3004 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3005 (if handler
3006 (funcall handler 'find-backup-file-name fn)
f26d858e
EZ
3007 (if (or (eq version-control 'never)
3008 ;; We don't support numbered backups on plain MS-DOS
3009 ;; when long file names are unavailable.
3010 (and (eq system-type 'ms-dos)
3011 (not (msdos-long-file-names))))
b4da00e9 3012 (list (make-backup-file-name fn))
ffc0e1ca
AS
3013 (let* ((basic-name (make-backup-file-name-1 fn))
3014 (base-versions (concat (file-name-nondirectory basic-name)
3015 ".~"))
e2b30772 3016 (backup-extract-version-start (length base-versions))
eb650569 3017 (high-water-mark 0)
ffc0e1ca
AS
3018 (number-to-delete 0)
3019 possibilities deserve-versions-p versions)
eb650569
RS
3020 (condition-case ()
3021 (setq possibilities (file-name-all-completions
3022 base-versions
ffc0e1ca
AS
3023 (file-name-directory basic-name))
3024 versions (sort (mapcar #'backup-extract-version
3025 possibilities)
3026 #'<)
eb650569
RS
3027 high-water-mark (apply 'max 0 versions)
3028 deserve-versions-p (or version-control
3029 (> high-water-mark 0))
3030 number-to-delete (- (length versions)
ffc0e1ca
AS
3031 kept-old-versions
3032 kept-new-versions
3033 -1))
3034 (file-error (setq possibilities nil)))
eb650569 3035 (if (not deserve-versions-p)
8767d866 3036 (list (make-backup-file-name fn))
ffc0e1ca 3037 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
eb650569
RS
3038 (if (and (> number-to-delete 0)
3039 ;; Delete nothing if there is overflow
3040 ;; in the number of versions to keep.
3041 (>= (+ kept-new-versions kept-old-versions -1) 0))
ffc0e1ca
AS
3042 (mapcar (lambda (n)
3043 (format "%s.~%d~" basic-name n))
eb650569
RS
3044 (let ((v (nthcdr kept-old-versions versions)))
3045 (rplacd (nthcdr (1- number-to-delete) v) ())
3046 v))))))))))
b4da00e9 3047
b4da00e9
RM
3048(defun file-nlinks (filename)
3049 "Return number of names file FILENAME has."
3050 (car (cdr (file-attributes filename))))
6c636af9 3051
753ad988
KG
3052;; (defun file-relative-name (filename &optional directory)
3053;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3054;; This function returns a relative file name which is equivalent to FILENAME
3055;; when used with that default directory as the default.
3056;; If this is impossible (which can happen on MSDOS and Windows
3057;; when the file name and directory use different drive names)
3058;; then it returns FILENAME."
3059;; (save-match-data
3060;; (let ((fname (expand-file-name filename)))
3061;; (setq directory (file-name-as-directory
3062;; (expand-file-name (or directory default-directory))))
3063;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3064;; ;; drive names, they can't be relative, so return the absolute name.
3065;; (if (and (or (eq system-type 'ms-dos)
3066;; (eq system-type 'cygwin)
3067;; (eq system-type 'windows-nt))
3068;; (not (string-equal (substring fname 0 2)
3069;; (substring directory 0 2))))
3070;; filename
3071;; (let ((ancestor ".")
3072;; (fname-dir (file-name-as-directory fname)))
3073;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3074;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3075;; (setq directory (file-name-directory (substring directory 0 -1))
3076;; ancestor (if (equal ancestor ".")
3077;; ".."
3078;; (concat "../" ancestor))))
3079;; ;; Now ancestor is empty, or .., or ../.., etc.
3080;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3081;; ;; We matched within FNAME's directory part.
3082;; ;; Add the rest of FNAME onto ANCESTOR.
3083;; (let ((rest (substring fname (match-end 0))))
3084;; (if (and (equal ancestor ".")
3085;; (not (equal rest "")))
3086;; ;; But don't bother with ANCESTOR if it would give us `./'.
3087;; rest
3088;; (concat (file-name-as-directory ancestor) rest)))
3089;; ;; We matched FNAME's directory equivalent.
3090;; ancestor))))))
3091
6c636af9 3092(defun file-relative-name (filename &optional directory)
ffc0e1ca 3093 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2d6562a5
RS
3094This function returns a relative file name which is equivalent to FILENAME
3095when used with that default directory as the default.
753ad988 3096If FILENAME and DIRECTORY lie on different machines or on different drives
493c98af 3097on a DOS/Windows machine, it returns FILENAME on expanded form."
96c188b0 3098 (save-match-data
753ad988
KG
3099 (setq directory
3100 (file-name-as-directory (expand-file-name (or directory
3101 default-directory))))
3102 (setq filename (expand-file-name filename))
3f788773
KG
3103 (let ((fremote (file-remote-p filename))
3104 (dremote (file-remote-p directory)))
493c98af
KG
3105 (if ;; Conditions for separate trees
3106 (or
3107 ;; Test for different drives on DOS/Windows
3108 (and
7c64272b 3109 ;; Should `cygwin' really be included here? --stef
493c98af 3110 (memq system-type '(ms-dos cygwin windows-nt))
7c64272b 3111 (not (eq t (compare-strings filename 0 2 directory 0 2))))
493c98af 3112 ;; Test for different remote file system identification
3f788773 3113 (not (equal fremote dremote)))
e2b30772 3114 filename
753ad988
KG
3115 (let ((ancestor ".")
3116 (filename-dir (file-name-as-directory filename)))
7c64272b
SM
3117 (while (not
3118 (or
3119 (eq t (compare-strings filename-dir nil (length directory)
3120 directory nil nil case-fold-search))
3121 (eq t (compare-strings filename nil (length directory)
3122 directory nil nil case-fold-search))))
753ad988 3123 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
3124 ancestor (if (equal ancestor ".")
3125 ".."
3126 (concat "../" ancestor))))
753ad988 3127 ;; Now ancestor is empty, or .., or ../.., etc.
7c64272b
SM
3128 (if (eq t (compare-strings filename nil (length directory)
3129 directory nil nil case-fold-search))
753ad988
KG
3130 ;; We matched within FILENAME's directory part.
3131 ;; Add the rest of FILENAME onto ANCESTOR.
3f7d6528 3132 (let ((rest (substring filename (length directory))))
753ad988 3133 (if (and (equal ancestor ".") (not (equal rest "")))
9695aac6
RS
3134 ;; But don't bother with ANCESTOR if it would give us `./'.
3135 rest
3136 (concat (file-name-as-directory ancestor) rest)))
753ad988
KG
3137 ;; We matched FILENAME's directory equivalent.
3138 ancestor))))))
b4da00e9
RM
3139\f
3140(defun save-buffer (&optional args)
9dce96b5 3141 "Save current buffer in visited file if modified. Variations are described below.
b4da00e9
RM
3142By default, makes the previous version into a backup file
3143 if previously requested or if this is the first save.
dc2ab26e 3144Prefixed with one \\[universal-argument], marks this version
b4da00e9 3145 to become a backup when the next save is done.
dc2ab26e 3146Prefixed with two \\[universal-argument]'s,
b4da00e9 3147 unconditionally makes the previous version into a backup file.
dc2ab26e 3148Prefixed with three \\[universal-argument]'s, marks this version
ac9650be
RS
3149 to become a backup when the next save is done,
3150 and unconditionally makes the previous version into a backup file.
3151
dc2ab26e
EZ
3152With a numeric argument of 0, never make the previous version
3153into a backup file.
b4da00e9
RM
3154
3155If a file's name is FOO, the names of its numbered backup versions are
3156 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3157Numeric backups (rather than FOO~) will be made if value of
3158 `version-control' is not the atom `never' and either there are already
3159 numeric versions of the file being backed up, or `version-control' is
3160 non-nil.
3161We don't want excessive versions piling up, so there are variables
3162 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3163 and `kept-new-versions', which tells how many newest versions to keep.
3164 Defaults are 2 old versions and 2 new.
3165`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 3166If `delete-old-versions' is nil, system will query user
e73ec04b
RS
3167 before trimming versions. Otherwise it does it silently.
3168
749d2ee6
RS
3169If `vc-make-backup-files' is nil, which is the default,
3170 no backup files are made for files managed by version control.
3171 (This is because the version control system itself records previous versions.)
3172
e73ec04b 3173See the subroutine `basic-save-buffer' for more information."
b4da00e9
RM
3174 (interactive "p")
3175 (let ((modp (buffer-modified-p))
3176 (large (> (buffer-size) 50000))
b5a8e0fc
RS
3177 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3178 (memq args '(16 64)))))
b4da00e9 3179 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
b4990dde
GM
3180 (if (and modp large (buffer-file-name))
3181 (message "Saving file %s..." (buffer-file-name)))
b4da00e9
RM
3182 (basic-save-buffer)
3183 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3184
3185(defun delete-auto-save-file-if-necessary (&optional force)
3186 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3187Normally delete only if the file was written by this Emacs since
3188the last real save, but optional arg FORCE non-nil means delete anyway."
3189 (and buffer-auto-save-file-name delete-auto-save-files
3190 (not (string= buffer-file-name buffer-auto-save-file-name))
3191 (or force (recent-auto-save-p))
3192 (progn
3193 (condition-case ()
3194 (delete-file buffer-auto-save-file-name)
3195 (file-error nil))
3196 (set-buffer-auto-saved))))
3197
481f215b
KH
3198(defvar auto-save-hook nil
3199 "Normal hook run just before auto-saving.")
3200
3c3b81d1
SJ
3201(defcustom before-save-hook nil
3202 "Normal hook that is run before a buffer is saved to its file."
25f6295e 3203 :options '(copyright-update time-stamp)
3c3b81d1
SJ
3204 :type 'hook
3205 :group 'files)
3206
ffc0e1ca
AS
3207(defcustom after-save-hook nil
3208 "Normal hook that is run after a buffer is saved to its file."
3209 :options '(executable-make-buffer-file-executable-if-script-p)
3210 :type 'hook
3211 :group 'files)
1cc852cc 3212
0516edee
RS
3213(defvar save-buffer-coding-system nil
3214 "If non-nil, use this coding system for saving the buffer.
3215More precisely, use this coding system in place of the
3216value of `buffer-file-coding-system', when saving the buffer.
3217Calling `write-region' for any purpose other than saving the buffer
3218will still use `buffer-file-coding-system'; this variable has no effect
3219in such cases.")
3220
d5fe94cc
RS
3221(make-variable-buffer-local 'save-buffer-coding-system)
3222(put 'save-buffer-coding-system 'permanent-local t)
3223
b4da00e9 3224(defun basic-save-buffer ()
1cc852cc 3225 "Save the current buffer in its visited file, if it has been modified.
0370fe77
SM
3226The hooks `write-contents-functions' and `write-file-functions' get a chance
3227to do the job of saving; if they do not, then the buffer is saved in
3228the visited file file in the usual way.
3c3b81d1
SJ
3229Before and after saving the buffer, this function runs
3230`before-save-hook' and `after-save-hook', respectively."
b4da00e9 3231 (interactive)
19618231 3232 (save-current-buffer
c11a94fe
RS
3233 ;; In an indirect buffer, save its base buffer instead.
3234 (if (buffer-base-buffer)
3235 (set-buffer (buffer-base-buffer)))
3236 (if (buffer-modified-p)
3237 (let ((recent-save (recent-auto-save-p))
818286f4 3238 setmodes)
c11a94fe
RS
3239 ;; On VMS, rename file and buffer to get rid of version number.
3240 (if (and (eq system-type 'vax-vms)
3241 (not (string= buffer-file-name
3242 (file-name-sans-versions buffer-file-name))))
3243 (let (buffer-new-name)
3244 ;; Strip VMS version number before save.
3245 (setq buffer-file-name
3246 (file-name-sans-versions buffer-file-name))
3247 ;; Construct a (unique) buffer name to correspond.
3248 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3249 (setq buffer-new-name (buffer-name buf))
3250 (kill-buffer buf))
3251 (rename-buffer buffer-new-name)))
3252 ;; If buffer has no file name, ask user for one.
3253 (or buffer-file-name
182891ef
RS
3254 (let ((filename
3255 (expand-file-name
3256 (read-file-name "File to save in: ") nil)))
3257 (and (file-exists-p filename)
3258 (or (y-or-n-p (format "File `%s' exists; overwrite? "
3259 filename))
3260 (error "Canceled")))
3261 (set-visited-file-name filename)))
c11a94fe
RS
3262 (or (verify-visited-file-modtime (current-buffer))
3263 (not (file-exists-p buffer-file-name))
3264 (yes-or-no-p
3265 (format "%s has changed since visited or saved. Save anyway? "
3266 (file-name-nondirectory buffer-file-name)))
3267 (error "Save not confirmed"))
3268 (save-restriction
3269 (widen)
19618231 3270 (save-excursion
0370fe77 3271 (and (> (point-max) (point-min))
407b4328 3272 (not find-file-literally)
19618231
RS
3273 (/= (char-after (1- (point-max))) ?\n)
3274 (not (and (eq selective-display t)
3275 (= (char-after (1- (point-max))) ?\r)))
3276 (or (eq require-final-newline t)
f4206092 3277 (eq require-final-newline 'visit-save)
19618231
RS
3278 (and require-final-newline
3279 (y-or-n-p
3280 (format "Buffer %s does not end in newline. Add one? "
3281 (buffer-name)))))
3282 (save-excursion
3283 (goto-char (point-max))
3284 (insert ?\n))))
fa5867f6
AS
3285 ;; Support VC version backups.
3286 (vc-before-save)
3c3b81d1 3287 (run-hooks 'before-save-hook)
0370fe77 3288 (or (run-hook-with-args-until-success 'write-contents-functions)
c11a94fe 3289 (run-hook-with-args-until-success 'local-write-file-hooks)
0370fe77 3290 (run-hook-with-args-until-success 'write-file-functions)
0ba5894b
RS
3291 ;; If a hook returned t, file is already "written".
3292 ;; Otherwise, write it the usual way now.
3293 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
3294 ;; Now we have saved the current buffer. Let's make sure
3295 ;; that buffer-file-coding-system is fixed to what
3296 ;; actually used for saving by binding it locally.
0516edee
RS
3297 (if save-buffer-coding-system
3298 (setq save-buffer-coding-system last-coding-system-used)
3299 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
3300 (setq buffer-file-number
3301 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
3302 (if setmodes
3303 (condition-case ()
f3f9e207 3304 (set-file-modes buffer-file-name (car setmodes))
c11a94fe
RS
3305 (error nil))))
3306 ;; If the auto-save file was recent before this command,
3307 ;; delete it now.
3308 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
3309 ;; Support VC `implicit' locking.
3310 (vc-after-save)
c11a94fe
RS
3311 (run-hooks 'after-save-hook))
3312 (message "(No changes need to be saved)"))))
b4da00e9 3313
87d26afc
RS
3314;; This does the "real job" of writing a buffer into its visited file
3315;; and making a backup file. This is what is normally done
0370fe77 3316;; but inhibited if one of write-file-functions returns non-nil.
f3f9e207 3317;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
87d26afc 3318(defun basic-save-buffer-1 ()
969be033
RS
3319 (prog1
3320 (if save-buffer-coding-system
3321 (let ((coding-system-for-write save-buffer-coding-system))
3322 (basic-save-buffer-2))
d5fe94cc 3323 (basic-save-buffer-2))
969be033 3324 (setq buffer-file-coding-system-explicit last-coding-system-used)))
d5fe94cc 3325
f3f9e207 3326;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
d5fe94cc
RS
3327(defun basic-save-buffer-2 ()
3328 (let (tempsetmodes setmodes)
87d26afc
RS
3329 (if (not (file-writable-p buffer-file-name))
3330 (let ((dir (file-name-directory buffer-file-name)))
3331 (if (not (file-directory-p dir))
83c6f446
RS
3332 (if (file-exists-p dir)
3333 (error "%s is not a directory" dir)
cb2fdcfa 3334 (error "%s: no such directory" buffer-file-name))
87d26afc
RS
3335 (if (not (file-exists-p buffer-file-name))
3336 (error "Directory %s write-protected" dir)
3337 (if (yes-or-no-p
3338 (format "File %s is write-protected; try to save anyway? "
3339 (file-name-nondirectory
3340 buffer-file-name)))
3341 (setq tempsetmodes t)
3342 (error "Attempt to save to a file which you aren't allowed to write"))))))
3343 (or buffer-backed-up
3344 (setq setmodes (backup-buffer)))
76d5492b 3345 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
3346 (if (and file-precious-flag
3347 (file-writable-p dir))
3348 ;; If file is precious, write temp name, then rename it.
3349 ;; This requires write access to the containing dir,
3350 ;; which is why we don't try it if we don't have that access.
3351 (let ((realname buffer-file-name)
44dce0fb
RS
3352 tempname succeed
3353 (umask (default-file-modes))
6782610c 3354 (old-modtime (visited-file-modtime)))
44dce0fb
RS
3355 ;; Create temp files with strict access rights. It's easy to
3356 ;; loosen them later, whereas it's impossible to close the
3357 ;; time-window of loose permissions otherwise.
f4a0f59b 3358 (unwind-protect
44dce0fb
RS
3359 (progn
3360 (clear-visited-file-modtime)
3361 (set-default-file-modes ?\700)
3362 ;; Try various temporary names.
3363 ;; This code follows the example of make-temp-file,
3364 ;; but it calls write-region in the appropriate way
3365 ;; for saving the buffer.
3366 (while (condition-case ()
3367 (progn
3368 (setq tempname
3369 (make-temp-name
3370 (expand-file-name "tmp" dir)))
3371 (write-region (point-min) (point-max)
3372 tempname nil realname
3373 buffer-file-truename 'excl)
3374 nil)
3375 (file-already-exists t))
3376 ;; The file was somehow created by someone else between
3377 ;; `make-temp-name' and `write-region', let's try again.
3378 nil)
3379 (setq succeed t))
3380 ;; Reset the umask.
3381 (set-default-file-modes umask)
3382 ;; If we failed, restore the buffer's modtime.
3383 (unless succeed
3384 (set-visited-file-modtime old-modtime)))
3385 ;; Since we have created an entirely new file,
3386 ;; make sure it gets the right permission bits set.
f3f9e207
RS
3387 (setq setmodes (or setmodes (cons (file-modes buffer-file-name)
3388 buffer-file-name)))
f4a0f59b
RS
3389 ;; We succeeded in writing the temp file,
3390 ;; so rename it.
3391 (rename-file tempname buffer-file-name t))
3392 ;; If file not writable, see if we can make it writable
3393 ;; temporarily while we write it.
3394 ;; But no need to do so if we have just backed it up
3395 ;; (setmodes is set) because that says we're superseding.
3396 (cond ((and tempsetmodes (not setmodes))
3397 ;; Change the mode back, after writing.
f3f9e207
RS
3398 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3399 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3400 (let (success)
3401 (unwind-protect
3402 (progn
3403 (write-region (point-min) (point-max)
3404 buffer-file-name nil t buffer-file-truename)
3405 (setq success t))
3406 ;; If we get an error writing the new file, and we made
3407 ;; the backup by renaming, undo the backing-up.
3408 (and setmodes (not success)
3409 (rename-file (cdr setmodes) buffer-file-name))))))
87d26afc
RS
3410 setmodes))
3411
1eeae2a1
RS
3412(defun diff-buffer-with-file (&optional buffer)
3413 "View the differences between BUFFER and its associated file.
0b9e4749 3414This requires the external program `diff' to be in your `exec-path'."
1eeae2a1 3415 (interactive "bBuffer: ")
0b9e4749 3416 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4e4e9519
MR
3417 (if (and buffer-file-name
3418 (file-exists-p buffer-file-name))
3419 (let ((tempfile (make-temp-file "buffer-content-")))
3420 (unwind-protect
3421 (save-restriction
3422 (widen)
3423 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3424 (diff buffer-file-name tempfile nil t)
3425 (sit-for 0))
3426 (when (file-exists-p tempfile)
3427 (delete-file tempfile))))
3428 (message "Buffer %s has no associated file on disc" (buffer-name))
3429 ;; Display that message for 1 second so that user can read it
3430 ;; in the minibuffer.
3431 (sit-for 1)))
3432 ;; return always nil, so that save-buffers-kill-emacs will not move
3433 ;; over to the next unsaved buffer when calling `d'.
3434 nil)
1eeae2a1
RS
3435
3436(defvar save-some-buffers-action-alist
3437 '((?\C-r
3438 (lambda (buf)
3439 (view-buffer buf
3440 (lambda (ignore)
3441 (exit-recursive-edit)))
3442 (recursive-edit)
3443 ;; Return nil to ask about BUF again.
3444 nil)
3445 "display the current buffer")
3446 (?d diff-buffer-with-file
d97182ab 3447 "show difference to last saved version"))
1eeae2a1
RS
3448 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3449(put 'save-some-buffers-action-alist 'risky-local-variable t)
3450
a1b0c2a7
RS
3451(defvar buffer-save-without-query nil
3452 "Non-nil means `save-some-buffers' should save this buffer without asking.")
3453(make-variable-buffer-local 'buffer-save-without-query)
3454
ffc0e1ca 3455(defun save-some-buffers (&optional arg pred)
b4da00e9 3456 "Save some modified file-visiting buffers. Asks user about each one.
1eeae2a1
RS
3457You can answer `y' to save, `n' not to save, `C-r' to look at the
3458buffer in question with `view-buffer' before deciding or `d' to
126c9dda 3459view the differences using `diff-buffer-with-file'.
8fd9c174 3460
5bbbceb1 3461Optional argument (the prefix) non-nil means save all with no questions.
ffc0e1ca
AS
3462Optional second argument PRED determines which buffers are considered:
3463If PRED is nil, all the file-visiting buffers are considered.
3464If PRED is t, then certain non-file buffers will also be considered.
3465If PRED is a zero-argument function, it indicates for each buffer whether
1eeae2a1
RS
3466to consider it or not when called with that buffer current.
3467
3468See `save-some-buffers-action-alist' if you want to
3469change the additional actions you can take on files."
b4da00e9 3470 (interactive "P")
907482b9 3471 (save-window-excursion
a1b0c2a7
RS
3472 (let* (queried some-automatic
3473 files-done abbrevs-done)
3474 (dolist (buffer (buffer-list))
3475 ;; First save any buffers that we're supposed to save unconditionally.
3476 ;; That way the following code won't ask about them.
3477 (with-current-buffer buffer
3478 (when (and buffer-save-without-query (buffer-modified-p))
3479 (setq some-automatic t)
3480 (save-buffer))))
3481 ;; Ask about those buffers that merit it,
3482 ;; and record the number thus saved.
3483 (setq files-done
76d5492b
RM
3484 (map-y-or-n-p
3485 (function
3486 (lambda (buffer)
3487 (and (buffer-modified-p buffer)
3488 (not (buffer-base-buffer buffer))
3489 (or
3490 (buffer-file-name buffer)
ffc0e1ca 3491 (and pred
76d5492b
RM
3492 (progn
3493 (set-buffer buffer)
3494 (and buffer-offer-save (> (buffer-size) 0)))))
ffc0e1ca
AS
3495 (or (not (functionp pred))
3496 (with-current-buffer buffer (funcall pred)))
76d5492b
RM
3497 (if arg
3498 t
3499 (setq queried t)
3500 (if (buffer-file-name buffer)
3501 (format "Save file %s? "
3502 (buffer-file-name buffer))
3503 (format "Save buffer %s? "
3504 (buffer-name buffer)))))))
3505 (function
3506 (lambda (buffer)
3507 (set-buffer buffer)
3508 (save-buffer)))
3509 (buffer-list)
3510 '("buffer" "buffers" "save")
1eeae2a1 3511 save-some-buffers-action-alist))
bf247b6e 3512 ;; Maybe to save abbrevs, and record whether
a1b0c2a7
RS
3513 ;; we either saved them or asked to.
3514 (and save-abbrevs abbrevs-changed
3515 (progn
3516 (if (or arg
3517 (eq save-abbrevs 'silently)
3518 (y-or-n-p (format "Save abbrevs in %s? "
3519 abbrev-file-name)))
3520 (write-abbrev-file nil))
3521 ;; Don't keep bothering user if he says no.
3522 (setq abbrevs-changed nil)
3523 (setq abbrevs-done t)))
76d5492b 3524 (or queried (> files-done 0) abbrevs-done
a1b0c2a7
RS
3525 (message (if some-automatic
3526 "(Some special files were saved without asking)"
3527 "(No files need saving)"))))))
b4da00e9
RM
3528\f
3529(defun not-modified (&optional arg)
3530 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
3531With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3532
3533It is not a good idea to use this function in Lisp programs, because it
3534prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
3535 (interactive "P")
3536 (message (if arg "Modification-flag set"
3537 "Modification-flag cleared"))
3538 (set-buffer-modified-p arg))
3539
3540(defun toggle-read-only (&optional arg)
3541 "Change whether this buffer is visiting its file read-only.
2a9fe1e2
RS
3542With arg, set read-only iff arg is positive.
3543If visiting file read-only and `view-read-only' is non-nil, enter view mode."
b4da00e9 3544 (interactive "P")
c60ee5e7 3545 (if (and arg
d758359d
AS
3546 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3547 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3548 nil ; do nothing.
3549 ;; Toggle.
3550 (cond
3551 ((and buffer-read-only view-mode)
3552 (View-exit-and-edit)
3553 (make-local-variable 'view-read-only)
3554 (setq view-read-only t)) ; Must leave view mode.
3555 ((and (not buffer-read-only) view-read-only
818286f4
SM
3556 ;; If view-mode is already active, `view-mode-enter' is a nop.
3557 (not view-mode)
d758359d
AS
3558 (not (eq (get major-mode 'mode-class) 'special)))
3559 (view-mode-enter))
3560 (t (setq buffer-read-only (not buffer-read-only))
3561 (force-mode-line-update)))
3562 (if (vc-backend buffer-file-name)
3563 (message (substitute-command-keys
a5dd5f60
RS
3564 (concat "File is under version-control; "
3565 "use \\[vc-next-action] to check in/out"))))))
b4da00e9 3566
912192d1 3567(defun insert-file (filename)
b4da00e9
RM
3568 "Insert contents of file FILENAME into buffer after point.
3569Set mark after the inserted text.
3570
3571This function is meant for the user to run interactively.
3572Don't call it from programs! Use `insert-file-contents' instead.
3573\(Its calling sequence is different; see its documentation)."
912192d1 3574 (interactive "*fInsert file: ")
3a64a3cf 3575 (insert-file-1 filename #'insert-file-contents))
b4da00e9 3576
912192d1 3577(defun append-to-file (start end filename)
b4da00e9
RM
3578 "Append the contents of the region to the end of file FILENAME.
3579When called from a function, expects three arguments,
3580START, END and FILENAME. START and END are buffer positions
da30bf98 3581saying what text to write."
912192d1
KH
3582 (interactive "r\nFAppend to file: ")
3583 (write-region start end filename t))
b4da00e9
RM
3584
3585(defun file-newest-backup (filename)
3586 "Return most recent backup file for FILENAME or nil if no backups exist."
ffc0e1ca
AS
3587 ;; `make-backup-file-name' will get us the right directory for
3588 ;; ordinary or numeric backups. It might create a directory for
3589 ;; backups as a side-effect, according to `backup-directory-alist'.
e31cfca5 3590 (let* ((filename (file-name-sans-versions
783bf210 3591 (make-backup-file-name (expand-file-name filename))))
b4da00e9
RM
3592 (file (file-name-nondirectory filename))
3593 (dir (file-name-directory filename))
3594 (comp (file-name-all-completions file dir))
cf7e94a0
RS
3595 (newest nil)
3596 tem)
b4da00e9 3597 (while comp
ffc0e1ca 3598 (setq tem (pop comp))
cf7e94a0
RS
3599 (cond ((and (backup-file-name-p tem)
3600 (string= (file-name-sans-versions tem) file))
3601 (setq tem (concat dir tem))
3602 (if (or (null newest)
3603 (file-newer-than-file-p tem newest))
3604 (setq newest tem)))))
b4da00e9
RM
3605 newest))
3606
3607(defun rename-uniquely ()
3608 "Rename current buffer to a similar name not already taken.
3609This function is useful for creating multiple shell process buffers
3610or multiple mail buffers, etc."
3611 (interactive)
40eb8038 3612 (save-match-data
e0df3aef
KH
3613 (let ((base-name (buffer-name)))
3614 (and (string-match "<[0-9]+>\\'" base-name)
3615 (not (and buffer-file-name
3616 (string= base-name
3617 (file-name-nondirectory buffer-file-name))))
3618 ;; If the existing buffer name has a <NNN>,
3619 ;; which isn't part of the file name (if any),
3620 ;; then get rid of that.
3621 (setq base-name (substring base-name 0 (match-beginning 0))))
3622 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 3623 (force-mode-line-update))))
5bbbceb1 3624
4e43240a 3625(defun make-directory (dir &optional parents)
5ce8bb89
RS
3626 "Create the directory DIR and any nonexistent parent dirs.
3627Interactively, the default choice of directory to create
3628is the current default directory for file names.
0225ae5e 3629That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
3630
3631Noninteractively, the second (optional) argument PARENTS says whether
07703430
RS
3632to create parent directories if they don't exist. Interactively,
3633this happens by default."
5ce8bb89
RS
3634 (interactive
3635 (list (read-file-name "Make directory: " default-directory default-directory
3636 nil nil)
3637 t))
ee291b46
RS
3638 ;; If default-directory is a remote directory,
3639 ;; make sure we find its make-directory handler.
3640 (setq dir (expand-file-name dir))
6eaebaa2 3641 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
3642 (if handler
3643 (funcall handler 'make-directory dir parents)
3644 (if (not parents)
3645 (make-directory-internal dir)
3646 (let ((dir (directory-file-name (expand-file-name dir)))
3647 create-list)
3648 (while (not (file-exists-p dir))
76d5492b 3649 (setq create-list (cons dir create-list)
4e43240a
RS
3650 dir (directory-file-name (file-name-directory dir))))
3651 (while create-list
3652 (make-directory-internal (car create-list))
3653 (setq create-list (cdr create-list))))))))
b4da00e9
RM
3654\f
3655(put 'revert-buffer-function 'permanent-local t)
3656(defvar revert-buffer-function nil
0973d78b
RS
3657 "Function to use to revert this buffer, or nil to do the default.
3658The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3659which are the arguments that `revert-buffer' received.")
b4da00e9
RM
3660
3661(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
3662(defvar revert-buffer-insert-file-contents-function nil
3663 "Function to use to insert contents when reverting this buffer.
3664Gets two args, first the nominal file name to use,
2df32500
RS
3665and second, t if reading the auto-save file.
3666
3667The function you specify is responsible for updating (or preserving) point.")
b4da00e9 3668
b0dc9757
LT
3669(defvar buffer-stale-function nil
3670 "Function to check whether a non-file buffer needs reverting.
3671This should be a function with one optional argument NOCONFIRM.
44dce0fb 3672Auto Revert Mode passes t for NOCONFIRM. The function should return
8b0b6932
LT
3673non-nil if the buffer should be reverted. A return value of
3674`fast' means that the need for reverting was not checked, but
3675that reverting the buffer is fast. The buffer is current when
3676this function is called.
b0dc9757 3677
4f8453ae
LT
3678The idea behind the NOCONFIRM argument is that it should be
3679non-nil if the buffer is going to be reverted without asking the
3680user. In such situations, one has to be careful with potentially
c90dcdd5
LT
3681time consuming operations.
3682
3683For more information on how this variable is used by Auto Revert mode,
3684see Info node `(emacs-xtra)Supporting additional buffers'.")
b0dc9757 3685
5f76e7d4
KH
3686(defvar before-revert-hook nil
3687 "Normal hook for `revert-buffer' to run before reverting.
3688If `revert-buffer-function' is used to override the normal revert
3689mechanism, this hook is not used.")
3690
3691(defvar after-revert-hook nil
3692 "Normal hook for `revert-buffer' to run after reverting.
3693Note that the hook value that it runs is the value that was in effect
3694before reverting; that makes a difference if you have buffer-local
3695hook functions.
3696
3697If `revert-buffer-function' is used to override the normal revert
3698mechanism, this hook is not used.")
3699
1554c03b
RS
3700(defvar revert-buffer-internal-hook)
3701
9a30563f 3702(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 3703 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 3704This undoes all changes since the file was visited or saved.
8c0e7b73
JB
3705With a prefix argument, offer to revert from latest auto-save file, if
3706that is more recent than the visited file.
1ab31687 3707
7e7c9c4e
RS
3708This command also works for special buffers that contain text which
3709doesn't come from a file, but reflects some other data base instead:
4e163715 3710for example, Dired buffers and `buffer-list' buffers. In these cases,
7e7c9c4e
RS
3711it reconstructs the buffer contents from the appropriate data base.
3712
65ee6096 3713When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
3714to revert from the auto-save file when this is nil. Note that the
3715sense of this argument is the reverse of the prefix argument, for the
3716sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3717to nil.
3718
3719Optional second argument NOCONFIRM means don't ask for confirmation at
ffc0e1ca 3720all. (The local variable `revert-without-query', if non-nil, prevents
d1f04130 3721confirmation.)
b4da00e9 3722
5b2b26d5
RS
3723Optional third argument PRESERVE-MODES non-nil means don't alter
3724the files modes. Normally we reinitialize them using `normal-mode'.
3725
8c0e7b73 3726If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
3727do all the work for this command. Otherwise, the hooks
3728`before-revert-hook' and `after-revert-hook' are run at the beginning
3729and the end, and if `revert-buffer-insert-file-contents-function' is
3730non-nil, it is called instead of rereading visited file contents."
fb6208a6 3731
1ab31687
JB
3732 ;; I admit it's odd to reverse the sense of the prefix argument, but
3733 ;; there is a lot of code out there which assumes that the first
3734 ;; argument should be t to avoid consulting the auto-save file, and
3735 ;; there's no straightforward way to encourage authors to notice a
3736 ;; reversal of the argument sense. So I'm just changing the user
3737 ;; interface, but leaving the programmatic interface the same.
e0867e99 3738 (interactive (list (not current-prefix-arg)))
b4da00e9 3739 (if revert-buffer-function
1ab31687 3740 (funcall revert-buffer-function ignore-auto noconfirm)
44dce0fb
RS
3741 (with-current-buffer (or (buffer-base-buffer (current-buffer))
3742 (current-buffer))
3743 (let* ((auto-save-p (and (not ignore-auto)
3744 (recent-auto-save-p)
3745 buffer-auto-save-file-name
3746 (file-readable-p buffer-auto-save-file-name)
3747 (y-or-n-p
3748 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3749 (file-name (if auto-save-p
3750 buffer-auto-save-file-name
3751 buffer-file-name)))
3752 (cond ((null file-name)
3753 (error "Buffer does not seem to be associated with any file"))
3754 ((or noconfirm
3755 (and (not (buffer-modified-p))
3756 (let ((tail revert-without-query)
3757 (found nil))
3758 (while tail
3759 (if (string-match (car tail) file-name)
3760 (setq found t))
3761 (setq tail (cdr tail)))
3762 found))
3763 (yes-or-no-p (format "Revert buffer from file %s? "
3764 file-name)))
3765 (run-hooks 'before-revert-hook)
3766 ;; If file was backed up but has changed since,
3767 ;; we shd make another backup.
3768 (and (not auto-save-p)
3769 (not (verify-visited-file-modtime (current-buffer)))
3770 (setq buffer-backed-up nil))
3771 ;; Get rid of all undo records for this buffer.
3772 (or (eq buffer-undo-list t)
3773 (setq buffer-undo-list nil))
3774 ;; Effectively copy the after-revert-hook status,
3775 ;; since after-find-file will clobber it.
3776 (let ((global-hook (default-value 'after-revert-hook))
3777 (local-hook-p (local-variable-p 'after-revert-hook))
3778 (local-hook (and (local-variable-p 'after-revert-hook)
3779 after-revert-hook)))
3780 (let (buffer-read-only
3781 ;; Don't make undo records for the reversion.
3782 (buffer-undo-list t))
3783 (if revert-buffer-insert-file-contents-function
3784 (funcall revert-buffer-insert-file-contents-function
3785 file-name auto-save-p)
3786 (if (not (file-exists-p file-name))
3787 (error (if buffer-file-number
3788 "File %s no longer exists!"
3789 "Cannot revert nonexistent file %s")
3790 file-name))
3791 ;; Bind buffer-file-name to nil
3792 ;; so that we don't try to lock the file.
3793 (let ((buffer-file-name nil))
3794 (or auto-save-p
3795 (unlock-buffer)))
3796 (widen)
3797 (let ((coding-system-for-read
3798 ;; Auto-saved file shoule be read by Emacs'
3799 ;; internal coding.
3800 (if auto-save-p 'auto-save-coding
3801 (or coding-system-for-read
3802 buffer-file-coding-system-explicit))))
3803 ;; This force after-insert-file-set-coding
3804 ;; (called from insert-file-contents) to set
3805 ;; buffer-file-coding-system to a proper value.
3806 (kill-local-variable 'buffer-file-coding-system)
3807
3808 ;; Note that this preserves point in an intelligent way.
3809 (if preserve-modes
3810 (let ((buffer-file-format buffer-file-format))
3811 (insert-file-contents file-name (not auto-save-p)
3812 nil nil t))
3813 (insert-file-contents file-name (not auto-save-p)
3814 nil nil t)))))
3815 ;; Recompute the truename in case changes in symlinks
3816 ;; have changed the truename.
3817 (setq buffer-file-truename
3818 (abbreviate-file-name (file-truename buffer-file-name)))
3819 (after-find-file nil nil t t preserve-modes)
3820 ;; Run after-revert-hook as it was before we reverted.
3821 (setq-default revert-buffer-internal-hook global-hook)
3822 (if local-hook-p
3823 (set (make-local-variable 'revert-buffer-internal-hook)
3824 local-hook)
3825 (kill-local-variable 'revert-buffer-internal-hook))
3826 (run-hooks 'revert-buffer-internal-hook))
3827 t))))))
b4da00e9 3828
64d18e8f
RS
3829(defun recover-this-file ()
3830 "Recover the visited file--get contents from its last auto-save file."
3831 (interactive)
3832 (recover-file buffer-file-name))
3833
b4da00e9
RM
3834(defun recover-file (file)
3835 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
3836 ;; Actually putting the file name in the minibuffer should be used
3837 ;; only rarely.
3838 ;; Not just because users often use the default.
e1dadc17 3839 (interactive "FRecover file: ")
b4da00e9 3840 (setq file (expand-file-name file))
f7da6740 3841 (if (auto-save-file-name-p (file-name-nondirectory file))
4e163715 3842 (error "%s is an auto-save file" (abbreviate-file-name file)))
b4da00e9
RM
3843 (let ((file-name (let ((buffer-file-name file))
3844 (make-auto-save-file-name))))
945e1965
RS
3845 (cond ((if (file-exists-p file)
3846 (not (file-newer-than-file-p file-name file))
3847 (not (file-exists-p file-name)))
4e163715
SM
3848 (error "Auto-save file %s not current"
3849 (abbreviate-file-name file-name)))
b4da00e9 3850 ((save-window-excursion
ffc0e1ca
AS
3851 (with-output-to-temp-buffer "*Directory*"
3852 (buffer-disable-undo standard-output)
3853 (save-excursion
3854 (let ((switches dired-listing-switches))
3855 (if (file-symlink-p file)
3856 (setq switches (concat switches "L")))
3857 (set-buffer standard-output)
bc22fd18
EZ
3858 ;; Use insert-directory-safely, not insert-directory,
3859 ;; because these files might not exist. In particular,
3860 ;; FILE might not exist if the auto-save file was for
3861 ;; a buffer that didn't visit a file, such as "*mail*".
3862 ;; The code in v20.x called `ls' directly, so we need
3863 ;; to emulate what `ls' did in that case.
3864 (insert-directory-safely file switches)
3865 (insert-directory-safely file-name switches))))
b4da00e9
RM
3866 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3867 (switch-to-buffer (find-file-noselect file t))
82d0954a 3868 (let ((buffer-read-only nil)
1e87edf5
KH
3869 ;; Keep the current buffer-file-coding-system.
3870 (coding-system buffer-file-coding-system)
77619f8e
KH
3871 ;; Auto-saved file shoule be read with special coding.
3872 (coding-system-for-read 'auto-save-coding))
b4da00e9 3873 (erase-buffer)
1e87edf5
KH
3874 (insert-file-contents file-name nil)
3875 (set-buffer-file-coding-system coding-system))
8cfb9d46 3876 (after-find-file nil nil t))
ffa7ab70 3877 (t (error "Recover-file cancelled")))))
b4da00e9 3878
6598027d 3879(defun recover-session ()
9aee5392
RS
3880 "Recover auto save files from a previous Emacs session.
3881This command first displays a Dired buffer showing you the
3882previous sessions that you could recover from.
3883To choose one, move point to the proper line and then type C-c C-c.
3884Then you'll be asked about a number of files to recover."
3885 (interactive)
363a5030
RS
3886 (if (null auto-save-list-file-prefix)
3887 (error "You set `auto-save-list-file-prefix' to disable making session files"))
ffc0e1ca
AS
3888 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3889 (unless (file-directory-p dir)
194600a8
JPW
3890 (make-directory dir t))
3891 (unless (directory-files dir nil
3892 (concat "\\`" (regexp-quote
3893 (file-name-nondirectory
3894 auto-save-list-file-prefix)))
3895 t)
3896 (error "No previous sessions to recover")))
6f4983e6 3897 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
3898 (dired (concat auto-save-list-file-prefix "*")
3899 (concat dired-listing-switches "t")))
05e076c7
AS
3900 (save-excursion
3901 (goto-char (point-min))
3902 (or (looking-at " Move to the session you want to recover,")
3903 (let ((inhibit-read-only t))
3904 ;; Each line starts with a space
3905 ;; so that Font Lock mode won't highlight the first character.
3906 (insert " Move to the session you want to recover,\n"
3907 " then type C-c C-c to select it.\n\n"
3908 " You can also delete some of these files;\n"
3909 " type d on a line to mark that file for deletion.\n\n"))))
9aee5392 3910 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 3911 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 3912
80280bb7 3913(defun recover-session-finish ()
9aee5392
RS
3914 "Choose one saved session to recover auto-save files from.
3915This command is used in the special Dired buffer created by
80280bb7 3916\\[recover-session]."
9aee5392
RS
3917 (interactive)
3918 ;; Get the name of the session file to recover from.
3919 (let ((file (dired-get-filename))
953a03b2 3920 files
9aee5392 3921 (buffer (get-buffer-create " *recover*")))
c11032b9 3922 (dired-unmark 1)
033ef863 3923 (dired-do-flagged-delete t)
9aee5392
RS
3924 (unwind-protect
3925 (save-excursion
3926 ;; Read in the auto-save-list file.
3927 (set-buffer buffer)
3928 (erase-buffer)
3929 (insert-file-contents file)
953a03b2
RS
3930 ;; Loop thru the text of that file
3931 ;; and get out the names of the files to recover.
3932 (while (not (eobp))
3933 (let (thisfile autofile)
3934 (if (eolp)
3935 ;; This is a pair of lines for a non-file-visiting buffer.
3936 ;; Get the auto-save file name and manufacture
3937 ;; a "visited file name" from that.
3938 (progn
3939 (forward-line 1)
259be4e6
JB
3940 ;; If there is no auto-save file name, the
3941 ;; auto-save-list file is probably corrupted.
3942 (unless (eolp)
3943 (setq autofile
3944 (buffer-substring-no-properties
3945 (point)
3946 (save-excursion
3947 (end-of-line)
3948 (point))))
3949 (setq thisfile
3950 (expand-file-name
3951 (substring
3952 (file-name-nondirectory autofile)
3953 1 -1)
3954 (file-name-directory autofile))))
953a03b2
RS
3955 (forward-line 1))
3956 ;; This pair of lines is a file-visiting
3957 ;; buffer. Use the visited file name.
3958 (progn
3959 (setq thisfile
3960 (buffer-substring-no-properties
3961 (point) (progn (end-of-line) (point))))
3962 (forward-line 1)
3963 (setq autofile
3964 (buffer-substring-no-properties
3965 (point) (progn (end-of-line) (point))))
3966 (forward-line 1)))
3967 ;; Ignore a file if its auto-save file does not exist now.
259be4e6 3968 (if (and autofile (file-exists-p autofile))
953a03b2
RS
3969 (setq files (cons thisfile files)))))
3970 (setq files (nreverse files))
945e1965
RS
3971 ;; The file contains a pair of line for each auto-saved buffer.
3972 ;; The first line of the pair contains the visited file name
3973 ;; or is empty if the buffer was not visiting a file.
3974 ;; The second line is the auto-save file name.
953a03b2
RS
3975 (if files
3976 (map-y-or-n-p "Recover %s? "
3977 (lambda (file)
3978 (condition-case nil
3979 (save-excursion (recover-file file))
76d5492b 3980 (error
953a03b2
RS
3981 "Failed to recover `%s'" file)))
3982 files
3983 '("file" "files" "recover"))
3984 (message "No files can be recovered from this session now")))
9aee5392
RS
3985 (kill-buffer buffer))))
3986
73ba610a 3987(defun kill-some-buffers (&optional list)
243a3ae0 3988 "Kill some buffers. Asks the user whether to kill each one of them.
bb8eaf67 3989Non-interactively, if optional argument LIST is non-nil, it
243a3ae0 3990specifies the list of buffers to kill, asking for approval for each one."
b4da00e9 3991 (interactive)
73ba610a
RS
3992 (if (null list)
3993 (setq list (buffer-list)))
3994 (while list
3995 (let* ((buffer (car list))
3996 (name (buffer-name buffer)))
3997 (and (not (string-equal name ""))
3998 (/= (aref name 0) ? )
3999 (yes-or-no-p
4000 (format "Buffer %s %s. Kill? "
4001 name
4002 (if (buffer-modified-p buffer)
4003 "HAS BEEN EDITED" "is unmodified")))
4004 (kill-buffer buffer)))
4005 (setq list (cdr list))))
b4da00e9
RM
4006\f
4007(defun auto-save-mode (arg)
4008 "Toggle auto-saving of contents of current buffer.
f3e23606 4009With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
4010 (interactive "P")
4011 (setq buffer-auto-save-file-name
4012 (and (if (null arg)
74b9c2af 4013 (or (not buffer-auto-save-file-name)
4e0c8650 4014 ;; If auto-save is off because buffer has shrunk,
74b9c2af
RS
4015 ;; then toggling should turn it on.
4016 (< buffer-saved-size 0))
b4da00e9
RM
4017 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4018 (if (and buffer-file-name auto-save-visited-file-name
4019 (not buffer-read-only))
4020 buffer-file-name
4021 (make-auto-save-file-name))))
0b7f1ef2
RS
4022 ;; If -1 was stored here, to temporarily turn off saving,
4023 ;; turn it back on.
4024 (and (< buffer-saved-size 0)
4025 (setq buffer-saved-size 0))
b4da00e9
RM
4026 (if (interactive-p)
4027 (message "Auto-save %s (in this buffer)"
4028 (if buffer-auto-save-file-name "on" "off")))
4029 buffer-auto-save-file-name)
4030
4031(defun rename-auto-save-file ()
4032 "Adjust current buffer's auto save file name for current conditions.
4033Also rename any existing auto save file, if it was made in this session."
4034 (let ((osave buffer-auto-save-file-name))
4035 (setq buffer-auto-save-file-name
4036 (make-auto-save-file-name))
4037 (if (and osave buffer-auto-save-file-name
4038 (not (string= buffer-auto-save-file-name buffer-file-name))
4039 (not (string= buffer-auto-save-file-name osave))
4040 (file-exists-p osave)
4041 (recent-auto-save-p))
4042 (rename-file osave buffer-auto-save-file-name t))))
4043
4044(defun make-auto-save-file-name ()
4045 "Return file name to use for auto-saves of current buffer.
4046Does not consider `auto-save-visited-file-name' as that variable is checked
4047before calling this function. You can redefine this for customization.
4048See also `auto-save-file-name-p'."
4049 (if buffer-file-name
ffc0e1ca
AS
4050 (let ((list auto-save-file-name-transforms)
4051 (filename buffer-file-name)
a0b60c33 4052 result uniq)
ffc0e1ca
AS
4053 ;; Apply user-specified translations
4054 ;; to the file name.
4055 (while (and list (not result))
4056 (if (string-match (car (car list)) filename)
4057 (setq result (replace-match (cadr (car list)) t nil
a0b60c33 4058 filename)
38eea7c7 4059 uniq (car (cddr (car list)))))
ffc0e1ca 4060 (setq list (cdr list)))
a0b60c33 4061 (if result
3c4a7cf3
RS
4062 (if uniq
4063 (setq filename (concat
4064 (file-name-directory result)
4065 (subst-char-in-string
d7b6ca4a 4066 ?/ ?!
3c4a7cf3
RS
4067 (replace-regexp-in-string "!" "!!"
4068 filename))))
4069 (setq filename result)))
1e57a696
EZ
4070 (setq result
4071 (if (and (eq system-type 'ms-dos)
4072 (not (msdos-long-file-names)))
4073 ;; We truncate the file name to DOS 8+3 limits
4074 ;; before doing anything else, because the regexp
4075 ;; passed to string-match below cannot handle
4076 ;; extensions longer than 3 characters, multiple
4077 ;; dots, and other atrocities.
4078 (let ((fn (dos-8+3-filename
4079 (file-name-nondirectory buffer-file-name))))
4080 (string-match
4081 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4082 fn)
4083 (concat (file-name-directory buffer-file-name)
4084 "#" (match-string 1 fn)
4085 "." (match-string 3 fn) "#"))
4086 (concat (file-name-directory filename)
4087 "#"
4088 (file-name-nondirectory filename)
4089 "#")))
4090 ;; Make sure auto-save file names don't contain characters
4091 ;; invalid for the underlying filesystem.
4092 (if (and (memq system-type '(ms-dos windows-nt))
4093 ;; Don't modify remote (ange-ftp) filenames
4094 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4095 (convert-standard-filename result)
4096 result))
0a1763b4
RS
4097
4098 ;; Deal with buffers that don't have any associated files. (Mail
4099 ;; mode tends to create a good number of these.)
4100
7d483e8c 4101 (let ((buffer-name (buffer-name))
ff5c7181 4102 (limit 0)
77d18896 4103 file-name)
c3348e10
RS
4104 ;; Eliminate all slashes and backslashes by
4105 ;; replacing them with sequences that start with %.
4106 ;; Quote % also, to keep distinct names distinct.
4107 (while (string-match "[/\\%]" buffer-name limit)
4108 (let* ((character (aref buffer-name (match-beginning 0)))
4109 (replacement
4110 (cond ((eq character ?%) "%%")
4111 ((eq character ?/) "%+")
4112 ((eq character ?\\) "%-"))))
4113 (setq buffer-name (replace-match replacement t t buffer-name))
4114 (setq limit (1+ (match-end 0)))))
a8abaf83 4115 ;; Generate the file name.
ff5c7181
RS
4116 (setq file-name
4117 (make-temp-file
4118 (let ((fname
4119 (expand-file-name
4120 (format "#%s#" buffer-name)
4121 ;; Try a few alternative directories, to get one we can
4122 ;; write it.
4123 (cond
4124 ((file-writable-p default-directory) default-directory)
4125 ((file-writable-p "/var/tmp/") "/var/tmp/")
4126 ("~/")))))
4127 (if (and (memq system-type '(ms-dos windows-nt))
4128 ;; Don't modify remote (ange-ftp) filenames
4129 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4130 ;; The call to convert-standard-filename is in case
4131 ;; buffer-name includes characters not allowed by the
4132 ;; DOS/Windows filesystems. make-temp-file writes to the
4133 ;; file it creates, so we must fix the file name _before_
4134 ;; make-temp-file is called.
4135 (convert-standard-filename fname)
4136 fname))
4137 nil "#"))
4138 ;; make-temp-file creates the file,
4139 ;; but we don't want it to exist until we do an auto-save.
4140 (condition-case ()
4141 (delete-file file-name)
4142 (file-error nil))
4143 file-name)))
b4da00e9
RM
4144
4145(defun auto-save-file-name-p (filename)
4146 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4147FILENAME should lack slashes. You can redefine this for customization."
4148 (string-match "^#.*#$" filename))
4149\f
6f4983e6
RS
4150(defun wildcard-to-regexp (wildcard)
4151 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4152The generated regexp will match a filename iff the filename
4153matches that wildcard according to shell rules. Only wildcards known
4154by `sh' are supported."
4155 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4156 ;; Copy the initial run of non-special characters.
4157 (result (substring wildcard 0 i))
4158 (len (length wildcard)))
4159 ;; If no special characters, we're almost done.
4160 (if i
4161 (while (< i len)
4162 (let ((ch (aref wildcard i))
4163 j)
4164 (setq
4165 result
4166 (concat result
4167 (cond
7e7c9c4e
RS
4168 ((and (eq ch ?\[)
4169 (< (1+ i) len)
4170 (eq (aref wildcard (1+ i)) ?\]))
4171 "\\[")
6f4983e6
RS
4172 ((eq ch ?\[) ; [...] maps to regexp char class
4173 (progn
4174 (setq i (1+ i))
4175 (concat
4176 (cond
4177 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4178 (progn
4179 (setq i (1+ i))
4180 (if (eq (aref wildcard i) ?\])
4181 (progn
4182 (setq i (1+ i))
4183 "[^]")
4184 "[^")))
4185 ((eq (aref wildcard i) ?^)
4186 ;; Found "[^". Insert a `\0' character
4187 ;; (which cannot happen in a filename)
4188 ;; into the character class, so that `^'
4189 ;; is not the first character after `[',
4190 ;; and thus non-special in a regexp.
4191 (progn
4192 (setq i (1+ i))
4193 "[\000^"))
4194 ((eq (aref wildcard i) ?\])
4195 ;; I don't think `]' can appear in a
4196 ;; character class in a wildcard, but
4197 ;; let's be general here.
4198 (progn
4199 (setq i (1+ i))
4200 "[]"))
4201 (t "["))
4202 (prog1 ; copy everything upto next `]'.
4203 (substring wildcard
4204 i
4205 (setq j (string-match
4206 "]" wildcard i)))
4207 (setq i (if j (1- j) (1- len)))))))
4208 ((eq ch ?.) "\\.")
4209 ((eq ch ?*) "[^\000]*")
4210 ((eq ch ?+) "\\+")
4211 ((eq ch ?^) "\\^")
4212 ((eq ch ?$) "\\$")
4213 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4214 ((eq ch ??) "[^\000]")
4215 (t (char-to-string ch)))))
4216 (setq i (1+ i)))))
4217 ;; Shell wildcards should match the entire filename,
4218 ;; not its part. Make the regexp say so.
4219 (concat "\\`" result "\\'")))
4220\f
21540597 4221(defcustom list-directory-brief-switches
b4da00e9 4222 (if (eq system-type 'vax-vms) "" "-CF")
ffc0e1ca 4223 "*Switches for `list-directory' to pass to `ls' for brief listing."
21540597
RS
4224 :type 'string
4225 :group 'dired)
b4da00e9 4226
21540597 4227(defcustom list-directory-verbose-switches
b4da00e9
RM
4228 (if (eq system-type 'vax-vms)
4229 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4230 "-l")
ffc0e1ca 4231 "*Switches for `list-directory' to pass to `ls' for verbose listing."
21540597
RS
4232 :type 'string
4233 :group 'dired)
b4da00e9 4234
5de148a2
RS
4235(defun file-expand-wildcards (pattern &optional full)
4236 "Expand wildcard pattern PATTERN.
4db2a7de
RS
4237This returns a list of file names which match the pattern.
4238
814af837 4239If PATTERN is written as an absolute file name,
4db2a7de
RS
4240the values are absolute also.
4241
4242If PATTERN is written as a relative file name, it is interpreted
4243relative to the current default directory, `default-directory'.
4244The file names returned are normally also relative to the current
4245default directory. However, if FULL is non-nil, they are absolute."
032388f3
RS
4246 (save-match-data
4247 (let* ((nondir (file-name-nondirectory pattern))
4248 (dirpart (file-name-directory pattern))
4249 ;; A list of all dirs that DIRPART specifies.
4250 ;; This can be more than one dir
4251 ;; if DIRPART contains wildcards.
4252 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4253 (mapcar 'file-name-as-directory
4254 (file-expand-wildcards (directory-file-name dirpart)))
4255 (list dirpart)))
4256 contents)
4257 (while dirs
4258 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
4259 (file-directory-p (directory-file-name (car dirs))))
4260 (let ((this-dir-contents
4261 ;; Filter out "." and ".."
4262 (delq nil
4263 (mapcar #'(lambda (name)
4264 (unless (string-match "\\`\\.\\.?\\'"
4265 (file-name-nondirectory name))
4266 name))
4267 (directory-files (or (car dirs) ".") full
4268 (wildcard-to-regexp nondir))))))
4269 (setq contents
4270 (nconc
4271 (if (and (car dirs) (not full))
4272 (mapcar (function (lambda (name) (concat (car dirs) name)))
4273 this-dir-contents)
4274 this-dir-contents)
4275 contents))))
4276 (setq dirs (cdr dirs)))
4277 contents)))
5de148a2 4278
b4da00e9
RM
4279(defun list-directory (dirname &optional verbose)
4280 "Display a list of files in or matching DIRNAME, a la `ls'.
4281DIRNAME is globbed by the shell if necessary.
4282Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4283Actions controlled by variables `list-directory-brief-switches'
4284and `list-directory-verbose-switches'."
4285 (interactive (let ((pfx current-prefix-arg))
4286 (list (read-file-name (if pfx "List directory (verbose): "
4287 "List directory (brief): ")
4288 nil default-directory nil)
4289 pfx)))
4290 (let ((switches (if verbose list-directory-verbose-switches
84905190
RS
4291 list-directory-brief-switches))
4292 buffer)
b4da00e9
RM
4293 (or dirname (setq dirname default-directory))
4294 (setq dirname (expand-file-name dirname))
4295 (with-output-to-temp-buffer "*Directory*"
84905190 4296 (setq buffer standard-output)
b4da00e9
RM
4297 (buffer-disable-undo standard-output)
4298 (princ "Directory ")
4299 (princ dirname)
4300 (terpri)
c3554e95
RS
4301 (save-excursion
4302 (set-buffer "*Directory*")
4303 (let ((wildcard (not (file-directory-p dirname))))
84905190
RS
4304 (insert-directory dirname switches wildcard (not wildcard)))))
4305 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4306 (with-current-buffer buffer
4307 (setq default-directory
4308 (if (file-directory-p dirname)
4309 (file-name-as-directory dirname)
4310 (file-name-directory dirname))))))
c3554e95 4311
ffc0e1ca
AS
4312(defun shell-quote-wildcard-pattern (pattern)
4313 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4314
4315PATTERN is assumed to represent a file-name wildcard suitable for the
4316underlying filesystem. For Unix and GNU/Linux, the characters from the
4317set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4318the parts of the pattern which don't include wildcard characters are
4319quoted with double quotes.
4320Existing quote characters in PATTERN are left alone, so you can pass
4321PATTERN that already quotes some of the special characters."
4322 (save-match-data
4323 (cond
c60ee5e7 4324 ((memq system-type '(ms-dos windows-nt cygwin))
ffc0e1ca
AS
4325 ;; DOS/Windows don't allow `"' in file names. So if the
4326 ;; argument has quotes, we can safely assume it is already
4327 ;; quoted by the caller.
4328 (if (or (string-match "[\"]" pattern)
4329 ;; We quote [&()#$'] in case their shell is a port of a
4330 ;; Unixy shell. We quote [,=+] because stock DOS and
4331 ;; Windows shells require that in some cases, such as
4332 ;; passing arguments to batch files that use positional
4333 ;; arguments like %1.
4334 (not (string-match "[ \t;&()#$',=+]" pattern)))
4335 pattern
4336 (let ((result "\"")
4337 (beg 0)
4338 end)
4339 (while (string-match "[*?]+" pattern beg)
4340 (setq end (match-beginning 0)
4341 result (concat result (substring pattern beg end)
4342 "\""
4343 (substring pattern end (match-end 0))
4344 "\"")
4345 beg (match-end 0)))
4346 (concat result (substring pattern beg) "\""))))
4347 (t
4348 (let ((beg 0))
4349 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4350 (setq pattern
4351 (concat (substring pattern 0 (match-beginning 0))
4352 "\\"
4353 (substring pattern (match-beginning 0)))
4354 beg (1+ (match-end 0)))))
4355 pattern))))
4356
4357
c3554e95
RS
4358(defvar insert-directory-program "ls"
4359 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4360
f4d04672
RS
4361(defcustom directory-free-space-program "df"
4362 "*Program to get the amount of free space on a file system.
4363We assume the output has the format of `df'.
4364The value of this variable must be just a command name or file name;
4365if you want to specify options, use `directory-free-space-args'.
4366
01b26b90
EZ
4367A value of nil disables this feature.
4368
4369If the function `file-system-info' is defined, it is always used in
4370preference to the program given by this variable."
f4d04672
RS
4371 :type '(choice (string :tag "Program") (const :tag "None" nil))
4372 :group 'dired)
4373
525fdbc9
AS
4374(defcustom directory-free-space-args
4375 (if (eq system-type 'darwin) "-k" "-Pk")
f4d04672
RS
4376 "*Options to use when running `directory-free-space-program'."
4377 :type 'string
4378 :group 'dired)
4379
01b26b90
EZ
4380(defun get-free-disk-space (dir)
4381 "Return the mount of free space on directory DIR's file system.
4382The result is a string that gives the number of free 1KB blocks,
4383or nil if the system call or the program which retrieve the infornmation
4384fail.
4385
4386This function calls `file-system-info' if it is available, or invokes the
4387program specified by `directory-free-space-program' if that is non-nil."
4388 ;; Try to find the number of free blocks. Non-Posix systems don't
4389 ;; always have df, but might have an equivalent system call.
4390 (if (fboundp 'file-system-info)
4391 (let ((fsinfo (file-system-info dir)))
4392 (if fsinfo
4393 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4394 (save-match-data
4395 (with-temp-buffer
4396 (when (and directory-free-space-program
15502042
EZ
4397 (eq 0 (call-process directory-free-space-program
4398 nil t nil
4399 directory-free-space-args
4400 dir)))
01b26b90
EZ
4401 ;; Usual format is a header line followed by a line of
4402 ;; numbers.
4403 (goto-char (point-min))
4404 (forward-line 1)
4405 (if (not (eobp))
4406 (progn
4407 ;; Move to the end of the "available blocks" number.
4408 (skip-chars-forward "^ \t")
4409 (forward-word 3)
4410 ;; Copy it into AVAILABLE.
4411 (let ((end (point)))
4412 (forward-word -1)
4413 (buffer-substring (point) end)))))))))
4414
4415
a1b0c2a7
RS
4416(defvar insert-directory-ls-version 'unknown)
4417
c3554e95
RS
4418;; insert-directory
4419;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4420;; FULL-DIRECTORY-P is nil.
4421;; The single line of output must display FILE's name as it was
4422;; given, namely, an absolute path name.
4423;; - must insert exactly one line for each file if WILDCARD or
4424;; FULL-DIRECTORY-P is t, plus one optional "total" line
4425;; before the file lines, plus optional text after the file lines.
4426;; Lines are delimited by "\n", so filenames containing "\n" are not
4427;; allowed.
4428;; File lines should display the basename.
4429;; - must be consistent with
4430;; - functions dired-move-to-filename, (these two define what a file line is)
4431;; dired-move-to-end-of-filename,
4432;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4433;; dired-insert-headerline
4434;; dired-after-subdir-garbage (defines what a "total" line is)
4435;; - variable dired-subdir-regexp
1fc85dae
KG
4436;; - may be passed "--dired" as the first argument in SWITCHES.
4437;; Filename handlers might have to remove this switch if their
4438;; "ls" command does not support it.
c3554e95 4439(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 4440 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 4441Leaves point after the inserted text.
8f8607be
LT
4442SWITCHES may be a string of options, or a list of strings
4443representing individual options.
c3554e95
RS
4444Optional third arg WILDCARD means treat FILE as shell wildcard.
4445Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4446switches do not contain `d', so that a full listing is expected.
4447
4448This works by running a directory listing program
406e12d9 4449whose name is in the variable `insert-directory-program'.
8f8607be
LT
4450If WILDCARD, it also runs the shell specified by `shell-file-name'.
4451
60ce7e3e 4452When SWITCHES contains the long `--dired' option, this function
8f8607be
LT
4453treats it specially, for the sake of dired. However, the
4454normally equivalent short `-D' option is just passed on to
4455`insert-directory-program', as any other option."
c870ab8e 4456 ;; We need the directory in order to find the right handler.
d2473540
AS
4457 (let ((handler (find-file-name-handler (expand-file-name file)
4458 'insert-directory)))
ebad92dc 4459 (if handler
c3554e95
RS
4460 (funcall handler 'insert-directory file switches
4461 wildcard full-directory-p)
b4da00e9 4462 (if (eq system-type 'vax-vms)
c3554e95 4463 (vms-read-directory file switches (current-buffer))
818286f4 4464 (let (result (beg (point)))
ebad92dc
RS
4465
4466 ;; Read the actual directory using `insert-directory-program'.
4467 ;; RESULT gets the status code.
99f01c91
KH
4468 (let* (;; We at first read by no-conversion, then after
4469 ;; putting text property `dired-filename, decode one
4470 ;; bunch by one to preserve that property.
4471 (coding-system-for-read 'no-conversion)
4472 ;; This is to control encoding the arguments in call-process.
c60ee5e7 4473 (coding-system-for-write
82e22b57
KH
4474 (and enable-multibyte-characters
4475 (or file-name-coding-system
99f01c91 4476 default-file-name-coding-system))))
ebad92dc
RS
4477 (setq result
4478 (if wildcard
4479 ;; Run ls in the directory part of the file pattern
4480 ;; using the last component as argument.
4481 (let ((default-directory
4482 (if (file-name-absolute-p file)
4483 (file-name-directory file)
4484 (file-name-directory (expand-file-name file))))
4485 (pattern (file-name-nondirectory file)))
4486 (call-process
4487 shell-file-name nil t nil
4488 "-c"
4489 (concat (if (memq system-type '(ms-dos windows-nt))
4490 ""
4491 "\\") ; Disregard Unix shell aliases!
4492 insert-directory-program
4493 " -d "
4494 (if (stringp switches)
4495 switches
4496 (mapconcat 'identity switches " "))
4497 " -- "
4498 ;; Quote some characters that have
4499 ;; special meanings in shells; but
4500 ;; don't quote the wildcards--we want
4501 ;; them to be special. We also
4502 ;; currently don't quote the quoting
4503 ;; characters in case people want to
4504 ;; use them explicitly to quote
4505 ;; wildcard characters.
4506 (shell-quote-wildcard-pattern pattern))))
4507 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4508 ;; directory if FILE is a symbolic link.
4509 (apply 'call-process
4510 insert-directory-program nil t nil
4511 (append
4512 (if (listp switches) switches
4513 (unless (equal switches "")
4514 ;; Split the switches at any spaces so we can
4515 ;; pass separate options as separate args.
4516 (split-string switches)))
4517 ;; Avoid lossage if FILE starts with `-'.
4518 '("--")
4519 (progn
4520 (if (string-match "\\`~" file)
4521 (setq file (expand-file-name file)))
4522 (list
4523 (if full-directory-p
4524 (concat (file-name-as-directory file) ".")
4525 file))))))))
4526
a1b0c2a7
RS
4527 ;; If we got "//DIRED//" in the output, it means we got a real
4528 ;; directory listing, even if `ls' returned nonzero.
4529 ;; So ignore any errors.
4530 (when (if (stringp switches)
4531 (string-match "--dired\\>" switches)
4532 (member "--dired" switches))
4533 (save-excursion
4534 (forward-line -2)
4535 (when (looking-at "//SUBDIRED//")
4536 (forward-line -1))
4537 (if (looking-at "//DIRED//")
4538 (setq result 0))))
4539
4540 (when (and (not (eq 0 result))
4541 (eq insert-directory-ls-version 'unknown))
4542 ;; The first time ls returns an error,
4543 ;; find the version numbers of ls,
4544 ;; and set insert-directory-ls-version
4545 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4546 ;; is equal or if the info cannot be obtained.
4547 ;; (That can mean it isn't GNU ls.)
4548 (let ((version-out
4549 (with-temp-buffer
4550 (call-process "ls" nil t nil "--version")
4551 (buffer-string))))
4552 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
4553 (let* ((version (match-string 1 version-out))
4554 (split (split-string version "[.]"))
027a4b6b 4555 (numbers (mapcar 'string-to-number split))
a1b0c2a7
RS
4556 (min '(5 2 1))
4557 comparison)
4558 (while (and (not comparison) (or numbers min))
4559 (cond ((null min)
4560 (setq comparison '>))
4561 ((null numbers)
4562 (setq comparison '<))
4563 ((> (car numbers) (car min))
4564 (setq comparison '>))
4565 ((< (car numbers) (car min))
4566 (setq comparison '<))
4567 (t
4568 (setq numbers (cdr numbers)
4569 min (cdr min)))))
4570 (setq insert-directory-ls-version (or comparison '=)))
4571 (setq insert-directory-ls-version nil))))
4572
4573 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4574 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
4575 (setq result 0))
4576
ebad92dc 4577 ;; If `insert-directory-program' failed, signal an error.
15502042 4578 (unless (eq 0 result)
f2440e42
RS
4579 ;; Delete the error message it may have output.
4580 (delete-region beg (point))
15502042
EZ
4581 ;; On non-Posix systems, we cannot open a directory, so
4582 ;; don't even try, because that will always result in
4583 ;; the ubiquitous "Access denied". Instead, show the
4584 ;; command line so the user can try to guess what went wrong.
4585 (if (and (file-directory-p file)
4586 (memq system-type '(ms-dos windows-nt)))
4587 (error
4588 "Reading directory: \"%s %s -- %s\" exited with status %s"
4589 insert-directory-program
4590 (if (listp switches) (concat switches) switches)
4591 file result)
4592 ;; Unix. Access the file to get a suitable error.
4593 (access-file file "Reading directory")
4594 (error "Listing directory failed but `access-file' worked")))
ebad92dc 4595
8f8607be
LT
4596 (when (if (stringp switches)
4597 (string-match "--dired\\>" switches)
4598 (member "--dired" switches))
9bb99df6
LT
4599 ;; The following overshoots by one line for an empty
4600 ;; directory listed with "--dired", but without "-a"
4601 ;; switch, where the ls output contains a
4602 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4603 ;; We take care of that case later.
ff7affeb 4604 (forward-line -2)
9423860f
AS
4605 (when (looking-at "//SUBDIRED//")
4606 (delete-region (point) (progn (forward-line 1) (point)))
4607 (forward-line -1))
9bb99df6
LT
4608 (if (looking-at "//DIRED//")
4609 (let ((end (line-end-position))
4610 (linebeg (point))
4611 error-lines)
4612 ;; Find all the lines that are error messages,
4613 ;; and record the bounds of each one.
4614 (goto-char beg)
4615 (while (< (point) linebeg)
4616 (or (eql (following-char) ?\s)
4617 (push (list (point) (line-end-position)) error-lines))
4618 (forward-line 1))
4619 (setq error-lines (nreverse error-lines))
4620 ;; Now read the numeric positions of file names.
4621 (goto-char linebeg)
4622 (forward-word 1)
4623 (forward-char 3)
4624 (while (< (point) end)
4625 (let ((start (insert-directory-adj-pos
4626 (+ beg (read (current-buffer)))
4627 error-lines))
4628 (end (insert-directory-adj-pos
a1b0c2a7 4629 (+ beg (read (current-buffer)))
9bb99df6
LT
4630 error-lines)))
4631 (if (memq (char-after end) '(?\n ?\ ))
4632 ;; End is followed by \n or by " -> ".
4633 (put-text-property start end 'dired-filename t)
4634 ;; It seems that we can't trust ls's output as to
4635 ;; byte positions of filenames.
4636 (put-text-property beg (point) 'dired-filename nil)
4637 (end-of-line))))
4638 (goto-char end)
4639 (beginning-of-line)
4640 (delete-region (point) (progn (forward-line 1) (point))))
4641 ;; Take care of the case where the ls output contains a
4642 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4643 ;; and we went one line too far back (see above).
4644 (forward-line 1))
4645 (if (looking-at "//DIRED-OPTIONS//")
4646 (delete-region (point) (progn (forward-line 1) (point)))))
ff7affeb 4647
99f01c91 4648 ;; Now decode what read if necessary.
b6647390
KH
4649 (let ((coding (or coding-system-for-read
4650 file-name-coding-system
4651 default-file-name-coding-system
4652 'undecided))
0bded065 4653 coding-no-eol
99f01c91 4654 val pos)
b6647390
KH
4655 (when (and enable-multibyte-characters
4656 (not (memq (coding-system-base coding)
4657 '(raw-text no-conversion))))
4658 ;; If no coding system is specified or detection is
4659 ;; requested, detect the coding.
4660 (if (eq (coding-system-base coding) 'undecided)
4661 (setq coding (detect-coding-region beg (point) t)))
4662 (if (not (eq (coding-system-base coding) 'undecided))
4663 (save-restriction
0bded065
AS
4664 (setq coding-no-eol
4665 (coding-system-change-eol-conversion coding 'unix))
b6647390
KH
4666 (narrow-to-region beg (point))
4667 (goto-char (point-min))
4668 (while (not (eobp))
4669 (setq pos (point)
4670 val (get-text-property (point) 'dired-filename))
4671 (goto-char (next-single-property-change
4672 (point) 'dired-filename nil (point-max)))
0bded065
AS
4673 ;; Force no eol conversion on a file name, so
4674 ;; that CR is preserved.
4675 (decode-coding-region pos (point)
4676 (if val coding-no-eol coding))
b6647390
KH
4677 (if val
4678 (put-text-property pos (point)
4679 'dired-filename t)))))))
99f01c91 4680
75bb5ca4
AS
4681 (if full-directory-p
4682 ;; Try to insert the amount of free space.
4683 (save-excursion
4684 (goto-char beg)
4685 ;; First find the line to put it on.
4686 (when (re-search-forward "^ *\\(total\\)" nil t)
4687 (let ((available (get-free-disk-space ".")))
4688 (when available
4689 ;; Replace "total" with "used", to avoid confusion.
4690 (replace-match "total used in directory" nil nil nil 1)
4691 (end-of-line)
4692 (insert " available " available)))))))))))
34342a07 4693
a1b0c2a7 4694(defun insert-directory-adj-pos (pos error-lines)
fead94d6 4695 "Convert `ls --dired' file name position value POS to a buffer position.
a1b0c2a7
RS
4696File name position values returned in ls --dired output
4697count only stdout; they don't count the error messages sent to stderr.
4698So this function converts to them to real buffer positions.
4699ERROR-LINES is a list of buffer positions of error message lines,
4700of the form (START END)."
4701 (while (and error-lines (< (caar error-lines) pos))
4702 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
4703 (pop error-lines))
4704 pos)
4705
bc22fd18
EZ
4706(defun insert-directory-safely (file switches
4707 &optional wildcard full-directory-p)
4708 "Insert directory listing for FILE, formatted according to SWITCHES.
4709
4710Like `insert-directory', but if FILE does not exist, it inserts a
4711message to that effect instead of signaling an error."
4712 (if (file-exists-p file)
4713 (insert-directory file switches wildcard full-directory-p)
4714 ;; Simulate the message printed by `ls'.
4715 (insert (format "%s: No such file or directory\n" file))))
4716
88902b35 4717(defvar kill-emacs-query-functions nil
65d5c6de 4718 "Functions to call with no arguments to query about killing Emacs.
78c793d1
RS
4719If any of these functions returns nil, killing Emacs is cancelled.
4720`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
4721but `kill-emacs', the low level primitive, does not.
4722See also `kill-emacs-hook'.")
88902b35 4723
11f15305 4724(defcustom confirm-kill-emacs nil
9c2ba08f
EZ
4725 "How to ask for confirmation when leaving Emacs.
4726If nil, the default, don't ask at all. If the value is non-nil, it should
4727be a predicate function such as `yes-or-no-p'."
11f15305
GM
4728 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
4729 (const :tag "Ask with y-or-n-p" y-or-n-p)
4730 (const :tag "Don't confirm" nil))
bdd9ab6e 4731 :group 'convenience
11f15305
GM
4732 :version "21.1")
4733
b4da00e9
RM
4734(defun save-buffers-kill-emacs (&optional arg)
4735 "Offer to save each buffer, then kill this Emacs process.
4736With prefix arg, silently save all file-visiting buffers, then kill."
4737 (interactive "P")
4738 (save-some-buffers arg t)
4739 (and (or (not (memq t (mapcar (function
4740 (lambda (buf) (and (buffer-file-name buf)
4741 (buffer-modified-p buf))))
4742 (buffer-list))))
4743 (yes-or-no-p "Modified buffers exist; exit anyway? "))
4744 (or (not (fboundp 'process-list))
4745 ;; process-list is not defined on VMS.
4746 (let ((processes (process-list))
4747 active)
4748 (while processes
48a4a1fb
KS
4749 (and (memq (process-status (car processes)) '(run stop open listen))
4750 (process-query-on-exit-flag (car processes))
b4da00e9
RM
4751 (setq active t))
4752 (setq processes (cdr processes)))
4753 (or (not active)
48a4a1fb 4754 (list-processes t)
b4da00e9 4755 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 4756 ;; Query the user for other things, perhaps.
fb15c113 4757 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
11f15305
GM
4758 (or (null confirm-kill-emacs)
4759 (funcall confirm-kill-emacs "Really exit Emacs? "))
b4da00e9
RM
4760 (kill-emacs)))
4761\f
ffc0e1ca 4762;; We use /: as a prefix to "quote" a file name
47afc068
RS
4763;; so that magic file name handlers will not apply to it.
4764
4765(setq file-name-handler-alist
4766 (cons '("\\`/:" . file-name-non-special)
4767 file-name-handler-alist))
4768
4769;; We depend on being the last handler on the list,
4770;; so that anything else which does need handling
4771;; has been handled already.
4772;; So it is safe for us to inhibit *all* magic file name handlers.
4773
4774(defun file-name-non-special (operation &rest arguments)
4775 (let ((file-name-handler-alist nil)
5cb1f728
KH
4776 (default-directory
4777 (if (eq operation 'insert-directory)
4778 (directory-file-name
ffc0e1ca 4779 (expand-file-name
5cb1f728
KH
4780 (unhandled-file-name-directory default-directory)))
4781 default-directory))
47afc068
RS
4782 ;; Get a list of the indices of the args which are file names.
4783 (file-arg-indices
4784 (cdr (or (assq operation
ae3b2983 4785 ;; The first six are special because they
47afc068
RS
4786 ;; return a file name. We want to include the /:
4787 ;; in the return value.
4788 ;; So just avoid stripping it in the first place.
4789 '((expand-file-name . nil)
4790 (file-name-directory . nil)
4791 (file-name-as-directory . nil)
4792 (directory-file-name . nil)
c736f678 4793 (file-name-sans-versions . nil)
ae3b2983 4794 (find-backup-file-name . nil)
c736f678 4795 ;; `identity' means just return the first arg
6750c852
RS
4796 ;; not stripped of its quoting.
4797 (substitute-in-file-name identity)
ae3b2983
MA
4798 ;; `add' means add "/:" to the result.
4799 (file-truename add 0)
4800 ;; `quote' means add "/:" to buffer-file-name.
4801 (insert-file-contents quote 0)
4802 ;; `unquote-then-quote' means set buffer-file-name
4803 ;; temporarily to unquoted filename.
4804 (verify-visited-file-modtime unquote-then-quote)
4805 ;; List the arguments which are filenames.
c37adaa5
SM
4806 (file-name-completion 1)
4807 (file-name-all-completions 1)
ae3b2983 4808 (write-region 2 5)
47afc068
RS
4809 (rename-file 0 1)
4810 (copy-file 0 1)
4811 (make-symbolic-link 0 1)
4812 (add-name-to-file 0 1)))
4813 ;; For all other operations, treat the first argument only
4814 ;; as the file name.
4815 '(nil 0))))
6750c852 4816 method
47afc068
RS
4817 ;; Copy ARGUMENTS so we can replace elements in it.
4818 (arguments (copy-sequence arguments)))
6750c852
RS
4819 (if (symbolp (car file-arg-indices))
4820 (setq method (pop file-arg-indices)))
4821 ;; Strip off the /: from the file names that have it.
47afc068 4822 (save-match-data
18b9dced 4823 (while (consp file-arg-indices)
fe4d9852
KH
4824 (let ((pair (nthcdr (car file-arg-indices) arguments)))
4825 (and (car pair)
4826 (string-match "\\`/:" (car pair))
4827 (setcar pair
4828 (if (= (length (car pair)) 2)
4829 "/"
4830 (substring (car pair) 2)))))
47afc068 4831 (setq file-arg-indices (cdr file-arg-indices))))
6750c852
RS
4832 (cond ((eq method 'identity)
4833 (car arguments))
ae3b2983 4834 ((eq method 'add)
6750c852 4835 (concat "/:" (apply operation arguments)))
ae3b2983
MA
4836 ((eq method 'quote)
4837 (prog1 (apply operation arguments)
4838 (setq buffer-file-name (concat "/:" buffer-file-name))))
4839 ((eq method 'unquote-then-quote)
4840 (let (res)
4841 (setq buffer-file-name (substring buffer-file-name 2))
4842 (setq res (apply operation arguments))
4843 (setq buffer-file-name (concat "/:" buffer-file-name))
4844 res))
6750c852
RS
4845 (t
4846 (apply operation arguments)))))
47afc068 4847\f
b4da00e9 4848(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
4849(define-key ctl-x-map "\C-r" 'find-file-read-only)
4850(define-key ctl-x-map "\C-v" 'find-alternate-file)
4851(define-key ctl-x-map "\C-s" 'save-buffer)
4852(define-key ctl-x-map "s" 'save-some-buffers)
4853(define-key ctl-x-map "\C-w" 'write-file)
4854(define-key ctl-x-map "i" 'insert-file)
4855(define-key esc-map "~" 'not-modified)
4856(define-key ctl-x-map "\C-d" 'list-directory)
4857(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
d758359d 4858(define-key ctl-x-map "\C-q" 'toggle-read-only)
b4da00e9
RM
4859
4860(define-key ctl-x-4-map "f" 'find-file-other-window)
4861(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
4862(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
4863(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 4864(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 4865
f98955ea
JB
4866(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
4867(define-key ctl-x-5-map "f" 'find-file-other-frame)
4868(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
4869(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38 4870
c3f6aa20 4871;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
c0274f38 4872;;; files.el ends here