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