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