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