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