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