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