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