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