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