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