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