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