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