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