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