(mail-interactive): Change default.
[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))
5ee66afc
SM
2863 ;; This used to be an error, but really all it means is
2864 ;; that this may simply not be a local-variables section,
2865 ;; so just ignore it.
2866 (message "Local variables list is not properly terminated"))
5a6c1d87
CY
2867 (beginning-of-line)
2868 (setq endpos (point)))
2869
2870 (with-temp-buffer
2871 (insert-buffer-substring thisbuf startpos endpos)
2872 (goto-char (point-min))
2873 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2874 (while (not (eobp))
2875 ;; Discard the prefix.
2876 (if (looking-at prefix)
2877 (delete-region (point) (match-end 0))
2878 (error "Local variables entry is missing the prefix"))
2879 (end-of-line)
2880 ;; Discard the suffix.
2881 (if (looking-back suffix)
2882 (delete-region (match-beginning 0) (point))
2883 (error "Local variables entry is missing the suffix"))
2884 (forward-line 1))
2885 (goto-char (point-min))
2886
2887 (while (not (eobp))
2888 ;; Find the variable name; strip whitespace.
2889 (skip-chars-forward " \t")
2890 (setq beg (point))
2891 (skip-chars-forward "^:\n")
2892 (if (eolp) (error "Missing colon in local variables entry"))
2893 (skip-chars-backward " \t")
2894 (let* ((str (buffer-substring beg (point)))
2895 (var (read str))
2896 val)
2897 ;; Read the variable value.
2898 (skip-chars-forward "^:")
2899 (forward-char 1)
2900 (setq val (read (current-buffer)))
2901 (if mode-only
2902 (if (eq var 'mode)
2903 (setq result t))
2904 (unless (eq var 'coding)
2905 (condition-case nil
2906 (push (cons (if (eq var 'eval)
2907 'eval
2908 (indirect-variable var))
2909 val) result)
2910 (error nil)))))
2911 (forward-line 1)))))))
2912
2913 ;; We've read all the local variables. Now, return whether the
2914 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2915 ;; variables (if MODE-ONLY is nil.)
2916 (if mode-only
2917 result
1b21ee06 2918 (hack-local-variables-apply result nil)
a548f3d7 2919 (run-hooks 'hack-local-variables-hook)))))
5a6c1d87 2920
5a6c1d87
CY
2921(defun safe-local-variable-p (sym val)
2922 "Non-nil if SYM is safe as a file-local variable with value VAL.
2923It is safe if any of these conditions are met:
2924
2925 * There is a matching entry (SYM . VAL) in the
2926 `safe-local-variable-values' user option.
2927
5a6c1d87
CY
2928 * The `safe-local-variable' property of SYM is a function that
2929 evaluates to a non-nil value with VAL as an argument."
2930 (or (member (cons sym val) safe-local-variable-values)
2931 (let ((safep (get sym 'safe-local-variable)))
80aa4695 2932 (and (functionp safep) (funcall safep val)))))
5a6c1d87
CY
2933
2934(defun risky-local-variable-p (sym &optional ignored)
2935 "Non-nil if SYM could be dangerous as a file-local variable.
2936It is dangerous if either of these conditions are met:
2937
2938 * Its `risky-local-variable' property is non-nil.
2939
2940 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
2941 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
cc5a104d
RS
2942 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
2943 \"map-alist\", or \"bindat-spec\"."
f36d46ca
RS
2944 ;; If this is an alias, check the base name.
2945 (condition-case nil
2946 (setq sym (indirect-variable sym))
2947 (error nil))
5a6c1d87
CY
2948 (or (get sym 'risky-local-variable)
2949 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
2950-commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
2951-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
cc5a104d 2952-map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
7ed9159a 2953
d0bd3513
RS
2954(defun hack-one-local-variable-quotep (exp)
2955 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2956
ff7affeb
RS
2957(defun hack-one-local-variable-constantp (exp)
2958 (or (and (not (symbolp exp)) (not (consp exp)))
2959 (memq exp '(t nil))
2960 (keywordp exp)
2961 (hack-one-local-variable-quotep exp)))
2962
2963(defun hack-one-local-variable-eval-safep (exp)
2964 "Return t if it is safe to eval EXP when it is found in a file."
8fd9c174
RS
2965 (or (not (consp exp))
2966 ;; Detect certain `put' expressions.
2967 (and (eq (car exp) 'put)
2968 (hack-one-local-variable-quotep (nth 1 exp))
2969 (hack-one-local-variable-quotep (nth 2 exp))
bc5d1dfb
EZ
2970 (let ((prop (nth 1 (nth 2 exp))) (val (nth 3 exp)))
2971 (cond ((eq prop 'lisp-indent-hook)
2972 ;; Only allow safe values of lisp-indent-hook;
2973 ;; not functions.
2974 (or (numberp val) (equal val ''defun)))
2975 ((eq prop 'edebug-form-spec)
2976 ;; Only allow indirect form specs.
b486a098
SM
2977 ;; During bootstrapping, edebug-basic-spec might not be
2978 ;; defined yet.
2979 (and (fboundp 'edebug-basic-spec)
f215a02f
AS
2980 (hack-one-local-variable-quotep val)
2981 (edebug-basic-spec (nth 1 val)))))))
8fd9c174
RS
2982 ;; Allow expressions that the user requested.
2983 (member exp safe-local-eval-forms)
2984 ;; Certain functions can be allowed with safe arguments
2985 ;; or can specify verification functions to try.
2986 (and (symbolp (car exp))
2987 (let ((prop (get (car exp) 'safe-local-eval-function)))
2988 (cond ((eq prop t)
2989 (let ((ok t))
2990 (dolist (arg (cdr exp))
2991 (unless (hack-one-local-variable-constantp arg)
2992 (setq ok nil)))
2993 ok))
2994 ((functionp prop)
2995 (funcall prop exp))
2996 ((listp prop)
2997 (let ((ok nil))
2998 (dolist (function prop)
2999 (if (funcall function exp)
3000 (setq ok t)))
3001 ok)))))))
ff7affeb 3002
f3e23606 3003(defun hack-one-local-variable (var val)
0c7c413c
CY
3004 "Set local variable VAR with value VAL.
3005If VAR is `mode', call `VAL-mode' as a function unless it's
3006already the major mode."
f3e23606 3007 (cond ((eq var 'mode)
0c7c413c
CY
3008 (let ((mode (intern (concat (downcase (symbol-name val))
3009 "-mode"))))
3010 (unless (eq (indirect-function mode)
3011 (indirect-function major-mode))
3012 (funcall mode))))
5a6c1d87
CY
3013 ((eq var 'eval)
3014 (save-excursion (eval val)))
e442c62b
SM
3015 (t
3016 ;; Make sure the string has no text properties.
3017 ;; Some text properties can get evaluated in various ways,
3018 ;; so it is risky to put them on with a local variable list.
3019 (if (stringp val)
3020 (set-text-properties 0 (length val) nil val))
3021 (set (make-local-variable var) val))))
1b21ee06
MO
3022\f
3023;;; Handling directory local variables, aka project settings.
3024
3025(defvar project-class-alist '()
3026 "Alist mapping project class names (symbols) to project variable lists.")
3027
3028(defvar project-directory-alist '()
3029 "Alist mapping project directory roots to project classes.")
3030
3031(defsubst project-get-alist (class)
3032 "Return the project variable list for project CLASS."
3033 (cdr (assq class project-class-alist)))
3034
3035(defun project-collect-bindings-from-alist (mode-alist settings)
3036 "Collect local variable settings from MODE-ALIST.
3037SETTINGS is the initial list of bindings.
3038Returns the new list."
3039 (dolist (pair mode-alist settings)
3040 (let* ((variable (car pair))
3041 (value (cdr pair))
3042 (slot (assq variable settings)))
3043 (if slot
3044 (setcdr slot value)
3045 ;; Need a new cons in case we setcdr later.
3046 (push (cons variable value) settings)))))
3047
3048(defun project-collect-binding-list (binding-list root settings)
3049 "Collect entries from BINDING-LIST into SETTINGS.
3050ROOT is the root directory of the project.
3051Return the new settings list."
3052 (let* ((file-name (buffer-file-name))
3053 (sub-file-name (if file-name
3054 (substring file-name (length root)))))
3055 (dolist (entry binding-list settings)
3056 (let ((key (car entry)))
3057 (cond
3058 ((stringp key)
3059 ;; Don't include this in the previous condition, because we
3060 ;; want to filter all strings before the next condition.
3061 (when (and sub-file-name
3062 (>= (length sub-file-name) (length key))
3063 (string= key (substring sub-file-name 0 (length key))))
3064 (setq settings (project-collect-binding-list (cdr entry)
3065 root settings))))
3066 ((or (not key)
3067 (derived-mode-p key))
3068 (setq settings (project-collect-bindings-from-alist (cdr entry)
3069 settings))))))))
3070
3071(defun set-directory-project (directory class)
3072 "Declare that the project rooted at DIRECTORY is an instance of CLASS.
3073DIRECTORY is the name of a directory, a string.
3074CLASS is the name of a project class, a symbol.
3075
3076When a file beneath DIRECTORY is visited, the mode-specific
3077settings from CLASS will be applied to the buffer. The settings
3078for a class are defined using `define-project-bindings'."
3079 (setq directory (file-name-as-directory (expand-file-name directory)))
3080 (unless (assq class project-class-alist)
3081 (error "No such project class `%s'" (symbol-name class)))
3082 (push (cons directory class) project-directory-alist))
3083
3084(defun define-project-bindings (class list)
3085 "Map the project type CLASS to a list of variable settings.
3086CLASS is the project class, a symbol.
3087LIST is a list that declares variable settings for the class.
3088An element in LIST is either of the form:
3089 (MAJOR-MODE . ALIST)
3090or
3091 (DIRECTORY . LIST)
3092
3093In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3094whose elements are of the form (VARIABLE . VALUE).
3095
3096In the second form, DIRECTORY is a directory name (a string), and
3097LIST is a list of the form accepted by the function.
3098
3099When a file is visited, the file's class is found. A directory
3100may be assigned a class using `set-directory-project'. Then
3101variables are set in the file's buffer according to the class'
3102LIST. The list is processed in order.
3103
3104* If the element is of the form (MAJOR-MODE . ALIST), and the
3105 buffer's major mode is derived from MAJOR-MODE (as determined
3106 by `derived-mode-p'), then all the settings in ALIST are
3107 applied. A MAJOR-MODE of nil may be used to match any buffer.
3108 `make-local-variable' is called for each variable before it is
3109 set.
3110
3111* If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3112 is an initial substring of the file's directory, then LIST is
3113 applied by recursively following these rules."
3114 (let ((elt (assq class project-class-alist)))
3115 (if elt
3116 (setcdr elt list)
3117 (push (cons class list) project-class-alist))))
3118
3119(defun project-find-settings-file (file)
3120 "Find the settings file for FILE.
3121This searches upward in the directory tree.
3122If a settings file is found, the file name is returned.
3123If the file is in a registered project, a cons from
3124`project-directory-alist' is returned.
3125Otherwise this returns nil."
a77b655d
SM
3126 (setq file (expand-file-name file))
3127 (let* ((settings (locate-dominating-file file "\\`\\.dir-settings\\.el\\'"))
3128 (pda nil))
3129 ;; `locate-dominating-file' may have abbreviated the name.
3130 (if settings (setq settings (expand-file-name settings)))
3131 (dolist (x project-directory-alist)
3132 (when (and (eq t (compare-strings file nil (length (car x))
3133 (car x) nil nil))
3134 (> (length (car x)) (length (car pda))))
3135 (setq pda x)))
3136 (if (and settings pda)
3137 (if (> (length (file-name-directory settings))
3138 (length (car pda)))
3139 settings pda)
3140 (or settings pda))))
1b21ee06
MO
3141
3142(defun project-define-from-project-file (settings-file)
3143 "Load a settings file and register a new project class and instance.
3144SETTINGS-FILE is the name of the file holding the settings to apply.
3145The new class name is the same as the directory in which SETTINGS-FILE
3146is found. Returns the new class name."
3147 (with-temp-buffer
3148 ;; We should probably store the modtime of SETTINGS-FILE and then
3149 ;; reload it whenever it changes.
3150 (insert-file-contents settings-file)
3151 (let* ((dir-name (file-name-directory settings-file))
3152 (class-name (intern dir-name))
3153 (list (read (current-buffer))))
3154 (define-project-bindings class-name list)
3155 (set-directory-project dir-name class-name)
3156 class-name)))
3157
361edc85
GM
3158(declare-function c-postprocess-file-styles "cc-mode" ())
3159
1b21ee06
MO
3160(defun hack-project-variables ()
3161 "Set local variables in a buffer based on project settings."
3162 (when (and (buffer-file-name) (not (file-remote-p (buffer-file-name))))
3163 ;; Find the settings file.
3164 (let ((settings (project-find-settings-file (buffer-file-name)))
3165 (class nil)
3166 (root-dir nil))
3167 (cond
3168 ((stringp settings)
3169 (setq root-dir (file-name-directory (buffer-file-name)))
3170 (setq class (project-define-from-project-file settings)))
3171 ((consp settings)
3172 (setq root-dir (car settings))
3173 (setq class (cdr settings))))
3174 (when class
3175 (let ((bindings
3176 (project-collect-binding-list (project-get-alist class)
3177 root-dir nil)))
3178 (when bindings
3179 (hack-local-variables-apply bindings root-dir)
3180 ;; Special case C and derived modes. Note that CC-based
3181 ;; modes don't work with derived-mode-p. In general I
3182 ;; think modes could use an auxiliary method which is
3183 ;; called after local variables are hacked.
3184 (and (boundp 'c-buffer-is-cc-mode)
3185 c-buffer-is-cc-mode
3186 (c-postprocess-file-styles))))))))
f3e23606 3187
b4da00e9 3188\f
21540597 3189(defcustom change-major-mode-with-file-name t
ba83982b 3190 "Non-nil means \\[write-file] should set the major mode from the file name.
9de9b6a2
RS
3191However, the mode will not be changed if
3192\(1) a local variables list or the `-*-' line specifies a major mode, or
3193\(2) the current major mode is a \"special\" mode,
96e777e1 3194\ not suitable for ordinary files, or
21540597
RS
3195\(3) the new file name does not particularly specify any mode."
3196 :type 'boolean
3197 :group 'editing-basics)
9de9b6a2 3198
f36012a6 3199(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9 3200 "Change name of file visited in current buffer to FILENAME.
1af57101 3201This also renames the buffer to correspond to the new file.
b4da00e9 3202The next time the buffer is saved it will go in the newly specified file.
1af57101 3203FILENAME nil or an empty string means mark buffer as not visiting any file.
b4da00e9 3204Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
3205if you wish to pass an empty string as the argument.
3206
3207The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
3208confirmation in the case where another buffer is already visiting FILENAME.
3209
3210The optional third argument ALONG-WITH-FILE, if non-nil, means that
3211the old visited file has been renamed to the new name FILENAME."
b4da00e9 3212 (interactive "FSet visited file name: ")
c11a94fe
RS
3213 (if (buffer-base-buffer)
3214 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
3215 (let (truename)
3216 (if filename
3217 (setq filename
3218 (if (string-equal filename "")
3219 nil
3220 (expand-file-name filename))))
3221 (if filename
3222 (progn
3223 (setq truename (file-truename filename))
3224 (if find-file-visit-truename
a522e5bf 3225 (setq filename truename))))
cbca0a4b 3226 (if filename
e6d0b67a 3227 (let ((new-name (file-name-nondirectory filename)))
cbca0a4b
RS
3228 (if (string= new-name "")
3229 (error "Empty file name"))))
11e314fa 3230 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 3231 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 3232 (not no-query)
674b7bae
JB
3233 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3234 filename)))
7b89d38e 3235 (error "Aborted")))
a522e5bf
RS
3236 (or (equal filename buffer-file-name)
3237 (progn
3238 (and filename (lock-buffer filename))
3239 (unlock-buffer)))
3240 (setq buffer-file-name filename)
3241 (if filename ; make buffer name reflect filename.
3242 (let ((new-name (file-name-nondirectory buffer-file-name)))
a522e5bf
RS
3243 (if (eq system-type 'vax-vms)
3244 (setq new-name (downcase new-name)))
3245 (setq default-directory (file-name-directory buffer-file-name))
67b6fd1c
SM
3246 ;; If new-name == old-name, renaming would add a spurious <2>
3247 ;; and it's considered as a feature in rename-buffer.
a522e5bf
RS
3248 (or (string= new-name (buffer-name))
3249 (rename-buffer new-name t))))
3250 (setq buffer-backed-up nil)
f36012a6
RS
3251 (or along-with-file
3252 (clear-visited-file-modtime))
8ccdc29e 3253 ;; Abbreviate the file names of the buffer.
4826e97f 3254 (if truename
8ccdc29e
RS
3255 (progn
3256 (setq buffer-file-truename (abbreviate-file-name truename))
3257 (if find-file-visit-truename
b1f1ceb8 3258 (setq buffer-file-name truename))))
a522e5bf
RS
3259 (setq buffer-file-number
3260 (if filename
2a47b4f5 3261 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 3262 nil)))
0370fe77 3263 ;; write-file-functions is normally used for things like ftp-find-file
b4da00e9
RM
3264 ;; that visit things that are not local files as if they were files.
3265 ;; Changing to visit an ordinary local file instead should flush the hook.
0370fe77 3266 (kill-local-variable 'write-file-functions)
c9dca4e0 3267 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
3268 (kill-local-variable 'revert-buffer-function)
3269 (kill-local-variable 'backup-inhibited)
ee81c959
RS
3270 ;; If buffer was read-only because of version control,
3271 ;; that reason is gone now, so make it writable.
3272 (if vc-mode
3273 (setq buffer-read-only nil))
3274 (kill-local-variable 'vc-mode)
b4da00e9
RM
3275 ;; Turn off backup files for certain file names.
3276 ;; Since this is a permanent local, the major mode won't eliminate it.
4d49551a 3277 (and buffer-file-name
b98a8e06 3278 backup-enable-predicate
4d49551a 3279 (not (funcall backup-enable-predicate buffer-file-name))
b4da00e9
RM
3280 (progn
3281 (make-local-variable 'backup-inhibited)
3282 (setq backup-inhibited t)))
c77a81cf
RS
3283 (let ((oauto buffer-auto-save-file-name))
3284 ;; If auto-save was not already on, turn it on if appropriate.
3285 (if (not buffer-auto-save-file-name)
3286 (and buffer-file-name auto-save-default
3287 (auto-save-mode t))
3288 ;; If auto save is on, start using a new name.
3289 ;; We deliberately don't rename or delete the old auto save
3290 ;; for the old visited file name. This is because perhaps
3291 ;; the user wants to save the new state and then compare with the
3292 ;; previous state from the auto save file.
3293 (setq buffer-auto-save-file-name
3294 (make-auto-save-file-name)))
3295 ;; Rename the old auto save file if any.
3296 (and oauto buffer-auto-save-file-name
e6f0e76c 3297 (file-exists-p oauto)
c77a81cf 3298 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
3299 (and buffer-file-name
3300 (not along-with-file)
9de9b6a2
RS
3301 (set-buffer-modified-p t))
3302 ;; Update the major mode, if the file name determines it.
3303 (condition-case nil
3304 ;; Don't change the mode if it is special.
3305 (or (not change-major-mode-with-file-name)
3306 (get major-mode 'mode-class)
3307 ;; Don't change the mode if the local variable list specifies it.
3308 (hack-local-variables t)
3309 (set-auto-mode t))
3310 (error nil)))
b4da00e9 3311
912192d1 3312(defun write-file (filename &optional confirm)
b4da00e9 3313 "Write current buffer into file FILENAME.
7f99999a 3314This makes the buffer visit that file, and marks it as not modified.
7458cc35 3315
7f99999a
KH
3316If you specify just a directory name as FILENAME, that means to use
3317the default file name but in that directory. You can also yank
074eb6ac 3318the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
7f99999a
KH
3319
3320If the buffer is not already visiting a file, the default file name
3321for the output file is the buffer name.
3322
3323If optional second arg CONFIRM is non-nil, this function
3324asks for confirmation before overwriting an existing file.
912192d1 3325Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
3326;; (interactive "FWrite file: ")
3327 (interactive
3328 (list (if buffer-file-name
3329 (read-file-name "Write file: "
f3684505 3330 nil nil nil nil)
7f99999a
KH
3331 (read-file-name "Write file: " default-directory
3332 (expand-file-name
3333 (file-name-nondirectory (buffer-name))
3334 default-directory)
3335 nil nil))
912192d1 3336 (not current-prefix-arg)))
b4da00e9 3337 (or (null filename) (string-equal filename "")
41f48cb1
RS
3338 (progn
3339 ;; If arg is just a directory,
7f99999a
KH
3340 ;; use the default file name, but in that directory.
3341 (if (file-directory-p filename)
41f48cb1 3342 (setq filename (concat (file-name-as-directory filename)
7f99999a
KH
3343 (file-name-nondirectory
3344 (or buffer-file-name (buffer-name))))))
c2fb8488
RS
3345 (and confirm
3346 (file-exists-p filename)
3347 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3348 (error "Canceled")))
5f65549e 3349 (set-visited-file-name filename (not confirm))))
b4da00e9 3350 (set-buffer-modified-p t)
6492b55d
KH
3351 ;; Make buffer writable if file is writable.
3352 (and buffer-file-name
3353 (file-writable-p buffer-file-name)
3354 (setq buffer-read-only nil))
8e5c7b90
SM
3355 (save-buffer)
3356 ;; It's likely that the VC status at the new location is different from
3357 ;; the one at the old location.
3358 (vc-find-file-hook))
b4da00e9
RM
3359\f
3360(defun backup-buffer ()
3361 "Make a backup of the disk file visited by the current buffer, if appropriate.
3362This is normally done before saving the buffer the first time.
27ab6944
KH
3363
3364A backup may be done by renaming or by copying; see documentation of
3365variable `make-backup-files'. If it's done by renaming, then the file is
f3f9e207
RS
3366no longer accessible under its old name.
3367
3368The value is non-nil after a backup was made by renaming.
3369It has the form (MODES . BACKUPNAME).
3370MODES is the result of `file-modes' on the original
3371file; this means that the caller, after saving the buffer, should change
3372the modes of the new file to agree with the old modes.
3373BACKUPNAME is the backup file name, which is the old file renamed."
b4da00e9
RM
3374 (if (and make-backup-files (not backup-inhibited)
3375 (not buffer-backed-up)
3376 (file-exists-p buffer-file-name)
3377 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3378 '(?- ?l)))
3379 (let ((real-file-name buffer-file-name)
3380 backup-info backupname targets setmodes)
3381 ;; If specified name is a symbolic link, chase it to the target.
3382 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 3383 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
3384 (setq backup-info (find-backup-file-name real-file-name)
3385 backupname (car backup-info)
3386 targets (cdr backup-info))
5c6d31a4
SM
3387 ;; (if (file-directory-p buffer-file-name)
3388 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
3389 (if backup-info
3390 (condition-case ()
3391 (let ((delete-old-versions
3392 ;; If have old versions to maybe delete,
3393 ;; ask the user to confirm now, before doing anything.
3394 ;; But don't actually delete til later.
3395 (and targets
3396 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3397 (or delete-old-versions
3398 (y-or-n-p (format "Delete excess backup versions of %s? "
446c63b0
RS
3399 real-file-name)))))
3400 (modes (file-modes buffer-file-name)))
eb650569
RS
3401 ;; Actually write the back up file.
3402 (condition-case ()
3403 (if (or file-precious-flag
ffc0e1ca 3404 ; (file-symlink-p buffer-file-name)
eb650569 3405 backup-by-copying
446c63b0 3406 ;; Don't rename a suid or sgid file.
7da6bf00 3407 (and modes (< 0 (logand modes #o6000)))
79d2d279 3408 (not (file-writable-p (file-name-directory real-file-name)))
eb650569
RS
3409 (and backup-by-copying-when-linked
3410 (> (file-nlinks real-file-name) 1))
ffc0e1ca
AS
3411 (and (or backup-by-copying-when-mismatch
3412 (integerp backup-by-copying-when-privileged-mismatch))
eb650569 3413 (let ((attr (file-attributes real-file-name)))
ffc0e1ca
AS
3414 (and (or backup-by-copying-when-mismatch
3415 (and (integerp (nth 2 attr))
3416 (integerp backup-by-copying-when-privileged-mismatch)
3417 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3418 (or (nth 9 attr)
3419 (not (file-ownership-preserved-p real-file-name)))))))
446c63b0 3420 (backup-buffer-copy real-file-name backupname modes)
eb650569
RS
3421 ;; rename-file should delete old backup.
3422 (rename-file real-file-name backupname t)
446c63b0 3423 (setq setmodes (cons modes backupname)))
eb650569
RS
3424 (file-error
3425 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
3426 (setq backupname (expand-file-name
3427 (convert-standard-filename
3428 "~/%backup%~")))
3429 (message "Cannot write backup file; backing up in %s"
6ba7756e 3430 backupname)
eb650569 3431 (sleep-for 1)
446c63b0 3432 (backup-buffer-copy real-file-name backupname modes)))
eb650569
RS
3433 (setq buffer-backed-up t)
3434 ;; Now delete the old versions, if desired.
3435 (if delete-old-versions
3436 (while targets
3437 (condition-case ()
3438 (delete-file (car targets))
3439 (file-error nil))
3440 (setq targets (cdr targets))))
3441 setmodes)
3442 (file-error nil))))))
b4da00e9 3443
446c63b0 3444(defun backup-buffer-copy (from-name to-name modes)
44dce0fb
RS
3445 (let ((umask (default-file-modes)))
3446 (unwind-protect
3447 (progn
3448 ;; Create temp files with strict access rights. It's easy to
3449 ;; loosen them later, whereas it's impossible to close the
3450 ;; time-window of loose permissions otherwise.
3451 (set-default-file-modes ?\700)
0f39d2c9
MR
3452 (when (condition-case nil
3453 ;; Try to overwrite old backup first.
5b2e628f 3454 (copy-file from-name to-name t t t)
0f39d2c9
MR
3455 (error t))
3456 (while (condition-case nil
3457 (progn
3458 (when (file-exists-p to-name)
3459 (delete-file to-name))
5b2e628f 3460 (copy-file from-name to-name nil t t)
0f39d2c9
MR
3461 nil)
3462 (file-already-exists t))
3463 ;; The file was somehow created by someone else between
3464 ;; `delete-file' and `copy-file', so let's try again.
3465 ;; rms says "I think there is also a possible race
3466 ;; condition for making backup files" (emacs-devel 20070821).
3467 nil)))
44dce0fb
RS
3468 ;; Reset the umask.
3469 (set-default-file-modes umask)))
147fbf70
RS
3470 (and modes
3471 (set-file-modes to-name (logand modes #o1777))))
446c63b0 3472
c3554e95 3473(defun file-name-sans-versions (name &optional keep-backup-version)
ffc0e1ca 3474 "Return file NAME sans backup versions or strings.
b4da00e9 3475This is a separate procedure so your site-init or startup file can
c3554e95
RS
3476redefine it.
3477If the optional argument KEEP-BACKUP-VERSION is non-nil,
3478we do not remove backup version numbers, only true file version numbers."
6eaebaa2 3479 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
3480 (if handler
3481 (funcall handler 'file-name-sans-versions name keep-backup-version)
3482 (substring name 0
3483 (if (eq system-type 'vax-vms)
3484 ;; VMS version number is (a) semicolon, optional
3485 ;; sign, zero or more digits or (b) period, option
3486 ;; sign, zero or more digits, provided this is the
3487 ;; second period encountered outside of the
3488 ;; device/directory part of the file name.
26add1bf
KH
3489 (or (string-match ";[-+]?[0-9]*\\'" name)
3490 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
3491 name)
3492 (match-beginning 1))
3493 (length name))
3494 (if keep-backup-version
3495 (length name)
9a3d2737 3496 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
c3554e95
RS
3497 (string-match "~\\'" name)
3498 (length name))))))))
b4da00e9 3499
cb0cd911 3500(defun file-ownership-preserved-p (file)
ffc0e1ca 3501 "Return t if deleting FILE and rewriting it would preserve the owner."
cb0cd911
RS
3502 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3503 (if handler
3504 (funcall handler 'file-ownership-preserved-p file)
ec5533be 3505 (let ((attributes (file-attributes file)))
306faa42
RS
3506 ;; Return t if the file doesn't exist, since it's true that no
3507 ;; information would be lost by an (attempted) delete and create.
3508 (or (null attributes)
3509 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 3510
20b5d24c
RS
3511(defun file-name-sans-extension (filename)
3512 "Return FILENAME sans final \"extension\".
2531b0c3
EZ
3513The extension, in a file name, is the part that follows the last `.',
3514except that a leading `.', if any, doesn't count."
20b5d24c
RS
3515 (save-match-data
3516 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3517 directory)
2531b0c3
EZ
3518 (if (and (string-match "\\.[^.]*\\'" file)
3519 (not (eq 0 (match-beginning 0))))
20b5d24c 3520 (if (setq directory (file-name-directory filename))
6ee24f1e
RS
3521 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3522 ;; we don't want to expand it.
3523 (concat directory (substring file 0 (match-beginning 0)))
20b5d24c
RS
3524 (substring file 0 (match-beginning 0)))
3525 filename))))
3526
93a2702d
RS
3527(defun file-name-extension (filename &optional period)
3528 "Return FILENAME's final \"extension\".
2531b0c3 3529The extension, in a file name, is the part that follows the last `.',
32483280 3530excluding version numbers and backup suffixes,
2531b0c3 3531except that a leading `.', if any, doesn't count.
93a2702d
RS
3532Return nil for extensionless file names such as `foo'.
3533Return the empty string for file names such as `foo.'.
3534
3535If PERIOD is non-nil, then the returned value includes the period
3536that delimits the extension, and if FILENAME has no extension,
3537the value is \"\"."
3538 (save-match-data
3539 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2531b0c3
EZ
3540 (if (and (string-match "\\.[^.]*\\'" file)
3541 (not (eq 0 (match-beginning 0))))
93a2702d
RS
3542 (substring file (+ (match-beginning 0) (if period 0 1)))
3543 (if period
3544 "")))))
3545
ffc0e1ca
AS
3546(defcustom make-backup-file-name-function nil
3547 "A function to use instead of the default `make-backup-file-name'.
643c985d 3548A value of nil gives the default `make-backup-file-name' behavior.
ffc0e1ca 3549
d5798fa7 3550This could be buffer-local to do something special for specific
ffc0e1ca
AS
3551files. If you define it, you may need to change `backup-file-name-p'
3552and `file-name-sans-versions' too.
3553
3554See also `backup-directory-alist'."
3555 :group 'backup
3556 :type '(choice (const :tag "Default" nil)
3557 (function :tag "Your function")))
3558
3559(defcustom backup-directory-alist nil
3560 "Alist of filename patterns and backup directory names.
3561Each element looks like (REGEXP . DIRECTORY). Backups of files with
3562names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3563relative or absolute. If it is absolute, so that all matching files
3564are backed up into the same directory, the file names in this
3565directory will be the full name of the file backed up with all
3566directory separators changed to `!' to prevent clashes. This will not
3567work correctly if your filesystem truncates the resulting name.
3568
3569For the common case of all backups going into one directory, the alist
3570should contain a single element pairing \".\" with the appropriate
3571directory name.
3572
3573If this variable is nil, or it fails to match a filename, the backup
3574is made in the original file's directory.
3575
3576On MS-DOS filesystems without long names this variable is always
3577ignored."
3578 :group 'backup
dca5e71d 3579 :type '(repeat (cons (regexp :tag "Regexp matching filename")
ffc0e1ca
AS
3580 (directory :tag "Backup directory name"))))
3581
388d6ab5
RS
3582(defun normal-backup-enable-predicate (name)
3583 "Default `backup-enable-predicate' function.
0c2f6dda
RS
3584Checks for files in `temporary-file-directory',
3585`small-temporary-file-directory', and /tmp."
388d6ab5
RS
3586 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3587 name 0 nil)))
3588 ;; Directory is under temporary-file-directory.
3589 (and (not (eq comp t))
3590 (< comp (- (length temporary-file-directory)))))
0c2f6dda
RS
3591 (let ((comp (compare-strings "/tmp" 0 nil
3592 name 0 nil)))
3593 ;; Directory is under /tmp.
3594 (and (not (eq comp t))
3595 (< comp (- (length "/tmp")))))
388d6ab5
RS
3596 (if small-temporary-file-directory
3597 (let ((comp (compare-strings small-temporary-file-directory
3598 0 nil
3599 name 0 nil)))
3600 ;; Directory is under small-temporary-file-directory.
3601 (and (not (eq comp t))
3602 (< comp (- (length small-temporary-file-directory)))))))))
3603
b4da00e9
RM
3604(defun make-backup-file-name (file)
3605 "Create the non-numeric backup file name for FILE.
ffc0e1ca
AS
3606Normally this will just be the file's name with `~' appended.
3607Customization hooks are provided as follows.
3608
3609If the variable `make-backup-file-name-function' is non-nil, its value
3610should be a function which will be called with FILE as its argument;
3611the resulting name is used.
3612
3613Otherwise a match for FILE is sought in `backup-directory-alist'; see
3614the documentation of that variable. If the directory for the backup
3615doesn't exist, it is created."
3616 (if make-backup-file-name-function
3617 (funcall make-backup-file-name-function file)
3618 (if (and (eq system-type 'ms-dos)
3619 (not (msdos-long-file-names)))
3620 (let ((fn (file-name-nondirectory file)))
3621 (concat (file-name-directory file)
3622 (or (and (string-match "\\`[^.]+\\'" fn)
3623 (concat (match-string 0 fn) ".~"))
3624 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3625 (concat (match-string 0 fn) "~")))))
3626 (concat (make-backup-file-name-1 file) "~"))))
3627
3628(defun make-backup-file-name-1 (file)
3629 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3630 (let ((alist backup-directory-alist)
6ba7756e 3631 elt backup-directory abs-backup-directory)
ffc0e1ca
AS
3632 (while alist
3633 (setq elt (pop alist))
3634 (if (string-match (car elt) file)
3635 (setq backup-directory (cdr elt)
3636 alist nil)))
eb0455ab
RS
3637 ;; If backup-directory is relative, it should be relative to the
3638 ;; file's directory. By expanding explicitly here, we avoid
3639 ;; depending on default-directory.
3640 (if backup-directory
6ba7756e
RS
3641 (setq abs-backup-directory
3642 (expand-file-name backup-directory
3643 (file-name-directory file))))
3644 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
ffc0e1ca 3645 (condition-case nil
6ba7756e
RS
3646 (make-directory abs-backup-directory 'parents)
3647 (file-error (setq backup-directory nil
3648 abs-backup-directory nil))))
ee291b46
RS
3649 (if (null backup-directory)
3650 file
ffc0e1ca
AS
3651 (if (file-name-absolute-p backup-directory)
3652 (progn
c60ee5e7 3653 (when (memq system-type '(windows-nt ms-dos cygwin))
d7b6ca4a
RS
3654 ;; Normalize DOSish file names: downcase the drive
3655 ;; letter, if any, and replace the leading "x:" with
3656 ;; "/drive_x".
ffc0e1ca
AS
3657 (or (file-name-absolute-p file)
3658 (setq file (expand-file-name file))) ; make defaults explicit
3659 ;; Replace any invalid file-name characters (for the
3660 ;; case of backing up remote files).
446c097e 3661 (setq file (expand-file-name (convert-standard-filename file)))
ffc0e1ca 3662 (if (eq (aref file 1) ?:)
d7b6ca4a 3663 (setq file (concat "/"
ffc0e1ca
AS
3664 "drive_"
3665 (char-to-string (downcase (aref file 0)))
d7b6ca4a 3666 (if (eq (aref file 2) ?/)
ffc0e1ca 3667 ""
d7b6ca4a 3668 "/")
ffc0e1ca
AS
3669 (substring file 2)))))
3670 ;; Make the name unique by substituting directory
3671 ;; separators. It may not really be worth bothering about
3672 ;; doubling `!'s in the original name...
3673 (expand-file-name
3674 (subst-char-in-string
d7b6ca4a 3675 ?/ ?!
ffc0e1ca
AS
3676 (replace-regexp-in-string "!" "!!" file))
3677 backup-directory))
3678 (expand-file-name (file-name-nondirectory file)
6ba7756e 3679 (file-name-as-directory abs-backup-directory))))))
b4da00e9
RM
3680
3681(defun backup-file-name-p (file)
3682 "Return non-nil if FILE is a backup file name (numeric or not).
3683This is a separate function so you can redefine it for customization.
3684You may need to redefine `file-name-sans-versions' as well."
066327ae 3685 (string-match "~\\'" file))
b4da00e9 3686
e2b30772
RS
3687(defvar backup-extract-version-start)
3688
2d051399 3689;; This is used in various files.
a7aa942a
KH
3690;; The usage of backup-extract-version-start is not very clean,
3691;; but I can't see a good alternative, so as of now I am leaving it alone.
2d051399 3692(defun backup-extract-version (fn)
ffc0e1ca 3693 "Given the name of a numeric backup file, FN, return the backup number.
e2b30772 3694Uses the free variable `backup-extract-version-start', whose value should be
2d051399 3695the index in the name where the version number begins."
e2b30772
RS
3696 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
3697 (= (match-beginning 0) backup-extract-version-start))
027a4b6b 3698 (string-to-number (substring fn backup-extract-version-start -1))
2d051399
RS
3699 0))
3700
b4da00e9
RM
3701;; I believe there is no need to alter this behavior for VMS;
3702;; since backup files are not made on VMS, it should not get called.
3703(defun find-backup-file-name (fn)
ffc0e1ca 3704 "Find a file name for a backup file FN, and suggestions for deletions.
b4da00e9 3705Value is a list whose car is the name for the backup file
ffc0e1ca
AS
3706and whose cdr is a list of old versions to consider deleting now.
3707If the value is nil, don't make a backup.
3708Uses `backup-directory-alist' in the same way as does
3709`make-backup-file-name'."
eb650569
RS
3710 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3711 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3712 (if handler
3713 (funcall handler 'find-backup-file-name fn)
f26d858e
EZ
3714 (if (or (eq version-control 'never)
3715 ;; We don't support numbered backups on plain MS-DOS
3716 ;; when long file names are unavailable.
3717 (and (eq system-type 'ms-dos)
3718 (not (msdos-long-file-names))))
b4da00e9 3719 (list (make-backup-file-name fn))
ffc0e1ca
AS
3720 (let* ((basic-name (make-backup-file-name-1 fn))
3721 (base-versions (concat (file-name-nondirectory basic-name)
3722 ".~"))
e2b30772 3723 (backup-extract-version-start (length base-versions))
eb650569 3724 (high-water-mark 0)
ffc0e1ca
AS
3725 (number-to-delete 0)
3726 possibilities deserve-versions-p versions)
eb650569
RS
3727 (condition-case ()
3728 (setq possibilities (file-name-all-completions
3729 base-versions
ffc0e1ca
AS
3730 (file-name-directory basic-name))
3731 versions (sort (mapcar #'backup-extract-version
3732 possibilities)
3733 #'<)
eb650569
RS
3734 high-water-mark (apply 'max 0 versions)
3735 deserve-versions-p (or version-control
3736 (> high-water-mark 0))
3737 number-to-delete (- (length versions)
ffc0e1ca
AS
3738 kept-old-versions
3739 kept-new-versions
3740 -1))
3741 (file-error (setq possibilities nil)))
eb650569 3742 (if (not deserve-versions-p)
8767d866 3743 (list (make-backup-file-name fn))
ffc0e1ca 3744 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
eb650569
RS
3745 (if (and (> number-to-delete 0)
3746 ;; Delete nothing if there is overflow
3747 ;; in the number of versions to keep.
3748 (>= (+ kept-new-versions kept-old-versions -1) 0))
ffc0e1ca
AS
3749 (mapcar (lambda (n)
3750 (format "%s.~%d~" basic-name n))
eb650569
RS
3751 (let ((v (nthcdr kept-old-versions versions)))
3752 (rplacd (nthcdr (1- number-to-delete) v) ())
3753 v))))))))))
b4da00e9 3754
b4da00e9
RM
3755(defun file-nlinks (filename)
3756 "Return number of names file FILENAME has."
3757 (car (cdr (file-attributes filename))))
6c636af9 3758
753ad988
KG
3759;; (defun file-relative-name (filename &optional directory)
3760;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3761;; This function returns a relative file name which is equivalent to FILENAME
3762;; when used with that default directory as the default.
3763;; If this is impossible (which can happen on MSDOS and Windows
3764;; when the file name and directory use different drive names)
3765;; then it returns FILENAME."
3766;; (save-match-data
3767;; (let ((fname (expand-file-name filename)))
3768;; (setq directory (file-name-as-directory
3769;; (expand-file-name (or directory default-directory))))
3770;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3771;; ;; drive names, they can't be relative, so return the absolute name.
3772;; (if (and (or (eq system-type 'ms-dos)
3773;; (eq system-type 'cygwin)
3774;; (eq system-type 'windows-nt))
3775;; (not (string-equal (substring fname 0 2)
3776;; (substring directory 0 2))))
3777;; filename
3778;; (let ((ancestor ".")
3779;; (fname-dir (file-name-as-directory fname)))
3780;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3781;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3782;; (setq directory (file-name-directory (substring directory 0 -1))
3783;; ancestor (if (equal ancestor ".")
3784;; ".."
3785;; (concat "../" ancestor))))
3786;; ;; Now ancestor is empty, or .., or ../.., etc.
3787;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3788;; ;; We matched within FNAME's directory part.
3789;; ;; Add the rest of FNAME onto ANCESTOR.
3790;; (let ((rest (substring fname (match-end 0))))
3791;; (if (and (equal ancestor ".")
3792;; (not (equal rest "")))
3793;; ;; But don't bother with ANCESTOR if it would give us `./'.
3794;; rest
3795;; (concat (file-name-as-directory ancestor) rest)))
3796;; ;; We matched FNAME's directory equivalent.
3797;; ancestor))))))
3798
6c636af9 3799(defun file-relative-name (filename &optional directory)
ffc0e1ca 3800 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2d6562a5
RS
3801This function returns a relative file name which is equivalent to FILENAME
3802when used with that default directory as the default.
753ad988 3803If FILENAME and DIRECTORY lie on different machines or on different drives
1be0210d 3804on a DOS/Windows machine, it returns FILENAME in expanded form."
96c188b0 3805 (save-match-data
753ad988
KG
3806 (setq directory
3807 (file-name-as-directory (expand-file-name (or directory
3808 default-directory))))
3809 (setq filename (expand-file-name filename))
3f788773
KG
3810 (let ((fremote (file-remote-p filename))
3811 (dremote (file-remote-p directory)))
493c98af
KG
3812 (if ;; Conditions for separate trees
3813 (or
3814 ;; Test for different drives on DOS/Windows
3815 (and
7c64272b 3816 ;; Should `cygwin' really be included here? --stef
493c98af 3817 (memq system-type '(ms-dos cygwin windows-nt))
7c64272b 3818 (not (eq t (compare-strings filename 0 2 directory 0 2))))
493c98af 3819 ;; Test for different remote file system identification
3f788773 3820 (not (equal fremote dremote)))
e2b30772 3821 filename
753ad988
KG
3822 (let ((ancestor ".")
3823 (filename-dir (file-name-as-directory filename)))
7c64272b
SM
3824 (while (not
3825 (or
3826 (eq t (compare-strings filename-dir nil (length directory)
3827 directory nil nil case-fold-search))
3828 (eq t (compare-strings filename nil (length directory)
3829 directory nil nil case-fold-search))))
753ad988 3830 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
3831 ancestor (if (equal ancestor ".")
3832 ".."
3833 (concat "../" ancestor))))
753ad988 3834 ;; Now ancestor is empty, or .., or ../.., etc.
7c64272b
SM
3835 (if (eq t (compare-strings filename nil (length directory)
3836 directory nil nil case-fold-search))
753ad988
KG
3837 ;; We matched within FILENAME's directory part.
3838 ;; Add the rest of FILENAME onto ANCESTOR.
3f7d6528 3839 (let ((rest (substring filename (length directory))))
753ad988 3840 (if (and (equal ancestor ".") (not (equal rest "")))
9695aac6
RS
3841 ;; But don't bother with ANCESTOR if it would give us `./'.
3842 rest
3843 (concat (file-name-as-directory ancestor) rest)))
753ad988
KG
3844 ;; We matched FILENAME's directory equivalent.
3845 ancestor))))))
b4da00e9
RM
3846\f
3847(defun save-buffer (&optional args)
e8f4db18
RS
3848 "Save current buffer in visited file if modified.
3849Variations are described below.
3850
b4da00e9
RM
3851By default, makes the previous version into a backup file
3852 if previously requested or if this is the first save.
dc2ab26e 3853Prefixed with one \\[universal-argument], marks this version
b4da00e9 3854 to become a backup when the next save is done.
dc2ab26e 3855Prefixed with two \\[universal-argument]'s,
b4da00e9 3856 unconditionally makes the previous version into a backup file.
dc2ab26e 3857Prefixed with three \\[universal-argument]'s, marks this version
ac9650be
RS
3858 to become a backup when the next save is done,
3859 and unconditionally makes the previous version into a backup file.
3860
dc2ab26e
EZ
3861With a numeric argument of 0, never make the previous version
3862into a backup file.
b4da00e9
RM
3863
3864If a file's name is FOO, the names of its numbered backup versions are
3865 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3866Numeric backups (rather than FOO~) will be made if value of
3867 `version-control' is not the atom `never' and either there are already
3868 numeric versions of the file being backed up, or `version-control' is
3869 non-nil.
3870We don't want excessive versions piling up, so there are variables
3871 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3872 and `kept-new-versions', which tells how many newest versions to keep.
3873 Defaults are 2 old versions and 2 new.
3874`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 3875If `delete-old-versions' is nil, system will query user
e73ec04b
RS
3876 before trimming versions. Otherwise it does it silently.
3877
749d2ee6
RS
3878If `vc-make-backup-files' is nil, which is the default,
3879 no backup files are made for files managed by version control.
3880 (This is because the version control system itself records previous versions.)
3881
e73ec04b 3882See the subroutine `basic-save-buffer' for more information."
b4da00e9
RM
3883 (interactive "p")
3884 (let ((modp (buffer-modified-p))
3885 (large (> (buffer-size) 50000))
b5a8e0fc
RS
3886 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3887 (memq args '(16 64)))))
b4da00e9 3888 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
b4990dde
GM
3889 (if (and modp large (buffer-file-name))
3890 (message "Saving file %s..." (buffer-file-name)))
b4da00e9
RM
3891 (basic-save-buffer)
3892 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3893
3894(defun delete-auto-save-file-if-necessary (&optional force)
3895 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3896Normally delete only if the file was written by this Emacs since
3897the last real save, but optional arg FORCE non-nil means delete anyway."
3898 (and buffer-auto-save-file-name delete-auto-save-files
3899 (not (string= buffer-file-name buffer-auto-save-file-name))
3900 (or force (recent-auto-save-p))
3901 (progn
3902 (condition-case ()
3903 (delete-file buffer-auto-save-file-name)
3904 (file-error nil))
3905 (set-buffer-auto-saved))))
3906
481f215b
KH
3907(defvar auto-save-hook nil
3908 "Normal hook run just before auto-saving.")
3909
3c3b81d1
SJ
3910(defcustom before-save-hook nil
3911 "Normal hook that is run before a buffer is saved to its file."
25f6295e 3912 :options '(copyright-update time-stamp)
3c3b81d1
SJ
3913 :type 'hook
3914 :group 'files)
3915
ffc0e1ca
AS
3916(defcustom after-save-hook nil
3917 "Normal hook that is run after a buffer is saved to its file."
3918 :options '(executable-make-buffer-file-executable-if-script-p)
3919 :type 'hook
3920 :group 'files)
1cc852cc 3921
0516edee
RS
3922(defvar save-buffer-coding-system nil
3923 "If non-nil, use this coding system for saving the buffer.
3924More precisely, use this coding system in place of the
3925value of `buffer-file-coding-system', when saving the buffer.
3926Calling `write-region' for any purpose other than saving the buffer
3927will still use `buffer-file-coding-system'; this variable has no effect
3928in such cases.")
3929
d5fe94cc
RS
3930(make-variable-buffer-local 'save-buffer-coding-system)
3931(put 'save-buffer-coding-system 'permanent-local t)
3932
b4da00e9 3933(defun basic-save-buffer ()
1cc852cc 3934 "Save the current buffer in its visited file, if it has been modified.
0370fe77
SM
3935The hooks `write-contents-functions' and `write-file-functions' get a chance
3936to do the job of saving; if they do not, then the buffer is saved in
222cf381 3937the visited file in the usual way.
3c3b81d1
SJ
3938Before and after saving the buffer, this function runs
3939`before-save-hook' and `after-save-hook', respectively."
b4da00e9 3940 (interactive)
19618231 3941 (save-current-buffer
c11a94fe
RS
3942 ;; In an indirect buffer, save its base buffer instead.
3943 (if (buffer-base-buffer)
3944 (set-buffer (buffer-base-buffer)))
3945 (if (buffer-modified-p)
3946 (let ((recent-save (recent-auto-save-p))
818286f4 3947 setmodes)
c11a94fe
RS
3948 ;; On VMS, rename file and buffer to get rid of version number.
3949 (if (and (eq system-type 'vax-vms)
3950 (not (string= buffer-file-name
3951 (file-name-sans-versions buffer-file-name))))
3952 (let (buffer-new-name)
3953 ;; Strip VMS version number before save.
3954 (setq buffer-file-name
3955 (file-name-sans-versions buffer-file-name))
3956 ;; Construct a (unique) buffer name to correspond.
3957 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3958 (setq buffer-new-name (buffer-name buf))
3959 (kill-buffer buf))
3960 (rename-buffer buffer-new-name)))
3961 ;; If buffer has no file name, ask user for one.
3962 (or buffer-file-name
182891ef
RS
3963 (let ((filename
3964 (expand-file-name
3965 (read-file-name "File to save in: ") nil)))
8400146f
MR
3966 (if (file-exists-p filename)
3967 (if (file-directory-p filename)
3968 ;; Signal an error if the user specified the name of an
3969 ;; existing directory.
3970 (error "%s is a directory" filename)
3971 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
3972 filename))
3973 (error "Canceled")))
3974 ;; Signal an error if the specified name refers to a
3975 ;; non-existing directory.
3976 (let ((dir (file-name-directory filename)))
3977 (unless (file-directory-p dir)
3978 (if (file-exists-p dir)
3979 (error "%s is not a directory" dir)
3980 (error "%s: no such directory" dir)))))
182891ef 3981 (set-visited-file-name filename)))
c11a94fe
RS
3982 (or (verify-visited-file-modtime (current-buffer))
3983 (not (file-exists-p buffer-file-name))
3984 (yes-or-no-p
3985 (format "%s has changed since visited or saved. Save anyway? "
3986 (file-name-nondirectory buffer-file-name)))
3987 (error "Save not confirmed"))
3988 (save-restriction
3989 (widen)
19618231 3990 (save-excursion
0370fe77 3991 (and (> (point-max) (point-min))
407b4328 3992 (not find-file-literally)
19618231
RS
3993 (/= (char-after (1- (point-max))) ?\n)
3994 (not (and (eq selective-display t)
3995 (= (char-after (1- (point-max))) ?\r)))
3996 (or (eq require-final-newline t)
f4206092 3997 (eq require-final-newline 'visit-save)
19618231
RS
3998 (and require-final-newline
3999 (y-or-n-p
4000 (format "Buffer %s does not end in newline. Add one? "
4001 (buffer-name)))))
4002 (save-excursion
4003 (goto-char (point-max))
4004 (insert ?\n))))
fa5867f6
AS
4005 ;; Support VC version backups.
4006 (vc-before-save)
3c3b81d1 4007 (run-hooks 'before-save-hook)
0370fe77 4008 (or (run-hook-with-args-until-success 'write-contents-functions)
c11a94fe 4009 (run-hook-with-args-until-success 'local-write-file-hooks)
0370fe77 4010 (run-hook-with-args-until-success 'write-file-functions)
0ba5894b
RS
4011 ;; If a hook returned t, file is already "written".
4012 ;; Otherwise, write it the usual way now.
4013 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
4014 ;; Now we have saved the current buffer. Let's make sure
4015 ;; that buffer-file-coding-system is fixed to what
4016 ;; actually used for saving by binding it locally.
0516edee
RS
4017 (if save-buffer-coding-system
4018 (setq save-buffer-coding-system last-coding-system-used)
4019 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
4020 (setq buffer-file-number
4021 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
4022 (if setmodes
4023 (condition-case ()
f3f9e207 4024 (set-file-modes buffer-file-name (car setmodes))
c11a94fe
RS
4025 (error nil))))
4026 ;; If the auto-save file was recent before this command,
4027 ;; delete it now.
4028 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
4029 ;; Support VC `implicit' locking.
4030 (vc-after-save)
c11a94fe
RS
4031 (run-hooks 'after-save-hook))
4032 (message "(No changes need to be saved)"))))
b4da00e9 4033
87d26afc
RS
4034;; This does the "real job" of writing a buffer into its visited file
4035;; and making a backup file. This is what is normally done
0370fe77 4036;; but inhibited if one of write-file-functions returns non-nil.
f3f9e207 4037;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
87d26afc 4038(defun basic-save-buffer-1 ()
969be033
RS
4039 (prog1
4040 (if save-buffer-coding-system
4041 (let ((coding-system-for-write save-buffer-coding-system))
4042 (basic-save-buffer-2))
d5fe94cc 4043 (basic-save-buffer-2))
969be033 4044 (setq buffer-file-coding-system-explicit last-coding-system-used)))
d5fe94cc 4045
f3f9e207 4046;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
d5fe94cc
RS
4047(defun basic-save-buffer-2 ()
4048 (let (tempsetmodes setmodes)
87d26afc
RS
4049 (if (not (file-writable-p buffer-file-name))
4050 (let ((dir (file-name-directory buffer-file-name)))
4051 (if (not (file-directory-p dir))
83c6f446
RS
4052 (if (file-exists-p dir)
4053 (error "%s is not a directory" dir)
87c60260 4054 (error "%s: no such directory" dir))
87d26afc
RS
4055 (if (not (file-exists-p buffer-file-name))
4056 (error "Directory %s write-protected" dir)
4057 (if (yes-or-no-p
4058 (format "File %s is write-protected; try to save anyway? "
4059 (file-name-nondirectory
4060 buffer-file-name)))
4061 (setq tempsetmodes t)
4062 (error "Attempt to save to a file which you aren't allowed to write"))))))
4063 (or buffer-backed-up
4064 (setq setmodes (backup-buffer)))
76d5492b 4065 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
4066 (if (and file-precious-flag
4067 (file-writable-p dir))
4068 ;; If file is precious, write temp name, then rename it.
4069 ;; This requires write access to the containing dir,
4070 ;; which is why we don't try it if we don't have that access.
4071 (let ((realname buffer-file-name)
44dce0fb
RS
4072 tempname succeed
4073 (umask (default-file-modes))
6782610c 4074 (old-modtime (visited-file-modtime)))
44dce0fb
RS
4075 ;; Create temp files with strict access rights. It's easy to
4076 ;; loosen them later, whereas it's impossible to close the
4077 ;; time-window of loose permissions otherwise.
f4a0f59b 4078 (unwind-protect
44dce0fb
RS
4079 (progn
4080 (clear-visited-file-modtime)
4081 (set-default-file-modes ?\700)
4082 ;; Try various temporary names.
4083 ;; This code follows the example of make-temp-file,
4084 ;; but it calls write-region in the appropriate way
4085 ;; for saving the buffer.
4086 (while (condition-case ()
4087 (progn
4088 (setq tempname
4089 (make-temp-name
4090 (expand-file-name "tmp" dir)))
6b3d752c
SM
4091 ;; Pass in nil&nil rather than point-min&max
4092 ;; cause we're saving the whole buffer.
4093 ;; write-region-annotate-functions may use it.
4094 (write-region nil nil
44dce0fb
RS
4095 tempname nil realname
4096 buffer-file-truename 'excl)
4097 nil)
4098 (file-already-exists t))
4099 ;; The file was somehow created by someone else between
4100 ;; `make-temp-name' and `write-region', let's try again.
4101 nil)
4102 (setq succeed t))
4103 ;; Reset the umask.
4104 (set-default-file-modes umask)
4105 ;; If we failed, restore the buffer's modtime.
4106 (unless succeed
4107 (set-visited-file-modtime old-modtime)))
4108 ;; Since we have created an entirely new file,
4109 ;; make sure it gets the right permission bits set.
730df8db 4110 (setq setmodes (or setmodes
562ca538
RS
4111 (cons (or (file-modes buffer-file-name)
4112 (logand ?\666 umask))
730df8db 4113 buffer-file-name)))
f4a0f59b
RS
4114 ;; We succeeded in writing the temp file,
4115 ;; so rename it.
4116 (rename-file tempname buffer-file-name t))
4117 ;; If file not writable, see if we can make it writable
4118 ;; temporarily while we write it.
4119 ;; But no need to do so if we have just backed it up
4120 ;; (setmodes is set) because that says we're superseding.
4121 (cond ((and tempsetmodes (not setmodes))
4122 ;; Change the mode back, after writing.
f3f9e207
RS
4123 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
4124 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
4125 (let (success)
4126 (unwind-protect
4127 (progn
6b3d752c
SM
4128 ;; Pass in nil&nil rather than point-min&max to indicate
4129 ;; we're saving the buffer rather than just a region.
4130 ;; write-region-annotate-functions may make us of it.
4131 (write-region nil nil
f3f9e207
RS
4132 buffer-file-name nil t buffer-file-truename)
4133 (setq success t))
4134 ;; If we get an error writing the new file, and we made
4135 ;; the backup by renaming, undo the backing-up.
4136 (and setmodes (not success)
0133dab9
EZ
4137 (progn
4138 (rename-file (cdr setmodes) buffer-file-name t)
4139 (setq buffer-backed-up nil)))))))
87d26afc
RS
4140 setmodes))
4141
1eeae2a1
RS
4142(defun diff-buffer-with-file (&optional buffer)
4143 "View the differences between BUFFER and its associated file.
0b9e4749 4144This requires the external program `diff' to be in your `exec-path'."
1eeae2a1 4145 (interactive "bBuffer: ")
0b9e4749 4146 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4e4e9519
MR
4147 (if (and buffer-file-name
4148 (file-exists-p buffer-file-name))
4149 (let ((tempfile (make-temp-file "buffer-content-")))
4150 (unwind-protect
ab1d3835
SM
4151 (progn
4152 (write-region nil nil tempfile nil 'nomessage)
4e4e9519
MR
4153 (diff buffer-file-name tempfile nil t)
4154 (sit-for 0))
4155 (when (file-exists-p tempfile)
4156 (delete-file tempfile))))
4157 (message "Buffer %s has no associated file on disc" (buffer-name))
4158 ;; Display that message for 1 second so that user can read it
4159 ;; in the minibuffer.
4160 (sit-for 1)))
4161 ;; return always nil, so that save-buffers-kill-emacs will not move
4162 ;; over to the next unsaved buffer when calling `d'.
4163 nil)
1eeae2a1
RS
4164
4165(defvar save-some-buffers-action-alist
4166 '((?\C-r
4167 (lambda (buf)
4168 (view-buffer buf
4169 (lambda (ignore)
4170 (exit-recursive-edit)))
4171 (recursive-edit)
4172 ;; Return nil to ask about BUF again.
4173 nil)
5c471b12 4174 "view this buffer")
16abdbe6
CY
4175 (?d (lambda (buf)
4176 (save-window-excursion
4177 (diff-buffer-with-file buf))
4178 (view-buffer (get-buffer-create "*Diff*")
4179 (lambda (ignore) (exit-recursive-edit)))
4180 (recursive-edit)
4181 nil)
5c471b12 4182 "view changes in this buffer"))
1eeae2a1 4183 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
1eeae2a1 4184
a1b0c2a7
RS
4185(defvar buffer-save-without-query nil
4186 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4187(make-variable-buffer-local 'buffer-save-without-query)
4188
ffc0e1ca 4189(defun save-some-buffers (&optional arg pred)
b4da00e9 4190 "Save some modified file-visiting buffers. Asks user about each one.
1eeae2a1
RS
4191You can answer `y' to save, `n' not to save, `C-r' to look at the
4192buffer in question with `view-buffer' before deciding or `d' to
126c9dda 4193view the differences using `diff-buffer-with-file'.
8fd9c174 4194
5bbbceb1 4195Optional argument (the prefix) non-nil means save all with no questions.
ffc0e1ca
AS
4196Optional second argument PRED determines which buffers are considered:
4197If PRED is nil, all the file-visiting buffers are considered.
4198If PRED is t, then certain non-file buffers will also be considered.
4199If PRED is a zero-argument function, it indicates for each buffer whether
1eeae2a1
RS
4200to consider it or not when called with that buffer current.
4201
4202See `save-some-buffers-action-alist' if you want to
4203change the additional actions you can take on files."
b4da00e9 4204 (interactive "P")
907482b9 4205 (save-window-excursion
a1b0c2a7
RS
4206 (let* (queried some-automatic
4207 files-done abbrevs-done)
4208 (dolist (buffer (buffer-list))
4209 ;; First save any buffers that we're supposed to save unconditionally.
4210 ;; That way the following code won't ask about them.
4211 (with-current-buffer buffer
4212 (when (and buffer-save-without-query (buffer-modified-p))
4213 (setq some-automatic t)
4214 (save-buffer))))
4215 ;; Ask about those buffers that merit it,
4216 ;; and record the number thus saved.
4217 (setq files-done
76d5492b
RM
4218 (map-y-or-n-p
4219 (function
4220 (lambda (buffer)
4221 (and (buffer-modified-p buffer)
4222 (not (buffer-base-buffer buffer))
4223 (or
4224 (buffer-file-name buffer)
ffc0e1ca 4225 (and pred
76d5492b
RM
4226 (progn
4227 (set-buffer buffer)
4228 (and buffer-offer-save (> (buffer-size) 0)))))
ffc0e1ca
AS
4229 (or (not (functionp pred))
4230 (with-current-buffer buffer (funcall pred)))
76d5492b
RM
4231 (if arg
4232 t
4233 (setq queried t)
4234 (if (buffer-file-name buffer)
4235 (format "Save file %s? "
4236 (buffer-file-name buffer))
4237 (format "Save buffer %s? "
4238 (buffer-name buffer)))))))
4239 (function
4240 (lambda (buffer)
4241 (set-buffer buffer)
4242 (save-buffer)))
4243 (buffer-list)
4244 '("buffer" "buffers" "save")
1eeae2a1 4245 save-some-buffers-action-alist))
bf247b6e 4246 ;; Maybe to save abbrevs, and record whether
a1b0c2a7
RS
4247 ;; we either saved them or asked to.
4248 (and save-abbrevs abbrevs-changed
4249 (progn
4250 (if (or arg
4251 (eq save-abbrevs 'silently)
4252 (y-or-n-p (format "Save abbrevs in %s? "
4253 abbrev-file-name)))
4254 (write-abbrev-file nil))
4255 ;; Don't keep bothering user if he says no.
4256 (setq abbrevs-changed nil)
4257 (setq abbrevs-done t)))
76d5492b 4258 (or queried (> files-done 0) abbrevs-done
a1b0c2a7
RS
4259 (message (if some-automatic
4260 "(Some special files were saved without asking)"
4261 "(No files need saving)"))))))
b4da00e9
RM
4262\f
4263(defun not-modified (&optional arg)
4264 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
4265With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
4266
4267It is not a good idea to use this function in Lisp programs, because it
4268prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
4269 (interactive "P")
4270 (message (if arg "Modification-flag set"
4271 "Modification-flag cleared"))
4272 (set-buffer-modified-p arg))
4273
4274(defun toggle-read-only (&optional arg)
4275 "Change whether this buffer is visiting its file read-only.
4837b516
GM
4276With prefix argument ARG, make the buffer read-only if ARG is
4277positive, otherwise make it writable. If visiting file read-only
4278and `view-read-only' is non-nil, enter view mode."
b4da00e9 4279 (interactive "P")
c60ee5e7 4280 (if (and arg
d758359d
AS
4281 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4282 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4283 nil ; do nothing.
4284 ;; Toggle.
4285 (cond
4286 ((and buffer-read-only view-mode)
4287 (View-exit-and-edit)
4288 (make-local-variable 'view-read-only)
4289 (setq view-read-only t)) ; Must leave view mode.
4290 ((and (not buffer-read-only) view-read-only
818286f4
SM
4291 ;; If view-mode is already active, `view-mode-enter' is a nop.
4292 (not view-mode)
d758359d
AS
4293 (not (eq (get major-mode 'mode-class) 'special)))
4294 (view-mode-enter))
4295 (t (setq buffer-read-only (not buffer-read-only))
4296 (force-mode-line-update)))
4297 (if (vc-backend buffer-file-name)
8a26c165 4298 (message "%s" (substitute-command-keys
a5dd5f60
RS
4299 (concat "File is under version-control; "
4300 "use \\[vc-next-action] to check in/out"))))))
b4da00e9 4301
912192d1 4302(defun insert-file (filename)
b4da00e9
RM
4303 "Insert contents of file FILENAME into buffer after point.
4304Set mark after the inserted text.
4305
4306This function is meant for the user to run interactively.
4307Don't call it from programs! Use `insert-file-contents' instead.
4308\(Its calling sequence is different; see its documentation)."
912192d1 4309 (interactive "*fInsert file: ")
3a64a3cf 4310 (insert-file-1 filename #'insert-file-contents))
b4da00e9 4311
912192d1 4312(defun append-to-file (start end filename)
b4da00e9
RM
4313 "Append the contents of the region to the end of file FILENAME.
4314When called from a function, expects three arguments,
4315START, END and FILENAME. START and END are buffer positions
da30bf98 4316saying what text to write."
912192d1
KH
4317 (interactive "r\nFAppend to file: ")
4318 (write-region start end filename t))
b4da00e9
RM
4319
4320(defun file-newest-backup (filename)
4321 "Return most recent backup file for FILENAME or nil if no backups exist."
ffc0e1ca
AS
4322 ;; `make-backup-file-name' will get us the right directory for
4323 ;; ordinary or numeric backups. It might create a directory for
4324 ;; backups as a side-effect, according to `backup-directory-alist'.
e31cfca5 4325 (let* ((filename (file-name-sans-versions
783bf210 4326 (make-backup-file-name (expand-file-name filename))))
b4da00e9
RM
4327 (file (file-name-nondirectory filename))
4328 (dir (file-name-directory filename))
4329 (comp (file-name-all-completions file dir))
cf7e94a0
RS
4330 (newest nil)
4331 tem)
b4da00e9 4332 (while comp
ffc0e1ca 4333 (setq tem (pop comp))
cf7e94a0
RS
4334 (cond ((and (backup-file-name-p tem)
4335 (string= (file-name-sans-versions tem) file))
4336 (setq tem (concat dir tem))
4337 (if (or (null newest)
4338 (file-newer-than-file-p tem newest))
4339 (setq newest tem)))))
b4da00e9
RM
4340 newest))
4341
4342(defun rename-uniquely ()
4343 "Rename current buffer to a similar name not already taken.
4344This function is useful for creating multiple shell process buffers
4345or multiple mail buffers, etc."
4346 (interactive)
40eb8038 4347 (save-match-data
e0df3aef
KH
4348 (let ((base-name (buffer-name)))
4349 (and (string-match "<[0-9]+>\\'" base-name)
4350 (not (and buffer-file-name
4351 (string= base-name
4352 (file-name-nondirectory buffer-file-name))))
4353 ;; If the existing buffer name has a <NNN>,
4354 ;; which isn't part of the file name (if any),
4355 ;; then get rid of that.
4356 (setq base-name (substring base-name 0 (match-beginning 0))))
4357 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 4358 (force-mode-line-update))))
5bbbceb1 4359
4e43240a 4360(defun make-directory (dir &optional parents)
5ce8bb89 4361 "Create the directory DIR and any nonexistent parent dirs.
ae0ece90 4362If DIR already exists as a directory, signal an error, unless PARENTS is set.
789cb0f9 4363
5ce8bb89
RS
4364Interactively, the default choice of directory to create
4365is the current default directory for file names.
0225ae5e 4366That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
4367
4368Noninteractively, the second (optional) argument PARENTS says whether
07703430
RS
4369to create parent directories if they don't exist. Interactively,
4370this happens by default."
5ce8bb89
RS
4371 (interactive
4372 (list (read-file-name "Make directory: " default-directory default-directory
4373 nil nil)
4374 t))
ee291b46
RS
4375 ;; If default-directory is a remote directory,
4376 ;; make sure we find its make-directory handler.
4377 (setq dir (expand-file-name dir))
6eaebaa2 4378 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
4379 (if handler
4380 (funcall handler 'make-directory dir parents)
4381 (if (not parents)
4382 (make-directory-internal dir)
4383 (let ((dir (directory-file-name (expand-file-name dir)))
4384 create-list)
4385 (while (not (file-exists-p dir))
76d5492b 4386 (setq create-list (cons dir create-list)
4e43240a
RS
4387 dir (directory-file-name (file-name-directory dir))))
4388 (while create-list
4389 (make-directory-internal (car create-list))
4390 (setq create-list (cdr create-list))))))))
b4da00e9
RM
4391\f
4392(put 'revert-buffer-function 'permanent-local t)
4393(defvar revert-buffer-function nil
0973d78b
RS
4394 "Function to use to revert this buffer, or nil to do the default.
4395The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4396which are the arguments that `revert-buffer' received.")
b4da00e9
RM
4397
4398(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4399(defvar revert-buffer-insert-file-contents-function nil
4400 "Function to use to insert contents when reverting this buffer.
4401Gets two args, first the nominal file name to use,
2df32500
RS
4402and second, t if reading the auto-save file.
4403
4404The function you specify is responsible for updating (or preserving) point.")
b4da00e9 4405
b0dc9757
LT
4406(defvar buffer-stale-function nil
4407 "Function to check whether a non-file buffer needs reverting.
4408This should be a function with one optional argument NOCONFIRM.
44dce0fb 4409Auto Revert Mode passes t for NOCONFIRM. The function should return
8b0b6932
LT
4410non-nil if the buffer should be reverted. A return value of
4411`fast' means that the need for reverting was not checked, but
4412that reverting the buffer is fast. The buffer is current when
4413this function is called.
b0dc9757 4414
4f8453ae
LT
4415The idea behind the NOCONFIRM argument is that it should be
4416non-nil if the buffer is going to be reverted without asking the
4417user. In such situations, one has to be careful with potentially
c90dcdd5
LT
4418time consuming operations.
4419
4420For more information on how this variable is used by Auto Revert mode,
b3a59350 4421see Info node `(emacs)Supporting additional buffers'.")
b0dc9757 4422
5f76e7d4
KH
4423(defvar before-revert-hook nil
4424 "Normal hook for `revert-buffer' to run before reverting.
4425If `revert-buffer-function' is used to override the normal revert
4426mechanism, this hook is not used.")
4427
4428(defvar after-revert-hook nil
4429 "Normal hook for `revert-buffer' to run after reverting.
4430Note that the hook value that it runs is the value that was in effect
4431before reverting; that makes a difference if you have buffer-local
4432hook functions.
4433
4434If `revert-buffer-function' is used to override the normal revert
4435mechanism, this hook is not used.")
4436
1554c03b
RS
4437(defvar revert-buffer-internal-hook)
4438
9a30563f 4439(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 4440 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 4441This undoes all changes since the file was visited or saved.
8c0e7b73
JB
4442With a prefix argument, offer to revert from latest auto-save file, if
4443that is more recent than the visited file.
1ab31687 4444
0dff8975
VJL
4445This command also implements an interface for special buffers
4446that contain text which doesn't come from a file, but reflects
4447some other data instead (e.g. Dired buffers, `buffer-list'
c84b3004
VJL
4448buffers). This is done via the variable
4449`revert-buffer-function'. In these cases, it should reconstruct
0dff8975 4450the buffer contents from the appropriate data.
7e7c9c4e 4451
65ee6096 4452When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
4453to revert from the auto-save file when this is nil. Note that the
4454sense of this argument is the reverse of the prefix argument, for the
4455sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4456to nil.
4457
4458Optional second argument NOCONFIRM means don't ask for confirmation at
518dc5be
EZ
4459all. \(The variable `revert-without-query' offers another way to
4460revert buffers without querying for confirmation.)
b4da00e9 4461
5b2b26d5
RS
4462Optional third argument PRESERVE-MODES non-nil means don't alter
4463the files modes. Normally we reinitialize them using `normal-mode'.
4464
8c0e7b73 4465If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
4466do all the work for this command. Otherwise, the hooks
4467`before-revert-hook' and `after-revert-hook' are run at the beginning
4468and the end, and if `revert-buffer-insert-file-contents-function' is
4469non-nil, it is called instead of rereading visited file contents."
fb6208a6 4470
1ab31687
JB
4471 ;; I admit it's odd to reverse the sense of the prefix argument, but
4472 ;; there is a lot of code out there which assumes that the first
4473 ;; argument should be t to avoid consulting the auto-save file, and
4474 ;; there's no straightforward way to encourage authors to notice a
4475 ;; reversal of the argument sense. So I'm just changing the user
4476 ;; interface, but leaving the programmatic interface the same.
e0867e99 4477 (interactive (list (not current-prefix-arg)))
b4da00e9 4478 (if revert-buffer-function
1ab31687 4479 (funcall revert-buffer-function ignore-auto noconfirm)
44dce0fb
RS
4480 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4481 (current-buffer))
4482 (let* ((auto-save-p (and (not ignore-auto)
4483 (recent-auto-save-p)
4484 buffer-auto-save-file-name
4485 (file-readable-p buffer-auto-save-file-name)
4486 (y-or-n-p
4487 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4488 (file-name (if auto-save-p
4489 buffer-auto-save-file-name
4490 buffer-file-name)))
4491 (cond ((null file-name)
4492 (error "Buffer does not seem to be associated with any file"))
4493 ((or noconfirm
4494 (and (not (buffer-modified-p))
518dc5be
EZ
4495 (catch 'found
4496 (dolist (regexp revert-without-query)
4497 (when (string-match regexp file-name)
4498 (throw 'found t)))))
44dce0fb
RS
4499 (yes-or-no-p (format "Revert buffer from file %s? "
4500 file-name)))
4501 (run-hooks 'before-revert-hook)
4502 ;; If file was backed up but has changed since,
4503 ;; we shd make another backup.
4504 (and (not auto-save-p)
4505 (not (verify-visited-file-modtime (current-buffer)))
4506 (setq buffer-backed-up nil))
44dce0fb
RS
4507 ;; Effectively copy the after-revert-hook status,
4508 ;; since after-find-file will clobber it.
4509 (let ((global-hook (default-value 'after-revert-hook))
518dc5be
EZ
4510 (local-hook (when (local-variable-p 'after-revert-hook)
4511 after-revert-hook))
4512 (inhibit-read-only t))
4513 (cond
4514 (revert-buffer-insert-file-contents-function
4515 (unless (eq buffer-undo-list t)
4516 ;; Get rid of all undo records for this buffer.
4517 (setq buffer-undo-list nil))
4518 ;; Don't make undo records for the reversion.
4519 (let ((buffer-undo-list t))
4520 (funcall revert-buffer-insert-file-contents-function
4521 file-name auto-save-p)))
4522 ((not (file-exists-p file-name))
4523 (error (if buffer-file-number
4524 "File %s no longer exists!"
4525 "Cannot revert nonexistent file %s")
4526 file-name))
b2d239c1
RS
4527 ((not (file-readable-p file-name))
4528 (error (if buffer-file-number
4529 "File %s no longer readable!"
4530 "Cannot revert unreadable file %s")
4531 file-name))
518dc5be
EZ
4532 (t
4533 ;; Bind buffer-file-name to nil
4534 ;; so that we don't try to lock the file.
4535 (let ((buffer-file-name nil))
4536 (or auto-save-p
4537 (unlock-buffer)))
4538 (widen)
4539 (let ((coding-system-for-read
4540 ;; Auto-saved file should be read by Emacs'
4541 ;; internal coding.
4542 (if auto-save-p 'auto-save-coding
4543 (or coding-system-for-read
4544 buffer-file-coding-system-explicit))))
e1ee3b54 4545 (if (and (not enable-multibyte-characters)
52f9b751 4546 coding-system-for-read
e1ee3b54
KH
4547 (not (memq (coding-system-base
4548 coding-system-for-read)
4549 '(no-conversion raw-text))))
4550 ;; As a coding system suitable for multibyte
4551 ;; buffer is specified, make the current
4552 ;; buffer multibyte.
4553 (set-buffer-multibyte t))
4554
518dc5be
EZ
4555 ;; This force after-insert-file-set-coding
4556 ;; (called from insert-file-contents) to set
4557 ;; buffer-file-coding-system to a proper value.
4558 (kill-local-variable 'buffer-file-coding-system)
4559
4560 ;; Note that this preserves point in an intelligent way.
4561 (if preserve-modes
4562 (let ((buffer-file-format buffer-file-format))
4563 (insert-file-contents file-name (not auto-save-p)
4564 nil nil t))
4565 (insert-file-contents file-name (not auto-save-p)
2a29c409 4566 nil nil t)))))
44dce0fb
RS
4567 ;; Recompute the truename in case changes in symlinks
4568 ;; have changed the truename.
4569 (setq buffer-file-truename
4570 (abbreviate-file-name (file-truename buffer-file-name)))
4571 (after-find-file nil nil t t preserve-modes)
4572 ;; Run after-revert-hook as it was before we reverted.
4573 (setq-default revert-buffer-internal-hook global-hook)
518dc5be 4574 (if local-hook
44dce0fb
RS
4575 (set (make-local-variable 'revert-buffer-internal-hook)
4576 local-hook)
4577 (kill-local-variable 'revert-buffer-internal-hook))
4578 (run-hooks 'revert-buffer-internal-hook))
4579 t))))))
b4da00e9 4580
64d18e8f
RS
4581(defun recover-this-file ()
4582 "Recover the visited file--get contents from its last auto-save file."
4583 (interactive)
4584 (recover-file buffer-file-name))
4585
b4da00e9
RM
4586(defun recover-file (file)
4587 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
4588 ;; Actually putting the file name in the minibuffer should be used
4589 ;; only rarely.
4590 ;; Not just because users often use the default.
e1dadc17 4591 (interactive "FRecover file: ")
b4da00e9 4592 (setq file (expand-file-name file))
f7da6740 4593 (if (auto-save-file-name-p (file-name-nondirectory file))
4e163715 4594 (error "%s is an auto-save file" (abbreviate-file-name file)))
b4da00e9
RM
4595 (let ((file-name (let ((buffer-file-name file))
4596 (make-auto-save-file-name))))
945e1965
RS
4597 (cond ((if (file-exists-p file)
4598 (not (file-newer-than-file-p file-name file))
4599 (not (file-exists-p file-name)))
4e163715
SM
4600 (error "Auto-save file %s not current"
4601 (abbreviate-file-name file-name)))
b4da00e9 4602 ((save-window-excursion
ffc0e1ca
AS
4603 (with-output-to-temp-buffer "*Directory*"
4604 (buffer-disable-undo standard-output)
4605 (save-excursion
4606 (let ((switches dired-listing-switches))
4607 (if (file-symlink-p file)
4608 (setq switches (concat switches "L")))
4609 (set-buffer standard-output)
bc22fd18
EZ
4610 ;; Use insert-directory-safely, not insert-directory,
4611 ;; because these files might not exist. In particular,
4612 ;; FILE might not exist if the auto-save file was for
4613 ;; a buffer that didn't visit a file, such as "*mail*".
4614 ;; The code in v20.x called `ls' directly, so we need
4615 ;; to emulate what `ls' did in that case.
4616 (insert-directory-safely file switches)
4617 (insert-directory-safely file-name switches))))
b4da00e9
RM
4618 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4619 (switch-to-buffer (find-file-noselect file t))
518dc5be 4620 (let ((inhibit-read-only t)
1e87edf5
KH
4621 ;; Keep the current buffer-file-coding-system.
4622 (coding-system buffer-file-coding-system)
1d0ec0d1 4623 ;; Auto-saved file should be read with special coding.
77619f8e 4624 (coding-system-for-read 'auto-save-coding))
b4da00e9 4625 (erase-buffer)
1e87edf5
KH
4626 (insert-file-contents file-name nil)
4627 (set-buffer-file-coding-system coding-system))
8cfb9d46 4628 (after-find-file nil nil t))
ffa7ab70 4629 (t (error "Recover-file cancelled")))))
b4da00e9 4630
6598027d 4631(defun recover-session ()
9aee5392
RS
4632 "Recover auto save files from a previous Emacs session.
4633This command first displays a Dired buffer showing you the
4634previous sessions that you could recover from.
4635To choose one, move point to the proper line and then type C-c C-c.
4636Then you'll be asked about a number of files to recover."
4637 (interactive)
363a5030
RS
4638 (if (null auto-save-list-file-prefix)
4639 (error "You set `auto-save-list-file-prefix' to disable making session files"))
ffc0e1ca
AS
4640 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4641 (unless (file-directory-p dir)
194600a8
JPW
4642 (make-directory dir t))
4643 (unless (directory-files dir nil
4644 (concat "\\`" (regexp-quote
4645 (file-name-nondirectory
4646 auto-save-list-file-prefix)))
4647 t)
4648 (error "No previous sessions to recover")))
6f4983e6 4649 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
4650 (dired (concat auto-save-list-file-prefix "*")
4651 (concat dired-listing-switches "t")))
05e076c7
AS
4652 (save-excursion
4653 (goto-char (point-min))
4654 (or (looking-at " Move to the session you want to recover,")
4655 (let ((inhibit-read-only t))
4656 ;; Each line starts with a space
4657 ;; so that Font Lock mode won't highlight the first character.
4658 (insert " Move to the session you want to recover,\n"
4659 " then type C-c C-c to select it.\n\n"
4660 " You can also delete some of these files;\n"
4661 " type d on a line to mark that file for deletion.\n\n"))))
9aee5392 4662 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 4663 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 4664
80280bb7 4665(defun recover-session-finish ()
9aee5392
RS
4666 "Choose one saved session to recover auto-save files from.
4667This command is used in the special Dired buffer created by
80280bb7 4668\\[recover-session]."
9aee5392
RS
4669 (interactive)
4670 ;; Get the name of the session file to recover from.
4671 (let ((file (dired-get-filename))
953a03b2 4672 files
9aee5392 4673 (buffer (get-buffer-create " *recover*")))
c11032b9 4674 (dired-unmark 1)
033ef863 4675 (dired-do-flagged-delete t)
9aee5392
RS
4676 (unwind-protect
4677 (save-excursion
4678 ;; Read in the auto-save-list file.
4679 (set-buffer buffer)
4680 (erase-buffer)
4681 (insert-file-contents file)
953a03b2
RS
4682 ;; Loop thru the text of that file
4683 ;; and get out the names of the files to recover.
4684 (while (not (eobp))
4685 (let (thisfile autofile)
4686 (if (eolp)
4687 ;; This is a pair of lines for a non-file-visiting buffer.
4688 ;; Get the auto-save file name and manufacture
4689 ;; a "visited file name" from that.
4690 (progn
4691 (forward-line 1)
259be4e6
JB
4692 ;; If there is no auto-save file name, the
4693 ;; auto-save-list file is probably corrupted.
4694 (unless (eolp)
4695 (setq autofile
4696 (buffer-substring-no-properties
4697 (point)
e442c62b 4698 (line-end-position)))
259be4e6
JB
4699 (setq thisfile
4700 (expand-file-name
4701 (substring
4702 (file-name-nondirectory autofile)
4703 1 -1)
4704 (file-name-directory autofile))))
953a03b2
RS
4705 (forward-line 1))
4706 ;; This pair of lines is a file-visiting
4707 ;; buffer. Use the visited file name.
4708 (progn
4709 (setq thisfile
4710 (buffer-substring-no-properties
4711 (point) (progn (end-of-line) (point))))
4712 (forward-line 1)
4713 (setq autofile
4714 (buffer-substring-no-properties
4715 (point) (progn (end-of-line) (point))))
4716 (forward-line 1)))
4717 ;; Ignore a file if its auto-save file does not exist now.
259be4e6 4718 (if (and autofile (file-exists-p autofile))
953a03b2
RS
4719 (setq files (cons thisfile files)))))
4720 (setq files (nreverse files))
945e1965
RS
4721 ;; The file contains a pair of line for each auto-saved buffer.
4722 ;; The first line of the pair contains the visited file name
4723 ;; or is empty if the buffer was not visiting a file.
4724 ;; The second line is the auto-save file name.
953a03b2
RS
4725 (if files
4726 (map-y-or-n-p "Recover %s? "
4727 (lambda (file)
4728 (condition-case nil
4729 (save-excursion (recover-file file))
76d5492b 4730 (error
953a03b2
RS
4731 "Failed to recover `%s'" file)))
4732 files
4733 '("file" "files" "recover"))
4734 (message "No files can be recovered from this session now")))
9aee5392
RS
4735 (kill-buffer buffer))))
4736
a151f82c
SS
4737(defun kill-buffer-ask (buffer)
4738 "Kill buffer if confirmed."
4739 (when (yes-or-no-p
4740 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4741 (if (buffer-modified-p buffer)
4742 "HAS BEEN EDITED" "is unmodified")))
4743 (kill-buffer buffer)))
4744
73ba610a 4745(defun kill-some-buffers (&optional list)
243a3ae0 4746 "Kill some buffers. Asks the user whether to kill each one of them.
bb8eaf67 4747Non-interactively, if optional argument LIST is non-nil, it
243a3ae0 4748specifies the list of buffers to kill, asking for approval for each one."
b4da00e9 4749 (interactive)
73ba610a
RS
4750 (if (null list)
4751 (setq list (buffer-list)))
4752 (while list
4753 (let* ((buffer (car list))
4754 (name (buffer-name buffer)))
cbca0a4b
RS
4755 (and name ; Can be nil for an indirect buffer
4756 ; if we killed the base buffer.
4757 (not (string-equal name ""))
26b9ecbc 4758 (/= (aref name 0) ?\s)
a151f82c 4759 (kill-buffer-ask buffer)))
73ba610a 4760 (setq list (cdr list))))
a151f82c
SS
4761
4762(defun kill-matching-buffers (regexp &optional internal-too)
4763 "Kill buffers whose name matches the specified regexp.
4764The optional second argument indicates whether to kill internal buffers too."
4765 (interactive "sKill buffers matching this regular expression: \nP")
4766 (dolist (buffer (buffer-list))
4767 (let ((name (buffer-name buffer)))
4768 (when (and name (not (string-equal name ""))
4769 (or internal-too (/= (aref name 0) ?\s))
4770 (string-match regexp name))
4771 (kill-buffer-ask buffer)))))
4772
b4da00e9
RM
4773\f
4774(defun auto-save-mode (arg)
4775 "Toggle auto-saving of contents of current buffer.
f3e23606 4776With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
4777 (interactive "P")
4778 (setq buffer-auto-save-file-name
4779 (and (if (null arg)
74b9c2af 4780 (or (not buffer-auto-save-file-name)
4e0c8650 4781 ;; If auto-save is off because buffer has shrunk,
74b9c2af
RS
4782 ;; then toggling should turn it on.
4783 (< buffer-saved-size 0))
b4da00e9
RM
4784 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4785 (if (and buffer-file-name auto-save-visited-file-name
4786 (not buffer-read-only))
4787 buffer-file-name
4788 (make-auto-save-file-name))))
0b7f1ef2
RS
4789 ;; If -1 was stored here, to temporarily turn off saving,
4790 ;; turn it back on.
4791 (and (< buffer-saved-size 0)
4792 (setq buffer-saved-size 0))
b4da00e9
RM
4793 (if (interactive-p)
4794 (message "Auto-save %s (in this buffer)"
4795 (if buffer-auto-save-file-name "on" "off")))
4796 buffer-auto-save-file-name)
4797
4798(defun rename-auto-save-file ()
4799 "Adjust current buffer's auto save file name for current conditions.
4800Also rename any existing auto save file, if it was made in this session."
4801 (let ((osave buffer-auto-save-file-name))
4802 (setq buffer-auto-save-file-name
4803 (make-auto-save-file-name))
4804 (if (and osave buffer-auto-save-file-name
4805 (not (string= buffer-auto-save-file-name buffer-file-name))
4806 (not (string= buffer-auto-save-file-name osave))
4807 (file-exists-p osave)
4808 (recent-auto-save-p))
4809 (rename-file osave buffer-auto-save-file-name t))))
4810
4811(defun make-auto-save-file-name ()
4812 "Return file name to use for auto-saves of current buffer.
4813Does not consider `auto-save-visited-file-name' as that variable is checked
4814before calling this function. You can redefine this for customization.
4815See also `auto-save-file-name-p'."
4816 (if buffer-file-name
c1105d05
MA
4817 (let ((handler (find-file-name-handler buffer-file-name
4818 'make-auto-save-file-name)))
4819 (if handler
4820 (funcall handler 'make-auto-save-file-name)
4821 (let ((list auto-save-file-name-transforms)
4822 (filename buffer-file-name)
4823 result uniq)
4824 ;; Apply user-specified translations
4825 ;; to the file name.
4826 (while (and list (not result))
4827 (if (string-match (car (car list)) filename)
4828 (setq result (replace-match (cadr (car list)) t nil
4829 filename)
4830 uniq (car (cddr (car list)))))
4831 (setq list (cdr list)))
4832 (if result
4833 (if uniq
4834 (setq filename (concat
4835 (file-name-directory result)
4836 (subst-char-in-string
4837 ?/ ?!
4838 (replace-regexp-in-string "!" "!!"
4839 filename))))
4840 (setq filename result)))
4841 (setq result
4842 (if (and (eq system-type 'ms-dos)
4843 (not (msdos-long-file-names)))
4844 ;; We truncate the file name to DOS 8+3 limits
4845 ;; before doing anything else, because the regexp
4846 ;; passed to string-match below cannot handle
4847 ;; extensions longer than 3 characters, multiple
4848 ;; dots, and other atrocities.
4849 (let ((fn (dos-8+3-filename
4850 (file-name-nondirectory buffer-file-name))))
4851 (string-match
4852 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4853 fn)
4854 (concat (file-name-directory buffer-file-name)
4855 "#" (match-string 1 fn)
4856 "." (match-string 3 fn) "#"))
4857 (concat (file-name-directory filename)
4858 "#"
4859 (file-name-nondirectory filename)
4860 "#")))
4861 ;; Make sure auto-save file names don't contain characters
4862 ;; invalid for the underlying filesystem.
18b28ef1 4863 (if (and (memq system-type '(ms-dos windows-nt cygwin))
c1105d05
MA
4864 ;; Don't modify remote (ange-ftp) filenames
4865 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4866 (convert-standard-filename result)
4867 result))))
0a1763b4
RS
4868
4869 ;; Deal with buffers that don't have any associated files. (Mail
4870 ;; mode tends to create a good number of these.)
4871
7d483e8c 4872 (let ((buffer-name (buffer-name))
ff5c7181 4873 (limit 0)
77d18896 4874 file-name)
ad80c679
JR
4875 ;; Restrict the characters used in the file name to those which
4876 ;; are known to be safe on all filesystems, url-encoding the
4877 ;; rest.
4878 ;; We do this on all platforms, because even if we are not
4879 ;; running on DOS/Windows, the current directory may be on a
4880 ;; mounted VFAT filesystem, such as a USB memory stick.
4881 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
c3348e10
RS
4882 (let* ((character (aref buffer-name (match-beginning 0)))
4883 (replacement
ad80c679
JR
4884 ;; For multibyte characters, this will produce more than
4885 ;; 2 hex digits, so is not true URL encoding.
4886 (format "%%%02X" character)))
c3348e10
RS
4887 (setq buffer-name (replace-match replacement t t buffer-name))
4888 (setq limit (1+ (match-end 0)))))
a8abaf83 4889 ;; Generate the file name.
ff5c7181
RS
4890 (setq file-name
4891 (make-temp-file
4892 (let ((fname
4893 (expand-file-name
4894 (format "#%s#" buffer-name)
4895 ;; Try a few alternative directories, to get one we can
4896 ;; write it.
4897 (cond
4898 ((file-writable-p default-directory) default-directory)
4899 ((file-writable-p "/var/tmp/") "/var/tmp/")
4900 ("~/")))))
18b28ef1 4901 (if (and (memq system-type '(ms-dos windows-nt cygwin))
ff5c7181
RS
4902 ;; Don't modify remote (ange-ftp) filenames
4903 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4904 ;; The call to convert-standard-filename is in case
4905 ;; buffer-name includes characters not allowed by the
4906 ;; DOS/Windows filesystems. make-temp-file writes to the
4907 ;; file it creates, so we must fix the file name _before_
4908 ;; make-temp-file is called.
4909 (convert-standard-filename fname)
4910 fname))
4911 nil "#"))
4912 ;; make-temp-file creates the file,
4913 ;; but we don't want it to exist until we do an auto-save.
4914 (condition-case ()
4915 (delete-file file-name)
4916 (file-error nil))
4917 file-name)))
b4da00e9
RM
4918
4919(defun auto-save-file-name-p (filename)
4920 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4921FILENAME should lack slashes. You can redefine this for customization."
4922 (string-match "^#.*#$" filename))
4923\f
6f4983e6
RS
4924(defun wildcard-to-regexp (wildcard)
4925 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4837b516 4926The generated regexp will match a filename only if the filename
6f4983e6
RS
4927matches that wildcard according to shell rules. Only wildcards known
4928by `sh' are supported."
4929 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4930 ;; Copy the initial run of non-special characters.
4931 (result (substring wildcard 0 i))
4932 (len (length wildcard)))
4933 ;; If no special characters, we're almost done.
4934 (if i
4935 (while (< i len)
4936 (let ((ch (aref wildcard i))
4937 j)
4938 (setq
4939 result
4940 (concat result
4941 (cond
7e7c9c4e
RS
4942 ((and (eq ch ?\[)
4943 (< (1+ i) len)
4944 (eq (aref wildcard (1+ i)) ?\]))
4945 "\\[")
6f4983e6
RS
4946 ((eq ch ?\[) ; [...] maps to regexp char class
4947 (progn
4948 (setq i (1+ i))
4949 (concat
4950 (cond
4951 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4952 (progn
4953 (setq i (1+ i))
4954 (if (eq (aref wildcard i) ?\])
4955 (progn
4956 (setq i (1+ i))
4957 "[^]")
4958 "[^")))
4959 ((eq (aref wildcard i) ?^)
4960 ;; Found "[^". Insert a `\0' character
4961 ;; (which cannot happen in a filename)
4962 ;; into the character class, so that `^'
4963 ;; is not the first character after `[',
4964 ;; and thus non-special in a regexp.
4965 (progn
4966 (setq i (1+ i))
4967 "[\000^"))
4968 ((eq (aref wildcard i) ?\])
4969 ;; I don't think `]' can appear in a
4970 ;; character class in a wildcard, but
4971 ;; let's be general here.
4972 (progn
4973 (setq i (1+ i))
4974 "[]"))
4975 (t "["))
4976 (prog1 ; copy everything upto next `]'.
4977 (substring wildcard
4978 i
4979 (setq j (string-match
4980 "]" wildcard i)))
4981 (setq i (if j (1- j) (1- len)))))))
4982 ((eq ch ?.) "\\.")
4983 ((eq ch ?*) "[^\000]*")
4984 ((eq ch ?+) "\\+")
4985 ((eq ch ?^) "\\^")
4986 ((eq ch ?$) "\\$")
4987 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4988 ((eq ch ??) "[^\000]")
4989 (t (char-to-string ch)))))
4990 (setq i (1+ i)))))
4991 ;; Shell wildcards should match the entire filename,
4992 ;; not its part. Make the regexp say so.
4993 (concat "\\`" result "\\'")))
4994\f
21540597 4995(defcustom list-directory-brief-switches
b4da00e9 4996 (if (eq system-type 'vax-vms) "" "-CF")
ba83982b 4997 "Switches for `list-directory' to pass to `ls' for brief listing."
21540597
RS
4998 :type 'string
4999 :group 'dired)
b4da00e9 5000
21540597 5001(defcustom list-directory-verbose-switches
b4da00e9
RM
5002 (if (eq system-type 'vax-vms)
5003 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
5004 "-l")
ba83982b 5005 "Switches for `list-directory' to pass to `ls' for verbose listing."
21540597
RS
5006 :type 'string
5007 :group 'dired)
b4da00e9 5008
5de148a2
RS
5009(defun file-expand-wildcards (pattern &optional full)
5010 "Expand wildcard pattern PATTERN.
4db2a7de
RS
5011This returns a list of file names which match the pattern.
5012
814af837 5013If PATTERN is written as an absolute file name,
4db2a7de
RS
5014the values are absolute also.
5015
5016If PATTERN is written as a relative file name, it is interpreted
5017relative to the current default directory, `default-directory'.
5018The file names returned are normally also relative to the current
5019default directory. However, if FULL is non-nil, they are absolute."
032388f3
RS
5020 (save-match-data
5021 (let* ((nondir (file-name-nondirectory pattern))
5022 (dirpart (file-name-directory pattern))
5023 ;; A list of all dirs that DIRPART specifies.
5024 ;; This can be more than one dir
5025 ;; if DIRPART contains wildcards.
5026 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
5027 (mapcar 'file-name-as-directory
5028 (file-expand-wildcards (directory-file-name dirpart)))
5029 (list dirpart)))
5030 contents)
5031 (while dirs
5032 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5033 (file-directory-p (directory-file-name (car dirs))))
5034 (let ((this-dir-contents
5035 ;; Filter out "." and ".."
5036 (delq nil
5037 (mapcar #'(lambda (name)
5038 (unless (string-match "\\`\\.\\.?\\'"
5039 (file-name-nondirectory name))
5040 name))
5041 (directory-files (or (car dirs) ".") full
5042 (wildcard-to-regexp nondir))))))
5043 (setq contents
5044 (nconc
5045 (if (and (car dirs) (not full))
5046 (mapcar (function (lambda (name) (concat (car dirs) name)))
5047 this-dir-contents)
5048 this-dir-contents)
5049 contents))))
5050 (setq dirs (cdr dirs)))
5051 contents)))
5de148a2 5052
b4da00e9
RM
5053(defun list-directory (dirname &optional verbose)
5054 "Display a list of files in or matching DIRNAME, a la `ls'.
5055DIRNAME is globbed by the shell if necessary.
5056Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5057Actions controlled by variables `list-directory-brief-switches'
5058and `list-directory-verbose-switches'."
5059 (interactive (let ((pfx current-prefix-arg))
5060 (list (read-file-name (if pfx "List directory (verbose): "
5061 "List directory (brief): ")
5062 nil default-directory nil)
5063 pfx)))
5064 (let ((switches (if verbose list-directory-verbose-switches
84905190
RS
5065 list-directory-brief-switches))
5066 buffer)
b4da00e9
RM
5067 (or dirname (setq dirname default-directory))
5068 (setq dirname (expand-file-name dirname))
5069 (with-output-to-temp-buffer "*Directory*"
84905190 5070 (setq buffer standard-output)
b4da00e9
RM
5071 (buffer-disable-undo standard-output)
5072 (princ "Directory ")
5073 (princ dirname)
5074 (terpri)
c3554e95
RS
5075 (save-excursion
5076 (set-buffer "*Directory*")
5077 (let ((wildcard (not (file-directory-p dirname))))
84905190
RS
5078 (insert-directory dirname switches wildcard (not wildcard)))))
5079 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5080 (with-current-buffer buffer
5081 (setq default-directory
5082 (if (file-directory-p dirname)
5083 (file-name-as-directory dirname)
5084 (file-name-directory dirname))))))
c3554e95 5085
ffc0e1ca
AS
5086(defun shell-quote-wildcard-pattern (pattern)
5087 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5088
5089PATTERN is assumed to represent a file-name wildcard suitable for the
5090underlying filesystem. For Unix and GNU/Linux, the characters from the
d6d61574 5091set [ \\t\\n;<>&|()'\"#$] are quoted with a backslash; for DOS/Windows, all
ffc0e1ca
AS
5092the parts of the pattern which don't include wildcard characters are
5093quoted with double quotes.
5094Existing quote characters in PATTERN are left alone, so you can pass
5095PATTERN that already quotes some of the special characters."
5096 (save-match-data
5097 (cond
c60ee5e7 5098 ((memq system-type '(ms-dos windows-nt cygwin))
ffc0e1ca
AS
5099 ;; DOS/Windows don't allow `"' in file names. So if the
5100 ;; argument has quotes, we can safely assume it is already
5101 ;; quoted by the caller.
5102 (if (or (string-match "[\"]" pattern)
5103 ;; We quote [&()#$'] in case their shell is a port of a
5104 ;; Unixy shell. We quote [,=+] because stock DOS and
5105 ;; Windows shells require that in some cases, such as
5106 ;; passing arguments to batch files that use positional
5107 ;; arguments like %1.
5108 (not (string-match "[ \t;&()#$',=+]" pattern)))
5109 pattern
5110 (let ((result "\"")
5111 (beg 0)
5112 end)
5113 (while (string-match "[*?]+" pattern beg)
5114 (setq end (match-beginning 0)
5115 result (concat result (substring pattern beg end)
5116 "\""
5117 (substring pattern end (match-end 0))
5118 "\"")
5119 beg (match-end 0)))
5120 (concat result (substring pattern beg) "\""))))
5121 (t
5122 (let ((beg 0))
d6d61574 5123 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
ffc0e1ca
AS
5124 (setq pattern
5125 (concat (substring pattern 0 (match-beginning 0))
5126 "\\"
5127 (substring pattern (match-beginning 0)))
5128 beg (1+ (match-end 0)))))
5129 pattern))))
5130
5131
c3554e95
RS
5132(defvar insert-directory-program "ls"
5133 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5134
f4d04672 5135(defcustom directory-free-space-program "df"
ba83982b 5136 "Program to get the amount of free space on a file system.
f4d04672
RS
5137We assume the output has the format of `df'.
5138The value of this variable must be just a command name or file name;
5139if you want to specify options, use `directory-free-space-args'.
5140
01b26b90
EZ
5141A value of nil disables this feature.
5142
5143If the function `file-system-info' is defined, it is always used in
5144preference to the program given by this variable."
f4d04672
RS
5145 :type '(choice (string :tag "Program") (const :tag "None" nil))
5146 :group 'dired)
5147
525fdbc9
AS
5148(defcustom directory-free-space-args
5149 (if (eq system-type 'darwin) "-k" "-Pk")
ba83982b 5150 "Options to use when running `directory-free-space-program'."
f4d04672
RS
5151 :type 'string
5152 :group 'dired)
5153
01b26b90 5154(defun get-free-disk-space (dir)
26b9ecbc 5155 "Return the amount of free space on directory DIR's file system.
01b26b90 5156The result is a string that gives the number of free 1KB blocks,
26b9ecbc 5157or nil if the system call or the program which retrieve the information
06531fc3 5158fail. It returns also nil when DIR is a remote directory.
01b26b90
EZ
5159
5160This function calls `file-system-info' if it is available, or invokes the
5161program specified by `directory-free-space-program' if that is non-nil."
06531fc3
MA
5162 (when (not (file-remote-p dir))
5163 ;; Try to find the number of free blocks. Non-Posix systems don't
5164 ;; always have df, but might have an equivalent system call.
5165 (if (fboundp 'file-system-info)
5166 (let ((fsinfo (file-system-info dir)))
5167 (if fsinfo
5168 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5169 (save-match-data
5170 (with-temp-buffer
5171 (when (and directory-free-space-program
5172 (eq 0 (call-process directory-free-space-program
5173 nil t nil
5174 directory-free-space-args
5175 dir)))
5176 ;; Usual format is a header line followed by a line of
5177 ;; numbers.
5178 (goto-char (point-min))
5179 (forward-line 1)
5180 (if (not (eobp))
5181 (progn
5182 ;; Move to the end of the "available blocks" number.
5183 (skip-chars-forward "^ \t")
5184 (forward-word 3)
5185 ;; Copy it into AVAILABLE.
5186 (let ((end (point)))
5187 (forward-word -1)
5188 (buffer-substring (point) end))))))))))
01b26b90 5189
9bc260cf
MA
5190;; The following expression replaces `dired-move-to-filename-regexp'.
5191(defvar directory-listing-before-filename-regexp
5192 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5193 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5194 ;; In some locales, month abbreviations are as short as 2 letters,
5195 ;; and they can be followed by ".".
5196 ;; In Breton, a month name can include a quote character.
5197 (month (concat l-or-quote l-or-quote "+\\.?"))
5198 (s " ")
5199 (yyyy "[0-9][0-9][0-9][0-9]")
5200 (dd "[ 0-3][0-9]")
5201 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5202 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5203 (zone "[-+][0-2][0-9][0-5][0-9]")
5204 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5205 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5206 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5207 "\\|" yyyy "-" iso-mm-dd "\\)"))
5208 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5209 s "+"
5210 "\\(" HH:MM "\\|" yyyy "\\)"))
5211 (western-comma (concat month s "+" dd "," s "+" yyyy))
5212 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5213 ;; omits the Kanji characters after month and day-of-month.
5214 ;; On Mac OS X 10.3, the date format in East Asian locales is
5215 ;; day-of-month digits followed by month digits.
5216 (mm "[ 0-1]?[0-9]")
5217 (east-asian
5218 (concat "\\(" mm l "?" s dd l "?" s "+"
5219 "\\|" dd s mm s "+" "\\)"
5220 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5221 ;; The "[0-9]" below requires the previous column to end in a digit.
5222 ;; This avoids recognizing `1 may 1997' as a date in the line:
5223 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5224
5225 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5226 ;; The ".*" below finds the last match if there are multiple matches.
5227 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5228 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5229
5230 ;; vc dired listings provide the state or blanks between file
5231 ;; permissions and date. The state is always surrounded by
5232 ;; parantheses:
5233 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5234 ;; This is not supported yet.
5235 (concat ".*[0-9][BkKMGTPEZY]?" s
5236 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
5237 s "+"))
5238 "Regular expression to match up to the file name in a directory listing.
5239The default value is designed to recognize dates and times
5240regardless of the language.")
01b26b90 5241
a1b0c2a7
RS
5242(defvar insert-directory-ls-version 'unknown)
5243
c3554e95
RS
5244;; insert-directory
5245;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5246;; FULL-DIRECTORY-P is nil.
5247;; The single line of output must display FILE's name as it was
5248;; given, namely, an absolute path name.
5249;; - must insert exactly one line for each file if WILDCARD or
5250;; FULL-DIRECTORY-P is t, plus one optional "total" line
5251;; before the file lines, plus optional text after the file lines.
5252;; Lines are delimited by "\n", so filenames containing "\n" are not
5253;; allowed.
5254;; File lines should display the basename.
5255;; - must be consistent with
5256;; - functions dired-move-to-filename, (these two define what a file line is)
5257;; dired-move-to-end-of-filename,
5258;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5259;; dired-insert-headerline
5260;; dired-after-subdir-garbage (defines what a "total" line is)
5261;; - variable dired-subdir-regexp
1fc85dae
KG
5262;; - may be passed "--dired" as the first argument in SWITCHES.
5263;; Filename handlers might have to remove this switch if their
5264;; "ls" command does not support it.
c3554e95 5265(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 5266 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 5267Leaves point after the inserted text.
8f8607be
LT
5268SWITCHES may be a string of options, or a list of strings
5269representing individual options.
c3554e95
RS
5270Optional third arg WILDCARD means treat FILE as shell wildcard.
5271Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5272switches do not contain `d', so that a full listing is expected.
5273
5274This works by running a directory listing program
406e12d9 5275whose name is in the variable `insert-directory-program'.
8f8607be
LT
5276If WILDCARD, it also runs the shell specified by `shell-file-name'.
5277
60ce7e3e 5278When SWITCHES contains the long `--dired' option, this function
8f8607be
LT
5279treats it specially, for the sake of dired. However, the
5280normally equivalent short `-D' option is just passed on to
5281`insert-directory-program', as any other option."
c870ab8e 5282 ;; We need the directory in order to find the right handler.
d2473540
AS
5283 (let ((handler (find-file-name-handler (expand-file-name file)
5284 'insert-directory)))
ebad92dc 5285 (if handler
c3554e95
RS
5286 (funcall handler 'insert-directory file switches
5287 wildcard full-directory-p)
b4da00e9 5288 (if (eq system-type 'vax-vms)
c3554e95 5289 (vms-read-directory file switches (current-buffer))
818286f4 5290 (let (result (beg (point)))
ebad92dc
RS
5291
5292 ;; Read the actual directory using `insert-directory-program'.
5293 ;; RESULT gets the status code.
99f01c91
KH
5294 (let* (;; We at first read by no-conversion, then after
5295 ;; putting text property `dired-filename, decode one
5296 ;; bunch by one to preserve that property.
5297 (coding-system-for-read 'no-conversion)
5298 ;; This is to control encoding the arguments in call-process.
c60ee5e7 5299 (coding-system-for-write
82e22b57
KH
5300 (and enable-multibyte-characters
5301 (or file-name-coding-system
99f01c91 5302 default-file-name-coding-system))))
ebad92dc
RS
5303 (setq result
5304 (if wildcard
5305 ;; Run ls in the directory part of the file pattern
5306 ;; using the last component as argument.
5307 (let ((default-directory
5308 (if (file-name-absolute-p file)
5309 (file-name-directory file)
5310 (file-name-directory (expand-file-name file))))
5311 (pattern (file-name-nondirectory file)))
5312 (call-process
5313 shell-file-name nil t nil
5314 "-c"
5315 (concat (if (memq system-type '(ms-dos windows-nt))
5316 ""
5317 "\\") ; Disregard Unix shell aliases!
5318 insert-directory-program
5319 " -d "
5320 (if (stringp switches)
5321 switches
5322 (mapconcat 'identity switches " "))
5323 " -- "
5324 ;; Quote some characters that have
5325 ;; special meanings in shells; but
5326 ;; don't quote the wildcards--we want
5327 ;; them to be special. We also
5328 ;; currently don't quote the quoting
5329 ;; characters in case people want to
5330 ;; use them explicitly to quote
5331 ;; wildcard characters.
5332 (shell-quote-wildcard-pattern pattern))))
5333 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5334 ;; directory if FILE is a symbolic link.
5335 (apply 'call-process
5336 insert-directory-program nil t nil
5337 (append
5338 (if (listp switches) switches
5339 (unless (equal switches "")
5340 ;; Split the switches at any spaces so we can
5341 ;; pass separate options as separate args.
5342 (split-string switches)))
5343 ;; Avoid lossage if FILE starts with `-'.
5344 '("--")
5345 (progn
5346 (if (string-match "\\`~" file)
5347 (setq file (expand-file-name file)))
5348 (list
5349 (if full-directory-p
5350 (concat (file-name-as-directory file) ".")
5351 file))))))))
5352
a1b0c2a7
RS
5353 ;; If we got "//DIRED//" in the output, it means we got a real
5354 ;; directory listing, even if `ls' returned nonzero.
5355 ;; So ignore any errors.
5356 (when (if (stringp switches)
5357 (string-match "--dired\\>" switches)
5358 (member "--dired" switches))
5359 (save-excursion
5360 (forward-line -2)
5361 (when (looking-at "//SUBDIRED//")
5362 (forward-line -1))
5363 (if (looking-at "//DIRED//")
5364 (setq result 0))))
5365
5366 (when (and (not (eq 0 result))
5367 (eq insert-directory-ls-version 'unknown))
5368 ;; The first time ls returns an error,
5369 ;; find the version numbers of ls,
5370 ;; and set insert-directory-ls-version
5371 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5372 ;; is equal or if the info cannot be obtained.
5373 ;; (That can mean it isn't GNU ls.)
5374 (let ((version-out
5375 (with-temp-buffer
5376 (call-process "ls" nil t nil "--version")
5377 (buffer-string))))
5378 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5379 (let* ((version (match-string 1 version-out))
5380 (split (split-string version "[.]"))
027a4b6b 5381 (numbers (mapcar 'string-to-number split))
a1b0c2a7
RS
5382 (min '(5 2 1))
5383 comparison)
5384 (while (and (not comparison) (or numbers min))
5385 (cond ((null min)
5386 (setq comparison '>))
5387 ((null numbers)
5388 (setq comparison '<))
5389 ((> (car numbers) (car min))
5390 (setq comparison '>))
5391 ((< (car numbers) (car min))
5392 (setq comparison '<))
5393 (t
5394 (setq numbers (cdr numbers)
5395 min (cdr min)))))
5396 (setq insert-directory-ls-version (or comparison '=)))
5397 (setq insert-directory-ls-version nil))))
5398
5399 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5400 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5401 (setq result 0))
5402
ebad92dc 5403 ;; If `insert-directory-program' failed, signal an error.
15502042 5404 (unless (eq 0 result)
f2440e42
RS
5405 ;; Delete the error message it may have output.
5406 (delete-region beg (point))
15502042
EZ
5407 ;; On non-Posix systems, we cannot open a directory, so
5408 ;; don't even try, because that will always result in
5409 ;; the ubiquitous "Access denied". Instead, show the
5410 ;; command line so the user can try to guess what went wrong.
5411 (if (and (file-directory-p file)
5412 (memq system-type '(ms-dos windows-nt)))
5413 (error
5414 "Reading directory: \"%s %s -- %s\" exited with status %s"
5415 insert-directory-program
5416 (if (listp switches) (concat switches) switches)
5417 file result)
5418 ;; Unix. Access the file to get a suitable error.
5419 (access-file file "Reading directory")
5420 (error "Listing directory failed but `access-file' worked")))
ebad92dc 5421
8f8607be
LT
5422 (when (if (stringp switches)
5423 (string-match "--dired\\>" switches)
5424 (member "--dired" switches))
9bb99df6
LT
5425 ;; The following overshoots by one line for an empty
5426 ;; directory listed with "--dired", but without "-a"
5427 ;; switch, where the ls output contains a
5428 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5429 ;; We take care of that case later.
ff7affeb 5430 (forward-line -2)
9423860f
AS
5431 (when (looking-at "//SUBDIRED//")
5432 (delete-region (point) (progn (forward-line 1) (point)))
5433 (forward-line -1))
9bb99df6
LT
5434 (if (looking-at "//DIRED//")
5435 (let ((end (line-end-position))
5436 (linebeg (point))
5437 error-lines)
5438 ;; Find all the lines that are error messages,
5439 ;; and record the bounds of each one.
5440 (goto-char beg)
5441 (while (< (point) linebeg)
5442 (or (eql (following-char) ?\s)
5443 (push (list (point) (line-end-position)) error-lines))
5444 (forward-line 1))
5445 (setq error-lines (nreverse error-lines))
5446 ;; Now read the numeric positions of file names.
5447 (goto-char linebeg)
5448 (forward-word 1)
5449 (forward-char 3)
5450 (while (< (point) end)
5451 (let ((start (insert-directory-adj-pos
5452 (+ beg (read (current-buffer)))
5453 error-lines))
5454 (end (insert-directory-adj-pos
a1b0c2a7 5455 (+ beg (read (current-buffer)))
9bb99df6 5456 error-lines)))
26b9ecbc 5457 (if (memq (char-after end) '(?\n ?\s))
9bb99df6
LT
5458 ;; End is followed by \n or by " -> ".
5459 (put-text-property start end 'dired-filename t)
5460 ;; It seems that we can't trust ls's output as to
5461 ;; byte positions of filenames.
5462 (put-text-property beg (point) 'dired-filename nil)
5463 (end-of-line))))
5464 (goto-char end)
5465 (beginning-of-line)
5466 (delete-region (point) (progn (forward-line 1) (point))))
5467 ;; Take care of the case where the ls output contains a
5468 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5469 ;; and we went one line too far back (see above).
5470 (forward-line 1))
5471 (if (looking-at "//DIRED-OPTIONS//")
5472 (delete-region (point) (progn (forward-line 1) (point)))))
ff7affeb 5473
99f01c91 5474 ;; Now decode what read if necessary.
b6647390
KH
5475 (let ((coding (or coding-system-for-read
5476 file-name-coding-system
5477 default-file-name-coding-system
5478 'undecided))
0bded065 5479 coding-no-eol
99f01c91 5480 val pos)
b6647390
KH
5481 (when (and enable-multibyte-characters
5482 (not (memq (coding-system-base coding)
5483 '(raw-text no-conversion))))
5484 ;; If no coding system is specified or detection is
5485 ;; requested, detect the coding.
5486 (if (eq (coding-system-base coding) 'undecided)
5487 (setq coding (detect-coding-region beg (point) t)))
5488 (if (not (eq (coding-system-base coding) 'undecided))
5489 (save-restriction
0bded065
AS
5490 (setq coding-no-eol
5491 (coding-system-change-eol-conversion coding 'unix))
b6647390
KH
5492 (narrow-to-region beg (point))
5493 (goto-char (point-min))
5494 (while (not (eobp))
5495 (setq pos (point)
5496 val (get-text-property (point) 'dired-filename))
5497 (goto-char (next-single-property-change
5498 (point) 'dired-filename nil (point-max)))
0bded065
AS
5499 ;; Force no eol conversion on a file name, so
5500 ;; that CR is preserved.
5501 (decode-coding-region pos (point)
5502 (if val coding-no-eol coding))
b6647390
KH
5503 (if val
5504 (put-text-property pos (point)
5505 'dired-filename t)))))))
99f01c91 5506
75bb5ca4
AS
5507 (if full-directory-p
5508 ;; Try to insert the amount of free space.
5509 (save-excursion
5510 (goto-char beg)
5511 ;; First find the line to put it on.
5512 (when (re-search-forward "^ *\\(total\\)" nil t)
5513 (let ((available (get-free-disk-space ".")))
5514 (when available
5515 ;; Replace "total" with "used", to avoid confusion.
5516 (replace-match "total used in directory" nil nil nil 1)
5517 (end-of-line)
5518 (insert " available " available)))))))))))
34342a07 5519
a1b0c2a7 5520(defun insert-directory-adj-pos (pos error-lines)
fead94d6 5521 "Convert `ls --dired' file name position value POS to a buffer position.
a1b0c2a7
RS
5522File name position values returned in ls --dired output
5523count only stdout; they don't count the error messages sent to stderr.
5524So this function converts to them to real buffer positions.
5525ERROR-LINES is a list of buffer positions of error message lines,
5526of the form (START END)."
5527 (while (and error-lines (< (caar error-lines) pos))
5528 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5529 (pop error-lines))
5530 pos)
5531
bc22fd18
EZ
5532(defun insert-directory-safely (file switches
5533 &optional wildcard full-directory-p)
5534 "Insert directory listing for FILE, formatted according to SWITCHES.
5535
5536Like `insert-directory', but if FILE does not exist, it inserts a
5537message to that effect instead of signaling an error."
5538 (if (file-exists-p file)
5539 (insert-directory file switches wildcard full-directory-p)
5540 ;; Simulate the message printed by `ls'.
5541 (insert (format "%s: No such file or directory\n" file))))
5542
88902b35 5543(defvar kill-emacs-query-functions nil
65d5c6de 5544 "Functions to call with no arguments to query about killing Emacs.
78c793d1 5545If any of these functions returns nil, killing Emacs is cancelled.
6daab4ed
JB
5546`save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5547the low level primitive, does not. See also `kill-emacs-hook'.")
88902b35 5548
11f15305 5549(defcustom confirm-kill-emacs nil
9c2ba08f
EZ
5550 "How to ask for confirmation when leaving Emacs.
5551If nil, the default, don't ask at all. If the value is non-nil, it should
5552be a predicate function such as `yes-or-no-p'."
11f15305
GM
5553 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5554 (const :tag "Ask with y-or-n-p" y-or-n-p)
5555 (const :tag "Don't confirm" nil))
bdd9ab6e 5556 :group 'convenience
11f15305
GM
5557 :version "21.1")
5558
b4da00e9
RM
5559(defun save-buffers-kill-emacs (&optional arg)
5560 "Offer to save each buffer, then kill this Emacs process.
5561With prefix arg, silently save all file-visiting buffers, then kill."
5562 (interactive "P")
5563 (save-some-buffers arg t)
5564 (and (or (not (memq t (mapcar (function
5565 (lambda (buf) (and (buffer-file-name buf)
5566 (buffer-modified-p buf))))
5567 (buffer-list))))
5568 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5569 (or (not (fboundp 'process-list))
5570 ;; process-list is not defined on VMS.
5571 (let ((processes (process-list))
5572 active)
5573 (while processes
48a4a1fb
KS
5574 (and (memq (process-status (car processes)) '(run stop open listen))
5575 (process-query-on-exit-flag (car processes))
b4da00e9
RM
5576 (setq active t))
5577 (setq processes (cdr processes)))
5578 (or (not active)
48a4a1fb 5579 (list-processes t)
b4da00e9 5580 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 5581 ;; Query the user for other things, perhaps.
fb15c113 5582 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
11f15305
GM
5583 (or (null confirm-kill-emacs)
5584 (funcall confirm-kill-emacs "Really exit Emacs? "))
b4da00e9 5585 (kill-emacs)))
59e085e0 5586
6ed8eeff 5587(defun save-buffers-kill-terminal (&optional arg)
59e085e0
KL
5588 "Offer to save each buffer, then kill the current connection.
5589If the current frame has no client, kill Emacs itself.
5590
5591With prefix arg, silently save all file-visiting buffers, then kill.
5592
5593If emacsclient was started with a list of filenames to edit, then
5594only these files will be asked to be saved."
5595 (interactive "P")
5596 (let ((proc (frame-parameter (selected-frame) 'client))
5597 (frame (selected-frame)))
5598 (if (null proc)
5599 (save-buffers-kill-emacs)
6ed8eeff 5600 (server-save-buffers-kill-terminal proc arg))))
59e085e0 5601
b4da00e9 5602\f
ffc0e1ca 5603;; We use /: as a prefix to "quote" a file name
47afc068
RS
5604;; so that magic file name handlers will not apply to it.
5605
5606(setq file-name-handler-alist
5607 (cons '("\\`/:" . file-name-non-special)
5608 file-name-handler-alist))
5609
5610;; We depend on being the last handler on the list,
5611;; so that anything else which does need handling
5612;; has been handled already.
5613;; So it is safe for us to inhibit *all* magic file name handlers.
5614
5615(defun file-name-non-special (operation &rest arguments)
5616 (let ((file-name-handler-alist nil)
5cb1f728
KH
5617 (default-directory
5618 (if (eq operation 'insert-directory)
5619 (directory-file-name
ffc0e1ca 5620 (expand-file-name
5cb1f728
KH
5621 (unhandled-file-name-directory default-directory)))
5622 default-directory))
47afc068
RS
5623 ;; Get a list of the indices of the args which are file names.
5624 (file-arg-indices
5625 (cdr (or (assq operation
ae3b2983 5626 ;; The first six are special because they
47afc068
RS
5627 ;; return a file name. We want to include the /:
5628 ;; in the return value.
5629 ;; So just avoid stripping it in the first place.
5630 '((expand-file-name . nil)
5631 (file-name-directory . nil)
5632 (file-name-as-directory . nil)
5633 (directory-file-name . nil)
c736f678 5634 (file-name-sans-versions . nil)
ae3b2983 5635 (find-backup-file-name . nil)
c736f678 5636 ;; `identity' means just return the first arg
6750c852
RS
5637 ;; not stripped of its quoting.
5638 (substitute-in-file-name identity)
ae3b2983
MA
5639 ;; `add' means add "/:" to the result.
5640 (file-truename add 0)
5641 ;; `quote' means add "/:" to buffer-file-name.
5642 (insert-file-contents quote 0)
5643 ;; `unquote-then-quote' means set buffer-file-name
5644 ;; temporarily to unquoted filename.
5645 (verify-visited-file-modtime unquote-then-quote)
5646 ;; List the arguments which are filenames.
c37adaa5
SM
5647 (file-name-completion 1)
5648 (file-name-all-completions 1)
ae3b2983 5649 (write-region 2 5)
47afc068
RS
5650 (rename-file 0 1)
5651 (copy-file 0 1)
5652 (make-symbolic-link 0 1)
5653 (add-name-to-file 0 1)))
5654 ;; For all other operations, treat the first argument only
5655 ;; as the file name.
5656 '(nil 0))))
6750c852 5657 method
47afc068
RS
5658 ;; Copy ARGUMENTS so we can replace elements in it.
5659 (arguments (copy-sequence arguments)))
6750c852
RS
5660 (if (symbolp (car file-arg-indices))
5661 (setq method (pop file-arg-indices)))
5662 ;; Strip off the /: from the file names that have it.
47afc068 5663 (save-match-data
18b9dced 5664 (while (consp file-arg-indices)
fe4d9852
KH
5665 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5666 (and (car pair)
5667 (string-match "\\`/:" (car pair))
5668 (setcar pair
5669 (if (= (length (car pair)) 2)
5670 "/"
5671 (substring (car pair) 2)))))
47afc068 5672 (setq file-arg-indices (cdr file-arg-indices))))
6750c852
RS
5673 (cond ((eq method 'identity)
5674 (car arguments))
ae3b2983 5675 ((eq method 'add)
6750c852 5676 (concat "/:" (apply operation arguments)))
ae3b2983 5677 ((eq method 'quote)
e8f30180
RS
5678 (unwind-protect
5679 (apply operation arguments)
ae3b2983
MA
5680 (setq buffer-file-name (concat "/:" buffer-file-name))))
5681 ((eq method 'unquote-then-quote)
5682 (let (res)
5683 (setq buffer-file-name (substring buffer-file-name 2))
5684 (setq res (apply operation arguments))
5685 (setq buffer-file-name (concat "/:" buffer-file-name))
5686 res))
6750c852
RS
5687 (t
5688 (apply operation arguments)))))
47afc068 5689\f
90d10f16
MC
5690;; Symbolic modes and read-file-modes.
5691
5692(defun file-modes-char-to-who (char)
5693 "Convert CHAR to a who-mask from a symbolic mode notation.
5694CHAR is in [ugoa] and represents the users on which rights are applied."
5695 (cond ((= char ?u) #o4700)
5696 ((= char ?g) #o2070)
5697 ((= char ?o) #o1007)
5698 ((= char ?a) #o7777)
5699 (t (error "%c: bad `who' character" char))))
5700
5701(defun file-modes-char-to-right (char &optional from)
5702 "Convert CHAR to a right-mask from a symbolic mode notation.
5703CHAR is in [rwxXstugo] and represents a right.
5704If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5705 (or from (setq from 0))
5706 (cond ((= char ?r) #o0444)
5707 ((= char ?w) #o0222)
5708 ((= char ?x) #o0111)
5709 ((= char ?s) #o1000)
5710 ((= char ?t) #o6000)
5711 ;; Rights relative to the previous file modes.
5712 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5713 ((= char ?u) (let ((uright (logand #o4700 from)))
5714 (+ uright (/ uright #o10) (/ uright #o100))))
5715 ((= char ?g) (let ((gright (logand #o2070 from)))
5716 (+ gright (/ gright #o10) (* gright #o10))))
5717 ((= char ?o) (let ((oright (logand #o1007 from)))
5718 (+ oright (* oright #o10) (* oright #o100))))
5719 (t (error "%c: bad right character" char))))
5720
5721(defun file-modes-rights-to-number (rights who-mask &optional from)
5722 "Convert a right string to a right-mask from a symbolic modes notation.
5723RIGHTS is the right string, it should match \"([+=-][rwxXstugo]+)+\".
5724WHO-MASK is the mask number of the users on which the rights are to be applied.
5725FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5726 (let* ((num-rights (or from 0))
5727 (list-rights (string-to-list rights))
5728 (op (pop list-rights)))
5729 (while (memq op '(?+ ?- ?=))
5730 (let ((num-right 0)
5731 char-right)
5732 (while (memq (setq char-right (pop list-rights))
5733 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5734 (setq num-right
5735 (logior num-right
5736 (file-modes-char-to-right char-right num-rights))))
5737 (setq num-right (logand who-mask num-right)
5738 num-rights
5739 (cond ((= op ?+) (logior num-rights num-right))
5740 ((= op ?-) (logand num-rights (lognot num-right)))
5741 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5742 op char-right)))
5743 num-rights))
5744
5745(defun file-modes-symbolic-to-number (modes &optional from)
5746 "Convert symbolic file modes to numeric file modes.
5747MODES is the string to convert, it should match
5748\"[ugoa]*([+-=][rwxXstugo]+)+,...\".
5749See (info \"(coreutils)File permissions\") for more information on this
5750notation.
5751FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5752 (save-match-data
5753 (let ((case-fold-search nil)
5754 (num-modes (or from 0)))
5755 (while (/= (string-to-char modes) 0)
5756 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes)
5757 (let ((num-who (apply 'logior 0
5758 (mapcar 'file-modes-char-to-who
5759 (match-string 1 modes)))))
5760 (when (= num-who 0)
5761 (setq num-who (default-file-modes)))
5762 (setq num-modes
5763 (file-modes-rights-to-number (substring modes (match-end 1))
5764 num-who num-modes)
5765 modes (substring modes (match-end 3))))
5766 (error "Parse error in modes near `%s'" (substring modes 0))))
5767 num-modes)))
5768
5769(defun read-file-modes (&optional prompt orig-file)
5770 "Read file modes in octal or symbolic notation.
5771PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5772ORIG-FILE is the original file of which modes will be change."
5773 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
5774 (error "File not found")))
5775 (value (read-string (or prompt "File modes (octal or symbolic): "))))
5776 (save-match-data
5777 (if (string-match "^[0-7]+" value)
5778 (string-to-number value 8)
5779 (file-modes-symbolic-to-number value modes)))))
5780
5781\f
b4da00e9 5782(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
5783(define-key ctl-x-map "\C-r" 'find-file-read-only)
5784(define-key ctl-x-map "\C-v" 'find-alternate-file)
5785(define-key ctl-x-map "\C-s" 'save-buffer)
5786(define-key ctl-x-map "s" 'save-some-buffers)
5787(define-key ctl-x-map "\C-w" 'write-file)
5788(define-key ctl-x-map "i" 'insert-file)
5789(define-key esc-map "~" 'not-modified)
5790(define-key ctl-x-map "\C-d" 'list-directory)
6ed8eeff 5791(define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
d758359d 5792(define-key ctl-x-map "\C-q" 'toggle-read-only)
b4da00e9
RM
5793
5794(define-key ctl-x-4-map "f" 'find-file-other-window)
5795(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5796(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5797(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 5798(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 5799
f98955ea
JB
5800(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5801(define-key ctl-x-5-map "f" 'find-file-other-frame)
5802(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5803(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
3095ccf5 5804(define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
c0274f38 5805
c3f6aa20 5806;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
c0274f38 5807;;; files.el ends here