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