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