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