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