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