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