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