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