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