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