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