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