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