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