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