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