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