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