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