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