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