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