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