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