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