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