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