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