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