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