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