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