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