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