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