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