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