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