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