*** empty log message ***
[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)))
7defe888
RS
1289 (let ((buffer (current-buffer)))
1290 (if rawfile
1291 (progn
1292 (set-buffer-multibyte nil)
1293 (setq buffer-file-coding-system 'no-conversion)
1294 (make-local-variable 'find-file-literally)
1295 (setq find-file-literally t))
1296 (after-find-file error (not nowarn)))
1297 buffer))))
9b8ef27d
RS
1298\f
1299(defun insert-file-contents-literally (filename &optional visit beg end replace)
1300 "Like `insert-file-contents', but only reads in the file literally.
1301A buffer may be modified in several ways after reading into the buffer,
1302to Emacs features such as format decoding, character code
d5798fa7 1303conversion, `find-file-hooks', automatic uncompression, etc.
9b8ef27d
RS
1304
1305This function ensures that none of these modifications will take place."
1306 (let ((format-alist nil)
1307 (after-insert-file-functions nil)
1308 (coding-system-for-read 'no-conversion)
1309 (coding-system-for-write 'no-conversion)
9b8ef27d
RS
1310 (find-buffer-file-type-function
1311 (if (fboundp 'find-buffer-file-type)
1312 (symbol-function 'find-buffer-file-type)
7e365285
DL
1313 nil))
1314 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
1315 (inhibit-file-name-operation 'insert-file-contents))
9b8ef27d
RS
1316 (unwind-protect
1317 (progn
1318 (fset 'find-buffer-file-type (lambda (filename) t))
1319 (insert-file-contents filename visit beg end replace))
1320 (if find-buffer-file-type-function
1321 (fset 'find-buffer-file-type find-buffer-file-type-function)
1322 (fmakunbound 'find-buffer-file-type)))))
1323
1324(defun insert-file-literally (filename)
1325 "Insert contents of file FILENAME into buffer after point with no conversion.
1326
1327This function is meant for the user to run interactively.
1328Don't call it from programs! Use `insert-file-contents-literally' instead.
1329\(Its calling sequence is different; see its documentation)."
1330 (interactive "*fInsert file literally: ")
1331 (if (file-directory-p filename)
1332 (signal 'file-error (list "Opening input file" "file is a directory"
1333 filename)))
1334 (let ((tem (insert-file-contents-literally filename)))
1335 (push-mark (+ (point) (car (cdr tem))))))
1336
1337(defvar find-file-literally nil
1338 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1339This is a permanent local.")
1340(put 'find-file-literally 'permanent-local t)
5fc196af 1341
ffc0e1ca 1342(defun find-file-literally (filename)
5fc196af
RS
1343 "Visit file FILENAME with no conversion of any kind.
1344Format conversion and character code conversion are both disabled,
1345and multibyte characters are disabled in the resulting buffer.
e65db7b8
RS
1346The major mode used is Fundamental mode regardless of the file name,
1347and local variable specifications in the file are ignored.
407b4328
GM
1348Automatic uncompression and adding a newline at the end of the
1349file due to `require-final-newline' is also disabled.
9b8ef27d
RS
1350
1351You cannot absolutely rely on this function to result in
b9aa9537 1352visiting the file literally. If Emacs already has a buffer
9b8ef27d
RS
1353which is visiting the file, you get the existing buffer,
1354regardless of whether it was created literally or not.
1355
1356In a Lisp program, if you want to be sure of accessing a file's
1357contents literally, you should create a temporary buffer and then read
1358the file contents into it using `insert-file-contents-literally'."
5fc196af 1359 (interactive "FFind file literally: ")
9b8ef27d 1360 (switch-to-buffer (find-file-noselect filename nil t)))
b4da00e9 1361\f
f7d786d0
RS
1362(defvar after-find-file-from-revert-buffer nil)
1363
e0ab8879 1364(defun after-find-file (&optional error warn noauto
9a30563f
RS
1365 after-find-file-from-revert-buffer
1366 nomodes)
b4da00e9
RM
1367 "Called after finding a file and by the default revert function.
1368Sets buffer mode, parses local variables.
8cfb9d46 1369Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
1370error in reading the file. WARN non-nil means warn if there
1371exists an auto-save file more recent than the visited file.
8cfb9d46 1372NOAUTO means don't mess with auto-save mode.
e0ab8879
RS
1373Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1374 means this call was from `revert-buffer'.
9a30563f
RS
1375Fifth arg NOMODES non-nil means don't alter the file's modes.
1376Finishes by calling the functions in `find-file-hooks'
1377unless NOMODES is non-nil."
b4da00e9
RM
1378 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1379 (if noninteractive
1380 nil
1381 (let* (not-serious
1382 (msg
fe50b6ab
GM
1383 (cond
1384 ((not warn) nil)
1385 ((and error (file-attributes buffer-file-name))
1386 (setq buffer-read-only t)
1387 "File exists, but cannot be read")
1388 ((not buffer-read-only)
1389 (if (and warn
1390 ;; No need to warn if buffer is auto-saved
1391 ;; under the name of the visited file.
1392 (not (and buffer-file-name
1393 auto-save-visited-file-name))
1394 (file-newer-than-file-p (or buffer-auto-save-file-name
1395 (make-auto-save-file-name))
1396 buffer-file-name))
1397 (format "%s has auto save data; consider M-x recover-file"
1398 (file-name-nondirectory buffer-file-name))
1399 (setq not-serious t)
1400 (if error "(New file)" nil)))
1401 ((not error)
1402 (setq not-serious t)
1403 "Note: file is write protected")
1404 ((file-attributes (directory-file-name default-directory))
1405 "File not found and directory write-protected")
1406 ((file-exists-p (file-name-directory buffer-file-name))
1407 (setq buffer-read-only nil))
1408 (t
1409 (setq buffer-read-only nil)
1410 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1411 "Use M-x make-directory RET RET to create the directory"
1412 "Use C-u M-x make-directory RET RET to create directory and its parents")))))
1413 (when msg
a74357d4 1414 (message "%s" msg)
fe50b6ab
GM
1415 (or not-serious (sit-for 1 nil t))))
1416 (when (and auto-save-default (not noauto))
1417 (auto-save-mode t)))
ffc0e1ca
AS
1418 ;; Make people do a little extra work (C-x C-q)
1419 ;; before altering a backup file.
fe50b6ab
GM
1420 (when (backup-file-name-p buffer-file-name)
1421 (setq buffer-read-only t))
1422 (unless nomodes
1423 (when (and view-read-only view-mode)
1424 (view-mode-disable))
9a30563f 1425 (normal-mode t)
fe50b6ab
GM
1426 (when (and buffer-read-only
1427 view-read-only
1428 (not (eq (get major-mode 'mode-class) 'special)))
1429 (view-mode-enter))
9a30563f 1430 (run-hooks 'find-file-hooks)))
b4da00e9
RM
1431
1432(defun normal-mode (&optional find-file)
1433 "Choose the major mode for this buffer automatically.
1434Also sets up any specified local variables of the file.
1435Uses the visited file name, the -*- line, and the local variables spec.
1436
1437This function is called automatically from `find-file'. In that case,
aa5fcebf
KH
1438we may set up the file-specified mode and local variables,
1439depending on the value of `enable-local-variables': if it is t, we do;
1440if it is nil, we don't; otherwise, we query.
1441In addition, if `local-enable-local-variables' is nil, we do
1442not set local variables (though we do notice a mode specified with -*-.)
1443
1444`enable-local-variables' is ignored if you run `normal-mode' interactively,
1445or from Lisp without specifying the optional argument FIND-FILE;
1446in that case, this function acts as if `enable-local-variables' were t."
b4da00e9
RM
1447 (interactive)
1448 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1449 (condition-case err
1450 (set-auto-mode)
1451 (error (message "File mode specification error: %s"
1452 (prin1-to-string err))))
1453 (condition-case err
7b3f3dc2
JB
1454 (let ((enable-local-variables (or (not find-file)
1455 enable-local-variables)))
1456 (hack-local-variables))
b4da00e9
RM
1457 (error (message "File local-variables error: %s"
1458 (prin1-to-string err)))))
1459
f76e0cd0 1460(defvar auto-mode-alist
ffc0e1ca
AS
1461 (mapc
1462 (lambda (elt)
1463 (cons (purecopy (car elt)) (cdr elt)))
36236b72
SS
1464 '(("\\.in\\'" nil t)
1465 ("\\.te?xt\\'" . text-mode)
ffc0e1ca
AS
1466 ("\\.c\\'" . c-mode)
1467 ("\\.h\\'" . c-mode)
1468 ("\\.tex\\'" . tex-mode)
1469 ("\\.ltx\\'" . latex-mode)
1470 ("\\.el\\'" . emacs-lisp-mode)
1471 ("\\.scm\\'" . scheme-mode)
1472 ("\\.l\\'" . lisp-mode)
1473 ("\\.lisp\\'" . lisp-mode)
1474 ("\\.f\\'" . fortran-mode)
1475 ("\\.F\\'" . fortran-mode)
1476 ("\\.for\\'" . fortran-mode)
1477 ("\\.p\\'" . pascal-mode)
1478 ("\\.pas\\'" . pascal-mode)
1479 ("\\.ad[abs]\\'" . ada-mode)
7defe888 1480 ("\\.ad[bs].dg\\'" . ada-mode)
5c6d31a4 1481 ("\\.\\([pP]\\([Llm]\\|erl\\)\\|al\\)\\'" . perl-mode)
ffc0e1ca
AS
1482 ("\\.s?html?\\'" . html-mode)
1483 ("\\.cc\\'" . c++-mode)
1484 ("\\.hh\\'" . c++-mode)
1485 ("\\.hpp\\'" . c++-mode)
1486 ("\\.C\\'" . c++-mode)
1487 ("\\.H\\'" . c++-mode)
1488 ("\\.cpp\\'" . c++-mode)
1489 ("\\.cxx\\'" . c++-mode)
1490 ("\\.hxx\\'" . c++-mode)
1491 ("\\.c\\+\\+\\'" . c++-mode)
1492 ("\\.h\\+\\+\\'" . c++-mode)
1493 ("\\.m\\'" . objc-mode)
1494 ("\\.java\\'" . java-mode)
1495 ("\\.mk\\'" . makefile-mode)
36236b72 1496 ("\\(M\\|m\\|GNUm\\)akefile\\'" . makefile-mode)
ffc0e1ca 1497 ("\\.am\\'" . makefile-mode) ;For Automake.
5c6d31a4
SM
1498 ;; Less common extensions come here
1499 ;; so more common ones above are found faster.
ffc0e1ca
AS
1500 ("\\.texinfo\\'" . texinfo-mode)
1501 ("\\.te?xi\\'" . texinfo-mode)
1502 ("\\.s\\'" . asm-mode)
1503 ("\\.S\\'" . asm-mode)
1504 ("\\.asm\\'" . asm-mode)
1505 ("ChangeLog\\'" . change-log-mode)
1506 ("change\\.log\\'" . change-log-mode)
1507 ("changelo\\'" . change-log-mode)
1508 ("ChangeLog\\.[0-9]+\\'" . change-log-mode)
1509 ;; for MSDOS and MS-Windows (which are case-insensitive)
1510 ("changelog\\'" . change-log-mode)
1511 ("changelog\\.[0-9]+\\'" . change-log-mode)
1512 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1513 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1514 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1515 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1516 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1517 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
d5798fa7 1518 ("\\.m?spec\\'" . sh-mode)
ffc0e1ca
AS
1519 ("\\.mm\\'" . nroff-mode)
1520 ("\\.me\\'" . nroff-mode)
1521 ("\\.ms\\'" . nroff-mode)
1522 ("\\.man\\'" . nroff-mode)
1523 ("\\.\\(u?lpc\\|pike\\|pmod\\)\\'" . pike-mode)
ffc0e1ca
AS
1524 ("\\.TeX\\'" . tex-mode)
1525 ("\\.sty\\'" . latex-mode)
1526 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1527 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
1528 ("\\.bbl\\'" . latex-mode)
1529 ("\\.bib\\'" . bibtex-mode)
1530 ("\\.sql\\'" . sql-mode)
1531 ("\\.m4\\'" . m4-mode)
1532 ("\\.mc\\'" . m4-mode)
1533 ("\\.mf\\'" . metafont-mode)
1534 ("\\.mp\\'" . metapost-mode)
1535 ("\\.vhdl?\\'" . vhdl-mode)
1536 ("\\.article\\'" . text-mode)
1537 ("\\.letter\\'" . text-mode)
1538 ("\\.tcl\\'" . tcl-mode)
1539 ("\\.exp\\'" . tcl-mode)
1540 ("\\.itcl\\'" . tcl-mode)
1541 ("\\.itk\\'" . tcl-mode)
1542 ("\\.icn\\'" . icon-mode)
1543 ("\\.sim\\'" . simula-mode)
1544 ("\\.mss\\'" . scribe-mode)
1545 ("\\.f90\\'" . f90-mode)
9211d053 1546 ("\\.f95\\'" . f90-mode)
8f9495e7 1547 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
ffc0e1ca
AS
1548 ("\\.pro\\'" . idlwave-mode)
1549 ("\\.lsp\\'" . lisp-mode)
1550 ("\\.awk\\'" . awk-mode)
1551 ("\\.prolog\\'" . prolog-mode)
1552 ("\\.tar\\'" . tar-mode)
1553 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\)\\'" . archive-mode)
1554 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\)\\'" . archive-mode)
1555 ;; Mailer puts message to be edited in
1556 ;; /tmp/Re.... or Message
1557 ("\\`/tmp/Re" . text-mode)
1558 ("/Message[0-9]*\\'" . text-mode)
1559 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1560 ("\\.zone\\'" . zone-mode)
1561 ;; some news reader is reported to use this
1562 ("\\`/tmp/fol/" . text-mode)
1563 ("\\.y\\'" . c-mode)
1564 ("\\.lex\\'" . c-mode)
1565 ("\\.oak\\'" . scheme-mode)
1566 ("\\.sgml?\\'" . sgml-mode)
1567 ("\\.xml\\'" . sgml-mode)
1568 ("\\.dtd\\'" . sgml-mode)
1569 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1570 ("\\.idl\\'" . idl-mode)
1571 ;; .emacs following a directory delimiter
1572 ;; in Unix, MSDOG or VMS syntax.
1573 ("[]>:/\\]\\..*emacs\\'" . emacs-lisp-mode)
1574 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1575 ;; _emacs following a directory delimiter
1576 ;; in MsDos syntax
1577 ("[:/]_emacs\\'" . emacs-lisp-mode)
1578 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1579 ("\\.ml\\'" . lisp-mode)
d5798fa7
SM
1580 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1581 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
ffc0e1ca 1582 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
e854cc22 1583 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
d5798fa7 1584 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
e55c4863 1585 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
ffc0e1ca
AS
1586 ("BROWSE\\'" . ebrowse-tree-mode)
1587 ("\\.ebrowse\\'" . ebrowse-tree-mode)
9ee45b2c
SM
1588 ("#\\*mail\\*" . mail-mode)
1589 ;; Get rid of any trailing .n.m and try again.
1590 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
5c6d31a4
SM
1591 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1592 ;; Using mode nil rather than `ignore' would let the search continue
1593 ;; through this list (with the shortened name) rather than start over.
1594 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" ignore t)
1595 ;; The following should come after the ChangeLog pattern
1596 ;; for the sake of ChangeLog.1, etc.
1597 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
e043664a 1598 ("\\.[1-9]\\'" . nroff-mode)
7423978d 1599 ("\\.g\\'" . antlr-mode)))
ffc0e1ca 1600 "Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
1601Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1602\(NON-NIL stands for anything that is not nil; the value does not matter.)
1603Visiting a file whose name matches REGEXP specifies FUNCTION as the
1604mode function to use. FUNCTION will be called, unless it is nil.
1605
1606If the element has the form (REGEXP FUNCTION NON-NIL), then after
1607calling FUNCTION (if it's not nil), we delete the suffix that matched
1608REGEXP and search the list again for another match.")
7b3f3dc2 1609
e13322a0 1610
d7fa5aa2 1611(defvar interpreter-mode-alist
ffc0e1ca
AS
1612 (mapc
1613 (lambda (l)
1614 (cons (purecopy (car l)) (cdr l)))
1615 '(("perl" . perl-mode)
1616 ("perl5" . perl-mode)
1617 ("miniperl" . perl-mode)
1618 ("wish" . tcl-mode)
1619 ("wishx" . tcl-mode)
1620 ("tcl" . tcl-mode)
1621 ("tclsh" . tcl-mode)
1622 ("awk" . awk-mode)
1623 ("mawk" . awk-mode)
1624 ("nawk" . awk-mode)
1625 ("gawk" . awk-mode)
1626 ("scm" . scheme-mode)
1627 ("ash" . sh-mode)
1628 ("bash" . sh-mode)
1629 ("bash2" . sh-mode)
1630 ("csh" . sh-mode)
1631 ("dtksh" . sh-mode)
1632 ("es" . sh-mode)
1633 ("itcsh" . sh-mode)
1634 ("jsh" . sh-mode)
1635 ("ksh" . sh-mode)
1636 ("oash" . sh-mode)
1637 ("pdksh" . sh-mode)
1638 ("rc" . sh-mode)
1639 ("rpm" . sh-mode)
1640 ("sh" . sh-mode)
1641 ("sh5" . sh-mode)
1642 ("tcsh" . sh-mode)
1643 ("wksh" . sh-mode)
1644 ("wsh" . sh-mode)
1645 ("zsh" . sh-mode)
1646 ("tail" . text-mode)
1647 ("more" . text-mode)
1648 ("less" . text-mode)
1649 ("pg" . text-mode)
1650 ("make" . makefile-mode) ; Debian uses this
1651 ("guile" . scheme-mode)
1652 ("clisp" . lisp-mode)))
c907d156
RS
1653 "Alist mapping interpreter names to major modes.
1654This alist applies to files whose first line starts with `#!'.
1655Each element looks like (INTERPRETER . MODE).
1656The car of each element is compared with
1657the name of the interpreter specified in the first line.
1658If it matches, mode MODE is selected.")
1659
d7fa5aa2 1660(defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
45fb3bb8 1661 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 1662
d7fa5aa2 1663(defvar inhibit-first-line-modes-suffixes nil
b20ff6d0
RS
1664 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1665When checking `inhibit-first-line-modes-regexps', we first discard
1666from the end of the file name anything that matches one of these regexps.")
1667
ffc0e1ca
AS
1668(defvar auto-mode-interpreter-regexp
1669 "#![ \t]?\\([^ \t\n]*\
1670/bin/env[ \t]\\)?\\([^ \t\n]+\\)"
1671 "Regular expression matching interpreters, for file mode determination.
1672This regular expression is matched against the first line of a file
1673to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1674a mode from the file's name. If it matches, the file is assumed to
1675be interpreted by the interpreter matched by the second group of the
1676regular expression. The mode is then determined as the mode associated
1677with that interpreter in `interpreter-mode-alist'.")
0720b68b 1678
9de9b6a2 1679(defun set-auto-mode (&optional just-from-file-name)
b4da00e9 1680 "Select major mode appropriate for current buffer.
e3998da1
RS
1681This checks for a -*- mode tag in the buffer's text,
1682compares the filename against the entries in `auto-mode-alist',
1683or checks the interpreter that runs this file against
1684`interpreter-mode-alist'.
1685
1686It does not check for the `mode:' local variable in the
1687Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 1688
f3e23606 1689If `enable-local-variables' is nil, this function does not check for a
9de9b6a2
RS
1690-*- mode tag.
1691
1692If the optional argument JUST-FROM-FILE-NAME is non-nil,
1693then we do not set anything but the major mode,
1694and we don't even do that unless it would come from the file name."
b4da00e9 1695 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2d2ab9da 1696 (let (end done modes)
b4da00e9
RM
1697 (save-excursion
1698 (goto-char (point-min))
1699 (skip-chars-forward " \t\n")
9fa7bfe5 1700 (and enable-local-variables
e3f9b9c0 1701 (setq end (set-auto-mode-1))
2d2ab9da
RS
1702 (if (save-excursion (search-forward ":" end t))
1703 ;; Find all specifications for the `mode:' variable
1704 ;; and execute them left to right.
1705 (while (let ((case-fold-search t))
1706 (or (and (looking-at "mode:")
1707 (goto-char (match-end 0)))
1708 (re-search-forward "[ \t;]mode:" end t)))
1709 (skip-chars-forward " \t")
1710 (let ((beg (point)))
9fa7bfe5
RS
1711 (if (search-forward ";" end t)
1712 (forward-char -1)
1713 (goto-char end))
1714 (skip-chars-backward " \t")
9ee45b2c 1715 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2d2ab9da
RS
1716 modes)))
1717 ;; Simple -*-MODE-*- case.
1718 (push (intern (concat (downcase (buffer-substring (point) end))
1719 "-mode"))
1720 modes))))
d0fc03ef
RS
1721 ;; If we found modes to use, invoke them now,
1722 ;; outside the save-excursion.
9ee45b2c
SM
1723 (unless just-from-file-name
1724 (dolist (mode (nreverse modes))
1725 (if (not (functionp mode))
1726 (message "Ignoring unknown mode `%s'" mode)
1727 (setq done t)
1728 (funcall mode))))
d0fc03ef
RS
1729 ;; If we didn't find a mode from a -*- line, try using the file name.
1730 (if (and (not done) buffer-file-name)
1731 (let ((name buffer-file-name)
1732 (keep-going t))
1733 ;; Remove backup-suffixes from file name.
1734 (setq name (file-name-sans-versions name))
1735 (while keep-going
1736 (setq keep-going nil)
1737 (let ((alist auto-mode-alist)
1738 (mode nil))
1739 ;; Find first matching alist entry.
76d5492b 1740 (let ((case-fold-search
d0fc03ef
RS
1741 (memq system-type '(vax-vms windows-nt))))
1742 (while (and (not mode) alist)
1743 (if (string-match (car (car alist)) name)
1744 (if (and (consp (cdr (car alist)))
1745 (nth 2 (car alist)))
ffc0e1ca
AS
1746 (setq mode (car (cdr (car alist)))
1747 name (substring name 0 (match-beginning 0))
1748 keep-going t)
d0fc03ef
RS
1749 (setq mode (cdr (car alist))
1750 keep-going nil)))
1751 (setq alist (cdr alist))))
1752 (if mode
3b9ffb77
RS
1753 ;; When JUST-FROM-FILE-NAME is set,
1754 ;; we are working on behalf of set-visited-file-name.
1755 ;; In that case, if the major mode specified is the
1756 ;; same one we already have, don't actually reset it.
1757 ;; We don't want to lose minor modes such as Font Lock.
1758 (unless (and just-from-file-name (eq mode major-mode))
1759 (funcall mode))
d0fc03ef
RS
1760 ;; If we can't deduce a mode from the file name,
1761 ;; look for an interpreter specified in the first line.
1540e4e9
KH
1762 ;; As a special case, allow for things like "#!/bin/env perl",
1763 ;; which finds the interpreter anywhere in $PATH.
d0fc03ef
RS
1764 (let ((interpreter
1765 (save-excursion
1766 (goto-char (point-min))
ffc0e1ca
AS
1767 (if (looking-at auto-mode-interpreter-regexp)
1768 (match-string 2)
d0fc03ef
RS
1769 "")))
1770 elt)
1771 ;; Map interpreter name to a mode.
1772 (setq elt (assoc (file-name-nondirectory interpreter)
1773 interpreter-mode-alist))
9de9b6a2
RS
1774 (unless just-from-file-name
1775 (if elt
1776 (funcall (cdr elt))))))))))))
b4da00e9 1777
e3f9b9c0
RS
1778
1779(defun set-auto-mode-1 ()
1780 "Find the -*- spec in the buffer.
1781Call with point at the place to start searching from.
1782If one is found, set point to the beginning
1783and return the position of the end.
1784Otherwise, return nil; point may be changed."
1785 (let (beg end)
1786 (and
1787 ;; Don't look for -*- if this file name matches any
1788 ;; of the regexps in inhibit-first-line-modes-regexps.
1789 (let ((temp inhibit-first-line-modes-regexps)
1790 (name (if buffer-file-name
1791 (file-name-sans-versions buffer-file-name)
1792 (buffer-name))))
1793 (while (let ((sufs inhibit-first-line-modes-suffixes))
1794 (while (and sufs (not (string-match (car sufs) name)))
1795 (setq sufs (cdr sufs)))
1796 sufs)
1797 (setq name (substring name 0 (match-beginning 0))))
1798 (while (and temp
1799 (not (string-match (car temp) name)))
1800 (setq temp (cdr temp)))
1801 (not temp))
1802
1803 (search-forward "-*-" (save-excursion
1804 ;; If the file begins with "#!"
1805 ;; (exec interpreter magic), look
1806 ;; for mode frobs in the first two
1807 ;; lines. You cannot necessarily
1808 ;; put them in the first line of
1809 ;; such a file without screwing up
1810 ;; the interpreter invocation.
1811 (end-of-line (and (looking-at "^#!") 2))
1812 (point)) t)
1813 (progn
1814 (skip-chars-forward " \t")
1815 (setq beg (point))
1816 (search-forward "-*-"
1817 (save-excursion (end-of-line) (point))
1818 t))
1819 (progn
1820 (forward-char -3)
1821 (skip-chars-backward " \t")
1822 (setq end (point))
1823 (goto-char beg)
1824 end))))
1825
f3e23606 1826(defun hack-local-variables-prop-line ()
ffc0e1ca
AS
1827 "Set local variables specified in the -*- line.
1828Ignore any specification for `mode:' and `coding:';
1829`set-auto-mode' should already have handled `mode:',
1830`set-auto-coding' should already have handled `coding:'."
f3e23606
RS
1831 (save-excursion
1832 (goto-char (point-min))
13a66180 1833 (let ((result nil)
e3f9b9c0 1834 (end (set-auto-mode-1))
aa5fcebf
KH
1835 (enable-local-variables
1836 (and local-enable-local-variables enable-local-variables)))
f3e23606 1837 ;; Parse the -*- line into the `result' alist.
e3f9b9c0 1838 (cond ((not end)
f3e23606
RS
1839 nil)
1840 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180
KH
1841 ;; Simple form: "-*- MODENAME -*-". Already handled.
1842 nil)
f3e23606
RS
1843 (t
1844 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1845 ;; (last ";" is optional).
f3e23606
RS
1846 (while (< (point) end)
1847 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
ffc0e1ca 1848 (error "Malformed -*- line"))
f3e23606 1849 (goto-char (match-end 0))
1c26a6f3
KH
1850 ;; There used to be a downcase here,
1851 ;; but the manual didn't say so,
1852 ;; and people want to set var names that aren't all lc.
1853 (let ((key (intern (buffer-substring
1854 (match-beginning 1)
1855 (match-end 1))))
f3e23606
RS
1856 (val (save-restriction
1857 (narrow-to-region (point) end)
1858 (read (current-buffer)))))
93a2702d
RS
1859 ;; It is traditional to ignore
1860 ;; case when checking for `mode' in set-auto-mode,
1861 ;; so we must do that here as well.
1862 ;; That is inconsistent, but we're stuck with it.
3fa0a9aa 1863 ;; The same can be said for `coding' in set-auto-coding.
93a2702d 1864 (or (equal (downcase (symbol-name key)) "mode")
3fa0a9aa 1865 (equal (downcase (symbol-name key)) "coding")
13a66180 1866 (setq result (cons (cons key val) result)))
f3e23606
RS
1867 (skip-chars-forward " \t;")))
1868 (setq result (nreverse result))))
76d5492b 1869
f3e23606
RS
1870 (if (and result
1871 (or (eq enable-local-variables t)
1872 (and enable-local-variables
1873 (save-window-excursion
6f931919
RS
1874 (condition-case nil
1875 (switch-to-buffer (current-buffer))
1876 (error
1877 ;; If we fail to switch in the selected window,
1878 ;; it is probably a minibuffer.
1879 ;; So try another window.
1880 (condition-case nil
1881 (switch-to-buffer-other-window (current-buffer))
1882 (error
1883 (switch-to-buffer-other-frame (current-buffer))))))
f3e23606
RS
1884 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1885 (file-name-nondirectory buffer-file-name)))))))
2837b9df
RS
1886 (let ((enable-local-eval enable-local-eval))
1887 (while result
1888 (hack-one-local-variable (car (car result)) (cdr (car result)))
1889 (setq result (cdr result))))))))
f3e23606 1890
1d517019
RS
1891(defvar hack-local-variables-hook nil
1892 "Normal hook run after processing a file's local variables specs.
1893Major modes can use this to examine user-specified local variables
1894in order to initialize other data structure based on them.")
1895
9de9b6a2
RS
1896(defun hack-local-variables (&optional mode-only)
1897 "Parse and put into effect this buffer's local variables spec.
1898If MODE-ONLY is non-nil, all we do is check whether the major mode
1899is specified, returning t if it is specified."
1900 (unless mode-only
1901 (hack-local-variables-prop-line))
b4da00e9 1902 ;; Look for "Local variables:" line in last page.
aa5fcebf
KH
1903 (let (mode-specified
1904 (enable-local-variables
1905 (and local-enable-local-variables enable-local-variables)))
9de9b6a2
RS
1906 (save-excursion
1907 (goto-char (point-max))
1908 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1909 (if (let ((case-fold-search t))
1910 (and (search-forward "Local Variables:" nil t)
1911 (or (eq enable-local-variables t)
1912 mode-only
1913 (and enable-local-variables
1914 (save-window-excursion
1915 (switch-to-buffer (current-buffer))
1916 (save-excursion
1917 (beginning-of-line)
1918 (set-window-start (selected-window) (point)))
1919 (y-or-n-p (format "Set local variables as specified at end of %s? "
1920 (if buffer-file-name
1921 (file-name-nondirectory
1922 buffer-file-name)
1923 (concat "buffer "
1924 (buffer-name))))))))))
1925 (let ((continue t)
1926 prefix prefixlen suffix beg
1927 mode-specified
1928 (enable-local-eval enable-local-eval))
1929 ;; The prefix is what comes before "local variables:" in its line.
1930 ;; The suffix is what comes after "local variables:" in its line.
b4da00e9 1931 (skip-chars-forward " \t")
9de9b6a2
RS
1932 (or (eolp)
1933 (setq suffix (buffer-substring (point)
1934 (progn (end-of-line) (point)))))
1935 (goto-char (match-beginning 0))
1936 (or (bolp)
1937 (setq prefix
1938 (buffer-substring (point)
1939 (progn (beginning-of-line) (point)))))
1940
1941 (if prefix (setq prefixlen (length prefix)
1942 prefix (regexp-quote prefix)))
1943 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1944 (while continue
1945 ;; Look at next local variable spec.
1946 (if selective-display (re-search-forward "[\n\C-m]")
1947 (forward-line 1))
1948 ;; Skip the prefix, if any.
1949 (if prefix
1950 (if (looking-at prefix)
1951 (forward-char prefixlen)
1952 (error "Local variables entry is missing the prefix")))
1953 ;; Find the variable name; strip whitespace.
1954 (skip-chars-forward " \t")
1955 (setq beg (point))
1956 (skip-chars-forward "^:\n")
1957 (if (eolp) (error "Missing colon in local variables entry"))
1958 (skip-chars-backward " \t")
1959 (let* ((str (buffer-substring beg (point)))
1960 (var (read str))
1961 val)
1962 ;; Setting variable named "end" means end of list.
1963 (if (string-equal (downcase str) "end")
1964 (setq continue nil)
1965 ;; Otherwise read the variable value.
1966 (skip-chars-forward "^:")
1967 (forward-char 1)
1968 (setq val (read (current-buffer)))
1969 (skip-chars-backward "\n")
1970 (skip-chars-forward " \t")
1971 (or (if suffix (looking-at suffix) (eolp))
1972 (error "Local variables entry is terminated incorrectly"))
1973 (if mode-only
1974 (if (eq var 'mode)
1975 (setq mode-specified t))
1976 ;; Set the variable. "Variables" mode and eval are funny.
1977 (hack-one-local-variable var val))))))))
1978 (unless mode-only
1979 (run-hooks 'hack-local-variables-hook))
1980 mode-specified))
f3e23606 1981
d7fa5aa2 1982(defvar ignored-local-variables
f3e23606
RS
1983 '(enable-local-eval)
1984 "Variables to be ignored in a file's local variable spec.")
1985
be0218a8 1986;; Get confirmation before setting these variables as locals in a file.
05ef1cda 1987(put 'debugger 'risky-local-variable t)
f6fa3ee3 1988(put 'enable-local-eval 'risky-local-variable t)
fce47eea 1989(put 'ignored-local-variables 'risky-local-variable t)
be0218a8
RS
1990(put 'eval 'risky-local-variable t)
1991(put 'file-name-handler-alist 'risky-local-variable t)
7078d9d2 1992(put 'minor-mode-alist 'risky-local-variable t)
be0218a8 1993(put 'minor-mode-map-alist 'risky-local-variable t)
7078d9d2
RS
1994(put 'minor-mode-overriding-map-alist 'risky-local-variable t)
1995(put 'overriding-local-map 'risky-local-variable t)
1996(put 'overriding-terminal-local-map 'risky-local-variable t)
1997(put 'auto-mode-alist 'risky-local-variable t)
be0218a8 1998(put 'after-load-alist 'risky-local-variable t)
f6fa3ee3 1999(put 'buffer-file-name 'risky-local-variable t)
7078d9d2 2000(put 'buffer-undo-list 'risky-local-variable t)
f6fa3ee3
RS
2001(put 'buffer-auto-save-file-name 'risky-local-variable t)
2002(put 'buffer-file-truename 'risky-local-variable t)
7078d9d2 2003(put 'default-text-properties 'risky-local-variable t)
b0ffcc0d
RS
2004(put 'exec-path 'risky-local-variable t)
2005(put 'load-path 'risky-local-variable t)
2006(put 'exec-directory 'risky-local-variable t)
2007(put 'process-environment 'risky-local-variable t)
eba1c87a
RS
2008(put 'dabbrev-case-fold-search 'risky-local-variable t)
2009(put 'dabbrev-case-replace 'risky-local-variable t)
9afa8bf7
RS
2010;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2011(put 'outline-level 'risky-local-variable t)
d98b741d 2012(put 'rmail-output-file-alist 'risky-local-variable t)
f4d04672 2013(put 'font-lock-defaults 'risky-local-variable t)
7078d9d2
RS
2014(put 'special-display-buffer-names 'risky-local-variable t)
2015(put 'frame-title-format 'risky-local-variable t)
2016(put 'global-mode-string 'risky-local-variable t)
2017(put 'header-line-format 'risky-local-variable t)
2018(put 'icon-title-format 'risky-local-variable t)
2019(put 'input-method-alist 'risky-local-variable t)
032388f3 2020(put 'format-alist 'risky-local-variable t)
7078d9d2
RS
2021(put 'vc-mode 'risky-local-variable t)
2022(put 'imenu-generic-expression 'risky-local-variable t)
2023(put 'imenu-index-alist 'risky-local-variable t)
2024(put 'standard-input 'risky-local-variable t)
2025(put 'standard-output 'risky-local-variable t)
2026(put 'unread-command-events 'risky-local-variable t)
2027(put 'max-lisp-eval-depth 'risky-local-variable t)
2028(put 'max-specpdl-size 'risky-local-variable t)
ec4ba9e3
RS
2029(put 'mode-line-format 'risky-local-variable t)
2030(put 'mode-line-modified 'risky-local-variable t)
2031(put 'mode-line-mule-info 'risky-local-variable t)
2032(put 'mode-line-buffer-identification 'risky-local-variable t)
2033(put 'mode-line-modes 'risky-local-variable t)
2034(put 'mode-line-position 'risky-local-variable t)
2bbbe4f6 2035(put 'display-time-string 'risky-local-variable t)
f6fa3ee3 2036
6672c42b
RS
2037;; This one is safe because the user gets to check it before it is used.
2038(put 'compile-command 'safe-local-variable t)
2039
d0bd3513
RS
2040(defun hack-one-local-variable-quotep (exp)
2041 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2042
f3e23606 2043(defun hack-one-local-variable (var val)
ffc0e1ca 2044 "\"Set\" one variable in a local variables spec.
7078d9d2
RS
2045A few patterns are specified so that any name which matches one
2046is considered risky."
f3e23606
RS
2047 (cond ((eq var 'mode)
2048 (funcall (intern (concat (downcase (symbol-name val))
2049 "-mode"))))
3fa0a9aa
KH
2050 ((eq var 'coding)
2051 ;; We have already handled coding: tag in set-auto-coding.
2052 nil)
f3e23606
RS
2053 ((memq var ignored-local-variables)
2054 nil)
2055 ;; "Setting" eval means either eval it or do nothing.
7d3221d7 2056 ;; Likewise for setting hook variables.
be0218a8 2057 ((or (get var 'risky-local-variable)
6672c42b 2058 (and
ec4ba9e3 2059 (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
2060 (symbol-name var))
2061 (not (get var 'safe-local-variable))))
0225ae5e 2062 ;; Permit evalling a put of a harmless property.
d0bd3513
RS
2063 ;; if the args do nothing tricky.
2064 (if (or (and (eq var 'eval)
2065 (consp val)
2066 (eq (car val) 'put)
2067 (hack-one-local-variable-quotep (nth 1 val))
2068 (hack-one-local-variable-quotep (nth 2 val))
2069 ;; Only allow safe values of lisp-indent-hook;
2070 ;; not functions.
2071 (or (numberp (nth 3 val))
dc417415 2072 (equal (nth 3 val) ''defun))
d0bd3513
RS
2073 (memq (nth 1 (nth 2 val))
2074 '(lisp-indent-hook)))
2075 ;; Permit eval if not root and user says ok.
c7e62660 2076 (and (not (zerop (user-uid)))
d0bd3513
RS
2077 (or (eq enable-local-eval t)
2078 (and enable-local-eval
2079 (save-window-excursion
2080 (switch-to-buffer (current-buffer))
2081 (save-excursion
2082 (beginning-of-line)
2083 (set-window-start (selected-window) (point)))
2084 (setq enable-local-eval
abf16d5e
RS
2085 (y-or-n-p (format "Process `eval' or hook local variables in %s? "
2086 (if buffer-file-name
2087 (concat "file " (file-name-nondirectory buffer-file-name))
2088 (concat "buffer " (buffer-name)))))))))))
7d3221d7
RS
2089 (if (eq var 'eval)
2090 (save-excursion (eval val))
2091 (make-local-variable var)
2092 (set var val))
abf16d5e 2093 (message "Ignoring `eval:' in the local variables list")))
f3e23606
RS
2094 ;; Ordinary variable, really set it.
2095 (t (make-local-variable var)
87a6a5d8
RS
2096 ;; Make sure the string has no text properties.
2097 ;; Some text properties can get evaluated in various ways,
2098 ;; so it is risky to put them on with a local variable list.
2099 (if (stringp val)
2100 (set-text-properties 0 (length val) nil val))
f3e23606
RS
2101 (set var val))))
2102
b4da00e9 2103\f
21540597 2104(defcustom change-major-mode-with-file-name t
9de9b6a2
RS
2105 "*Non-nil means \\[write-file] should set the major mode from the file name.
2106However, the mode will not be changed if
2107\(1) a local variables list or the `-*-' line specifies a major mode, or
2108\(2) the current major mode is a \"special\" mode,
8609911b 2109\ not suitable for ordinary files, or
21540597
RS
2110\(3) the new file name does not particularly specify any mode."
2111 :type 'boolean
2112 :group 'editing-basics)
9de9b6a2 2113
f36012a6 2114(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9
RM
2115 "Change name of file visited in current buffer to FILENAME.
2116The next time the buffer is saved it will go in the newly specified file.
2117nil or empty string as argument means make buffer not be visiting any file.
2118Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
2119if you wish to pass an empty string as the argument.
2120
2121The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
2122confirmation in the case where another buffer is already visiting FILENAME.
2123
2124The optional third argument ALONG-WITH-FILE, if non-nil, means that
2125the old visited file has been renamed to the new name FILENAME."
b4da00e9 2126 (interactive "FSet visited file name: ")
c11a94fe
RS
2127 (if (buffer-base-buffer)
2128 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
2129 (let (truename)
2130 (if filename
2131 (setq filename
2132 (if (string-equal filename "")
2133 nil
2134 (expand-file-name filename))))
2135 (if filename
2136 (progn
2137 (setq truename (file-truename filename))
2138 (if find-file-visit-truename
a522e5bf 2139 (setq filename truename))))
11e314fa 2140 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 2141 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 2142 (not no-query)
7b89d38e
RS
2143 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
2144 filename)))
2145 (error "Aborted")))
a522e5bf
RS
2146 (or (equal filename buffer-file-name)
2147 (progn
2148 (and filename (lock-buffer filename))
2149 (unlock-buffer)))
2150 (setq buffer-file-name filename)
2151 (if filename ; make buffer name reflect filename.
2152 (let ((new-name (file-name-nondirectory buffer-file-name)))
2153 (if (string= new-name "")
2154 (error "Empty file name"))
2155 (if (eq system-type 'vax-vms)
2156 (setq new-name (downcase new-name)))
2157 (setq default-directory (file-name-directory buffer-file-name))
2158 (or (string= new-name (buffer-name))
2159 (rename-buffer new-name t))))
2160 (setq buffer-backed-up nil)
f36012a6
RS
2161 (or along-with-file
2162 (clear-visited-file-modtime))
8ccdc29e 2163 ;; Abbreviate the file names of the buffer.
4826e97f 2164 (if truename
8ccdc29e
RS
2165 (progn
2166 (setq buffer-file-truename (abbreviate-file-name truename))
2167 (if find-file-visit-truename
2168 (setq buffer-file-name buffer-file-truename))))
a522e5bf
RS
2169 (setq buffer-file-number
2170 (if filename
2a47b4f5 2171 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 2172 nil)))
b4da00e9
RM
2173 ;; write-file-hooks is normally used for things like ftp-find-file
2174 ;; that visit things that are not local files as if they were files.
2175 ;; Changing to visit an ordinary local file instead should flush the hook.
2176 (kill-local-variable 'write-file-hooks)
c9dca4e0 2177 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
2178 (kill-local-variable 'revert-buffer-function)
2179 (kill-local-variable 'backup-inhibited)
ee81c959
RS
2180 ;; If buffer was read-only because of version control,
2181 ;; that reason is gone now, so make it writable.
2182 (if vc-mode
2183 (setq buffer-read-only nil))
2184 (kill-local-variable 'vc-mode)
b4da00e9
RM
2185 ;; Turn off backup files for certain file names.
2186 ;; Since this is a permanent local, the major mode won't eliminate it.
4d49551a
KH
2187 (and buffer-file-name
2188 (not (funcall backup-enable-predicate buffer-file-name))
b4da00e9
RM
2189 (progn
2190 (make-local-variable 'backup-inhibited)
2191 (setq backup-inhibited t)))
c77a81cf
RS
2192 (let ((oauto buffer-auto-save-file-name))
2193 ;; If auto-save was not already on, turn it on if appropriate.
2194 (if (not buffer-auto-save-file-name)
2195 (and buffer-file-name auto-save-default
2196 (auto-save-mode t))
2197 ;; If auto save is on, start using a new name.
2198 ;; We deliberately don't rename or delete the old auto save
2199 ;; for the old visited file name. This is because perhaps
2200 ;; the user wants to save the new state and then compare with the
2201 ;; previous state from the auto save file.
2202 (setq buffer-auto-save-file-name
2203 (make-auto-save-file-name)))
2204 ;; Rename the old auto save file if any.
2205 (and oauto buffer-auto-save-file-name
e6f0e76c 2206 (file-exists-p oauto)
c77a81cf 2207 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
2208 (and buffer-file-name
2209 (not along-with-file)
9de9b6a2
RS
2210 (set-buffer-modified-p t))
2211 ;; Update the major mode, if the file name determines it.
2212 (condition-case nil
2213 ;; Don't change the mode if it is special.
2214 (or (not change-major-mode-with-file-name)
2215 (get major-mode 'mode-class)
2216 ;; Don't change the mode if the local variable list specifies it.
2217 (hack-local-variables t)
2218 (set-auto-mode t))
2219 (error nil)))
b4da00e9 2220
912192d1 2221(defun write-file (filename &optional confirm)
b4da00e9 2222 "Write current buffer into file FILENAME.
7f99999a 2223This makes the buffer visit that file, and marks it as not modified.
7458cc35 2224
7f99999a
KH
2225If you specify just a directory name as FILENAME, that means to use
2226the default file name but in that directory. You can also yank
2227the default file name into the minibuffer to edit it, using M-n.
2228
2229If the buffer is not already visiting a file, the default file name
2230for the output file is the buffer name.
2231
2232If optional second arg CONFIRM is non-nil, this function
2233asks for confirmation before overwriting an existing file.
912192d1 2234Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
2235;; (interactive "FWrite file: ")
2236 (interactive
2237 (list (if buffer-file-name
2238 (read-file-name "Write file: "
2239 nil nil nil nil)
7f99999a
KH
2240 (read-file-name "Write file: " default-directory
2241 (expand-file-name
2242 (file-name-nondirectory (buffer-name))
2243 default-directory)
2244 nil nil))
912192d1 2245 (not current-prefix-arg)))
b4da00e9 2246 (or (null filename) (string-equal filename "")
41f48cb1
RS
2247 (progn
2248 ;; If arg is just a directory,
7f99999a
KH
2249 ;; use the default file name, but in that directory.
2250 (if (file-directory-p filename)
41f48cb1 2251 (setq filename (concat (file-name-as-directory filename)
7f99999a
KH
2252 (file-name-nondirectory
2253 (or buffer-file-name (buffer-name))))))
c2fb8488
RS
2254 (and confirm
2255 (file-exists-p filename)
2256 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2257 (error "Canceled")))
5f65549e 2258 (set-visited-file-name filename (not confirm))))
b4da00e9 2259 (set-buffer-modified-p t)
6492b55d
KH
2260 ;; Make buffer writable if file is writable.
2261 (and buffer-file-name
2262 (file-writable-p buffer-file-name)
2263 (setq buffer-read-only nil))
912192d1 2264 (save-buffer))
b4da00e9
RM
2265\f
2266(defun backup-buffer ()
2267 "Make a backup of the disk file visited by the current buffer, if appropriate.
2268This is normally done before saving the buffer the first time.
2269If the value is non-nil, it is the result of `file-modes' on the original
2270file; this means that the caller, after saving the buffer, should change
27ab6944
KH
2271the modes of the new file to agree with the old modes.
2272
2273A backup may be done by renaming or by copying; see documentation of
2274variable `make-backup-files'. If it's done by renaming, then the file is
2275no longer accessible under its old name."
b4da00e9
RM
2276 (if (and make-backup-files (not backup-inhibited)
2277 (not buffer-backed-up)
2278 (file-exists-p buffer-file-name)
2279 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2280 '(?- ?l)))
2281 (let ((real-file-name buffer-file-name)
2282 backup-info backupname targets setmodes)
2283 ;; If specified name is a symbolic link, chase it to the target.
2284 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 2285 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
2286 (setq backup-info (find-backup-file-name real-file-name)
2287 backupname (car backup-info)
2288 targets (cdr backup-info))
5c6d31a4
SM
2289 ;; (if (file-directory-p buffer-file-name)
2290 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
2291 (if backup-info
2292 (condition-case ()
2293 (let ((delete-old-versions
2294 ;; If have old versions to maybe delete,
2295 ;; ask the user to confirm now, before doing anything.
2296 ;; But don't actually delete til later.
2297 (and targets
2298 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2299 (or delete-old-versions
2300 (y-or-n-p (format "Delete excess backup versions of %s? "
2301 real-file-name))))))
2302 ;; Actually write the back up file.
2303 (condition-case ()
2304 (if (or file-precious-flag
ffc0e1ca 2305 ; (file-symlink-p buffer-file-name)
eb650569
RS
2306 backup-by-copying
2307 (and backup-by-copying-when-linked
2308 (> (file-nlinks real-file-name) 1))
ffc0e1ca
AS
2309 (and (or backup-by-copying-when-mismatch
2310 (integerp backup-by-copying-when-privileged-mismatch))
eb650569 2311 (let ((attr (file-attributes real-file-name)))
ffc0e1ca
AS
2312 (and (or backup-by-copying-when-mismatch
2313 (and (integerp (nth 2 attr))
2314 (integerp backup-by-copying-when-privileged-mismatch)
2315 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2316 (or (nth 9 attr)
2317 (not (file-ownership-preserved-p real-file-name)))))))
eb650569
RS
2318 (condition-case ()
2319 (copy-file real-file-name backupname t t)
2320 (file-error
2321 ;; If copying fails because file BACKUPNAME
2322 ;; is not writable, delete that file and try again.
2323 (if (and (file-exists-p backupname)
2324 (not (file-writable-p backupname)))
2325 (delete-file backupname))
2326 (copy-file real-file-name backupname t t)))
2327 ;; rename-file should delete old backup.
2328 (rename-file real-file-name backupname t)
2329 (setq setmodes (file-modes backupname)))
2330 (file-error
2331 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
2332 (setq backupname (expand-file-name
2333 (convert-standard-filename
2334 "~/%backup%~")))
2335 (message "Cannot write backup file; backing up in %s"
2336 (file-name-nondirectory backupname))
eb650569
RS
2337 (sleep-for 1)
2338 (condition-case ()
2339 (copy-file real-file-name backupname t t)
2340 (file-error
2341 ;; If copying fails because file BACKUPNAME
2342 ;; is not writable, delete that file and try again.
2343 (if (and (file-exists-p backupname)
2344 (not (file-writable-p backupname)))
2345 (delete-file backupname))
2346 (copy-file real-file-name backupname t t)))))
2347 (setq buffer-backed-up t)
2348 ;; Now delete the old versions, if desired.
2349 (if delete-old-versions
2350 (while targets
2351 (condition-case ()
2352 (delete-file (car targets))
2353 (file-error nil))
2354 (setq targets (cdr targets))))
2355 setmodes)
2356 (file-error nil))))))
b4da00e9 2357
c3554e95 2358(defun file-name-sans-versions (name &optional keep-backup-version)
ffc0e1ca 2359 "Return file NAME sans backup versions or strings.
b4da00e9 2360This is a separate procedure so your site-init or startup file can
c3554e95
RS
2361redefine it.
2362If the optional argument KEEP-BACKUP-VERSION is non-nil,
2363we do not remove backup version numbers, only true file version numbers."
6eaebaa2 2364 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
2365 (if handler
2366 (funcall handler 'file-name-sans-versions name keep-backup-version)
2367 (substring name 0
2368 (if (eq system-type 'vax-vms)
2369 ;; VMS version number is (a) semicolon, optional
2370 ;; sign, zero or more digits or (b) period, option
2371 ;; sign, zero or more digits, provided this is the
2372 ;; second period encountered outside of the
2373 ;; device/directory part of the file name.
26add1bf
KH
2374 (or (string-match ";[-+]?[0-9]*\\'" name)
2375 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
2376 name)
2377 (match-beginning 1))
2378 (length name))
2379 (if keep-backup-version
2380 (length name)
dbb12f2c 2381 (or (string-match "\\.~[0-9.]+~\\'" name)
c3554e95
RS
2382 (string-match "~\\'" name)
2383 (length name))))))))
b4da00e9 2384
cb0cd911 2385(defun file-ownership-preserved-p (file)
ffc0e1ca 2386 "Return t if deleting FILE and rewriting it would preserve the owner."
cb0cd911
RS
2387 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2388 (if handler
2389 (funcall handler 'file-ownership-preserved-p file)
ec5533be 2390 (let ((attributes (file-attributes file)))
306faa42
RS
2391 ;; Return t if the file doesn't exist, since it's true that no
2392 ;; information would be lost by an (attempted) delete and create.
2393 (or (null attributes)
2394 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 2395
20b5d24c
RS
2396(defun file-name-sans-extension (filename)
2397 "Return FILENAME sans final \"extension\".
2531b0c3
EZ
2398The extension, in a file name, is the part that follows the last `.',
2399except that a leading `.', if any, doesn't count."
20b5d24c
RS
2400 (save-match-data
2401 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2402 directory)
2531b0c3
EZ
2403 (if (and (string-match "\\.[^.]*\\'" file)
2404 (not (eq 0 (match-beginning 0))))
20b5d24c
RS
2405 (if (setq directory (file-name-directory filename))
2406 (expand-file-name (substring file 0 (match-beginning 0))
2407 directory)
2408 (substring file 0 (match-beginning 0)))
2409 filename))))
2410
93a2702d
RS
2411(defun file-name-extension (filename &optional period)
2412 "Return FILENAME's final \"extension\".
2531b0c3
EZ
2413The extension, in a file name, is the part that follows the last `.',
2414except that a leading `.', if any, doesn't count.
93a2702d
RS
2415Return nil for extensionless file names such as `foo'.
2416Return the empty string for file names such as `foo.'.
2417
2418If PERIOD is non-nil, then the returned value includes the period
2419that delimits the extension, and if FILENAME has no extension,
2420the value is \"\"."
2421 (save-match-data
2422 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2531b0c3
EZ
2423 (if (and (string-match "\\.[^.]*\\'" file)
2424 (not (eq 0 (match-beginning 0))))
93a2702d
RS
2425 (substring file (+ (match-beginning 0) (if period 0 1)))
2426 (if period
2427 "")))))
2428
ffc0e1ca
AS
2429(defcustom make-backup-file-name-function nil
2430 "A function to use instead of the default `make-backup-file-name'.
2431A value of nil gives the default `make-backup-file-name' behaviour.
2432
d5798fa7 2433This could be buffer-local to do something special for specific
ffc0e1ca
AS
2434files. If you define it, you may need to change `backup-file-name-p'
2435and `file-name-sans-versions' too.
2436
2437See also `backup-directory-alist'."
2438 :group 'backup
2439 :type '(choice (const :tag "Default" nil)
2440 (function :tag "Your function")))
2441
2442(defcustom backup-directory-alist nil
2443 "Alist of filename patterns and backup directory names.
2444Each element looks like (REGEXP . DIRECTORY). Backups of files with
2445names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2446relative or absolute. If it is absolute, so that all matching files
2447are backed up into the same directory, the file names in this
2448directory will be the full name of the file backed up with all
2449directory separators changed to `!' to prevent clashes. This will not
2450work correctly if your filesystem truncates the resulting name.
2451
2452For the common case of all backups going into one directory, the alist
2453should contain a single element pairing \".\" with the appropriate
2454directory name.
2455
2456If this variable is nil, or it fails to match a filename, the backup
2457is made in the original file's directory.
2458
2459On MS-DOS filesystems without long names this variable is always
2460ignored."
2461 :group 'backup
dca5e71d 2462 :type '(repeat (cons (regexp :tag "Regexp matching filename")
ffc0e1ca
AS
2463 (directory :tag "Backup directory name"))))
2464
388d6ab5
RS
2465(defun normal-backup-enable-predicate (name)
2466 "Default `backup-enable-predicate' function.
2467Checks for files in `temporary-file-directory' or
2468`small-temporary-file-directory'."
2469 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2470 name 0 nil)))
2471 ;; Directory is under temporary-file-directory.
2472 (and (not (eq comp t))
2473 (< comp (- (length temporary-file-directory)))))
2474 (if small-temporary-file-directory
2475 (let ((comp (compare-strings small-temporary-file-directory
2476 0 nil
2477 name 0 nil)))
2478 ;; Directory is under small-temporary-file-directory.
2479 (and (not (eq comp t))
2480 (< comp (- (length small-temporary-file-directory)))))))))
2481
b4da00e9
RM
2482(defun make-backup-file-name (file)
2483 "Create the non-numeric backup file name for FILE.
ffc0e1ca
AS
2484Normally this will just be the file's name with `~' appended.
2485Customization hooks are provided as follows.
2486
2487If the variable `make-backup-file-name-function' is non-nil, its value
2488should be a function which will be called with FILE as its argument;
2489the resulting name is used.
2490
2491Otherwise a match for FILE is sought in `backup-directory-alist'; see
2492the documentation of that variable. If the directory for the backup
2493doesn't exist, it is created."
2494 (if make-backup-file-name-function
2495 (funcall make-backup-file-name-function file)
2496 (if (and (eq system-type 'ms-dos)
2497 (not (msdos-long-file-names)))
2498 (let ((fn (file-name-nondirectory file)))
2499 (concat (file-name-directory file)
2500 (or (and (string-match "\\`[^.]+\\'" fn)
2501 (concat (match-string 0 fn) ".~"))
2502 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2503 (concat (match-string 0 fn) "~")))))
2504 (concat (make-backup-file-name-1 file) "~"))))
2505
2506(defun make-backup-file-name-1 (file)
2507 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2508 (let ((alist backup-directory-alist)
2509 elt backup-directory dir-sep-string)
2510 (while alist
2511 (setq elt (pop alist))
2512 (if (string-match (car elt) file)
2513 (setq backup-directory (cdr elt)
2514 alist nil)))
2515 (if (null backup-directory)
2516 file
2517 (unless (file-exists-p backup-directory)
2518 (condition-case nil
2519 (make-directory backup-directory 'parents)
2520 (file-error file)))
2521 (if (file-name-absolute-p backup-directory)
2522 (progn
2523 (when (memq system-type '(windows-nt ms-dos))
2524 ;; Normalize DOSish file names: convert all slashes to
2525 ;; directory-sep-char, downcase the drive letter, if any,
2526 ;; and replace the leading "x:" with "/drive_x".
2527 (or (file-name-absolute-p file)
2528 (setq file (expand-file-name file))) ; make defaults explicit
2529 ;; Replace any invalid file-name characters (for the
2530 ;; case of backing up remote files).
446c097e 2531 (setq file (expand-file-name (convert-standard-filename file)))
ffc0e1ca 2532 (setq dir-sep-string (char-to-string directory-sep-char))
ffc0e1ca
AS
2533 (if (eq (aref file 1) ?:)
2534 (setq file (concat dir-sep-string
2535 "drive_"
2536 (char-to-string (downcase (aref file 0)))
2537 (if (eq (aref file 2) directory-sep-char)
2538 ""
2539 dir-sep-string)
2540 (substring file 2)))))
2541 ;; Make the name unique by substituting directory
2542 ;; separators. It may not really be worth bothering about
2543 ;; doubling `!'s in the original name...
2544 (expand-file-name
2545 (subst-char-in-string
2546 directory-sep-char ?!
2547 (replace-regexp-in-string "!" "!!" file))
2548 backup-directory))
2549 (expand-file-name (file-name-nondirectory file)
2550 (file-name-as-directory
2551 (expand-file-name backup-directory
2552 (file-name-directory file))))))))
b4da00e9
RM
2553
2554(defun backup-file-name-p (file)
2555 "Return non-nil if FILE is a backup file name (numeric or not).
2556This is a separate function so you can redefine it for customization.
2557You may need to redefine `file-name-sans-versions' as well."
066327ae 2558 (string-match "~\\'" file))
b4da00e9 2559
e2b30772
RS
2560(defvar backup-extract-version-start)
2561
2d051399 2562;; This is used in various files.
a7aa942a
KH
2563;; The usage of backup-extract-version-start is not very clean,
2564;; but I can't see a good alternative, so as of now I am leaving it alone.
2d051399 2565(defun backup-extract-version (fn)
ffc0e1ca 2566 "Given the name of a numeric backup file, FN, return the backup number.
e2b30772 2567Uses the free variable `backup-extract-version-start', whose value should be
2d051399 2568the index in the name where the version number begins."
e2b30772
RS
2569 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2570 (= (match-beginning 0) backup-extract-version-start))
2571 (string-to-int (substring fn backup-extract-version-start -1))
2d051399
RS
2572 0))
2573
b4da00e9
RM
2574;; I believe there is no need to alter this behavior for VMS;
2575;; since backup files are not made on VMS, it should not get called.
2576(defun find-backup-file-name (fn)
ffc0e1ca 2577 "Find a file name for a backup file FN, and suggestions for deletions.
b4da00e9 2578Value is a list whose car is the name for the backup file
ffc0e1ca
AS
2579and whose cdr is a list of old versions to consider deleting now.
2580If the value is nil, don't make a backup.
2581Uses `backup-directory-alist' in the same way as does
2582`make-backup-file-name'."
eb650569
RS
2583 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2584 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2585 (if handler
2586 (funcall handler 'find-backup-file-name fn)
f26d858e
EZ
2587 (if (or (eq version-control 'never)
2588 ;; We don't support numbered backups on plain MS-DOS
2589 ;; when long file names are unavailable.
2590 (and (eq system-type 'ms-dos)
2591 (not (msdos-long-file-names))))
b4da00e9 2592 (list (make-backup-file-name fn))
ffc0e1ca
AS
2593 (let* ((basic-name (make-backup-file-name-1 fn))
2594 (base-versions (concat (file-name-nondirectory basic-name)
2595 ".~"))
e2b30772 2596 (backup-extract-version-start (length base-versions))
eb650569 2597 (high-water-mark 0)
ffc0e1ca
AS
2598 (number-to-delete 0)
2599 possibilities deserve-versions-p versions)
eb650569
RS
2600 (condition-case ()
2601 (setq possibilities (file-name-all-completions
2602 base-versions
ffc0e1ca
AS
2603 (file-name-directory basic-name))
2604 versions (sort (mapcar #'backup-extract-version
2605 possibilities)
2606 #'<)
eb650569
RS
2607 high-water-mark (apply 'max 0 versions)
2608 deserve-versions-p (or version-control
2609 (> high-water-mark 0))
2610 number-to-delete (- (length versions)
ffc0e1ca
AS
2611 kept-old-versions
2612 kept-new-versions
2613 -1))
2614 (file-error (setq possibilities nil)))
eb650569 2615 (if (not deserve-versions-p)
8767d866 2616 (list (make-backup-file-name fn))
ffc0e1ca 2617 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
eb650569
RS
2618 (if (and (> number-to-delete 0)
2619 ;; Delete nothing if there is overflow
2620 ;; in the number of versions to keep.
2621 (>= (+ kept-new-versions kept-old-versions -1) 0))
ffc0e1ca
AS
2622 (mapcar (lambda (n)
2623 (format "%s.~%d~" basic-name n))
eb650569
RS
2624 (let ((v (nthcdr kept-old-versions versions)))
2625 (rplacd (nthcdr (1- number-to-delete) v) ())
2626 v))))))))))
b4da00e9 2627
b4da00e9
RM
2628(defun file-nlinks (filename)
2629 "Return number of names file FILENAME has."
2630 (car (cdr (file-attributes filename))))
6c636af9
RM
2631
2632(defun file-relative-name (filename &optional directory)
ffc0e1ca 2633 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2d6562a5
RS
2634This function returns a relative file name which is equivalent to FILENAME
2635when used with that default directory as the default.
2636If this is impossible (which can happen on MSDOS and Windows
2637when the file name and directory use different drive names)
2638then it returns FILENAME."
96c188b0 2639 (save-match-data
e2b30772
RS
2640 (let ((fname (expand-file-name filename)))
2641 (setq directory (file-name-as-directory
2642 (expand-file-name (or directory default-directory))))
2643 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2644 ;; drive names, they can't be relative, so return the absolute name.
2645 (if (and (or (eq system-type 'ms-dos)
2646 (eq system-type 'windows-nt))
2647 (not (string-equal (substring fname 0 2)
2648 (substring directory 0 2))))
2649 filename
9695aac6
RS
2650 (let ((ancestor ".")
2651 (fname-dir (file-name-as-directory fname)))
2652 (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2653 (not (string-match (concat "^" (regexp-quote directory)) fname)))
e2b30772 2654 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
2655 ancestor (if (equal ancestor ".")
2656 ".."
2657 (concat "../" ancestor))))
2658 ;; Now ancestor is empty, or .., or ../.., etc.
2659 (if (string-match (concat "^" (regexp-quote directory)) fname)
2660 ;; We matched within FNAME's directory part.
2661 ;; Add the rest of FNAME onto ANCESTOR.
2662 (let ((rest (substring fname (match-end 0))))
2663 (if (and (equal ancestor ".")
2664 (not (equal rest "")))
2665 ;; But don't bother with ANCESTOR if it would give us `./'.
2666 rest
2667 (concat (file-name-as-directory ancestor) rest)))
2668 ;; We matched FNAME's directory equivalent.
2669 ancestor))))))
b4da00e9
RM
2670\f
2671(defun save-buffer (&optional args)
2672 "Save current buffer in visited file if modified. Versions described below.
2673By default, makes the previous version into a backup file
2674 if previously requested or if this is the first save.
ac9650be 2675With 1 \\[universal-argument], marks this version
b4da00e9 2676 to become a backup when the next save is done.
ac9650be 2677With 2 \\[universal-argument]'s,
b4da00e9 2678 unconditionally makes the previous version into a backup file.
ac9650be
RS
2679With 3 \\[universal-argument]'s, marks this version
2680 to become a backup when the next save is done,
2681 and unconditionally makes the previous version into a backup file.
2682
749d2ee6 2683With argument of 0, never make the previous version into a backup file.
b4da00e9
RM
2684
2685If a file's name is FOO, the names of its numbered backup versions are
2686 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2687Numeric backups (rather than FOO~) will be made if value of
2688 `version-control' is not the atom `never' and either there are already
2689 numeric versions of the file being backed up, or `version-control' is
2690 non-nil.
2691We don't want excessive versions piling up, so there are variables
2692 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2693 and `kept-new-versions', which tells how many newest versions to keep.
2694 Defaults are 2 old versions and 2 new.
2695`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 2696If `delete-old-versions' is nil, system will query user
e73ec04b
RS
2697 before trimming versions. Otherwise it does it silently.
2698
749d2ee6
RS
2699If `vc-make-backup-files' is nil, which is the default,
2700 no backup files are made for files managed by version control.
2701 (This is because the version control system itself records previous versions.)
2702
e73ec04b 2703See the subroutine `basic-save-buffer' for more information."
b4da00e9
RM
2704 (interactive "p")
2705 (let ((modp (buffer-modified-p))
2706 (large (> (buffer-size) 50000))
b5a8e0fc
RS
2707 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2708 (memq args '(16 64)))))
b4da00e9 2709 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
b4990dde
GM
2710 (if (and modp large (buffer-file-name))
2711 (message "Saving file %s..." (buffer-file-name)))
b4da00e9
RM
2712 (basic-save-buffer)
2713 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2714
2715(defun delete-auto-save-file-if-necessary (&optional force)
2716 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2717Normally delete only if the file was written by this Emacs since
2718the last real save, but optional arg FORCE non-nil means delete anyway."
2719 (and buffer-auto-save-file-name delete-auto-save-files
2720 (not (string= buffer-file-name buffer-auto-save-file-name))
2721 (or force (recent-auto-save-p))
2722 (progn
2723 (condition-case ()
2724 (delete-file buffer-auto-save-file-name)
2725 (file-error nil))
2726 (set-buffer-auto-saved))))
2727
481f215b
KH
2728(defvar auto-save-hook nil
2729 "Normal hook run just before auto-saving.")
2730
ffc0e1ca
AS
2731(defcustom after-save-hook nil
2732 "Normal hook that is run after a buffer is saved to its file."
2733 :options '(executable-make-buffer-file-executable-if-script-p)
2734 :type 'hook
2735 :group 'files)
1cc852cc 2736
0516edee
RS
2737(defvar save-buffer-coding-system nil
2738 "If non-nil, use this coding system for saving the buffer.
2739More precisely, use this coding system in place of the
2740value of `buffer-file-coding-system', when saving the buffer.
2741Calling `write-region' for any purpose other than saving the buffer
2742will still use `buffer-file-coding-system'; this variable has no effect
2743in such cases.")
2744
d5fe94cc
RS
2745(make-variable-buffer-local 'save-buffer-coding-system)
2746(put 'save-buffer-coding-system 'permanent-local t)
2747
b4da00e9 2748(defun basic-save-buffer ()
1cc852cc 2749 "Save the current buffer in its visited file, if it has been modified.
e73ec04b
RS
2750The hooks `write-contents-hooks', `local-write-file-hooks' and
2751`write-file-hooks' get a chance to do the job of saving; if they do not,
2752then the buffer is saved in the visited file file in the usual way.
2753After saving the buffer, this function runs `after-save-hook'."
b4da00e9 2754 (interactive)
19618231 2755 (save-current-buffer
c11a94fe
RS
2756 ;; In an indirect buffer, save its base buffer instead.
2757 (if (buffer-base-buffer)
2758 (set-buffer (buffer-base-buffer)))
2759 (if (buffer-modified-p)
2760 (let ((recent-save (recent-auto-save-p))
2761 setmodes tempsetmodes)
2762 ;; On VMS, rename file and buffer to get rid of version number.
2763 (if (and (eq system-type 'vax-vms)
2764 (not (string= buffer-file-name
2765 (file-name-sans-versions buffer-file-name))))
2766 (let (buffer-new-name)
2767 ;; Strip VMS version number before save.
2768 (setq buffer-file-name
2769 (file-name-sans-versions buffer-file-name))
2770 ;; Construct a (unique) buffer name to correspond.
2771 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2772 (setq buffer-new-name (buffer-name buf))
2773 (kill-buffer buf))
2774 (rename-buffer buffer-new-name)))
2775 ;; If buffer has no file name, ask user for one.
2776 (or buffer-file-name
182891ef
RS
2777 (let ((filename
2778 (expand-file-name
2779 (read-file-name "File to save in: ") nil)))
2780 (and (file-exists-p filename)
2781 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2782 filename))
2783 (error "Canceled")))
2784 (set-visited-file-name filename)))
c11a94fe
RS
2785 (or (verify-visited-file-modtime (current-buffer))
2786 (not (file-exists-p buffer-file-name))
2787 (yes-or-no-p
2788 (format "%s has changed since visited or saved. Save anyway? "
2789 (file-name-nondirectory buffer-file-name)))
2790 (error "Save not confirmed"))
2791 (save-restriction
2792 (widen)
19618231
RS
2793 (save-excursion
2794 (and (> (point-max) 1)
407b4328 2795 (not find-file-literally)
19618231
RS
2796 (/= (char-after (1- (point-max))) ?\n)
2797 (not (and (eq selective-display t)
2798 (= (char-after (1- (point-max))) ?\r)))
2799 (or (eq require-final-newline t)
2800 (and require-final-newline
2801 (y-or-n-p
2802 (format "Buffer %s does not end in newline. Add one? "
2803 (buffer-name)))))
2804 (save-excursion
2805 (goto-char (point-max))
2806 (insert ?\n))))
fa5867f6
AS
2807 ;; Support VC version backups.
2808 (vc-before-save)
c11a94fe
RS
2809 (or (run-hook-with-args-until-success 'write-contents-hooks)
2810 (run-hook-with-args-until-success 'local-write-file-hooks)
2811 (run-hook-with-args-until-success 'write-file-hooks)
0ba5894b
RS
2812 ;; If a hook returned t, file is already "written".
2813 ;; Otherwise, write it the usual way now.
2814 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
2815 ;; Now we have saved the current buffer. Let's make sure
2816 ;; that buffer-file-coding-system is fixed to what
2817 ;; actually used for saving by binding it locally.
0516edee
RS
2818 (if save-buffer-coding-system
2819 (setq save-buffer-coding-system last-coding-system-used)
2820 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
2821 (setq buffer-file-number
2822 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
2823 (if setmodes
2824 (condition-case ()
2825 (set-file-modes buffer-file-name setmodes)
2826 (error nil))))
2827 ;; If the auto-save file was recent before this command,
2828 ;; delete it now.
2829 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
2830 ;; Support VC `implicit' locking.
2831 (vc-after-save)
c11a94fe
RS
2832 (run-hooks 'after-save-hook))
2833 (message "(No changes need to be saved)"))))
b4da00e9 2834
87d26afc
RS
2835;; This does the "real job" of writing a buffer into its visited file
2836;; and making a backup file. This is what is normally done
2837;; but inhibited if one of write-file-hooks returns non-nil.
2838;; It returns a value to store in setmodes.
2839(defun basic-save-buffer-1 ()
d5fe94cc
RS
2840 (if save-buffer-coding-system
2841 (let ((coding-system-for-write save-buffer-coding-system))
2842 (basic-save-buffer-2))
2843 (basic-save-buffer-2)))
2844
2845(defun basic-save-buffer-2 ()
2846 (let (tempsetmodes setmodes)
87d26afc
RS
2847 (if (not (file-writable-p buffer-file-name))
2848 (let ((dir (file-name-directory buffer-file-name)))
2849 (if (not (file-directory-p dir))
83c6f446
RS
2850 (if (file-exists-p dir)
2851 (error "%s is not a directory" dir)
cb2fdcfa 2852 (error "%s: no such directory" buffer-file-name))
87d26afc
RS
2853 (if (not (file-exists-p buffer-file-name))
2854 (error "Directory %s write-protected" dir)
2855 (if (yes-or-no-p
2856 (format "File %s is write-protected; try to save anyway? "
2857 (file-name-nondirectory
2858 buffer-file-name)))
2859 (setq tempsetmodes t)
2860 (error "Attempt to save to a file which you aren't allowed to write"))))))
2861 (or buffer-backed-up
2862 (setq setmodes (backup-buffer)))
76d5492b 2863 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
2864 (if (and file-precious-flag
2865 (file-writable-p dir))
2866 ;; If file is precious, write temp name, then rename it.
2867 ;; This requires write access to the containing dir,
2868 ;; which is why we don't try it if we don't have that access.
2869 (let ((realname buffer-file-name)
6782610c
RS
2870 tempname temp nogood i succeed
2871 (old-modtime (visited-file-modtime)))
f4a0f59b
RS
2872 (setq i 0)
2873 (setq nogood t)
2874 ;; Find the temporary name to write under.
2875 (while nogood
567c1ca9 2876 (setq tempname (format
28ee503c
KH
2877 (if (and (eq system-type 'ms-dos)
2878 (not (msdos-long-file-names)))
567c1ca9 2879 "%s#%d.tm#" ; MSDOS limits files to 8+3
ffc0e1ca
AS
2880 (if (memq system-type '(vax-vms axp-vms))
2881 "%s$tmp$%d"
2882 "%s#tmp#%d"))
567c1ca9 2883 dir i))
f4a0f59b
RS
2884 (setq nogood (file-exists-p tempname))
2885 (setq i (1+ i)))
2886 (unwind-protect
2887 (progn (clear-visited-file-modtime)
2888 (write-region (point-min) (point-max)
89095962
RS
2889 tempname nil realname
2890 buffer-file-truename)
f4a0f59b
RS
2891 (setq succeed t))
2892 ;; If writing the temp file fails,
2893 ;; delete the temp file.
76d5492b 2894 (or succeed
6782610c 2895 (progn
c9783dfe
RS
2896 (condition-case nil
2897 (delete-file tempname)
2898 (file-error nil))
6782610c 2899 (set-visited-file-modtime old-modtime))))
f4a0f59b
RS
2900 ;; Since we have created an entirely new file
2901 ;; and renamed it, make sure it gets the
2902 ;; right permission bits set.
2903 (setq setmodes (file-modes buffer-file-name))
2904 ;; We succeeded in writing the temp file,
2905 ;; so rename it.
2906 (rename-file tempname buffer-file-name t))
2907 ;; If file not writable, see if we can make it writable
2908 ;; temporarily while we write it.
2909 ;; But no need to do so if we have just backed it up
2910 ;; (setmodes is set) because that says we're superseding.
2911 (cond ((and tempsetmodes (not setmodes))
2912 ;; Change the mode back, after writing.
2913 (setq setmodes (file-modes buffer-file-name))
ffc0e1ca 2914 (set-file-modes buffer-file-name (logior setmodes 128))))
f4a0f59b 2915 (write-region (point-min) (point-max)
89095962 2916 buffer-file-name nil t buffer-file-truename)))
87d26afc
RS
2917 setmodes))
2918
ffc0e1ca 2919(defun save-some-buffers (&optional arg pred)
b4da00e9 2920 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1 2921Optional argument (the prefix) non-nil means save all with no questions.
ffc0e1ca
AS
2922Optional second argument PRED determines which buffers are considered:
2923If PRED is nil, all the file-visiting buffers are considered.
2924If PRED is t, then certain non-file buffers will also be considered.
2925If PRED is a zero-argument function, it indicates for each buffer whether
2926to consider it or not when called with that buffer current."
b4da00e9 2927 (interactive "P")
907482b9 2928 (save-window-excursion
76d5492b
RM
2929 (let* ((queried nil)
2930 (files-done
2931 (map-y-or-n-p
2932 (function
2933 (lambda (buffer)
2934 (and (buffer-modified-p buffer)
2935 (not (buffer-base-buffer buffer))
2936 (or
2937 (buffer-file-name buffer)
ffc0e1ca 2938 (and pred
76d5492b
RM
2939 (progn
2940 (set-buffer buffer)
2941 (and buffer-offer-save (> (buffer-size) 0)))))
ffc0e1ca
AS
2942 (or (not (functionp pred))
2943 (with-current-buffer buffer (funcall pred)))
76d5492b
RM
2944 (if arg
2945 t
2946 (setq queried t)
2947 (if (buffer-file-name buffer)
2948 (format "Save file %s? "
2949 (buffer-file-name buffer))
2950 (format "Save buffer %s? "
2951 (buffer-name buffer)))))))
2952 (function
2953 (lambda (buffer)
2954 (set-buffer buffer)
2955 (save-buffer)))
2956 (buffer-list)
2957 '("buffer" "buffers" "save")
2958 (list (list ?\C-r (lambda (buf)
2a9fe1e2
RS
2959 (view-buffer buf
2960 (function
2961 (lambda (ignore)
2962 (exit-recursive-edit))))
76d5492b
RM
2963 (recursive-edit)
2964 ;; Return nil to ask about BUF again.
2965 nil)
2966 "display the current buffer"))))
2967 (abbrevs-done
2968 (and save-abbrevs abbrevs-changed
2969 (progn
2970 (if (or arg
02c6a1cc 2971 (eq save-abbrevs 'silently)
76d5492b
RM
2972 (y-or-n-p (format "Save abbrevs in %s? "
2973 abbrev-file-name)))
2974 (write-abbrev-file nil))
2975 ;; Don't keep bothering user if he says no.
2976 (setq abbrevs-changed nil)
2977 t))))
2978 (or queried (> files-done 0) abbrevs-done
5625c2fc 2979 (message "(No files need saving)")))))
b4da00e9
RM
2980\f
2981(defun not-modified (&optional arg)
2982 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
2983With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2984
2985It is not a good idea to use this function in Lisp programs, because it
2986prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
2987 (interactive "P")
2988 (message (if arg "Modification-flag set"
2989 "Modification-flag cleared"))
2990 (set-buffer-modified-p arg))
2991
2992(defun toggle-read-only (&optional arg)
2993 "Change whether this buffer is visiting its file read-only.
2a9fe1e2
RS
2994With arg, set read-only iff arg is positive.
2995If visiting file read-only and `view-read-only' is non-nil, enter view mode."
b4da00e9 2996 (interactive "P")
2a9fe1e2
RS
2997 (cond
2998 ((and arg (if (> (prefix-numeric-value arg) 0) buffer-read-only
2999 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3000 nil) ; do nothing.
3001 ;; Toggle.
3002 ((and buffer-read-only view-mode)
ca597f41
KH
3003 (View-exit-and-edit)
3004 (make-local-variable 'view-read-only)
3005 (setq view-read-only t)) ; Must leave view mode.
2a9fe1e2
RS
3006 ((and (not buffer-read-only) view-read-only
3007 (not (eq (get major-mode 'mode-class) 'special)))
3008 (view-mode-enter))
3009 (t (setq buffer-read-only (not buffer-read-only))
3010 (force-mode-line-update))))
b4da00e9 3011
912192d1 3012(defun insert-file (filename)
b4da00e9
RM
3013 "Insert contents of file FILENAME into buffer after point.
3014Set mark after the inserted text.
3015
3016This function is meant for the user to run interactively.
3017Don't call it from programs! Use `insert-file-contents' instead.
3018\(Its calling sequence is different; see its documentation)."
912192d1 3019 (interactive "*fInsert file: ")
3be6243a
RS
3020 (if (file-directory-p filename)
3021 (signal 'file-error (list "Opening input file" "file is a directory"
3022 filename)))
912192d1 3023 (let ((tem (insert-file-contents filename)))
b4da00e9
RM
3024 (push-mark (+ (point) (car (cdr tem))))))
3025
912192d1 3026(defun append-to-file (start end filename)
b4da00e9
RM
3027 "Append the contents of the region to the end of file FILENAME.
3028When called from a function, expects three arguments,
3029START, END and FILENAME. START and END are buffer positions
da30bf98 3030saying what text to write."
912192d1
KH
3031 (interactive "r\nFAppend to file: ")
3032 (write-region start end filename t))
b4da00e9
RM
3033
3034(defun file-newest-backup (filename)
3035 "Return most recent backup file for FILENAME or nil if no backups exist."
ffc0e1ca
AS
3036 ;; `make-backup-file-name' will get us the right directory for
3037 ;; ordinary or numeric backups. It might create a directory for
3038 ;; backups as a side-effect, according to `backup-directory-alist'.
e31cfca5
MR
3039 (let* ((filename (file-name-sans-versions
3040 (make-backup-file-name filename)))
b4da00e9
RM
3041 (file (file-name-nondirectory filename))
3042 (dir (file-name-directory filename))
3043 (comp (file-name-all-completions file dir))
cf7e94a0
RS
3044 (newest nil)
3045 tem)
b4da00e9 3046 (while comp
ffc0e1ca 3047 (setq tem (pop comp))
cf7e94a0
RS
3048 (cond ((and (backup-file-name-p tem)
3049 (string= (file-name-sans-versions tem) file))
3050 (setq tem (concat dir tem))
3051 (if (or (null newest)
3052 (file-newer-than-file-p tem newest))
3053 (setq newest tem)))))
b4da00e9
RM
3054 newest))
3055
3056(defun rename-uniquely ()
3057 "Rename current buffer to a similar name not already taken.
3058This function is useful for creating multiple shell process buffers
3059or multiple mail buffers, etc."
3060 (interactive)
40eb8038 3061 (save-match-data
e0df3aef
KH
3062 (let ((base-name (buffer-name)))
3063 (and (string-match "<[0-9]+>\\'" base-name)
3064 (not (and buffer-file-name
3065 (string= base-name
3066 (file-name-nondirectory buffer-file-name))))
3067 ;; If the existing buffer name has a <NNN>,
3068 ;; which isn't part of the file name (if any),
3069 ;; then get rid of that.
3070 (setq base-name (substring base-name 0 (match-beginning 0))))
3071 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 3072 (force-mode-line-update))))
5bbbceb1 3073
4e43240a 3074(defun make-directory (dir &optional parents)
5ce8bb89
RS
3075 "Create the directory DIR and any nonexistent parent dirs.
3076Interactively, the default choice of directory to create
3077is the current default directory for file names.
0225ae5e 3078That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
3079
3080Noninteractively, the second (optional) argument PARENTS says whether
3081to create parent directories if they don't exist."
3082 (interactive
3083 (list (read-file-name "Make directory: " default-directory default-directory
3084 nil nil)
3085 t))
6eaebaa2 3086 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
3087 (if handler
3088 (funcall handler 'make-directory dir parents)
3089 (if (not parents)
3090 (make-directory-internal dir)
3091 (let ((dir (directory-file-name (expand-file-name dir)))
3092 create-list)
3093 (while (not (file-exists-p dir))
76d5492b 3094 (setq create-list (cons dir create-list)
4e43240a
RS
3095 dir (directory-file-name (file-name-directory dir))))
3096 (while create-list
3097 (make-directory-internal (car create-list))
3098 (setq create-list (cdr create-list))))))))
b4da00e9
RM
3099\f
3100(put 'revert-buffer-function 'permanent-local t)
3101(defvar revert-buffer-function nil
0973d78b
RS
3102 "Function to use to revert this buffer, or nil to do the default.
3103The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3104which are the arguments that `revert-buffer' received.")
b4da00e9
RM
3105
3106(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
3107(defvar revert-buffer-insert-file-contents-function nil
3108 "Function to use to insert contents when reverting this buffer.
3109Gets two args, first the nominal file name to use,
2df32500
RS
3110and second, t if reading the auto-save file.
3111
3112The function you specify is responsible for updating (or preserving) point.")
b4da00e9 3113
5f76e7d4
KH
3114(defvar before-revert-hook nil
3115 "Normal hook for `revert-buffer' to run before reverting.
3116If `revert-buffer-function' is used to override the normal revert
3117mechanism, this hook is not used.")
3118
3119(defvar after-revert-hook nil
3120 "Normal hook for `revert-buffer' to run after reverting.
3121Note that the hook value that it runs is the value that was in effect
3122before reverting; that makes a difference if you have buffer-local
3123hook functions.
3124
3125If `revert-buffer-function' is used to override the normal revert
3126mechanism, this hook is not used.")
3127
1554c03b
RS
3128(defvar revert-buffer-internal-hook)
3129
9a30563f 3130(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 3131 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 3132This undoes all changes since the file was visited or saved.
8c0e7b73
JB
3133With a prefix argument, offer to revert from latest auto-save file, if
3134that is more recent than the visited file.
1ab31687 3135
7e7c9c4e
RS
3136This command also works for special buffers that contain text which
3137doesn't come from a file, but reflects some other data base instead:
3138for example, Dired buffers and buffer-list buffers. In these cases,
3139it reconstructs the buffer contents from the appropriate data base.
3140
65ee6096 3141When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
3142to revert from the auto-save file when this is nil. Note that the
3143sense of this argument is the reverse of the prefix argument, for the
3144sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3145to nil.
3146
3147Optional second argument NOCONFIRM means don't ask for confirmation at
ffc0e1ca 3148all. (The local variable `revert-without-query', if non-nil, prevents
d1f04130 3149confirmation.)
b4da00e9 3150
5b2b26d5
RS
3151Optional third argument PRESERVE-MODES non-nil means don't alter
3152the files modes. Normally we reinitialize them using `normal-mode'.
3153
8c0e7b73 3154If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
3155do all the work for this command. Otherwise, the hooks
3156`before-revert-hook' and `after-revert-hook' are run at the beginning
3157and the end, and if `revert-buffer-insert-file-contents-function' is
3158non-nil, it is called instead of rereading visited file contents."
fb6208a6 3159
1ab31687
JB
3160 ;; I admit it's odd to reverse the sense of the prefix argument, but
3161 ;; there is a lot of code out there which assumes that the first
3162 ;; argument should be t to avoid consulting the auto-save file, and
3163 ;; there's no straightforward way to encourage authors to notice a
3164 ;; reversal of the argument sense. So I'm just changing the user
3165 ;; interface, but leaving the programmatic interface the same.
e0867e99 3166 (interactive (list (not current-prefix-arg)))
b4da00e9 3167 (if revert-buffer-function
1ab31687 3168 (funcall revert-buffer-function ignore-auto noconfirm)
2df32500 3169 (let* ((auto-save-p (and (not ignore-auto)
1ab31687 3170 (recent-auto-save-p)
b4da00e9
RM
3171 buffer-auto-save-file-name
3172 (file-readable-p buffer-auto-save-file-name)
3173 (y-or-n-p
3174 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3175 (file-name (if auto-save-p
3176 buffer-auto-save-file-name
3177 buffer-file-name)))
3178 (cond ((null file-name)
3179 (error "Buffer does not seem to be associated with any file"))
3180 ((or noconfirm
db8c4866
RS
3181 (and (not (buffer-modified-p))
3182 (let ((tail revert-without-query)
3183 (found nil))
3184 (while tail
3185 (if (string-match (car tail) file-name)
3186 (setq found t))
3187 (setq tail (cdr tail)))
3188 found))
b4da00e9
RM
3189 (yes-or-no-p (format "Revert buffer from file %s? "
3190 file-name)))
4fbf62ee 3191 (run-hooks 'before-revert-hook)
b4da00e9
RM
3192 ;; If file was backed up but has changed since,
3193 ;; we shd make another backup.
3194 (and (not auto-save-p)
5bbbceb1 3195 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
3196 (setq buffer-backed-up nil))
3197 ;; Get rid of all undo records for this buffer.
3198 (or (eq buffer-undo-list t)
3199 (setq buffer-undo-list nil))
ba5c8c93
KH
3200 ;; Effectively copy the after-revert-hook status,
3201 ;; since after-find-file will clobber it.
3202 (let ((global-hook (default-value 'after-revert-hook))
3203 (local-hook-p (local-variable-p 'after-revert-hook))
3204 (local-hook (and (local-variable-p 'after-revert-hook)
3205 after-revert-hook)))
3206 (let (buffer-read-only
3207 ;; Don't make undo records for the reversion.
3208 (buffer-undo-list t))
3209 (if revert-buffer-insert-file-contents-function
3210 (funcall revert-buffer-insert-file-contents-function
3211 file-name auto-save-p)
3212 (if (not (file-exists-p file-name))
3213 (error "File %s no longer exists!" file-name))
3214 ;; Bind buffer-file-name to nil
3215 ;; so that we don't try to lock the file.
3216 (let ((buffer-file-name nil))
3217 (or auto-save-p
3218 (unlock-buffer)))
3219 (widen)
b77d8211
KH
3220 (let ((coding-system-for-read
3221 ;; Auto-saved file shoule be read without
3222 ;; any code conversion.
68875f0e 3223 (if auto-save-p 'emacs-mule-unix
b77d8211 3224 coding-system-for-read)))
2df32500 3225 ;; Note that this preserves point in an intelligent way.
b77d8211
KH
3226 (insert-file-contents file-name (not auto-save-p)
3227 nil nil t))))
ba5c8c93
KH
3228 ;; Recompute the truename in case changes in symlinks
3229 ;; have changed the truename.
3230 (setq buffer-file-truename
3231 (abbreviate-file-name (file-truename buffer-file-name)))
9a30563f 3232 (after-find-file nil nil t t preserve-modes)
ba5c8c93
KH
3233 ;; Run after-revert-hook as it was before we reverted.
3234 (setq-default revert-buffer-internal-hook global-hook)
3235 (if local-hook-p
3236 (progn
3237 (make-local-variable 'revert-buffer-internal-hook)
3238 (setq revert-buffer-internal-hook local-hook))
3239 (kill-local-variable 'revert-buffer-internal-hook))
3240 (run-hooks 'revert-buffer-internal-hook))
4fbf62ee 3241 t)))))
b4da00e9
RM
3242
3243(defun recover-file (file)
3244 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
3245 ;; Actually putting the file name in the minibuffer should be used
3246 ;; only rarely.
3247 ;; Not just because users often use the default.
e1dadc17 3248 (interactive "FRecover file: ")
b4da00e9 3249 (setq file (expand-file-name file))
f7da6740
RS
3250 (if (auto-save-file-name-p (file-name-nondirectory file))
3251 (error "%s is an auto-save file" file))
b4da00e9
RM
3252 (let ((file-name (let ((buffer-file-name file))
3253 (make-auto-save-file-name))))
945e1965
RS
3254 (cond ((if (file-exists-p file)
3255 (not (file-newer-than-file-p file-name file))
3256 (not (file-exists-p file-name)))
b4da00e9
RM
3257 (error "Auto-save file %s not current" file-name))
3258 ((save-window-excursion
ffc0e1ca
AS
3259 (with-output-to-temp-buffer "*Directory*"
3260 (buffer-disable-undo standard-output)
3261 (save-excursion
3262 (let ((switches dired-listing-switches))
3263 (if (file-symlink-p file)
3264 (setq switches (concat switches "L")))
3265 (set-buffer standard-output)
bc22fd18
EZ
3266 ;; Use insert-directory-safely, not insert-directory,
3267 ;; because these files might not exist. In particular,
3268 ;; FILE might not exist if the auto-save file was for
3269 ;; a buffer that didn't visit a file, such as "*mail*".
3270 ;; The code in v20.x called `ls' directly, so we need
3271 ;; to emulate what `ls' did in that case.
3272 (insert-directory-safely file switches)
3273 (insert-directory-safely file-name switches))))
b4da00e9
RM
3274 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3275 (switch-to-buffer (find-file-noselect file t))
82d0954a 3276 (let ((buffer-read-only nil)
1e87edf5
KH
3277 ;; Keep the current buffer-file-coding-system.
3278 (coding-system buffer-file-coding-system)
82d0954a 3279 ;; Auto-saved file shoule be read without any code conversion.
68875f0e 3280 (coding-system-for-read 'emacs-mule-unix))
b4da00e9 3281 (erase-buffer)
1e87edf5
KH
3282 (insert-file-contents file-name nil)
3283 (set-buffer-file-coding-system coding-system))
8cfb9d46 3284 (after-find-file nil nil t))
ffa7ab70 3285 (t (error "Recover-file cancelled")))))
b4da00e9 3286
6598027d 3287(defun recover-session ()
9aee5392
RS
3288 "Recover auto save files from a previous Emacs session.
3289This command first displays a Dired buffer showing you the
3290previous sessions that you could recover from.
3291To choose one, move point to the proper line and then type C-c C-c.
3292Then you'll be asked about a number of files to recover."
3293 (interactive)
363a5030
RS
3294 (if (null auto-save-list-file-prefix)
3295 (error "You set `auto-save-list-file-prefix' to disable making session files"))
ffc0e1ca
AS
3296 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3297 (unless (file-directory-p dir)
3298 (make-directory dir t)))
6f4983e6 3299 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
3300 (dired (concat auto-save-list-file-prefix "*")
3301 (concat dired-listing-switches "t")))
05e076c7
AS
3302 (save-excursion
3303 (goto-char (point-min))
3304 (or (looking-at " Move to the session you want to recover,")
3305 (let ((inhibit-read-only t))
3306 ;; Each line starts with a space
3307 ;; so that Font Lock mode won't highlight the first character.
3308 (insert " Move to the session you want to recover,\n"
3309 " then type C-c C-c to select it.\n\n"
3310 " You can also delete some of these files;\n"
3311 " type d on a line to mark that file for deletion.\n\n"))))
9aee5392 3312 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 3313 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 3314
80280bb7 3315(defun recover-session-finish ()
9aee5392
RS
3316 "Choose one saved session to recover auto-save files from.
3317This command is used in the special Dired buffer created by
80280bb7 3318\\[recover-session]."
9aee5392
RS
3319 (interactive)
3320 ;; Get the name of the session file to recover from.
3321 (let ((file (dired-get-filename))
953a03b2 3322 files
9aee5392 3323 (buffer (get-buffer-create " *recover*")))
c11032b9 3324 (dired-unmark 1)
033ef863 3325 (dired-do-flagged-delete t)
9aee5392
RS
3326 (unwind-protect
3327 (save-excursion
3328 ;; Read in the auto-save-list file.
3329 (set-buffer buffer)
3330 (erase-buffer)
3331 (insert-file-contents file)
953a03b2
RS
3332 ;; Loop thru the text of that file
3333 ;; and get out the names of the files to recover.
3334 (while (not (eobp))
3335 (let (thisfile autofile)
3336 (if (eolp)
3337 ;; This is a pair of lines for a non-file-visiting buffer.
3338 ;; Get the auto-save file name and manufacture
3339 ;; a "visited file name" from that.
3340 (progn
3341 (forward-line 1)
3342 (setq autofile
3343 (buffer-substring-no-properties
3344 (point)
3345 (save-excursion
3346 (end-of-line)
3347 (point))))
3348 (setq thisfile
3349 (expand-file-name
3350 (substring
3351 (file-name-nondirectory autofile)
3352 1 -1)
3353 (file-name-directory autofile)))
3354 (forward-line 1))
3355 ;; This pair of lines is a file-visiting
3356 ;; buffer. Use the visited file name.
3357 (progn
3358 (setq thisfile
3359 (buffer-substring-no-properties
3360 (point) (progn (end-of-line) (point))))
3361 (forward-line 1)
3362 (setq autofile
3363 (buffer-substring-no-properties
3364 (point) (progn (end-of-line) (point))))
3365 (forward-line 1)))
3366 ;; Ignore a file if its auto-save file does not exist now.
3367 (if (file-exists-p autofile)
3368 (setq files (cons thisfile files)))))
3369 (setq files (nreverse files))
945e1965
RS
3370 ;; The file contains a pair of line for each auto-saved buffer.
3371 ;; The first line of the pair contains the visited file name
3372 ;; or is empty if the buffer was not visiting a file.
3373 ;; The second line is the auto-save file name.
953a03b2
RS
3374 (if files
3375 (map-y-or-n-p "Recover %s? "
3376 (lambda (file)
3377 (condition-case nil
3378 (save-excursion (recover-file file))
76d5492b 3379 (error
953a03b2
RS
3380 "Failed to recover `%s'" file)))
3381 files
3382 '("file" "files" "recover"))
3383 (message "No files can be recovered from this session now")))
9aee5392
RS
3384 (kill-buffer buffer))))
3385
73ba610a
RS
3386(defun kill-some-buffers (&optional list)
3387 "For each buffer in LIST, ask whether to kill it.
3388LIST defaults to all existing live buffers."
b4da00e9 3389 (interactive)
73ba610a
RS
3390 (if (null list)
3391 (setq list (buffer-list)))
3392 (while list
3393 (let* ((buffer (car list))
3394 (name (buffer-name buffer)))
3395 (and (not (string-equal name ""))
3396 (/= (aref name 0) ? )
3397 (yes-or-no-p
3398 (format "Buffer %s %s. Kill? "
3399 name
3400 (if (buffer-modified-p buffer)
3401 "HAS BEEN EDITED" "is unmodified")))
3402 (kill-buffer buffer)))
3403 (setq list (cdr list))))
b4da00e9
RM
3404\f
3405(defun auto-save-mode (arg)
3406 "Toggle auto-saving of contents of current buffer.
f3e23606 3407With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
3408 (interactive "P")
3409 (setq buffer-auto-save-file-name
3410 (and (if (null arg)
74b9c2af 3411 (or (not buffer-auto-save-file-name)
4e0c8650 3412 ;; If auto-save is off because buffer has shrunk,
74b9c2af
RS
3413 ;; then toggling should turn it on.
3414 (< buffer-saved-size 0))
b4da00e9
RM
3415 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
3416 (if (and buffer-file-name auto-save-visited-file-name
3417 (not buffer-read-only))
3418 buffer-file-name
3419 (make-auto-save-file-name))))
0b7f1ef2
RS
3420 ;; If -1 was stored here, to temporarily turn off saving,
3421 ;; turn it back on.
3422 (and (< buffer-saved-size 0)
3423 (setq buffer-saved-size 0))
b4da00e9
RM
3424 (if (interactive-p)
3425 (message "Auto-save %s (in this buffer)"
3426 (if buffer-auto-save-file-name "on" "off")))
3427 buffer-auto-save-file-name)
3428
3429(defun rename-auto-save-file ()
3430 "Adjust current buffer's auto save file name for current conditions.
3431Also rename any existing auto save file, if it was made in this session."
3432 (let ((osave buffer-auto-save-file-name))
3433 (setq buffer-auto-save-file-name
3434 (make-auto-save-file-name))
3435 (if (and osave buffer-auto-save-file-name
3436 (not (string= buffer-auto-save-file-name buffer-file-name))
3437 (not (string= buffer-auto-save-file-name osave))
3438 (file-exists-p osave)
3439 (recent-auto-save-p))
3440 (rename-file osave buffer-auto-save-file-name t))))
3441
3442(defun make-auto-save-file-name ()
3443 "Return file name to use for auto-saves of current buffer.
3444Does not consider `auto-save-visited-file-name' as that variable is checked
3445before calling this function. You can redefine this for customization.
3446See also `auto-save-file-name-p'."
3447 (if buffer-file-name
ffc0e1ca
AS
3448 (let ((list auto-save-file-name-transforms)
3449 (filename buffer-file-name)
a0b60c33 3450 result uniq)
ffc0e1ca
AS
3451 ;; Apply user-specified translations
3452 ;; to the file name.
3453 (while (and list (not result))
3454 (if (string-match (car (car list)) filename)
3455 (setq result (replace-match (cadr (car list)) t nil
a0b60c33 3456 filename)
38eea7c7 3457 uniq (car (cddr (car list)))))
ffc0e1ca 3458 (setq list (cdr list)))
a0b60c33 3459 (if result
3c4a7cf3
RS
3460 (if uniq
3461 (setq filename (concat
3462 (file-name-directory result)
3463 (subst-char-in-string
3464 directory-sep-char ?!
3465 (replace-regexp-in-string "!" "!!"
3466 filename))))
3467 (setq filename result)))
1e57a696
EZ
3468 (setq result
3469 (if (and (eq system-type 'ms-dos)
3470 (not (msdos-long-file-names)))
3471 ;; We truncate the file name to DOS 8+3 limits
3472 ;; before doing anything else, because the regexp
3473 ;; passed to string-match below cannot handle
3474 ;; extensions longer than 3 characters, multiple
3475 ;; dots, and other atrocities.
3476 (let ((fn (dos-8+3-filename
3477 (file-name-nondirectory buffer-file-name))))
3478 (string-match
3479 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
3480 fn)
3481 (concat (file-name-directory buffer-file-name)
3482 "#" (match-string 1 fn)
3483 "." (match-string 3 fn) "#"))
3484 (concat (file-name-directory filename)
3485 "#"
3486 (file-name-nondirectory filename)
3487 "#")))
3488 ;; Make sure auto-save file names don't contain characters
3489 ;; invalid for the underlying filesystem.
3490 (if (and (memq system-type '(ms-dos windows-nt))
3491 ;; Don't modify remote (ange-ftp) filenames
3492 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
3493 (convert-standard-filename result)
3494 result))
0a1763b4
RS
3495
3496 ;; Deal with buffers that don't have any associated files. (Mail
3497 ;; mode tends to create a good number of these.)
3498
7d483e8c 3499 (let ((buffer-name (buffer-name))
ff5c7181
RS
3500 (limit 0)
3501 filename)
c3348e10
RS
3502 ;; Eliminate all slashes and backslashes by
3503 ;; replacing them with sequences that start with %.
3504 ;; Quote % also, to keep distinct names distinct.
3505 (while (string-match "[/\\%]" buffer-name limit)
3506 (let* ((character (aref buffer-name (match-beginning 0)))
3507 (replacement
3508 (cond ((eq character ?%) "%%")
3509 ((eq character ?/) "%+")
3510 ((eq character ?\\) "%-"))))
3511 (setq buffer-name (replace-match replacement t t buffer-name))
3512 (setq limit (1+ (match-end 0)))))
a8abaf83 3513 ;; Generate the file name.
ff5c7181
RS
3514 (setq file-name
3515 (make-temp-file
3516 (let ((fname
3517 (expand-file-name
3518 (format "#%s#" buffer-name)
3519 ;; Try a few alternative directories, to get one we can
3520 ;; write it.
3521 (cond
3522 ((file-writable-p default-directory) default-directory)
3523 ((file-writable-p "/var/tmp/") "/var/tmp/")
3524 ("~/")))))
3525 (if (and (memq system-type '(ms-dos windows-nt))
3526 ;; Don't modify remote (ange-ftp) filenames
3527 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
3528 ;; The call to convert-standard-filename is in case
3529 ;; buffer-name includes characters not allowed by the
3530 ;; DOS/Windows filesystems. make-temp-file writes to the
3531 ;; file it creates, so we must fix the file name _before_
3532 ;; make-temp-file is called.
3533 (convert-standard-filename fname)
3534 fname))
3535 nil "#"))
3536 ;; make-temp-file creates the file,
3537 ;; but we don't want it to exist until we do an auto-save.
3538 (condition-case ()
3539 (delete-file file-name)
3540 (file-error nil))
3541 file-name)))
b4da00e9
RM
3542
3543(defun auto-save-file-name-p (filename)
3544 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3545FILENAME should lack slashes. You can redefine this for customization."
3546 (string-match "^#.*#$" filename))
3547\f
6f4983e6
RS
3548(defun wildcard-to-regexp (wildcard)
3549 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3550The generated regexp will match a filename iff the filename
3551matches that wildcard according to shell rules. Only wildcards known
3552by `sh' are supported."
3553 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3554 ;; Copy the initial run of non-special characters.
3555 (result (substring wildcard 0 i))
3556 (len (length wildcard)))
3557 ;; If no special characters, we're almost done.
3558 (if i
3559 (while (< i len)
3560 (let ((ch (aref wildcard i))
3561 j)
3562 (setq
3563 result
3564 (concat result
3565 (cond
7e7c9c4e
RS
3566 ((and (eq ch ?\[)
3567 (< (1+ i) len)
3568 (eq (aref wildcard (1+ i)) ?\]))
3569 "\\[")
6f4983e6
RS
3570 ((eq ch ?\[) ; [...] maps to regexp char class
3571 (progn
3572 (setq i (1+ i))
3573 (concat
3574 (cond
3575 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3576 (progn
3577 (setq i (1+ i))
3578 (if (eq (aref wildcard i) ?\])
3579 (progn
3580 (setq i (1+ i))
3581 "[^]")
3582 "[^")))
3583 ((eq (aref wildcard i) ?^)
3584 ;; Found "[^". Insert a `\0' character
3585 ;; (which cannot happen in a filename)
3586 ;; into the character class, so that `^'
3587 ;; is not the first character after `[',
3588 ;; and thus non-special in a regexp.
3589 (progn
3590 (setq i (1+ i))
3591 "[\000^"))
3592 ((eq (aref wildcard i) ?\])
3593 ;; I don't think `]' can appear in a
3594 ;; character class in a wildcard, but
3595 ;; let's be general here.
3596 (progn
3597 (setq i (1+ i))
3598 "[]"))
3599 (t "["))
3600 (prog1 ; copy everything upto next `]'.
3601 (substring wildcard
3602 i
3603 (setq j (string-match
3604 "]" wildcard i)))
3605 (setq i (if j (1- j) (1- len)))))))
3606 ((eq ch ?.) "\\.")
3607 ((eq ch ?*) "[^\000]*")
3608 ((eq ch ?+) "\\+")
3609 ((eq ch ?^) "\\^")
3610 ((eq ch ?$) "\\$")
3611 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3612 ((eq ch ??) "[^\000]")
3613 (t (char-to-string ch)))))
3614 (setq i (1+ i)))))
3615 ;; Shell wildcards should match the entire filename,
3616 ;; not its part. Make the regexp say so.
3617 (concat "\\`" result "\\'")))
3618\f
21540597 3619(defcustom list-directory-brief-switches
b4da00e9 3620 (if (eq system-type 'vax-vms) "" "-CF")
ffc0e1ca 3621 "*Switches for `list-directory' to pass to `ls' for brief listing."
21540597
RS
3622 :type 'string
3623 :group 'dired)
b4da00e9 3624
21540597 3625(defcustom list-directory-verbose-switches
b4da00e9
RM
3626 (if (eq system-type 'vax-vms)
3627 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3628 "-l")
ffc0e1ca 3629 "*Switches for `list-directory' to pass to `ls' for verbose listing."
21540597
RS
3630 :type 'string
3631 :group 'dired)
b4da00e9 3632
5de148a2
RS
3633(defun file-expand-wildcards (pattern &optional full)
3634 "Expand wildcard pattern PATTERN.
4db2a7de
RS
3635This returns a list of file names which match the pattern.
3636
3637If PATTERN is written as an absolute relative file name,
3638the values are absolute also.
3639
3640If PATTERN is written as a relative file name, it is interpreted
3641relative to the current default directory, `default-directory'.
3642The file names returned are normally also relative to the current
3643default directory. However, if FULL is non-nil, they are absolute."
032388f3
RS
3644 (save-match-data
3645 (let* ((nondir (file-name-nondirectory pattern))
3646 (dirpart (file-name-directory pattern))
3647 ;; A list of all dirs that DIRPART specifies.
3648 ;; This can be more than one dir
3649 ;; if DIRPART contains wildcards.
3650 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
3651 (mapcar 'file-name-as-directory
3652 (file-expand-wildcards (directory-file-name dirpart)))
3653 (list dirpart)))
3654 contents)
3655 (while dirs
3656 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
3657 (file-directory-p (directory-file-name (car dirs))))
3658 (let ((this-dir-contents
3659 ;; Filter out "." and ".."
3660 (delq nil
3661 (mapcar #'(lambda (name)
3662 (unless (string-match "\\`\\.\\.?\\'"
3663 (file-name-nondirectory name))
3664 name))
3665 (directory-files (or (car dirs) ".") full
3666 (wildcard-to-regexp nondir))))))
3667 (setq contents
3668 (nconc
3669 (if (and (car dirs) (not full))
3670 (mapcar (function (lambda (name) (concat (car dirs) name)))
3671 this-dir-contents)
3672 this-dir-contents)
3673 contents))))
3674 (setq dirs (cdr dirs)))
3675 contents)))
5de148a2 3676
b4da00e9
RM
3677(defun list-directory (dirname &optional verbose)
3678 "Display a list of files in or matching DIRNAME, a la `ls'.
3679DIRNAME is globbed by the shell if necessary.
3680Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3681Actions controlled by variables `list-directory-brief-switches'
3682and `list-directory-verbose-switches'."
3683 (interactive (let ((pfx current-prefix-arg))
3684 (list (read-file-name (if pfx "List directory (verbose): "
3685 "List directory (brief): ")
3686 nil default-directory nil)
3687 pfx)))
3688 (let ((switches (if verbose list-directory-verbose-switches
84905190
RS
3689 list-directory-brief-switches))
3690 buffer)
b4da00e9
RM
3691 (or dirname (setq dirname default-directory))
3692 (setq dirname (expand-file-name dirname))
3693 (with-output-to-temp-buffer "*Directory*"
84905190 3694 (setq buffer standard-output)
b4da00e9
RM
3695 (buffer-disable-undo standard-output)
3696 (princ "Directory ")
3697 (princ dirname)
3698 (terpri)
c3554e95
RS
3699 (save-excursion
3700 (set-buffer "*Directory*")
3701 (let ((wildcard (not (file-directory-p dirname))))
84905190
RS
3702 (insert-directory dirname switches wildcard (not wildcard)))))
3703 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
3704 (with-current-buffer buffer
3705 (setq default-directory
3706 (if (file-directory-p dirname)
3707 (file-name-as-directory dirname)
3708 (file-name-directory dirname))))))
c3554e95 3709
ffc0e1ca
AS
3710(defun shell-quote-wildcard-pattern (pattern)
3711 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3712
3713PATTERN is assumed to represent a file-name wildcard suitable for the
3714underlying filesystem. For Unix and GNU/Linux, the characters from the
3715set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
3716the parts of the pattern which don't include wildcard characters are
3717quoted with double quotes.
3718Existing quote characters in PATTERN are left alone, so you can pass
3719PATTERN that already quotes some of the special characters."
3720 (save-match-data
3721 (cond
3722 ((memq system-type '(ms-dos windows-nt))
3723 ;; DOS/Windows don't allow `"' in file names. So if the
3724 ;; argument has quotes, we can safely assume it is already
3725 ;; quoted by the caller.
3726 (if (or (string-match "[\"]" pattern)
3727 ;; We quote [&()#$'] in case their shell is a port of a
3728 ;; Unixy shell. We quote [,=+] because stock DOS and
3729 ;; Windows shells require that in some cases, such as
3730 ;; passing arguments to batch files that use positional
3731 ;; arguments like %1.
3732 (not (string-match "[ \t;&()#$',=+]" pattern)))
3733 pattern
3734 (let ((result "\"")
3735 (beg 0)
3736 end)
3737 (while (string-match "[*?]+" pattern beg)
3738 (setq end (match-beginning 0)
3739 result (concat result (substring pattern beg end)
3740 "\""
3741 (substring pattern end (match-end 0))
3742 "\"")
3743 beg (match-end 0)))
3744 (concat result (substring pattern beg) "\""))))
3745 (t
3746 (let ((beg 0))
3747 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3748 (setq pattern
3749 (concat (substring pattern 0 (match-beginning 0))
3750 "\\"
3751 (substring pattern (match-beginning 0)))
3752 beg (1+ (match-end 0)))))
3753 pattern))))
3754
3755
c3554e95
RS
3756(defvar insert-directory-program "ls"
3757 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3758
f4d04672
RS
3759(defcustom directory-free-space-program "df"
3760 "*Program to get the amount of free space on a file system.
3761We assume the output has the format of `df'.
3762The value of this variable must be just a command name or file name;
3763if you want to specify options, use `directory-free-space-args'.
3764
01b26b90
EZ
3765A value of nil disables this feature.
3766
3767If the function `file-system-info' is defined, it is always used in
3768preference to the program given by this variable."
f4d04672
RS
3769 :type '(choice (string :tag "Program") (const :tag "None" nil))
3770 :group 'dired)
3771
3772(defcustom directory-free-space-args "-Pk"
3773 "*Options to use when running `directory-free-space-program'."
3774 :type 'string
3775 :group 'dired)
3776
01b26b90
EZ
3777(defun get-free-disk-space (dir)
3778 "Return the mount of free space on directory DIR's file system.
3779The result is a string that gives the number of free 1KB blocks,
3780or nil if the system call or the program which retrieve the infornmation
3781fail.
3782
3783This function calls `file-system-info' if it is available, or invokes the
3784program specified by `directory-free-space-program' if that is non-nil."
3785 ;; Try to find the number of free blocks. Non-Posix systems don't
3786 ;; always have df, but might have an equivalent system call.
3787 (if (fboundp 'file-system-info)
3788 (let ((fsinfo (file-system-info dir)))
3789 (if fsinfo
3790 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
3791 (save-match-data
3792 (with-temp-buffer
3793 (when (and directory-free-space-program
3794 (zerop (call-process directory-free-space-program
3795 nil t nil
3796 directory-free-space-args
3797 dir)))
3798 ;; Usual format is a header line followed by a line of
3799 ;; numbers.
3800 (goto-char (point-min))
3801 (forward-line 1)
3802 (if (not (eobp))
3803 (progn
3804 ;; Move to the end of the "available blocks" number.
3805 (skip-chars-forward "^ \t")
3806 (forward-word 3)
3807 ;; Copy it into AVAILABLE.
3808 (let ((end (point)))
3809 (forward-word -1)
3810 (buffer-substring (point) end)))))))))
3811
3812
c3554e95
RS
3813;; insert-directory
3814;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3815;; FULL-DIRECTORY-P is nil.
3816;; The single line of output must display FILE's name as it was
3817;; given, namely, an absolute path name.
3818;; - must insert exactly one line for each file if WILDCARD or
3819;; FULL-DIRECTORY-P is t, plus one optional "total" line
3820;; before the file lines, plus optional text after the file lines.
3821;; Lines are delimited by "\n", so filenames containing "\n" are not
3822;; allowed.
3823;; File lines should display the basename.
3824;; - must be consistent with
3825;; - functions dired-move-to-filename, (these two define what a file line is)
3826;; dired-move-to-end-of-filename,
3827;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3828;; dired-insert-headerline
3829;; dired-after-subdir-garbage (defines what a "total" line is)
3830;; - variable dired-subdir-regexp
3831(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 3832 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 3833Leaves point after the inserted text.
727d277d 3834SWITCHES may be a string of options, or a list of strings.
c3554e95
RS
3835Optional third arg WILDCARD means treat FILE as shell wildcard.
3836Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3837switches do not contain `d', so that a full listing is expected.
3838
3839This works by running a directory listing program
406e12d9 3840whose name is in the variable `insert-directory-program'.
c3554e95 3841If WILDCARD, it also runs the shell specified by `shell-file-name'."
c870ab8e 3842 ;; We need the directory in order to find the right handler.
d2473540
AS
3843 (let ((handler (find-file-name-handler (expand-file-name file)
3844 'insert-directory)))
ebad92dc 3845 (if handler
c3554e95
RS
3846 (funcall handler 'insert-directory file switches
3847 wildcard full-directory-p)
b4da00e9 3848 (if (eq system-type 'vax-vms)
c3554e95 3849 (vms-read-directory file switches (current-buffer))
ebad92dc
RS
3850 (let (result available)
3851
3852 ;; Read the actual directory using `insert-directory-program'.
3853 ;; RESULT gets the status code.
3854 (let ((coding-system-for-read
3855 (and enable-multibyte-characters
3856 (or file-name-coding-system
3857 default-file-name-coding-system)))
3858 ;; This is to control encoding the arguments in call-process.
3859 (coding-system-for-write coding-system-for-read))
3860 (setq result
3861 (if wildcard
3862 ;; Run ls in the directory part of the file pattern
3863 ;; using the last component as argument.
3864 (let ((default-directory
3865 (if (file-name-absolute-p file)
3866 (file-name-directory file)
3867 (file-name-directory (expand-file-name file))))
3868 (pattern (file-name-nondirectory file)))
3869 (call-process
3870 shell-file-name nil t nil
3871 "-c"
3872 (concat (if (memq system-type '(ms-dos windows-nt))
3873 ""
3874 "\\") ; Disregard Unix shell aliases!
3875 insert-directory-program
3876 " -d "
3877 (if (stringp switches)
3878 switches
3879 (mapconcat 'identity switches " "))
3880 " -- "
3881 ;; Quote some characters that have
3882 ;; special meanings in shells; but
3883 ;; don't quote the wildcards--we want
3884 ;; them to be special. We also
3885 ;; currently don't quote the quoting
3886 ;; characters in case people want to
3887 ;; use them explicitly to quote
3888 ;; wildcard characters.
3889 (shell-quote-wildcard-pattern pattern))))
3890 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3891 ;; directory if FILE is a symbolic link.
3892 (apply 'call-process
3893 insert-directory-program nil t nil
3894 (append
3895 (if (listp switches) switches
3896 (unless (equal switches "")
3897 ;; Split the switches at any spaces so we can
3898 ;; pass separate options as separate args.
3899 (split-string switches)))
3900 ;; Avoid lossage if FILE starts with `-'.
3901 '("--")
3902 (progn
3903 (if (string-match "\\`~" file)
3904 (setq file (expand-file-name file)))
3905 (list
3906 (if full-directory-p
3907 (concat (file-name-as-directory file) ".")
3908 file))))))))
3909
3910 ;; If `insert-directory-program' failed, signal an error.
73ba53dc 3911 (if (/= result 0)
ffc0e1ca
AS
3912 ;; On non-Posix systems, we cannot open a directory, so
3913 ;; don't even try, because that will always result in
ebad92dc
RS
3914 ;; the ubiquitous "Access denied". Instead, show the
3915 ;; command line so the user can try to guess what went wrong.
ffc0e1ca
AS
3916 (if (and (file-directory-p file)
3917 (memq system-type '(ms-dos windows-nt)))
3918 (error
3919 "Reading directory: \"%s %s -- %s\" exited with status %s"
3920 insert-directory-program
3921 (if (listp switches) (concat switches) switches)
3922 file result)
3923 ;; Unix. Access the file to get a suitable error.
ebad92dc
RS
3924 (access-file file "Reading directory")
3925 (error "Listing directory failed but `access-file' worked")))
3926
3927 ;; Try to insert the amount of free space.
3928 (save-excursion
3929 (goto-char (point-min))
3930 ;; First find the line to put it on.
3931 (when (re-search-forward "^total" nil t)
01b26b90
EZ
3932 (let ((available (get-free-disk-space ".")))
3933 (when available
3934 ;; Replace "total" with "used", to avoid confusion.
14be1bc2 3935 (replace-match "total used in directory")
01b26b90
EZ
3936 (end-of-line)
3937 (insert " available " available))))))))))
34342a07 3938
bc22fd18
EZ
3939(defun insert-directory-safely (file switches
3940 &optional wildcard full-directory-p)
3941 "Insert directory listing for FILE, formatted according to SWITCHES.
3942
3943Like `insert-directory', but if FILE does not exist, it inserts a
3944message to that effect instead of signaling an error."
3945 (if (file-exists-p file)
3946 (insert-directory file switches wildcard full-directory-p)
3947 ;; Simulate the message printed by `ls'.
3948 (insert (format "%s: No such file or directory\n" file))))
3949
88902b35 3950(defvar kill-emacs-query-functions nil
65d5c6de 3951 "Functions to call with no arguments to query about killing Emacs.
78c793d1
RS
3952If any of these functions returns nil, killing Emacs is cancelled.
3953`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3954but `kill-emacs', the low level primitive, does not.
3955See also `kill-emacs-hook'.")
88902b35 3956
11f15305 3957(defcustom confirm-kill-emacs nil
9c2ba08f
EZ
3958 "How to ask for confirmation when leaving Emacs.
3959If nil, the default, don't ask at all. If the value is non-nil, it should
3960be a predicate function such as `yes-or-no-p'."
11f15305
GM
3961 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
3962 (const :tag "Ask with y-or-n-p" y-or-n-p)
3963 (const :tag "Don't confirm" nil))
3964 :group 'emacs
3965 :version "21.1")
3966
b4da00e9
RM
3967(defun save-buffers-kill-emacs (&optional arg)
3968 "Offer to save each buffer, then kill this Emacs process.
3969With prefix arg, silently save all file-visiting buffers, then kill."
3970 (interactive "P")
3971 (save-some-buffers arg t)
3972 (and (or (not (memq t (mapcar (function
3973 (lambda (buf) (and (buffer-file-name buf)
3974 (buffer-modified-p buf))))
3975 (buffer-list))))
3976 (yes-or-no-p "Modified buffers exist; exit anyway? "))
3977 (or (not (fboundp 'process-list))
3978 ;; process-list is not defined on VMS.
3979 (let ((processes (process-list))
3980 active)
3981 (while processes
48a4a1fb
KS
3982 (and (memq (process-status (car processes)) '(run stop open listen))
3983 (process-query-on-exit-flag (car processes))
b4da00e9
RM
3984 (setq active t))
3985 (setq processes (cdr processes)))
3986 (or (not active)
48a4a1fb 3987 (list-processes t)
b4da00e9 3988 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 3989 ;; Query the user for other things, perhaps.
fb15c113 3990 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
11f15305
GM
3991 (or (null confirm-kill-emacs)
3992 (funcall confirm-kill-emacs "Really exit Emacs? "))
b4da00e9
RM
3993 (kill-emacs)))
3994\f
ffc0e1ca 3995;; We use /: as a prefix to "quote" a file name
47afc068
RS
3996;; so that magic file name handlers will not apply to it.
3997
3998(setq file-name-handler-alist
3999 (cons '("\\`/:" . file-name-non-special)
4000 file-name-handler-alist))
4001
4002;; We depend on being the last handler on the list,
4003;; so that anything else which does need handling
4004;; has been handled already.
4005;; So it is safe for us to inhibit *all* magic file name handlers.
4006
4007(defun file-name-non-special (operation &rest arguments)
4008 (let ((file-name-handler-alist nil)
5cb1f728
KH
4009 (default-directory
4010 (if (eq operation 'insert-directory)
4011 (directory-file-name
ffc0e1ca 4012 (expand-file-name
5cb1f728
KH
4013 (unhandled-file-name-directory default-directory)))
4014 default-directory))
47afc068
RS
4015 ;; Get a list of the indices of the args which are file names.
4016 (file-arg-indices
4017 (cdr (or (assq operation
c736f678 4018 ;; The first five are special because they
47afc068
RS
4019 ;; return a file name. We want to include the /:
4020 ;; in the return value.
4021 ;; So just avoid stripping it in the first place.
4022 '((expand-file-name . nil)
4023 (file-name-directory . nil)
4024 (file-name-as-directory . nil)
4025 (directory-file-name . nil)
c736f678
RS
4026 (file-name-sans-versions . nil)
4027 ;; `identity' means just return the first arg
4028 ;; as stripped of its quoting.
4029 (substitute-in-file-name . identity)
c37adaa5
SM
4030 (file-name-completion 1)
4031 (file-name-all-completions 1)
47afc068
RS
4032 (rename-file 0 1)
4033 (copy-file 0 1)
4034 (make-symbolic-link 0 1)
4035 (add-name-to-file 0 1)))
4036 ;; For all other operations, treat the first argument only
4037 ;; as the file name.
4038 '(nil 0))))
4039 ;; Copy ARGUMENTS so we can replace elements in it.
4040 (arguments (copy-sequence arguments)))
4041 ;; Strip off the /: from the file names that have this handler.
4042 (save-match-data
18b9dced 4043 (while (consp file-arg-indices)
fe4d9852
KH
4044 (let ((pair (nthcdr (car file-arg-indices) arguments)))
4045 (and (car pair)
4046 (string-match "\\`/:" (car pair))
4047 (setcar pair
4048 (if (= (length (car pair)) 2)
4049 "/"
4050 (substring (car pair) 2)))))
47afc068 4051 (setq file-arg-indices (cdr file-arg-indices))))
18b9dced
RS
4052 (if (eq file-arg-indices 'identity)
4053 (car arguments)
c37adaa5 4054 (apply operation arguments))))
47afc068 4055\f
b4da00e9 4056(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
4057(define-key ctl-x-map "\C-r" 'find-file-read-only)
4058(define-key ctl-x-map "\C-v" 'find-alternate-file)
4059(define-key ctl-x-map "\C-s" 'save-buffer)
4060(define-key ctl-x-map "s" 'save-some-buffers)
4061(define-key ctl-x-map "\C-w" 'write-file)
4062(define-key ctl-x-map "i" 'insert-file)
4063(define-key esc-map "~" 'not-modified)
4064(define-key ctl-x-map "\C-d" 'list-directory)
4065(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
4066
4067(define-key ctl-x-4-map "f" 'find-file-other-window)
4068(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
4069(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
4070(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 4071(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 4072
f98955ea
JB
4073(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
4074(define-key ctl-x-5-map "f" 'find-file-other-frame)
4075(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
4076(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38
ER
4077
4078;;; files.el ends here