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