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