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