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