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