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