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