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