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