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