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