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