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