Fix logic for returning to and yanking from Rmail buffer.
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
acaf905b 3;; Copyright (C) 1985-1987, 1992-2012 Free Software Foundation, Inc.
b4da00e9 4
3a801d0c 5;; Maintainer: FSF
bd78fa1d 6;; Package: emacs
3a801d0c 7
b4da00e9
RM
8;; This file is part of GNU Emacs.
9
eb3fa2cf 10;; GNU Emacs is free software: you can redistribute it and/or modify
b4da00e9 11;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
12;; the Free Software Foundation, either version 3 of the License, or
13;; (at your option) any later version.
b4da00e9
RM
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
eb3fa2cf 21;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
b4da00e9 22
e41b2db1
ER
23;;; Commentary:
24
44e97401 25;; Defines most of Emacs'ss file- and directory-handling functions,
e41b2db1
ER
26;; including basic file visiting, backup generation, link handling,
27;; ITS-id version control, load- and write-hook handling, and the like.
28
e5167999
ER
29;;; Code:
30
79f01fa7
JB
31(eval-when-compile (require 'cl))
32
26138670
JB
33(defvar font-lock-keywords)
34
21540597
RS
35(defgroup backup nil
36 "Backups of edited data files."
2a9fe1e2 37 :group 'files)
b4da00e9 38
21540597 39(defgroup find-file nil
2a9fe1e2
RS
40 "Finding files."
41 :group 'files)
21540597
RS
42
43
44(defcustom delete-auto-save-files t
ba83982b 45 "Non-nil means delete auto-save file when a buffer is saved or killed.
92631216 46
564af258 47Note that the auto-save file will not be deleted if the buffer is killed
92631216 48when it has unsaved changes."
21540597
RS
49 :type 'boolean
50 :group 'auto-save)
51
52(defcustom directory-abbrev-alist
b4da00e9 53 nil
ba83982b 54 "Alist of abbreviations for file directories.
b4da00e9
RM
55A list of elements of the form (FROM . TO), each meaning to replace
56FROM with TO when it appears in a directory name. This replacement is
57done when setting up the default directory of a newly visited file.
362b9d48
GM
58
59FROM is matched against directory names anchored at the first
60character, so it should start with a \"\\\\`\", or, if directory
61names cannot have embedded newlines, with a \"^\".
b4da00e9 62
4b690a83
RS
63FROM and TO should be equivalent names, which refer to the
64same directory. Do not use `~' in the TO strings;
65they should be ordinary absolute directory names.
65151a1b 66
b4da00e9
RM
67Use this feature when you have directories which you normally refer to
68via absolute symbolic links. Make TO the name of the link, and FROM
21540597
RS
69the name it is linked to."
70 :type '(repeat (cons :format "%v"
3fa0dc8f 71 :value ("\\`" . "")
21540597 72 (regexp :tag "From")
3fa0dc8f 73 (string :tag "To")))
21540597
RS
74 :group 'abbrev
75 :group 'find-file)
b4da00e9 76
7c2fb837 77(defcustom make-backup-files t
ba83982b 78 "Non-nil means make a backup of a file the first time it is saved.
b4da00e9
RM
79This can be done by renaming the file or by copying.
80
81Renaming means that Emacs renames the existing file so that it is a
82backup file, then writes the buffer into a new file. Any other names
83that the old file had will now refer to the backup file. The new file
84is owned by you and its group is defaulted.
85
86Copying means that Emacs copies the existing file into the backup
87file, then writes the buffer on top of the existing file. Any other
88names that the old file had will now refer to the new (edited) file.
89The file's owner and group are unchanged.
90
91The choice of renaming or copying is controlled by the variables
ffc0e1ca
AS
92`backup-by-copying', `backup-by-copying-when-linked',
93`backup-by-copying-when-mismatch' and
94`backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
21540597
RS
95 :type 'boolean
96 :group 'backup)
b4da00e9
RM
97
98;; Do this so that local variables based on the file name
99;; are not overridden by the major mode.
100(defvar backup-inhibited nil
f862241d
RS
101 "Non-nil means don't make a backup, regardless of the other parameters.
102This variable is intended for use by making it local to a buffer.
103But it is local only if you make it local.")
b4da00e9
RM
104(put 'backup-inhibited 'permanent-local t)
105
21540597 106(defcustom backup-by-copying nil
ba83982b 107 "Non-nil means always use copying to create backup files.
21540597 108See documentation of variable `make-backup-files'."
094eabe4
JB
109 :type 'boolean
110 :group 'backup)
b4da00e9 111
21540597 112(defcustom backup-by-copying-when-linked nil
ba83982b 113 "Non-nil means use copying to create backups for files with multiple names.
b4da00e9 114This causes the alternate names to refer to the latest version as edited.
21540597 115This variable is relevant only if `backup-by-copying' is nil."
094eabe4
JB
116 :type 'boolean
117 :group 'backup)
b4da00e9 118
e274eb13 119(defcustom backup-by-copying-when-mismatch t
ba83982b 120 "Non-nil means create backups by copying if this preserves owner or group.
b4da00e9
RM
121Renaming may still be used (subject to control of other variables)
122when it would not result in changing the owner or group of the file;
123that is, for files which are owned by you and whose group matches
124the default for a new file created there by you.
21540597 125This variable is relevant only if `backup-by-copying' is nil."
e274eb13 126 :version "24.1"
21540597
RS
127 :type 'boolean
128 :group 'backup)
6ce78fdc 129(put 'backup-by-copying-when-mismatch 'permanent-local t)
b4da00e9 130
ffc0e1ca 131(defcustom backup-by-copying-when-privileged-mismatch 200
ba83982b 132 "Non-nil means create backups by copying to preserve a privileged owner.
ffc0e1ca
AS
133Renaming may still be used (subject to control of other variables)
134when it would not result in changing the owner of the file or if the owner
135has a user id greater than the value of this variable. This is useful
136when low-numbered uid's are used for special system users (such as root)
137that must maintain ownership of certain files.
138This variable is relevant only if `backup-by-copying' and
139`backup-by-copying-when-mismatch' are nil."
140 :type '(choice (const nil) integer)
141 :group 'backup)
142
ffc0e1ca 143(defvar backup-enable-predicate 'normal-backup-enable-predicate
b4da00e9 144 "Predicate that looks at a file name and decides whether to make backups.
37193ee6 145Called with an absolute file name as argument, it returns t to enable backup.")
b4da00e9 146
21540597 147(defcustom buffer-offer-save nil
ba83982b 148 "Non-nil in a buffer means always offer to save buffer on exit.
ffc0e1ca 149Do so even if the buffer is not visiting a file.
21540597
RS
150Automatically local in all buffers."
151 :type 'boolean
152 :group 'backup)
b4da00e9 153(make-variable-buffer-local 'buffer-offer-save)
3ee3a1b5 154(put 'buffer-offer-save 'permanent-local t)
b4da00e9 155
21540597 156(defcustom find-file-existing-other-name t
ba83982b 157 "Non-nil means find a file under alternative names, in existing buffers.
f3e23606 158This means if any existing buffer is visiting the file you want
21540597
RS
159under another name, you get the existing buffer instead of a new buffer."
160 :type 'boolean
161 :group 'find-file)
f3e23606 162
21540597 163(defcustom find-file-visit-truename nil
09949b83 164 "Non-nil means visit a file under its truename.
f3e23606 165The truename of a file is found by chasing all links
21540597
RS
166both at the file level and at the levels of the containing directories."
167 :type 'boolean
168 :group 'find-file)
290c2be5 169(put 'find-file-visit-truename 'safe-local-variable 'booleanp)
f3e23606 170
26b9ecbc 171(defcustom revert-without-query nil
ba83982b 172 "Specify which files should be reverted without query.
ebeb898f
RS
173The value is a list of regular expressions.
174If the file name matches one of these regular expressions,
db8c4866 175then `revert-buffer' reverts the file without querying
21540597 176if the file has changed on disk and you have not edited the buffer."
a0d809f2 177 :type '(repeat regexp)
21540597 178 :group 'find-file)
ebeb898f 179
f3e23606
RS
180(defvar buffer-file-number nil
181 "The device number and file number of the file visited in the current buffer.
182The value is a list of the form (FILENUM DEVNUM).
183This pair of numbers uniquely identifies the file.
184If the buffer is visiting a new file, the value is nil.")
185(make-variable-buffer-local 'buffer-file-number)
186(put 'buffer-file-number 'permanent-local t)
187
de88363f 188(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
26b9ecbc 189 "Non-nil means that `buffer-file-number' uniquely identifies files.")
de88363f 190
e554eeb7
RS
191(defvar buffer-file-read-only nil
192 "Non-nil if visited file was read-only when visited.")
193(make-variable-buffer-local 'buffer-file-read-only)
194
388d6ab5 195(defcustom small-temporary-file-directory
eb61b61b
RS
196 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
197 "The directory for writing small temporary files.
198If non-nil, this directory is used instead of `temporary-file-directory'
199by programs that create small temporary files. This is for systems that
388d6ab5
RS
200have fast storage with limited space, such as a RAM disk."
201 :group 'files
adba8116 202 :initialize 'custom-initialize-delay
bab6eadb 203 :type '(choice (const nil) directory))
eb61b61b
RS
204
205;; The system null device. (Should reference NULL_DEVICE from C.)
a7610c52 206(defvar null-device (purecopy "/dev/null") "The system null device.")
eb61b61b 207
73e6adaa
DN
208(declare-function msdos-long-file-names "msdos.c")
209(declare-function w32-long-file-name "w32proc.c")
e8ffb999
DN
210(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
211(declare-function dired-unmark "dired" (arg))
212(declare-function dired-do-flagged-delete "dired" (&optional nomessage))
213(declare-function dos-8+3-filename "dos-fns" (filename))
e8ffb999 214(declare-function view-mode-disable "view" ())
7533b418 215(declare-function dosified-file-name "dos-fns" (file-name))
e8ffb999 216
30966847
EZ
217(defvar file-name-invalid-regexp
218 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
a7610c52 219 (purecopy
9959c16e 220 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
30966847 221 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
12f68d3f 222 "[\000-\037]\\|" ; control characters
30966847 223 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
a7610c52 224 "\\(/[^/.]+\\.[^/.]*\\.\\)"))) ; more than a single dot
c60ee5e7 225 ((memq system-type '(ms-dos windows-nt cygwin))
a7610c52 226 (purecopy
9959c16e 227 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
a7610c52
DN
228 "[|<>\"?*\000-\037]"))) ; invalid characters
229 (t (purecopy "[\000]")))
30966847
EZ
230 "Regexp recognizing file names which aren't allowed by the filesystem.")
231
21540597 232(defcustom file-precious-flag nil
ba83982b 233 "Non-nil means protect against I/O errors while saving files.
560f4415 234Some modes set this non-nil in particular buffers.
4b7271c1
KH
235
236This feature works by writing the new contents into a temporary file
237and then renaming the temporary file to replace the original.
238In this way, any I/O error in writing leaves the original untouched,
239and there is never any instant where the file is nonexistent.
240
241Note that this feature forces backups to be made by copying.
560f4415 242Yet, at the same time, saving a precious file
dab71b2c
KF
243breaks any hard links between it and other files.
244
245This feature is advisory: for example, if the directory in which the
622bdb51 246file is being saved is not writable, Emacs may ignore a non-nil value
1d367309
KF
247of `file-precious-flag' and write directly into the file.
248
249See also: `break-hardlink-on-save'."
21540597
RS
250 :type 'boolean
251 :group 'backup)
b4da00e9 252
1d367309
KF
253(defcustom break-hardlink-on-save nil
254 "Non-nil means when saving a file that exists under several names
76e7a7f0 255\(i.e., has multiple hardlinks), break the hardlink associated with
1d367309
KF
256`buffer-file-name' and write to a new file, so that the other
257instances of the file are not affected by the save.
258
259If `buffer-file-name' refers to a symlink, do not break the symlink.
260
261Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262For example, if the directory in which a file is being saved is not
622bdb51 263itself writable, then error instead of saving in some
1d367309
KF
264hardlink-nonbreaking way.
265
266See also `backup-by-copying' and `backup-by-copying-when-linked'."
267 :type 'boolean
76e7a7f0
JB
268 :group 'files
269 :version "23.1")
1d367309 270
21540597 271(defcustom version-control nil
ba83982b 272 "Control use of version numbers for backup files.
93e7eeb4
JB
273When t, make numeric backup versions unconditionally.
274When nil, make them for files that have some already.
275The value `never' means do not make them."
e48807d1
AS
276 :type '(choice (const :tag "Never" never)
277 (const :tag "If existing" nil)
278 (other :tag "Always" t))
21540597
RS
279 :group 'backup
280 :group 'vc)
e48335de 281(put 'version-control 'safe-local-variable
4f91a816 282 (lambda (x) (or (booleanp x) (equal x 'never))))
21540597
RS
283
284(defcustom dired-kept-versions 2
ba83982b 285 "When cleaning directory, number of versions to keep."
21540597
RS
286 :type 'integer
287 :group 'backup
288 :group 'dired)
289
290(defcustom delete-old-versions nil
ba83982b 291 "If t, delete excess backup versions silently.
21540597
RS
292If nil, ask confirmation. Any other value prevents any trimming."
293 :type '(choice (const :tag "Delete" t)
294 (const :tag "Ask" nil)
e48807d1 295 (other :tag "Leave" other))
21540597
RS
296 :group 'backup)
297
298(defcustom kept-old-versions 2
ba83982b 299 "Number of oldest versions to keep when a new numbered backup is made."
21540597
RS
300 :type 'integer
301 :group 'backup)
631c8020 302(put 'kept-old-versions 'safe-local-variable 'integerp)
21540597
RS
303
304(defcustom kept-new-versions 2
ba83982b 305 "Number of newest versions to keep when a new numbered backup is made.
21540597
RS
306Includes the new backup. Must be > 0"
307 :type 'integer
308 :group 'backup)
631c8020 309(put 'kept-new-versions 'safe-local-variable 'integerp)
b4da00e9 310
21540597 311(defcustom require-final-newline nil
ba83982b 312 "Whether to add a newline automatically at the end of the file.
f4206092
RS
313
314A value of t means do this only when the file is about to be saved.
315A value of `visit' means do this right after the file is visited.
316A value of `visit-save' means do it at both of those times.
317Any other non-nil value means ask user whether to add a newline, when saving.
756c496f 318A value of nil means don't add newlines.
f4206092
RS
319
320Certain major modes set this locally to the value obtained
321from `mode-require-final-newline'."
322 :type '(choice (const :tag "When visiting" visit)
323 (const :tag "When saving" t)
324 (const :tag "When visiting or saving" visit-save)
93d1963d 325 (const :tag "Don't add newlines" nil)
0776da52 326 (other :tag "Ask each time" ask))
21540597 327 :group 'editing-basics)
b4da00e9 328
f4206092 329(defcustom mode-require-final-newline t
ba83982b 330 "Whether to add a newline at end of file, in certain major modes.
f4206092 331Those modes set `require-final-newline' to this value when you enable them.
0776da52 332They do so because they are often used for files that are supposed
f4206092
RS
333to end in newlines, and the question is how to arrange that.
334
335A value of t means do this only when the file is about to be saved.
336A value of `visit' means do this right after the file is visited.
337A value of `visit-save' means do it at both of those times.
5e9961be 338Any other non-nil value means ask user whether to add a newline, when saving.
5e9961be 339
756c496f
JB
340A value of nil means do not add newlines. That is a risky choice in this
341variable since this value is used for modes for files that ought to have
342final newlines. So if you set this to nil, you must explicitly check and
343add a final newline, whenever you save a file that really needs one."
f4206092
RS
344 :type '(choice (const :tag "When visiting" visit)
345 (const :tag "When saving" t)
346 (const :tag "When visiting or saving" visit-save)
93d1963d
RS
347 (const :tag "Don't add newlines" nil)
348 (other :tag "Ask each time" ask))
f4206092 349 :group 'editing-basics
bf247b6e 350 :version "22.1")
f4206092 351
21540597 352(defcustom auto-save-default t
ba83982b 353 "Non-nil says by default do auto-saving of every file-visiting buffer."
21540597
RS
354 :type 'boolean
355 :group 'auto-save)
b4da00e9 356
ffc0e1ca 357(defcustom auto-save-file-name-transforms
b1e5937c 358 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
747981b0
EZ
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
a0b60c33 361 ,(concat temporary-file-directory "\\2") t))
ba83982b 362 "Transforms to apply to buffer file name before making auto-save file name.
a0b60c33 363Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
ffc0e1ca
AS
364REGEXP is a regular expression to match against the file name.
365If it matches, `replace-match' is used to replace the
366matching part with REPLACEMENT.
a0b60c33 367If the optional element UNIQUIFY is non-nil, the auto-save file name is
36236b72 368constructed by taking the directory part of the replaced file-name,
a0b60c33
GM
369concatenated with the buffer file name with all directory separators
370changed to `!' to prevent clashes. This will not work
371correctly if your filesystem truncates the resulting name.
372
ffc0e1ca
AS
373All the transforms in the list are tried, in the order they are listed.
374When one transform applies, its result is final;
375no further transforms are tried.
376
a2899d6c
KG
377The default value is set up to put the auto-save file into the
378temporary directory (see the variable `temporary-file-directory') for
a0b60c33
GM
379editing a remote file.
380
381On MS-DOS filesystems without long names this variable is always
382ignored."
ffc0e1ca 383 :group 'auto-save
a0b60c33
GM
384 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
385 (boolean :tag "Uniquify")))
adba8116 386 :initialize 'custom-initialize-delay
ffc0e1ca
AS
387 :version "21.1")
388
88b36776 389(defcustom save-abbrevs t
ba83982b 390 "Non-nil means save word abbrevs too when files are saved.
02c6a1cc
EZ
391If `silently', don't ask the user before saving."
392 :type '(choice (const t) (const nil) (const silently))
21540597 393 :group 'abbrev)
b4da00e9 394
21540597 395(defcustom find-file-run-dired t
ba83982b 396 "Non-nil means allow `find-file' to visit directories.
ffc0e1ca 397To visit the directory, `find-file' runs `find-directory-functions'."
21540597
RS
398 :type 'boolean
399 :group 'find-file)
b4da00e9 400
ffc0e1ca 401(defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
ba83982b 402 "List of functions to try in sequence to visit a directory.
ffc0e1ca
AS
403Each function is called with the directory name as the sole argument
404and should return either a buffer or nil."
405 :type '(hook :options (cvs-dired-noselect dired-noselect))
406 :group 'find-file)
407
7d371eac
JL
408;; FIXME: also add a hook for `(thing-at-point 'filename)'
409(defcustom file-name-at-point-functions '(ffap-guess-file-name-at-point)
410 "List of functions to try in sequence to get a file name at point.
411Each function should return either nil or a file name found at the
412location of point in the current buffer."
413 :type '(hook :options (ffap-guess-file-name-at-point))
414 :group 'find-file)
415
92966e6f
RS
416;;;It is not useful to make this a local variable.
417;;;(put 'find-file-not-found-hooks 'permanent-local t)
0370fe77 418(defvar find-file-not-found-functions nil
b4da00e9
RM
419 "List of functions to be called for `find-file' on nonexistent file.
420These functions are called as soon as the error is detected.
ffc0e1ca 421Variable `buffer-file-name' is already set up.
b4da00e9 422The functions are called in the order given until one of them returns non-nil.")
26b9ecbc
JB
423(define-obsolete-variable-alias 'find-file-not-found-hooks
424 'find-file-not-found-functions "22.1")
b4da00e9 425
92966e6f
RS
426;;;It is not useful to make this a local variable.
427;;;(put 'find-file-hooks 'permanent-local t)
cd6ef82d 428(define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
564af258 429(defcustom find-file-hook nil
b4da00e9
RM
430 "List of functions to be called after a buffer is loaded from a file.
431The buffer's local variables (if any) will have been processed before the
564af258
DL
432functions are called."
433 :group 'find-file
434 :type 'hook
435 :options '(auto-insert)
bf247b6e 436 :version "22.1")
b4da00e9 437
0370fe77 438(defvar write-file-functions nil
b4da00e9
RM
439 "List of functions to be called before writing out a buffer to a file.
440If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
441and the rest are not called.
442These hooks are considered to pertain to the visited file.
0370fe77
SM
443So any buffer-local binding of this variable is discarded if you change
444the visited file name with \\[set-visited-file-name], but not when you
445change the major mode.
446
0eb0202f
LT
447This hook is not run if any of the functions in
448`write-contents-functions' returns non-nil. Both hooks pertain
449to how to save a buffer to file, for instance, choosing a suitable
450coding system and setting mode bits. (See Info
451node `(elisp)Saving Buffers'.) To perform various checks or
26b9ecbc 452updates before the buffer is saved, use `before-save-hook'.")
0370fe77 453(put 'write-file-functions 'permanent-local t)
26b9ecbc 454(define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
0370fe77
SM
455
456(defvar local-write-file-hooks nil)
b19f1da4
BF
457(make-variable-buffer-local 'local-write-file-hooks)
458(put 'local-write-file-hooks 'permanent-local t)
bf247b6e 459(make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
8c0e7b73 460
0370fe77 461(defvar write-contents-functions nil
8c0e7b73
JB
462 "List of functions to be called before writing out a buffer to a file.
463If one of them returns non-nil, the file is considered already written
7dd11b37
LH
464and the rest are not called and neither are the functions in
465`write-file-functions'.
f82966e4
KH
466
467This variable is meant to be used for hooks that pertain to the
468buffer's contents, not to the particular visited file; thus,
469`set-visited-file-name' does not clear this variable; but changing the
693f800d
RS
470major mode does clear it.
471
0eb0202f
LT
472For hooks that _do_ pertain to the particular visited file, use
473`write-file-functions'. Both this variable and
474`write-file-functions' relate to how a buffer is saved to file.
475To perform various checks or updates before the buffer is saved,
476use `before-save-hook'.")
0370fe77 477(make-variable-buffer-local 'write-contents-functions)
26b9ecbc
JB
478(define-obsolete-variable-alias 'write-contents-hooks
479 'write-contents-functions "22.1")
b4da00e9 480
21540597 481(defcustom enable-local-variables t
ba83982b 482 "Control use of local variables in files you visit.
d355b270 483The value can be t, nil, :safe, :all, or something else.
5a6c1d87
CY
484
485A value of t means file local variables specifications are obeyed
a251756e
RS
486if all the specified variable values are safe; if any values are
487not safe, Emacs queries you, once, whether to set them all.
a5ce12c3
RS
488\(When you say yes to certain values, they are remembered as safe.)
489
490:safe means set the safe variables, and ignore the rest.
e58cec15
RS
491:all means set all variables, whether safe or not.
492 (Don't set it permanently to :all.)
756c496f 493A value of nil means always ignore the file local variables.
a251756e 494
a251756e 495Any other value means always query you once whether to set them all.
a5ce12c3
RS
496\(When you say yes to certain values, they are remembered as safe, but
497this has no effect when `enable-local-variables' is \"something else\".)
5a6c1d87 498
aa5fcebf
KH
499This variable also controls use of major modes specified in
500a -*- line.
b4da00e9 501
aa5fcebf
KH
502The command \\[normal-mode], when used interactively,
503always obeys file local variable specifications and the -*- line,
504and ignores this variable."
3029e594 505 :risky t
e58cec15 506 :type '(choice (const :tag "Query Unsafe" t)
a5ce12c3 507 (const :tag "Safe Only" :safe)
e58cec15 508 (const :tag "Do all" :all)
21540597 509 (const :tag "Ignore" nil)
e48807d1 510 (other :tag "Query" other))
21540597 511 :group 'find-file)
b4da00e9 512
7b447e9b
GM
513;; This is an odd variable IMO.
514;; You might wonder why it is needed, when we could just do:
515;; (set (make-local-variable 'enable-local-variables) nil)
516;; These two are not precisely the same.
517;; Setting this variable does not cause -*- mode settings to be
518;; ignored, whereas setting enable-local-variables does.
519;; Only three places in Emacs use this variable: tar and arc modes,
520;; and rmail. The first two don't need it. They already use
521;; inhibit-local-variables-regexps, which is probably enough, and
522;; could also just set enable-local-variables locally to nil.
523;; Them setting it has the side-effect that dir-locals cannot apply to
524;; eg tar files (?). FIXME Is this appropriate?
525;; AFAICS, rmail is the only thing that needs this, and the only
526;; reason it uses it is for BABYL files (which are obsolete).
527;; These contain "-*- rmail -*-" in the first line, which rmail wants
528;; to respect, so that find-file on a BABYL file will switch to
529;; rmail-mode automatically (this is nice, but hardly essential,
530;; since most people are used to explicitly running a command to
531;; access their mail; M-x gnus etc). Rmail files may happen to
532;; contain Local Variables sections in messages, which Rmail wants to
533;; ignore. So AFAICS the only reason this variable exists is for a
534;; minor convenience feature for handling of an obsolete Rmail file format.
da09b92b
RS
535(defvar local-enable-local-variables t
536 "Like `enable-local-variables' but meant for buffer-local bindings.
aa5fcebf 537The meaningful values are nil and non-nil. The default is non-nil.
da09b92b 538If a major mode sets this to nil, buffer-locally, then any local
7b447e9b 539variables list in a file visited in that mode will be ignored.
aa5fcebf 540
7b447e9b
GM
541This variable does not affect the use of major modes specified
542in a -*- line.")
da09b92b 543
21540597 544(defcustom enable-local-eval 'maybe
e442c62b 545 "Control processing of the \"variable\" `eval' in a file's local variables.
d207b766 546The value can be t, nil or something else.
8fc29035 547A value of t means obey `eval' variables.
756c496f 548A value of nil means ignore them; anything else means query."
3029e594 549 :risky t
21540597
RS
550 :type '(choice (const :tag "Obey" t)
551 (const :tag "Ignore" nil)
e48807d1 552 (other :tag "Query" other))
21540597 553 :group 'find-file)
b4da00e9
RM
554
555;; Avoid losing in versions where CLASH_DETECTION is disabled.
556(or (fboundp 'lock-buffer)
231c4e10 557 (defalias 'lock-buffer 'ignore))
b4da00e9 558(or (fboundp 'unlock-buffer)
231c4e10 559 (defalias 'unlock-buffer 'ignore))
a7305f6e
RS
560(or (fboundp 'file-locked-p)
561 (defalias 'file-locked-p 'ignore))
93fe0a35 562
cb211eb2 563(defcustom view-read-only nil
ba83982b 564 "Non-nil means buffers visiting files read-only do so in view mode.
4c91443d
RS
565In fact, this means that all read-only buffers normally have
566View mode enabled, including buffers that are read-only because
567you visit a file you cannot alter, and buffers you make read-only
568using \\[toggle-read-only]."
cb211eb2
SM
569 :type 'boolean
570 :group 'view)
2a9fe1e2 571
5c471b12 572(defvar file-name-history nil
426aa4f0
EZ
573 "History list of file names entered in the minibuffer.
574
575Maximum length of the history list is determined by the value
576of `history-length', which see.")
5c471b12 577\f
1aa8fe46 578(put 'ange-ftp-completion-hook-function 'safe-magic t)
93fe0a35 579(defun ange-ftp-completion-hook-function (op &rest args)
ffc0e1ca
AS
580 "Provides support for ange-ftp host name completion.
581Runs the usual ange-ftp hook, but only for completion operations."
582 ;; Having this here avoids the need to load ange-ftp when it's not
583 ;; really in use.
93fe0a35
RS
584 (if (memq op '(file-name-completion file-name-all-completions))
585 (apply 'ange-ftp-hook-function op args)
57e81f57
RS
586 (let ((inhibit-file-name-handlers
587 (cons 'ange-ftp-completion-hook-function
588 (and (eq inhibit-file-name-operation op)
589 inhibit-file-name-handlers)))
590 (inhibit-file-name-operation op))
93fe0a35 591 (apply op args))))
567c1ca9 592
98d8b17e
EZ
593(declare-function dos-convert-standard-filename "dos-fns.el" (filename))
594(declare-function w32-convert-standard-filename "w32-fns.el" (filename))
595
567c1ca9 596(defun convert-standard-filename (filename)
a576d8e2 597 "Convert a standard file's name to something suitable for the OS.
915b0bf0
JB
598This means to guarantee valid names and perhaps to canonicalize
599certain patterns.
600
f2430a0d
SM
601FILENAME should be an absolute file name since the conversion rules
602sometimes vary depending on the position in the file name. E.g. c:/foo
603is a valid DOS file name, but c:/bar/c:/foo is not.
604
915b0bf0
JB
605This function's standard definition is trivial; it just returns
606the argument. However, on Windows and DOS, replace invalid
18b28ef1
EZ
607characters. On DOS, make sure to obey the 8.3 limitations.
608In the native Windows build, turn Cygwin names into native names,
609and also turn slashes into backslashes if the shell requires it (see
a576d8e2
LT
610`w32-shell-dos-semantics').
611
612See Info node `(elisp)Standard File Names' for more details."
98d8b17e
EZ
613 (cond
614 ((eq system-type 'cygwin)
615 (let ((name (copy-sequence filename))
616 (start 0))
617 ;; Replace invalid filename characters with !
618 (while (string-match "[?*:<>|\"\000-\037]" name start)
619 (aset name (match-beginning 0) ?!)
620 (setq start (match-end 0)))
621 name))
622 ((eq system-type 'windows-nt)
623 (w32-convert-standard-filename filename))
624 ((eq system-type 'ms-dos)
625 (dos-convert-standard-filename filename))
626 (t filename)))
5d4d17b8
KS
627
628(defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
629 "Read directory name, prompting with PROMPT and completing in directory DIR.
630Value is not expanded---you must call `expand-file-name' yourself.
25802eac
LT
631Default name to DEFAULT-DIRNAME if user exits with the same
632non-empty string that was inserted by this function.
44dce0fb
RS
633 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
634 or just DIR if INITIAL is nil.)
25802eac
LT
635If the user exits with an empty minibuffer, this function returns
636an empty string. (This can only happen if the user erased the
637pre-inserted contents or if `insert-default-directory' is nil.)
5d4d17b8
KS
638Fourth arg MUSTMATCH non-nil means require existing directory's name.
639 Non-nil and non-t means also require confirmation after completion.
640Fifth arg INITIAL specifies text to start with.
25802eac
LT
641DIR should be an absolute directory name. It defaults to
642the value of `default-directory'."
5d4d17b8
KS
643 (unless dir
644 (setq dir default-directory))
54005870 645 (read-file-name prompt dir (or default-dirname
44dce0fb
RS
646 (if initial (expand-file-name initial dir)
647 dir))
648 mustmatch initial
5d4d17b8
KS
649 'file-directory-p))
650
b4da00e9
RM
651\f
652(defun pwd ()
653 "Show the current default directory."
654 (interactive nil)
655 (message "Directory %s" default-directory))
656
231c4e10
ER
657(defvar cd-path nil
658 "Value of the CDPATH environment variable, as a list.
9ee45b2c 659Not actually set up until the first time you use it.")
231c4e10 660
06b60517 661(defun parse-colon-path (search-path)
ae135939 662 "Explode a search path into a list of directory names.
c5994cfa
JB
663Directories are separated by occurrences of `path-separator'
664\(which is colon in GNU and GNU-like systems)."
ffc0e1ca 665 ;; We could use split-string here.
06b60517 666 (and search-path
818286f4 667 (let (cd-list (cd-start 0) cd-colon)
06b60517
JB
668 (setq search-path (concat search-path path-separator))
669 (while (setq cd-colon (string-match path-separator search-path cd-start))
231c4e10 670 (setq cd-list
9daefb36 671 (nconc cd-list
c52e4104
RS
672 (list (if (= cd-start cd-colon)
673 nil
674 (substitute-in-file-name
e33e80e4 675 (file-name-as-directory
06b60517 676 (substring search-path cd-start cd-colon)))))))
231c4e10
ER
677 (setq cd-start (+ cd-colon 1)))
678 cd-list)))
679
680(defun cd-absolute (dir)
30c5ce9c 681 "Change current directory to given absolute file name DIR."
f4a0f59b
RS
682 ;; Put the name into directory syntax now,
683 ;; because otherwise expand-file-name may give some bad results.
7c2fb837 684 (setq dir (file-name-as-directory dir))
7201bfbb
SM
685 ;; We used to additionally call abbreviate-file-name here, for an
686 ;; unknown reason. Problem is that most buffers are setup
687 ;; without going through cd-absolute and don't call
688 ;; abbreviate-file-name on their default-directory, so the few that
689 ;; do end up using a superficially different directory.
690 (setq dir (expand-file-name dir))
b4da00e9 691 (if (not (file-directory-p dir))
83c6f446
RS
692 (if (file-exists-p dir)
693 (error "%s is not a directory" dir)
31c691c1 694 (error "%s: no such directory" dir))
cfef87ad
TTN
695 (unless (file-executable-p dir)
696 (error "Cannot cd to %s: Permission denied" dir))
697 (setq default-directory dir)
11ee8d90 698 (setq list-buffers-directory dir)))
b4da00e9 699
231c4e10
ER
700(defun cd (dir)
701 "Make DIR become the current buffer's default directory.
ae135939
JB
702If your environment includes a `CDPATH' variable, try each one of
703that list of directories (separated by occurrences of
c5994cfa
JB
704`path-separator') when resolving a relative directory name.
705The path separator is colon in GNU and GNU-like systems."
dac4ea74 706 (interactive
aa56f361
SM
707 (list
708 ;; FIXME: There's a subtle bug in the completion below. Seems linked
709 ;; to a fundamental difficulty of implementing `predicate' correctly.
710 ;; The manifestation is that TAB may list non-directories in the case where
711 ;; those files also correspond to valid directories (if your cd-path is (A/
712 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
713 ;; will be listed as valid completions).
714 ;; This is because `a' (listed because of A/a) is indeed a valid choice
715 ;; (which will lead to the use of B/a).
716 (minibuffer-with-setup-hook
717 (lambda ()
718 (setq minibuffer-completion-table
719 (apply-partially #'locate-file-completion-table
720 cd-path nil))
721 (setq minibuffer-completion-predicate
722 (lambda (dir)
723 (locate-file dir cd-path nil
724 (lambda (f) (and (file-directory-p f) 'dir-ok))))))
725 (unless cd-path
726 (setq cd-path (or (parse-colon-path (getenv "CDPATH"))
727 (list "./"))))
728 (read-directory-name "Change default directory: "
729 default-directory default-directory
730 t))))
731 (unless cd-path
732 (setq cd-path (or (parse-colon-path (getenv "CDPATH"))
733 (list "./"))))
734 (cd-absolute
735 (or (locate-file dir cd-path nil
736 (lambda (f) (and (file-directory-p f) 'dir-ok)))
737 (error "No such directory found via CDPATH environment variable"))))
231c4e10 738
b4da00e9
RM
739(defun load-file (file)
740 "Load the Lisp file named FILE."
58195faa
DL
741 ;; This is a case where .elc makes a lot of sense.
742 (interactive (list (let ((completion-ignored-extensions
9ab80679 743 (remove ".elc" completion-ignored-extensions)))
58195faa
DL
744 (read-file-name "Load file: "))))
745 (load (expand-file-name file) nil nil t))
b4da00e9 746
38eea7c7
SM
747(defun locate-file (filename path &optional suffixes predicate)
748 "Search for FILENAME through PATH.
c7c4bc11
EZ
749If found, return the absolute file name of FILENAME, with its suffixes;
750otherwise return nil.
751PATH should be a list of directories to look in, like the lists in
752`exec-path' or `load-path'.
38eea7c7
SM
753If SUFFIXES is non-nil, it should be a list of suffixes to append to
754file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
c7c4bc11 755Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
38eea7c7 756If non-nil, PREDICATE is used instead of `file-readable-p'.
aa56f361
SM
757
758This function will normally skip directories, so if you want it to find
759directories, make sure the PREDICATE function returns `dir-ok' for them.
760
e6f0ff92
RS
761PREDICATE can also be an integer to pass to the `access' system call,
762in which case file-name handlers are ignored. This usage is deprecated.
e6f0ff92
RS
763For compatibility, PREDICATE can also be one of the symbols
764`executable', `readable', `writable', or `exists', or a list of
765one or more of those symbols."
38eea7c7
SM
766 (if (and predicate (symbolp predicate) (not (functionp predicate)))
767 (setq predicate (list predicate)))
768 (when (and (consp predicate) (not (functionp predicate)))
769 (setq predicate
770 (logior (if (memq 'executable predicate) 1 0)
771 (if (memq 'writable predicate) 2 0)
772 (if (memq 'readable predicate) 4 0))))
773 (locate-file-internal filename path suffixes predicate))
774
e8dab975
SM
775(defun locate-file-completion-table (dirs suffixes string pred action)
776 "Do completion for file names passed to `locate-file'."
df120481
SM
777 (cond
778 ((file-name-absolute-p string)
528c56e2
SM
779 ;; FIXME: maybe we should use completion-file-name-table instead,
780 ;; tho at least for `load', the arg is passed through
781 ;; substitute-in-file-name for historical reasons.
782 (read-file-name-internal string pred action))
df120481
SM
783 ((eq (car-safe action) 'boundaries)
784 (let ((suffix (cdr action)))
79f01fa7 785 (list* 'boundaries
df120481
SM
786 (length (file-name-directory string))
787 (let ((x (file-name-directory suffix)))
788 (if x (1- (length x)) (length suffix))))))
789 (t
118cf454
SM
790 (let ((names '())
791 ;; If we have files like "foo.el" and "foo.elc", we could load one of
792 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
793 ;; preferred way. So if we list all 3, that gives a lot of redundant
794 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
795 ;; the user does want to pay attention to the extension. We try to
796 ;; diffuse this tension by stripping the suffix, except when the
797 ;; result is a single element (i.e. usually we only list "foo" unless
798 ;; it's the only remaining element in the list, in which case we do
799 ;; list "foo", "foo.elc" and "foo.el").
800 (fullnames '())
e8dab975 801 (suffix (concat (regexp-opt suffixes t) "\\'"))
df120481
SM
802 (string-dir (file-name-directory string))
803 (string-file (file-name-nondirectory string)))
e8dab975 804 (dolist (dir dirs)
118cf454
SM
805 (unless dir
806 (setq dir default-directory))
807 (if string-dir (setq dir (expand-file-name string-dir dir)))
808 (when (file-directory-p dir)
809 (dolist (file (file-name-all-completions
810 string-file dir))
811 (if (not (string-match suffix file))
812 (push file names)
813 (push file fullnames)
814 (push (substring file 0 (match-beginning 0)) names)))))
815 ;; Switching from names to names+fullnames creates a non-monotonicity
816 ;; which can cause problems with things like partial-completion.
817 ;; To minimize the problem, filter out completion-regexp-list, so that
43f964fc
SM
818 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
819 ;; from `names' which only matched `string' when they still had
820 ;; their suffix.
821 (setq names (all-completions string names))
118cf454
SM
822 ;; Remove duplicates of the first element, so that we can easily check
823 ;; if `names' really only contains a single element.
824 (when (cdr names) (setcdr names (delete (car names) (cdr names))))
825 (unless (cdr names)
826 ;; There's no more than one matching non-suffixed element, so expand
827 ;; the list by adding the suffixed elements as well.
828 (setq names (nconc names fullnames)))
df120481
SM
829 (completion-table-with-context
830 string-dir names string-file pred action)))))
e8dab975
SM
831
832(defun locate-file-completion (string path-and-suffixes action)
833 "Do completion for file names passed to `locate-file'.
834PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
835 (locate-file-completion-table (car path-and-suffixes)
836 (cdr path-and-suffixes)
837 string nil action))
838(make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
2c3d8820 839
8cd56959 840(defvar locate-dominating-stop-dir-regexp
a7610c52 841 (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
8cd56959
SM
842 "Regexp of directory names which stop the search in `locate-dominating-file'.
843Any directory whose name matches this regexp will be treated like
844a kind of root directory by `locate-dominating-file' which will stop its search
845when it bumps into it.
846The default regexp prevents fruitless and time-consuming attempts to find
48981b8b
JR
847special files in directories in which filenames are interpreted as hostnames,
848or mount points potentially requiring authentication as a different user.")
8cd56959
SM
849
850;; (defun locate-dominating-files (file regexp)
851;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
852;; Stop at the first parent where a matching file is found and return the list
853;; of files that that match in this directory."
854;; (catch 'found
855;; ;; `user' is not initialized yet because `file' may not exist, so we may
856;; ;; have to walk up part of the hierarchy before we find the "initial UID".
857;; (let ((user nil)
858;; ;; Abbreviate, so as to stop when we cross ~/.
859;; (dir (abbreviate-file-name (file-name-as-directory file)))
860;; files)
861;; (while (and dir
862;; ;; As a heuristic, we stop looking up the hierarchy of
863;; ;; directories as soon as we find a directory belonging to
864;; ;; another user. This should save us from looking in
865;; ;; things like /net and /afs. This assumes that all the
866;; ;; files inside a project belong to the same user.
867;; (let ((prev-user user))
868;; (setq user (nth 2 (file-attributes dir)))
869;; (or (null prev-user) (equal user prev-user))))
870;; (if (setq files (condition-case nil
871;; (directory-files dir 'full regexp 'nosort)
872;; (error nil)))
873;; (throw 'found files)
874;; (if (equal dir
875;; (setq dir (file-name-directory
876;; (directory-file-name dir))))
877;; (setq dir nil))))
878;; nil)))
879
9a40b8d4 880(defun locate-dominating-file (file name)
8cd56959 881 "Look up the directory hierarchy from FILE for a file named NAME.
09949b83 882Stop at the first parent directory containing a file NAME,
eb182446
GM
883and return the directory. Return nil if not found.
884
9a40b8d4
GM
885This function only tests if FILE exists. If you care about whether
886it is readable, regular, etc., you should test the result."
8cd56959
SM
887 ;; We used to use the above locate-dominating-files code, but the
888 ;; directory-files call is very costly, so we're much better off doing
889 ;; multiple calls using the code in here.
09949b83 890 ;;
8cd56959
SM
891 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
892 ;; `name' in /home or in /.
893 (setq file (abbreviate-file-name file))
894 (let ((root nil)
8cd56959
SM
895 ;; `user' is not initialized outside the loop because
896 ;; `file' may not exist, so we may have to walk up part of the
06b60517
JB
897 ;; hierarchy before we find the "initial UID". Note: currently unused
898 ;; (user nil)
8cd56959
SM
899 try)
900 (while (not (or root
901 (null file)
902 ;; FIXME: Disabled this heuristic because it is sometimes
903 ;; inappropriate.
904 ;; As a heuristic, we stop looking up the hierarchy of
905 ;; directories as soon as we find a directory belonging
906 ;; to another user. This should save us from looking in
907 ;; things like /net and /afs. This assumes that all the
908 ;; files inside a project belong to the same user.
909 ;; (let ((prev-user user))
910 ;; (setq user (nth 2 (file-attributes file)))
911 ;; (and prev-user (not (equal user prev-user))))
912 (string-match locate-dominating-stop-dir-regexp file)))
9a40b8d4
GM
913 ;; FIXME? maybe this function should (optionally?)
914 ;; use file-readable-p instead. In many cases, an unreadable
915 ;; FILE is no better than a non-existent one.
916 ;; See eg dir-locals-find-file.
917 (setq try (file-exists-p (expand-file-name name file)))
8cd56959 918 (cond (try (setq root file))
06b60517 919 ((equal file (setq file (file-name-directory
8cd56959
SM
920 (directory-file-name file))))
921 (setq file nil))))
922 root))
923
418fd375 924
c3f6aa20
SM
925(defun executable-find (command)
926 "Search for COMMAND in `exec-path' and return the absolute file name.
927Return nil if COMMAND is not found anywhere in `exec-path'."
928 ;; Use 1 rather than file-executable-p to better match the behavior of
929 ;; call-process.
930 (locate-file command exec-path exec-suffixes 1))
931
b4da00e9 932(defun load-library (library)
0a56bf8c 933 "Load the Emacs Lisp library named LIBRARY.
9d73a99e
CY
934This is an interface to the function `load'. LIBRARY is searched
935for in `load-path', both with and without `load-suffixes' (as
936well as `load-file-rep-suffixes').
937
938See Info node `(emacs)Lisp Libraries' for more details.
939See `load-file' for a different interface to `load'."
38eea7c7
SM
940 (interactive
941 (list (completing-read "Load library: "
e8dab975
SM
942 (apply-partially 'locate-file-completion-table
943 load-path
944 (get-load-suffixes)))))
b4da00e9 945 (load library))
5d68c2c2 946
ac25542d 947(defun file-remote-p (file &optional identification connected)
3f788773 948 "Test whether FILE specifies a location on a remote system.
bace743a
DA
949A file is considered remote if accessing it is likely to
950be slower or less reliable than accessing local files.
951
952`file-remote-p' never opens a new remote connection. It can
953only reuse a connection that is already open.
954
955Return nil or a string identifying the remote connection
956\(ideally a prefix of FILE). Return nil if FILE is a relative
957file name.
958
959When IDENTIFICATION is nil, the returned string is a complete
960remote identifier: with components method, user, and host. The
961components are those present in FILE, with defaults filled in for
962any that are missing.
963
964IDENTIFICATION can specify which part of the identification to
965return. IDENTIFICATION can be the symbol `method', `user',
966`host', or `localname'. Any other value is handled like nil and
967means to return the complete identification. The string returned
968for IDENTIFICATION `localname' can differ depending on whether
969there is an existing connection.
970
971If CONNECTED is non-nil, return an identification only if FILE is
972located on a remote system and a connection is established to
973that remote system.
974
975Tip: You can use this expansion of remote identifier components
976 to derive a new remote file name from an existing one. For
977 example, if FILE is \"/sudo::/path/to/file\" then
978
979 \(concat \(file-remote-p FILE) \"/bin/sh\")
980
981 returns a remote file name for file \"/bin/sh\" that has the
982 same remote identifier as FILE but expanded; a name such as
983 \"/sudo:root@myhost:/bin/sh\"."
04621aaa 984 (let ((handler (find-file-name-handler file 'file-remote-p)))
ff7affeb 985 (if handler
ac25542d 986 (funcall handler 'file-remote-p file identification connected)
04621aaa 987 nil)))
ff7affeb 988
4bc3c53d
MA
989(defcustom remote-file-name-inhibit-cache 10
990 "Whether to use the remote file-name cache for read access.
b011fbfe
GM
991When `nil', never expire cached values (caution)
992When `t', never use the cache (safe, but may be slow)
993A number means use cached values for that amount of seconds since caching.
994
995The attributes of remote files are cached for better performance.
996If they are changed outside of Emacs's control, the cached values
997become invalid, and must be reread. If you are sure that nothing
998other than Emacs changes the files, you can set this variable to `nil'.
999
1000If a remote file is checked regularly, it might be a good idea to
1001let-bind this variable to a value less than the interval between
1002consecutive checks. For example:
4bc3c53d 1003
06b60517
JB
1004 (defun display-time-file-nonempty-p (file)
1005 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1006 (and (file-exists-p file)
1007 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
4bc3c53d
MA
1008 :group 'files
1009 :version "24.1"
1010 :type `(choice
1011 (const :tag "Do not inhibit file name cache" nil)
1012 (const :tag "Do not use file name cache" t)
1013 (integer :tag "Do not use file name cache"
1014 :format "Do not use file name cache older then %v seconds"
1015 :value 10)))
1016
ffc0e1ca 1017(defun file-local-copy (file)
5d68c2c2
RS
1018 "Copy the file FILE into a temporary file on this machine.
1019Returns the name of the local copy, or nil, if FILE is directly
1020accessible."
ffc0e1ca
AS
1021 ;; This formerly had an optional BUFFER argument that wasn't used by
1022 ;; anything.
6eaebaa2 1023 (let ((handler (find-file-name-handler file 'file-local-copy)))
5d68c2c2
RS
1024 (if handler
1025 (funcall handler 'file-local-copy file)
1026 nil)))
f3e23606 1027
05ef1cda 1028(defun file-truename (filename &optional counter prev-dirs)
06083aa1
GM
1029 "Return the truename of FILENAME.
1030If FILENAME is not absolute, first expands it against `default-directory'.
f3e23606
RS
1031The truename of a file name is found by chasing symbolic links
1032both at the level of the file and at the level of the directories
05ef1cda
RS
1033containing it, until no links are left at any level.
1034
89bf74f8 1035\(fn FILENAME)" ;; Don't document the optional arguments.
b9963e32
JB
1036 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1037 ;; COUNTER can be a cons cell whose car is the count of how many
1038 ;; more links to chase before getting an error.
05ef1cda
RS
1039 ;; PREV-DIRS can be a cons cell whose car is an alist
1040 ;; of truenames we've just recently computed.
f2440e42
RS
1041 (cond ((or (string= filename "") (string= filename "~"))
1042 (setq filename (expand-file-name filename))
1043 (if (string= filename "")
1044 (setq filename "/")))
1045 ((and (string= (substring filename 0 1) "~")
1046 (string-match "~[^/]*/?" filename))
1047 (let ((first-part
1048 (substring filename 0 (match-end 0)))
1049 (rest (substring filename (match-end 0))))
1050 (setq filename (concat (expand-file-name first-part) rest)))))
1051
05ef1cda 1052 (or counter (setq counter (list 100)))
b505828b
RS
1053 (let (done
1054 ;; For speed, remove the ange-ftp completion handler from the list.
1055 ;; We know it's not needed here.
1056 ;; For even more speed, do this only on the outermost call.
1057 (file-name-handler-alist
1058 (if prev-dirs file-name-handler-alist
1059 (let ((tem (copy-sequence file-name-handler-alist)))
1060 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
1061 (or prev-dirs (setq prev-dirs (list nil)))
b1667e6c
GV
1062
1063 ;; andrewi@harlequin.co.uk - none of the following code (except for
1064 ;; invoking the file-name handler) currently applies on Windows
1065 ;; (ie. there are no native symlinks), but there is an issue with
1066 ;; case differences being ignored by the OS, and short "8.3 DOS"
1067 ;; name aliases existing for all files. (The short names are not
1068 ;; reported by directory-files, but can be used to refer to files.)
1069 ;; It seems appropriate for file-truename to resolve these issues in
1070 ;; the most natural way, which on Windows is to call the function
1071 ;; `w32-long-file-name' - this returns the exact name of a file as
1072 ;; it is stored on disk (expanding short name aliases with the full
1073 ;; name in the process).
1074 (if (eq system-type 'windows-nt)
06dd5ef7 1075 (let ((handler (find-file-name-handler filename 'file-truename)))
b1667e6c
GV
1076 ;; For file name that has a special handler, call handler.
1077 ;; This is so that ange-ftp can save time by doing a no-op.
1078 (if handler
1079 (setq filename (funcall handler 'file-truename filename))
1080 ;; If filename contains a wildcard, newname will be the old name.
06dd5ef7 1081 (unless (string-match "[[*?]" filename)
85d181e1
JR
1082 ;; If filename exists, use the long name. If it doesn't exist,
1083 ;; drill down until we find a directory that exists, and use
1084 ;; the long name of that, with the extra non-existent path
1085 ;; components concatenated.
1086 (let ((longname (w32-long-file-name filename))
1087 missing rest)
1088 (if longname
1089 (setq filename longname)
35e3abe5 1090 ;; Include the preceding directory separator in the missing
85d181e1
JR
1091 ;; part so subsequent recursion on the rest works.
1092 (setq missing (concat "/" (file-name-nondirectory filename)))
35e3abe5
MR
1093 (let ((length (length missing)))
1094 (setq rest
1095 (if (> length (length filename))
1096 ""
1097 (substring filename 0 (- length)))))
85d181e1 1098 (setq filename (concat (file-truename rest) missing))))))
b1667e6c
GV
1099 (setq done t)))
1100
05ef1cda
RS
1101 ;; If this file directly leads to a link, process that iteratively
1102 ;; so that we don't use lots of stack.
1103 (while (not done)
1104 (setcar counter (1- (car counter)))
1105 (if (< (car counter) 0)
1106 (error "Apparent cycle of symbolic links for %s" filename))
1107 (let ((handler (find-file-name-handler filename 'file-truename)))
1108 ;; For file name that has a special handler, call handler.
1109 ;; This is so that ange-ftp can save time by doing a no-op.
1110 (if handler
1111 (setq filename (funcall handler 'file-truename filename)
1112 done t)
fb145562 1113 (let ((dir (or (file-name-directory filename) default-directory))
05ef1cda
RS
1114 target dirfile)
1115 ;; Get the truename of the directory.
1116 (setq dirfile (directory-file-name dir))
1117 ;; If these are equal, we have the (or a) root directory.
1118 (or (string= dir dirfile)
1119 ;; If this is the same dir we last got the truename for,
1120 ;; save time--don't recalculate.
1121 (if (assoc dir (car prev-dirs))
1122 (setq dir (cdr (assoc dir (car prev-dirs))))
1123 (let ((old dir)
1124 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
1125 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
1126 (setq dir new))))
1127 (if (equal ".." (file-name-nondirectory filename))
1128 (setq filename
1129 (directory-file-name (file-name-directory (directory-file-name dir)))
1130 done t)
1131 (if (equal "." (file-name-nondirectory filename))
1132 (setq filename (directory-file-name dir)
1133 done t)
1134 ;; Put it back on the file name.
1135 (setq filename (concat dir (file-name-nondirectory filename)))
1136 ;; Is the file name the name of a link?
1137 (setq target (file-symlink-p filename))
1138 (if target
1139 ;; Yes => chase that link, then start all over
1140 ;; since the link may point to a directory name that uses links.
1141 ;; We can't safely use expand-file-name here
1142 ;; since target might look like foo/../bar where foo
1143 ;; is itself a link. Instead, we handle . and .. above.
1144 (setq filename
1145 (if (file-name-absolute-p target)
1146 target
1147 (concat dir target))
1148 done nil)
1149 ;; No, we are done!
1150 (setq done t))))))))
1151 filename))
5dbfdacd 1152
302fcc98 1153(defun file-chase-links (filename &optional limit)
5dadeb29 1154 "Chase links in FILENAME until a name that is not a link.
302fcc98
RS
1155Unlike `file-truename', this does not check whether a parent
1156directory name is a symbolic link.
1157If the optional argument LIMIT is a number,
1158it means chase no more than that many links and then stop."
1159 (let (tem (newname filename)
92464ae6 1160 (count 0))
302fcc98
RS
1161 (while (and (or (null limit) (< count limit))
1162 (setq tem (file-symlink-p newname)))
9695aac6 1163 (save-match-data
92464ae6 1164 (if (and (null limit) (= count 100))
9695aac6
RS
1165 (error "Apparent cycle of symbolic links for %s" filename))
1166 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1167 (while (string-match "//+" tem)
1168 (setq tem (replace-match "/" nil nil tem)))
1169 ;; Handle `..' by hand, since it needs to work in the
1170 ;; target of any directory symlink.
1171 ;; This code is not quite complete; it does not handle
1172 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1173 (while (string-match "\\`\\.\\./" tem)
1174 (setq tem (substring tem 3))
1175 (setq newname (expand-file-name newname))
1176 ;; Chase links in the default dir of the symlink.
1177 (setq newname
1178 (file-chase-links
1179 (directory-file-name (file-name-directory newname))))
1180 ;; Now find the parent of that dir.
1181 (setq newname (file-name-directory newname)))
1182 (setq newname (expand-file-name tem (file-name-directory newname)))
92464ae6 1183 (setq count (1+ count))))
5dadeb29 1184 newname))
9bdbd98e 1185
e3971c44
EZ
1186;; A handy function to display file sizes in human-readable form.
1187;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1188(defun file-size-human-readable (file-size &optional flavor)
1189 "Produce a string showing FILE-SIZE in human-readable form.
1190
1191Optional second argument FLAVOR controls the units and the display format:
1192
1193 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1194 suffixes are \"k\", \"M\", \"G\", \"T\", etc.
1195 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1196 are \"k\", \"M\", \"G\", \"T\", etc.
1197 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1198 are \"KiB\", \"MiB\", \"GiB\", \"TiB\", etc."
1199 (let ((power (if (or (null flavor) (eq flavor 'iec))
1200 1024.0
1201 1000.0))
1202 (post-fixes
1203 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1204 (list "" "k" "M" "G" "T" "P" "E" "Z" "Y")))
1205 (while (and (>= file-size power) (cdr post-fixes))
1206 (setq file-size (/ file-size power)
1207 post-fixes (cdr post-fixes)))
04f33f1e
EZ
1208 (format (if (> (mod file-size 1.0) 0.05)
1209 "%.1f%s%s"
1210 "%.0f%s%s")
1211 file-size
e3971c44
EZ
1212 (if (and (eq flavor 'iec) (string= (car post-fixes) "k"))
1213 "K"
1214 (car post-fixes))
1215 (if (eq flavor 'iec) "iB" ""))))
1216
9e8bb7f7
RS
1217(defun make-temp-file (prefix &optional dir-flag suffix)
1218 "Create a temporary file.
1219The returned file name (created by appending some random characters at the end
1220of PREFIX, and expanding against `temporary-file-directory' if necessary),
1221is guaranteed to point to a newly created empty file.
1222You can then use `write-region' to write new data into the file.
1223
1224If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1225
1226If SUFFIX is non-nil, add that at the end of the file name."
1227 (let ((umask (default-file-modes))
1228 file)
1229 (unwind-protect
1230 (progn
1231 ;; Create temp files with strict access rights. It's easy to
1232 ;; loosen them later, whereas it's impossible to close the
1233 ;; time-window of loose permissions otherwise.
1234 (set-default-file-modes ?\700)
1235 (while (condition-case ()
1236 (progn
1237 (setq file
1238 (make-temp-name
f8dce815
GM
1239 (if (zerop (length prefix))
1240 (file-name-as-directory
1241 temporary-file-directory)
1242 (expand-file-name prefix
1243 temporary-file-directory))))
9e8bb7f7
RS
1244 (if suffix
1245 (setq file (concat file suffix)))
1246 (if dir-flag
1247 (make-directory file)
1248 (write-region "" nil file nil 'silent nil 'excl))
1249 nil)
1250 (file-already-exists t))
1251 ;; the file was somehow created by someone else between
1252 ;; `make-temp-name' and `write-region', let's try again.
1253 nil)
1254 file)
1255 ;; Reset the umask.
1256 (set-default-file-modes umask))))
1257
9bdbd98e
KH
1258(defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1259 "Change the encoding of FILE's name from CODING to NEW-CODING.
1260The value is a new name of FILE.
1261Signals a `file-already-exists' error if a file of the new name
26b9ecbc
JB
1262already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1263is non-nil. A number as fourth arg means request confirmation if
9bdbd98e
KH
1264the new name already exists. This is what happens in interactive
1265use with M-x."
1266 (interactive
1267 (let ((default-coding (or file-name-coding-system
1268 default-file-name-coding-system))
1269 (filename (read-file-name "Recode filename: " nil nil t))
1270 from-coding to-coding)
1271 (if (and default-coding
1272 ;; We provide the default coding only when it seems that
1273 ;; the filename is correctly decoded by the default
1274 ;; coding.
1275 (let ((charsets (find-charset-string filename)))
1276 (and (not (memq 'eight-bit-control charsets))
1277 (not (memq 'eight-bit-graphic charsets)))))
1278 (setq from-coding (read-coding-system
1279 (format "Recode filename %s from (default %s): "
1280 filename default-coding)
1281 default-coding))
1282 (setq from-coding (read-coding-system
1283 (format "Recode filename %s from: " filename))))
cdec2ad7 1284
9bdbd98e
KH
1285 ;; We provide the default coding only when a user is going to
1286 ;; change the encoding not from the default coding.
1287 (if (eq from-coding default-coding)
1288 (setq to-coding (read-coding-system
1289 (format "Recode filename %s from %s to: "
1290 filename from-coding)))
1291 (setq to-coding (read-coding-system
1292 (format "Recode filename %s from %s to (default %s): "
1293 filename from-coding default-coding)
1294 default-coding)))
1295 (list filename from-coding to-coding)))
1296
1297 (let* ((default-coding (or file-name-coding-system
1298 default-file-name-coding-system))
1299 ;; FILE should have been decoded by DEFAULT-CODING.
1300 (encoded (encode-coding-string file default-coding))
1301 (newname (decode-coding-string encoded coding))
1302 (new-encoded (encode-coding-string newname new-coding))
1303 ;; Suppress further encoding.
1304 (file-name-coding-system nil)
1305 (default-file-name-coding-system nil)
1306 (locale-coding-system nil))
1307 (rename-file encoded new-encoded ok-if-already-exists)
1308 newname))
b4da00e9 1309\f
4a977e20
CY
1310(defcustom confirm-nonexistent-file-or-buffer 'after-completion
1311 "Whether confirmation is requested before visiting a new file or buffer.
1312If nil, confirmation is not requested.
1313If the value is `after-completion', confirmation is only
1314 requested if the user called `minibuffer-complete' right before
1315 `minibuffer-complete-and-exit'.
1316Any other non-nil value means to request confirmation.
1317
35b05a77
SM
1318This affects commands like `switch-to-buffer' and `find-file'."
1319 :group 'find-file
1320 :version "23.1"
b61324c3
GM
1321 :type '(choice (const :tag "After completion" after-completion)
1322 (const :tag "Never" nil)
1323 (other :tag "Always" t)))
4a977e20
CY
1324
1325(defun confirm-nonexistent-file-or-buffer ()
1326 "Whether to request confirmation before visiting a new file or buffer.
1327The variable `confirm-nonexistent-file-or-buffer' determines the
1328return value, which may be passed as the REQUIRE-MATCH arg to
1329`read-buffer' or `find-file-read-args'."
1330 (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion)
1331 'confirm-after-completion)
1332 (confirm-nonexistent-file-or-buffer
1333 'confirm)
1334 (t nil)))
35b05a77 1335
a42e7db0 1336(defmacro minibuffer-with-setup-hook (fun &rest body)
9bbe0828 1337 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
a42e7db0 1338BODY should use the minibuffer at most once.
9bbe0828
CY
1339Recursive uses of the minibuffer are unaffected (FUN is not
1340called additional times).
1341
4963739e 1342This macro actually adds an auxiliary function that calls FUN,
9bbe0828 1343rather than FUN itself, to `minibuffer-setup-hook'."
a42e7db0
SM
1344 (declare (indent 1) (debug t))
1345 (let ((hook (make-symbol "setup-hook")))
44dce0fb
RS
1346 `(let (,hook)
1347 (setq ,hook
1348 (lambda ()
1349 ;; Clear out this hook so it does not interfere
1350 ;; with any recursive minibuffer usage.
1351 (remove-hook 'minibuffer-setup-hook ,hook)
2bd49e46 1352 (funcall ,fun)))
a42e7db0
SM
1353 (unwind-protect
1354 (progn
1355 (add-hook 'minibuffer-setup-hook ,hook)
1356 ,@body)
1357 (remove-hook 'minibuffer-setup-hook ,hook)))))
1358
05a7cb3d 1359(defun find-file-read-args (prompt mustmatch)
7d371eac 1360 (list (read-file-name prompt nil default-directory mustmatch)
b2a26f4e 1361 t))
e6f0ff92 1362
243ce842 1363(defun find-file (filename &optional wildcards)
b4da00e9
RM
1364 "Edit file FILENAME.
1365Switch to a buffer visiting file FILENAME,
243ce842 1366creating one if none already exists.
e6f0ff92
RS
1367Interactively, the default if you just type RET is the current directory,
1368but the visited file name is available through the minibuffer history:
1369type M-n to pull it into the minibuffer.
1370
4d4efd30
EZ
1371You can visit files on remote machines by specifying something
1372like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1373also visit local files as a different user by specifying
6f174d77
EZ
1374/sudo::FILE for the file name.
1375See the Info node `(tramp)Filename Syntax' in the Tramp Info
1376manual, for more about this.
4d4efd30 1377
243ce842 1378Interactively, or if WILDCARDS is non-nil in a call from Lisp,
91174d63 1379expand wildcards (if any) and visit multiple files. You can
518dc5be 1380suppress wildcard expansion by setting `find-file-wildcards' to nil.
91174d63
RS
1381
1382To visit a file without any kind of conversion and without
1383automatically choosing a major mode, use \\[find-file-literally]."
14fd09e5
SM
1384 (interactive
1385 (find-file-read-args "Find file: "
4a977e20 1386 (confirm-nonexistent-file-or-buffer)))
5b8ed07b
RS
1387 (let ((value (find-file-noselect filename nil nil wildcards)))
1388 (if (listp value)
c3313451 1389 (mapcar 'switch-to-buffer (nreverse value))
24510c22 1390 (switch-to-buffer value))))
82d0954a 1391
243ce842 1392(defun find-file-other-window (filename &optional wildcards)
b4da00e9 1393 "Edit file FILENAME, in another window.
4d4efd30
EZ
1394
1395Like \\[find-file] (which see), but creates a new window or reuses
1396an existing one. See the function `display-buffer'.
e6f0ff92
RS
1397
1398Interactively, the default if you just type RET is the current directory,
1399but the visited file name is available through the minibuffer history:
1400type M-n to pull it into the minibuffer.
1401
243ce842
RS
1402Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1403expand wildcards (if any) and visit multiple files."
14fd09e5
SM
1404 (interactive
1405 (find-file-read-args "Find file in other window: "
4a977e20 1406 (confirm-nonexistent-file-or-buffer)))
5b8ed07b
RS
1407 (let ((value (find-file-noselect filename nil nil wildcards)))
1408 (if (listp value)
1409 (progn
1410 (setq value (nreverse value))
a9d6a617
JL
1411 (cons (switch-to-buffer-other-window (car value))
1412 (mapcar 'switch-to-buffer (cdr value))))
5b8ed07b 1413 (switch-to-buffer-other-window value))))
243ce842
RS
1414
1415(defun find-file-other-frame (filename &optional wildcards)
f98955ea 1416 "Edit file FILENAME, in another frame.
4d4efd30
EZ
1417
1418Like \\[find-file] (which see), but creates a new frame or reuses
1419an existing one. See the function `display-buffer'.
e6f0ff92
RS
1420
1421Interactively, the default if you just type RET is the current directory,
1422but the visited file name is available through the minibuffer history:
1423type M-n to pull it into the minibuffer.
1424
243ce842
RS
1425Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1426expand wildcards (if any) and visit multiple files."
14fd09e5
SM
1427 (interactive
1428 (find-file-read-args "Find file in other frame: "
4a977e20 1429 (confirm-nonexistent-file-or-buffer)))
5b8ed07b
RS
1430 (let ((value (find-file-noselect filename nil nil wildcards)))
1431 (if (listp value)
1432 (progn
1433 (setq value (nreverse value))
a9d6a617
JL
1434 (cons (switch-to-buffer-other-frame (car value))
1435 (mapcar 'switch-to-buffer (cdr value))))
5b8ed07b 1436 (switch-to-buffer-other-frame value))))
243ce842 1437
63c8abc4
EZ
1438(defun find-file-existing (filename)
1439 "Edit the existing file FILENAME.
4d4efd30 1440Like \\[find-file], but only allow a file that exists, and do not allow
63c8abc4
EZ
1441file names with wildcards."
1442 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
32226619
JB
1443 (if (and (not (called-interactively-p 'interactive))
1444 (not (file-exists-p filename)))
63c8abc4
EZ
1445 (error "%s does not exist" filename)
1446 (find-file filename)
1447 (current-buffer)))
46bfc73b 1448
243ce842 1449(defun find-file-read-only (filename &optional wildcards)
b4da00e9 1450 "Edit file FILENAME but don't allow changes.
4d4efd30 1451Like \\[find-file], but marks buffer as read-only.
b4da00e9 1452Use \\[toggle-read-only] to permit editing."
14fd09e5
SM
1453 (interactive
1454 (find-file-read-args "Find file read-only: "
4a977e20 1455 (confirm-nonexistent-file-or-buffer)))
a9d6a617
JL
1456 (unless (or (and wildcards find-file-wildcards
1457 (not (string-match "\\`/:" filename))
1458 (string-match "[[*?]" filename))
1459 (file-exists-p filename))
1460 (error "%s does not exist" filename))
1461 (let ((value (find-file filename wildcards)))
1462 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1463 (if (listp value) value (list value)))
1464 value))
b4da00e9 1465
243ce842 1466(defun find-file-read-only-other-window (filename &optional wildcards)
b4da00e9 1467 "Edit file FILENAME in another window but don't allow changes.
4d4efd30 1468Like \\[find-file-other-window], but marks buffer as read-only.
b4da00e9 1469Use \\[toggle-read-only] to permit editing."
14fd09e5
SM
1470 (interactive
1471 (find-file-read-args "Find file read-only other window: "
4a977e20 1472 (confirm-nonexistent-file-or-buffer)))
a9d6a617
JL
1473 (unless (or (and wildcards find-file-wildcards
1474 (not (string-match "\\`/:" filename))
1475 (string-match "[[*?]" filename))
1476 (file-exists-p filename))
1477 (error "%s does not exist" filename))
1478 (let ((value (find-file-other-window filename wildcards)))
1479 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1480 (if (listp value) value (list value)))
1481 value))
b4da00e9 1482
243ce842 1483(defun find-file-read-only-other-frame (filename &optional wildcards)
f98955ea 1484 "Edit file FILENAME in another frame but don't allow changes.
4d4efd30 1485Like \\[find-file-other-frame], but marks buffer as read-only.
5bbbceb1 1486Use \\[toggle-read-only] to permit editing."
14fd09e5
SM
1487 (interactive
1488 (find-file-read-args "Find file read-only other frame: "
4a977e20 1489 (confirm-nonexistent-file-or-buffer)))
a9d6a617
JL
1490 (unless (or (and wildcards find-file-wildcards
1491 (not (string-match "\\`/:" filename))
1492 (string-match "[[*?]" filename))
1493 (file-exists-p filename))
1494 (error "%s does not exist" filename))
1495 (let ((value (find-file-other-frame filename wildcards)))
1496 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1497 (if (listp value) value (list value)))
1498 value))
1499
1500(defun find-alternate-file-other-window (filename &optional wildcards)
60eaf370 1501 "Find file FILENAME as a replacement for the file in the next window.
a9d6a617
JL
1502This command does not select that window.
1503
4d4efd30
EZ
1504See \\[find-file] for the possible forms of the FILENAME argument.
1505
a9d6a617
JL
1506Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1507expand wildcards (if any) and replace the file with multiple files."
60eaf370
RS
1508 (interactive
1509 (save-selected-window
1510 (other-window 1)
1511 (let ((file buffer-file-name)
1512 (file-name nil)
1513 (file-dir nil))
1514 (and file
1515 (setq file-name (file-name-nondirectory file)
1516 file-dir (file-name-directory file)))
1517 (list (read-file-name
4b8b1ec5
SM
1518 "Find alternate file: " file-dir nil
1519 (confirm-nonexistent-file-or-buffer) file-name)
a9d6a617 1520 t))))
60eaf370 1521 (if (one-window-p)
a9d6a617 1522 (find-file-other-window filename wildcards)
60eaf370
RS
1523 (save-selected-window
1524 (other-window 1)
a9d6a617 1525 (find-alternate-file filename wildcards))))
60eaf370 1526
06b60517
JB
1527(defvar kill-buffer-hook) ; from buffer.c
1528
a9d6a617 1529(defun find-alternate-file (filename &optional wildcards)
b4da00e9
RM
1530 "Find file FILENAME, select its buffer, kill previous buffer.
1531If the current buffer now contains an empty file that you just visited
a9d6a617
JL
1532\(presumably by mistake), use this command to visit the file you really want.
1533
4d4efd30
EZ
1534See \\[find-file] for the possible forms of the FILENAME argument.
1535
a9d6a617 1536Interactively, or if WILDCARDS is non-nil in a call from Lisp,
077f47e2
CY
1537expand wildcards (if any) and replace the file with multiple files.
1538
1539If the current buffer is an indirect buffer, or the base buffer
1540for one or more indirect buffers, the other buffer(s) are not
1541killed."
b4da00e9
RM
1542 (interactive
1543 (let ((file buffer-file-name)
1544 (file-name nil)
1545 (file-dir nil))
1546 (and file
1547 (setq file-name (file-name-nondirectory file)
1548 file-dir (file-name-directory file)))
a61f59b4 1549 (list (read-file-name
4b8b1ec5
SM
1550 "Find alternate file: " file-dir nil
1551 (confirm-nonexistent-file-or-buffer) file-name)
a9d6a617 1552 t)))
63fabbb4
RS
1553 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1554 (error "Aborted"))
ef7ef2a0 1555 (when (and (buffer-modified-p) buffer-file-name)
9aea757b
CY
1556 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1557 (buffer-name)))
ef7ef2a0
KF
1558 (save-buffer)
1559 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1560 (error "Aborted"))))
b4da00e9
RM
1561 (let ((obuf (current-buffer))
1562 (ofile buffer-file-name)
8bb27285 1563 (onum buffer-file-number)
37c58ca6 1564 (odir dired-directory)
8bb27285 1565 (otrue buffer-file-truename)
b4da00e9 1566 (oname (buffer-name)))
049a231b
KF
1567 ;; Run `kill-buffer-hook' here. It needs to happen before
1568 ;; variables like `buffer-file-name' etc are set to nil below,
1569 ;; because some of the hooks that could be invoked
1570 ;; (e.g., `save-place-to-alist') depend on those variables.
1571 ;;
1572 ;; Note that `kill-buffer-hook' is not what queries whether to
1573 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1574 ;; asks that itself. Thus, there's no need to temporarily do
1575 ;; `(set-buffer-modified-p nil)' before running this hook.
1576 (run-hooks 'kill-buffer-hook)
1577 ;; Okay, now we can end-of-life the old buffer.
baf9b8c4
RS
1578 (if (get-buffer " **lose**")
1579 (kill-buffer " **lose**"))
b4da00e9 1580 (rename-buffer " **lose**")
b4da00e9
RM
1581 (unwind-protect
1582 (progn
1583 (unlock-buffer)
7906c044
RS
1584 ;; This prevents us from finding the same buffer
1585 ;; if we specified the same file again.
a4ad4d96
RS
1586 (setq buffer-file-name nil)
1587 (setq buffer-file-number nil)
1588 (setq buffer-file-truename nil)
7906c044
RS
1589 ;; Likewise for dired buffers.
1590 (setq dired-directory nil)
a9d6a617 1591 (find-file filename wildcards))
63fabbb4
RS
1592 (when (eq obuf (current-buffer))
1593 ;; This executes if find-file gets an error
1594 ;; and does not really find anything.
1595 ;; We put things back as they were.
1596 ;; If find-file actually finds something, we kill obuf below.
1597 (setq buffer-file-name ofile)
1598 (setq buffer-file-number onum)
1599 (setq buffer-file-truename otrue)
7906c044 1600 (setq dired-directory odir)
63fabbb4
RS
1601 (lock-buffer)
1602 (rename-buffer oname)))
1603 (unless (eq (current-buffer) obuf)
d97a9ff3 1604 (with-current-buffer obuf
049a231b
KF
1605 ;; We already ran these; don't run them again.
1606 (let (kill-buffer-query-functions kill-buffer-hook)
d97a9ff3 1607 (kill-buffer obuf))))))
9b8ef27d 1608\f
b4da00e9
RM
1609(defun create-file-buffer (filename)
1610 "Create a suitably named buffer for visiting FILENAME, and return it.
1611FILENAME (sans directory) is used unchanged if that name is free;
661e8cd1
MC
1612otherwise a string <2> or <3> or ... is appended to get an unused name.
1613Spaces at the start of FILENAME (sans directory) are removed."
b4da00e9
RM
1614 (let ((lastname (file-name-nondirectory filename)))
1615 (if (string= lastname "")
1616 (setq lastname filename))
661e8cd1
MC
1617 (save-match-data
1618 (string-match "^ *\\(.*\\)" lastname)
1619 (generate-new-buffer (match-string 1 lastname)))))
b4da00e9 1620
5bbbceb1
JB
1621(defun generate-new-buffer (name)
1622 "Create and return a buffer with a name based on NAME.
29165787 1623Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
1624 (get-buffer-create (generate-new-buffer-name name)))
1625
1e8780b1 1626(defcustom automount-dir-prefix (purecopy "^/tmp_mnt/")
ffc0e1ca
AS
1627 "Regexp to match the automounter prefix in a directory name."
1628 :group 'files
1629 :type 'regexp)
e373f201 1630
ffb3a4db 1631(defvar abbreviated-home-dir nil
ffc0e1ca 1632 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
ffb3a4db 1633
5bbbceb1 1634(defun abbreviate-file-name (filename)
29165787 1635 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
fe4e58ec
EZ
1636This also substitutes \"~\" for the user's home directory (unless the
1637home directory is a root directory) and removes automounter prefixes
1638\(see the variable `automount-dir-prefix')."
e373f201 1639 ;; Get rid of the prefixes added by the automounter.
f663a1ce
RS
1640 (save-match-data
1641 (if (and automount-dir-prefix
1642 (string-match automount-dir-prefix filename)
1643 (file-exists-p (file-name-directory
1644 (substring filename (1- (match-end 0))))))
1645 (setq filename (substring filename (1- (match-end 0)))))
20431da9
CY
1646 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1647 ;; To fix this right, we need a `file-name-case-sensitive-p'
1648 ;; function, but we don't have that yet, so just guess.
9f2f6ad8 1649 (let ((case-fold-search
20431da9 1650 (memq system-type '(ms-dos windows-nt darwin cygwin))))
f663a1ce
RS
1651 ;; If any elt of directory-abbrev-alist matches this name,
1652 ;; abbreviate accordingly.
20431da9
CY
1653 (dolist (dir-abbrev directory-abbrev-alist)
1654 (if (string-match (car dir-abbrev) filename)
f663a1ce 1655 (setq filename
20431da9
CY
1656 (concat (cdr dir-abbrev)
1657 (substring filename (match-end 0))))))
f663a1ce
RS
1658 ;; Compute and save the abbreviated homedir name.
1659 ;; We defer computing this until the first time it's needed, to
1660 ;; give time for directory-abbrev-alist to be set properly.
1661 ;; We include a slash at the end, to avoid spurious matches
1662 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1663 (or abbreviated-home-dir
1664 (setq abbreviated-home-dir
1665 (let ((abbreviated-home-dir "$foo"))
528c56e2 1666 (concat "\\`" (abbreviate-file-name (expand-file-name "~"))
e959542d 1667 "\\(/\\|\\'\\)"))))
f663a1ce
RS
1668
1669 ;; If FILENAME starts with the abbreviated homedir,
1670 ;; make it start with `~' instead.
1671 (if (and (string-match abbreviated-home-dir filename)
1672 ;; If the home dir is just /, don't change it.
1673 (not (and (= (match-end 0) 1)
1674 (= (aref filename 0) ?/)))
1675 ;; MS-DOS root directories can come with a drive letter;
1676 ;; Novell Netware allows drive letters beyond `Z:'.
528c56e2 1677 (not (and (memq system-type '(ms-dos windows-nt cygwin))
f663a1ce
RS
1678 (save-match-data
1679 (string-match "^[a-zA-`]:/$" filename)))))
5bbbceb1 1680 (setq filename
f663a1ce
RS
1681 (concat "~"
1682 (match-string 1 filename)
1683 (substring filename (match-end 0)))))
1684 filename)))
5bbbceb1 1685
3a64a3cf 1686(defun find-buffer-visiting (filename &optional predicate)
138c44f6
KH
1687 "Return the buffer visiting file FILENAME (a string).
1688This is like `get-file-buffer', except that it checks for any buffer
1689visiting the same file, possibly under a different name.
a1b0c2a7
RS
1690If PREDICATE is non-nil, only buffers satisfying it are eligible,
1691and others are ignored.
138c44f6 1692If there is no such live buffer, return nil."
3a64a3cf
JB
1693 (let ((predicate (or predicate #'identity))
1694 (truename (abbreviate-file-name (file-truename filename))))
1695 (or (let ((buf (get-file-buffer filename)))
1696 (when (and buf (funcall predicate buf)) buf))
1697 (let ((list (buffer-list)) found)
1698 (while (and (not found) list)
528c56e2 1699 (with-current-buffer (car list)
3a64a3cf
JB
1700 (if (and buffer-file-name
1701 (string= buffer-file-truename truename)
1702 (funcall predicate (current-buffer)))
1703 (setq found (car list))))
1704 (setq list (cdr list)))
1705 found)
1706 (let* ((attributes (file-attributes truename))
1707 (number (nthcdr 10 attributes))
1708 (list (buffer-list)) found)
1709 (and buffer-file-numbers-unique
02bb2aab 1710 (car-safe number) ;Make sure the inode is not just nil.
3a64a3cf
JB
1711 (while (and (not found) list)
1712 (with-current-buffer (car list)
1713 (if (and buffer-file-name
1714 (equal buffer-file-number number)
1715 ;; Verify this buffer's file number
1716 ;; still belongs to its file.
1717 (file-exists-p buffer-file-name)
1718 (equal (file-attributes buffer-file-truename)
1719 attributes)
1720 (funcall predicate (current-buffer)))
1721 (setq found (car list))))
1722 (setq list (cdr list))))
1723 found))))
9b8ef27d 1724\f
5de148a2 1725(defcustom find-file-wildcards t
ba83982b 1726 "Non-nil means file-visiting commands should handle wildcards.
5de148a2
RS
1727For example, if you specify `*.c', that would visit all the files
1728whose names match the pattern."
1729 :group 'files
3957c982 1730 :version "20.4"
5de148a2
RS
1731 :type 'boolean)
1732
ffc0e1ca 1733(defcustom find-file-suppress-same-file-warnings nil
ba83982b 1734 "Non-nil means suppress warning messages for symlinked files.
ffc0e1ca
AS
1735When nil, Emacs prints a warning when visiting a file that is already
1736visited, but with a different name. Setting this option to t
1737suppresses this warning."
1738 :group 'files
1739 :version "21.1"
1740 :type 'boolean)
1741
818286f4 1742(defcustom large-file-warning-threshold 10000000
5d648479
JPW
1743 "Maximum size of file above which a confirmation is requested.
1744When nil, never request confirmation."
1745 :group 'files
1746 :group 'find-file
bf247b6e 1747 :version "22.1"
5d648479 1748 :type '(choice integer (const :tag "Never request confirmation" nil)))
818286f4 1749
26ede5d3 1750(defun abort-if-file-too-large (size op-type filename)
afe9998d 1751 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
4954b81b
AR
1752OP-TYPE specifies the file operation being performed (for message to user)."
1753 (when (and large-file-warning-threshold size
3ef01959 1754 (> size large-file-warning-threshold)
9aea757b
CY
1755 (not (y-or-n-p (format "File %s is large (%dMB), really %s? "
1756 (file-name-nondirectory filename)
1757 (/ size 1048576) op-type))))
3ef01959 1758 (error "Aborted")))
4954b81b 1759
243ce842 1760(defun find-file-noselect (filename &optional nowarn rawfile wildcards)
b4da00e9
RM
1761 "Read file FILENAME into a buffer and return the buffer.
1762If a buffer exists visiting FILENAME, return that one, but
1763verify that the file has not changed since visited or saved.
82d0954a 1764The buffer is not selected, just returned to the caller.
26b9ecbc
JB
1765Optional second arg NOWARN non-nil means suppress any warning messages.
1766Optional third arg RAWFILE non-nil means the file is read literally.
1767Optional fourth arg WILDCARDS non-nil means do wildcard processing
5b8ed07b 1768and visit all the matching files. When wildcards are actually
a9d6a617
JL
1769used and expanded, return a list of buffers that are visiting
1770the various files."
e373f201
JB
1771 (setq filename
1772 (abbreviate-file-name
1773 (expand-file-name filename)))
b4da00e9 1774 (if (file-directory-p filename)
ffc0e1ca
AS
1775 (or (and find-file-run-dired
1776 (run-hook-with-args-until-success
1777 'find-directory-functions
1778 (if find-file-visit-truename
1779 (abbreviate-file-name (file-truename filename))
1780 filename)))
1781 (error "%s is a directory" filename))
243ce842
RS
1782 (if (and wildcards
1783 find-file-wildcards
f91fe604 1784 (not (string-match "\\`/:" filename))
5de148a2 1785 (string-match "[[*?]" filename))
ffc0e1ca
AS
1786 (let ((files (condition-case nil
1787 (file-expand-wildcards filename t)
1788 (error (list filename))))
5de148a2 1789 (find-file-wildcards nil))
f91fe604 1790 (if (null files)
ffc0e1ca 1791 (find-file-noselect filename)
648ec2ff 1792 (mapcar #'find-file-noselect files)))
5de148a2
RS
1793 (let* ((buf (get-file-buffer filename))
1794 (truename (abbreviate-file-name (file-truename filename)))
818286f4
SM
1795 (attributes (file-attributes truename))
1796 (number (nthcdr 10 attributes))
5de148a2
RS
1797 ;; Find any buffer for a file which has same truename.
1798 (other (and (not buf) (find-buffer-visiting filename))))
1799 ;; Let user know if there is a buffer with the same truename.
1800 (if other
1801 (progn
1802 (or nowarn
ffc0e1ca 1803 find-file-suppress-same-file-warnings
5de148a2
RS
1804 (string-equal filename (buffer-file-name other))
1805 (message "%s and %s are the same file"
1806 filename (buffer-file-name other)))
1807 ;; Optionally also find that buffer.
1808 (if (or find-file-existing-other-name find-file-visit-truename)
1809 (setq buf other))))
818286f4 1810 ;; Check to see if the file looks uncommonly large.
4954b81b 1811 (when (not (or buf nowarn))
26ede5d3 1812 (abort-if-file-too-large (nth 7 attributes) "open" filename))
5de148a2
RS
1813 (if buf
1814 ;; We are using an existing buffer.
2c5b1db7 1815 (let (nonexistent)
5de148a2
RS
1816 (or nowarn
1817 (verify-visited-file-modtime buf)
1818 (cond ((not (file-exists-p filename))
2c5b1db7
RS
1819 (setq nonexistent t)
1820 (message "File %s no longer exists!" filename))
5de148a2
RS
1821 ;; Certain files should be reverted automatically
1822 ;; if they have changed on disk and not in the buffer.
1823 ((and (not (buffer-modified-p buf))
1824 (let ((tail revert-without-query)
1825 (found nil))
1826 (while tail
1827 (if (string-match (car tail) filename)
1828 (setq found t))
1829 (setq tail (cdr tail)))
1830 found))
1831 (with-current-buffer buf
1832 (message "Reverting file %s..." filename)
1833 (revert-buffer t t)
1834 (message "Reverting file %s...done" filename)))
1835 ((yes-or-no-p
1836 (if (string= (file-name-nondirectory filename)
1837 (buffer-name buf))
1838 (format
1839 (if (buffer-modified-p buf)
1840 "File %s changed on disk. Discard your edits? "
1841 "File %s changed on disk. Reread from disk? ")
1842 (file-name-nondirectory filename))
ddd64da9
RS
1843 (format
1844 (if (buffer-modified-p buf)
5de148a2
RS
1845 "File %s changed on disk. Discard your edits in %s? "
1846 "File %s changed on disk. Reread from disk into %s? ")
1847 (file-name-nondirectory filename)
1848 (buffer-name buf))))
1849 (with-current-buffer buf
1850 (revert-buffer t t)))))
1851 (with-current-buffer buf
a8d002d2
GM
1852
1853 ;; Check if a formerly read-only file has become
e554eeb7
RS
1854 ;; writable and vice versa, but if the buffer agrees
1855 ;; with the new state of the file, that is ok too.
a8d002d2 1856 (let ((read-only (not (file-writable-p buffer-file-name))))
2c5b1db7
RS
1857 (unless (or nonexistent
1858 (eq read-only buffer-file-read-only)
e554eeb7 1859 (eq read-only buffer-read-only))
a8d002d2 1860 (when (or nowarn
36236b72 1861 (let ((question
a8d002d2
GM
1862 (format "File %s is %s on disk. Change buffer mode? "
1863 buffer-file-name
1864 (if read-only "read-only" "writable"))))
1865 (y-or-n-p question)))
e554eeb7
RS
1866 (setq buffer-read-only read-only)))
1867 (setq buffer-file-read-only read-only))
a8d002d2 1868
ef59dd3b
EZ
1869 (when (and (not (eq (not (null rawfile))
1870 (not (null find-file-literally))))
2c5b1db7 1871 (not nonexistent)
ef59dd3b
EZ
1872 ;; It is confusing to ask whether to visit
1873 ;; non-literally if they have the file in
3ae59fff
EZ
1874 ;; hexl-mode or image-mode.
1875 (not (memq major-mode '(hexl-mode image-mode))))
5de148a2 1876 (if (buffer-modified-p)
562ca538 1877 (if (y-or-n-p
674b7bae 1878 (format
562ca538
RS
1879 (if rawfile
1880 "The file %s is already visited normally,
1881and you have edited the buffer. Now you have asked to visit it literally,
1882meaning no coding system handling, format conversion, or local variables.
1883Emacs can only visit a file in one way at a time.
1884
1885Do you want to save the file, and visit it literally instead? "
1886 "The file %s is already visited literally,
1887meaning no coding system handling, format conversion, or local variables.
1888You have edited the buffer. Now you have asked to visit the file normally,
1889but Emacs can only visit a file in one way at a time.
1890
1891Do you want to save the file, and visit it normally instead? ")
1892 (file-name-nondirectory filename)))
5de148a2
RS
1893 (progn
1894 (save-buffer)
1895 (find-file-noselect-1 buf filename nowarn
1896 rawfile truename number))
562ca538 1897 (if (y-or-n-p
674b7bae 1898 (format
562ca538
RS
1899 (if rawfile
1900 "\
1901Do you want to discard your changes, and visit the file literally now? "
1902 "\
1903Do you want to discard your changes, and visit the file normally now? ")))
5de148a2
RS
1904 (find-file-noselect-1 buf filename nowarn
1905 rawfile truename number)
1906 (error (if rawfile "File already visited non-literally"
1907 "File already visited literally"))))
674b7bae
JB
1908 (if (y-or-n-p
1909 (format
562ca538
RS
1910 (if rawfile
1911 "The file %s is already visited normally.
1912You have asked to visit it literally,
1913meaning no coding system decoding, format conversion, or local variables.
1914But Emacs can only visit a file in one way at a time.
1915
1916Do you want to revisit the file literally now? "
1917 "The file %s is already visited literally,
1918meaning no coding system decoding, format conversion, or local variables.
1919You have asked to visit it normally,
1920but Emacs can only visit a file in one way at a time.
1921
1922Do you want to revisit the file normally now? ")
1923 (file-name-nondirectory filename)))
5de148a2
RS
1924 (find-file-noselect-1 buf filename nowarn
1925 rawfile truename number)
1926 (error (if rawfile "File already visited non-literally"
1927 "File already visited literally"))))))
1928 ;; Return the buffer we are using.
1929 buf)
1930 ;; Create a new buffer.
1931 (setq buf (create-file-buffer filename))
5de148a2
RS
1932 ;; find-file-noselect-1 may use a different buffer.
1933 (find-file-noselect-1 buf filename nowarn
1934 rawfile truename number))))))
ddd64da9
RS
1935
1936(defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
4edcfd17 1937 (let (error)
ddd64da9
RS
1938 (with-current-buffer buf
1939 (kill-local-variable 'find-file-literally)
b296cbd4
RS
1940 ;; Needed in case we are re-visiting the file with a different
1941 ;; text representation.
e73ec04b 1942 (kill-local-variable 'buffer-file-coding-system)
4ad1689f 1943 (kill-local-variable 'cursor-type)
4edcfd17 1944 (let ((inhibit-read-only t))
0a11c70b
LT
1945 (erase-buffer))
1946 (and (default-value 'enable-multibyte-characters)
1947 (not rawfile)
1948 (set-buffer-multibyte t))
1949 (if rawfile
74dca654 1950 (condition-case ()
0a11c70b
LT
1951 (let ((inhibit-read-only t))
1952 (insert-file-contents-literally filename t))
74dca654
LT
1953 (file-error
1954 (when (and (file-exists-p filename)
1955 (not (file-readable-p filename)))
1956 (kill-buffer buf)
1957 (signal 'file-error (list "File is not readable"
1958 filename)))
0a11c70b
LT
1959 ;; Unconditionally set error
1960 (setq error t)))
1961 (condition-case ()
1962 (let ((inhibit-read-only t))
1963 (insert-file-contents filename t))
1964 (file-error
1965 (when (and (file-exists-p filename)
1966 (not (file-readable-p filename)))
1967 (kill-buffer buf)
1968 (signal 'file-error (list "File is not readable"
1969 filename)))
e0d8fc91 1970 ;; Run find-file-not-found-functions until one returns non-nil.
0a11c70b
LT
1971 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1972 ;; If they fail too, set error.
1973 (setq error t)))))
b120e713
KH
1974 ;; Record the file's truename, and maybe use that as visited name.
1975 (if (equal filename buffer-file-name)
1976 (setq buffer-file-truename truename)
9ab19105
DL
1977 (setq buffer-file-truename
1978 (abbreviate-file-name (file-truename buffer-file-name))))
ddd64da9 1979 (setq buffer-file-number number)
ddd64da9 1980 (if find-file-visit-truename
e442c62b 1981 (setq buffer-file-name (expand-file-name buffer-file-truename)))
ddd64da9 1982 ;; Set buffer's default directory to that of the file.
b120e713 1983 (setq default-directory (file-name-directory buffer-file-name))
ddd64da9
RS
1984 ;; Turn off backup files for certain file names. Since
1985 ;; this is a permanent local, the major mode won't eliminate it.
b98a8e06
RS
1986 (and backup-enable-predicate
1987 (not (funcall backup-enable-predicate buffer-file-name))
ddd64da9
RS
1988 (progn
1989 (make-local-variable 'backup-inhibited)
1990 (setq backup-inhibited t)))
f402ba38
RS
1991 (if rawfile
1992 (progn
1993 (set-buffer-multibyte nil)
1994 (setq buffer-file-coding-system 'no-conversion)
e8f30180 1995 (set-buffer-major-mode buf)
f402ba38
RS
1996 (make-local-variable 'find-file-literally)
1997 (setq find-file-literally t))
1998 (after-find-file error (not nowarn)))
1999 (current-buffer))))
9b8ef27d
RS
2000\f
2001(defun insert-file-contents-literally (filename &optional visit beg end replace)
2002 "Like `insert-file-contents', but only reads in the file literally.
2003A buffer may be modified in several ways after reading into the buffer,
2004to Emacs features such as format decoding, character code
0370fe77 2005conversion, `find-file-hook', automatic uncompression, etc.
9b8ef27d
RS
2006
2007This function ensures that none of these modifications will take place."
2008 (let ((format-alist nil)
2009 (after-insert-file-functions nil)
2010 (coding-system-for-read 'no-conversion)
2011 (coding-system-for-write 'no-conversion)
9b8ef27d 2012 (find-buffer-file-type-function
cdec2ad7
JB
2013 (if (fboundp 'find-buffer-file-type)
2014 (symbol-function 'find-buffer-file-type)
2015 nil))
2016 (inhibit-file-name-handlers
bfeee9d1 2017 (append '(jka-compr-handler image-file-handler epa-file-handler)
cdec2ad7
JB
2018 inhibit-file-name-handlers))
2019 (inhibit-file-name-operation 'insert-file-contents))
9b8ef27d 2020 (unwind-protect
cdec2ad7 2021 (progn
06b60517 2022 (fset 'find-buffer-file-type (lambda (_filename) t))
cdec2ad7 2023 (insert-file-contents filename visit beg end replace))
9b8ef27d
RS
2024 (if find-buffer-file-type-function
2025 (fset 'find-buffer-file-type find-buffer-file-type-function)
2026 (fmakunbound 'find-buffer-file-type)))))
2027
3a64a3cf
JB
2028(defun insert-file-1 (filename insert-func)
2029 (if (file-directory-p filename)
2030 (signal 'file-error (list "Opening input file" "file is a directory"
2031 filename)))
4954b81b 2032 ;; Check whether the file is uncommonly large
26ede5d3 2033 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert" filename)
3a64a3cf
JB
2034 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
2035 #'buffer-modified-p))
2036 (tem (funcall insert-func filename)))
2037 (push-mark (+ (point) (car (cdr tem))))
2038 (when buffer
2039 (message "File %s already visited and modified in buffer %s"
2040 filename (buffer-name buffer)))))
2041
9b8ef27d
RS
2042(defun insert-file-literally (filename)
2043 "Insert contents of file FILENAME into buffer after point with no conversion.
2044
2045This function is meant for the user to run interactively.
2046Don't call it from programs! Use `insert-file-contents-literally' instead.
2047\(Its calling sequence is different; see its documentation)."
2048 (interactive "*fInsert file literally: ")
3a64a3cf 2049 (insert-file-1 filename #'insert-file-contents-literally))
9b8ef27d
RS
2050
2051(defvar find-file-literally nil
2052 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
72d6685c
GM
2053This has the `permanent-local' property, which takes effect if you
2054make the variable buffer-local.")
9b8ef27d 2055(put 'find-file-literally 'permanent-local t)
5fc196af 2056
ffc0e1ca 2057(defun find-file-literally (filename)
5fc196af
RS
2058 "Visit file FILENAME with no conversion of any kind.
2059Format conversion and character code conversion are both disabled,
2060and multibyte characters are disabled in the resulting buffer.
e65db7b8
RS
2061The major mode used is Fundamental mode regardless of the file name,
2062and local variable specifications in the file are ignored.
407b4328
GM
2063Automatic uncompression and adding a newline at the end of the
2064file due to `require-final-newline' is also disabled.
9b8ef27d
RS
2065
2066You cannot absolutely rely on this function to result in
b9aa9537 2067visiting the file literally. If Emacs already has a buffer
9b8ef27d
RS
2068which is visiting the file, you get the existing buffer,
2069regardless of whether it was created literally or not.
2070
2071In a Lisp program, if you want to be sure of accessing a file's
2072contents literally, you should create a temporary buffer and then read
2073the file contents into it using `insert-file-contents-literally'."
7d371eac
JL
2074 (interactive
2075 (list (read-file-name
2076 "Find file literally: " nil default-directory
2077 (confirm-nonexistent-file-or-buffer))))
9b8ef27d 2078 (switch-to-buffer (find-file-noselect filename nil t)))
b4da00e9 2079\f
e0ab8879 2080(defun after-find-file (&optional error warn noauto
3e214b50 2081 _after-find-file-from-revert-buffer
9a30563f 2082 nomodes)
b4da00e9
RM
2083 "Called after finding a file and by the default revert function.
2084Sets buffer mode, parses local variables.
8cfb9d46 2085Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
2086error in reading the file. WARN non-nil means warn if there
2087exists an auto-save file more recent than the visited file.
8cfb9d46 2088NOAUTO means don't mess with auto-save mode.
3e214b50
JB
2089Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2090\(see `revert-buffer-in-progress-p' for similar functionality).
9a30563f 2091Fifth arg NOMODES non-nil means don't alter the file's modes.
0370fe77 2092Finishes by calling the functions in `find-file-hook'
9a30563f 2093unless NOMODES is non-nil."
b4da00e9
RM
2094 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
2095 (if noninteractive
2096 nil
2097 (let* (not-serious
2098 (msg
fe50b6ab
GM
2099 (cond
2100 ((not warn) nil)
2101 ((and error (file-attributes buffer-file-name))
2102 (setq buffer-read-only t)
7152b011
LMI
2103 (if (and (file-symlink-p buffer-file-name)
2104 (not (file-exists-p
2105 (file-chase-links buffer-file-name))))
2106 "Symbolic link that points to nonexistent file"
2107 "File exists, but cannot be read"))
fe50b6ab
GM
2108 ((not buffer-read-only)
2109 (if (and warn
2110 ;; No need to warn if buffer is auto-saved
2111 ;; under the name of the visited file.
2112 (not (and buffer-file-name
2113 auto-save-visited-file-name))
2114 (file-newer-than-file-p (or buffer-auto-save-file-name
2115 (make-auto-save-file-name))
2116 buffer-file-name))
64d18e8f 2117 (format "%s has auto save data; consider M-x recover-this-file"
fe50b6ab
GM
2118 (file-name-nondirectory buffer-file-name))
2119 (setq not-serious t)
2120 (if error "(New file)" nil)))
2121 ((not error)
2122 (setq not-serious t)
2123 "Note: file is write protected")
2124 ((file-attributes (directory-file-name default-directory))
2125 "File not found and directory write-protected")
2126 ((file-exists-p (file-name-directory buffer-file-name))
2127 (setq buffer-read-only nil))
2128 (t
2129 (setq buffer-read-only nil)
07703430 2130 "Use M-x make-directory RET RET to create the directory and its parents"))))
fe50b6ab 2131 (when msg
a74357d4 2132 (message "%s" msg)
e09f3bff 2133 (or not-serious (sit-for 1 t))))
fe50b6ab 2134 (when (and auto-save-default (not noauto))
06b60517 2135 (auto-save-mode 1)))
ffc0e1ca
AS
2136 ;; Make people do a little extra work (C-x C-q)
2137 ;; before altering a backup file.
fe50b6ab
GM
2138 (when (backup-file-name-p buffer-file-name)
2139 (setq buffer-read-only t))
8fd9c174
RS
2140 ;; When a file is marked read-only,
2141 ;; make the buffer read-only even if root is looking at it.
879365c6
KS
2142 (when (and (file-modes (buffer-file-name))
2143 (zerop (logand (file-modes (buffer-file-name)) #o222)))
8fd9c174 2144 (setq buffer-read-only t))
fe50b6ab
GM
2145 (unless nomodes
2146 (when (and view-read-only view-mode)
2147 (view-mode-disable))
9a30563f 2148 (normal-mode t)
f4206092
RS
2149 ;; If requested, add a newline at the end of the file.
2150 (and (memq require-final-newline '(visit visit-save))
2151 (> (point-max) (point-min))
2152 (/= (char-after (1- (point-max))) ?\n)
2153 (not (and (eq selective-display t)
2154 (= (char-after (1- (point-max))) ?\r)))
2155 (save-excursion
2156 (goto-char (point-max))
2157 (insert "\n")))
fe50b6ab
GM
2158 (when (and buffer-read-only
2159 view-read-only
2160 (not (eq (get major-mode 'mode-class) 'special)))
2161 (view-mode-enter))
0370fe77 2162 (run-hooks 'find-file-hook)))
b4da00e9 2163
818286f4
SM
2164(defmacro report-errors (format &rest body)
2165 "Eval BODY and turn any error into a FORMAT message.
2166FORMAT can have a %s escape which will be replaced with the actual error.
2167If `debug-on-error' is set, errors are not caught, so that you can
2168debug them.
2169Avoid using a large BODY since it is duplicated."
2170 (declare (debug t) (indent 1))
2171 `(if debug-on-error
2172 (progn . ,body)
2173 (condition-case err
2174 (progn . ,body)
2175 (error (message ,format (prin1-to-string err))))))
2176
b4da00e9
RM
2177(defun normal-mode (&optional find-file)
2178 "Choose the major mode for this buffer automatically.
2179Also sets up any specified local variables of the file.
2180Uses the visited file name, the -*- line, and the local variables spec.
2181
2182This function is called automatically from `find-file'. In that case,
aa5fcebf 2183we may set up the file-specified mode and local variables,
a5ce12c3 2184depending on the value of `enable-local-variables'.
aa5fcebf
KH
2185In addition, if `local-enable-local-variables' is nil, we do
2186not set local variables (though we do notice a mode specified with -*-.)
2187
2188`enable-local-variables' is ignored if you run `normal-mode' interactively,
2189or from Lisp without specifying the optional argument FIND-FILE;
2190in that case, this function acts as if `enable-local-variables' were t."
b4da00e9 2191 (interactive)
14acf2f5 2192 (funcall (or (default-value 'major-mode) 'fundamental-mode))
0fc205c6 2193 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
e145f188
GM
2194 ;; FIXME this is less efficient than it could be, since both
2195 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
0fc205c6
LT
2196 (report-errors "File mode specification error: %s"
2197 (set-auto-mode))
2198 (report-errors "File local-variables error: %s"
818286f4 2199 (hack-local-variables)))
6e86be0b
RS
2200 ;; Turn font lock off and on, to make sure it takes account of
2201 ;; whatever file local variables are relevant to it.
344f1111
SM
2202 (when (and font-lock-mode
2203 ;; Font-lock-mode (now in font-core.el) can be ON when
2204 ;; font-lock.el still hasn't been loaded.
2205 (boundp 'font-lock-keywords)
2206 (eq (car font-lock-keywords) t))
6e86be0b 2207 (setq font-lock-keywords (cadr font-lock-keywords))
fd06db5d 2208 (font-lock-mode 1)))
b4da00e9 2209
2372f278 2210(defcustom auto-mode-case-fold t
94495713
KS
2211 "Non-nil means to try second pass through `auto-mode-alist'.
2212This means that if the first case-sensitive search through the alist fails
2213to find a matching major mode, a second case-insensitive search is made.
2214On systems with case-insensitive file names, this variable is ignored,
bb178aaa 2215since only a single case-insensitive search through the alist is made."
94495713
KS
2216 :group 'files
2217 :version "22.1"
2218 :type 'boolean)
2219
f76e0cd0 2220(defvar auto-mode-alist
f209c999
MS
2221 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2222 ;; c++-mode, java-mode and more) are added through autoload
2223 ;; directives in that file. That way is discouraged since it
2224 ;; spreads out the definition of the initial value.
4aaffda1 2225 (mapcar
e8e4d5c8
SS
2226 (lambda (elt)
2227 (cons (purecopy (car elt)) (cdr elt)))
813731b3 2228 `(;; do this first, so that .html.pl is Polish html, not Perl
1e5d2a04 2229 ("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
5e339ee2
GM
2230 ("\\.svgz?\\'" . image-mode)
2231 ("\\.svgz?\\'" . xml-mode)
2232 ("\\.x[bp]m\\'" . image-mode)
2233 ("\\.x[bp]m\\'" . c-mode)
2234 ("\\.p[bpgn]m\\'" . image-mode)
2235 ("\\.tiff?\\'" . image-mode)
2236 ("\\.gif\\'" . image-mode)
2237 ("\\.png\\'" . image-mode)
2238 ("\\.jpe?g\\'" . image-mode)
9e6f5419 2239 ("\\.te?xt\\'" . text-mode)
bbc67516 2240 ("\\.[tT]e[xX]\\'" . tex-mode)
4e163715 2241 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
ffc0e1ca 2242 ("\\.ltx\\'" . latex-mode)
4e163715 2243 ("\\.dtx\\'" . doctex-mode)
18d8cb81 2244 ("\\.org\\'" . org-mode)
ffc0e1ca 2245 ("\\.el\\'" . emacs-lisp-mode)
e6e267fc 2246 ("Project\\.ede\\'" . emacs-lisp-mode)
21575d92 2247 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
ffc0e1ca 2248 ("\\.l\\'" . lisp-mode)
bbc67516
DP
2249 ("\\.li?sp\\'" . lisp-mode)
2250 ("\\.[fF]\\'" . fortran-mode)
ffc0e1ca
AS
2251 ("\\.for\\'" . fortran-mode)
2252 ("\\.p\\'" . pascal-mode)
2253 ("\\.pas\\'" . pascal-mode)
448ecec3 2254 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode)
ffc0e1ca 2255 ("\\.ad[abs]\\'" . ada-mode)
7defe888 2256 ("\\.ad[bs].dg\\'" . ada-mode)
bbc67516 2257 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
3968c89f 2258 ("Imakefile\\'" . makefile-imake-mode)
8088bb2c
DP
2259 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2260 ("\\.makepp\\'" . makefile-makepp-mode)
2ddf2ea6 2261 ,@(if (memq system-type '(berkeley-unix darwin))
813731b3 2262 '(("\\.mk\\'" . makefile-bsdmake-mode)
47d4e709 2263 ("GNUmakefile\\'" . makefile-gmake-mode)
813731b3
DP
2264 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2265 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
47d4e709 2266 ("[Mm]akefile\\'" . makefile-gmake-mode)))
27a7c83f 2267 ("\\.am\\'" . makefile-automake-mode)
5c6d31a4
SM
2268 ;; Less common extensions come here
2269 ;; so more common ones above are found faster.
ffc0e1ca
AS
2270 ("\\.texinfo\\'" . texinfo-mode)
2271 ("\\.te?xi\\'" . texinfo-mode)
bbc67516 2272 ("\\.[sS]\\'" . asm-mode)
ffc0e1ca 2273 ("\\.asm\\'" . asm-mode)
5e339ee2
GM
2274 ("\\.css\\'" . css-mode)
2275 ("\\.mixal\\'" . mixal-mode)
2276 ("\\.gcov\\'" . compilation-mode)
2277 ;; Besides .gdbinit, gdb documents other names to be usable for init
2278 ;; files, cross-debuggers can use something like
2279 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2280 ;; don't interfere with each other.
2281 ("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode)
bbc67516 2282 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
40656849 2283 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
ffc0e1ca
AS
2284 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2285 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2286 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
b921b596 2287 ("\\.bash\\'" . sh-mode)
ffc0e1ca
AS
2288 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2289 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2290 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
d5798fa7 2291 ("\\.m?spec\\'" . sh-mode)
bbc67516 2292 ("\\.m[mes]\\'" . nroff-mode)
ffc0e1ca 2293 ("\\.man\\'" . nroff-mode)
ffc0e1ca 2294 ("\\.sty\\'" . latex-mode)
bbc67516 2295 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
ffc0e1ca
AS
2296 ("\\.bbl\\'" . latex-mode)
2297 ("\\.bib\\'" . bibtex-mode)
5e339ee2 2298 ("\\.bst\\'" . bibtex-style-mode)
ffc0e1ca 2299 ("\\.sql\\'" . sql-mode)
bbc67516 2300 ("\\.m[4c]\\'" . m4-mode)
ffc0e1ca
AS
2301 ("\\.mf\\'" . metafont-mode)
2302 ("\\.mp\\'" . metapost-mode)
2303 ("\\.vhdl?\\'" . vhdl-mode)
2304 ("\\.article\\'" . text-mode)
2305 ("\\.letter\\'" . text-mode)
bbc67516 2306 ("\\.i?tcl\\'" . tcl-mode)
ffc0e1ca 2307 ("\\.exp\\'" . tcl-mode)
ffc0e1ca
AS
2308 ("\\.itk\\'" . tcl-mode)
2309 ("\\.icn\\'" . icon-mode)
2310 ("\\.sim\\'" . simula-mode)
2311 ("\\.mss\\'" . scribe-mode)
faf2a174
GM
2312 ;; The Fortran standard does not say anything about file extensions.
2313 ;; .f90 was widely used for F90, now we seem to be trapped into
2314 ;; using a different extension for each language revision.
2315 ;; Anyway, the following extensions are supported by gfortran.
bbc67516 2316 ("\\.f9[05]\\'" . f90-mode)
faf2a174 2317 ("\\.f0[38]\\'" . f90-mode)
8f9495e7 2318 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
4998f839 2319 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
e6e267fc 2320 ("\\.srt\\'" . srecode-template-mode)
ffc0e1ca
AS
2321 ("\\.prolog\\'" . prolog-mode)
2322 ("\\.tar\\'" . tar-mode)
0ee6e7b7
JL
2323 ;; The list of archive file extensions should be in sync with
2324 ;; `auto-coding-alist' with `no-conversion' coding system.
e7988f09 2325 ("\\.\\(\
b3671a51
JL
2326arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\
2327ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode)
ccb012c5
SM
2328 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode) ;OpenOffice.org
2329 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages.
ffc0e1ca
AS
2330 ;; Mailer puts message to be edited in
2331 ;; /tmp/Re.... or Message
2332 ("\\`/tmp/Re" . text-mode)
2333 ("/Message[0-9]*\\'" . text-mode)
ffc0e1ca
AS
2334 ;; some news reader is reported to use this
2335 ("\\`/tmp/fol/" . text-mode)
ffc0e1ca
AS
2336 ("\\.oak\\'" . scheme-mode)
2337 ("\\.sgml?\\'" . sgml-mode)
e477ca84 2338 ("\\.x[ms]l\\'" . xml-mode)
11cb1e35 2339 ("\\.dbk\\'" . xml-mode)
ffc0e1ca
AS
2340 ("\\.dtd\\'" . sgml-mode)
2341 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
ba2d8894 2342 ("\\.js\\'" . js-mode) ; javascript-mode would be better
c8d173eb 2343 ("\\.json\\'" . js-mode)
855a2294 2344 ("\\.[ds]?vh?\\'" . verilog-mode)
709d45e1
KG
2345 ;; .emacs or .gnus or .viper following a directory delimiter in
2346 ;; Unix, MSDOG or VMS syntax.
2347 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
ffc0e1ca
AS
2348 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2349 ;; _emacs following a directory delimiter
2350 ;; in MsDos syntax
2351 ("[:/]_emacs\\'" . emacs-lisp-mode)
2352 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2353 ("\\.ml\\'" . lisp-mode)
ce009d0b
GM
2354 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2355 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2356 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2357 ("\\.ld[si]?\\'" . ld-script-mode)
2358 ("ld\\.?script\\'" . ld-script-mode)
54238e6d
GM
2359 ;; .xs is also used for ld scripts, but seems to be more commonly
2360 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2361 ("\\.xs\\'" . c-mode)
19543b17
GM
2362 ;; Explained in binutils ld/genscripts.sh. Eg:
2363 ;; A .x script file is the default script.
2364 ;; A .xr script is for linking without relocation (-r flag). Etc.
2365 ("\\.x[abdsru]?[cnw]?\\'" . ld-script-mode)
5e339ee2
GM
2366 ("\\.zone\\'" . dns-mode)
2367 ("\\.soa\\'" . dns-mode)
ebbcece3
GM
2368 ;; Common Lisp ASDF package system.
2369 ("\\.asd\\'" . lisp-mode)
d5798fa7
SM
2370 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2371 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
ffc0e1ca 2372 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
e854cc22 2373 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
9a905782 2374 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
291cc045 2375 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
e55c4863 2376 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
8a28dd0b 2377 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
ffc0e1ca
AS
2378 ("BROWSE\\'" . ebrowse-tree-mode)
2379 ("\\.ebrowse\\'" . ebrowse-tree-mode)
9ee45b2c 2380 ("#\\*mail\\*" . mail-mode)
80174d35 2381 ("\\.g\\'" . antlr-mode)
56f9dcc9 2382 ("\\.mod\\'" . m2-mode)
80174d35 2383 ("\\.ses\\'" . ses-mode)
80174d35 2384 ("\\.docbook\\'" . sgml-mode)
00daa381 2385 ("\\.com\\'" . dcl-mode)
80174d35
DP
2386 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2387 ;; Windows candidates may be opened case sensitively on Unix
2388 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2389 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
08adf84e 2390 ("\\.ppd\\'" . conf-ppd-mode)
80174d35
DP
2391 ("java.+\\.conf\\'" . conf-javaprop-mode)
2392 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
a35d9075
AS
2393 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2394 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
40656849
CY
2395 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2396 ;; this has lower priority to avoid matching changelog.sgml etc.
2397 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
80174d35
DP
2398 ;; either user's dot-files or under /etc or some such
2399 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2400 ;; alas not all ~/.*rc files are like this
b14f1885 2401 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
80174d35
DP
2402 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2403 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2404 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2405 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2406 ;; this contains everything twice, with space and with colon :-(
2407 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
9ee45b2c
SM
2408 ;; Get rid of any trailing .n.m and try again.
2409 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
5c6d31a4
SM
2410 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2411 ;; Using mode nil rather than `ignore' would let the search continue
2412 ;; through this list (with the shortened name) rather than start over.
bbc67516 2413 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
5d344e88
CY
2414 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)
2415 ;; This should come after "in" stripping (e.g. config.h.in).
2416 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2417 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
5c6d31a4
SM
2418 ;; The following should come after the ChangeLog pattern
2419 ;; for the sake of ChangeLog.1, etc.
2420 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
5d344e88 2421 ("\\.[1-9]\\'" . nroff-mode)))
ffc0e1ca 2422 "Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
2423Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2424\(NON-NIL stands for anything that is not nil; the value does not matter.)
2425Visiting a file whose name matches REGEXP specifies FUNCTION as the
2426mode function to use. FUNCTION will be called, unless it is nil.
2427
2428If the element has the form (REGEXP FUNCTION NON-NIL), then after
2429calling FUNCTION (if it's not nil), we delete the suffix that matched
969be033 2430REGEXP and search the list again for another match.
7b3f3dc2 2431
d5040404
EZ
2432The extensions whose FUNCTION is `archive-mode' should also
2433appear in `auto-coding-alist' with `no-conversion' coding system.
2434
969be033
RS
2435See also `interpreter-mode-alist', which detects executable script modes
2436based on the interpreters they specify to run,
2437and `magic-mode-alist', which determines modes based on file contents.")
3029e594 2438(put 'auto-mode-alist 'risky-local-variable t)
e13322a0 2439
73936494
RS
2440(defun conf-mode-maybe ()
2441 "Select Conf mode or XML mode according to start of file."
2442 (if (save-excursion
2443 (save-restriction
2444 (widen)
2445 (goto-char (point-min))
2446 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
e477ca84 2447 (xml-mode)
73936494
RS
2448 (conf-mode)))
2449
d7fa5aa2 2450(defvar interpreter-mode-alist
f209c999
MS
2451 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2452 ;; and pike-mode) are added through autoload directives in that
2453 ;; file. That way is discouraged since it spreads out the
2454 ;; definition of the initial value.
a7610c52 2455 (mapcar
e8e4d5c8
SS
2456 (lambda (l)
2457 (cons (purecopy (car l)) (cdr l)))
ffc0e1ca
AS
2458 '(("perl" . perl-mode)
2459 ("perl5" . perl-mode)
2460 ("miniperl" . perl-mode)
2461 ("wish" . tcl-mode)
2462 ("wishx" . tcl-mode)
2463 ("tcl" . tcl-mode)
2464 ("tclsh" . tcl-mode)
ffc0e1ca
AS
2465 ("scm" . scheme-mode)
2466 ("ash" . sh-mode)
2467 ("bash" . sh-mode)
2468 ("bash2" . sh-mode)
2469 ("csh" . sh-mode)
2470 ("dtksh" . sh-mode)
2471 ("es" . sh-mode)
2472 ("itcsh" . sh-mode)
2473 ("jsh" . sh-mode)
2474 ("ksh" . sh-mode)
2475 ("oash" . sh-mode)
2476 ("pdksh" . sh-mode)
7a6b1aef 2477 ("rbash" . sh-mode)
ffc0e1ca
AS
2478 ("rc" . sh-mode)
2479 ("rpm" . sh-mode)
2480 ("sh" . sh-mode)
2481 ("sh5" . sh-mode)
2482 ("tcsh" . sh-mode)
2483 ("wksh" . sh-mode)
2484 ("wsh" . sh-mode)
2485 ("zsh" . sh-mode)
2486 ("tail" . text-mode)
2487 ("more" . text-mode)
2488 ("less" . text-mode)
2489 ("pg" . text-mode)
27a7c83f 2490 ("make" . makefile-gmake-mode) ; Debian uses this
ffc0e1ca 2491 ("guile" . scheme-mode)
04525749
GM
2492 ("clisp" . lisp-mode)
2493 ("emacs" . emacs-lisp-mode)))
c907d156 2494 "Alist mapping interpreter names to major modes.
969be033 2495This is used for files whose first lines match `auto-mode-interpreter-regexp'.
c907d156 2496Each element looks like (INTERPRETER . MODE).
9f01a773
RS
2497If INTERPRETER matches the name of the interpreter specified in the first line
2498of a script, mode MODE is enabled.
969be033
RS
2499
2500See also `auto-mode-alist'.")
c907d156 2501
7b447e9b
GM
2502(define-obsolete-variable-alias 'inhibit-first-line-modes-regexps
2503 'inhibit-file-local-variables-regexps "24.1")
2504
2505;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2506;; because we are duplicating info from auto-mode-alist.
2507;; TODO many elements of this list are also in auto-coding-alist.
2508(defvar inhibit-local-variables-regexps
2509 (mapcar 'purecopy '("\\.tar\\'" "\\.t[bg]z\\'"
2510 "\\.arc\\'" "\\.zip\\'" "\\.lzh\\'" "\\.lha\\'"
2511 "\\.zoo\\'" "\\.[jew]ar\\'" "\\.xpi\\'" "\\.rar\\'"
2512 "\\.7z\\'"
2513 "\\.sx[dmicw]\\'" "\\.odt\\'"
2514 "\\.tiff?\\'" "\\.gif\\'" "\\.png\\'" "\\.jpe?g\\'"))
2515 "List of regexps matching file names in which to ignore local variables.
2516This includes `-*-' lines as well as trailing \"Local Variables\" sections.
2517Files matching this list are typically binary file formats.
2518They may happen to contain sequences that look like local variable
2519specifications, but are not really, or they may be containers for
2520member files with their own local variable sections, which are
2521not appropriate for the containing file.
2522See also `inhibit-local-variables-suffixes'.")
2523
2524(define-obsolete-variable-alias 'inhibit-first-line-modes-suffixes
2525 'inhibit-local-variables-suffixes "24.1")
2526
2527(defvar inhibit-local-variables-suffixes nil
2528 "List of regexps matching suffixes to remove from file names.
2529When checking `inhibit-local-variables-regexps', we first discard
b20ff6d0
RS
2530from the end of the file name anything that matches one of these regexps.")
2531
7b447e9b
GM
2532;; TODO explicitly add case-fold-search t?
2533(defun inhibit-local-variables-p ()
2534 "Return non-nil if file local variables should be ignored.
2535This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2536and `inhibit-local-variables-suffixes'."
2537 (let ((temp inhibit-local-variables-regexps)
2538 (name (if buffer-file-name
2539 (file-name-sans-versions buffer-file-name)
2540 (buffer-name))))
2541 (while (let ((sufs inhibit-local-variables-suffixes))
2542 (while (and sufs (not (string-match (car sufs) name)))
2543 (setq sufs (cdr sufs)))
2544 sufs)
2545 (setq name (substring name 0 (match-beginning 0))))
2546 (while (and temp
2547 (not (string-match (car temp) name)))
2548 (setq temp (cdr temp)))
2549 temp))
2550
ffc0e1ca 2551(defvar auto-mode-interpreter-regexp
1e8780b1
DN
2552 (purecopy "#![ \t]?\\([^ \t\n]*\
2553/bin/env[ \t]\\)?\\([^ \t\n]+\\)")
54005870 2554 "Regexp matching interpreters, for file mode determination.
ffc0e1ca 2555This regular expression is matched against the first line of a file
54005870
LT
2556to determine the file's mode in `set-auto-mode'. If it matches, the file
2557is assumed to be interpreted by the interpreter matched by the second group
2558of the regular expression. The mode is then determined as the mode
2559associated with that interpreter in `interpreter-mode-alist'.")
0720b68b 2560
1a5bfb0e 2561(defvar magic-mode-alist nil
c11781de
SM
2562 "Alist of buffer beginnings vs. corresponding major mode functions.
2563Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2564After visiting a file, if REGEXP matches the text at the beginning of the
2565buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2566call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2567major mode.
2568
2569If FUNCTION is nil, then it is not called. (That is a way of saying
2570\"allow `auto-mode-alist' to decide for these files.\")")
2571(put 'magic-mode-alist 'risky-local-variable t)
2572
2573(defvar magic-fallback-mode-alist
1e8780b1 2574 (purecopy
1a5bfb0e 2575 `((image-type-auto-detected-p . image-mode)
e15f58f8 2576 ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip
1a5bfb0e 2577 ;; The < comes before the groups (but the first) to reduce backtracking.
4ac1d37a 2578 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
efaa82ff 2579 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
32a0479a 2580 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
efaa82ff
GM
2581 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2582 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
32a0479a 2583 comment-re "*"
efaa82ff 2584 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
969be033
RS
2585 "[Hh][Tt][Mm][Ll]"))
2586 . html-mode)
815fde34 2587 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
4ac1d37a 2588 ;; These two must come after html, because they are more general:
e477ca84 2589 ("<\\?xml " . xml-mode)
811cab86 2590 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
e7d313a0
GM
2591 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2592 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
969be033 2593 . sgml-mode)
12333e2b 2594 ("%!PS" . ps-mode)
1e8780b1 2595 ("# xmcd " . conf-unix-mode)))
14774875
RS
2596 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2597Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2598After visiting a file, if REGEXP matches the text at the beginning of the
2599buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2600call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2601have not specified a mode for this file.
2602
2603If FUNCTION is nil, then it is not called.")
92228a10 2604(put 'magic-fallback-mode-alist 'risky-local-variable t)
14774875 2605
5cce080e 2606(defvar magic-mode-regexp-match-limit 4000
14774875 2607 "Upper limit on `magic-mode-alist' regexp matches.
92228a10 2608Also applies to `magic-fallback-mode-alist'.")
5cce080e 2609
9e6f5419 2610(defun set-auto-mode (&optional keep-mode-if-same)
b4da00e9 2611 "Select major mode appropriate for current buffer.
4ac1d37a 2612
f3860cea 2613To find the right major mode, this function checks for a -*- mode tag
e145f188 2614checks for a `mode:' entry in the Local Variables section of the file,
c022c4c4
RS
2615checks if it uses an interpreter listed in `interpreter-mode-alist',
2616matches the buffer beginning against `magic-mode-alist',
2617compares the filename against the entries in `auto-mode-alist',
2618then matches the buffer beginning against `magic-fallback-mode-alist'.
e3998da1 2619
7b447e9b
GM
2620If `enable-local-variables' is nil, or if the file name matches
2621`inhibit-local-variables-regexps', this function does not check
2622for any mode: tag anywhere in the file. If `local-enable-local-variables'
2623is nil, then the only mode: tag that can be relevant is a -*- one.
9de9b6a2 2624
521cf174 2625If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
c022c4c4
RS
2626set the major mode only if that would change it. In other words
2627we don't actually set it to the same mode the buffer already has."
b4da00e9 2628 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
7b447e9b
GM
2629 (let ((try-locals (not (inhibit-local-variables-p)))
2630 end done mode modes)
e145f188 2631 ;; Once we drop the deprecated feature where mode: is also allowed to
f0da764a 2632 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
e145f188
GM
2633 ;; remove this section and just let (hack-local-variables t) handle it.
2634 ;; Find a -*- mode tag.
b4da00e9
RM
2635 (save-excursion
2636 (goto-char (point-min))
2637 (skip-chars-forward " \t\n")
7b447e9b 2638 ;; Note by design local-enable-local-variables does not matter here.
9fa7bfe5 2639 (and enable-local-variables
7b447e9b 2640 try-locals
e3f9b9c0 2641 (setq end (set-auto-mode-1))
2d2ab9da
RS
2642 (if (save-excursion (search-forward ":" end t))
2643 ;; Find all specifications for the `mode:' variable
2644 ;; and execute them left to right.
2645 (while (let ((case-fold-search t))
2646 (or (and (looking-at "mode:")
2647 (goto-char (match-end 0)))
2648 (re-search-forward "[ \t;]mode:" end t)))
2649 (skip-chars-forward " \t")
2650 (let ((beg (point)))
9fa7bfe5
RS
2651 (if (search-forward ";" end t)
2652 (forward-char -1)
2653 (goto-char end))
2654 (skip-chars-backward " \t")
9ee45b2c 2655 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2d2ab9da
RS
2656 modes)))
2657 ;; Simple -*-MODE-*- case.
2658 (push (intern (concat (downcase (buffer-substring (point) end))
2659 "-mode"))
2660 modes))))
9e6f5419
DP
2661 ;; If we found modes to use, invoke them now, outside the save-excursion.
2662 (if modes
521cf174
DP
2663 (catch 'nop
2664 (dolist (mode (nreverse modes))
2665 (if (not (functionp mode))
2666 (message "Ignoring unknown mode `%s'" mode)
2667 (setq done t)
3467488e 2668 (or (set-auto-mode-0 mode keep-mode-if-same)
df4d0613 2669 ;; continuing would call minor modes again, toggling them off
ec6328a2 2670 (throw 'nop nil))))))
7b447e9b
GM
2671 ;; hack-local-variables checks local-enable-local-variables etc, but
2672 ;; we might as well be explicit here for the sake of clarity.
e145f188
GM
2673 (and (not done)
2674 enable-local-variables
7b447e9b
GM
2675 local-enable-local-variables
2676 try-locals
e145f188
GM
2677 (setq mode (hack-local-variables t))
2678 (not (memq mode modes)) ; already tried and failed
2679 (if (not (functionp mode))
2680 (message "Ignoring unknown mode `%s'" mode)
2681 (setq done t)
2682 (set-auto-mode-0 mode keep-mode-if-same)))
14774875
RS
2683 ;; If we didn't, look for an interpreter specified in the first line.
2684 ;; As a special case, allow for things like "#!/bin/env perl", which
2685 ;; finds the interpreter anywhere in $PATH.
ec6328a2 2686 (unless done
9e6f5419
DP
2687 (setq mode (save-excursion
2688 (goto-char (point-min))
2689 (if (looking-at auto-mode-interpreter-regexp)
2690 (match-string 2)
2691 ""))
8350f087 2692 ;; Map interpreter name to a mode, signaling we're done at the
9e6f5419
DP
2693 ;; same time.
2694 done (assoc (file-name-nondirectory mode)
2695 interpreter-mode-alist))
811cab86 2696 ;; If we found an interpreter mode to use, invoke it now.
df4d0613
DP
2697 (if done
2698 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
14774875 2699 ;; Next try matching the buffer beginning against magic-mode-alist.
df4d0613 2700 (unless done
4ac1d37a
DP
2701 (if (setq done (save-excursion
2702 (goto-char (point-min))
5cce080e
KS
2703 (save-restriction
2704 (narrow-to-region (point-min)
2705 (min (point-max)
2706 (+ (point-min) magic-mode-regexp-match-limit)))
2707 (assoc-default nil magic-mode-alist
06b60517 2708 (lambda (re _dummy)
10ffa2a1
KS
2709 (if (functionp re)
2710 (funcall re)
2711 (looking-at re)))))))
14774875
RS
2712 (set-auto-mode-0 done keep-mode-if-same)))
2713 ;; Next compare the filename against the entries in auto-mode-alist.
2714 (unless done
2715 (if buffer-file-name
f1fa5062
MA
2716 (let ((name buffer-file-name)
2717 (remote-id (file-remote-p buffer-file-name)))
28dbc92f
MA
2718 ;; Remove backup-suffixes from file name.
2719 (setq name (file-name-sans-versions name))
f1fa5062
MA
2720 ;; Remove remote file name identification.
2721 (when (and (stringp remote-id)
32650100 2722 (string-match (regexp-quote remote-id) name))
f1fa5062 2723 (setq name (substring name (match-end 0))))
14774875
RS
2724 (while name
2725 ;; Find first matching alist entry.
2726 (setq mode
7c2fb837 2727 (if (memq system-type '(windows-nt cygwin))
14774875
RS
2728 ;; System is case-insensitive.
2729 (let ((case-fold-search t))
2730 (assoc-default name auto-mode-alist
2731 'string-match))
2732 ;; System is case-sensitive.
2733 (or
2734 ;; First match case-sensitively.
2735 (let ((case-fold-search nil))
2736 (assoc-default name auto-mode-alist
2737 'string-match))
2738 ;; Fallback to case-insensitive match.
2739 (and auto-mode-case-fold
2740 (let ((case-fold-search t))
2741 (assoc-default name auto-mode-alist
2742 'string-match))))))
2743 (if (and mode
2744 (consp mode)
2745 (cadr mode))
2746 (setq mode (car mode)
2747 name (substring name 0 (match-beginning 0)))
2748 (setq name))
2749 (when mode
2750 (set-auto-mode-0 mode keep-mode-if-same)
2751 (setq done t))))))
92228a10 2752 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
14774875
RS
2753 (unless done
2754 (if (setq done (save-excursion
2755 (goto-char (point-min))
2756 (save-restriction
2757 (narrow-to-region (point-min)
2758 (min (point-max)
2759 (+ (point-min) magic-mode-regexp-match-limit)))
92228a10 2760 (assoc-default nil magic-fallback-mode-alist
06b60517 2761 (lambda (re _dummy)
14774875
RS
2762 (if (functionp re)
2763 (funcall re)
2764 (looking-at re)))))))
2765 (set-auto-mode-0 done keep-mode-if-same)))))
521cf174 2766
521cf174
DP
2767;; When `keep-mode-if-same' is set, we are working on behalf of
2768;; set-visited-file-name. In that case, if the major mode specified is the
2769;; same one we already have, don't actually reset it. We don't want to lose
2770;; minor modes such as Font Lock.
3467488e 2771(defun set-auto-mode-0 (mode &optional keep-mode-if-same)
521cf174 2772 "Apply MODE and return it.
3467488e
KS
2773If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2774any aliases and compared to current major mode. If they are the
2775same, do nothing and return nil."
0c7c413c
CY
2776 (unless (and keep-mode-if-same
2777 (eq (indirect-function mode)
2778 (indirect-function major-mode)))
2779 (when mode
2780 (funcall mode)
2781 mode)))
b4da00e9 2782
e3f9b9c0
RS
2783(defun set-auto-mode-1 ()
2784 "Find the -*- spec in the buffer.
2785Call with point at the place to start searching from.
7b447e9b
GM
2786If one is found, set point to the beginning and return the position
2787of the end. Otherwise, return nil; may change point.
2788The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2789be ignored; but `enable-local-variables' and `local-enable-local-variables'
2790have no effect."
e3f9b9c0
RS
2791 (let (beg end)
2792 (and
2793 ;; Don't look for -*- if this file name matches any
7b447e9b
GM
2794 ;; of the regexps in inhibit-local-variables-regexps.
2795 (not (inhibit-local-variables-p))
f587e30b 2796 (search-forward "-*-" (line-end-position
7b447e9b
GM
2797 ;; If the file begins with "#!" (exec
2798 ;; interpreter magic), look for mode frobs
2799 ;; in the first two lines. You cannot
2800 ;; necessarily put them in the first line
2801 ;; of such a file without screwing up the
2802 ;; interpreter invocation. The same holds
2803 ;; for '\" in man pages (preprocessor
dddb4597
WL
2804 ;; magic for the `man' program).
2805 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
e3f9b9c0
RS
2806 (progn
2807 (skip-chars-forward " \t")
2808 (setq beg (point))
f587e30b 2809 (search-forward "-*-" (line-end-position) t))
e3f9b9c0
RS
2810 (progn
2811 (forward-char -3)
2812 (skip-chars-backward " \t")
2813 (setq end (point))
2814 (goto-char beg)
2815 end))))
b9e1451a
CY
2816\f
2817;;; Handling file local variables
2818
2819(defvar ignored-local-variables
2b8ac025 2820 '(ignored-local-variables safe-local-variable-values
8c8b0185 2821 file-local-variables-alist dir-local-variables-alist)
b9e1451a 2822 "Variables to be ignored in a file's local variable spec.")
3029e594 2823(put 'ignored-local-variables 'risky-local-variable t)
b9e1451a
CY
2824
2825(defvar hack-local-variables-hook nil
2826 "Normal hook run after processing a file's local variables specs.
2827Major modes can use this to examine user-specified local variables
2828in order to initialize other data structure based on them.")
2829
2830(defcustom safe-local-variable-values nil
2831 "List variable-value pairs that are considered safe.
2832Each element is a cons cell (VAR . VAL), where VAR is a variable
2833symbol and VAL is a value that is considered safe."
3029e594 2834 :risky t
b9e1451a 2835 :group 'find-file
094eabe4 2836 :type 'alist)
b9e1451a 2837
182b3bec 2838(defcustom safe-local-eval-forms
5582c670
GM
2839 ;; This should be here at least as long as Emacs supports write-file-hooks.
2840 '((add-hook 'write-file-hooks 'time-stamp)
2841 (add-hook 'write-file-functions 'time-stamp)
561580e9 2842 (add-hook 'before-save-hook 'time-stamp))
ba83982b 2843 "Expressions that are considered safe in an `eval:' local variable.
b9e1451a
CY
2844Add expressions to this list if you want Emacs to evaluate them, when
2845they appear in an `eval' local variable specification, without first
2846asking you for confirmation."
3029e594 2847 :risky t
b9e1451a 2848 :group 'find-file
5582c670 2849 :version "24.1" ; added write-file-hooks
b9e1451a
CY
2850 :type '(repeat sexp))
2851
2852;; Risky local variables:
2853(mapc (lambda (var) (put var 'risky-local-variable t))
2854 '(after-load-alist
b9e1451a
CY
2855 buffer-auto-save-file-name
2856 buffer-file-name
2857 buffer-file-truename
2858 buffer-undo-list
b9e1451a
CY
2859 debugger
2860 default-text-properties
b9e1451a
CY
2861 eval
2862 exec-directory
2863 exec-path
2864 file-name-handler-alist
b9e1451a
CY
2865 frame-title-format
2866 global-mode-string
2867 header-line-format
2868 icon-title-format
b9e1451a 2869 inhibit-quit
b9e1451a
CY
2870 load-path
2871 max-lisp-eval-depth
2872 max-specpdl-size
b9e1451a
CY
2873 minor-mode-map-alist
2874 minor-mode-overriding-map-alist
b9e1451a 2875 mode-line-format
b9e1451a 2876 mode-name
b9e1451a
CY
2877 overriding-local-map
2878 overriding-terminal-local-map
b9e1451a 2879 process-environment
b9e1451a
CY
2880 standard-input
2881 standard-output
3029e594 2882 unread-command-events))
b9e1451a
CY
2883
2884;; Safe local variables:
2885;;
3e457225
RS
2886;; For variables defined by major modes, the safety declarations can go into
2887;; the major mode's file, since that will be loaded before file variables are
2888;; processed.
2889;;
2890;; For variables defined by minor modes, put the safety declarations in the
2891;; file defining the minor mode after the defcustom/defvar using an autoload
2892;; cookie, e.g.:
2893;;
2894;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2895;;
2896;; Otherwise, when Emacs visits a file specifying that local variable, the
2897;; minor mode file may not be loaded yet.
2898;;
2899;; For variables defined in the C source code the declaration should go here:
b9e1451a 2900
b38b1ec0
SM
2901(dolist (pair
2902 '((buffer-read-only . booleanp) ;; C source code
2903 (default-directory . stringp) ;; C source code
2904 (fill-column . integerp) ;; C source code
2905 (indent-tabs-mode . booleanp) ;; C source code
2906 (left-margin . integerp) ;; C source code
2907 (no-update-autoloads . booleanp)
2908 (lexical-binding . booleanp) ;; C source code
2909 (tab-width . integerp) ;; C source code
2910 (truncate-lines . booleanp) ;; C source code
2911 (word-wrap . booleanp) ;; C source code
2912 (bidi-display-reordering . booleanp))) ;; C source code
2913 (put (car pair) 'safe-local-variable (cdr pair)))
b9e1451a 2914
cd83d522
EZ
2915(put 'bidi-paragraph-direction 'safe-local-variable
2916 (lambda (v) (memq v '(nil right-to-left left-to-right))))
2917
b9e1451a 2918(put 'c-set-style 'safe-local-eval-function t)
e3f9b9c0 2919
2b8ac025
CY
2920(defvar file-local-variables-alist nil
2921 "Alist of file-local variable settings in the current buffer.
2922Each element in this list has the form (VAR . VALUE), where VAR
2923is a file-local variable (a symbol) and VALUE is the value
2924specified. The actual value in the buffer may differ from VALUE,
2925if it is changed by the major or minor modes, or by the user.")
2926(make-variable-buffer-local 'file-local-variables-alist)
2a8a455e 2927(put 'file-local-variables-alist 'permanent-local t)
2b8ac025 2928
8c8b0185
JL
2929(defvar dir-local-variables-alist nil
2930 "Alist of directory-local variable settings in the current buffer.
2931Each element in this list has the form (VAR . VALUE), where VAR
2932is a directory-local variable (a symbol) and VALUE is the value
2933specified in .dir-locals.el. The actual value in the buffer
2934may differ from VALUE, if it is changed by the major or minor modes,
2935or by the user.")
2936(make-variable-buffer-local 'dir-local-variables-alist)
2937
2b8ac025
CY
2938(defvar before-hack-local-variables-hook nil
2939 "Normal hook run before setting file-local variables.
2940It is called after checking for unsafe/risky variables and
2941setting `file-local-variables-alist', and before applying the
2942variables stored in `file-local-variables-alist'. A hook
2943function is allowed to change the contents of this alist.
2944
2945This hook is called only if there is at least one file-local
2946variable to set.")
2947
75fd7f12 2948(defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name)
70b49e57
RS
2949 "Get confirmation before setting up local variable values.
2950ALL-VARS is the list of all variables to be set up.
2951UNSAFE-VARS is the list of those that aren't marked as safe or risky.
1b21ee06 2952RISKY-VARS is the list of those that are marked as risky.
07915ed9
GM
2953If these settings come from directory-local variables, then
2954DIR-NAME is the name of the associated directory. Otherwise it is nil."
5a6c1d87
CY
2955 (if noninteractive
2956 nil
3ef01959
CY
2957 (save-window-excursion
2958 (let* ((name (or dir-name
2959 (if buffer-file-name
2960 (file-name-nondirectory buffer-file-name)
2961 (concat "buffer " (buffer-name)))))
2962 (offer-save (and (eq enable-local-variables t)
2963 unsafe-vars))
2964 (exit-chars
2965 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2966 (buf (pop-to-buffer "*Local Variables*"))
2967 prompt char)
2968 (set (make-local-variable 'cursor-type) nil)
2969 (erase-buffer)
2970 (cond
2971 (unsafe-vars
2972 (insert "The local variables list in " name
2973 "\ncontains values that may not be safe (*)"
2974 (if risky-vars
2975 ", and variables that are risky (**)."
2976 ".")))
2977 (risky-vars
2978 (insert "The local variables list in " name
2979 "\ncontains variables that are risky (**)."))
2980 (t
2981 (insert "A local variables list is specified in " name ".")))
2982 (insert "\n\nDo you want to apply it? You can type
5a6c1d87 2983y -- to apply the local variables list.
af467e28 2984n -- to ignore the local variables list.")
3ef01959
CY
2985 (if offer-save
2986 (insert "
dbcd3ce0
EZ
2987! -- to apply the local variables list, and permanently mark these
2988 values (*) as safe (in the future, they will be set automatically.)\n\n")
3ef01959
CY
2989 (insert "\n\n"))
2990 (dolist (elt all-vars)
2991 (cond ((member elt unsafe-vars)
2992 (insert " * "))
2993 ((member elt risky-vars)
2994 (insert " ** "))
2995 (t
2996 (insert " ")))
2997 (princ (car elt) buf)
2998 (insert " : ")
2999 ;; Make strings with embedded whitespace easier to read.
3000 (let ((print-escape-newlines t))
3001 (prin1 (cdr elt) buf))
3002 (insert "\n"))
3003 (setq prompt
3004 (format "Please type %s%s: "
3005 (if offer-save "y, n, or !" "y or n")
3006 (if (< (line-number-at-pos) (window-body-height))
3007 ""
3008 (push ?\C-v exit-chars)
3009 ", or C-v to scroll")))
3010 (goto-char (point-min))
3011 (while (null char)
3012 (setq char (read-char-choice prompt exit-chars t))
3013 (when (eq char ?\C-v)
3014 (condition-case nil
3015 (scroll-up)
3016 (error (goto-char (point-min))))
3017 (setq char nil)))
3018 (kill-buffer buf)
3019 (when (and offer-save (= char ?!) unsafe-vars)
658d8eb8 3020 (customize-push-and-save 'safe-local-variable-values unsafe-vars))
3ef01959 3021 (memq char '(?! ?\s ?y))))))
cc45837e 3022
a0e74e72 3023(defun hack-local-variables-prop-line (&optional mode-only)
5a6c1d87 3024 "Return local variables specified in the -*- line.
88dfa756
GM
3025Returns an alist of elements (VAR . VAL), where VAR is a variable
3026and VAL is the specified value. Ignores any specification for
3027`mode:' and `coding:' (which should have already been handled
3028by `set-auto-mode' and `set-auto-coding', respectively).
3aace4e4 3029Return nil if the -*- line is malformed.
88dfa756
GM
3030
3031If MODE-ONLY is non-nil, just returns the symbol specifying the
3032mode, if there is one, otherwise nil."
3aace4e4
CY
3033 (catch 'malformed-line
3034 (save-excursion
3035 (goto-char (point-min))
3036 (let ((end (set-auto-mode-1))
3037 result)
3038 (cond ((not end)
3039 nil)
3040 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
3041 ;; Simple form: "-*- MODENAME -*-".
3042 (if mode-only
3043 (intern (concat (match-string 1) "-mode"))))
3044 (t
3045 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3046 ;; (last ";" is optional).
3047 ;; If MODE-ONLY, just check for `mode'.
3048 ;; Otherwise, parse the -*- line into the RESULT alist.
3049 (while (and (or (not mode-only)
3050 (not result))
3051 (< (point) end))
3052 (unless (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
3053 (message "Malformed mode-line")
3054 (throw 'malformed-line nil))
3055 (goto-char (match-end 0))
3056 ;; There used to be a downcase here,
3057 ;; but the manual didn't say so,
3058 ;; and people want to set var names that aren't all lc.
3059 (let* ((key (intern (match-string 1)))
3060 (val (save-restriction
3061 (narrow-to-region (point) end)
3062 (let ((read-circle nil))
3063 (read (current-buffer)))))
3064 ;; It is traditional to ignore
3065 ;; case when checking for `mode' in set-auto-mode,
3066 ;; so we must do that here as well.
3067 ;; That is inconsistent, but we're stuck with it.
3068 ;; The same can be said for `coding' in set-auto-coding.
3069 (keyname (downcase (symbol-name key))))
3070 (if mode-only
3071 (and (equal keyname "mode")
3072 (setq result
3073 (intern (concat (downcase (symbol-name val))
3074 "-mode"))))
3075 (or (equal keyname "coding")
3076 (condition-case nil
3077 (push (cons (cond ((eq key 'eval) 'eval)
3078 ;; Downcase "Mode:".
3079 ((equal keyname "mode") 'mode)
3080 (t (indirect-variable key)))
3081 val) result)
3082 (error nil))))
3083 (skip-chars-forward " \t;")))
3084 result))))))
f3e23606 3085
75fd7f12 3086(defun hack-local-variables-filter (variables dir-name)
2b8ac025
CY
3087 "Filter local variable settings, querying the user if necessary.
3088VARIABLES is the alist of variable-value settings. This alist is
3089 filtered based on the values of `ignored-local-variables',
3090 `enable-local-eval', `enable-local-variables', and (if necessary)
3091 user interaction. The results are added to
3092 `file-local-variables-alist', without applying them.
07915ed9
GM
3093If these settings come from directory-local variables, then
3094DIR-NAME is the name of the associated directory. Otherwise it is nil."
89bf83cd
CY
3095 ;; Find those variables that we may want to save to
3096 ;; `safe-local-variable-values'.
3097 (let (all-vars risky-vars unsafe-vars)
3098 (dolist (elt variables)
3099 (let ((var (car elt))
3100 (val (cdr elt)))
3101 (cond ((memq var ignored-local-variables)
3102 ;; Ignore any variable in `ignored-local-variables'.
3103 nil)
3104 ;; Obey `enable-local-eval'.
3105 ((eq var 'eval)
3106 (when enable-local-eval
3107 (push elt all-vars)
3108 (or (eq enable-local-eval t)
3109 (hack-one-local-variable-eval-safep (eval (quote val)))
f95a5fd0 3110 (safe-local-variable-p var val)
89bf83cd 3111 (push elt unsafe-vars))))
cfb54897
JL
3112 ;; Ignore duplicates (except `mode') in the present list.
3113 ((and (assq var all-vars) (not (eq var 'mode))) nil)
89bf83cd
CY
3114 ;; Accept known-safe variables.
3115 ((or (memq var '(mode unibyte coding))
3116 (safe-local-variable-p var val))
3117 (push elt all-vars))
3118 ;; The variable is either risky or unsafe:
3119 ((not (eq enable-local-variables :safe))
3120 (push elt all-vars)
3121 (if (risky-local-variable-p var val)
3122 (push elt risky-vars)
3123 (push elt unsafe-vars))))))
3124 (and all-vars
3125 ;; Query, unless all vars are safe or user wants no querying.
3126 (or (and (eq enable-local-variables t)
3127 (null unsafe-vars)
3128 (null risky-vars))
42e0a725 3129 (memq enable-local-variables '(:all :safe))
89bf83cd
CY
3130 (hack-local-variables-confirm all-vars unsafe-vars
3131 risky-vars dir-name))
3132 (dolist (elt all-vars)
cfb54897 3133 (unless (memq (car elt) '(eval mode))
8c8b0185
JL
3134 (unless dir-name
3135 (setq dir-local-variables-alist
3136 (assq-delete-all (car elt) dir-local-variables-alist)))
89bf83cd
CY
3137 (setq file-local-variables-alist
3138 (assq-delete-all (car elt) file-local-variables-alist)))
3139 (push elt file-local-variables-alist)))))
1b21ee06 3140
9de9b6a2
RS
3141(defun hack-local-variables (&optional mode-only)
3142 "Parse and put into effect this buffer's local variables spec.
27b48e63
GM
3143Uses `hack-local-variables-apply' to apply the variables.
3144
88dfa756 3145If MODE-ONLY is non-nil, all we do is check whether a \"mode:\"
162d78a1
GM
3146is specified, and return the corresponding mode symbol, or nil.
3147In this case, we try to ignore minor-modes, and only return a
7b447e9b
GM
3148major-mode.
3149
3150If `enable-local-variables' or `local-enable-local-variables' is nil,
3151this function does nothing. If `inhibit-local-variables-regexps'
3152applies to the file in question, the file is not scanned for
3153local variables, but directory-local variables may still be applied."
3154 ;; We don't let inhibit-local-variables-p influence the value of
3155 ;; enable-local-variables, because then it would affect dir-local
3156 ;; variables. We don't want to search eg tar files for file local
3157 ;; variable sections, but there is no reason dir-locals cannot apply
3158 ;; to them. The real meaning of inhibit-local-variables-p is "do
3159 ;; not scan this file for local variables".
5a6c1d87
CY
3160 (let ((enable-local-variables
3161 (and local-enable-local-variables enable-local-variables))
3162 result)
2b8ac025
CY
3163 (unless mode-only
3164 (setq file-local-variables-alist nil)
75fd7f12 3165 (report-errors "Directory-local variables error: %s"
7b447e9b 3166 ;; Note this is a no-op if enable-local-variables is nil.
75fd7f12 3167 (hack-dir-local-variables)))
7b447e9b
GM
3168 ;; This entire function is basically a no-op if enable-local-variables
3169 ;; is nil. All it does is set file-local-variables-alist to nil.
3170 (when enable-local-variables
3171 ;; This part used to ignore enable-local-variables when mode-only
3172 ;; was non-nil. That was inappropriate, eg consider the
3173 ;; (artificial) example of:
3174 ;; (setq local-enable-local-variables nil)
3175 ;; Open a file foo.txt that contains "mode: sh".
3176 ;; It correctly opens in text-mode.
3177 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3178 (unless (or (inhibit-local-variables-p)
3179 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3180 ;; mode, then we're done, and have no need to scan further.
3181 (and (setq result (hack-local-variables-prop-line mode-only))
3182 mode-only))
7e4ccca3
GM
3183 ;; Look for "Local variables:" line in last page.
3184 (save-excursion
3185 (goto-char (point-max))
3186 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3187 'move)
3188 (when (let ((case-fold-search t))
3189 (search-forward "Local Variables:" nil t))
3190 (skip-chars-forward " \t")
3191 ;; suffix is what comes after "local variables:" in its line.
3192 ;; prefix is what comes before "local variables:" in its line.
3193 (let ((suffix
3194 (concat
3195 (regexp-quote (buffer-substring (point)
3196 (line-end-position)))
3197 "$"))
3198 (prefix
3199 (concat "^" (regexp-quote
3200 (buffer-substring (line-beginning-position)
3201 (match-beginning 0)))))
3202 beg)
3203
3204 (forward-line 1)
3205 (let ((startpos (point))
3206 endpos
3207 (thisbuf (current-buffer)))
3208 (save-excursion
3209 (unless (let ((case-fold-search t))
3210 (re-search-forward
3211 (concat prefix "[ \t]*End:[ \t]*" suffix)
3212 nil t))
3213 ;; This used to be an error, but really all it means is
3214 ;; that this may simply not be a local-variables section,
3215 ;; so just ignore it.
3216 (message "Local variables list is not properly terminated"))
3217 (beginning-of-line)
3218 (setq endpos (point)))
3219
3220 (with-temp-buffer
3221 (insert-buffer-substring thisbuf startpos endpos)
3222 (goto-char (point-min))
3223 (subst-char-in-region (point) (point-max) ?\^m ?\n)
3224 (while (not (eobp))
3225 ;; Discard the prefix.
3226 (if (looking-at prefix)
3227 (delete-region (point) (match-end 0))
3228 (error "Local variables entry is missing the prefix"))
3229 (end-of-line)
3230 ;; Discard the suffix.
3231 (if (looking-back suffix)
3232 (delete-region (match-beginning 0) (point))
3233 (error "Local variables entry is missing the suffix"))
3234 (forward-line 1))
3235 (goto-char (point-min))
3236
3237 (while (and (not (eobp))
3238 (or (not mode-only)
3239 (not result)))
3240 ;; Find the variable name; strip whitespace.
3241 (skip-chars-forward " \t")
3242 (setq beg (point))
3243 (skip-chars-forward "^:\n")
3244 (if (eolp) (error "Missing colon in local variables entry"))
3245 (skip-chars-backward " \t")
3246 (let* ((str (buffer-substring beg (point)))
3247 (var (let ((read-circle nil))
3248 (read str)))
162d78a1 3249 val val2)
8e999f70
GM
3250 (and (equal (downcase (symbol-name var)) "mode")
3251 (setq var 'mode))
7e4ccca3
GM
3252 ;; Read the variable value.
3253 (skip-chars-forward "^:")
3254 (forward-char 1)
3255 (let ((read-circle nil))
3256 (setq val (read (current-buffer))))
3257 (if mode-only
162d78a1
GM
3258 (and (eq var 'mode)
3259 ;; Specifying minor-modes via mode: is
3260 ;; deprecated, but try to reject them anyway.
3261 (not (string-match
3262 "-minor\\'"
98f593b8 3263 (setq val2 (downcase (symbol-name val)))))
162d78a1 3264 (setq result (intern (concat val2 "-mode"))))
7e4ccca3
GM
3265 (unless (eq var 'coding)
3266 (condition-case nil
3267 (push (cons (if (eq var 'eval)
3268 'eval
3269 (indirect-variable var))
3270 val) result)
3271 (error nil)))))
7b447e9b
GM
3272 (forward-line 1))))))))
3273 ;; Now we've read all the local variables.
3274 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3275 (if mode-only result
3276 ;; Otherwise, set the variables.
3277 (hack-local-variables-filter result nil)
3278 (hack-local-variables-apply)))))
8117868f
DN
3279
3280(defun hack-local-variables-apply ()
27b48e63
GM
3281 "Apply the elements of `file-local-variables-alist'.
3282If there are any elements, runs `before-hack-local-variables-hook',
3283then calls `hack-one-local-variable' to apply the alist elements one by one.
3284Finishes by running `hack-local-variables-hook', regardless of whether
3285the alist is empty or not.
3286
3287Note that this function ignores a `mode' entry if it specifies the same
3288major mode as the buffer already has."
8117868f
DN
3289 (when file-local-variables-alist
3290 ;; Any 'evals must run in the Right sequence.
3291 (setq file-local-variables-alist
3292 (nreverse file-local-variables-alist))
3293 (run-hooks 'before-hack-local-variables-hook)
3294 (dolist (elt file-local-variables-alist)
3295 (hack-one-local-variable (car elt) (cdr elt))))
3296 (run-hooks 'hack-local-variables-hook))
5a6c1d87 3297
5a6c1d87
CY
3298(defun safe-local-variable-p (sym val)
3299 "Non-nil if SYM is safe as a file-local variable with value VAL.
3300It is safe if any of these conditions are met:
3301
3302 * There is a matching entry (SYM . VAL) in the
3303 `safe-local-variable-values' user option.
3304
5a6c1d87
CY
3305 * The `safe-local-variable' property of SYM is a function that
3306 evaluates to a non-nil value with VAL as an argument."
3307 (or (member (cons sym val) safe-local-variable-values)
3308 (let ((safep (get sym 'safe-local-variable)))
acef0722
SM
3309 (and (functionp safep)
3310 ;; If the function signals an error, that means it
3311 ;; can't assure us that the value is safe.
3312 (with-demoted-errors (funcall safep val))))))
5a6c1d87 3313
06b60517 3314(defun risky-local-variable-p (sym &optional _ignored)
5a6c1d87
CY
3315 "Non-nil if SYM could be dangerous as a file-local variable.
3316It is dangerous if either of these conditions are met:
3317
3318 * Its `risky-local-variable' property is non-nil.
3319
3320 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3321 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
cc5a104d
RS
3322 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3323 \"map-alist\", or \"bindat-spec\"."
f36d46ca
RS
3324 ;; If this is an alias, check the base name.
3325 (condition-case nil
3326 (setq sym (indirect-variable sym))
3327 (error nil))
5a6c1d87
CY
3328 (or (get sym 'risky-local-variable)
3329 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3330-commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3331-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
cc5a104d 3332-map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
7ed9159a 3333
d0bd3513
RS
3334(defun hack-one-local-variable-quotep (exp)
3335 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3336
ff7affeb
RS
3337(defun hack-one-local-variable-constantp (exp)
3338 (or (and (not (symbolp exp)) (not (consp exp)))
3339 (memq exp '(t nil))
3340 (keywordp exp)
3341 (hack-one-local-variable-quotep exp)))
3342
3343(defun hack-one-local-variable-eval-safep (exp)
3344 "Return t if it is safe to eval EXP when it is found in a file."
8fd9c174
RS
3345 (or (not (consp exp))
3346 ;; Detect certain `put' expressions.
3347 (and (eq (car exp) 'put)
3348 (hack-one-local-variable-quotep (nth 1 exp))
3349 (hack-one-local-variable-quotep (nth 2 exp))
9b3e8086
CY
3350 (let ((prop (nth 1 (nth 2 exp)))
3351 (val (nth 3 exp)))
3352 (cond ((memq prop '(lisp-indent-hook
3353 lisp-indent-function
3354 scheme-indent-function))
3355 ;; Only allow safe values (not functions).
3356 (or (numberp val)
3357 (and (hack-one-local-variable-quotep val)
3358 (eq (nth 1 val) 'defun))))
bc5d1dfb
EZ
3359 ((eq prop 'edebug-form-spec)
3360 ;; Only allow indirect form specs.
b486a098
SM
3361 ;; During bootstrapping, edebug-basic-spec might not be
3362 ;; defined yet.
3363 (and (fboundp 'edebug-basic-spec)
f215a02f
AS
3364 (hack-one-local-variable-quotep val)
3365 (edebug-basic-spec (nth 1 val)))))))
8fd9c174
RS
3366 ;; Allow expressions that the user requested.
3367 (member exp safe-local-eval-forms)
3368 ;; Certain functions can be allowed with safe arguments
3369 ;; or can specify verification functions to try.
3370 (and (symbolp (car exp))
b8f82dc1
GM
3371 ;; Allow (minor)-modes calls with no arguments.
3372 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
89bd9ccd 3373 (or (and (member (cdr exp) '(nil (1) (0) (-1)))
b8f82dc1
GM
3374 (string-match "-mode\\'" (symbol-name (car exp))))
3375 (let ((prop (get (car exp) 'safe-local-eval-function)))
3376 (cond ((eq prop t)
3377 (let ((ok t))
3378 (dolist (arg (cdr exp))
3379 (unless (hack-one-local-variable-constantp arg)
3380 (setq ok nil)))
3381 ok))
3382 ((functionp prop)
3383 (funcall prop exp))
3384 ((listp prop)
3385 (let ((ok nil))
3386 (dolist (function prop)
3387 (if (funcall function exp)
3388 (setq ok t)))
3389 ok))))))))
ff7affeb 3390
f3e23606 3391(defun hack-one-local-variable (var val)
0c7c413c
CY
3392 "Set local variable VAR with value VAL.
3393If VAR is `mode', call `VAL-mode' as a function unless it's
3394already the major mode."
f3e23606 3395 (cond ((eq var 'mode)
0c7c413c
CY
3396 (let ((mode (intern (concat (downcase (symbol-name val))
3397 "-mode"))))
3398 (unless (eq (indirect-function mode)
3399 (indirect-function major-mode))
645b9326
CY
3400 (if (memq mode minor-mode-list)
3401 ;; A minor mode must be passed an argument.
3402 ;; Otherwise, if the user enables the minor mode in a
3403 ;; major mode hook, this would toggle it off.
3404 (funcall mode 1)
3405 (funcall mode)))))
5a6c1d87
CY
3406 ((eq var 'eval)
3407 (save-excursion (eval val)))
e442c62b
SM
3408 (t
3409 ;; Make sure the string has no text properties.
3410 ;; Some text properties can get evaluated in various ways,
3411 ;; so it is risky to put them on with a local variable list.
3412 (if (stringp val)
3413 (set-text-properties 0 (length val) nil val))
3414 (set (make-local-variable var) val))))
1b21ee06 3415\f
75fd7f12 3416;;; Handling directory-local variables, aka project settings.
1b21ee06 3417
75fd7f12 3418(defvar dir-locals-class-alist '()
25760acb
CY
3419 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3420
3421(defvar dir-locals-directory-cache '()
3422 "List of cached directory roots for directory-local variable classes.
3423Each element in this list has the form (DIR CLASS MTIME).
3424DIR is the name of the directory.
3425CLASS is the name of a variable class (a symbol).
3426MTIME is the recorded modification time of the directory-local
ebe401f6
GM
3427variables file associated with this entry. This time is a list
3428of two integers (the same format as `file-attributes'), and is
3429used to test whether the cache entry is still valid.
3430Alternatively, MTIME can be nil, which means the entry is always
3431considered valid.")
1b21ee06 3432
75fd7f12
JL
3433(defsubst dir-locals-get-class-variables (class)
3434 "Return the variable list for CLASS."
3435 (cdr (assq class dir-locals-class-alist)))
1b21ee06 3436
75fd7f12
JL
3437(defun dir-locals-collect-mode-variables (mode-variables variables)
3438 "Collect directory-local variables from MODE-VARIABLES.
3439VARIABLES is the initial list of variables.
1b21ee06 3440Returns the new list."
75fd7f12 3441 (dolist (pair mode-variables variables)
1b21ee06
MO
3442 (let* ((variable (car pair))
3443 (value (cdr pair))
75fd7f12 3444 (slot (assq variable variables)))
46253b34
GM
3445 ;; If variables are specified more than once, only use the last. (Why?)
3446 ;; The pseudo-variables mode and eval are different (bug#3430).
3447 (if (and slot (not (memq variable '(mode eval))))
1b21ee06
MO
3448 (setcdr slot value)
3449 ;; Need a new cons in case we setcdr later.
75fd7f12 3450 (push (cons variable value) variables)))))
1b21ee06 3451
75fd7f12
JL
3452(defun dir-locals-collect-variables (class-variables root variables)
3453 "Collect entries from CLASS-VARIABLES into VARIABLES.
1b21ee06 3454ROOT is the root directory of the project.
75fd7f12 3455Return the new variables list."
1b21ee06
MO
3456 (let* ((file-name (buffer-file-name))
3457 (sub-file-name (if file-name
33cf0fb2 3458 ;; FIXME: Why not use file-relative-name?
1b21ee06 3459 (substring file-name (length root)))))
33cf0fb2
SM
3460 (condition-case err
3461 (dolist (entry class-variables variables)
3462 (let ((key (car entry)))
3463 (cond
3464 ((stringp key)
3465 ;; Don't include this in the previous condition, because we
3466 ;; want to filter all strings before the next condition.
3467 (when (and sub-file-name
3468 (>= (length sub-file-name) (length key))
3469 (string-prefix-p key sub-file-name))
3470 (setq variables (dir-locals-collect-variables
3471 (cdr entry) root variables))))
3472 ((or (not key)
3473 (derived-mode-p key))
6640b281
GM
3474 (let* ((alist (cdr entry))
3475 (subdirs (assq 'subdirs alist)))
3476 (if (or (not subdirs)
3477 (progn
3478 (setq alist (delq subdirs alist))
3479 (cdr-safe subdirs))
0e0b2989 3480 ;; TODO someone might want to extend this to allow
6640b281
GM
3481 ;; integer values for subdir, where N means
3482 ;; variables apply to this directory and N levels
3483 ;; below it (0 == nil).
3484 (equal root default-directory))
3485 (setq variables (dir-locals-collect-mode-variables
3486 alist variables))))))))
33cf0fb2
SM
3487 (error
3488 ;; The file's content might be invalid (e.g. have a merge conflict), but
3489 ;; that shouldn't prevent the user from opening the file.
3490 (message ".dir-locals error: %s" (error-message-string err))
3491 nil))))
1b21ee06 3492
c1a70892 3493(defun dir-locals-set-directory-class (directory class &optional mtime)
75fd7f12 3494 "Declare that the DIRECTORY root is an instance of CLASS.
1b21ee06
MO
3495DIRECTORY is the name of a directory, a string.
3496CLASS is the name of a project class, a symbol.
25760acb 3497MTIME is either the modification time of the directory-local
cf66a343 3498variables file that defined this class, or nil.
1b21ee06
MO
3499
3500When a file beneath DIRECTORY is visited, the mode-specific
25760acb 3501variables from CLASS are applied to the buffer. The variables
75fd7f12 3502for a class are defined using `dir-locals-set-class-variables'."
1b21ee06 3503 (setq directory (file-name-as-directory (expand-file-name directory)))
75fd7f12
JL
3504 (unless (assq class dir-locals-class-alist)
3505 (error "No such class `%s'" (symbol-name class)))
25760acb 3506 (push (list directory class mtime) dir-locals-directory-cache))
75fd7f12
JL
3507
3508(defun dir-locals-set-class-variables (class variables)
3509 "Map the type CLASS to a list of variable settings.
3510CLASS is the project class, a symbol. VARIABLES is a list
3511that declares directory-local variables for the class.
3512An element in VARIABLES is either of the form:
1b21ee06
MO
3513 (MAJOR-MODE . ALIST)
3514or
3515 (DIRECTORY . LIST)
3516
3517In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3518whose elements are of the form (VARIABLE . VALUE).
3519
3520In the second form, DIRECTORY is a directory name (a string), and
3521LIST is a list of the form accepted by the function.
3522
3523When a file is visited, the file's class is found. A directory
75fd7f12
JL
3524may be assigned a class using `dir-locals-set-directory-class'.
3525Then variables are set in the file's buffer according to the
4a427f58 3526VARIABLES list of the class. The list is processed in order.
1b21ee06
MO
3527
3528* If the element is of the form (MAJOR-MODE . ALIST), and the
3529 buffer's major mode is derived from MAJOR-MODE (as determined
75fd7f12 3530 by `derived-mode-p'), then all the variables in ALIST are
1b21ee06
MO
3531 applied. A MAJOR-MODE of nil may be used to match any buffer.
3532 `make-local-variable' is called for each variable before it is
3533 set.
3534
3535* If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3536 is an initial substring of the file's directory, then LIST is
3537 applied by recursively following these rules."
75fd7f12 3538 (let ((elt (assq class dir-locals-class-alist)))
1b21ee06 3539 (if elt
75fd7f12
JL
3540 (setcdr elt variables)
3541 (push (cons class variables) dir-locals-class-alist))))
1b21ee06 3542
75fd7f12
JL
3543(defconst dir-locals-file ".dir-locals.el"
3544 "File that contains directory-local variables.
3545It has to be constant to enforce uniform values
3546across different environments and users.")
3547
3548(defun dir-locals-find-file (file)
25760acb
CY
3549 "Find the directory-local variables for FILE.
3550This searches upward in the directory tree from FILE.
ebe401f6 3551It stops at the first directory that has been registered in
9a40b8d4 3552`dir-locals-directory-cache' or contains a `dir-locals-file'.
ebe401f6
GM
3553If it finds an entry in the cache, it checks that it is valid.
3554A cache entry with no modification time element (normally, one that
3555has been assigned directly using `dir-locals-set-directory-class', not
3556set from a file) is always valid.
3557A cache entry based on a `dir-locals-file' is valid if the modification
3558time stored in the cache matches the current file modification time.
3559If not, the cache entry is cleared so that the file will be re-read.
3560
3561This function returns either nil (no directory local variables found),
3562or the matching entry from `dir-locals-directory-cache' (a list),
3563or the full path to the `dir-locals-file' (a string) in the case
3564of no valid cache entry."
35f0d8ce 3565 (setq file (expand-file-name file))
8245c361
EZ
3566 (let* ((dir-locals-file-name
3567 (if (eq system-type 'ms-dos)
3568 (dosified-file-name dir-locals-file)
3569 dir-locals-file))
9a40b8d4 3570 (locals-file (locate-dominating-file file dir-locals-file-name))
8245c361 3571 (dir-elt nil))
35f0d8ce 3572 ;; `locate-dominating-file' may have abbreviated the name.
9a40b8d4 3573 (and locals-file
f7fd3d79
GM
3574 (setq locals-file (expand-file-name dir-locals-file-name locals-file)))
3575 ;; Let dir-locals-read-from-file inform us via demoted-errors
3576 ;; about unreadable files, etc.
3577 ;; Maybe we'd want to keep searching though - that is
3578 ;; a locate-dominating-file issue.
3579;;; (or (not (file-readable-p locals-file))
3580;;; (not (file-regular-p locals-file)))
3581;;; (setq locals-file nil))
25760acb
CY
3582 ;; Find the best cached value in `dir-locals-directory-cache'.
3583 (dolist (elt dir-locals-directory-cache)
75fd7f12 3584 (when (and (eq t (compare-strings file nil (length (car elt))
8245c361
EZ
3585 (car elt) nil nil
3586 (memq system-type
3587 '(windows-nt cygwin ms-dos))))
75fd7f12
JL
3588 (> (length (car elt)) (length (car dir-elt))))
3589 (setq dir-elt elt)))
ebe401f6
GM
3590 (if (and dir-elt
3591 (or (null locals-file)
3592 (<= (length (file-name-directory locals-file))
3593 (length (car dir-elt)))))
3594 ;; Found a potential cache entry. Check validity.
3595 ;; A cache entry with no MTIME is assumed to always be valid
3596 ;; (ie, set directly, not from a dir-locals file).
3597 ;; Note, we don't bother to check that there is a matching class
3598 ;; element in dir-locals-class-alist, since that's done by
3599 ;; dir-locals-set-directory-class.
3600 (if (or (null (nth 2 dir-elt))
3601 (let ((cached-file (expand-file-name dir-locals-file-name
3602 (car dir-elt))))
3603 (and (file-readable-p cached-file)
25760acb 3604 (equal (nth 2 dir-elt)
ebe401f6
GM
3605 (nth 5 (file-attributes cached-file))))))
3606 ;; This cache entry is OK.
3607 dir-elt
3608 ;; This cache entry is invalid; clear it.
3609 (setq dir-locals-directory-cache
3610 (delq dir-elt dir-locals-directory-cache))
3611 ;; Return the first existing dir-locals file. Might be the same
3612 ;; as dir-elt's, might not (eg latter might have been deleted).
3613 locals-file)
3614 ;; No cache entry.
3615 locals-file)))
75fd7f12
JL
3616
3617(defun dir-locals-read-from-file (file)
3618 "Load a variables FILE and register a new class and instance.
3619FILE is the name of the file holding the variables to apply.
3620The new class name is the same as the directory in which FILE
1b21ee06
MO
3621is found. Returns the new class name."
3622 (with-temp-buffer
f7fd3d79
GM
3623 ;; Errors reading the file are not very informative.
3624 ;; Eg just "Error: (end-of-file)" does not give any clue that the
3625 ;; problem is related to dir-locals.
3626 (with-demoted-errors
3627 (insert-file-contents file)
3628 (let* ((dir-name (file-name-directory file))
3629 (class-name (intern dir-name))
3630 (variables (let ((read-circle nil))
3631 (read (current-buffer)))))
3632 (dir-locals-set-class-variables class-name variables)
3633 (dir-locals-set-directory-class dir-name class-name
3634 (nth 5 (file-attributes file)))
3635 class-name))))
1b21ee06 3636
75fd7f12
JL
3637(defun hack-dir-local-variables ()
3638 "Read per-directory local variables for the current buffer.
8c8b0185
JL
3639Store the directory-local variables in `dir-local-variables-alist'
3640and `file-local-variables-alist', without applying them."
2b8ac025 3641 (when (and enable-local-variables
8117868f 3642 (not (file-remote-p (or (buffer-file-name) default-directory))))
75fd7f12 3643 ;; Find the variables file.
8117868f 3644 (let ((variables-file (dir-locals-find-file (or (buffer-file-name) default-directory)))
1b21ee06 3645 (class nil)
75fd7f12 3646 (dir-name nil))
1b21ee06 3647 (cond
75fd7f12 3648 ((stringp variables-file)
07915ed9
GM
3649 (setq dir-name (file-name-directory variables-file)
3650 class (dir-locals-read-from-file variables-file)))
75fd7f12 3651 ((consp variables-file)
25760acb
CY
3652 (setq dir-name (nth 0 variables-file))
3653 (setq class (nth 1 variables-file))))
1b21ee06 3654 (when class
75fd7f12
JL
3655 (let ((variables
3656 (dir-locals-collect-variables
3657 (dir-locals-get-class-variables class) dir-name nil)))
3658 (when variables
8c8b0185 3659 (dolist (elt variables)
cfb54897 3660 (unless (memq (car elt) '(eval mode))
8c8b0185
JL
3661 (setq dir-local-variables-alist
3662 (assq-delete-all (car elt) dir-local-variables-alist)))
3663 (push elt dir-local-variables-alist))
75fd7f12 3664 (hack-local-variables-filter variables dir-name)))))))
f3e23606 3665
8117868f 3666(defun hack-dir-local-variables-non-file-buffer ()
89bd9ccd
CY
3667 "Apply directory-local variables to a non-file buffer.
3668For non-file buffers, such as Dired buffers, directory-local
3669variables are looked for in `default-directory' and its parent
3670directories."
8117868f
DN
3671 (hack-dir-local-variables)
3672 (hack-local-variables-apply))
3673
b4da00e9 3674\f
21540597 3675(defcustom change-major-mode-with-file-name t
ba83982b 3676 "Non-nil means \\[write-file] should set the major mode from the file name.
9de9b6a2
RS
3677However, the mode will not be changed if
3678\(1) a local variables list or the `-*-' line specifies a major mode, or
3679\(2) the current major mode is a \"special\" mode,
96e777e1 3680\ not suitable for ordinary files, or
21540597
RS
3681\(3) the new file name does not particularly specify any mode."
3682 :type 'boolean
3683 :group 'editing-basics)
9de9b6a2 3684
f36012a6 3685(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9 3686 "Change name of file visited in current buffer to FILENAME.
1af57101 3687This also renames the buffer to correspond to the new file.
b4da00e9 3688The next time the buffer is saved it will go in the newly specified file.
1af57101 3689FILENAME nil or an empty string means mark buffer as not visiting any file.
b4da00e9 3690Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
3691if you wish to pass an empty string as the argument.
3692
3693The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
3694confirmation in the case where another buffer is already visiting FILENAME.
3695
3696The optional third argument ALONG-WITH-FILE, if non-nil, means that
3697the old visited file has been renamed to the new name FILENAME."
b4da00e9 3698 (interactive "FSet visited file name: ")
c11a94fe
RS
3699 (if (buffer-base-buffer)
3700 (error "An indirect buffer cannot visit a file"))
7b447e9b 3701 (let (truename old-try-locals)
a522e5bf
RS
3702 (if filename
3703 (setq filename
3704 (if (string-equal filename "")
3705 nil
3706 (expand-file-name filename))))
3707 (if filename
3708 (progn
3709 (setq truename (file-truename filename))
3710 (if find-file-visit-truename
a522e5bf 3711 (setq filename truename))))
cbca0a4b 3712 (if filename
e6d0b67a 3713 (let ((new-name (file-name-nondirectory filename)))
cbca0a4b
RS
3714 (if (string= new-name "")
3715 (error "Empty file name"))))
11e314fa 3716 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 3717 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 3718 (not no-query)
9aea757b
CY
3719 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3720 filename)))
7b89d38e 3721 (error "Aborted")))
a522e5bf
RS
3722 (or (equal filename buffer-file-name)
3723 (progn
3724 (and filename (lock-buffer filename))
3725 (unlock-buffer)))
7b447e9b
GM
3726 (setq old-try-locals (not (inhibit-local-variables-p))
3727 buffer-file-name filename)
a522e5bf
RS
3728 (if filename ; make buffer name reflect filename.
3729 (let ((new-name (file-name-nondirectory buffer-file-name)))
a522e5bf 3730 (setq default-directory (file-name-directory buffer-file-name))
67b6fd1c
SM
3731 ;; If new-name == old-name, renaming would add a spurious <2>
3732 ;; and it's considered as a feature in rename-buffer.
a522e5bf
RS
3733 (or (string= new-name (buffer-name))
3734 (rename-buffer new-name t))))
3735 (setq buffer-backed-up nil)
f36012a6
RS
3736 (or along-with-file
3737 (clear-visited-file-modtime))
8ccdc29e 3738 ;; Abbreviate the file names of the buffer.
4826e97f 3739 (if truename
8ccdc29e
RS
3740 (progn
3741 (setq buffer-file-truename (abbreviate-file-name truename))
3742 (if find-file-visit-truename
b1f1ceb8 3743 (setq buffer-file-name truename))))
a522e5bf
RS
3744 (setq buffer-file-number
3745 (if filename
2a47b4f5 3746 (nthcdr 10 (file-attributes buffer-file-name))
7b447e9b
GM
3747 nil))
3748 ;; write-file-functions is normally used for things like ftp-find-file
3749 ;; that visit things that are not local files as if they were files.
3750 ;; Changing to visit an ordinary local file instead should flush the hook.
3751 (kill-local-variable 'write-file-functions)
3752 (kill-local-variable 'local-write-file-hooks)
3753 (kill-local-variable 'revert-buffer-function)
3754 (kill-local-variable 'backup-inhibited)
3755 ;; If buffer was read-only because of version control,
3756 ;; that reason is gone now, so make it writable.
3757 (if vc-mode
3758 (setq buffer-read-only nil))
3759 (kill-local-variable 'vc-mode)
3760 ;; Turn off backup files for certain file names.
3761 ;; Since this is a permanent local, the major mode won't eliminate it.
3762 (and buffer-file-name
3763 backup-enable-predicate
3764 (not (funcall backup-enable-predicate buffer-file-name))
3765 (progn
3766 (make-local-variable 'backup-inhibited)
3767 (setq backup-inhibited t)))
3768 (let ((oauto buffer-auto-save-file-name))
3769 ;; If auto-save was not already on, turn it on if appropriate.
3770 (if (not buffer-auto-save-file-name)
3771 (and buffer-file-name auto-save-default
3772 (auto-save-mode t))
3773 ;; If auto save is on, start using a new name.
3774 ;; We deliberately don't rename or delete the old auto save
3775 ;; for the old visited file name. This is because perhaps
3776 ;; the user wants to save the new state and then compare with the
3777 ;; previous state from the auto save file.
3778 (setq buffer-auto-save-file-name
3779 (make-auto-save-file-name)))
3780 ;; Rename the old auto save file if any.
3781 (and oauto buffer-auto-save-file-name
3782 (file-exists-p oauto)
3783 (rename-file oauto buffer-auto-save-file-name t)))
3784 (and buffer-file-name
3785 (not along-with-file)
3786 (set-buffer-modified-p t))
3787 ;; Update the major mode, if the file name determines it.
3788 (condition-case nil
3789 ;; Don't change the mode if it is special.
3790 (or (not change-major-mode-with-file-name)
3791 (get major-mode 'mode-class)
3792 ;; Don't change the mode if the local variable list specifies it.
3793 ;; The file name can influence whether the local variables apply.
3794 (and old-try-locals
b13f806e 3795 ;; h-l-v also checks it, but might as well be explicit.
7b447e9b
GM
3796 (not (inhibit-local-variables-p))
3797 (hack-local-variables t))
3798 ;; TODO consider making normal-mode handle this case.
3799 (let ((old major-mode))
3800 (set-auto-mode t)
3801 (or (eq old major-mode)
3802 (hack-local-variables))))
3803 (error nil))))
b4da00e9 3804
912192d1 3805(defun write-file (filename &optional confirm)
b4da00e9 3806 "Write current buffer into file FILENAME.
7f99999a 3807This makes the buffer visit that file, and marks it as not modified.
7458cc35 3808
7f99999a
KH
3809If you specify just a directory name as FILENAME, that means to use
3810the default file name but in that directory. You can also yank
074eb6ac 3811the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
7f99999a
KH
3812
3813If the buffer is not already visiting a file, the default file name
3814for the output file is the buffer name.
3815
3816If optional second arg CONFIRM is non-nil, this function
3817asks for confirmation before overwriting an existing file.
912192d1 3818Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
3819;; (interactive "FWrite file: ")
3820 (interactive
3821 (list (if buffer-file-name
3822 (read-file-name "Write file: "
f3684505 3823 nil nil nil nil)
7f99999a
KH
3824 (read-file-name "Write file: " default-directory
3825 (expand-file-name
3826 (file-name-nondirectory (buffer-name))
3827 default-directory)
3828 nil nil))
912192d1 3829 (not current-prefix-arg)))
b4da00e9 3830 (or (null filename) (string-equal filename "")
41f48cb1
RS
3831 (progn
3832 ;; If arg is just a directory,
7f99999a
KH
3833 ;; use the default file name, but in that directory.
3834 (if (file-directory-p filename)
41f48cb1 3835 (setq filename (concat (file-name-as-directory filename)
7f99999a
KH
3836 (file-name-nondirectory
3837 (or buffer-file-name (buffer-name))))))
c2fb8488
RS
3838 (and confirm
3839 (file-exists-p filename)
9aea757b 3840 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
c2fb8488 3841 (error "Canceled")))
5f65549e 3842 (set-visited-file-name filename (not confirm))))
b4da00e9 3843 (set-buffer-modified-p t)
6492b55d
KH
3844 ;; Make buffer writable if file is writable.
3845 (and buffer-file-name
3846 (file-writable-p buffer-file-name)
3847 (setq buffer-read-only nil))
8e5c7b90
SM
3848 (save-buffer)
3849 ;; It's likely that the VC status at the new location is different from
3850 ;; the one at the old location.
3851 (vc-find-file-hook))
b4da00e9
RM
3852\f
3853(defun backup-buffer ()
3854 "Make a backup of the disk file visited by the current buffer, if appropriate.
3855This is normally done before saving the buffer the first time.
27ab6944
KH
3856
3857A backup may be done by renaming or by copying; see documentation of
3858variable `make-backup-files'. If it's done by renaming, then the file is
f3f9e207
RS
3859no longer accessible under its old name.
3860
3861The value is non-nil after a backup was made by renaming.
574c05e2 3862It has the form (MODES SELINUXCONTEXT BACKUPNAME).
f3f9e207
RS
3863MODES is the result of `file-modes' on the original
3864file; this means that the caller, after saving the buffer, should change
3865the modes of the new file to agree with the old modes.
574c05e2
KK
3866SELINUXCONTEXT is the result of `file-selinux-context' on the original
3867file; this means that the caller, after saving the buffer, should change
3868the SELinux context of the new file to agree with the old context.
f3f9e207 3869BACKUPNAME is the backup file name, which is the old file renamed."
b4da00e9
RM
3870 (if (and make-backup-files (not backup-inhibited)
3871 (not buffer-backed-up)
3872 (file-exists-p buffer-file-name)
3873 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3874 '(?- ?l)))
3875 (let ((real-file-name buffer-file-name)
3876 backup-info backupname targets setmodes)
3877 ;; If specified name is a symbolic link, chase it to the target.
3878 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 3879 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
3880 (setq backup-info (find-backup-file-name real-file-name)
3881 backupname (car backup-info)
3882 targets (cdr backup-info))
5c6d31a4
SM
3883 ;; (if (file-directory-p buffer-file-name)
3884 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
3885 (if backup-info
3886 (condition-case ()
3887 (let ((delete-old-versions
3888 ;; If have old versions to maybe delete,
3889 ;; ask the user to confirm now, before doing anything.
3890 ;; But don't actually delete til later.
3891 (and targets
3892 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3893 (or delete-old-versions
9aea757b
CY
3894 (y-or-n-p (format "Delete excess backup versions of %s? "
3895 real-file-name)))))
574c05e2
KK
3896 (modes (file-modes buffer-file-name))
3897 (context (file-selinux-context buffer-file-name)))
eb650569
RS
3898 ;; Actually write the back up file.
3899 (condition-case ()
3900 (if (or file-precious-flag
ffc0e1ca 3901 ; (file-symlink-p buffer-file-name)
eb650569 3902 backup-by-copying
446c63b0 3903 ;; Don't rename a suid or sgid file.
7da6bf00 3904 (and modes (< 0 (logand modes #o6000)))
79d2d279 3905 (not (file-writable-p (file-name-directory real-file-name)))
eb650569
RS
3906 (and backup-by-copying-when-linked
3907 (> (file-nlinks real-file-name) 1))
ffc0e1ca
AS
3908 (and (or backup-by-copying-when-mismatch
3909 (integerp backup-by-copying-when-privileged-mismatch))
eb650569 3910 (let ((attr (file-attributes real-file-name)))
ffc0e1ca
AS
3911 (and (or backup-by-copying-when-mismatch
3912 (and (integerp (nth 2 attr))
3913 (integerp backup-by-copying-when-privileged-mismatch)
3914 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3915 (or (nth 9 attr)
3916 (not (file-ownership-preserved-p real-file-name)))))))
574c05e2 3917 (backup-buffer-copy real-file-name backupname modes context)
eb650569
RS
3918 ;; rename-file should delete old backup.
3919 (rename-file real-file-name backupname t)
574c05e2 3920 (setq setmodes (list modes context backupname)))
eb650569 3921 (file-error
b024d9f0
MD
3922 ;; If trouble writing the backup, write it in
3923 ;; .emacs.d/%backup%.
3924 (setq backupname (locate-user-emacs-file "%backup%~"))
567c1ca9 3925 (message "Cannot write backup file; backing up in %s"
6ba7756e 3926 backupname)
eb650569 3927 (sleep-for 1)
574c05e2 3928 (backup-buffer-copy real-file-name backupname modes context)))
eb650569
RS
3929 (setq buffer-backed-up t)
3930 ;; Now delete the old versions, if desired.
3931 (if delete-old-versions
3932 (while targets
3933 (condition-case ()
3934 (delete-file (car targets))
3935 (file-error nil))
3936 (setq targets (cdr targets))))
3937 setmodes)
3938 (file-error nil))))))
b4da00e9 3939
574c05e2 3940(defun backup-buffer-copy (from-name to-name modes context)
44dce0fb
RS
3941 (let ((umask (default-file-modes)))
3942 (unwind-protect
3943 (progn
3944 ;; Create temp files with strict access rights. It's easy to
3945 ;; loosen them later, whereas it's impossible to close the
3946 ;; time-window of loose permissions otherwise.
3947 (set-default-file-modes ?\700)
0f39d2c9
MR
3948 (when (condition-case nil
3949 ;; Try to overwrite old backup first.
5b2e628f 3950 (copy-file from-name to-name t t t)
0f39d2c9
MR
3951 (error t))
3952 (while (condition-case nil
3953 (progn
3954 (when (file-exists-p to-name)
3955 (delete-file to-name))
5b2e628f 3956 (copy-file from-name to-name nil t t)
0f39d2c9
MR
3957 nil)
3958 (file-already-exists t))
3959 ;; The file was somehow created by someone else between
3960 ;; `delete-file' and `copy-file', so let's try again.
3961 ;; rms says "I think there is also a possible race
3962 ;; condition for making backup files" (emacs-devel 20070821).
3963 nil)))
44dce0fb
RS
3964 ;; Reset the umask.
3965 (set-default-file-modes umask)))
147fbf70 3966 (and modes
574c05e2
KK
3967 (set-file-modes to-name (logand modes #o1777)))
3968 (and context
3969 (set-file-selinux-context to-name context)))
446c63b0 3970
33cf0fb2 3971(defvar file-name-version-regexp
2de9cc1a
RT
3972 "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+\\(?:~[[:digit:]]+\\)?~\\)"
3973 ;; The last ~[[:digit]]+ matches relative versions in git,
3974 ;; e.g. `foo.js.~HEAD~1~'.
33cf0fb2
SM
3975 "Regular expression matching the backup/version part of a file name.
3976Used by `file-name-sans-versions'.")
3977
c3554e95 3978(defun file-name-sans-versions (name &optional keep-backup-version)
ffc0e1ca 3979 "Return file NAME sans backup versions or strings.
b4da00e9 3980This is a separate procedure so your site-init or startup file can
c3554e95
RS
3981redefine it.
3982If the optional argument KEEP-BACKUP-VERSION is non-nil,
33cf0fb2
SM
3983we do not remove backup version numbers, only true file version numbers.
3984See also `file-name-version-regexp'."
6eaebaa2 3985 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
3986 (if handler
3987 (funcall handler 'file-name-sans-versions name keep-backup-version)
3988 (substring name 0
33cf0fb2
SM
3989 (unless keep-backup-version
3990 (string-match (concat file-name-version-regexp "\\'")
3991 name))))))
b4da00e9 3992
cb0cd911 3993(defun file-ownership-preserved-p (file)
ffc0e1ca 3994 "Return t if deleting FILE and rewriting it would preserve the owner."
cb0cd911
RS
3995 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3996 (if handler
3997 (funcall handler 'file-ownership-preserved-p file)
2920e68d 3998 (let ((attributes (file-attributes file 'integer)))
306faa42
RS
3999 ;; Return t if the file doesn't exist, since it's true that no
4000 ;; information would be lost by an (attempted) delete and create.
4001 (or (null attributes)
2920e68d
EZ
4002 (= (nth 2 attributes) (user-uid))
4003 ;; Files created on Windows by Administrator (RID=500)
4004 ;; have the Administrators group (RID=544) recorded as
4005 ;; their owner. Rewriting them will still preserve the
4006 ;; owner.
4007 (and (eq system-type 'windows-nt)
4008 (= (user-uid) 500) (= (nth 2 attributes) 544)))))))
cb0cd911 4009
20b5d24c
RS
4010(defun file-name-sans-extension (filename)
4011 "Return FILENAME sans final \"extension\".
2531b0c3
EZ
4012The extension, in a file name, is the part that follows the last `.',
4013except that a leading `.', if any, doesn't count."
20b5d24c
RS
4014 (save-match-data
4015 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
4016 directory)
2531b0c3
EZ
4017 (if (and (string-match "\\.[^.]*\\'" file)
4018 (not (eq 0 (match-beginning 0))))
20b5d24c 4019 (if (setq directory (file-name-directory filename))
6ee24f1e
RS
4020 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4021 ;; we don't want to expand it.
4022 (concat directory (substring file 0 (match-beginning 0)))
20b5d24c
RS
4023 (substring file 0 (match-beginning 0)))
4024 filename))))
4025
93a2702d
RS
4026(defun file-name-extension (filename &optional period)
4027 "Return FILENAME's final \"extension\".
2531b0c3 4028The extension, in a file name, is the part that follows the last `.',
32483280 4029excluding version numbers and backup suffixes,
2531b0c3 4030except that a leading `.', if any, doesn't count.
93a2702d
RS
4031Return nil for extensionless file names such as `foo'.
4032Return the empty string for file names such as `foo.'.
4033
4034If PERIOD is non-nil, then the returned value includes the period
4035that delimits the extension, and if FILENAME has no extension,
4036the value is \"\"."
4037 (save-match-data
4038 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2531b0c3
EZ
4039 (if (and (string-match "\\.[^.]*\\'" file)
4040 (not (eq 0 (match-beginning 0))))
93a2702d
RS
4041 (substring file (+ (match-beginning 0) (if period 0 1)))
4042 (if period
4043 "")))))
4044
ffc0e1ca
AS
4045(defcustom make-backup-file-name-function nil
4046 "A function to use instead of the default `make-backup-file-name'.
643c985d 4047A value of nil gives the default `make-backup-file-name' behavior.
ffc0e1ca 4048
d5798fa7 4049This could be buffer-local to do something special for specific
ffc0e1ca
AS
4050files. If you define it, you may need to change `backup-file-name-p'
4051and `file-name-sans-versions' too.
4052
4053See also `backup-directory-alist'."
4054 :group 'backup
4055 :type '(choice (const :tag "Default" nil)
4056 (function :tag "Your function")))
4057
4058(defcustom backup-directory-alist nil
4059 "Alist of filename patterns and backup directory names.
4060Each element looks like (REGEXP . DIRECTORY). Backups of files with
4061names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4062relative or absolute. If it is absolute, so that all matching files
4063are backed up into the same directory, the file names in this
4064directory will be the full name of the file backed up with all
4065directory separators changed to `!' to prevent clashes. This will not
4066work correctly if your filesystem truncates the resulting name.
4067
4068For the common case of all backups going into one directory, the alist
4069should contain a single element pairing \".\" with the appropriate
4070directory name.
4071
4072If this variable is nil, or it fails to match a filename, the backup
4073is made in the original file's directory.
4074
4075On MS-DOS filesystems without long names this variable is always
4076ignored."
4077 :group 'backup
dca5e71d 4078 :type '(repeat (cons (regexp :tag "Regexp matching filename")
ffc0e1ca
AS
4079 (directory :tag "Backup directory name"))))
4080
388d6ab5
RS
4081(defun normal-backup-enable-predicate (name)
4082 "Default `backup-enable-predicate' function.
0c2f6dda
RS
4083Checks for files in `temporary-file-directory',
4084`small-temporary-file-directory', and /tmp."
388d6ab5
RS
4085 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
4086 name 0 nil)))
4087 ;; Directory is under temporary-file-directory.
4088 (and (not (eq comp t))
4089 (< comp (- (length temporary-file-directory)))))
0c2f6dda
RS
4090 (let ((comp (compare-strings "/tmp" 0 nil
4091 name 0 nil)))
4092 ;; Directory is under /tmp.
4093 (and (not (eq comp t))
4094 (< comp (- (length "/tmp")))))
388d6ab5
RS
4095 (if small-temporary-file-directory
4096 (let ((comp (compare-strings small-temporary-file-directory
4097 0 nil
4098 name 0 nil)))
4099 ;; Directory is under small-temporary-file-directory.
4100 (and (not (eq comp t))
4101 (< comp (- (length small-temporary-file-directory)))))))))
4102
b4da00e9
RM
4103(defun make-backup-file-name (file)
4104 "Create the non-numeric backup file name for FILE.
ffc0e1ca
AS
4105Normally this will just be the file's name with `~' appended.
4106Customization hooks are provided as follows.
4107
4108If the variable `make-backup-file-name-function' is non-nil, its value
4109should be a function which will be called with FILE as its argument;
4110the resulting name is used.
4111
4112Otherwise a match for FILE is sought in `backup-directory-alist'; see
4113the documentation of that variable. If the directory for the backup
4114doesn't exist, it is created."
4115 (if make-backup-file-name-function
4116 (funcall make-backup-file-name-function file)
4117 (if (and (eq system-type 'ms-dos)
4118 (not (msdos-long-file-names)))
4119 (let ((fn (file-name-nondirectory file)))
4120 (concat (file-name-directory file)
4121 (or (and (string-match "\\`[^.]+\\'" fn)
4122 (concat (match-string 0 fn) ".~"))
4123 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
4124 (concat (match-string 0 fn) "~")))))
4125 (concat (make-backup-file-name-1 file) "~"))))
4126
4127(defun make-backup-file-name-1 (file)
4128 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4129 (let ((alist backup-directory-alist)
6ba7756e 4130 elt backup-directory abs-backup-directory)
ffc0e1ca
AS
4131 (while alist
4132 (setq elt (pop alist))
4133 (if (string-match (car elt) file)
4134 (setq backup-directory (cdr elt)
4135 alist nil)))
eb0455ab
RS
4136 ;; If backup-directory is relative, it should be relative to the
4137 ;; file's directory. By expanding explicitly here, we avoid
4138 ;; depending on default-directory.
4139 (if backup-directory
6ba7756e
RS
4140 (setq abs-backup-directory
4141 (expand-file-name backup-directory
4142 (file-name-directory file))))
4143 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
ffc0e1ca 4144 (condition-case nil
6ba7756e
RS
4145 (make-directory abs-backup-directory 'parents)
4146 (file-error (setq backup-directory nil
4147 abs-backup-directory nil))))
ee291b46
RS
4148 (if (null backup-directory)
4149 file
ffc0e1ca
AS
4150 (if (file-name-absolute-p backup-directory)
4151 (progn
c60ee5e7 4152 (when (memq system-type '(windows-nt ms-dos cygwin))
d7b6ca4a
RS
4153 ;; Normalize DOSish file names: downcase the drive
4154 ;; letter, if any, and replace the leading "x:" with
4155 ;; "/drive_x".
ffc0e1ca
AS
4156 (or (file-name-absolute-p file)
4157 (setq file (expand-file-name file))) ; make defaults explicit
4158 ;; Replace any invalid file-name characters (for the
4159 ;; case of backing up remote files).
446c097e 4160 (setq file (expand-file-name (convert-standard-filename file)))
ffc0e1ca 4161 (if (eq (aref file 1) ?:)
d7b6ca4a 4162 (setq file (concat "/"
ffc0e1ca
AS
4163 "drive_"
4164 (char-to-string (downcase (aref file 0)))
d7b6ca4a 4165 (if (eq (aref file 2) ?/)
ffc0e1ca 4166 ""
d7b6ca4a 4167 "/")
ffc0e1ca
AS
4168 (substring file 2)))))
4169 ;; Make the name unique by substituting directory
4170 ;; separators. It may not really be worth bothering about
4171 ;; doubling `!'s in the original name...
4172 (expand-file-name
4173 (subst-char-in-string
d7b6ca4a 4174 ?/ ?!
ffc0e1ca
AS
4175 (replace-regexp-in-string "!" "!!" file))
4176 backup-directory))
4177 (expand-file-name (file-name-nondirectory file)
6ba7756e 4178 (file-name-as-directory abs-backup-directory))))))
b4da00e9
RM
4179
4180(defun backup-file-name-p (file)
4181 "Return non-nil if FILE is a backup file name (numeric or not).
4182This is a separate function so you can redefine it for customization.
4183You may need to redefine `file-name-sans-versions' as well."
066327ae 4184 (string-match "~\\'" file))
b4da00e9 4185
e2b30772
RS
4186(defvar backup-extract-version-start)
4187
2d051399 4188;; This is used in various files.
a7aa942a
KH
4189;; The usage of backup-extract-version-start is not very clean,
4190;; but I can't see a good alternative, so as of now I am leaving it alone.
2d051399 4191(defun backup-extract-version (fn)
ffc0e1ca 4192 "Given the name of a numeric backup file, FN, return the backup number.
e2b30772 4193Uses the free variable `backup-extract-version-start', whose value should be
2d051399 4194the index in the name where the version number begins."
6cf29fe8 4195 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
e2b30772 4196 (= (match-beginning 0) backup-extract-version-start))
027a4b6b 4197 (string-to-number (substring fn backup-extract-version-start -1))
2d051399
RS
4198 0))
4199
b4da00e9 4200(defun find-backup-file-name (fn)
ffc0e1ca 4201 "Find a file name for a backup file FN, and suggestions for deletions.
b4da00e9 4202Value is a list whose car is the name for the backup file
ffc0e1ca
AS
4203and whose cdr is a list of old versions to consider deleting now.
4204If the value is nil, don't make a backup.
4205Uses `backup-directory-alist' in the same way as does
4206`make-backup-file-name'."
eb650569
RS
4207 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
4208 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4209 (if handler
4210 (funcall handler 'find-backup-file-name fn)
f26d858e
EZ
4211 (if (or (eq version-control 'never)
4212 ;; We don't support numbered backups on plain MS-DOS
4213 ;; when long file names are unavailable.
4214 (and (eq system-type 'ms-dos)
4215 (not (msdos-long-file-names))))
b4da00e9 4216 (list (make-backup-file-name fn))
ffc0e1ca
AS
4217 (let* ((basic-name (make-backup-file-name-1 fn))
4218 (base-versions (concat (file-name-nondirectory basic-name)
4219 ".~"))
e2b30772 4220 (backup-extract-version-start (length base-versions))
eb650569 4221 (high-water-mark 0)
ffc0e1ca
AS
4222 (number-to-delete 0)
4223 possibilities deserve-versions-p versions)
eb650569
RS
4224 (condition-case ()
4225 (setq possibilities (file-name-all-completions
4226 base-versions
ffc0e1ca
AS
4227 (file-name-directory basic-name))
4228 versions (sort (mapcar #'backup-extract-version
4229 possibilities)
4230 #'<)
eb650569
RS
4231 high-water-mark (apply 'max 0 versions)
4232 deserve-versions-p (or version-control
4233 (> high-water-mark 0))
4234 number-to-delete (- (length versions)
ffc0e1ca
AS
4235 kept-old-versions
4236 kept-new-versions
4237 -1))
4238 (file-error (setq possibilities nil)))
eb650569 4239 (if (not deserve-versions-p)
8767d866 4240 (list (make-backup-file-name fn))
ffc0e1ca 4241 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
eb650569
RS
4242 (if (and (> number-to-delete 0)
4243 ;; Delete nothing if there is overflow
4244 ;; in the number of versions to keep.
4245 (>= (+ kept-new-versions kept-old-versions -1) 0))
ffc0e1ca
AS
4246 (mapcar (lambda (n)
4247 (format "%s.~%d~" basic-name n))
eb650569
RS
4248 (let ((v (nthcdr kept-old-versions versions)))
4249 (rplacd (nthcdr (1- number-to-delete) v) ())
4250 v))))))))))
b4da00e9 4251
b4da00e9
RM
4252(defun file-nlinks (filename)
4253 "Return number of names file FILENAME has."
4254 (car (cdr (file-attributes filename))))
6c636af9 4255
753ad988
KG
4256;; (defun file-relative-name (filename &optional directory)
4257;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4258;; This function returns a relative file name which is equivalent to FILENAME
4259;; when used with that default directory as the default.
4260;; If this is impossible (which can happen on MSDOS and Windows
4261;; when the file name and directory use different drive names)
4262;; then it returns FILENAME."
4263;; (save-match-data
4264;; (let ((fname (expand-file-name filename)))
4265;; (setq directory (file-name-as-directory
4266;; (expand-file-name (or directory default-directory))))
4267;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4268;; ;; drive names, they can't be relative, so return the absolute name.
4269;; (if (and (or (eq system-type 'ms-dos)
4270;; (eq system-type 'cygwin)
4271;; (eq system-type 'windows-nt))
4272;; (not (string-equal (substring fname 0 2)
4273;; (substring directory 0 2))))
4274;; filename
4275;; (let ((ancestor ".")
4276;; (fname-dir (file-name-as-directory fname)))
4277;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4278;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4279;; (setq directory (file-name-directory (substring directory 0 -1))
4280;; ancestor (if (equal ancestor ".")
4281;; ".."
4282;; (concat "../" ancestor))))
4283;; ;; Now ancestor is empty, or .., or ../.., etc.
4284;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4285;; ;; We matched within FNAME's directory part.
4286;; ;; Add the rest of FNAME onto ANCESTOR.
4287;; (let ((rest (substring fname (match-end 0))))
4288;; (if (and (equal ancestor ".")
4289;; (not (equal rest "")))
4290;; ;; But don't bother with ANCESTOR if it would give us `./'.
4291;; rest
4292;; (concat (file-name-as-directory ancestor) rest)))
4293;; ;; We matched FNAME's directory equivalent.
4294;; ancestor))))))
4295
6c636af9 4296(defun file-relative-name (filename &optional directory)
ffc0e1ca 4297 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2d6562a5
RS
4298This function returns a relative file name which is equivalent to FILENAME
4299when used with that default directory as the default.
753ad988 4300If FILENAME and DIRECTORY lie on different machines or on different drives
1be0210d 4301on a DOS/Windows machine, it returns FILENAME in expanded form."
96c188b0 4302 (save-match-data
753ad988
KG
4303 (setq directory
4304 (file-name-as-directory (expand-file-name (or directory
4305 default-directory))))
4306 (setq filename (expand-file-name filename))
3f788773
KG
4307 (let ((fremote (file-remote-p filename))
4308 (dremote (file-remote-p directory)))
493c98af
KG
4309 (if ;; Conditions for separate trees
4310 (or
2472c214 4311 ;; Test for different filesystems on DOS/Windows
493c98af 4312 (and
7c64272b 4313 ;; Should `cygwin' really be included here? --stef
493c98af 4314 (memq system-type '(ms-dos cygwin windows-nt))
2472c214
EZ
4315 (or
4316 ;; Test for different drive letters
4317 (not (eq t (compare-strings filename 0 2 directory 0 2)))
4318 ;; Test for UNCs on different servers
4319 (not (eq t (compare-strings
4320 (progn
4321 (if (string-match "\\`//\\([^:/]+\\)/" filename)
4322 (match-string 1 filename)
4323 ;; Windows file names cannot have ? in
4324 ;; them, so use that to detect when
4325 ;; neither FILENAME nor DIRECTORY is a
4326 ;; UNC.
4327 "?"))
4328 0 nil
4329 (progn
4330 (if (string-match "\\`//\\([^:/]+\\)/" directory)
4331 (match-string 1 directory)
4332 "?"))
4333 0 nil t)))))
493c98af 4334 ;; Test for different remote file system identification
3f788773 4335 (not (equal fremote dremote)))
e2b30772 4336 filename
753ad988
KG
4337 (let ((ancestor ".")
4338 (filename-dir (file-name-as-directory filename)))
7c64272b
SM
4339 (while (not
4340 (or
4341 (eq t (compare-strings filename-dir nil (length directory)
4342 directory nil nil case-fold-search))
4343 (eq t (compare-strings filename nil (length directory)
4344 directory nil nil case-fold-search))))
753ad988 4345 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
4346 ancestor (if (equal ancestor ".")
4347 ".."
4348 (concat "../" ancestor))))
753ad988 4349 ;; Now ancestor is empty, or .., or ../.., etc.
7c64272b
SM
4350 (if (eq t (compare-strings filename nil (length directory)
4351 directory nil nil case-fold-search))
753ad988
KG
4352 ;; We matched within FILENAME's directory part.
4353 ;; Add the rest of FILENAME onto ANCESTOR.
3f7d6528 4354 (let ((rest (substring filename (length directory))))
753ad988 4355 (if (and (equal ancestor ".") (not (equal rest "")))
9695aac6
RS
4356 ;; But don't bother with ANCESTOR if it would give us `./'.
4357 rest
4358 (concat (file-name-as-directory ancestor) rest)))
753ad988
KG
4359 ;; We matched FILENAME's directory equivalent.
4360 ancestor))))))
b4da00e9
RM
4361\f
4362(defun save-buffer (&optional args)
e8f4db18
RS
4363 "Save current buffer in visited file if modified.
4364Variations are described below.
4365
b4da00e9
RM
4366By default, makes the previous version into a backup file
4367 if previously requested or if this is the first save.
dc2ab26e 4368Prefixed with one \\[universal-argument], marks this version
b4da00e9 4369 to become a backup when the next save is done.
dc2ab26e 4370Prefixed with two \\[universal-argument]'s,
b4da00e9 4371 unconditionally makes the previous version into a backup file.
dc2ab26e 4372Prefixed with three \\[universal-argument]'s, marks this version
ac9650be
RS
4373 to become a backup when the next save is done,
4374 and unconditionally makes the previous version into a backup file.
4375
dc2ab26e
EZ
4376With a numeric argument of 0, never make the previous version
4377into a backup file.
b4da00e9
RM
4378
4379If a file's name is FOO, the names of its numbered backup versions are
4380 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4381Numeric backups (rather than FOO~) will be made if value of
4382 `version-control' is not the atom `never' and either there are already
4383 numeric versions of the file being backed up, or `version-control' is
4384 non-nil.
4385We don't want excessive versions piling up, so there are variables
4386 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4387 and `kept-new-versions', which tells how many newest versions to keep.
4388 Defaults are 2 old versions and 2 new.
4389`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 4390If `delete-old-versions' is nil, system will query user
e73ec04b
RS
4391 before trimming versions. Otherwise it does it silently.
4392
749d2ee6
RS
4393If `vc-make-backup-files' is nil, which is the default,
4394 no backup files are made for files managed by version control.
4395 (This is because the version control system itself records previous versions.)
4396
e73ec04b 4397See the subroutine `basic-save-buffer' for more information."
b4da00e9
RM
4398 (interactive "p")
4399 (let ((modp (buffer-modified-p))
b5a8e0fc
RS
4400 (make-backup-files (or (and make-backup-files (not (eq args 0)))
4401 (memq args '(16 64)))))
b4da00e9 4402 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
86a30352
EZ
4403 ;; We used to display the message below only for files > 50KB, but
4404 ;; then Rmail-mbox never displays it due to buffer swapping. If
4405 ;; the test is ever re-introduced, be sure to handle saving of
4406 ;; Rmail files.
4407 (if (and modp (buffer-file-name))
b4990dde 4408 (message "Saving file %s..." (buffer-file-name)))
b4da00e9
RM
4409 (basic-save-buffer)
4410 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
4411
4412(defun delete-auto-save-file-if-necessary (&optional force)
4413 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4414Normally delete only if the file was written by this Emacs since
4415the last real save, but optional arg FORCE non-nil means delete anyway."
4416 (and buffer-auto-save-file-name delete-auto-save-files
4417 (not (string= buffer-file-name buffer-auto-save-file-name))
4418 (or force (recent-auto-save-p))
4419 (progn
4420 (condition-case ()
4421 (delete-file buffer-auto-save-file-name)
4422 (file-error nil))
4423 (set-buffer-auto-saved))))
4424
481f215b
KH
4425(defvar auto-save-hook nil
4426 "Normal hook run just before auto-saving.")
4427
3c3b81d1
SJ
4428(defcustom before-save-hook nil
4429 "Normal hook that is run before a buffer is saved to its file."
25f6295e 4430 :options '(copyright-update time-stamp)
3c3b81d1
SJ
4431 :type 'hook
4432 :group 'files)
4433
ffc0e1ca
AS
4434(defcustom after-save-hook nil
4435 "Normal hook that is run after a buffer is saved to its file."
4436 :options '(executable-make-buffer-file-executable-if-script-p)
4437 :type 'hook
4438 :group 'files)
1cc852cc 4439
0516edee
RS
4440(defvar save-buffer-coding-system nil
4441 "If non-nil, use this coding system for saving the buffer.
4442More precisely, use this coding system in place of the
4443value of `buffer-file-coding-system', when saving the buffer.
4444Calling `write-region' for any purpose other than saving the buffer
4445will still use `buffer-file-coding-system'; this variable has no effect
4446in such cases.")
4447
d5fe94cc
RS
4448(make-variable-buffer-local 'save-buffer-coding-system)
4449(put 'save-buffer-coding-system 'permanent-local t)
4450
b4da00e9 4451(defun basic-save-buffer ()
1cc852cc 4452 "Save the current buffer in its visited file, if it has been modified.
0370fe77
SM
4453The hooks `write-contents-functions' and `write-file-functions' get a chance
4454to do the job of saving; if they do not, then the buffer is saved in
222cf381 4455the visited file in the usual way.
3c3b81d1
SJ
4456Before and after saving the buffer, this function runs
4457`before-save-hook' and `after-save-hook', respectively."
b4da00e9 4458 (interactive)
19618231 4459 (save-current-buffer
c11a94fe
RS
4460 ;; In an indirect buffer, save its base buffer instead.
4461 (if (buffer-base-buffer)
4462 (set-buffer (buffer-base-buffer)))
75d1d833
BG
4463 (if (or (buffer-modified-p)
4464 ;; handle the case when no modification has been made but
4465 ;; the file disappeared since visited
4466 (and buffer-file-name
4467 (not (file-exists-p buffer-file-name))))
c11a94fe 4468 (let ((recent-save (recent-auto-save-p))
818286f4 4469 setmodes)
c11a94fe
RS
4470 ;; If buffer has no file name, ask user for one.
4471 (or buffer-file-name
182891ef
RS
4472 (let ((filename
4473 (expand-file-name
4474 (read-file-name "File to save in: ") nil)))
8400146f
MR
4475 (if (file-exists-p filename)
4476 (if (file-directory-p filename)
4477 ;; Signal an error if the user specified the name of an
4478 ;; existing directory.
4479 (error "%s is a directory" filename)
9aea757b
CY
4480 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4481 filename))
8400146f
MR
4482 (error "Canceled")))
4483 ;; Signal an error if the specified name refers to a
4484 ;; non-existing directory.
4485 (let ((dir (file-name-directory filename)))
4486 (unless (file-directory-p dir)
4487 (if (file-exists-p dir)
4488 (error "%s is not a directory" dir)
4489 (error "%s: no such directory" dir)))))
182891ef 4490 (set-visited-file-name filename)))
c11a94fe
RS
4491 (or (verify-visited-file-modtime (current-buffer))
4492 (not (file-exists-p buffer-file-name))
4493 (yes-or-no-p
9aea757b
CY
4494 (format
4495 "%s has changed since visited or saved. Save anyway? "
4496 (file-name-nondirectory buffer-file-name)))
c11a94fe
RS
4497 (error "Save not confirmed"))
4498 (save-restriction
4499 (widen)
19618231 4500 (save-excursion
0370fe77 4501 (and (> (point-max) (point-min))
407b4328 4502 (not find-file-literally)
19618231
RS
4503 (/= (char-after (1- (point-max))) ?\n)
4504 (not (and (eq selective-display t)
4505 (= (char-after (1- (point-max))) ?\r)))
4506 (or (eq require-final-newline t)
f4206092 4507 (eq require-final-newline 'visit-save)
19618231
RS
4508 (and require-final-newline
4509 (y-or-n-p
9aea757b
CY
4510 (format "Buffer %s does not end in newline. Add one? "
4511 (buffer-name)))))
19618231
RS
4512 (save-excursion
4513 (goto-char (point-max))
4514 (insert ?\n))))
fa5867f6
AS
4515 ;; Support VC version backups.
4516 (vc-before-save)
3c3b81d1 4517 (run-hooks 'before-save-hook)
0370fe77 4518 (or (run-hook-with-args-until-success 'write-contents-functions)
c11a94fe 4519 (run-hook-with-args-until-success 'local-write-file-hooks)
0370fe77 4520 (run-hook-with-args-until-success 'write-file-functions)
0ba5894b
RS
4521 ;; If a hook returned t, file is already "written".
4522 ;; Otherwise, write it the usual way now.
4523 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
4524 ;; Now we have saved the current buffer. Let's make sure
4525 ;; that buffer-file-coding-system is fixed to what
4526 ;; actually used for saving by binding it locally.
0516edee
RS
4527 (if save-buffer-coding-system
4528 (setq save-buffer-coding-system last-coding-system-used)
4529 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
4530 (setq buffer-file-number
4531 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
4532 (if setmodes
4533 (condition-case ()
574c05e2
KK
4534 (progn
4535 (set-file-modes buffer-file-name (car setmodes))
4536 (set-file-selinux-context buffer-file-name (nth 1 setmodes)))
c11a94fe
RS
4537 (error nil))))
4538 ;; If the auto-save file was recent before this command,
4539 ;; delete it now.
4540 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
4541 ;; Support VC `implicit' locking.
4542 (vc-after-save)
c11a94fe
RS
4543 (run-hooks 'after-save-hook))
4544 (message "(No changes need to be saved)"))))
b4da00e9 4545
87d26afc
RS
4546;; This does the "real job" of writing a buffer into its visited file
4547;; and making a backup file. This is what is normally done
0370fe77 4548;; but inhibited if one of write-file-functions returns non-nil.
574c05e2 4549;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
87d26afc 4550(defun basic-save-buffer-1 ()
969be033
RS
4551 (prog1
4552 (if save-buffer-coding-system
4553 (let ((coding-system-for-write save-buffer-coding-system))
4554 (basic-save-buffer-2))
d5fe94cc 4555 (basic-save-buffer-2))
86c507f7
KH
4556 (if buffer-file-coding-system-explicit
4557 (setcar buffer-file-coding-system-explicit last-coding-system-used)
4558 (setq buffer-file-coding-system-explicit
4559 (cons last-coding-system-used nil)))))
d5fe94cc 4560
574c05e2 4561;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
d5fe94cc
RS
4562(defun basic-save-buffer-2 ()
4563 (let (tempsetmodes setmodes)
87d26afc
RS
4564 (if (not (file-writable-p buffer-file-name))
4565 (let ((dir (file-name-directory buffer-file-name)))
4566 (if (not (file-directory-p dir))
83c6f446
RS
4567 (if (file-exists-p dir)
4568 (error "%s is not a directory" dir)
87c60260 4569 (error "%s: no such directory" dir))
87d26afc
RS
4570 (if (not (file-exists-p buffer-file-name))
4571 (error "Directory %s write-protected" dir)
4572 (if (yes-or-no-p
9aea757b
CY
4573 (format
4574 "File %s is write-protected; try to save anyway? "
4575 (file-name-nondirectory
4576 buffer-file-name)))
87d26afc
RS
4577 (setq tempsetmodes t)
4578 (error "Attempt to save to a file which you aren't allowed to write"))))))
4579 (or buffer-backed-up
4580 (setq setmodes (backup-buffer)))
1d367309
KF
4581 (let* ((dir (file-name-directory buffer-file-name))
4582 (dir-writable (file-writable-p dir)))
4583 (if (or (and file-precious-flag dir-writable)
4584 (and break-hardlink-on-save
35fd0881 4585 (file-exists-p buffer-file-name)
1d367309
KF
4586 (> (file-nlinks buffer-file-name) 1)
4587 (or dir-writable
4588 (error (concat (format
4589 "Directory %s write-protected; " dir)
4590 "cannot break hardlink when saving")))))
4591 ;; Write temp name, then rename it.
f4a0f59b
RS
4592 ;; This requires write access to the containing dir,
4593 ;; which is why we don't try it if we don't have that access.
4594 (let ((realname buffer-file-name)
44dce0fb
RS
4595 tempname succeed
4596 (umask (default-file-modes))
6782610c 4597 (old-modtime (visited-file-modtime)))
44dce0fb
RS
4598 ;; Create temp files with strict access rights. It's easy to
4599 ;; loosen them later, whereas it's impossible to close the
4600 ;; time-window of loose permissions otherwise.
f4a0f59b 4601 (unwind-protect
44dce0fb
RS
4602 (progn
4603 (clear-visited-file-modtime)
4604 (set-default-file-modes ?\700)
4605 ;; Try various temporary names.
4606 ;; This code follows the example of make-temp-file,
4607 ;; but it calls write-region in the appropriate way
4608 ;; for saving the buffer.
4609 (while (condition-case ()
4610 (progn
4611 (setq tempname
4612 (make-temp-name
4613 (expand-file-name "tmp" dir)))
6b3d752c
SM
4614 ;; Pass in nil&nil rather than point-min&max
4615 ;; cause we're saving the whole buffer.
4616 ;; write-region-annotate-functions may use it.
4617 (write-region nil nil
44dce0fb
RS
4618 tempname nil realname
4619 buffer-file-truename 'excl)
4620 nil)
4621 (file-already-exists t))
4622 ;; The file was somehow created by someone else between
4623 ;; `make-temp-name' and `write-region', let's try again.
4624 nil)
4625 (setq succeed t))
4626 ;; Reset the umask.
4627 (set-default-file-modes umask)
4628 ;; If we failed, restore the buffer's modtime.
4629 (unless succeed
4630 (set-visited-file-modtime old-modtime)))
4631 ;; Since we have created an entirely new file,
4632 ;; make sure it gets the right permission bits set.
730df8db 4633 (setq setmodes (or setmodes
574c05e2 4634 (list (or (file-modes buffer-file-name)
562ca538 4635 (logand ?\666 umask))
574c05e2 4636 (file-selinux-context buffer-file-name)
730df8db 4637 buffer-file-name)))
f4a0f59b
RS
4638 ;; We succeeded in writing the temp file,
4639 ;; so rename it.
4640 (rename-file tempname buffer-file-name t))
4641 ;; If file not writable, see if we can make it writable
4642 ;; temporarily while we write it.
4643 ;; But no need to do so if we have just backed it up
4644 ;; (setmodes is set) because that says we're superseding.
4645 (cond ((and tempsetmodes (not setmodes))
4646 ;; Change the mode back, after writing.
574c05e2
KK
4647 (setq setmodes (list (file-modes buffer-file-name)
4648 (file-selinux-context buffer-file-name)
4649 buffer-file-name))
4650 (set-file-modes buffer-file-name (logior (car setmodes) 128))
4651 (set-file-selinux-context buffer-file-name (nth 1 setmodes)))))
f3f9e207
RS
4652 (let (success)
4653 (unwind-protect
4654 (progn
6b3d752c
SM
4655 ;; Pass in nil&nil rather than point-min&max to indicate
4656 ;; we're saving the buffer rather than just a region.
4657 ;; write-region-annotate-functions may make us of it.
4658 (write-region nil nil
f3f9e207
RS
4659 buffer-file-name nil t buffer-file-truename)
4660 (setq success t))
4661 ;; If we get an error writing the new file, and we made
4662 ;; the backup by renaming, undo the backing-up.
4663 (and setmodes (not success)
0133dab9 4664 (progn
574c05e2
KK
4665 (rename-file (nth 2 setmodes) buffer-file-name t)
4666 (setq buffer-backed-up nil))))))
87d26afc
RS
4667 setmodes))
4668
66f782de
GM
4669(declare-function diff-no-select "diff"
4670 (old new &optional switches no-async buf))
4671
1eeae2a1 4672(defvar save-some-buffers-action-alist
9b106871
SM
4673 `((?\C-r
4674 ,(lambda (buf)
4675 (if (not enable-recursive-minibuffers)
4676 (progn (display-buffer buf)
4677 (setq other-window-scroll-buffer buf))
4678 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4679 (recursive-edit))
4680 ;; Return nil to ask about BUF again.
4681 nil)
ca0a881a 4682 ,(purecopy "view this buffer"))
9b106871 4683 (?d ,(lambda (buf)
b9330108 4684 (if (null (buffer-file-name buf))
9b106871 4685 (message "Not applicable: no file")
b2e44819
SM
4686 (require 'diff) ;for diff-no-select.
4687 (let ((diffbuf (diff-no-select (buffer-file-name buf) buf
4688 nil 'noasync)))
4689 (if (not enable-recursive-minibuffers)
4690 (progn (display-buffer diffbuf)
4691 (setq other-window-scroll-buffer diffbuf))
4692 (view-buffer diffbuf (lambda (_) (exit-recursive-edit)))
4693 (recursive-edit))))
9b106871
SM
4694 ;; Return nil to ask about BUF again.
4695 nil)
ca0a881a 4696 ,(purecopy "view changes in this buffer")))
1eeae2a1 4697 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3029e594 4698(put 'save-some-buffers-action-alist 'risky-local-variable t)
1eeae2a1 4699
a1b0c2a7
RS
4700(defvar buffer-save-without-query nil
4701 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4702(make-variable-buffer-local 'buffer-save-without-query)
4703
ffc0e1ca 4704(defun save-some-buffers (&optional arg pred)
b4da00e9 4705 "Save some modified file-visiting buffers. Asks user about each one.
1eeae2a1
RS
4706You can answer `y' to save, `n' not to save, `C-r' to look at the
4707buffer in question with `view-buffer' before deciding or `d' to
126c9dda 4708view the differences using `diff-buffer-with-file'.
8fd9c174 4709
afa8e9f6
GM
4710This command first saves any buffers where `buffer-save-without-query' is
4711non-nil, without asking.
4712
5bbbceb1 4713Optional argument (the prefix) non-nil means save all with no questions.
ffc0e1ca
AS
4714Optional second argument PRED determines which buffers are considered:
4715If PRED is nil, all the file-visiting buffers are considered.
4716If PRED is t, then certain non-file buffers will also be considered.
4717If PRED is a zero-argument function, it indicates for each buffer whether
1eeae2a1
RS
4718to consider it or not when called with that buffer current.
4719
4720See `save-some-buffers-action-alist' if you want to
4721change the additional actions you can take on files."
b4da00e9 4722 (interactive "P")
907482b9 4723 (save-window-excursion
c5f09daf 4724 (let* (queried autosaved-buffers
a1b0c2a7
RS
4725 files-done abbrevs-done)
4726 (dolist (buffer (buffer-list))
4727 ;; First save any buffers that we're supposed to save unconditionally.
4728 ;; That way the following code won't ask about them.
4729 (with-current-buffer buffer
4730 (when (and buffer-save-without-query (buffer-modified-p))
c5f09daf 4731 (push (buffer-name) autosaved-buffers)
a1b0c2a7
RS
4732 (save-buffer))))
4733 ;; Ask about those buffers that merit it,
4734 ;; and record the number thus saved.
4735 (setq files-done
76d5492b 4736 (map-y-or-n-p
9b106871 4737 (lambda (buffer)
be9acc26
CY
4738 ;; Note that killing some buffers may kill others via
4739 ;; hooks (e.g. Rmail and its viewing buffer).
4740 (and (buffer-live-p buffer)
4741 (buffer-modified-p buffer)
9b106871
SM
4742 (not (buffer-base-buffer buffer))
4743 (or
4744 (buffer-file-name buffer)
4745 (and pred
4746 (progn
4747 (set-buffer buffer)
4748 (and buffer-offer-save (> (buffer-size) 0)))))
4749 (or (not (functionp pred))
4750 (with-current-buffer buffer (funcall pred)))
4751 (if arg
4752 t
4753 (setq queried t)
4754 (if (buffer-file-name buffer)
4755 (format "Save file %s? "
4756 (buffer-file-name buffer))
4757 (format "Save buffer %s? "
4758 (buffer-name buffer))))))
4759 (lambda (buffer)
4760 (with-current-buffer buffer
4761 (save-buffer)))
4762 (buffer-list)
76d5492b 4763 '("buffer" "buffers" "save")
1eeae2a1 4764 save-some-buffers-action-alist))
bf247b6e 4765 ;; Maybe to save abbrevs, and record whether
a1b0c2a7
RS
4766 ;; we either saved them or asked to.
4767 (and save-abbrevs abbrevs-changed
4768 (progn
4769 (if (or arg
4770 (eq save-abbrevs 'silently)
9aea757b 4771 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
a1b0c2a7
RS
4772 (write-abbrev-file nil))
4773 ;; Don't keep bothering user if he says no.
4774 (setq abbrevs-changed nil)
4775 (setq abbrevs-done t)))
76d5492b 4776 (or queried (> files-done 0) abbrevs-done
c5f09daf
DE
4777 (cond
4778 ((null autosaved-buffers)
4779 (message "(No files need saving)"))
4780 ((= (length autosaved-buffers) 1)
4781 (message "(Saved %s)" (car autosaved-buffers)))
4782 (t
4783 (message "(Saved %d files: %s)"
4784 (length autosaved-buffers)
4785 (mapconcat 'identity autosaved-buffers ", "))))))))
b4da00e9
RM
4786\f
4787(defun not-modified (&optional arg)
4788 "Mark current buffer as unmodified, not needing to be saved.
8fc29035 4789With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
a641f9a1
RM
4790
4791It is not a good idea to use this function in Lisp programs, because it
4792prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
4793 (interactive "P")
4794 (message (if arg "Modification-flag set"
4795 "Modification-flag cleared"))
4796 (set-buffer-modified-p arg))
4797
4798(defun toggle-read-only (&optional arg)
8bfbd132 4799 "Change whether this buffer is read-only.
4837b516 4800With prefix argument ARG, make the buffer read-only if ARG is
8bfbd132 4801positive, otherwise make it writable. If buffer is read-only
b2621720
GM
4802and `view-read-only' is non-nil, enter view mode.
4803
4804This function is usually the wrong thing to use in a Lisp program.
4805It can have side-effects beyond changing the read-only status of a buffer
4806\(e.g., enabling view mode), and does not affect read-only regions that
4807are caused by text properties. To make a buffer read-only in Lisp code,
4808set `buffer-read-only'. To ignore read-only status (whether due to text
4809properties or buffer state) and make changes, temporarily bind
4810`inhibit-read-only'."
b4da00e9 4811 (interactive "P")
c60ee5e7 4812 (if (and arg
d758359d
AS
4813 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4814 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4815 nil ; do nothing.
4816 ;; Toggle.
4817 (cond
4818 ((and buffer-read-only view-mode)
4819 (View-exit-and-edit)
4820 (make-local-variable 'view-read-only)
4821 (setq view-read-only t)) ; Must leave view mode.
4822 ((and (not buffer-read-only) view-read-only
818286f4
SM
4823 ;; If view-mode is already active, `view-mode-enter' is a nop.
4824 (not view-mode)
d758359d
AS
4825 (not (eq (get major-mode 'mode-class) 'special)))
4826 (view-mode-enter))
4827 (t (setq buffer-read-only (not buffer-read-only))
86c60681 4828 (force-mode-line-update)))))
b4da00e9 4829
912192d1 4830(defun insert-file (filename)
b4da00e9
RM
4831 "Insert contents of file FILENAME into buffer after point.
4832Set mark after the inserted text.
4833
4834This function is meant for the user to run interactively.
4835Don't call it from programs! Use `insert-file-contents' instead.
4836\(Its calling sequence is different; see its documentation)."
912192d1 4837 (interactive "*fInsert file: ")
3a64a3cf 4838 (insert-file-1 filename #'insert-file-contents))
b4da00e9 4839
912192d1 4840(defun append-to-file (start end filename)
b4da00e9
RM
4841 "Append the contents of the region to the end of file FILENAME.
4842When called from a function, expects three arguments,
d8c0d419
EZ
4843START, END and FILENAME. START and END are normally buffer positions
4844specifying the part of the buffer to write.
4845If START is nil, that means to use the entire buffer contents.
4846If START is a string, then output that string to the file
4847instead of any buffer contents; END is ignored.
4848
4849This does character code conversion and applies annotations
4850like `write-region' does."
912192d1
KH
4851 (interactive "r\nFAppend to file: ")
4852 (write-region start end filename t))
b4da00e9
RM
4853
4854(defun file-newest-backup (filename)
4855 "Return most recent backup file for FILENAME or nil if no backups exist."
ffc0e1ca
AS
4856 ;; `make-backup-file-name' will get us the right directory for
4857 ;; ordinary or numeric backups. It might create a directory for
4858 ;; backups as a side-effect, according to `backup-directory-alist'.
e31cfca5 4859 (let* ((filename (file-name-sans-versions
783bf210 4860 (make-backup-file-name (expand-file-name filename))))
b4da00e9
RM
4861 (file (file-name-nondirectory filename))
4862 (dir (file-name-directory filename))
4863 (comp (file-name-all-completions file dir))
cf7e94a0
RS
4864 (newest nil)
4865 tem)
b4da00e9 4866 (while comp
ffc0e1ca 4867 (setq tem (pop comp))
cf7e94a0
RS
4868 (cond ((and (backup-file-name-p tem)
4869 (string= (file-name-sans-versions tem) file))
4870 (setq tem (concat dir tem))
4871 (if (or (null newest)
4872 (file-newer-than-file-p tem newest))
4873 (setq newest tem)))))
b4da00e9
RM
4874 newest))
4875
4876(defun rename-uniquely ()
4877 "Rename current buffer to a similar name not already taken.
4878This function is useful for creating multiple shell process buffers
cf3aa21b
GM
4879or multiple mail buffers, etc.
4880
4881Note that some commands, in particular those based on `compilation-mode'
4882\(`compile', `grep', etc.) will reuse the current buffer if it has the
4883appropriate mode even if it has been renamed. So as well as renaming
4884the buffer, you also need to switch buffers before running another
4885instance of such commands."
b4da00e9 4886 (interactive)
40eb8038 4887 (save-match-data
e0df3aef
KH
4888 (let ((base-name (buffer-name)))
4889 (and (string-match "<[0-9]+>\\'" base-name)
4890 (not (and buffer-file-name
4891 (string= base-name
4892 (file-name-nondirectory buffer-file-name))))
4893 ;; If the existing buffer name has a <NNN>,
4894 ;; which isn't part of the file name (if any),
4895 ;; then get rid of that.
4896 (setq base-name (substring base-name 0 (match-beginning 0))))
4897 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 4898 (force-mode-line-update))))
5bbbceb1 4899
4e43240a 4900(defun make-directory (dir &optional parents)
9d1f18b5
EZ
4901 "Create the directory DIR and optionally any nonexistent parent dirs.
4902If DIR already exists as a directory, signal an error, unless
4903PARENTS is non-nil.
789cb0f9 4904
9d1f18b5
EZ
4905Interactively, the default choice of directory to create is the
4906current buffer's default directory. That is useful when you have
4907visited a file in a nonexistent directory.
5ce8bb89 4908
9d1f18b5
EZ
4909Noninteractively, the second (optional) argument PARENTS, if
4910non-nil, says whether to create parent directories that don't
bd2fcc8d
LMI
4911exist. Interactively, this happens by default.
4912
4913If creating the directory or directories fail, an error will be
4914raised."
5ce8bb89
RS
4915 (interactive
4916 (list (read-file-name "Make directory: " default-directory default-directory
4917 nil nil)
4918 t))
ee291b46
RS
4919 ;; If default-directory is a remote directory,
4920 ;; make sure we find its make-directory handler.
4921 (setq dir (expand-file-name dir))
6eaebaa2 4922 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
4923 (if handler
4924 (funcall handler 'make-directory dir parents)
4925 (if (not parents)
4926 (make-directory-internal dir)
4927 (let ((dir (directory-file-name (expand-file-name dir)))
4928 create-list)
bb4a52db
JR
4929 (while (and (not (file-exists-p dir))
4930 ;; If directory is its own parent, then we can't
4931 ;; keep looping forever
4932 (not (equal dir
4933 (directory-file-name
4934 (file-name-directory dir)))))
76d5492b 4935 (setq create-list (cons dir create-list)
4e43240a
RS
4936 dir (directory-file-name (file-name-directory dir))))
4937 (while create-list
4938 (make-directory-internal (car create-list))
4939 (setq create-list (cdr create-list))))))))
96ad4c35 4940
0e1f2ee6
MA
4941(defconst directory-files-no-dot-files-regexp
4942 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
1603358c 4943 "Regexp matching any file name except \".\" and \"..\".")
0e1f2ee6 4944
f1a5d776 4945(defun delete-directory (directory &optional recursive trash)
96ad4c35 4946 "Delete the directory named DIRECTORY. Does not follow symlinks.
f1a5d776
CY
4947If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4948TRASH non-nil means to trash the directory instead, provided
4949`delete-by-moving-to-trash' is non-nil.
4950
4951When called interactively, TRASH is t if no prefix argument is
4952given. With a prefix argument, TRASH is nil."
96ad4c35 4953 (interactive
f1a5d776
CY
4954 (let* ((trashing (and delete-by-moving-to-trash
4955 (null current-prefix-arg)))
4956 (dir (expand-file-name
7e27ce9c 4957 (read-directory-name
f1a5d776
CY
4958 (if trashing
4959 "Move directory to trash: "
4960 "Delete directory: ")
4961 default-directory default-directory nil nil))))
96ad4c35 4962 (list dir
0e1f2ee6 4963 (if (directory-files dir nil directory-files-no-dot-files-regexp)
96ad4c35 4964 (y-or-n-p
9aea757b
CY
4965 (format "Directory `%s' is not empty, really %s? "
4966 dir (if trashing "trash" "delete")))
f1a5d776
CY
4967 nil)
4968 (null current-prefix-arg))))
8e692050
MA
4969 ;; If default-directory is a remote directory, make sure we find its
4970 ;; delete-directory handler.
96ad4c35
MA
4971 (setq directory (directory-file-name (expand-file-name directory)))
4972 (let ((handler (find-file-name-handler directory 'delete-directory)))
8b0e68ea
CY
4973 (cond
4974 (handler
4975 (funcall handler 'delete-directory directory recursive))
f1a5d776 4976 ((and delete-by-moving-to-trash trash)
8b0e68ea
CY
4977 ;; Only move non-empty dir to trash if recursive deletion was
4978 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4979 ;; case, where the operation fails in delete-directory-internal.
4980 ;; As `move-file-to-trash' trashes directories (empty or
4981 ;; otherwise) as a unit, we do not need to recurse here.
4982 (if (and (not recursive)
4983 ;; Check if directory is empty apart from "." and "..".
4984 (directory-files
4985 directory 'full directory-files-no-dot-files-regexp))
4986 (error "Directory is not empty, not moving to trash")
4987 (move-file-to-trash directory)))
c80e3b4a 4988 ;; Otherwise, call ourselves recursively if needed.
8b0e68ea 4989 (t
96ad4c35 4990 (if (and recursive (not (file-symlink-p directory)))
8b0e68ea
CY
4991 (mapc (lambda (file)
4992 ;; This test is equivalent to
4993 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4994 ;; but more efficient
4995 (if (eq t (car (file-attributes file)))
f1a5d776
CY
4996 (delete-directory file recursive nil)
4997 (delete-file file nil)))
8b0e68ea
CY
4998 ;; We do not want to delete "." and "..".
4999 (directory-files
1d78a746
CY
5000 directory 'full directory-files-no-dot-files-regexp)))
5001 (delete-directory-internal directory)))))
96ad4c35 5002
96b49301 5003(defun file-equal-p (file1 file2)
a032a702
MA
5004 "Return non-nil if files FILE1 and FILE2 name the same file.
5005If FILE1 or FILE2 does not exist, the return value is unspecified."
96b49301 5006 (let ((handler (or (find-file-name-handler file1 'file-equal-p)
5007 (find-file-name-handler file2 'file-equal-p))))
25b2e303 5008 (if handler
96b49301 5009 (funcall handler 'file-equal-p file1 file2)
a032a702
MA
5010 (let (f1-attr f2-attr)
5011 (and (setq f1-attr (file-attributes (file-truename file1)))
5012 (setq f2-attr (file-attributes (file-truename file2)))
5013 (equal f1-attr f2-attr))))))
25b2e303 5014
42ee526b
CY
5015(defun file-in-directory-p (file dir)
5016 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5017A directory is considered to be \"in\" itself.
5018Return nil if DIR is not an existing directory."
5019 (let ((handler (or (find-file-name-handler file 'file-in-directory-p)
5020 (find-file-name-handler dir 'file-in-directory-p))))
25b2e303 5021 (if handler
42ee526b
CY
5022 (funcall handler 'file-in-directory-p file dir)
5023 (when (file-directory-p dir) ; DIR must exist.
5024 (setq file (file-truename file)
5025 dir (file-truename dir))
5026 (let ((ls1 (split-string file "/" t))
5027 (ls2 (split-string dir "/" t))
5028 (root (if (string-match "\\`/" file) "/" ""))
9a4888c0
CY
5029 (mismatch nil))
5030 (while (and ls1 ls2 (not mismatch))
5031 (if (string-equal (car ls1) (car ls2))
5032 (setq root (concat root (car ls1) "/"))
5033 (setq mismatch t))
5034 (setq ls1 (cdr ls1)
5035 ls2 (cdr ls2)))
5036 (unless mismatch
42ee526b 5037 (file-equal-p root dir)))))))
25b2e303 5038
470d996d 5039(defun copy-directory (directory newname &optional keep-time parents copy-contents)
8e692050 5040 "Copy DIRECTORY to NEWNAME. Both args must be strings.
8e692050
MA
5041This function always sets the file modes of the output files to match
5042the corresponding input file.
5043
5044The third arg KEEP-TIME non-nil means give the output files the same
5045last-modified time as the old ones. (This works on only some systems.)
5046
5047A prefix arg makes KEEP-TIME non-nil.
5048
8e692050
MA
5049Noninteractively, the last argument PARENTS says whether to
5050create parent directories if they don't exist. Interactively,
470d996d
TV
5051this happens by default.
5052
5053If NEWNAME names an existing directory, copy DIRECTORY as a
5054subdirectory there. However, if called from Lisp with a non-nil
5055optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5056directly into NEWNAME instead."
8e692050
MA
5057 (interactive
5058 (let ((dir (read-directory-name
5059 "Copy directory: " default-directory default-directory t nil)))
5060 (list dir
7e27ce9c 5061 (read-directory-name
8e692050
MA
5062 (format "Copy directory %s to: " dir)
5063 default-directory default-directory nil nil)
470d996d 5064 current-prefix-arg t nil)))
42ee526b 5065 (when (file-in-directory-p newname directory)
25b2e303 5066 (error "Cannot copy `%s' into its subdirectory `%s'"
5067 directory newname))
8e692050
MA
5068 ;; If default-directory is a remote directory, make sure we find its
5069 ;; copy-directory handler.
5070 (let ((handler (or (find-file-name-handler directory 'copy-directory)
5071 (find-file-name-handler newname 'copy-directory))))
5072 (if handler
25b2e303 5073 (funcall handler 'copy-directory directory
5074 newname keep-time parents copy-contents)
8e692050
MA
5075
5076 ;; Compute target name.
5077 (setq directory (directory-file-name (expand-file-name directory))
5078 newname (directory-file-name (expand-file-name newname)))
82d84d3f 5079
470d996d
TV
5080 (cond ((not (file-directory-p newname))
5081 ;; If NEWNAME is not an existing directory, create it;
5082 ;; that is where we will copy the files of DIRECTORY.
96b49301 5083 (make-directory newname parents))
470d996d
TV
5084 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5085 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5086 ((not copy-contents)
5087 (setq newname (expand-file-name
5088 (file-name-nondirectory
5089 (directory-file-name directory))
5090 newname))
5091 (and (file-exists-p newname)
5092 (not (file-directory-p newname))
5093 (error "Cannot overwrite non-directory %s with a directory"
5094 newname))
5095 (make-directory newname t)))
0e1f2ee6 5096
8e692050 5097 ;; Copy recursively.
6fa1f651
CY
5098 (dolist (file
5099 ;; We do not want to copy "." and "..".
5100 (directory-files directory 'full
5101 directory-files-no-dot-files-regexp))
40311efc
TV
5102 (let ((target (expand-file-name (file-name-nondirectory file) newname))
5103 (filetype (car (file-attributes file))))
5104 (cond
5105 ((eq filetype t) ; Directory but not a symlink.
5106 (copy-directory file newname keep-time parents))
5107 ((stringp filetype) ; Symbolic link
5108 (make-symbolic-link filetype target t))
5109 ((copy-file file target t keep-time)))))
8e692050
MA
5110
5111 ;; Set directory attributes.
e74f1bb6
MA
5112 (let ((modes (file-modes directory))
5113 (times (and keep-time (nth 5 (file-attributes directory)))))
5114 (if modes (set-file-modes newname modes))
5115 (if times (set-file-times newname times))))))
b4da00e9
RM
5116\f
5117(put 'revert-buffer-function 'permanent-local t)
5118(defvar revert-buffer-function nil
0973d78b
RS
5119 "Function to use to revert this buffer, or nil to do the default.
5120The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5121which are the arguments that `revert-buffer' received.")
b4da00e9
RM
5122
5123(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
5124(defvar revert-buffer-insert-file-contents-function nil
5125 "Function to use to insert contents when reverting this buffer.
5126Gets two args, first the nominal file name to use,
2df32500
RS
5127and second, t if reading the auto-save file.
5128
5129The function you specify is responsible for updating (or preserving) point.")
b4da00e9 5130
b0dc9757
LT
5131(defvar buffer-stale-function nil
5132 "Function to check whether a non-file buffer needs reverting.
5133This should be a function with one optional argument NOCONFIRM.
44dce0fb 5134Auto Revert Mode passes t for NOCONFIRM. The function should return
8b0b6932
LT
5135non-nil if the buffer should be reverted. A return value of
5136`fast' means that the need for reverting was not checked, but
5137that reverting the buffer is fast. The buffer is current when
5138this function is called.
b0dc9757 5139
4f8453ae
LT
5140The idea behind the NOCONFIRM argument is that it should be
5141non-nil if the buffer is going to be reverted without asking the
5142user. In such situations, one has to be careful with potentially
c90dcdd5
LT
5143time consuming operations.
5144
5145For more information on how this variable is used by Auto Revert mode,
b3a59350 5146see Info node `(emacs)Supporting additional buffers'.")
b0dc9757 5147
5f76e7d4
KH
5148(defvar before-revert-hook nil
5149 "Normal hook for `revert-buffer' to run before reverting.
5150If `revert-buffer-function' is used to override the normal revert
5151mechanism, this hook is not used.")
5152
5153(defvar after-revert-hook nil
5154 "Normal hook for `revert-buffer' to run after reverting.
5155Note that the hook value that it runs is the value that was in effect
5156before reverting; that makes a difference if you have buffer-local
5157hook functions.
5158
5159If `revert-buffer-function' is used to override the normal revert
5160mechanism, this hook is not used.")
5161
3e214b50
JB
5162(defvar revert-buffer-in-progress-p nil
5163 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5164This is true even if a `revert-buffer-function' is being used.")
5165
1554c03b
RS
5166(defvar revert-buffer-internal-hook)
5167
9a30563f 5168(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 5169 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 5170This undoes all changes since the file was visited or saved.
8c0e7b73
JB
5171With a prefix argument, offer to revert from latest auto-save file, if
5172that is more recent than the visited file.
1ab31687 5173
0dff8975
VJL
5174This command also implements an interface for special buffers
5175that contain text which doesn't come from a file, but reflects
5176some other data instead (e.g. Dired buffers, `buffer-list'
8fc29035
JB
5177buffers). This is done via the variable `revert-buffer-function'.
5178In these cases, it should reconstruct the buffer contents from the
5179appropriate data.
7e7c9c4e 5180
65ee6096 5181When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
5182to revert from the auto-save file when this is nil. Note that the
5183sense of this argument is the reverse of the prefix argument, for the
5184sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5185to nil.
5186
8fc29035 5187Optional second argument NOCONFIRM means don't ask for confirmation
06b60517 5188at all. (The variable `revert-without-query' offers another way to
518dc5be 5189revert buffers without querying for confirmation.)
b4da00e9 5190
5b2b26d5
RS
5191Optional third argument PRESERVE-MODES non-nil means don't alter
5192the files modes. Normally we reinitialize them using `normal-mode'.
5193
8f05da42
GM
5194This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5195
8c0e7b73 5196If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
5197do all the work for this command. Otherwise, the hooks
5198`before-revert-hook' and `after-revert-hook' are run at the beginning
5199and the end, and if `revert-buffer-insert-file-contents-function' is
5200non-nil, it is called instead of rereading visited file contents."
fb6208a6 5201
1ab31687
JB
5202 ;; I admit it's odd to reverse the sense of the prefix argument, but
5203 ;; there is a lot of code out there which assumes that the first
5204 ;; argument should be t to avoid consulting the auto-save file, and
5205 ;; there's no straightforward way to encourage authors to notice a
5206 ;; reversal of the argument sense. So I'm just changing the user
5207 ;; interface, but leaving the programmatic interface the same.
e0867e99 5208 (interactive (list (not current-prefix-arg)))
b4da00e9 5209 (if revert-buffer-function
3e214b50
JB
5210 (let ((revert-buffer-in-progress-p t))
5211 (funcall revert-buffer-function ignore-auto noconfirm))
44dce0fb
RS
5212 (with-current-buffer (or (buffer-base-buffer (current-buffer))
5213 (current-buffer))
3e214b50
JB
5214 (let* ((revert-buffer-in-progress-p t)
5215 (auto-save-p (and (not ignore-auto)
44dce0fb
RS
5216 (recent-auto-save-p)
5217 buffer-auto-save-file-name
5218 (file-readable-p buffer-auto-save-file-name)
5219 (y-or-n-p
5220 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
5221 (file-name (if auto-save-p
5222 buffer-auto-save-file-name
5223 buffer-file-name)))
5224 (cond ((null file-name)
5225 (error "Buffer does not seem to be associated with any file"))
5226 ((or noconfirm
5227 (and (not (buffer-modified-p))
518dc5be
EZ
5228 (catch 'found
5229 (dolist (regexp revert-without-query)
5230 (when (string-match regexp file-name)
5231 (throw 'found t)))))
9aea757b
CY
5232 (yes-or-no-p (format "Revert buffer from file %s? "
5233 file-name)))
44dce0fb
RS
5234 (run-hooks 'before-revert-hook)
5235 ;; If file was backed up but has changed since,
528c56e2 5236 ;; we should make another backup.
44dce0fb
RS
5237 (and (not auto-save-p)
5238 (not (verify-visited-file-modtime (current-buffer)))
5239 (setq buffer-backed-up nil))
44dce0fb
RS
5240 ;; Effectively copy the after-revert-hook status,
5241 ;; since after-find-file will clobber it.
5242 (let ((global-hook (default-value 'after-revert-hook))
518dc5be
EZ
5243 (local-hook (when (local-variable-p 'after-revert-hook)
5244 after-revert-hook))
5245 (inhibit-read-only t))
5246 (cond
5247 (revert-buffer-insert-file-contents-function
5248 (unless (eq buffer-undo-list t)
5249 ;; Get rid of all undo records for this buffer.
5250 (setq buffer-undo-list nil))
5251 ;; Don't make undo records for the reversion.
5252 (let ((buffer-undo-list t))
5253 (funcall revert-buffer-insert-file-contents-function
5254 file-name auto-save-p)))
5255 ((not (file-exists-p file-name))
5256 (error (if buffer-file-number
5257 "File %s no longer exists!"
5258 "Cannot revert nonexistent file %s")
5259 file-name))
b2d239c1
RS
5260 ((not (file-readable-p file-name))
5261 (error (if buffer-file-number
5262 "File %s no longer readable!"
5263 "Cannot revert unreadable file %s")
5264 file-name))
518dc5be
EZ
5265 (t
5266 ;; Bind buffer-file-name to nil
5267 ;; so that we don't try to lock the file.
5268 (let ((buffer-file-name nil))
5269 (or auto-save-p
5270 (unlock-buffer)))
5271 (widen)
5272 (let ((coding-system-for-read
44e97401 5273 ;; Auto-saved file should be read by Emacs's
518dc5be
EZ
5274 ;; internal coding.
5275 (if auto-save-p 'auto-save-coding
5276 (or coding-system-for-read
86c507f7
KH
5277 (and
5278 buffer-file-coding-system-explicit
5279 (car buffer-file-coding-system-explicit))))))
e1ee3b54 5280 (if (and (not enable-multibyte-characters)
52f9b751 5281 coding-system-for-read
e1ee3b54
KH
5282 (not (memq (coding-system-base
5283 coding-system-for-read)
5284 '(no-conversion raw-text))))
5285 ;; As a coding system suitable for multibyte
5286 ;; buffer is specified, make the current
5287 ;; buffer multibyte.
5288 (set-buffer-multibyte t))
5289
518dc5be
EZ
5290 ;; This force after-insert-file-set-coding
5291 ;; (called from insert-file-contents) to set
5292 ;; buffer-file-coding-system to a proper value.
5293 (kill-local-variable 'buffer-file-coding-system)
5294
5295 ;; Note that this preserves point in an intelligent way.
5296 (if preserve-modes
5297 (let ((buffer-file-format buffer-file-format))
5298 (insert-file-contents file-name (not auto-save-p)
5299 nil nil t))
5300 (insert-file-contents file-name (not auto-save-p)
2a29c409 5301 nil nil t)))))
44dce0fb
RS
5302 ;; Recompute the truename in case changes in symlinks
5303 ;; have changed the truename.
5304 (setq buffer-file-truename
5305 (abbreviate-file-name (file-truename buffer-file-name)))
3e214b50 5306 (after-find-file nil nil t nil preserve-modes)
44dce0fb
RS
5307 ;; Run after-revert-hook as it was before we reverted.
5308 (setq-default revert-buffer-internal-hook global-hook)
518dc5be 5309 (if local-hook
44dce0fb
RS
5310 (set (make-local-variable 'revert-buffer-internal-hook)
5311 local-hook)
5312 (kill-local-variable 'revert-buffer-internal-hook))
5313 (run-hooks 'revert-buffer-internal-hook))
5314 t))))))
b4da00e9 5315
64d18e8f
RS
5316(defun recover-this-file ()
5317 "Recover the visited file--get contents from its last auto-save file."
5318 (interactive)
5319 (recover-file buffer-file-name))
5320
b4da00e9
RM
5321(defun recover-file (file)
5322 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
5323 ;; Actually putting the file name in the minibuffer should be used
5324 ;; only rarely.
5325 ;; Not just because users often use the default.
e1dadc17 5326 (interactive "FRecover file: ")
b4da00e9 5327 (setq file (expand-file-name file))
f7da6740 5328 (if (auto-save-file-name-p (file-name-nondirectory file))
4e163715 5329 (error "%s is an auto-save file" (abbreviate-file-name file)))
b4da00e9
RM
5330 (let ((file-name (let ((buffer-file-name file))
5331 (make-auto-save-file-name))))
945e1965
RS
5332 (cond ((if (file-exists-p file)
5333 (not (file-newer-than-file-p file-name file))
5334 (not (file-exists-p file-name)))
4e163715
SM
5335 (error "Auto-save file %s not current"
5336 (abbreviate-file-name file-name)))
b4da00e9 5337 ((save-window-excursion
ffc0e1ca
AS
5338 (with-output-to-temp-buffer "*Directory*"
5339 (buffer-disable-undo standard-output)
5340 (save-excursion
5341 (let ((switches dired-listing-switches))
5342 (if (file-symlink-p file)
254c37a5 5343 (setq switches (concat switches " -L")))
ffc0e1ca 5344 (set-buffer standard-output)
bc22fd18
EZ
5345 ;; Use insert-directory-safely, not insert-directory,
5346 ;; because these files might not exist. In particular,
5347 ;; FILE might not exist if the auto-save file was for
5348 ;; a buffer that didn't visit a file, such as "*mail*".
5349 ;; The code in v20.x called `ls' directly, so we need
5350 ;; to emulate what `ls' did in that case.
5351 (insert-directory-safely file switches)
5352 (insert-directory-safely file-name switches))))
9aea757b 5353 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
b4da00e9 5354 (switch-to-buffer (find-file-noselect file t))
518dc5be 5355 (let ((inhibit-read-only t)
1e87edf5
KH
5356 ;; Keep the current buffer-file-coding-system.
5357 (coding-system buffer-file-coding-system)
1d0ec0d1 5358 ;; Auto-saved file should be read with special coding.
77619f8e 5359 (coding-system-for-read 'auto-save-coding))
b4da00e9 5360 (erase-buffer)
1e87edf5
KH
5361 (insert-file-contents file-name nil)
5362 (set-buffer-file-coding-system coding-system))
8cfb9d46 5363 (after-find-file nil nil t))
ffa7ab70 5364 (t (error "Recover-file cancelled")))))
b4da00e9 5365
6598027d 5366(defun recover-session ()
9aee5392
RS
5367 "Recover auto save files from a previous Emacs session.
5368This command first displays a Dired buffer showing you the
5369previous sessions that you could recover from.
5370To choose one, move point to the proper line and then type C-c C-c.
5371Then you'll be asked about a number of files to recover."
5372 (interactive)
363a5030
RS
5373 (if (null auto-save-list-file-prefix)
5374 (error "You set `auto-save-list-file-prefix' to disable making session files"))
ffc0e1ca
AS
5375 (let ((dir (file-name-directory auto-save-list-file-prefix)))
5376 (unless (file-directory-p dir)
194600a8
JPW
5377 (make-directory dir t))
5378 (unless (directory-files dir nil
5379 (concat "\\`" (regexp-quote
5380 (file-name-nondirectory
5381 auto-save-list-file-prefix)))
5382 t)
5383 (error "No previous sessions to recover")))
6f4983e6 5384 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5 5385 (dired (concat auto-save-list-file-prefix "*")
254c37a5 5386 (concat dired-listing-switches " -t")))
05e076c7
AS
5387 (save-excursion
5388 (goto-char (point-min))
5389 (or (looking-at " Move to the session you want to recover,")
5390 (let ((inhibit-read-only t))
5391 ;; Each line starts with a space
5392 ;; so that Font Lock mode won't highlight the first character.
5393 (insert " Move to the session you want to recover,\n"
5394 " then type C-c C-c to select it.\n\n"
5395 " You can also delete some of these files;\n"
5396 " type d on a line to mark that file for deletion.\n\n"))))
9aee5392 5397 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 5398 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 5399
80280bb7 5400(defun recover-session-finish ()
9aee5392
RS
5401 "Choose one saved session to recover auto-save files from.
5402This command is used in the special Dired buffer created by
80280bb7 5403\\[recover-session]."
9aee5392
RS
5404 (interactive)
5405 ;; Get the name of the session file to recover from.
5406 (let ((file (dired-get-filename))
953a03b2 5407 files
9aee5392 5408 (buffer (get-buffer-create " *recover*")))
c11032b9 5409 (dired-unmark 1)
033ef863 5410 (dired-do-flagged-delete t)
9aee5392 5411 (unwind-protect
8c3e96d2 5412 (with-current-buffer buffer
9aee5392 5413 ;; Read in the auto-save-list file.
9aee5392
RS
5414 (erase-buffer)
5415 (insert-file-contents file)
953a03b2
RS
5416 ;; Loop thru the text of that file
5417 ;; and get out the names of the files to recover.
5418 (while (not (eobp))
5419 (let (thisfile autofile)
5420 (if (eolp)
5421 ;; This is a pair of lines for a non-file-visiting buffer.
5422 ;; Get the auto-save file name and manufacture
5423 ;; a "visited file name" from that.
5424 (progn
5425 (forward-line 1)
259be4e6
JB
5426 ;; If there is no auto-save file name, the
5427 ;; auto-save-list file is probably corrupted.
5428 (unless (eolp)
5429 (setq autofile
5430 (buffer-substring-no-properties
5431 (point)
e442c62b 5432 (line-end-position)))
259be4e6
JB
5433 (setq thisfile
5434 (expand-file-name
5435 (substring
5436 (file-name-nondirectory autofile)
5437 1 -1)
5438 (file-name-directory autofile))))
953a03b2
RS
5439 (forward-line 1))
5440 ;; This pair of lines is a file-visiting
5441 ;; buffer. Use the visited file name.
5442 (progn
5443 (setq thisfile
5444 (buffer-substring-no-properties
5445 (point) (progn (end-of-line) (point))))
5446 (forward-line 1)
5447 (setq autofile
5448 (buffer-substring-no-properties
5449 (point) (progn (end-of-line) (point))))
5450 (forward-line 1)))
5451 ;; Ignore a file if its auto-save file does not exist now.
259be4e6 5452 (if (and autofile (file-exists-p autofile))
953a03b2
RS
5453 (setq files (cons thisfile files)))))
5454 (setq files (nreverse files))
945e1965
RS
5455 ;; The file contains a pair of line for each auto-saved buffer.
5456 ;; The first line of the pair contains the visited file name
5457 ;; or is empty if the buffer was not visiting a file.
5458 ;; The second line is the auto-save file name.
953a03b2
RS
5459 (if files
5460 (map-y-or-n-p "Recover %s? "
5461 (lambda (file)
5462 (condition-case nil
5463 (save-excursion (recover-file file))
76d5492b 5464 (error
953a03b2
RS
5465 "Failed to recover `%s'" file)))
5466 files
5467 '("file" "files" "recover"))
5468 (message "No files can be recovered from this session now")))
9aee5392
RS
5469 (kill-buffer buffer))))
5470
a151f82c 5471(defun kill-buffer-ask (buffer)
8fc29035 5472 "Kill BUFFER if confirmed."
9aea757b
CY
5473 (when (yes-or-no-p (format "Buffer %s %s. Kill? "
5474 (buffer-name buffer)
5475 (if (buffer-modified-p buffer)
5476 "HAS BEEN EDITED" "is unmodified")))
a151f82c
SS
5477 (kill-buffer buffer)))
5478
73ba610a 5479(defun kill-some-buffers (&optional list)
243a3ae0 5480 "Kill some buffers. Asks the user whether to kill each one of them.
bb8eaf67 5481Non-interactively, if optional argument LIST is non-nil, it
243a3ae0 5482specifies the list of buffers to kill, asking for approval for each one."
b4da00e9 5483 (interactive)
73ba610a
RS
5484 (if (null list)
5485 (setq list (buffer-list)))
5486 (while list
5487 (let* ((buffer (car list))
5488 (name (buffer-name buffer)))
cbca0a4b
RS
5489 (and name ; Can be nil for an indirect buffer
5490 ; if we killed the base buffer.
5491 (not (string-equal name ""))
26b9ecbc 5492 (/= (aref name 0) ?\s)
a151f82c 5493 (kill-buffer-ask buffer)))
73ba610a 5494 (setq list (cdr list))))
a151f82c
SS
5495
5496(defun kill-matching-buffers (regexp &optional internal-too)
8fc29035 5497 "Kill buffers whose name matches the specified REGEXP.
a151f82c
SS
5498The optional second argument indicates whether to kill internal buffers too."
5499 (interactive "sKill buffers matching this regular expression: \nP")
5500 (dolist (buffer (buffer-list))
5501 (let ((name (buffer-name buffer)))
5502 (when (and name (not (string-equal name ""))
5503 (or internal-too (/= (aref name 0) ?\s))
5504 (string-match regexp name))
5505 (kill-buffer-ask buffer)))))
5506
b4da00e9 5507\f
b4da00e9
RM
5508(defun rename-auto-save-file ()
5509 "Adjust current buffer's auto save file name for current conditions.
5510Also rename any existing auto save file, if it was made in this session."
5511 (let ((osave buffer-auto-save-file-name))
5512 (setq buffer-auto-save-file-name
5513 (make-auto-save-file-name))
5514 (if (and osave buffer-auto-save-file-name
5515 (not (string= buffer-auto-save-file-name buffer-file-name))
5516 (not (string= buffer-auto-save-file-name osave))
5517 (file-exists-p osave)
5518 (recent-auto-save-p))
5519 (rename-file osave buffer-auto-save-file-name t))))
5520
5521(defun make-auto-save-file-name ()
5522 "Return file name to use for auto-saves of current buffer.
5523Does not consider `auto-save-visited-file-name' as that variable is checked
5524before calling this function. You can redefine this for customization.
5525See also `auto-save-file-name-p'."
5526 (if buffer-file-name
c1105d05
MA
5527 (let ((handler (find-file-name-handler buffer-file-name
5528 'make-auto-save-file-name)))
5529 (if handler
5530 (funcall handler 'make-auto-save-file-name)
5531 (let ((list auto-save-file-name-transforms)
5532 (filename buffer-file-name)
5533 result uniq)
5534 ;; Apply user-specified translations
5535 ;; to the file name.
5536 (while (and list (not result))
5537 (if (string-match (car (car list)) filename)
5538 (setq result (replace-match (cadr (car list)) t nil
5539 filename)
5540 uniq (car (cddr (car list)))))
5541 (setq list (cdr list)))
5542 (if result
5543 (if uniq
5544 (setq filename (concat
5545 (file-name-directory result)
5546 (subst-char-in-string
5547 ?/ ?!
5548 (replace-regexp-in-string "!" "!!"
5549 filename))))
5550 (setq filename result)))
5551 (setq result
5552 (if (and (eq system-type 'ms-dos)
5553 (not (msdos-long-file-names)))
5554 ;; We truncate the file name to DOS 8+3 limits
5555 ;; before doing anything else, because the regexp
5556 ;; passed to string-match below cannot handle
5557 ;; extensions longer than 3 characters, multiple
5558 ;; dots, and other atrocities.
5559 (let ((fn (dos-8+3-filename
5560 (file-name-nondirectory buffer-file-name))))
5561 (string-match
5562 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5563 fn)
5564 (concat (file-name-directory buffer-file-name)
5565 "#" (match-string 1 fn)
5566 "." (match-string 3 fn) "#"))
5567 (concat (file-name-directory filename)
5568 "#"
5569 (file-name-nondirectory filename)
5570 "#")))
5571 ;; Make sure auto-save file names don't contain characters
5572 ;; invalid for the underlying filesystem.
18b28ef1 5573 (if (and (memq system-type '(ms-dos windows-nt cygwin))
c1105d05
MA
5574 ;; Don't modify remote (ange-ftp) filenames
5575 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
5576 (convert-standard-filename result)
5577 result))))
0a1763b4
RS
5578
5579 ;; Deal with buffers that don't have any associated files. (Mail
5580 ;; mode tends to create a good number of these.)
5581
7d483e8c 5582 (let ((buffer-name (buffer-name))
ff5c7181 5583 (limit 0)
77d18896 5584 file-name)
ad80c679
JR
5585 ;; Restrict the characters used in the file name to those which
5586 ;; are known to be safe on all filesystems, url-encoding the
5587 ;; rest.
5588 ;; We do this on all platforms, because even if we are not
5589 ;; running on DOS/Windows, the current directory may be on a
5590 ;; mounted VFAT filesystem, such as a USB memory stick.
5591 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
c3348e10
RS
5592 (let* ((character (aref buffer-name (match-beginning 0)))
5593 (replacement
ad80c679
JR
5594 ;; For multibyte characters, this will produce more than
5595 ;; 2 hex digits, so is not true URL encoding.
5596 (format "%%%02X" character)))
c3348e10
RS
5597 (setq buffer-name (replace-match replacement t t buffer-name))
5598 (setq limit (1+ (match-end 0)))))
a8abaf83 5599 ;; Generate the file name.
ff5c7181
RS
5600 (setq file-name
5601 (make-temp-file
5602 (let ((fname
5603 (expand-file-name
5604 (format "#%s#" buffer-name)
5605 ;; Try a few alternative directories, to get one we can
5606 ;; write it.
5607 (cond
5608 ((file-writable-p default-directory) default-directory)
5609 ((file-writable-p "/var/tmp/") "/var/tmp/")
5610 ("~/")))))
18b28ef1 5611 (if (and (memq system-type '(ms-dos windows-nt cygwin))
ff5c7181
RS
5612 ;; Don't modify remote (ange-ftp) filenames
5613 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5614 ;; The call to convert-standard-filename is in case
5615 ;; buffer-name includes characters not allowed by the
5616 ;; DOS/Windows filesystems. make-temp-file writes to the
5617 ;; file it creates, so we must fix the file name _before_
5618 ;; make-temp-file is called.
5619 (convert-standard-filename fname)
5620 fname))
5621 nil "#"))
5622 ;; make-temp-file creates the file,
5623 ;; but we don't want it to exist until we do an auto-save.
5624 (condition-case ()
5625 (delete-file file-name)
5626 (file-error nil))
5627 file-name)))
b4da00e9
RM
5628
5629(defun auto-save-file-name-p (filename)
5630 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5631FILENAME should lack slashes. You can redefine this for customization."
5632 (string-match "^#.*#$" filename))
5633\f
6f4983e6
RS
5634(defun wildcard-to-regexp (wildcard)
5635 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4837b516 5636The generated regexp will match a filename only if the filename
6f4983e6
RS
5637matches that wildcard according to shell rules. Only wildcards known
5638by `sh' are supported."
5639 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5640 ;; Copy the initial run of non-special characters.
5641 (result (substring wildcard 0 i))
5642 (len (length wildcard)))
5643 ;; If no special characters, we're almost done.
5644 (if i
5645 (while (< i len)
5646 (let ((ch (aref wildcard i))
5647 j)
5648 (setq
5649 result
5650 (concat result
5651 (cond
7e7c9c4e
RS
5652 ((and (eq ch ?\[)
5653 (< (1+ i) len)
5654 (eq (aref wildcard (1+ i)) ?\]))
5655 "\\[")
6f4983e6
RS
5656 ((eq ch ?\[) ; [...] maps to regexp char class
5657 (progn
5658 (setq i (1+ i))
5659 (concat
5660 (cond
5661 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5662 (progn
5663 (setq i (1+ i))
5664 (if (eq (aref wildcard i) ?\])
5665 (progn
5666 (setq i (1+ i))
5667 "[^]")
5668 "[^")))
5669 ((eq (aref wildcard i) ?^)
5670 ;; Found "[^". Insert a `\0' character
5671 ;; (which cannot happen in a filename)
5672 ;; into the character class, so that `^'
5673 ;; is not the first character after `[',
5674 ;; and thus non-special in a regexp.
5675 (progn
5676 (setq i (1+ i))
5677 "[\000^"))
5678 ((eq (aref wildcard i) ?\])
5679 ;; I don't think `]' can appear in a
5680 ;; character class in a wildcard, but
5681 ;; let's be general here.
5682 (progn
5683 (setq i (1+ i))
5684 "[]"))
5685 (t "["))
5686 (prog1 ; copy everything upto next `]'.
5687 (substring wildcard
5688 i
5689 (setq j (string-match
5690 "]" wildcard i)))
5691 (setq i (if j (1- j) (1- len)))))))
5692 ((eq ch ?.) "\\.")
5693 ((eq ch ?*) "[^\000]*")
5694 ((eq ch ?+) "\\+")
5695 ((eq ch ?^) "\\^")
5696 ((eq ch ?$) "\\$")
5697 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5698 ((eq ch ??) "[^\000]")
5699 (t (char-to-string ch)))))
5700 (setq i (1+ i)))))
5701 ;; Shell wildcards should match the entire filename,
5702 ;; not its part. Make the regexp say so.
5703 (concat "\\`" result "\\'")))
5704\f
21540597 5705(defcustom list-directory-brief-switches
1e8780b1 5706 (purecopy "-CF")
ba83982b 5707 "Switches for `list-directory' to pass to `ls' for brief listing."
21540597
RS
5708 :type 'string
5709 :group 'dired)
b4da00e9 5710
21540597 5711(defcustom list-directory-verbose-switches
1e8780b1 5712 (purecopy "-l")
ba83982b 5713 "Switches for `list-directory' to pass to `ls' for verbose listing."
21540597
RS
5714 :type 'string
5715 :group 'dired)
b4da00e9 5716
5de148a2
RS
5717(defun file-expand-wildcards (pattern &optional full)
5718 "Expand wildcard pattern PATTERN.
4db2a7de
RS
5719This returns a list of file names which match the pattern.
5720
814af837 5721If PATTERN is written as an absolute file name,
4db2a7de
RS
5722the values are absolute also.
5723
5724If PATTERN is written as a relative file name, it is interpreted
5725relative to the current default directory, `default-directory'.
5726The file names returned are normally also relative to the current
5727default directory. However, if FULL is non-nil, they are absolute."
032388f3
RS
5728 (save-match-data
5729 (let* ((nondir (file-name-nondirectory pattern))
5730 (dirpart (file-name-directory pattern))
5731 ;; A list of all dirs that DIRPART specifies.
5732 ;; This can be more than one dir
5733 ;; if DIRPART contains wildcards.
1f3611c6
MA
5734 (dirs (if (and dirpart
5735 (string-match "[[*?]"
5736 (or (file-remote-p dirpart 'localname)
5737 dirpart)))
032388f3
RS
5738 (mapcar 'file-name-as-directory
5739 (file-expand-wildcards (directory-file-name dirpart)))
5740 (list dirpart)))
5741 contents)
5742 (while dirs
5743 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
28fd8759
LMI
5744 (and (file-directory-p (directory-file-name (car dirs)))
5745 (file-readable-p (car dirs))))
032388f3
RS
5746 (let ((this-dir-contents
5747 ;; Filter out "." and ".."
5748 (delq nil
5749 (mapcar #'(lambda (name)
5750 (unless (string-match "\\`\\.\\.?\\'"
5751 (file-name-nondirectory name))
5752 name))
5753 (directory-files (or (car dirs) ".") full
5754 (wildcard-to-regexp nondir))))))
5755 (setq contents
5756 (nconc
5757 (if (and (car dirs) (not full))
5758 (mapcar (function (lambda (name) (concat (car dirs) name)))
5759 this-dir-contents)
5760 this-dir-contents)
5761 contents))))
5762 (setq dirs (cdr dirs)))
5763 contents)))
5de148a2 5764
1f3611c6
MA
5765;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5766(provide 'files '(remote-wildcards))
5767
b4da00e9
RM
5768(defun list-directory (dirname &optional verbose)
5769 "Display a list of files in or matching DIRNAME, a la `ls'.
5770DIRNAME is globbed by the shell if necessary.
5771Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5772Actions controlled by variables `list-directory-brief-switches'
5773and `list-directory-verbose-switches'."
5774 (interactive (let ((pfx current-prefix-arg))
7e27ce9c 5775 (list (read-directory-name (if pfx "List directory (verbose): "
b4da00e9
RM
5776 "List directory (brief): ")
5777 nil default-directory nil)
5778 pfx)))
5779 (let ((switches (if verbose list-directory-verbose-switches
84905190
RS
5780 list-directory-brief-switches))
5781 buffer)
b4da00e9
RM
5782 (or dirname (setq dirname default-directory))
5783 (setq dirname (expand-file-name dirname))
5784 (with-output-to-temp-buffer "*Directory*"
84905190 5785 (setq buffer standard-output)
b4da00e9
RM
5786 (buffer-disable-undo standard-output)
5787 (princ "Directory ")
5788 (princ dirname)
5789 (terpri)
7fdbcd83 5790 (with-current-buffer "*Directory*"
c3554e95 5791 (let ((wildcard (not (file-directory-p dirname))))
84905190
RS
5792 (insert-directory dirname switches wildcard (not wildcard)))))
5793 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5794 (with-current-buffer buffer
5795 (setq default-directory
5796 (if (file-directory-p dirname)
5797 (file-name-as-directory dirname)
5798 (file-name-directory dirname))))))
c3554e95 5799
ffc0e1ca
AS
5800(defun shell-quote-wildcard-pattern (pattern)
5801 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5802
5803PATTERN is assumed to represent a file-name wildcard suitable for the
7f94baf0
EZ
5804underlying filesystem. For Unix and GNU/Linux, each character from the
5805set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
ffc0e1ca
AS
5806the parts of the pattern which don't include wildcard characters are
5807quoted with double quotes.
7f94baf0
EZ
5808
5809This function leaves alone existing quote characters (\\ on Unix and \"
5810on Windows), so PATTERN can use them to quote wildcard characters that
5811need to be passed verbatim to shell commands."
ffc0e1ca
AS
5812 (save-match-data
5813 (cond
c60ee5e7 5814 ((memq system-type '(ms-dos windows-nt cygwin))
ffc0e1ca
AS
5815 ;; DOS/Windows don't allow `"' in file names. So if the
5816 ;; argument has quotes, we can safely assume it is already
5817 ;; quoted by the caller.
5818 (if (or (string-match "[\"]" pattern)
5819 ;; We quote [&()#$'] in case their shell is a port of a
5820 ;; Unixy shell. We quote [,=+] because stock DOS and
5821 ;; Windows shells require that in some cases, such as
5822 ;; passing arguments to batch files that use positional
5823 ;; arguments like %1.
5824 (not (string-match "[ \t;&()#$',=+]" pattern)))
5825 pattern
5826 (let ((result "\"")
5827 (beg 0)
5828 end)
5829 (while (string-match "[*?]+" pattern beg)
5830 (setq end (match-beginning 0)
5831 result (concat result (substring pattern beg end)
5832 "\""
5833 (substring pattern end (match-end 0))
5834 "\"")
5835 beg (match-end 0)))
5836 (concat result (substring pattern beg) "\""))))
5837 (t
5838 (let ((beg 0))
d6d61574 5839 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
ffc0e1ca
AS
5840 (setq pattern
5841 (concat (substring pattern 0 (match-beginning 0))
5842 "\\"
5843 (substring pattern (match-beginning 0)))
5844 beg (1+ (match-end 0)))))
5845 pattern))))
5846
5847
1e8780b1 5848(defvar insert-directory-program (purecopy "ls")
c3554e95
RS
5849 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5850
1e8780b1 5851(defcustom directory-free-space-program (purecopy "df")
ba83982b 5852 "Program to get the amount of free space on a file system.
f4d04672
RS
5853We assume the output has the format of `df'.
5854The value of this variable must be just a command name or file name;
5855if you want to specify options, use `directory-free-space-args'.
5856
01b26b90
EZ
5857A value of nil disables this feature.
5858
5859If the function `file-system-info' is defined, it is always used in
5860preference to the program given by this variable."
f4d04672
RS
5861 :type '(choice (string :tag "Program") (const :tag "None" nil))
5862 :group 'dired)
5863
525fdbc9 5864(defcustom directory-free-space-args
1e8780b1 5865 (purecopy (if (eq system-type 'darwin) "-k" "-Pk"))
ba83982b 5866 "Options to use when running `directory-free-space-program'."
f4d04672
RS
5867 :type 'string
5868 :group 'dired)
5869
01b26b90 5870(defun get-free-disk-space (dir)
26b9ecbc 5871 "Return the amount of free space on directory DIR's file system.
93a596e1
CY
5872The return value is a string describing the amount of free
5873space (normally, the number of free 1KB blocks).
5874
5875This function calls `file-system-info' if it is available, or
5876invokes the program specified by `directory-free-space-program'
5877and `directory-free-space-args'. If the system call or program
5878is unsuccessful, or if DIR is a remote directory, this function
5879returns nil."
e1bdde78 5880 (unless (file-remote-p dir)
06531fc3
MA
5881 ;; Try to find the number of free blocks. Non-Posix systems don't
5882 ;; always have df, but might have an equivalent system call.
5883 (if (fboundp 'file-system-info)
5884 (let ((fsinfo (file-system-info dir)))
5885 (if fsinfo
5886 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
51da8fe2 5887 (setq dir (expand-file-name dir))
06531fc3
MA
5888 (save-match-data
5889 (with-temp-buffer
5890 (when (and directory-free-space-program
e1bdde78
CY
5891 ;; Avoid failure if the default directory does
5892 ;; not exist (Bug#2631, Bug#3911).
53be4cdb 5893 (let ((default-directory "/"))
86c7144b 5894 (eq (call-process directory-free-space-program
06531fc3
MA
5895 nil t nil
5896 directory-free-space-args
86c7144b
CY
5897 dir)
5898 0)))
41f54b73
CY
5899 ;; Assume that the "available" column is before the
5900 ;; "capacity" column. Find the "%" and scan backward.
06531fc3 5901 (goto-char (point-min))
41f54b73
CY
5902 (forward-line 1)
5903 (when (re-search-forward
5904 "[[:space:]]+[^[:space:]]+%[^%]*$"
5905 (line-end-position) t)
5906 (goto-char (match-beginning 0))
5907 (let ((endpt (point)))
5908 (skip-chars-backward "^[:space:]")
5909 (buffer-substring-no-properties (point) endpt)))))))))
01b26b90 5910
9bc260cf
MA
5911;; The following expression replaces `dired-move-to-filename-regexp'.
5912(defvar directory-listing-before-filename-regexp
5913 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5914 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5915 ;; In some locales, month abbreviations are as short as 2 letters,
5916 ;; and they can be followed by ".".
5917 ;; In Breton, a month name can include a quote character.
5918 (month (concat l-or-quote l-or-quote "+\\.?"))
5919 (s " ")
5920 (yyyy "[0-9][0-9][0-9][0-9]")
5921 (dd "[ 0-3][0-9]")
5922 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5923 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5924 (zone "[-+][0-2][0-9][0-5][0-9]")
5925 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5926 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5927 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5928 "\\|" yyyy "-" iso-mm-dd "\\)"))
5929 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5930 s "+"
5931 "\\(" HH:MM "\\|" yyyy "\\)"))
5932 (western-comma (concat month s "+" dd "," s "+" yyyy))
5933 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5934 ;; omits the Kanji characters after month and day-of-month.
5935 ;; On Mac OS X 10.3, the date format in East Asian locales is
5936 ;; day-of-month digits followed by month digits.
5937 (mm "[ 0-1]?[0-9]")
5938 (east-asian
5939 (concat "\\(" mm l "?" s dd l "?" s "+"
5940 "\\|" dd s mm s "+" "\\)"
5941 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5942 ;; The "[0-9]" below requires the previous column to end in a digit.
5943 ;; This avoids recognizing `1 may 1997' as a date in the line:
5944 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5945
5946 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
50c58e27
CY
5947
5948 ;; For non-iso date formats, we add the ".*" in order to find
5949 ;; the last possible match. This avoids recognizing
5950 ;; `jservice 10 1024' as a date in the line:
9bc260cf
MA
5951 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5952
5953 ;; vc dired listings provide the state or blanks between file
5954 ;; permissions and date. The state is always surrounded by
e1dbe924 5955 ;; parentheses:
9bc260cf
MA
5956 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5957 ;; This is not supported yet.
50c58e27
CY
5958 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
5959 "\\|.*[0-9][BkKMGTPEZY]? "
5960 "\\(" western "\\|" western-comma "\\|" east-asian "\\)"
5961 "\\) +")))
9bc260cf
MA
5962 "Regular expression to match up to the file name in a directory listing.
5963The default value is designed to recognize dates and times
5964regardless of the language.")
01b26b90 5965
a1b0c2a7
RS
5966(defvar insert-directory-ls-version 'unknown)
5967
c3554e95
RS
5968;; insert-directory
5969;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5970;; FULL-DIRECTORY-P is nil.
5971;; The single line of output must display FILE's name as it was
5972;; given, namely, an absolute path name.
5973;; - must insert exactly one line for each file if WILDCARD or
5974;; FULL-DIRECTORY-P is t, plus one optional "total" line
5975;; before the file lines, plus optional text after the file lines.
5976;; Lines are delimited by "\n", so filenames containing "\n" are not
5977;; allowed.
5978;; File lines should display the basename.
5979;; - must be consistent with
5980;; - functions dired-move-to-filename, (these two define what a file line is)
5981;; dired-move-to-end-of-filename,
5982;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5983;; dired-insert-headerline
5984;; dired-after-subdir-garbage (defines what a "total" line is)
5985;; - variable dired-subdir-regexp
1fc85dae
KG
5986;; - may be passed "--dired" as the first argument in SWITCHES.
5987;; Filename handlers might have to remove this switch if their
5988;; "ls" command does not support it.
c3554e95 5989(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 5990 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 5991Leaves point after the inserted text.
8f8607be
LT
5992SWITCHES may be a string of options, or a list of strings
5993representing individual options.
c3554e95
RS
5994Optional third arg WILDCARD means treat FILE as shell wildcard.
5995Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5996switches do not contain `d', so that a full listing is expected.
5997
5998This works by running a directory listing program
406e12d9 5999whose name is in the variable `insert-directory-program'.
8f8607be
LT
6000If WILDCARD, it also runs the shell specified by `shell-file-name'.
6001
60ce7e3e 6002When SWITCHES contains the long `--dired' option, this function
8f8607be
LT
6003treats it specially, for the sake of dired. However, the
6004normally equivalent short `-D' option is just passed on to
6005`insert-directory-program', as any other option."
c870ab8e 6006 ;; We need the directory in order to find the right handler.
d2473540
AS
6007 (let ((handler (find-file-name-handler (expand-file-name file)
6008 'insert-directory)))
ebad92dc 6009 (if handler
c3554e95
RS
6010 (funcall handler 'insert-directory file switches
6011 wildcard full-directory-p)
818286f4 6012 (let (result (beg (point)))
ebad92dc
RS
6013
6014 ;; Read the actual directory using `insert-directory-program'.
6015 ;; RESULT gets the status code.
99f01c91
KH
6016 (let* (;; We at first read by no-conversion, then after
6017 ;; putting text property `dired-filename, decode one
6018 ;; bunch by one to preserve that property.
6019 (coding-system-for-read 'no-conversion)
6020 ;; This is to control encoding the arguments in call-process.
c60ee5e7 6021 (coding-system-for-write
82e22b57
KH
6022 (and enable-multibyte-characters
6023 (or file-name-coding-system
99f01c91 6024 default-file-name-coding-system))))
ebad92dc
RS
6025 (setq result
6026 (if wildcard
6027 ;; Run ls in the directory part of the file pattern
6028 ;; using the last component as argument.
6029 (let ((default-directory
6030 (if (file-name-absolute-p file)
6031 (file-name-directory file)
6032 (file-name-directory (expand-file-name file))))
6033 (pattern (file-name-nondirectory file)))
82137b51
GM
6034 ;; NB since switches is passed to the shell, be
6035 ;; careful of malicious values, eg "-l;reboot".
6036 ;; See eg dired-safe-switches-p.
ebad92dc
RS
6037 (call-process
6038 shell-file-name nil t nil
6039 "-c"
6040 (concat (if (memq system-type '(ms-dos windows-nt))
6041 ""
6042 "\\") ; Disregard Unix shell aliases!
6043 insert-directory-program
6044 " -d "
6045 (if (stringp switches)
6046 switches
6047 (mapconcat 'identity switches " "))
6048 " -- "
6049 ;; Quote some characters that have
6050 ;; special meanings in shells; but
6051 ;; don't quote the wildcards--we want
6052 ;; them to be special. We also
6053 ;; currently don't quote the quoting
6054 ;; characters in case people want to
6055 ;; use them explicitly to quote
6056 ;; wildcard characters.
6057 (shell-quote-wildcard-pattern pattern))))
6058 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6059 ;; directory if FILE is a symbolic link.
ecbaeb7b
MA
6060 (unless full-directory-p
6061 (setq switches
6062 (if (stringp switches)
6063 (concat switches " -d")
6064 (add-to-list 'switches "-d" 'append))))
ebad92dc
RS
6065 (apply 'call-process
6066 insert-directory-program nil t nil
6067 (append
6068 (if (listp switches) switches
6069 (unless (equal switches "")
6070 ;; Split the switches at any spaces so we can
6071 ;; pass separate options as separate args.
6072 (split-string switches)))
6073 ;; Avoid lossage if FILE starts with `-'.
6074 '("--")
6075 (progn
6076 (if (string-match "\\`~" file)
6077 (setq file (expand-file-name file)))
6078 (list
6079 (if full-directory-p
6080 (concat (file-name-as-directory file) ".")
6081 file))))))))
6082
a1b0c2a7
RS
6083 ;; If we got "//DIRED//" in the output, it means we got a real
6084 ;; directory listing, even if `ls' returned nonzero.
6085 ;; So ignore any errors.
6086 (when (if (stringp switches)
6087 (string-match "--dired\\>" switches)
6088 (member "--dired" switches))
6089 (save-excursion
6090 (forward-line -2)
6091 (when (looking-at "//SUBDIRED//")
6092 (forward-line -1))
6093 (if (looking-at "//DIRED//")
6094 (setq result 0))))
6095
6096 (when (and (not (eq 0 result))
6097 (eq insert-directory-ls-version 'unknown))
6098 ;; The first time ls returns an error,
6099 ;; find the version numbers of ls,
6100 ;; and set insert-directory-ls-version
6101 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6102 ;; is equal or if the info cannot be obtained.
6103 ;; (That can mean it isn't GNU ls.)
6104 (let ((version-out
6105 (with-temp-buffer
6106 (call-process "ls" nil t nil "--version")
6107 (buffer-string))))
6108 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
6109 (let* ((version (match-string 1 version-out))
6110 (split (split-string version "[.]"))
027a4b6b 6111 (numbers (mapcar 'string-to-number split))
a1b0c2a7
RS
6112 (min '(5 2 1))
6113 comparison)
6114 (while (and (not comparison) (or numbers min))
6115 (cond ((null min)
6116 (setq comparison '>))
6117 ((null numbers)
6118 (setq comparison '<))
6119 ((> (car numbers) (car min))
6120 (setq comparison '>))
6121 ((< (car numbers) (car min))
6122 (setq comparison '<))
6123 (t
6124 (setq numbers (cdr numbers)
6125 min (cdr min)))))
6126 (setq insert-directory-ls-version (or comparison '=)))
6127 (setq insert-directory-ls-version nil))))
6128
6129 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6130 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
6131 (setq result 0))
6132
ebad92dc 6133 ;; If `insert-directory-program' failed, signal an error.
15502042 6134 (unless (eq 0 result)
f2440e42
RS
6135 ;; Delete the error message it may have output.
6136 (delete-region beg (point))
15502042
EZ
6137 ;; On non-Posix systems, we cannot open a directory, so
6138 ;; don't even try, because that will always result in
6139 ;; the ubiquitous "Access denied". Instead, show the
6140 ;; command line so the user can try to guess what went wrong.
6141 (if (and (file-directory-p file)
6142 (memq system-type '(ms-dos windows-nt)))
6143 (error
6144 "Reading directory: \"%s %s -- %s\" exited with status %s"
6145 insert-directory-program
6146 (if (listp switches) (concat switches) switches)
6147 file result)
6148 ;; Unix. Access the file to get a suitable error.
6149 (access-file file "Reading directory")
6150 (error "Listing directory failed but `access-file' worked")))
ebad92dc 6151
8f8607be
LT
6152 (when (if (stringp switches)
6153 (string-match "--dired\\>" switches)
6154 (member "--dired" switches))
9bb99df6
LT
6155 ;; The following overshoots by one line for an empty
6156 ;; directory listed with "--dired", but without "-a"
6157 ;; switch, where the ls output contains a
6158 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6159 ;; We take care of that case later.
ff7affeb 6160 (forward-line -2)
9423860f
AS
6161 (when (looking-at "//SUBDIRED//")
6162 (delete-region (point) (progn (forward-line 1) (point)))
6163 (forward-line -1))
9bb99df6
LT
6164 (if (looking-at "//DIRED//")
6165 (let ((end (line-end-position))
6166 (linebeg (point))
6167 error-lines)
6168 ;; Find all the lines that are error messages,
6169 ;; and record the bounds of each one.
6170 (goto-char beg)
6171 (while (< (point) linebeg)
6172 (or (eql (following-char) ?\s)
6173 (push (list (point) (line-end-position)) error-lines))
6174 (forward-line 1))
6175 (setq error-lines (nreverse error-lines))
6176 ;; Now read the numeric positions of file names.
6177 (goto-char linebeg)
6178 (forward-word 1)
6179 (forward-char 3)
6180 (while (< (point) end)
6181 (let ((start (insert-directory-adj-pos
6182 (+ beg (read (current-buffer)))
6183 error-lines))
6184 (end (insert-directory-adj-pos
a1b0c2a7 6185 (+ beg (read (current-buffer)))
9bb99df6 6186 error-lines)))
26b9ecbc 6187 (if (memq (char-after end) '(?\n ?\s))
9bb99df6
LT
6188 ;; End is followed by \n or by " -> ".
6189 (put-text-property start end 'dired-filename t)
6190 ;; It seems that we can't trust ls's output as to
6191 ;; byte positions of filenames.
6192 (put-text-property beg (point) 'dired-filename nil)
6193 (end-of-line))))
6194 (goto-char end)
6195 (beginning-of-line)
6196 (delete-region (point) (progn (forward-line 1) (point))))
6197 ;; Take care of the case where the ls output contains a
6198 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6199 ;; and we went one line too far back (see above).
6200 (forward-line 1))
6201 (if (looking-at "//DIRED-OPTIONS//")
6202 (delete-region (point) (progn (forward-line 1) (point)))))
ff7affeb 6203
99f01c91 6204 ;; Now decode what read if necessary.
b6647390
KH
6205 (let ((coding (or coding-system-for-read
6206 file-name-coding-system
6207 default-file-name-coding-system
6208 'undecided))
0bded065 6209 coding-no-eol
99f01c91 6210 val pos)
b6647390
KH
6211 (when (and enable-multibyte-characters
6212 (not (memq (coding-system-base coding)
6213 '(raw-text no-conversion))))
6214 ;; If no coding system is specified or detection is
6215 ;; requested, detect the coding.
6216 (if (eq (coding-system-base coding) 'undecided)
6217 (setq coding (detect-coding-region beg (point) t)))
6218 (if (not (eq (coding-system-base coding) 'undecided))
6219 (save-restriction
0bded065
AS
6220 (setq coding-no-eol
6221 (coding-system-change-eol-conversion coding 'unix))
b6647390
KH
6222 (narrow-to-region beg (point))
6223 (goto-char (point-min))
6224 (while (not (eobp))
6225 (setq pos (point)
6226 val (get-text-property (point) 'dired-filename))
6227 (goto-char (next-single-property-change
6228 (point) 'dired-filename nil (point-max)))
0bded065
AS
6229 ;; Force no eol conversion on a file name, so
6230 ;; that CR is preserved.
6231 (decode-coding-region pos (point)
6232 (if val coding-no-eol coding))
b6647390
KH
6233 (if val
6234 (put-text-property pos (point)
6235 'dired-filename t)))))))
99f01c91 6236
75bb5ca4
AS
6237 (if full-directory-p
6238 ;; Try to insert the amount of free space.
6239 (save-excursion
6240 (goto-char beg)
6241 ;; First find the line to put it on.
6242 (when (re-search-forward "^ *\\(total\\)" nil t)
6243 (let ((available (get-free-disk-space ".")))
6244 (when available
6245 ;; Replace "total" with "used", to avoid confusion.
6246 (replace-match "total used in directory" nil nil nil 1)
6247 (end-of-line)
7c2fb837 6248 (insert " available " available))))))))))
34342a07 6249
a1b0c2a7 6250(defun insert-directory-adj-pos (pos error-lines)
fead94d6 6251 "Convert `ls --dired' file name position value POS to a buffer position.
a1b0c2a7
RS
6252File name position values returned in ls --dired output
6253count only stdout; they don't count the error messages sent to stderr.
6254So this function converts to them to real buffer positions.
6255ERROR-LINES is a list of buffer positions of error message lines,
6256of the form (START END)."
6257 (while (and error-lines (< (caar error-lines) pos))
6258 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
6259 (pop error-lines))
6260 pos)
6261
bc22fd18
EZ
6262(defun insert-directory-safely (file switches
6263 &optional wildcard full-directory-p)
6264 "Insert directory listing for FILE, formatted according to SWITCHES.
6265
6266Like `insert-directory', but if FILE does not exist, it inserts a
6267message to that effect instead of signaling an error."
6268 (if (file-exists-p file)
6269 (insert-directory file switches wildcard full-directory-p)
6270 ;; Simulate the message printed by `ls'.
6271 (insert (format "%s: No such file or directory\n" file))))
6272
88902b35 6273(defvar kill-emacs-query-functions nil
65d5c6de 6274 "Functions to call with no arguments to query about killing Emacs.
c80e3b4a 6275If any of these functions returns nil, killing Emacs is canceled.
6daab4ed
JB
6276`save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6277the low level primitive, does not. See also `kill-emacs-hook'.")
88902b35 6278
11f15305 6279(defcustom confirm-kill-emacs nil
9c2ba08f
EZ
6280 "How to ask for confirmation when leaving Emacs.
6281If nil, the default, don't ask at all. If the value is non-nil, it should
6282be a predicate function such as `yes-or-no-p'."
11f15305
GM
6283 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
6284 (const :tag "Ask with y-or-n-p" y-or-n-p)
6285 (const :tag "Don't confirm" nil))
bdd9ab6e 6286 :group 'convenience
11f15305
GM
6287 :version "21.1")
6288
b4da00e9
RM
6289(defun save-buffers-kill-emacs (&optional arg)
6290 "Offer to save each buffer, then kill this Emacs process.
02243d9d
GM
6291With prefix ARG, silently save all file-visiting buffers without asking.
6292If there are active processes where `process-query-on-exit-flag'
6293returns non-nil, asks whether processes should be killed.
6294Runs the members of `kill-emacs-query-functions' in turn and stops
6295if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
b4da00e9
RM
6296 (interactive "P")
6297 (save-some-buffers arg t)
6298 (and (or (not (memq t (mapcar (function
6299 (lambda (buf) (and (buffer-file-name buf)
6300 (buffer-modified-p buf))))
6301 (buffer-list))))
6302 (yes-or-no-p "Modified buffers exist; exit anyway? "))
6303 (or (not (fboundp 'process-list))
7c2fb837 6304 ;; process-list is not defined on MSDOS.
b4da00e9
RM
6305 (let ((processes (process-list))
6306 active)
6307 (while processes
48a4a1fb
KS
6308 (and (memq (process-status (car processes)) '(run stop open listen))
6309 (process-query-on-exit-flag (car processes))
b4da00e9
RM
6310 (setq active t))
6311 (setq processes (cdr processes)))
6312 (or (not active)
7d668f2c
CY
6313 (progn (list-processes t)
6314 (yes-or-no-p "Active processes exist; kill them and exit anyway? ")))))
88902b35 6315 ;; Query the user for other things, perhaps.
fb15c113 6316 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
11f15305
GM
6317 (or (null confirm-kill-emacs)
6318 (funcall confirm-kill-emacs "Really exit Emacs? "))
b4da00e9 6319 (kill-emacs)))
59e085e0 6320
6ed8eeff 6321(defun save-buffers-kill-terminal (&optional arg)
59e085e0
KL
6322 "Offer to save each buffer, then kill the current connection.
6323If the current frame has no client, kill Emacs itself.
6324
8fc29035 6325With prefix ARG, silently save all file-visiting buffers, then kill.
59e085e0
KL
6326
6327If emacsclient was started with a list of filenames to edit, then
6328only these files will be asked to be saved."
6329 (interactive "P")
0eef14bd
CY
6330 (if (frame-parameter (selected-frame) 'client)
6331 (server-save-buffers-kill-terminal arg)
6332 (save-buffers-kill-emacs arg)))
b4da00e9 6333\f
ffc0e1ca 6334;; We use /: as a prefix to "quote" a file name
47afc068
RS
6335;; so that magic file name handlers will not apply to it.
6336
6337(setq file-name-handler-alist
6d341a2a 6338 (cons (cons (purecopy "\\`/:") 'file-name-non-special)
47afc068
RS
6339 file-name-handler-alist))
6340
6341;; We depend on being the last handler on the list,
6342;; so that anything else which does need handling
6343;; has been handled already.
6344;; So it is safe for us to inhibit *all* magic file name handlers.
6345
6346(defun file-name-non-special (operation &rest arguments)
6347 (let ((file-name-handler-alist nil)
5cb1f728
KH
6348 (default-directory
6349 (if (eq operation 'insert-directory)
6350 (directory-file-name
ffc0e1ca 6351 (expand-file-name
5cb1f728
KH
6352 (unhandled-file-name-directory default-directory)))
6353 default-directory))
47afc068
RS
6354 ;; Get a list of the indices of the args which are file names.
6355 (file-arg-indices
6356 (cdr (or (assq operation
ae3b2983 6357 ;; The first six are special because they
47afc068
RS
6358 ;; return a file name. We want to include the /:
6359 ;; in the return value.
6360 ;; So just avoid stripping it in the first place.
6361 '((expand-file-name . nil)
6362 (file-name-directory . nil)
6363 (file-name-as-directory . nil)
6364 (directory-file-name . nil)
c736f678 6365 (file-name-sans-versions . nil)
ae3b2983 6366 (find-backup-file-name . nil)
c736f678 6367 ;; `identity' means just return the first arg
6750c852
RS
6368 ;; not stripped of its quoting.
6369 (substitute-in-file-name identity)
ae3b2983
MA
6370 ;; `add' means add "/:" to the result.
6371 (file-truename add 0)
10e1d5f3 6372 (insert-file-contents insert-file-contents 0)
ae3b2983
MA
6373 ;; `unquote-then-quote' means set buffer-file-name
6374 ;; temporarily to unquoted filename.
6375 (verify-visited-file-modtime unquote-then-quote)
6376 ;; List the arguments which are filenames.
c37adaa5
SM
6377 (file-name-completion 1)
6378 (file-name-all-completions 1)
ae3b2983 6379 (write-region 2 5)
47afc068
RS
6380 (rename-file 0 1)
6381 (copy-file 0 1)
6382 (make-symbolic-link 0 1)
6383 (add-name-to-file 0 1)))
6384 ;; For all other operations, treat the first argument only
6385 ;; as the file name.
6386 '(nil 0))))
6750c852 6387 method
47afc068
RS
6388 ;; Copy ARGUMENTS so we can replace elements in it.
6389 (arguments (copy-sequence arguments)))
6750c852
RS
6390 (if (symbolp (car file-arg-indices))
6391 (setq method (pop file-arg-indices)))
6392 ;; Strip off the /: from the file names that have it.
47afc068 6393 (save-match-data
18b9dced 6394 (while (consp file-arg-indices)
fe4d9852
KH
6395 (let ((pair (nthcdr (car file-arg-indices) arguments)))
6396 (and (car pair)
6397 (string-match "\\`/:" (car pair))
6398 (setcar pair
6399 (if (= (length (car pair)) 2)
6400 "/"
6401 (substring (car pair) 2)))))
47afc068 6402 (setq file-arg-indices (cdr file-arg-indices))))
10e1d5f3
SM
6403 (case method
6404 (identity (car arguments))
6405 (add (concat "/:" (apply operation arguments)))
6406 (insert-file-contents
6407 (let ((visit (nth 1 arguments)))
6408 (prog1
e8f30180 6409 (apply operation arguments)
10e1d5f3
SM
6410 (when (and visit buffer-file-name)
6411 (setq buffer-file-name (concat "/:" buffer-file-name))))))
6412 (unquote-then-quote
6413 (let ((buffer-file-name (substring buffer-file-name 2)))
6414 (apply operation arguments)))
6750c852
RS
6415 (t
6416 (apply operation arguments)))))
47afc068 6417\f
90d10f16
MC
6418;; Symbolic modes and read-file-modes.
6419
6420(defun file-modes-char-to-who (char)
e240aaa9
EZ
6421 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6422CHAR is in [ugoa] and represents the category of users (Owner, Group,
6423Others, or All) for whom to produce the mask.
6424The bit-mask that is returned extracts from mode bits the access rights
6425for the specified category of users."
90d10f16
MC
6426 (cond ((= char ?u) #o4700)
6427 ((= char ?g) #o2070)
6428 ((= char ?o) #o1007)
6429 ((= char ?a) #o7777)
6430 (t (error "%c: bad `who' character" char))))
6431
6432(defun file-modes-char-to-right (char &optional from)
e240aaa9
EZ
6433 "Convert CHAR to a numeric value of mode bits.
6434CHAR is in [rwxXstugo] and represents symbolic access permissions.
6435If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
90d10f16
MC
6436 (or from (setq from 0))
6437 (cond ((= char ?r) #o0444)
6438 ((= char ?w) #o0222)
6439 ((= char ?x) #o0111)
6440 ((= char ?s) #o1000)
6441 ((= char ?t) #o6000)
6442 ;; Rights relative to the previous file modes.
6443 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
6444 ((= char ?u) (let ((uright (logand #o4700 from)))
6445 (+ uright (/ uright #o10) (/ uright #o100))))
6446 ((= char ?g) (let ((gright (logand #o2070 from)))
6447 (+ gright (/ gright #o10) (* gright #o10))))
6448 ((= char ?o) (let ((oright (logand #o1007 from)))
6449 (+ oright (* oright #o10) (* oright #o100))))
6450 (t (error "%c: bad right character" char))))
6451
6452(defun file-modes-rights-to-number (rights who-mask &optional from)
e240aaa9 6453 "Convert a symbolic mode string specification to an equivalent number.
ca66f00d 6454RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
e240aaa9
EZ
6455WHO-MASK is the bit-mask specifying the category of users to which to
6456apply the access permissions. See `file-modes-char-to-who'.
6457FROM (or 0 if nil) gives the mode bits on which to base permissions if
6458RIGHTS request to add, remove, or set permissions based on existing ones,
6459as in \"og+rX-w\"."
90d10f16
MC
6460 (let* ((num-rights (or from 0))
6461 (list-rights (string-to-list rights))
6462 (op (pop list-rights)))
6463 (while (memq op '(?+ ?- ?=))
6464 (let ((num-right 0)
6465 char-right)
6466 (while (memq (setq char-right (pop list-rights))
6467 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
6468 (setq num-right
6469 (logior num-right
6470 (file-modes-char-to-right char-right num-rights))))
6471 (setq num-right (logand who-mask num-right)
6472 num-rights
6473 (cond ((= op ?+) (logior num-rights num-right))
6474 ((= op ?-) (logand num-rights (lognot num-right)))
6475 (t (logior (logand num-rights (lognot who-mask)) num-right)))
6476 op char-right)))
6477 num-rights))
6478
6479(defun file-modes-symbolic-to-number (modes &optional from)
6480 "Convert symbolic file modes to numeric file modes.
6481MODES is the string to convert, it should match
ca66f00d 6482\"[ugoa]*([+-=][rwxXstugo]*)+,...\".
64b51947 6483See Info node `(coreutils)File permissions' for more information on this
90d10f16 6484notation.
e240aaa9
EZ
6485FROM (or 0 if nil) gives the mode bits on which to base permissions if
6486MODES request to add, remove, or set permissions based on existing ones,
6487as in \"og+rX-w\"."
90d10f16
MC
6488 (save-match-data
6489 (let ((case-fold-search nil)
6490 (num-modes (or from 0)))
6491 (while (/= (string-to-char modes) 0)
ca66f00d 6492 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes)
90d10f16
MC
6493 (let ((num-who (apply 'logior 0
6494 (mapcar 'file-modes-char-to-who
6495 (match-string 1 modes)))))
6496 (when (= num-who 0)
6497 (setq num-who (default-file-modes)))
6498 (setq num-modes
6499 (file-modes-rights-to-number (substring modes (match-end 1))
6500 num-who num-modes)
6501 modes (substring modes (match-end 3))))
6502 (error "Parse error in modes near `%s'" (substring modes 0))))
6503 num-modes)))
6504
6505(defun read-file-modes (&optional prompt orig-file)
e240aaa9 6506 "Read file modes in octal or symbolic notation and return its numeric value.
90d10f16 6507PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
e240aaa9
EZ
6508ORIG-FILE is the name of a file on whose mode bits to base returned
6509permissions if what user types requests to add, remove, or set permissions
6510based on existing mode bits, as in \"og+rX-w\"."
90d10f16
MC
6511 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
6512 (error "File not found")))
7cb41b32
JL
6513 (modestr (and (stringp orig-file)
6514 (nth 8 (file-attributes orig-file))))
6515 (default
6516 (and (stringp modestr)
6517 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
6518 (replace-regexp-in-string
6519 "-" ""
6520 (format "u=%s,g=%s,o=%s"
6521 (match-string 1 modestr)
6522 (match-string 2 modestr)
6523 (match-string 3 modestr)))))
6524 (value (read-string (or prompt "File modes (octal or symbolic): ")
6525 nil nil default)))
90d10f16
MC
6526 (save-match-data
6527 (if (string-match "^[0-7]+" value)
6528 (string-to-number value 8)
6529 (file-modes-symbolic-to-number value modes)))))
6530
6531\f
e240aaa9 6532;; Trashcan handling.
d63a01ef 6533(defcustom trash-directory nil
6cf29fe8 6534 "Directory for `move-file-to-trash' to move files and directories to.
d63a01ef
CY
6535This directory is only used when the function `system-move-file-to-trash'
6536is not defined.
6537Relative paths are interpreted relative to `default-directory'.
6538If the value is nil, Emacs uses a freedesktop.org-style trashcan."
f7c0d931 6539 :type '(choice (const nil) directory)
6cf29fe8 6540 :group 'auto-save
d63a01ef
CY
6541 :version "23.2")
6542
6543(defvar trash--hexify-table)
6cf29fe8
JR
6544
6545(declare-function system-move-file-to-trash "w32fns.c" (filename))
6546
6547(defun move-file-to-trash (filename)
d63a01ef
CY
6548 "Move the file (or directory) named FILENAME to the trash.
6549When `delete-by-moving-to-trash' is non-nil, this function is
6550called by `delete-file' and `delete-directory' instead of
6551deleting files outright.
6552
6553If the function `system-move-file-to-trash' is defined, call it
6554 with FILENAME as an argument.
6555Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6556 directory.
6557Otherwise, trash FILENAME using the freedesktop.org conventions,
6558 like the GNOME, KDE and XFCE desktop environments. Emacs only
6559 moves files to \"home trash\", ignoring per-volume trashcans."
6cf29fe8 6560 (interactive "fMove file to trash: ")
d63a01ef
CY
6561 (cond (trash-directory
6562 ;; If `trash-directory' is non-nil, move the file there.
6563 (let* ((trash-dir (expand-file-name trash-directory))
6564 (fn (directory-file-name (expand-file-name filename)))
6565 (new-fn (expand-file-name (file-name-nondirectory fn)
6566 trash-dir)))
6567 ;; We can't trash a parent directory of trash-directory.
1acad97c 6568 (if (string-prefix-p fn trash-dir)
d63a01ef
CY
6569 (error "Trash directory `%s' is a subdirectory of `%s'"
6570 trash-dir filename))
6571 (unless (file-directory-p trash-dir)
6572 (make-directory trash-dir t))
6573 ;; Ensure that the trashed file-name is unique.
6574 (if (file-exists-p new-fn)
6575 (let ((version-control t)
6576 (backup-directory-alist nil))
6577 (setq new-fn (car (find-backup-file-name new-fn)))))
6578 (let (delete-by-moving-to-trash)
6579 (rename-file fn new-fn))))
6580 ;; If `system-move-file-to-trash' is defined, use it.
6581 ((fboundp 'system-move-file-to-trash)
6582 (system-move-file-to-trash filename))
6583 ;; Otherwise, use the freedesktop.org method, as specified at
6584 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6585 (t
6586 (let* ((xdg-data-dir
6587 (directory-file-name
6588 (expand-file-name "Trash"
6589 (or (getenv "XDG_DATA_HOME")
6590 "~/.local/share"))))
6591 (trash-files-dir (expand-file-name "files" xdg-data-dir))
6592 (trash-info-dir (expand-file-name "info" xdg-data-dir))
6593 (fn (directory-file-name (expand-file-name filename))))
6594
6595 ;; Check if we have permissions to delete.
6596 (unless (file-writable-p (directory-file-name
6597 (file-name-directory fn)))
6598 (error "Cannot move %s to trash: Permission denied" filename))
6599 ;; The trashed file cannot be the trash dir or its parent.
1acad97c 6600 (if (string-prefix-p fn trash-files-dir)
d63a01ef
CY
6601 (error "The trash directory %s is a subdirectory of %s"
6602 trash-files-dir filename))
1acad97c 6603 (if (string-prefix-p fn trash-info-dir)
d63a01ef
CY
6604 (error "The trash directory %s is a subdirectory of %s"
6605 trash-info-dir filename))
6606
6607 ;; Ensure that the trash directory exists; otherwise, create it.
6608 (let ((saved-default-file-modes (default-file-modes)))
6bb72cbd
PE
6609 (unwind-protect
6610 (progn
6611 (set-default-file-modes #o700)
6612 (unless (file-exists-p trash-files-dir)
6613 (make-directory trash-files-dir t))
6614 (unless (file-exists-p trash-info-dir)
6615 (make-directory trash-info-dir t)))
6616 (set-default-file-modes saved-default-file-modes)))
d63a01ef
CY
6617
6618 ;; Try to move to trash with .trashinfo undo information
6619 (save-excursion
6620 (with-temp-buffer
6621 (set-buffer-file-coding-system 'utf-8-unix)
6622 (insert "[Trash Info]\nPath=")
6623 ;; Perform url-encoding on FN. For compatibility with
6624 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6625 ;; for path separators.
6626 (unless (boundp 'trash--hexify-table)
6627 (setq trash--hexify-table (make-vector 256 nil))
6628 (let ((unreserved-chars
6629 (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6630 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6631 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6632 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2
6633 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?'
6634 ?\( ?\))))
6635 (dotimes (byte 256)
6636 (aset trash--hexify-table byte
6637 (if (memq byte unreserved-chars)
6638 (char-to-string byte)
6639 (format "%%%02x" byte))))))
6640 (mapc (lambda (byte)
6641 (insert (aref trash--hexify-table byte)))
6642 (if (multibyte-string-p fn)
6643 (encode-coding-string fn 'utf-8)
6644 fn))
6645 (insert "\nDeletionDate="
6646 (format-time-string "%Y-%m-%dT%T")
6647 "\n")
6648
6649 ;; Attempt to make .trashinfo file, trying up to 5
6650 ;; times. The .trashinfo file is opened with O_EXCL,
6651 ;; as per trash-spec 0.7, even if that can be a problem
6652 ;; on old NFS versions...
6653 (let* ((tries 5)
6654 (base-fn (expand-file-name
6655 (file-name-nondirectory fn)
6656 trash-files-dir))
6657 (new-fn base-fn)
6658 success info-fn)
6659 (while (> tries 0)
6660 (setq info-fn (expand-file-name
6661 (concat (file-name-nondirectory new-fn)
6662 ".trashinfo")
6663 trash-info-dir))
6664 (unless (condition-case nil
6665 (progn
6666 (write-region nil nil info-fn nil
6667 'quiet info-fn 'excl)
6668 (setq tries 0 success t))
6669 (file-already-exists nil))
6670 (setq tries (1- tries))
8350f087 6671 ;; Uniquify new-fn. (Some file managers do not
d63a01ef
CY
6672 ;; like Emacs-style backup file names---e.g. bug
6673 ;; 170956 in Konqueror bug tracker.)
6674 (setq new-fn (make-temp-name (concat base-fn "_")))))
6675 (unless success
6676 (error "Cannot move %s to trash: Lock failed" filename))
6677
6678 ;; Finally, try to move the file to the trashcan.
6679 (let ((delete-by-moving-to-trash nil))
6680 (rename-file fn new-fn)))))))))
6cf29fe8
JR
6681
6682\f
b4da00e9 6683(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
6684(define-key ctl-x-map "\C-r" 'find-file-read-only)
6685(define-key ctl-x-map "\C-v" 'find-alternate-file)
6686(define-key ctl-x-map "\C-s" 'save-buffer)
6687(define-key ctl-x-map "s" 'save-some-buffers)
6688(define-key ctl-x-map "\C-w" 'write-file)
6689(define-key ctl-x-map "i" 'insert-file)
6690(define-key esc-map "~" 'not-modified)
6691(define-key ctl-x-map "\C-d" 'list-directory)
6ed8eeff 6692(define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
d758359d 6693(define-key ctl-x-map "\C-q" 'toggle-read-only)
b4da00e9
RM
6694
6695(define-key ctl-x-4-map "f" 'find-file-other-window)
6696(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
6697(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
6698(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 6699(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 6700
f98955ea
JB
6701(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
6702(define-key ctl-x-5-map "f" 'find-file-other-frame)
6703(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
6704(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
3095ccf5 6705(define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
c0274f38
ER
6706
6707;;; files.el ends here