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