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