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