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