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