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