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