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