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