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