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