*** empty log message ***
[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
94495713
KS
1879(defcustom auto-mode-case-fold nil
1880 "Non-nil means to try second pass through `auto-mode-alist'.
1881This means that if the first case-sensitive search through the alist fails
1882to find a matching major mode, a second case-insensitive search is made.
1883On systems with case-insensitive file names, this variable is ignored,
bb178aaa 1884since only a single case-insensitive search through the alist is made."
94495713
KS
1885 :group 'files
1886 :version "22.1"
1887 :type 'boolean)
1888
f76e0cd0 1889(defvar auto-mode-alist
f209c999
MS
1890 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1891 ;; c++-mode, java-mode and more) are added through autoload
1892 ;; directives in that file. That way is discouraged since it
1893 ;; spreads out the definition of the initial value.
ffc0e1ca
AS
1894 (mapc
1895 (lambda (elt)
1896 (cons (purecopy (car elt)) (cdr elt)))
813731b3 1897 `(;; do this first, so that .html.pl is Polish html, not Perl
9e6f5419
DP
1898 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
1899 ("\\.te?xt\\'" . text-mode)
bbc67516 1900 ("\\.[tT]e[xX]\\'" . tex-mode)
4e163715 1901 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
ffc0e1ca 1902 ("\\.ltx\\'" . latex-mode)
4e163715 1903 ("\\.dtx\\'" . doctex-mode)
ffc0e1ca 1904 ("\\.el\\'" . emacs-lisp-mode)
21575d92 1905 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
ffc0e1ca 1906 ("\\.l\\'" . lisp-mode)
bbc67516
DP
1907 ("\\.li?sp\\'" . lisp-mode)
1908 ("\\.[fF]\\'" . fortran-mode)
ffc0e1ca
AS
1909 ("\\.for\\'" . fortran-mode)
1910 ("\\.p\\'" . pascal-mode)
1911 ("\\.pas\\'" . pascal-mode)
1912 ("\\.ad[abs]\\'" . ada-mode)
7defe888 1913 ("\\.ad[bs].dg\\'" . ada-mode)
bbc67516 1914 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
3968c89f 1915 ("Imakefile\\'" . makefile-imake-mode)
8088bb2c
DP
1916 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
1917 ("\\.makepp\\'" . makefile-makepp-mode)
813731b3
DP
1918 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
1919 '(("\\.mk\\'" . makefile-bsdmake-mode)
47d4e709 1920 ("GNUmakefile\\'" . makefile-gmake-mode)
813731b3
DP
1921 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
1922 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
47d4e709 1923 ("[Mm]akefile\\'" . makefile-gmake-mode)))
27a7c83f 1924 ("\\.am\\'" . makefile-automake-mode)
5c6d31a4
SM
1925 ;; Less common extensions come here
1926 ;; so more common ones above are found faster.
ffc0e1ca
AS
1927 ("\\.texinfo\\'" . texinfo-mode)
1928 ("\\.te?xi\\'" . texinfo-mode)
bbc67516 1929 ("\\.[sS]\\'" . asm-mode)
ffc0e1ca 1930 ("\\.asm\\'" . asm-mode)
bbc67516 1931 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
c595fad9 1932 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
ffc0e1ca
AS
1933 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1934 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1935 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
b921b596 1936 ("\\.bash\\'" . sh-mode)
ffc0e1ca
AS
1937 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1938 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1939 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
d5798fa7 1940 ("\\.m?spec\\'" . sh-mode)
bbc67516 1941 ("\\.m[mes]\\'" . nroff-mode)
ffc0e1ca 1942 ("\\.man\\'" . nroff-mode)
ffc0e1ca 1943 ("\\.sty\\'" . latex-mode)
bbc67516 1944 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
ffc0e1ca
AS
1945 ("\\.bbl\\'" . latex-mode)
1946 ("\\.bib\\'" . bibtex-mode)
1947 ("\\.sql\\'" . sql-mode)
bbc67516 1948 ("\\.m[4c]\\'" . m4-mode)
9e6f5419
DP
1949 ("\\.mf\\'" . metafont-mode)
1950 ("\\.mp\\'" . metapost-mode)
ffc0e1ca
AS
1951 ("\\.vhdl?\\'" . vhdl-mode)
1952 ("\\.article\\'" . text-mode)
1953 ("\\.letter\\'" . text-mode)
bbc67516 1954 ("\\.i?tcl\\'" . tcl-mode)
ffc0e1ca 1955 ("\\.exp\\'" . tcl-mode)
ffc0e1ca
AS
1956 ("\\.itk\\'" . tcl-mode)
1957 ("\\.icn\\'" . icon-mode)
1958 ("\\.sim\\'" . simula-mode)
1959 ("\\.mss\\'" . scribe-mode)
bbc67516 1960 ("\\.f9[05]\\'" . f90-mode)
8f9495e7 1961 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
ffc0e1ca 1962 ("\\.pro\\'" . idlwave-mode)
ffc0e1ca
AS
1963 ("\\.prolog\\'" . prolog-mode)
1964 ("\\.tar\\'" . tar-mode)
0ee6e7b7
JL
1965 ;; The list of archive file extensions should be in sync with
1966 ;; `auto-coding-alist' with `no-conversion' coding system.
03210c3a
EZ
1967 ("\\.\\(arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\)\\'" . archive-mode)
1968 ("\\.\\(ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\)\\'" . archive-mode)
d5040404 1969 ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode) ; OpenOffice.org
ffc0e1ca
AS
1970 ;; Mailer puts message to be edited in
1971 ;; /tmp/Re.... or Message
1972 ("\\`/tmp/Re" . text-mode)
1973 ("/Message[0-9]*\\'" . text-mode)
ffc0e1ca
AS
1974 ("\\.zone\\'" . zone-mode)
1975 ;; some news reader is reported to use this
1976 ("\\`/tmp/fol/" . text-mode)
ffc0e1ca
AS
1977 ("\\.oak\\'" . scheme-mode)
1978 ("\\.sgml?\\'" . sgml-mode)
bbc67516 1979 ("\\.x[ms]l\\'" . xml-mode)
ffc0e1ca
AS
1980 ("\\.dtd\\'" . sgml-mode)
1981 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
bbc67516
DP
1982 ("\\.js\\'" . java-mode) ; javascript-mode would be better
1983 ("\\.x[bp]m\\'" . c-mode)
709d45e1
KG
1984 ;; .emacs or .gnus or .viper following a directory delimiter in
1985 ;; Unix, MSDOG or VMS syntax.
1986 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
ffc0e1ca
AS
1987 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1988 ;; _emacs following a directory delimiter
1989 ;; in MsDos syntax
1990 ("[:/]_emacs\\'" . emacs-lisp-mode)
1991 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1992 ("\\.ml\\'" . lisp-mode)
d5798fa7
SM
1993 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1994 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
ffc0e1ca 1995 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
e854cc22 1996 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
d5798fa7 1997 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
e55c4863 1998 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
ffc0e1ca
AS
1999 ("BROWSE\\'" . ebrowse-tree-mode)
2000 ("\\.ebrowse\\'" . ebrowse-tree-mode)
9ee45b2c 2001 ("#\\*mail\\*" . mail-mode)
80174d35
DP
2002 ("\\.g\\'" . antlr-mode)
2003 ("\\.ses\\'" . ses-mode)
2004 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2005 ("\\.docbook\\'" . sgml-mode)
00daa381 2006 ("\\.com\\'" . dcl-mode)
80174d35
DP
2007 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2008 ;; Windows candidates may be opened case sensitively on Unix
2009 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2010 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
08adf84e 2011 ("\\.ppd\\'" . conf-ppd-mode)
80174d35
DP
2012 ("java.+\\.conf\\'" . conf-javaprop-mode)
2013 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2014 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2015 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode)
a35d9075
AS
2016 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2017 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
80174d35
DP
2018 ;; either user's dot-files or under /etc or some such
2019 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2020 ;; alas not all ~/.*rc files are like this
b14f1885 2021 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
80174d35
DP
2022 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2023 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2024 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2025 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2026 ;; this contains everything twice, with space and with colon :-(
2027 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
9ee45b2c
SM
2028 ;; Get rid of any trailing .n.m and try again.
2029 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
5c6d31a4
SM
2030 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2031 ;; Using mode nil rather than `ignore' would let the search continue
2032 ;; through this list (with the shortened name) rather than start over.
bbc67516 2033 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
5c6d31a4
SM
2034 ;; The following should come after the ChangeLog pattern
2035 ;; for the sake of ChangeLog.1, etc.
2036 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
e043664a 2037 ("\\.[1-9]\\'" . nroff-mode)
80174d35 2038 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
ffc0e1ca 2039 "Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
2040Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2041\(NON-NIL stands for anything that is not nil; the value does not matter.)
2042Visiting a file whose name matches REGEXP specifies FUNCTION as the
2043mode function to use. FUNCTION will be called, unless it is nil.
2044
2045If the element has the form (REGEXP FUNCTION NON-NIL), then after
2046calling FUNCTION (if it's not nil), we delete the suffix that matched
969be033 2047REGEXP and search the list again for another match.
7b3f3dc2 2048
969be033
RS
2049If the file name matches `inhibit-first-line-modes-regexps',
2050then `auto-mode-alist' is not processed.
2051
d5040404
EZ
2052The extensions whose FUNCTION is `archive-mode' should also
2053appear in `auto-coding-alist' with `no-conversion' coding system.
2054
969be033
RS
2055See also `interpreter-mode-alist', which detects executable script modes
2056based on the interpreters they specify to run,
2057and `magic-mode-alist', which determines modes based on file contents.")
e13322a0 2058
d7fa5aa2 2059(defvar interpreter-mode-alist
f209c999
MS
2060 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2061 ;; and pike-mode) are added through autoload directives in that
2062 ;; file. That way is discouraged since it spreads out the
2063 ;; definition of the initial value.
ffc0e1ca
AS
2064 (mapc
2065 (lambda (l)
2066 (cons (purecopy (car l)) (cdr l)))
2067 '(("perl" . perl-mode)
2068 ("perl5" . perl-mode)
2069 ("miniperl" . perl-mode)
2070 ("wish" . tcl-mode)
2071 ("wishx" . tcl-mode)
2072 ("tcl" . tcl-mode)
2073 ("tclsh" . tcl-mode)
ffc0e1ca
AS
2074 ("scm" . scheme-mode)
2075 ("ash" . sh-mode)
2076 ("bash" . sh-mode)
2077 ("bash2" . sh-mode)
2078 ("csh" . sh-mode)
2079 ("dtksh" . sh-mode)
2080 ("es" . sh-mode)
2081 ("itcsh" . sh-mode)
2082 ("jsh" . sh-mode)
2083 ("ksh" . sh-mode)
2084 ("oash" . sh-mode)
2085 ("pdksh" . sh-mode)
2086 ("rc" . sh-mode)
2087 ("rpm" . sh-mode)
2088 ("sh" . sh-mode)
2089 ("sh5" . sh-mode)
2090 ("tcsh" . sh-mode)
2091 ("wksh" . sh-mode)
2092 ("wsh" . sh-mode)
2093 ("zsh" . sh-mode)
2094 ("tail" . text-mode)
2095 ("more" . text-mode)
2096 ("less" . text-mode)
2097 ("pg" . text-mode)
27a7c83f 2098 ("make" . makefile-gmake-mode) ; Debian uses this
ffc0e1ca
AS
2099 ("guile" . scheme-mode)
2100 ("clisp" . lisp-mode)))
c907d156 2101 "Alist mapping interpreter names to major modes.
969be033 2102This is used for files whose first lines match `auto-mode-interpreter-regexp'.
c907d156 2103Each element looks like (INTERPRETER . MODE).
9f01a773
RS
2104If INTERPRETER matches the name of the interpreter specified in the first line
2105of a script, mode MODE is enabled.
969be033
RS
2106
2107See also `auto-mode-alist'.")
c907d156 2108
d7fa5aa2 2109(defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
45fb3bb8 2110 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 2111
d7fa5aa2 2112(defvar inhibit-first-line-modes-suffixes nil
b20ff6d0
RS
2113 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2114When checking `inhibit-first-line-modes-regexps', we first discard
2115from the end of the file name anything that matches one of these regexps.")
2116
ffc0e1ca
AS
2117(defvar auto-mode-interpreter-regexp
2118 "#![ \t]?\\([^ \t\n]*\
2119/bin/env[ \t]\\)?\\([^ \t\n]+\\)"
54005870 2120 "Regexp matching interpreters, for file mode determination.
ffc0e1ca 2121This regular expression is matched against the first line of a file
54005870
LT
2122to determine the file's mode in `set-auto-mode'. If it matches, the file
2123is assumed to be interpreted by the interpreter matched by the second group
2124of the regular expression. The mode is then determined as the mode
2125associated with that interpreter in `interpreter-mode-alist'.")
0720b68b 2126
4ac1d37a 2127(defvar magic-mode-alist
305018c6 2128 `((image-type-auto-detected-p . image-mode)
10ffa2a1 2129 ;; The < comes before the groups (but the first) to reduce backtracking.
4ac1d37a 2130 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
a52152f8 2131 ;; We use [ \t\n] instead of `\\s ' to make regex overflow less likely.
32a0479a 2132 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
a52152f8
RS
2133 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\n]*<\\)")))
2134 (concat "\\(?:<\\?xml[ \t\n]+[^>]*>\\)?[ \t\n]*<"
32a0479a 2135 comment-re "*"
a52152f8 2136 "\\(?:!DOCTYPE[ \t\n]+[^>]*>[ \t\n]*<[ \t\n]*" comment-re "*\\)?"
969be033
RS
2137 "[Hh][Tt][Mm][Ll]"))
2138 . html-mode)
4ac1d37a
DP
2139 ;; These two must come after html, because they are more general:
2140 ("<\\?xml " . xml-mode)
811cab86 2141 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
a52152f8
RS
2142 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\n]*<\\)")))
2143 (concat "[ \t\n]*<" comment-re "*!DOCTYPE "))
969be033 2144 . sgml-mode)
80174d35
DP
2145 ("%![^V]" . ps-mode)
2146 ("# xmcd " . conf-unix-mode))
2147 "Alist of buffer beginnings vs. corresponding major mode functions.
10ffa2a1
KS
2148Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2149After visiting a file, if REGEXP matches the text at the beginning of the
2150buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2151call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2152major mode.
44dce0fb
RS
2153
2154If FUNCTION is nil, then it is not called. (That is a way of saying
26b9ecbc 2155\"allow `auto-mode-alist' to decide for these files.\")")
eb0455ab 2156(put 'magic-mode-alist 'risky-local-variable t)
bbc67516 2157
5cce080e
KS
2158(defvar magic-mode-regexp-match-limit 4000
2159 "Upper limit on `magic-mode-alist' regexp matches.")
2160
9e6f5419 2161(defun set-auto-mode (&optional keep-mode-if-same)
b4da00e9 2162 "Select major mode appropriate for current buffer.
4ac1d37a 2163
bbc67516
DP
2164This checks for a -*- mode tag in the buffer's text, checks the
2165interpreter that runs this file against `interpreter-mode-alist',
811cab86
JL
2166compares the buffer beginning against `magic-mode-alist', or
2167compares the filename against the entries in `auto-mode-alist'.
e3998da1
RS
2168
2169It does not check for the `mode:' local variable in the
2170Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 2171
f3e23606 2172If `enable-local-variables' is nil, this function does not check for a
9de9b6a2
RS
2173-*- mode tag.
2174
521cf174
DP
2175If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2176only set the major mode, if that would change it."
b4da00e9 2177 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
811cab86 2178 (let (end done mode modes)
9e6f5419
DP
2179 ;; Find a -*- mode tag
2180 (save-excursion
2181 (goto-char (point-min))
2182 (skip-chars-forward " \t\n")
9e6f5419
DP
2183 (and enable-local-variables
2184 (setq end (set-auto-mode-1))
2185 (if (save-excursion (search-forward ":" end t))
2186 ;; Find all specifications for the `mode:' variable
2187 ;; and execute them left to right.
2188 (while (let ((case-fold-search t))
2189 (or (and (looking-at "mode:")
2190 (goto-char (match-end 0)))
2191 (re-search-forward "[ \t;]mode:" end t)))
2192 (skip-chars-forward " \t")
2193 (let ((beg (point)))
2194 (if (search-forward ";" end t)
2195 (forward-char -1)
2196 (goto-char end))
2197 (skip-chars-backward " \t")
2198 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2199 modes)))
2200 ;; Simple -*-MODE-*- case.
2201 (push (intern (concat (downcase (buffer-substring (point) end))
2202 "-mode"))
2203 modes))))
2204 ;; If we found modes to use, invoke them now, outside the save-excursion.
2205 (if modes
521cf174
DP
2206 (catch 'nop
2207 (dolist (mode (nreverse modes))
2208 (if (not (functionp mode))
2209 (message "Ignoring unknown mode `%s'" mode)
2210 (setq done t)
3467488e 2211 (or (set-auto-mode-0 mode keep-mode-if-same)
df4d0613 2212 ;; continuing would call minor modes again, toggling them off
ec6328a2
EZ
2213 (throw 'nop nil))))))
2214 (unless done
9e6f5419
DP
2215 ;; If we didn't, look for an interpreter specified in the first line.
2216 ;; As a special case, allow for things like "#!/bin/env perl", which
2217 ;; finds the interpreter anywhere in $PATH.
2218 (setq mode (save-excursion
2219 (goto-char (point-min))
2220 (if (looking-at auto-mode-interpreter-regexp)
2221 (match-string 2)
2222 ""))
2223 ;; Map interpreter name to a mode, signalling we're done at the
2224 ;; same time.
2225 done (assoc (file-name-nondirectory mode)
df4d0613 2226 interpreter-mode-alist))
811cab86 2227 ;; If we found an interpreter mode to use, invoke it now.
df4d0613
DP
2228 (if done
2229 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
811cab86 2230 ;; If we didn't, match the buffer beginning against magic-mode-alist.
df4d0613 2231 (unless done
4ac1d37a
DP
2232 (if (setq done (save-excursion
2233 (goto-char (point-min))
5cce080e
KS
2234 (save-restriction
2235 (narrow-to-region (point-min)
2236 (min (point-max)
2237 (+ (point-min) magic-mode-regexp-match-limit)))
2238 (assoc-default nil magic-mode-alist
2239 (lambda (re dummy)
10ffa2a1
KS
2240 (if (functionp re)
2241 (funcall re)
2242 (looking-at re)))))))
4ac1d37a 2243 (set-auto-mode-0 done keep-mode-if-same)
811cab86 2244 ;; Compare the filename against the entries in auto-mode-alist.
4ac1d37a
DP
2245 (if buffer-file-name
2246 (let ((name buffer-file-name))
2247 ;; Remove backup-suffixes from file name.
2248 (setq name (file-name-sans-versions name))
2249 (while name
2250 ;; Find first matching alist entry.
94495713
KS
2251 (setq mode
2252 (if (memq system-type '(vax-vms windows-nt cygwin))
2253 ;; System is case-insensitive.
2254 (let ((case-fold-search t))
2255 (assoc-default name auto-mode-alist
2256 'string-match))
2257 ;; System is case-sensitive.
2258 (or
2259 ;; First match case-sensitively.
2260 (let ((case-fold-search nil))
2261 (assoc-default name auto-mode-alist
2262 'string-match))
2263 ;; Fallback to case-insensitive match.
2264 (and auto-mode-case-fold
2265 (let ((case-fold-search t))
2266 (assoc-default name auto-mode-alist
2267 'string-match))))))
2268 (if (and mode
2269 (consp mode)
2270 (cadr mode))
2271 (setq mode (car mode)
2272 name (substring name 0 (match-beginning 0)))
2273 (setq name))
4ac1d37a
DP
2274 (when mode
2275 (set-auto-mode-0 mode keep-mode-if-same)))))))))
521cf174 2276
521cf174
DP
2277;; When `keep-mode-if-same' is set, we are working on behalf of
2278;; set-visited-file-name. In that case, if the major mode specified is the
2279;; same one we already have, don't actually reset it. We don't want to lose
2280;; minor modes such as Font Lock.
3467488e 2281(defun set-auto-mode-0 (mode &optional keep-mode-if-same)
521cf174 2282 "Apply MODE and return it.
3467488e
KS
2283If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2284any aliases and compared to current major mode. If they are the
2285same, do nothing and return nil."
521cf174
DP
2286 (when keep-mode-if-same
2287 (while (symbolp (symbol-function mode))
2288 (setq mode (symbol-function mode)))
2289 (if (eq mode major-mode)
3467488e 2290 (setq mode nil)))
521cf174
DP
2291 (when mode
2292 (funcall mode)
2293 mode))
b4da00e9 2294
e3f9b9c0
RS
2295(defun set-auto-mode-1 ()
2296 "Find the -*- spec in the buffer.
2297Call with point at the place to start searching from.
2298If one is found, set point to the beginning
2299and return the position of the end.
2300Otherwise, return nil; point may be changed."
2301 (let (beg end)
2302 (and
2303 ;; Don't look for -*- if this file name matches any
2304 ;; of the regexps in inhibit-first-line-modes-regexps.
2305 (let ((temp inhibit-first-line-modes-regexps)
2306 (name (if buffer-file-name
2307 (file-name-sans-versions buffer-file-name)
2308 (buffer-name))))
2309 (while (let ((sufs inhibit-first-line-modes-suffixes))
2310 (while (and sufs (not (string-match (car sufs) name)))
2311 (setq sufs (cdr sufs)))
2312 sufs)
2313 (setq name (substring name 0 (match-beginning 0))))
2314 (while (and temp
2315 (not (string-match (car temp) name)))
2316 (setq temp (cdr temp)))
2317 (not temp))
2318
f587e30b
SM
2319 (search-forward "-*-" (line-end-position
2320 ;; If the file begins with "#!"
2321 ;; (exec interpreter magic), look
2322 ;; for mode frobs in the first two
2323 ;; lines. You cannot necessarily
2324 ;; put them in the first line of
2325 ;; such a file without screwing up
2326 ;; the interpreter invocation.
2327 (and (looking-at "^#!") 2)) t)
e3f9b9c0
RS
2328 (progn
2329 (skip-chars-forward " \t")
2330 (setq beg (point))
f587e30b 2331 (search-forward "-*-" (line-end-position) t))
e3f9b9c0
RS
2332 (progn
2333 (forward-char -3)
2334 (skip-chars-backward " \t")
2335 (setq end (point))
2336 (goto-char beg)
2337 end))))
b9e1451a
CY
2338\f
2339;;; Handling file local variables
2340
2341(defvar ignored-local-variables
2342 '(ignored-local-variables safe-local-variable-values)
2343 "Variables to be ignored in a file's local variable spec.")
2344
2345(defvar hack-local-variables-hook nil
2346 "Normal hook run after processing a file's local variables specs.
2347Major modes can use this to examine user-specified local variables
2348in order to initialize other data structure based on them.")
2349
2350(defcustom safe-local-variable-values nil
2351 "List variable-value pairs that are considered safe.
2352Each element is a cons cell (VAR . VAL), where VAR is a variable
2353symbol and VAL is a value that is considered safe."
2354 :group 'find-file
2355 :type 'alist)
2356
2357(defcustom safe-local-eval-forms nil
ba83982b 2358 "Expressions that are considered safe in an `eval:' local variable.
b9e1451a
CY
2359Add expressions to this list if you want Emacs to evaluate them, when
2360they appear in an `eval' local variable specification, without first
2361asking you for confirmation."
2362 :group 'find-file
2363 :version "22.1"
2364 :type '(repeat sexp))
2365
2366;; Risky local variables:
2367(mapc (lambda (var) (put var 'risky-local-variable t))
2368 '(after-load-alist
2369 auto-mode-alist
2370 buffer-auto-save-file-name
2371 buffer-file-name
2372 buffer-file-truename
2373 buffer-undo-list
2374 dabbrev-case-fold-search
2375 dabbrev-case-replace
2376 debugger
2377 default-text-properties
2378 display-time-string
2379 enable-local-eval
e58cec15 2380 enable-local-variables
b9e1451a
CY
2381 eval
2382 exec-directory
2383 exec-path
2384 file-name-handler-alist
2385 font-lock-defaults
2386 format-alist
2387 frame-title-format
2388 global-mode-string
2389 header-line-format
2390 icon-title-format
2391 ignored-local-variables
2392 imenu--index-alist
2393 imenu-generic-expression
2394 inhibit-quit
2395 input-method-alist
2396 load-path
2397 max-lisp-eval-depth
2398 max-specpdl-size
2399 minor-mode-alist
2400 minor-mode-map-alist
2401 minor-mode-overriding-map-alist
2402 mode-line-buffer-identification
2403 mode-line-format
2404 mode-line-modes
2405 mode-line-modified
2406 mode-line-mule-info
2407 mode-line-position
2408 mode-line-process
2409 mode-name
2410 outline-level
2411 overriding-local-map
2412 overriding-terminal-local-map
2413 parse-time-rules
2414 process-environment
2415 rmail-output-file-alist
e58cec15
RS
2416 safe-local-variable-values
2417 safe-local-eval-forms
b9e1451a
CY
2418 save-some-buffers-action-alist
2419 special-display-buffer-names
2420 standard-input
2421 standard-output
2422 unread-command-events
2423 vc-mode))
2424
2425;; Safe local variables:
2426;;
3e457225
RS
2427;; For variables defined by major modes, the safety declarations can go into
2428;; the major mode's file, since that will be loaded before file variables are
2429;; processed.
2430;;
2431;; For variables defined by minor modes, put the safety declarations in the
2432;; file defining the minor mode after the defcustom/defvar using an autoload
2433;; cookie, e.g.:
2434;;
2435;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2436;;
2437;; Otherwise, when Emacs visits a file specifying that local variable, the
2438;; minor mode file may not be loaded yet.
2439;;
2440;; For variables defined in the C source code the declaration should go here:
b9e1451a 2441
0a51c121
JL
2442(mapc (lambda (pair)
2443 (put (car pair) 'safe-local-variable (cdr pair)))
1eb1a906
RS
2444 '((buffer-read-only . booleanp) ;; C source code
2445 (fill-column . integerp) ;; C source code
0a51c121 2446 (indent-tabs-mode . booleanp) ;; C source code
631c8020 2447 (left-margin . integerp) ;; C source code
0a51c121 2448 (no-update-autoloads . booleanp)
0a51c121 2449 (tab-width . integerp) ;; C source code
7f385e47 2450 (truncate-lines . booleanp))) ;; C source code
b9e1451a
CY
2451
2452(put 'c-set-style 'safe-local-eval-function t)
e3f9b9c0 2453
5a6c1d87
CY
2454(defun hack-local-variables-confirm (vars unsafe-vars risky-vars)
2455 (if noninteractive
2456 nil
2457 (let ((name (if buffer-file-name
2458 (file-name-nondirectory buffer-file-name)
2459 (concat "buffer " (buffer-name))))
af467e28 2460 (offer-save (and (eq enable-local-variables t) unsafe-vars))
0a158521 2461 prompt char)
5a6c1d87 2462 (save-window-excursion
0a158521 2463 (let ((buf (get-buffer-create "*Local Variables*")))
42078bb2
CY
2464 (pop-to-buffer buf)
2465 (set (make-local-variable 'cursor-type) nil)
2466 (erase-buffer)
5a6c1d87 2467 (if unsafe-vars
42078bb2
CY
2468 (insert "The local variables list in " name
2469 "\ncontains values that may not be safe (*)"
2470 (if risky-vars
2471 ", and variables that are risky (**)."
2472 "."))
5a6c1d87 2473 (if risky-vars
42078bb2
CY
2474 (insert "The local variables list in " name
2475 "\ncontains variables that are risky (**).")
2476 (insert "A local variables list is specified in " name ".")))
2477 (insert "\n\nDo you want to apply it? You can type
5a6c1d87 2478y -- to apply the local variables list.
af467e28
CY
2479n -- to ignore the local variables list.")
2480 (if offer-save
2481 (insert "
dbcd3ce0
EZ
2482! -- to apply the local variables list, and permanently mark these
2483 values (*) as safe (in the future, they will be set automatically.)\n\n")
af467e28 2484 (insert "\n\n"))
5a6c1d87
CY
2485 (dolist (elt vars)
2486 (cond ((member elt unsafe-vars)
42078bb2 2487 (insert " * "))
5a6c1d87 2488 ((member elt risky-vars)
42078bb2 2489 (insert " ** "))
5a6c1d87 2490 (t
42078bb2
CY
2491 (insert " ")))
2492 (princ (car elt) buf)
2493 (insert " : ")
e442c62b
SM
2494 ;; Make strings with embedded whitespace easier to read.
2495 (let ((print-escape-newlines t))
2496 (prin1 (cdr elt) buf))
42078bb2 2497 (insert "\n"))
af467e28
CY
2498 (setq prompt
2499 (format "Please type %s%s: "
2500 (if offer-save "y, n, or !" "y or n")
2501 (if (< (line-number-at-pos) (window-body-height))
2502 ""
2503 ", or C-v to scroll")))
2504 (goto-char (point-min))
a5ce12c3 2505 (let ((cursor-in-echo-area t)
af467e28
CY
2506 (exit-chars
2507 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
42078bb2
CY
2508 done)
2509 (while (not done)
2510 (message prompt)
2511 (setq char (read-event))
2512 (if (numberp char)
2513 (if (eq char ?\C-v)
2514 (condition-case nil
2515 (scroll-up)
2516 (error (goto-char (point-min))))
a5ce12c3 2517 (setq done (memq (downcase char) exit-chars))))))
42078bb2 2518 (setq char (downcase char))
af467e28 2519 (when (and offer-save (= char ?!) unsafe-vars)
42078bb2
CY
2520 (dolist (elt unsafe-vars)
2521 (add-to-list 'safe-local-variable-values elt))
4299d849
CY
2522 ;; When this is called from desktop-restore-file-buffer,
2523 ;; coding-system-for-read may be non-nil. Reset it before
2524 ;; writing to .emacs.
af467e28
CY
2525 (if (or custom-file user-init-file)
2526 (let ((coding-system-for-read nil))
2527 (customize-save-variable
2528 'safe-local-variable-values
2529 safe-local-variable-values))))
0a158521 2530 (kill-buffer buf)
42078bb2
CY
2531 (or (= char ?!)
2532 (= char ?\s)
2533 (= char ?y)))))))
cc45837e 2534
a0e74e72 2535(defun hack-local-variables-prop-line (&optional mode-only)
5a6c1d87 2536 "Return local variables specified in the -*- line.
ffc0e1ca
AS
2537Ignore any specification for `mode:' and `coding:';
2538`set-auto-mode' should already have handled `mode:',
a0e74e72 2539`set-auto-coding' should already have handled `coding:'.
5a6c1d87
CY
2540
2541If MODE-ONLY is non-nil, all we do is check whether the major
2542mode is specified, returning t if it is specified. Otherwise,
2543return an alist of elements (VAR . VAL), where VAR is a variable
2544and VAL is the specified value."
f3e23606
RS
2545 (save-excursion
2546 (goto-char (point-min))
5a6c1d87
CY
2547 (let ((end (set-auto-mode-1))
2548 result mode-specified)
a0e74e72
RS
2549 ;; Parse the -*- line into the RESULT alist.
2550 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
e3f9b9c0 2551 (cond ((not end)
f3e23606
RS
2552 nil)
2553 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180 2554 ;; Simple form: "-*- MODENAME -*-". Already handled.
a0e74e72 2555 (setq mode-specified t)
13a66180 2556 nil)
f3e23606
RS
2557 (t
2558 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2559 ;; (last ";" is optional).
f3e23606
RS
2560 (while (< (point) end)
2561 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
ffc0e1ca 2562 (error "Malformed -*- line"))
f3e23606 2563 (goto-char (match-end 0))
1c26a6f3
KH
2564 ;; There used to be a downcase here,
2565 ;; but the manual didn't say so,
2566 ;; and people want to set var names that aren't all lc.
e442c62b 2567 (let ((key (intern (match-string 1)))
f3e23606
RS
2568 (val (save-restriction
2569 (narrow-to-region (point) end)
2570 (read (current-buffer)))))
93a2702d
RS
2571 ;; It is traditional to ignore
2572 ;; case when checking for `mode' in set-auto-mode,
2573 ;; so we must do that here as well.
2574 ;; That is inconsistent, but we're stuck with it.
1314c787 2575 ;; The same can be said for `coding' in set-auto-coding.
5a6c1d87
CY
2576 (or (and (equal (downcase (symbol-name key)) "mode")
2577 (setq mode-specified t))
3fa0a9aa 2578 (equal (downcase (symbol-name key)) "coding")
5a6c1d87
CY
2579 (condition-case nil
2580 (push (cons (if (eq key 'eval)
2581 'eval
2582 (indirect-variable key))
2583 val) result)
2584 (error nil)))
2585 (skip-chars-forward " \t;")))))
2586
2587 (if mode-only
2588 mode-specified
2589 result))))
f3e23606 2590
9de9b6a2
RS
2591(defun hack-local-variables (&optional mode-only)
2592 "Parse and put into effect this buffer's local variables spec.
2593If MODE-ONLY is non-nil, all we do is check whether the major mode
2594is specified, returning t if it is specified."
5a6c1d87
CY
2595 (let ((enable-local-variables
2596 (and local-enable-local-variables enable-local-variables))
2597 result)
2598 (when (or mode-only enable-local-variables)
2599 (setq result (hack-local-variables-prop-line mode-only))
2600 ;; Look for "Local variables:" line in last page.
2601 (save-excursion
2602 (goto-char (point-max))
2603 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2604 'move)
2605 (when (let ((case-fold-search t))
2606 (search-forward "Local Variables:" nil t))
2607 (skip-chars-forward " \t")
2608 ;; suffix is what comes after "local variables:" in its line.
2609 ;; prefix is what comes before "local variables:" in its line.
2610 (let ((suffix
2611 (concat
2612 (regexp-quote (buffer-substring (point)
2613 (line-end-position)))
2614 "$"))
2615 (prefix
2616 (concat "^" (regexp-quote
2617 (buffer-substring (line-beginning-position)
2618 (match-beginning 0)))))
2619 beg)
2620
2621 (forward-line 1)
2622 (let ((startpos (point))
2623 endpos
2624 (thisbuf (current-buffer)))
2625 (save-excursion
2626 (unless (let ((case-fold-search t))
2627 (re-search-forward
2628 (concat prefix "[ \t]*End:[ \t]*" suffix)
2629 nil t))
2630 (error "Local variables list is not properly terminated"))
2631 (beginning-of-line)
2632 (setq endpos (point)))
2633
2634 (with-temp-buffer
2635 (insert-buffer-substring thisbuf startpos endpos)
2636 (goto-char (point-min))
2637 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2638 (while (not (eobp))
2639 ;; Discard the prefix.
2640 (if (looking-at prefix)
2641 (delete-region (point) (match-end 0))
2642 (error "Local variables entry is missing the prefix"))
2643 (end-of-line)
2644 ;; Discard the suffix.
2645 (if (looking-back suffix)
2646 (delete-region (match-beginning 0) (point))
2647 (error "Local variables entry is missing the suffix"))
2648 (forward-line 1))
2649 (goto-char (point-min))
2650
2651 (while (not (eobp))
2652 ;; Find the variable name; strip whitespace.
2653 (skip-chars-forward " \t")
2654 (setq beg (point))
2655 (skip-chars-forward "^:\n")
2656 (if (eolp) (error "Missing colon in local variables entry"))
2657 (skip-chars-backward " \t")
2658 (let* ((str (buffer-substring beg (point)))
2659 (var (read str))
2660 val)
2661 ;; Read the variable value.
2662 (skip-chars-forward "^:")
2663 (forward-char 1)
2664 (setq val (read (current-buffer)))
2665 (if mode-only
2666 (if (eq var 'mode)
2667 (setq result t))
1314c787 2668 (unless (eq var 'coding)
5a6c1d87
CY
2669 (condition-case nil
2670 (push (cons (if (eq var 'eval)
2671 'eval
2672 (indirect-variable var))
2673 val) result)
2674 (error nil)))))
2675 (forward-line 1)))))))
2676
2677 ;; We've read all the local variables. Now, return whether the
2678 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2679 ;; variables (if MODE-ONLY is nil.)
2680 (if mode-only
2681 result
d450f2a2
CY
2682 (dolist (ignored ignored-local-variables)
2683 (setq result (assq-delete-all ignored result)))
2684 (if (null enable-local-eval)
2685 (setq result (assq-delete-all 'eval result)))
dd60bebe
CY
2686 (when result
2687 (setq result (nreverse result))
dd60bebe
CY
2688 ;; Find those variables that we may want to save to
2689 ;; `safe-local-variable-values'.
2690 (let (risky-vars unsafe-vars)
2691 (dolist (elt result)
2692 (let ((var (car elt))
2693 (val (cdr elt)))
2694 (or (eq var 'mode)
2695 (and (eq var 'eval)
2696 (or (eq enable-local-eval t)
2697 (hack-one-local-variable-eval-safep
2698 (eval (quote val)))))
2699 (safe-local-variable-p var val)
2700 (and (risky-local-variable-p var val)
2701 (push elt risky-vars))
2702 (push elt unsafe-vars))))
a5ce12c3
RS
2703 (if (eq enable-local-variables :safe)
2704 ;; If caller wants only the safe variables,
2705 ;; install only them.
dd60bebe 2706 (dolist (elt result)
a5ce12c3
RS
2707 (unless (or (memq (car elt) unsafe-vars)
2708 (memq (car elt) risky-vars))
2709 (hack-one-local-variable (car elt) (cdr elt))))
2710 ;; Query, except in the case where all are known safe
2711 ;; if the user wants no quuery in that case.
2712 (if (or (and (eq enable-local-variables t)
2713 (null unsafe-vars)
2714 (null risky-vars))
e58cec15 2715 (eq enable-local-variables :all)
a5ce12c3
RS
2716 (hack-local-variables-confirm
2717 result unsafe-vars risky-vars))
2718 (dolist (elt result)
a548f3d7
CY
2719 (hack-one-local-variable (car elt) (cdr elt)))))))
2720 (run-hooks 'hack-local-variables-hook)))))
5a6c1d87 2721
5a6c1d87
CY
2722(defun safe-local-variable-p (sym val)
2723 "Non-nil if SYM is safe as a file-local variable with value VAL.
2724It is safe if any of these conditions are met:
2725
2726 * There is a matching entry (SYM . VAL) in the
2727 `safe-local-variable-values' user option.
2728
5a6c1d87
CY
2729 * The `safe-local-variable' property of SYM is a function that
2730 evaluates to a non-nil value with VAL as an argument."
2731 (or (member (cons sym val) safe-local-variable-values)
2732 (let ((safep (get sym 'safe-local-variable)))
80aa4695 2733 (and (functionp safep) (funcall safep val)))))
5a6c1d87
CY
2734
2735(defun risky-local-variable-p (sym &optional ignored)
2736 "Non-nil if SYM could be dangerous as a file-local variable.
2737It is dangerous if either of these conditions are met:
2738
2739 * Its `risky-local-variable' property is non-nil.
2740
2741 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
2742 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
cc5a104d
RS
2743 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
2744 \"map-alist\", or \"bindat-spec\"."
f36d46ca
RS
2745 ;; If this is an alias, check the base name.
2746 (condition-case nil
2747 (setq sym (indirect-variable sym))
2748 (error nil))
5a6c1d87
CY
2749 (or (get sym 'risky-local-variable)
2750 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
2751-commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
2752-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
cc5a104d 2753-map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
7ed9159a 2754
d0bd3513
RS
2755(defun hack-one-local-variable-quotep (exp)
2756 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2757
ff7affeb
RS
2758(defun hack-one-local-variable-constantp (exp)
2759 (or (and (not (symbolp exp)) (not (consp exp)))
2760 (memq exp '(t nil))
2761 (keywordp exp)
2762 (hack-one-local-variable-quotep exp)))
2763
2764(defun hack-one-local-variable-eval-safep (exp)
2765 "Return t if it is safe to eval EXP when it is found in a file."
8fd9c174
RS
2766 (or (not (consp exp))
2767 ;; Detect certain `put' expressions.
2768 (and (eq (car exp) 'put)
2769 (hack-one-local-variable-quotep (nth 1 exp))
2770 (hack-one-local-variable-quotep (nth 2 exp))
bc5d1dfb
EZ
2771 (let ((prop (nth 1 (nth 2 exp))) (val (nth 3 exp)))
2772 (cond ((eq prop 'lisp-indent-hook)
2773 ;; Only allow safe values of lisp-indent-hook;
2774 ;; not functions.
2775 (or (numberp val) (equal val ''defun)))
2776 ((eq prop 'edebug-form-spec)
2777 ;; Only allow indirect form specs.
b486a098
SM
2778 ;; During bootstrapping, edebug-basic-spec might not be
2779 ;; defined yet.
2780 (and (fboundp 'edebug-basic-spec)
2781 (edebug-basic-spec val))))))
8fd9c174
RS
2782 ;; Allow expressions that the user requested.
2783 (member exp safe-local-eval-forms)
2784 ;; Certain functions can be allowed with safe arguments
2785 ;; or can specify verification functions to try.
2786 (and (symbolp (car exp))
2787 (let ((prop (get (car exp) 'safe-local-eval-function)))
2788 (cond ((eq prop t)
2789 (let ((ok t))
2790 (dolist (arg (cdr exp))
2791 (unless (hack-one-local-variable-constantp arg)
2792 (setq ok nil)))
2793 ok))
2794 ((functionp prop)
2795 (funcall prop exp))
2796 ((listp prop)
2797 (let ((ok nil))
2798 (dolist (function prop)
2799 (if (funcall function exp)
2800 (setq ok t)))
2801 ok)))))))
ff7affeb 2802
f3e23606 2803(defun hack-one-local-variable (var val)
5a6c1d87 2804 "Set local variable VAR with value VAL."
f3e23606 2805 (cond ((eq var 'mode)
e442c62b 2806 (funcall (intern (concat (downcase (symbol-name val)) "-mode"))))
5a6c1d87
CY
2807 ((eq var 'eval)
2808 (save-excursion (eval val)))
e442c62b
SM
2809 (t
2810 ;; Make sure the string has no text properties.
2811 ;; Some text properties can get evaluated in various ways,
2812 ;; so it is risky to put them on with a local variable list.
2813 (if (stringp val)
2814 (set-text-properties 0 (length val) nil val))
2815 (set (make-local-variable var) val))))
f3e23606 2816
b4da00e9 2817\f
21540597 2818(defcustom change-major-mode-with-file-name t
ba83982b 2819 "Non-nil means \\[write-file] should set the major mode from the file name.
9de9b6a2
RS
2820However, the mode will not be changed if
2821\(1) a local variables list or the `-*-' line specifies a major mode, or
2822\(2) the current major mode is a \"special\" mode,
8609911b 2823\ not suitable for ordinary files, or
21540597
RS
2824\(3) the new file name does not particularly specify any mode."
2825 :type 'boolean
2826 :group 'editing-basics)
9de9b6a2 2827
f36012a6 2828(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9 2829 "Change name of file visited in current buffer to FILENAME.
1af57101 2830This also renames the buffer to correspond to the new file.
b4da00e9 2831The next time the buffer is saved it will go in the newly specified file.
1af57101 2832FILENAME nil or an empty string means mark buffer as not visiting any file.
b4da00e9 2833Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
2834if you wish to pass an empty string as the argument.
2835
2836The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
2837confirmation in the case where another buffer is already visiting FILENAME.
2838
2839The optional third argument ALONG-WITH-FILE, if non-nil, means that
2840the old visited file has been renamed to the new name FILENAME."
b4da00e9 2841 (interactive "FSet visited file name: ")
c11a94fe
RS
2842 (if (buffer-base-buffer)
2843 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
2844 (let (truename)
2845 (if filename
2846 (setq filename
2847 (if (string-equal filename "")
2848 nil
2849 (expand-file-name filename))))
2850 (if filename
2851 (progn
2852 (setq truename (file-truename filename))
2853 (if find-file-visit-truename
a522e5bf 2854 (setq filename truename))))
cbca0a4b 2855 (if filename
e6d0b67a 2856 (let ((new-name (file-name-nondirectory filename)))
cbca0a4b
RS
2857 (if (string= new-name "")
2858 (error "Empty file name"))))
11e314fa 2859 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 2860 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 2861 (not no-query)
674b7bae
JB
2862 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
2863 filename)))
7b89d38e 2864 (error "Aborted")))
a522e5bf
RS
2865 (or (equal filename buffer-file-name)
2866 (progn
2867 (and filename (lock-buffer filename))
2868 (unlock-buffer)))
2869 (setq buffer-file-name filename)
2870 (if filename ; make buffer name reflect filename.
2871 (let ((new-name (file-name-nondirectory buffer-file-name)))
a522e5bf
RS
2872 (if (eq system-type 'vax-vms)
2873 (setq new-name (downcase new-name)))
2874 (setq default-directory (file-name-directory buffer-file-name))
67b6fd1c
SM
2875 ;; If new-name == old-name, renaming would add a spurious <2>
2876 ;; and it's considered as a feature in rename-buffer.
a522e5bf
RS
2877 (or (string= new-name (buffer-name))
2878 (rename-buffer new-name t))))
2879 (setq buffer-backed-up nil)
f36012a6
RS
2880 (or along-with-file
2881 (clear-visited-file-modtime))
8ccdc29e 2882 ;; Abbreviate the file names of the buffer.
4826e97f 2883 (if truename
8ccdc29e
RS
2884 (progn
2885 (setq buffer-file-truename (abbreviate-file-name truename))
2886 (if find-file-visit-truename
b1f1ceb8 2887 (setq buffer-file-name truename))))
a522e5bf
RS
2888 (setq buffer-file-number
2889 (if filename
2a47b4f5 2890 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 2891 nil)))
0370fe77 2892 ;; write-file-functions is normally used for things like ftp-find-file
b4da00e9
RM
2893 ;; that visit things that are not local files as if they were files.
2894 ;; Changing to visit an ordinary local file instead should flush the hook.
0370fe77 2895 (kill-local-variable 'write-file-functions)
c9dca4e0 2896 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
2897 (kill-local-variable 'revert-buffer-function)
2898 (kill-local-variable 'backup-inhibited)
ee81c959
RS
2899 ;; If buffer was read-only because of version control,
2900 ;; that reason is gone now, so make it writable.
2901 (if vc-mode
2902 (setq buffer-read-only nil))
2903 (kill-local-variable 'vc-mode)
b4da00e9
RM
2904 ;; Turn off backup files for certain file names.
2905 ;; Since this is a permanent local, the major mode won't eliminate it.
4d49551a
KH
2906 (and buffer-file-name
2907 (not (funcall backup-enable-predicate buffer-file-name))
b4da00e9
RM
2908 (progn
2909 (make-local-variable 'backup-inhibited)
2910 (setq backup-inhibited t)))
c77a81cf
RS
2911 (let ((oauto buffer-auto-save-file-name))
2912 ;; If auto-save was not already on, turn it on if appropriate.
2913 (if (not buffer-auto-save-file-name)
2914 (and buffer-file-name auto-save-default
2915 (auto-save-mode t))
2916 ;; If auto save is on, start using a new name.
2917 ;; We deliberately don't rename or delete the old auto save
2918 ;; for the old visited file name. This is because perhaps
2919 ;; the user wants to save the new state and then compare with the
2920 ;; previous state from the auto save file.
2921 (setq buffer-auto-save-file-name
2922 (make-auto-save-file-name)))
2923 ;; Rename the old auto save file if any.
2924 (and oauto buffer-auto-save-file-name
e6f0e76c 2925 (file-exists-p oauto)
c77a81cf 2926 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
2927 (and buffer-file-name
2928 (not along-with-file)
9de9b6a2
RS
2929 (set-buffer-modified-p t))
2930 ;; Update the major mode, if the file name determines it.
2931 (condition-case nil
2932 ;; Don't change the mode if it is special.
2933 (or (not change-major-mode-with-file-name)
2934 (get major-mode 'mode-class)
2935 ;; Don't change the mode if the local variable list specifies it.
2936 (hack-local-variables t)
2937 (set-auto-mode t))
2938 (error nil)))
b4da00e9 2939
912192d1 2940(defun write-file (filename &optional confirm)
b4da00e9 2941 "Write current buffer into file FILENAME.
7f99999a 2942This makes the buffer visit that file, and marks it as not modified.
7458cc35 2943
7f99999a
KH
2944If you specify just a directory name as FILENAME, that means to use
2945the default file name but in that directory. You can also yank
074eb6ac 2946the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
7f99999a
KH
2947
2948If the buffer is not already visiting a file, the default file name
2949for the output file is the buffer name.
2950
2951If optional second arg CONFIRM is non-nil, this function
2952asks for confirmation before overwriting an existing file.
912192d1 2953Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
2954;; (interactive "FWrite file: ")
2955 (interactive
2956 (list (if buffer-file-name
2957 (read-file-name "Write file: "
f3684505 2958 nil nil nil nil)
7f99999a
KH
2959 (read-file-name "Write file: " default-directory
2960 (expand-file-name
2961 (file-name-nondirectory (buffer-name))
2962 default-directory)
2963 nil nil))
912192d1 2964 (not current-prefix-arg)))
b4da00e9 2965 (or (null filename) (string-equal filename "")
41f48cb1
RS
2966 (progn
2967 ;; If arg is just a directory,
7f99999a
KH
2968 ;; use the default file name, but in that directory.
2969 (if (file-directory-p filename)
41f48cb1 2970 (setq filename (concat (file-name-as-directory filename)
7f99999a
KH
2971 (file-name-nondirectory
2972 (or buffer-file-name (buffer-name))))))
c2fb8488
RS
2973 (and confirm
2974 (file-exists-p filename)
2975 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2976 (error "Canceled")))
5f65549e 2977 (set-visited-file-name filename (not confirm))))
b4da00e9 2978 (set-buffer-modified-p t)
6492b55d
KH
2979 ;; Make buffer writable if file is writable.
2980 (and buffer-file-name
2981 (file-writable-p buffer-file-name)
2982 (setq buffer-read-only nil))
8e5c7b90
SM
2983 (save-buffer)
2984 ;; It's likely that the VC status at the new location is different from
2985 ;; the one at the old location.
2986 (vc-find-file-hook))
b4da00e9
RM
2987\f
2988(defun backup-buffer ()
2989 "Make a backup of the disk file visited by the current buffer, if appropriate.
2990This is normally done before saving the buffer the first time.
27ab6944
KH
2991
2992A backup may be done by renaming or by copying; see documentation of
2993variable `make-backup-files'. If it's done by renaming, then the file is
f3f9e207
RS
2994no longer accessible under its old name.
2995
2996The value is non-nil after a backup was made by renaming.
2997It has the form (MODES . BACKUPNAME).
2998MODES is the result of `file-modes' on the original
2999file; this means that the caller, after saving the buffer, should change
3000the modes of the new file to agree with the old modes.
3001BACKUPNAME is the backup file name, which is the old file renamed."
b4da00e9
RM
3002 (if (and make-backup-files (not backup-inhibited)
3003 (not buffer-backed-up)
3004 (file-exists-p buffer-file-name)
3005 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3006 '(?- ?l)))
3007 (let ((real-file-name buffer-file-name)
3008 backup-info backupname targets setmodes)
3009 ;; If specified name is a symbolic link, chase it to the target.
3010 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 3011 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
3012 (setq backup-info (find-backup-file-name real-file-name)
3013 backupname (car backup-info)
3014 targets (cdr backup-info))
5c6d31a4
SM
3015 ;; (if (file-directory-p buffer-file-name)
3016 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
3017 (if backup-info
3018 (condition-case ()
3019 (let ((delete-old-versions
3020 ;; If have old versions to maybe delete,
3021 ;; ask the user to confirm now, before doing anything.
3022 ;; But don't actually delete til later.
3023 (and targets
3024 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3025 (or delete-old-versions
3026 (y-or-n-p (format "Delete excess backup versions of %s? "
446c63b0
RS
3027 real-file-name)))))
3028 (modes (file-modes buffer-file-name)))
eb650569
RS
3029 ;; Actually write the back up file.
3030 (condition-case ()
3031 (if (or file-precious-flag
ffc0e1ca 3032 ; (file-symlink-p buffer-file-name)
eb650569 3033 backup-by-copying
446c63b0 3034 ;; Don't rename a suid or sgid file.
7da6bf00 3035 (and modes (< 0 (logand modes #o6000)))
79d2d279 3036 (not (file-writable-p (file-name-directory real-file-name)))
eb650569
RS
3037 (and backup-by-copying-when-linked
3038 (> (file-nlinks real-file-name) 1))
ffc0e1ca
AS
3039 (and (or backup-by-copying-when-mismatch
3040 (integerp backup-by-copying-when-privileged-mismatch))
eb650569 3041 (let ((attr (file-attributes real-file-name)))
ffc0e1ca
AS
3042 (and (or backup-by-copying-when-mismatch
3043 (and (integerp (nth 2 attr))
3044 (integerp backup-by-copying-when-privileged-mismatch)
3045 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3046 (or (nth 9 attr)
3047 (not (file-ownership-preserved-p real-file-name)))))))
446c63b0 3048 (backup-buffer-copy real-file-name backupname modes)
eb650569
RS
3049 ;; rename-file should delete old backup.
3050 (rename-file real-file-name backupname t)
446c63b0 3051 (setq setmodes (cons modes backupname)))
eb650569
RS
3052 (file-error
3053 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
3054 (setq backupname (expand-file-name
3055 (convert-standard-filename
3056 "~/%backup%~")))
3057 (message "Cannot write backup file; backing up in %s"
6ba7756e 3058 backupname)
eb650569 3059 (sleep-for 1)
446c63b0 3060 (backup-buffer-copy real-file-name backupname modes)))
eb650569
RS
3061 (setq buffer-backed-up t)
3062 ;; Now delete the old versions, if desired.
3063 (if delete-old-versions
3064 (while targets
3065 (condition-case ()
3066 (delete-file (car targets))
3067 (file-error nil))
3068 (setq targets (cdr targets))))
3069 setmodes)
3070 (file-error nil))))))
b4da00e9 3071
446c63b0 3072(defun backup-buffer-copy (from-name to-name modes)
44dce0fb
RS
3073 (let ((umask (default-file-modes)))
3074 (unwind-protect
3075 (progn
3076 ;; Create temp files with strict access rights. It's easy to
3077 ;; loosen them later, whereas it's impossible to close the
3078 ;; time-window of loose permissions otherwise.
3079 (set-default-file-modes ?\700)
3080 (while (condition-case ()
3081 (progn
3082 (condition-case nil
3083 (delete-file to-name)
3084 (file-error nil))
920e95c0 3085 (copy-file from-name to-name nil t)
44dce0fb
RS
3086 nil)
3087 (file-already-exists t))
689accb8
RS
3088 ;; The file was somehow created by someone else between
3089 ;; `delete-file' and `copy-file', so let's try again.
3090 nil))
44dce0fb
RS
3091 ;; Reset the umask.
3092 (set-default-file-modes umask)))
147fbf70
RS
3093 (and modes
3094 (set-file-modes to-name (logand modes #o1777))))
446c63b0 3095
c3554e95 3096(defun file-name-sans-versions (name &optional keep-backup-version)
ffc0e1ca 3097 "Return file NAME sans backup versions or strings.
b4da00e9 3098This is a separate procedure so your site-init or startup file can
c3554e95
RS
3099redefine it.
3100If the optional argument KEEP-BACKUP-VERSION is non-nil,
3101we do not remove backup version numbers, only true file version numbers."
6eaebaa2 3102 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
3103 (if handler
3104 (funcall handler 'file-name-sans-versions name keep-backup-version)
3105 (substring name 0
3106 (if (eq system-type 'vax-vms)
3107 ;; VMS version number is (a) semicolon, optional
3108 ;; sign, zero or more digits or (b) period, option
3109 ;; sign, zero or more digits, provided this is the
3110 ;; second period encountered outside of the
3111 ;; device/directory part of the file name.
26add1bf
KH
3112 (or (string-match ";[-+]?[0-9]*\\'" name)
3113 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
3114 name)
3115 (match-beginning 1))
3116 (length name))
3117 (if keep-backup-version
3118 (length name)
dbb12f2c 3119 (or (string-match "\\.~[0-9.]+~\\'" name)
c3554e95
RS
3120 (string-match "~\\'" name)
3121 (length name))))))))
b4da00e9 3122
cb0cd911 3123(defun file-ownership-preserved-p (file)
ffc0e1ca 3124 "Return t if deleting FILE and rewriting it would preserve the owner."
cb0cd911
RS
3125 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3126 (if handler
3127 (funcall handler 'file-ownership-preserved-p file)
ec5533be 3128 (let ((attributes (file-attributes file)))
306faa42
RS
3129 ;; Return t if the file doesn't exist, since it's true that no
3130 ;; information would be lost by an (attempted) delete and create.
3131 (or (null attributes)
3132 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 3133
20b5d24c
RS
3134(defun file-name-sans-extension (filename)
3135 "Return FILENAME sans final \"extension\".
2531b0c3
EZ
3136The extension, in a file name, is the part that follows the last `.',
3137except that a leading `.', if any, doesn't count."
20b5d24c
RS
3138 (save-match-data
3139 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3140 directory)
2531b0c3
EZ
3141 (if (and (string-match "\\.[^.]*\\'" file)
3142 (not (eq 0 (match-beginning 0))))
20b5d24c 3143 (if (setq directory (file-name-directory filename))
6ee24f1e
RS
3144 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3145 ;; we don't want to expand it.
3146 (concat directory (substring file 0 (match-beginning 0)))
20b5d24c
RS
3147 (substring file 0 (match-beginning 0)))
3148 filename))))
3149
93a2702d
RS
3150(defun file-name-extension (filename &optional period)
3151 "Return FILENAME's final \"extension\".
2531b0c3 3152The extension, in a file name, is the part that follows the last `.',
32483280 3153excluding version numbers and backup suffixes,
2531b0c3 3154except that a leading `.', if any, doesn't count.
93a2702d
RS
3155Return nil for extensionless file names such as `foo'.
3156Return the empty string for file names such as `foo.'.
3157
3158If PERIOD is non-nil, then the returned value includes the period
3159that delimits the extension, and if FILENAME has no extension,
3160the value is \"\"."
3161 (save-match-data
3162 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2531b0c3
EZ
3163 (if (and (string-match "\\.[^.]*\\'" file)
3164 (not (eq 0 (match-beginning 0))))
93a2702d
RS
3165 (substring file (+ (match-beginning 0) (if period 0 1)))
3166 (if period
3167 "")))))
3168
ffc0e1ca
AS
3169(defcustom make-backup-file-name-function nil
3170 "A function to use instead of the default `make-backup-file-name'.
643c985d 3171A value of nil gives the default `make-backup-file-name' behavior.
ffc0e1ca 3172
d5798fa7 3173This could be buffer-local to do something special for specific
ffc0e1ca
AS
3174files. If you define it, you may need to change `backup-file-name-p'
3175and `file-name-sans-versions' too.
3176
3177See also `backup-directory-alist'."
3178 :group 'backup
3179 :type '(choice (const :tag "Default" nil)
3180 (function :tag "Your function")))
3181
3182(defcustom backup-directory-alist nil
3183 "Alist of filename patterns and backup directory names.
3184Each element looks like (REGEXP . DIRECTORY). Backups of files with
3185names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3186relative or absolute. If it is absolute, so that all matching files
3187are backed up into the same directory, the file names in this
3188directory will be the full name of the file backed up with all
3189directory separators changed to `!' to prevent clashes. This will not
3190work correctly if your filesystem truncates the resulting name.
3191
3192For the common case of all backups going into one directory, the alist
3193should contain a single element pairing \".\" with the appropriate
3194directory name.
3195
3196If this variable is nil, or it fails to match a filename, the backup
3197is made in the original file's directory.
3198
3199On MS-DOS filesystems without long names this variable is always
3200ignored."
3201 :group 'backup
dca5e71d 3202 :type '(repeat (cons (regexp :tag "Regexp matching filename")
ffc0e1ca
AS
3203 (directory :tag "Backup directory name"))))
3204
388d6ab5
RS
3205(defun normal-backup-enable-predicate (name)
3206 "Default `backup-enable-predicate' function.
0c2f6dda
RS
3207Checks for files in `temporary-file-directory',
3208`small-temporary-file-directory', and /tmp."
388d6ab5
RS
3209 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3210 name 0 nil)))
3211 ;; Directory is under temporary-file-directory.
3212 (and (not (eq comp t))
3213 (< comp (- (length temporary-file-directory)))))
0c2f6dda
RS
3214 (let ((comp (compare-strings "/tmp" 0 nil
3215 name 0 nil)))
3216 ;; Directory is under /tmp.
3217 (and (not (eq comp t))
3218 (< comp (- (length "/tmp")))))
388d6ab5
RS
3219 (if small-temporary-file-directory
3220 (let ((comp (compare-strings small-temporary-file-directory
3221 0 nil
3222 name 0 nil)))
3223 ;; Directory is under small-temporary-file-directory.
3224 (and (not (eq comp t))
3225 (< comp (- (length small-temporary-file-directory)))))))))
3226
b4da00e9
RM
3227(defun make-backup-file-name (file)
3228 "Create the non-numeric backup file name for FILE.
ffc0e1ca
AS
3229Normally this will just be the file's name with `~' appended.
3230Customization hooks are provided as follows.
3231
3232If the variable `make-backup-file-name-function' is non-nil, its value
3233should be a function which will be called with FILE as its argument;
3234the resulting name is used.
3235
3236Otherwise a match for FILE is sought in `backup-directory-alist'; see
3237the documentation of that variable. If the directory for the backup
3238doesn't exist, it is created."
3239 (if make-backup-file-name-function
3240 (funcall make-backup-file-name-function file)
3241 (if (and (eq system-type 'ms-dos)
3242 (not (msdos-long-file-names)))
3243 (let ((fn (file-name-nondirectory file)))
3244 (concat (file-name-directory file)
3245 (or (and (string-match "\\`[^.]+\\'" fn)
3246 (concat (match-string 0 fn) ".~"))
3247 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3248 (concat (match-string 0 fn) "~")))))
3249 (concat (make-backup-file-name-1 file) "~"))))
3250
3251(defun make-backup-file-name-1 (file)
3252 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3253 (let ((alist backup-directory-alist)
6ba7756e 3254 elt backup-directory abs-backup-directory)
ffc0e1ca
AS
3255 (while alist
3256 (setq elt (pop alist))
3257 (if (string-match (car elt) file)
3258 (setq backup-directory (cdr elt)
3259 alist nil)))
eb0455ab
RS
3260 ;; If backup-directory is relative, it should be relative to the
3261 ;; file's directory. By expanding explicitly here, we avoid
3262 ;; depending on default-directory.
3263 (if backup-directory
6ba7756e
RS
3264 (setq abs-backup-directory
3265 (expand-file-name backup-directory
3266 (file-name-directory file))))
3267 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
ffc0e1ca 3268 (condition-case nil
6ba7756e
RS
3269 (make-directory abs-backup-directory 'parents)
3270 (file-error (setq backup-directory nil
3271 abs-backup-directory nil))))
ee291b46
RS
3272 (if (null backup-directory)
3273 file
ffc0e1ca
AS
3274 (if (file-name-absolute-p backup-directory)
3275 (progn
c60ee5e7 3276 (when (memq system-type '(windows-nt ms-dos cygwin))
d7b6ca4a
RS
3277 ;; Normalize DOSish file names: downcase the drive
3278 ;; letter, if any, and replace the leading "x:" with
3279 ;; "/drive_x".
ffc0e1ca
AS
3280 (or (file-name-absolute-p file)
3281 (setq file (expand-file-name file))) ; make defaults explicit
3282 ;; Replace any invalid file-name characters (for the
3283 ;; case of backing up remote files).
446c097e 3284 (setq file (expand-file-name (convert-standard-filename file)))
ffc0e1ca 3285 (if (eq (aref file 1) ?:)
d7b6ca4a 3286 (setq file (concat "/"
ffc0e1ca
AS
3287 "drive_"
3288 (char-to-string (downcase (aref file 0)))
d7b6ca4a 3289 (if (eq (aref file 2) ?/)
ffc0e1ca 3290 ""
d7b6ca4a 3291 "/")
ffc0e1ca
AS
3292 (substring file 2)))))
3293 ;; Make the name unique by substituting directory
3294 ;; separators. It may not really be worth bothering about
3295 ;; doubling `!'s in the original name...
3296 (expand-file-name
3297 (subst-char-in-string
d7b6ca4a 3298 ?/ ?!
ffc0e1ca
AS
3299 (replace-regexp-in-string "!" "!!" file))
3300 backup-directory))
3301 (expand-file-name (file-name-nondirectory file)
6ba7756e 3302 (file-name-as-directory abs-backup-directory))))))
b4da00e9
RM
3303
3304(defun backup-file-name-p (file)
3305 "Return non-nil if FILE is a backup file name (numeric or not).
3306This is a separate function so you can redefine it for customization.
3307You may need to redefine `file-name-sans-versions' as well."
066327ae 3308 (string-match "~\\'" file))
b4da00e9 3309
e2b30772
RS
3310(defvar backup-extract-version-start)
3311
2d051399 3312;; This is used in various files.
a7aa942a
KH
3313;; The usage of backup-extract-version-start is not very clean,
3314;; but I can't see a good alternative, so as of now I am leaving it alone.
2d051399 3315(defun backup-extract-version (fn)
ffc0e1ca 3316 "Given the name of a numeric backup file, FN, return the backup number.
e2b30772 3317Uses the free variable `backup-extract-version-start', whose value should be
2d051399 3318the index in the name where the version number begins."
e2b30772
RS
3319 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
3320 (= (match-beginning 0) backup-extract-version-start))
027a4b6b 3321 (string-to-number (substring fn backup-extract-version-start -1))
2d051399
RS
3322 0))
3323
b4da00e9
RM
3324;; I believe there is no need to alter this behavior for VMS;
3325;; since backup files are not made on VMS, it should not get called.
3326(defun find-backup-file-name (fn)
ffc0e1ca 3327 "Find a file name for a backup file FN, and suggestions for deletions.
b4da00e9 3328Value is a list whose car is the name for the backup file
ffc0e1ca
AS
3329and whose cdr is a list of old versions to consider deleting now.
3330If the value is nil, don't make a backup.
3331Uses `backup-directory-alist' in the same way as does
3332`make-backup-file-name'."
eb650569
RS
3333 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3334 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3335 (if handler
3336 (funcall handler 'find-backup-file-name fn)
f26d858e
EZ
3337 (if (or (eq version-control 'never)
3338 ;; We don't support numbered backups on plain MS-DOS
3339 ;; when long file names are unavailable.
3340 (and (eq system-type 'ms-dos)
3341 (not (msdos-long-file-names))))
b4da00e9 3342 (list (make-backup-file-name fn))
ffc0e1ca
AS
3343 (let* ((basic-name (make-backup-file-name-1 fn))
3344 (base-versions (concat (file-name-nondirectory basic-name)
3345 ".~"))
e2b30772 3346 (backup-extract-version-start (length base-versions))
eb650569 3347 (high-water-mark 0)
ffc0e1ca
AS
3348 (number-to-delete 0)
3349 possibilities deserve-versions-p versions)
eb650569
RS
3350 (condition-case ()
3351 (setq possibilities (file-name-all-completions
3352 base-versions
ffc0e1ca
AS
3353 (file-name-directory basic-name))
3354 versions (sort (mapcar #'backup-extract-version
3355 possibilities)
3356 #'<)
eb650569
RS
3357 high-water-mark (apply 'max 0 versions)
3358 deserve-versions-p (or version-control
3359 (> high-water-mark 0))
3360 number-to-delete (- (length versions)
ffc0e1ca
AS
3361 kept-old-versions
3362 kept-new-versions
3363 -1))
3364 (file-error (setq possibilities nil)))
eb650569 3365 (if (not deserve-versions-p)
8767d866 3366 (list (make-backup-file-name fn))
ffc0e1ca 3367 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
eb650569
RS
3368 (if (and (> number-to-delete 0)
3369 ;; Delete nothing if there is overflow
3370 ;; in the number of versions to keep.
3371 (>= (+ kept-new-versions kept-old-versions -1) 0))
ffc0e1ca
AS
3372 (mapcar (lambda (n)
3373 (format "%s.~%d~" basic-name n))
eb650569
RS
3374 (let ((v (nthcdr kept-old-versions versions)))
3375 (rplacd (nthcdr (1- number-to-delete) v) ())
3376 v))))))))))
b4da00e9 3377
b4da00e9
RM
3378(defun file-nlinks (filename)
3379 "Return number of names file FILENAME has."
3380 (car (cdr (file-attributes filename))))
6c636af9 3381
753ad988
KG
3382;; (defun file-relative-name (filename &optional directory)
3383;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3384;; This function returns a relative file name which is equivalent to FILENAME
3385;; when used with that default directory as the default.
3386;; If this is impossible (which can happen on MSDOS and Windows
3387;; when the file name and directory use different drive names)
3388;; then it returns FILENAME."
3389;; (save-match-data
3390;; (let ((fname (expand-file-name filename)))
3391;; (setq directory (file-name-as-directory
3392;; (expand-file-name (or directory default-directory))))
3393;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3394;; ;; drive names, they can't be relative, so return the absolute name.
3395;; (if (and (or (eq system-type 'ms-dos)
3396;; (eq system-type 'cygwin)
3397;; (eq system-type 'windows-nt))
3398;; (not (string-equal (substring fname 0 2)
3399;; (substring directory 0 2))))
3400;; filename
3401;; (let ((ancestor ".")
3402;; (fname-dir (file-name-as-directory fname)))
3403;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3404;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3405;; (setq directory (file-name-directory (substring directory 0 -1))
3406;; ancestor (if (equal ancestor ".")
3407;; ".."
3408;; (concat "../" ancestor))))
3409;; ;; Now ancestor is empty, or .., or ../.., etc.
3410;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3411;; ;; We matched within FNAME's directory part.
3412;; ;; Add the rest of FNAME onto ANCESTOR.
3413;; (let ((rest (substring fname (match-end 0))))
3414;; (if (and (equal ancestor ".")
3415;; (not (equal rest "")))
3416;; ;; But don't bother with ANCESTOR if it would give us `./'.
3417;; rest
3418;; (concat (file-name-as-directory ancestor) rest)))
3419;; ;; We matched FNAME's directory equivalent.
3420;; ancestor))))))
3421
6c636af9 3422(defun file-relative-name (filename &optional directory)
ffc0e1ca 3423 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2d6562a5
RS
3424This function returns a relative file name which is equivalent to FILENAME
3425when used with that default directory as the default.
753ad988 3426If FILENAME and DIRECTORY lie on different machines or on different drives
1be0210d 3427on a DOS/Windows machine, it returns FILENAME in expanded form."
96c188b0 3428 (save-match-data
753ad988
KG
3429 (setq directory
3430 (file-name-as-directory (expand-file-name (or directory
3431 default-directory))))
3432 (setq filename (expand-file-name filename))
3f788773
KG
3433 (let ((fremote (file-remote-p filename))
3434 (dremote (file-remote-p directory)))
493c98af
KG
3435 (if ;; Conditions for separate trees
3436 (or
3437 ;; Test for different drives on DOS/Windows
3438 (and
7c64272b 3439 ;; Should `cygwin' really be included here? --stef
493c98af 3440 (memq system-type '(ms-dos cygwin windows-nt))
7c64272b 3441 (not (eq t (compare-strings filename 0 2 directory 0 2))))
493c98af 3442 ;; Test for different remote file system identification
3f788773 3443 (not (equal fremote dremote)))
e2b30772 3444 filename
753ad988
KG
3445 (let ((ancestor ".")
3446 (filename-dir (file-name-as-directory filename)))
7c64272b
SM
3447 (while (not
3448 (or
3449 (eq t (compare-strings filename-dir nil (length directory)
3450 directory nil nil case-fold-search))
3451 (eq t (compare-strings filename nil (length directory)
3452 directory nil nil case-fold-search))))
753ad988 3453 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
3454 ancestor (if (equal ancestor ".")
3455 ".."
3456 (concat "../" ancestor))))
753ad988 3457 ;; Now ancestor is empty, or .., or ../.., etc.
7c64272b
SM
3458 (if (eq t (compare-strings filename nil (length directory)
3459 directory nil nil case-fold-search))
753ad988
KG
3460 ;; We matched within FILENAME's directory part.
3461 ;; Add the rest of FILENAME onto ANCESTOR.
3f7d6528 3462 (let ((rest (substring filename (length directory))))
753ad988 3463 (if (and (equal ancestor ".") (not (equal rest "")))
9695aac6
RS
3464 ;; But don't bother with ANCESTOR if it would give us `./'.
3465 rest
3466 (concat (file-name-as-directory ancestor) rest)))
753ad988
KG
3467 ;; We matched FILENAME's directory equivalent.
3468 ancestor))))))
b4da00e9
RM
3469\f
3470(defun save-buffer (&optional args)
e8f4db18
RS
3471 "Save current buffer in visited file if modified.
3472Variations are described below.
3473
b4da00e9
RM
3474By default, makes the previous version into a backup file
3475 if previously requested or if this is the first save.
dc2ab26e 3476Prefixed with one \\[universal-argument], marks this version
b4da00e9 3477 to become a backup when the next save is done.
dc2ab26e 3478Prefixed with two \\[universal-argument]'s,
b4da00e9 3479 unconditionally makes the previous version into a backup file.
dc2ab26e 3480Prefixed with three \\[universal-argument]'s, marks this version
ac9650be
RS
3481 to become a backup when the next save is done,
3482 and unconditionally makes the previous version into a backup file.
3483
dc2ab26e
EZ
3484With a numeric argument of 0, never make the previous version
3485into a backup file.
b4da00e9
RM
3486
3487If a file's name is FOO, the names of its numbered backup versions are
3488 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3489Numeric backups (rather than FOO~) will be made if value of
3490 `version-control' is not the atom `never' and either there are already
3491 numeric versions of the file being backed up, or `version-control' is
3492 non-nil.
3493We don't want excessive versions piling up, so there are variables
3494 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3495 and `kept-new-versions', which tells how many newest versions to keep.
3496 Defaults are 2 old versions and 2 new.
3497`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 3498If `delete-old-versions' is nil, system will query user
e73ec04b
RS
3499 before trimming versions. Otherwise it does it silently.
3500
749d2ee6
RS
3501If `vc-make-backup-files' is nil, which is the default,
3502 no backup files are made for files managed by version control.
3503 (This is because the version control system itself records previous versions.)
3504
e73ec04b 3505See the subroutine `basic-save-buffer' for more information."
b4da00e9
RM
3506 (interactive "p")
3507 (let ((modp (buffer-modified-p))
3508 (large (> (buffer-size) 50000))
b5a8e0fc
RS
3509 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3510 (memq args '(16 64)))))
b4da00e9 3511 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
b4990dde
GM
3512 (if (and modp large (buffer-file-name))
3513 (message "Saving file %s..." (buffer-file-name)))
b4da00e9
RM
3514 (basic-save-buffer)
3515 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3516
3517(defun delete-auto-save-file-if-necessary (&optional force)
3518 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3519Normally delete only if the file was written by this Emacs since
3520the last real save, but optional arg FORCE non-nil means delete anyway."
3521 (and buffer-auto-save-file-name delete-auto-save-files
3522 (not (string= buffer-file-name buffer-auto-save-file-name))
3523 (or force (recent-auto-save-p))
3524 (progn
3525 (condition-case ()
3526 (delete-file buffer-auto-save-file-name)
3527 (file-error nil))
3528 (set-buffer-auto-saved))))
3529
481f215b
KH
3530(defvar auto-save-hook nil
3531 "Normal hook run just before auto-saving.")
3532
3c3b81d1
SJ
3533(defcustom before-save-hook nil
3534 "Normal hook that is run before a buffer is saved to its file."
25f6295e 3535 :options '(copyright-update time-stamp)
3c3b81d1
SJ
3536 :type 'hook
3537 :group 'files)
3538
ffc0e1ca
AS
3539(defcustom after-save-hook nil
3540 "Normal hook that is run after a buffer is saved to its file."
3541 :options '(executable-make-buffer-file-executable-if-script-p)
3542 :type 'hook
3543 :group 'files)
1cc852cc 3544
0516edee
RS
3545(defvar save-buffer-coding-system nil
3546 "If non-nil, use this coding system for saving the buffer.
3547More precisely, use this coding system in place of the
3548value of `buffer-file-coding-system', when saving the buffer.
3549Calling `write-region' for any purpose other than saving the buffer
3550will still use `buffer-file-coding-system'; this variable has no effect
3551in such cases.")
3552
d5fe94cc
RS
3553(make-variable-buffer-local 'save-buffer-coding-system)
3554(put 'save-buffer-coding-system 'permanent-local t)
3555
b4da00e9 3556(defun basic-save-buffer ()
1cc852cc 3557 "Save the current buffer in its visited file, if it has been modified.
0370fe77
SM
3558The hooks `write-contents-functions' and `write-file-functions' get a chance
3559to do the job of saving; if they do not, then the buffer is saved in
222cf381 3560the visited file in the usual way.
3c3b81d1
SJ
3561Before and after saving the buffer, this function runs
3562`before-save-hook' and `after-save-hook', respectively."
b4da00e9 3563 (interactive)
19618231 3564 (save-current-buffer
c11a94fe
RS
3565 ;; In an indirect buffer, save its base buffer instead.
3566 (if (buffer-base-buffer)
3567 (set-buffer (buffer-base-buffer)))
3568 (if (buffer-modified-p)
3569 (let ((recent-save (recent-auto-save-p))
818286f4 3570 setmodes)
c11a94fe
RS
3571 ;; On VMS, rename file and buffer to get rid of version number.
3572 (if (and (eq system-type 'vax-vms)
3573 (not (string= buffer-file-name
3574 (file-name-sans-versions buffer-file-name))))
3575 (let (buffer-new-name)
3576 ;; Strip VMS version number before save.
3577 (setq buffer-file-name
3578 (file-name-sans-versions buffer-file-name))
3579 ;; Construct a (unique) buffer name to correspond.
3580 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3581 (setq buffer-new-name (buffer-name buf))
3582 (kill-buffer buf))
3583 (rename-buffer buffer-new-name)))
3584 ;; If buffer has no file name, ask user for one.
3585 (or buffer-file-name
182891ef
RS
3586 (let ((filename
3587 (expand-file-name
3588 (read-file-name "File to save in: ") nil)))
3589 (and (file-exists-p filename)
3590 (or (y-or-n-p (format "File `%s' exists; overwrite? "
3591 filename))
3592 (error "Canceled")))
3593 (set-visited-file-name filename)))
c11a94fe
RS
3594 (or (verify-visited-file-modtime (current-buffer))
3595 (not (file-exists-p buffer-file-name))
3596 (yes-or-no-p
3597 (format "%s has changed since visited or saved. Save anyway? "
3598 (file-name-nondirectory buffer-file-name)))
3599 (error "Save not confirmed"))
3600 (save-restriction
3601 (widen)
19618231 3602 (save-excursion
0370fe77 3603 (and (> (point-max) (point-min))
407b4328 3604 (not find-file-literally)
19618231
RS
3605 (/= (char-after (1- (point-max))) ?\n)
3606 (not (and (eq selective-display t)
3607 (= (char-after (1- (point-max))) ?\r)))
3608 (or (eq require-final-newline t)
f4206092 3609 (eq require-final-newline 'visit-save)
19618231
RS
3610 (and require-final-newline
3611 (y-or-n-p
3612 (format "Buffer %s does not end in newline. Add one? "
3613 (buffer-name)))))
3614 (save-excursion
3615 (goto-char (point-max))
3616 (insert ?\n))))
fa5867f6
AS
3617 ;; Support VC version backups.
3618 (vc-before-save)
3c3b81d1 3619 (run-hooks 'before-save-hook)
0370fe77 3620 (or (run-hook-with-args-until-success 'write-contents-functions)
c11a94fe 3621 (run-hook-with-args-until-success 'local-write-file-hooks)
0370fe77 3622 (run-hook-with-args-until-success 'write-file-functions)
0ba5894b
RS
3623 ;; If a hook returned t, file is already "written".
3624 ;; Otherwise, write it the usual way now.
3625 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
3626 ;; Now we have saved the current buffer. Let's make sure
3627 ;; that buffer-file-coding-system is fixed to what
3628 ;; actually used for saving by binding it locally.
0516edee
RS
3629 (if save-buffer-coding-system
3630 (setq save-buffer-coding-system last-coding-system-used)
3631 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
3632 (setq buffer-file-number
3633 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
3634 (if setmodes
3635 (condition-case ()
f3f9e207 3636 (set-file-modes buffer-file-name (car setmodes))
c11a94fe
RS
3637 (error nil))))
3638 ;; If the auto-save file was recent before this command,
3639 ;; delete it now.
3640 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
3641 ;; Support VC `implicit' locking.
3642 (vc-after-save)
c11a94fe
RS
3643 (run-hooks 'after-save-hook))
3644 (message "(No changes need to be saved)"))))
b4da00e9 3645
87d26afc
RS
3646;; This does the "real job" of writing a buffer into its visited file
3647;; and making a backup file. This is what is normally done
0370fe77 3648;; but inhibited if one of write-file-functions returns non-nil.
f3f9e207 3649;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
87d26afc 3650(defun basic-save-buffer-1 ()
969be033
RS
3651 (prog1
3652 (if save-buffer-coding-system
3653 (let ((coding-system-for-write save-buffer-coding-system))
3654 (basic-save-buffer-2))
d5fe94cc 3655 (basic-save-buffer-2))
969be033 3656 (setq buffer-file-coding-system-explicit last-coding-system-used)))
d5fe94cc 3657
f3f9e207 3658;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
d5fe94cc
RS
3659(defun basic-save-buffer-2 ()
3660 (let (tempsetmodes setmodes)
87d26afc
RS
3661 (if (not (file-writable-p buffer-file-name))
3662 (let ((dir (file-name-directory buffer-file-name)))
3663 (if (not (file-directory-p dir))
83c6f446
RS
3664 (if (file-exists-p dir)
3665 (error "%s is not a directory" dir)
cb2fdcfa 3666 (error "%s: no such directory" buffer-file-name))
87d26afc
RS
3667 (if (not (file-exists-p buffer-file-name))
3668 (error "Directory %s write-protected" dir)
3669 (if (yes-or-no-p
3670 (format "File %s is write-protected; try to save anyway? "
3671 (file-name-nondirectory
3672 buffer-file-name)))
3673 (setq tempsetmodes t)
3674 (error "Attempt to save to a file which you aren't allowed to write"))))))
3675 (or buffer-backed-up
3676 (setq setmodes (backup-buffer)))
76d5492b 3677 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
3678 (if (and file-precious-flag
3679 (file-writable-p dir))
3680 ;; If file is precious, write temp name, then rename it.
3681 ;; This requires write access to the containing dir,
3682 ;; which is why we don't try it if we don't have that access.
3683 (let ((realname buffer-file-name)
44dce0fb
RS
3684 tempname succeed
3685 (umask (default-file-modes))
6782610c 3686 (old-modtime (visited-file-modtime)))
44dce0fb
RS
3687 ;; Create temp files with strict access rights. It's easy to
3688 ;; loosen them later, whereas it's impossible to close the
3689 ;; time-window of loose permissions otherwise.
f4a0f59b 3690 (unwind-protect
44dce0fb
RS
3691 (progn
3692 (clear-visited-file-modtime)
3693 (set-default-file-modes ?\700)
3694 ;; Try various temporary names.
3695 ;; This code follows the example of make-temp-file,
3696 ;; but it calls write-region in the appropriate way
3697 ;; for saving the buffer.
3698 (while (condition-case ()
3699 (progn
3700 (setq tempname
3701 (make-temp-name
3702 (expand-file-name "tmp" dir)))
3703 (write-region (point-min) (point-max)
3704 tempname nil realname
3705 buffer-file-truename 'excl)
3706 nil)
3707 (file-already-exists t))
3708 ;; The file was somehow created by someone else between
3709 ;; `make-temp-name' and `write-region', let's try again.
3710 nil)
3711 (setq succeed t))
3712 ;; Reset the umask.
3713 (set-default-file-modes umask)
3714 ;; If we failed, restore the buffer's modtime.
3715 (unless succeed
3716 (set-visited-file-modtime old-modtime)))
3717 ;; Since we have created an entirely new file,
3718 ;; make sure it gets the right permission bits set.
730df8db 3719 (setq setmodes (or setmodes
562ca538
RS
3720 (cons (or (file-modes buffer-file-name)
3721 (logand ?\666 umask))
730df8db 3722 buffer-file-name)))
f4a0f59b
RS
3723 ;; We succeeded in writing the temp file,
3724 ;; so rename it.
3725 (rename-file tempname buffer-file-name t))
3726 ;; If file not writable, see if we can make it writable
3727 ;; temporarily while we write it.
3728 ;; But no need to do so if we have just backed it up
3729 ;; (setmodes is set) because that says we're superseding.
3730 (cond ((and tempsetmodes (not setmodes))
3731 ;; Change the mode back, after writing.
f3f9e207
RS
3732 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3733 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3734 (let (success)
3735 (unwind-protect
3736 (progn
3737 (write-region (point-min) (point-max)
3738 buffer-file-name nil t buffer-file-truename)
3739 (setq success t))
3740 ;; If we get an error writing the new file, and we made
3741 ;; the backup by renaming, undo the backing-up.
3742 (and setmodes (not success)
0133dab9
EZ
3743 (progn
3744 (rename-file (cdr setmodes) buffer-file-name t)
3745 (setq buffer-backed-up nil)))))))
87d26afc
RS
3746 setmodes))
3747
1eeae2a1
RS
3748(defun diff-buffer-with-file (&optional buffer)
3749 "View the differences between BUFFER and its associated file.
0b9e4749 3750This requires the external program `diff' to be in your `exec-path'."
1eeae2a1 3751 (interactive "bBuffer: ")
0b9e4749 3752 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4e4e9519
MR
3753 (if (and buffer-file-name
3754 (file-exists-p buffer-file-name))
3755 (let ((tempfile (make-temp-file "buffer-content-")))
3756 (unwind-protect
3757 (save-restriction
3758 (widen)
3759 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3760 (diff buffer-file-name tempfile nil t)
3761 (sit-for 0))
3762 (when (file-exists-p tempfile)
3763 (delete-file tempfile))))
3764 (message "Buffer %s has no associated file on disc" (buffer-name))
3765 ;; Display that message for 1 second so that user can read it
3766 ;; in the minibuffer.
3767 (sit-for 1)))
3768 ;; return always nil, so that save-buffers-kill-emacs will not move
3769 ;; over to the next unsaved buffer when calling `d'.
3770 nil)
1eeae2a1
RS
3771
3772(defvar save-some-buffers-action-alist
3773 '((?\C-r
3774 (lambda (buf)
3775 (view-buffer buf
3776 (lambda (ignore)
3777 (exit-recursive-edit)))
3778 (recursive-edit)
3779 ;; Return nil to ask about BUF again.
3780 nil)
5c471b12 3781 "view this buffer")
16abdbe6
CY
3782 (?d (lambda (buf)
3783 (save-window-excursion
3784 (diff-buffer-with-file buf))
3785 (view-buffer (get-buffer-create "*Diff*")
3786 (lambda (ignore) (exit-recursive-edit)))
3787 (recursive-edit)
3788 nil)
5c471b12 3789 "view changes in this buffer"))
1eeae2a1 3790 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
1eeae2a1 3791
a1b0c2a7
RS
3792(defvar buffer-save-without-query nil
3793 "Non-nil means `save-some-buffers' should save this buffer without asking.")
3794(make-variable-buffer-local 'buffer-save-without-query)
3795
ffc0e1ca 3796(defun save-some-buffers (&optional arg pred)
b4da00e9 3797 "Save some modified file-visiting buffers. Asks user about each one.
1eeae2a1
RS
3798You can answer `y' to save, `n' not to save, `C-r' to look at the
3799buffer in question with `view-buffer' before deciding or `d' to
126c9dda 3800view the differences using `diff-buffer-with-file'.
8fd9c174 3801
5bbbceb1 3802Optional argument (the prefix) non-nil means save all with no questions.
ffc0e1ca
AS
3803Optional second argument PRED determines which buffers are considered:
3804If PRED is nil, all the file-visiting buffers are considered.
3805If PRED is t, then certain non-file buffers will also be considered.
3806If PRED is a zero-argument function, it indicates for each buffer whether
1eeae2a1
RS
3807to consider it or not when called with that buffer current.
3808
3809See `save-some-buffers-action-alist' if you want to
3810change the additional actions you can take on files."
b4da00e9 3811 (interactive "P")
907482b9 3812 (save-window-excursion
a1b0c2a7
RS
3813 (let* (queried some-automatic
3814 files-done abbrevs-done)
3815 (dolist (buffer (buffer-list))
3816 ;; First save any buffers that we're supposed to save unconditionally.
3817 ;; That way the following code won't ask about them.
3818 (with-current-buffer buffer
3819 (when (and buffer-save-without-query (buffer-modified-p))
3820 (setq some-automatic t)
3821 (save-buffer))))
3822 ;; Ask about those buffers that merit it,
3823 ;; and record the number thus saved.
3824 (setq files-done
76d5492b
RM
3825 (map-y-or-n-p
3826 (function
3827 (lambda (buffer)
3828 (and (buffer-modified-p buffer)
3829 (not (buffer-base-buffer buffer))
3830 (or
3831 (buffer-file-name buffer)
ffc0e1ca 3832 (and pred
76d5492b
RM
3833 (progn
3834 (set-buffer buffer)
3835 (and buffer-offer-save (> (buffer-size) 0)))))
ffc0e1ca
AS
3836 (or (not (functionp pred))
3837 (with-current-buffer buffer (funcall pred)))
76d5492b
RM
3838 (if arg
3839 t
3840 (setq queried t)
3841 (if (buffer-file-name buffer)
3842 (format "Save file %s? "
3843 (buffer-file-name buffer))
3844 (format "Save buffer %s? "
3845 (buffer-name buffer)))))))
3846 (function
3847 (lambda (buffer)
3848 (set-buffer buffer)
3849 (save-buffer)))
3850 (buffer-list)
3851 '("buffer" "buffers" "save")
1eeae2a1 3852 save-some-buffers-action-alist))
bf247b6e 3853 ;; Maybe to save abbrevs, and record whether
a1b0c2a7
RS
3854 ;; we either saved them or asked to.
3855 (and save-abbrevs abbrevs-changed
3856 (progn
3857 (if (or arg
3858 (eq save-abbrevs 'silently)
3859 (y-or-n-p (format "Save abbrevs in %s? "
3860 abbrev-file-name)))
3861 (write-abbrev-file nil))
3862 ;; Don't keep bothering user if he says no.
3863 (setq abbrevs-changed nil)
3864 (setq abbrevs-done t)))
76d5492b 3865 (or queried (> files-done 0) abbrevs-done
a1b0c2a7
RS
3866 (message (if some-automatic
3867 "(Some special files were saved without asking)"
3868 "(No files need saving)"))))))
b4da00e9
RM
3869\f
3870(defun not-modified (&optional arg)
3871 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
3872With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3873
3874It is not a good idea to use this function in Lisp programs, because it
3875prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
3876 (interactive "P")
3877 (message (if arg "Modification-flag set"
3878 "Modification-flag cleared"))
3879 (set-buffer-modified-p arg))
3880
3881(defun toggle-read-only (&optional arg)
3882 "Change whether this buffer is visiting its file read-only.
2a9fe1e2
RS
3883With arg, set read-only iff arg is positive.
3884If visiting file read-only and `view-read-only' is non-nil, enter view mode."
b4da00e9 3885 (interactive "P")
c60ee5e7 3886 (if (and arg
d758359d
AS
3887 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3888 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3889 nil ; do nothing.
3890 ;; Toggle.
3891 (cond
3892 ((and buffer-read-only view-mode)
3893 (View-exit-and-edit)
3894 (make-local-variable 'view-read-only)
3895 (setq view-read-only t)) ; Must leave view mode.
3896 ((and (not buffer-read-only) view-read-only
818286f4
SM
3897 ;; If view-mode is already active, `view-mode-enter' is a nop.
3898 (not view-mode)
d758359d
AS
3899 (not (eq (get major-mode 'mode-class) 'special)))
3900 (view-mode-enter))
3901 (t (setq buffer-read-only (not buffer-read-only))
3902 (force-mode-line-update)))
3903 (if (vc-backend buffer-file-name)
8a26c165 3904 (message "%s" (substitute-command-keys
a5dd5f60
RS
3905 (concat "File is under version-control; "
3906 "use \\[vc-next-action] to check in/out"))))))
b4da00e9 3907
912192d1 3908(defun insert-file (filename)
b4da00e9
RM
3909 "Insert contents of file FILENAME into buffer after point.
3910Set mark after the inserted text.
3911
3912This function is meant for the user to run interactively.
3913Don't call it from programs! Use `insert-file-contents' instead.
3914\(Its calling sequence is different; see its documentation)."
912192d1 3915 (interactive "*fInsert file: ")
3a64a3cf 3916 (insert-file-1 filename #'insert-file-contents))
b4da00e9 3917
912192d1 3918(defun append-to-file (start end filename)
b4da00e9
RM
3919 "Append the contents of the region to the end of file FILENAME.
3920When called from a function, expects three arguments,
3921START, END and FILENAME. START and END are buffer positions
da30bf98 3922saying what text to write."
912192d1
KH
3923 (interactive "r\nFAppend to file: ")
3924 (write-region start end filename t))
b4da00e9
RM
3925
3926(defun file-newest-backup (filename)
3927 "Return most recent backup file for FILENAME or nil if no backups exist."
ffc0e1ca
AS
3928 ;; `make-backup-file-name' will get us the right directory for
3929 ;; ordinary or numeric backups. It might create a directory for
3930 ;; backups as a side-effect, according to `backup-directory-alist'.
e31cfca5 3931 (let* ((filename (file-name-sans-versions
783bf210 3932 (make-backup-file-name (expand-file-name filename))))
b4da00e9
RM
3933 (file (file-name-nondirectory filename))
3934 (dir (file-name-directory filename))
3935 (comp (file-name-all-completions file dir))
cf7e94a0
RS
3936 (newest nil)
3937 tem)
b4da00e9 3938 (while comp
ffc0e1ca 3939 (setq tem (pop comp))
cf7e94a0
RS
3940 (cond ((and (backup-file-name-p tem)
3941 (string= (file-name-sans-versions tem) file))
3942 (setq tem (concat dir tem))
3943 (if (or (null newest)
3944 (file-newer-than-file-p tem newest))
3945 (setq newest tem)))))
b4da00e9
RM
3946 newest))
3947
3948(defun rename-uniquely ()
3949 "Rename current buffer to a similar name not already taken.
3950This function is useful for creating multiple shell process buffers
3951or multiple mail buffers, etc."
3952 (interactive)
40eb8038 3953 (save-match-data
e0df3aef
KH
3954 (let ((base-name (buffer-name)))
3955 (and (string-match "<[0-9]+>\\'" base-name)
3956 (not (and buffer-file-name
3957 (string= base-name
3958 (file-name-nondirectory buffer-file-name))))
3959 ;; If the existing buffer name has a <NNN>,
3960 ;; which isn't part of the file name (if any),
3961 ;; then get rid of that.
3962 (setq base-name (substring base-name 0 (match-beginning 0))))
3963 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 3964 (force-mode-line-update))))
5bbbceb1 3965
4e43240a 3966(defun make-directory (dir &optional parents)
5ce8bb89
RS
3967 "Create the directory DIR and any nonexistent parent dirs.
3968Interactively, the default choice of directory to create
3969is the current default directory for file names.
0225ae5e 3970That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
3971
3972Noninteractively, the second (optional) argument PARENTS says whether
07703430
RS
3973to create parent directories if they don't exist. Interactively,
3974this happens by default."
5ce8bb89
RS
3975 (interactive
3976 (list (read-file-name "Make directory: " default-directory default-directory
3977 nil nil)
3978 t))
ee291b46
RS
3979 ;; If default-directory is a remote directory,
3980 ;; make sure we find its make-directory handler.
3981 (setq dir (expand-file-name dir))
6eaebaa2 3982 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
3983 (if handler
3984 (funcall handler 'make-directory dir parents)
3985 (if (not parents)
3986 (make-directory-internal dir)
3987 (let ((dir (directory-file-name (expand-file-name dir)))
3988 create-list)
3989 (while (not (file-exists-p dir))
76d5492b 3990 (setq create-list (cons dir create-list)
4e43240a
RS
3991 dir (directory-file-name (file-name-directory dir))))
3992 (while create-list
3993 (make-directory-internal (car create-list))
3994 (setq create-list (cdr create-list))))))))
b4da00e9
RM
3995\f
3996(put 'revert-buffer-function 'permanent-local t)
3997(defvar revert-buffer-function nil
0973d78b
RS
3998 "Function to use to revert this buffer, or nil to do the default.
3999The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4000which are the arguments that `revert-buffer' received.")
b4da00e9
RM
4001
4002(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4003(defvar revert-buffer-insert-file-contents-function nil
4004 "Function to use to insert contents when reverting this buffer.
4005Gets two args, first the nominal file name to use,
2df32500
RS
4006and second, t if reading the auto-save file.
4007
4008The function you specify is responsible for updating (or preserving) point.")
b4da00e9 4009
b0dc9757
LT
4010(defvar buffer-stale-function nil
4011 "Function to check whether a non-file buffer needs reverting.
4012This should be a function with one optional argument NOCONFIRM.
44dce0fb 4013Auto Revert Mode passes t for NOCONFIRM. The function should return
8b0b6932
LT
4014non-nil if the buffer should be reverted. A return value of
4015`fast' means that the need for reverting was not checked, but
4016that reverting the buffer is fast. The buffer is current when
4017this function is called.
b0dc9757 4018
4f8453ae
LT
4019The idea behind the NOCONFIRM argument is that it should be
4020non-nil if the buffer is going to be reverted without asking the
4021user. In such situations, one has to be careful with potentially
c90dcdd5
LT
4022time consuming operations.
4023
4024For more information on how this variable is used by Auto Revert mode,
b3a59350 4025see Info node `(emacs)Supporting additional buffers'.")
b0dc9757 4026
5f76e7d4
KH
4027(defvar before-revert-hook nil
4028 "Normal hook for `revert-buffer' to run before reverting.
4029If `revert-buffer-function' is used to override the normal revert
4030mechanism, this hook is not used.")
4031
4032(defvar after-revert-hook nil
4033 "Normal hook for `revert-buffer' to run after reverting.
4034Note that the hook value that it runs is the value that was in effect
4035before reverting; that makes a difference if you have buffer-local
4036hook functions.
4037
4038If `revert-buffer-function' is used to override the normal revert
4039mechanism, this hook is not used.")
4040
1554c03b
RS
4041(defvar revert-buffer-internal-hook)
4042
9a30563f 4043(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 4044 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 4045This undoes all changes since the file was visited or saved.
8c0e7b73
JB
4046With a prefix argument, offer to revert from latest auto-save file, if
4047that is more recent than the visited file.
1ab31687 4048
7e7c9c4e
RS
4049This command also works for special buffers that contain text which
4050doesn't come from a file, but reflects some other data base instead:
4e163715 4051for example, Dired buffers and `buffer-list' buffers. In these cases,
7e7c9c4e
RS
4052it reconstructs the buffer contents from the appropriate data base.
4053
65ee6096 4054When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
4055to revert from the auto-save file when this is nil. Note that the
4056sense of this argument is the reverse of the prefix argument, for the
4057sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4058to nil.
4059
4060Optional second argument NOCONFIRM means don't ask for confirmation at
518dc5be
EZ
4061all. \(The variable `revert-without-query' offers another way to
4062revert buffers without querying for confirmation.)
b4da00e9 4063
5b2b26d5
RS
4064Optional third argument PRESERVE-MODES non-nil means don't alter
4065the files modes. Normally we reinitialize them using `normal-mode'.
4066
8c0e7b73 4067If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
4068do all the work for this command. Otherwise, the hooks
4069`before-revert-hook' and `after-revert-hook' are run at the beginning
4070and the end, and if `revert-buffer-insert-file-contents-function' is
4071non-nil, it is called instead of rereading visited file contents."
fb6208a6 4072
1ab31687
JB
4073 ;; I admit it's odd to reverse the sense of the prefix argument, but
4074 ;; there is a lot of code out there which assumes that the first
4075 ;; argument should be t to avoid consulting the auto-save file, and
4076 ;; there's no straightforward way to encourage authors to notice a
4077 ;; reversal of the argument sense. So I'm just changing the user
4078 ;; interface, but leaving the programmatic interface the same.
e0867e99 4079 (interactive (list (not current-prefix-arg)))
b4da00e9 4080 (if revert-buffer-function
1ab31687 4081 (funcall revert-buffer-function ignore-auto noconfirm)
44dce0fb
RS
4082 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4083 (current-buffer))
4084 (let* ((auto-save-p (and (not ignore-auto)
4085 (recent-auto-save-p)
4086 buffer-auto-save-file-name
4087 (file-readable-p buffer-auto-save-file-name)
4088 (y-or-n-p
4089 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4090 (file-name (if auto-save-p
4091 buffer-auto-save-file-name
4092 buffer-file-name)))
4093 (cond ((null file-name)
4094 (error "Buffer does not seem to be associated with any file"))
4095 ((or noconfirm
4096 (and (not (buffer-modified-p))
518dc5be
EZ
4097 (catch 'found
4098 (dolist (regexp revert-without-query)
4099 (when (string-match regexp file-name)
4100 (throw 'found t)))))
44dce0fb
RS
4101 (yes-or-no-p (format "Revert buffer from file %s? "
4102 file-name)))
4103 (run-hooks 'before-revert-hook)
4104 ;; If file was backed up but has changed since,
4105 ;; we shd make another backup.
4106 (and (not auto-save-p)
4107 (not (verify-visited-file-modtime (current-buffer)))
4108 (setq buffer-backed-up nil))
44dce0fb
RS
4109 ;; Effectively copy the after-revert-hook status,
4110 ;; since after-find-file will clobber it.
4111 (let ((global-hook (default-value 'after-revert-hook))
518dc5be
EZ
4112 (local-hook (when (local-variable-p 'after-revert-hook)
4113 after-revert-hook))
4114 (inhibit-read-only t))
4115 (cond
4116 (revert-buffer-insert-file-contents-function
4117 (unless (eq buffer-undo-list t)
4118 ;; Get rid of all undo records for this buffer.
4119 (setq buffer-undo-list nil))
4120 ;; Don't make undo records for the reversion.
4121 (let ((buffer-undo-list t))
4122 (funcall revert-buffer-insert-file-contents-function
4123 file-name auto-save-p)))
4124 ((not (file-exists-p file-name))
4125 (error (if buffer-file-number
4126 "File %s no longer exists!"
4127 "Cannot revert nonexistent file %s")
4128 file-name))
b2d239c1
RS
4129 ((not (file-readable-p file-name))
4130 (error (if buffer-file-number
4131 "File %s no longer readable!"
4132 "Cannot revert unreadable file %s")
4133 file-name))
518dc5be
EZ
4134 (t
4135 ;; Bind buffer-file-name to nil
4136 ;; so that we don't try to lock the file.
4137 (let ((buffer-file-name nil))
4138 (or auto-save-p
4139 (unlock-buffer)))
4140 (widen)
4141 (let ((coding-system-for-read
4142 ;; Auto-saved file should be read by Emacs'
4143 ;; internal coding.
4144 (if auto-save-p 'auto-save-coding
4145 (or coding-system-for-read
4146 buffer-file-coding-system-explicit))))
e1ee3b54 4147 (if (and (not enable-multibyte-characters)
52f9b751 4148 coding-system-for-read
e1ee3b54
KH
4149 (not (memq (coding-system-base
4150 coding-system-for-read)
4151 '(no-conversion raw-text))))
4152 ;; As a coding system suitable for multibyte
4153 ;; buffer is specified, make the current
4154 ;; buffer multibyte.
4155 (set-buffer-multibyte t))
4156
518dc5be
EZ
4157 ;; This force after-insert-file-set-coding
4158 ;; (called from insert-file-contents) to set
4159 ;; buffer-file-coding-system to a proper value.
4160 (kill-local-variable 'buffer-file-coding-system)
4161
4162 ;; Note that this preserves point in an intelligent way.
4163 (if preserve-modes
4164 (let ((buffer-file-format buffer-file-format))
4165 (insert-file-contents file-name (not auto-save-p)
4166 nil nil t))
4167 (insert-file-contents file-name (not auto-save-p)
4168 nil nil t)))))
44dce0fb
RS
4169 ;; Recompute the truename in case changes in symlinks
4170 ;; have changed the truename.
4171 (setq buffer-file-truename
4172 (abbreviate-file-name (file-truename buffer-file-name)))
4173 (after-find-file nil nil t t preserve-modes)
4174 ;; Run after-revert-hook as it was before we reverted.
4175 (setq-default revert-buffer-internal-hook global-hook)
518dc5be 4176 (if local-hook
44dce0fb
RS
4177 (set (make-local-variable 'revert-buffer-internal-hook)
4178 local-hook)
4179 (kill-local-variable 'revert-buffer-internal-hook))
4180 (run-hooks 'revert-buffer-internal-hook))
4181 t))))))
b4da00e9 4182
64d18e8f
RS
4183(defun recover-this-file ()
4184 "Recover the visited file--get contents from its last auto-save file."
4185 (interactive)
4186 (recover-file buffer-file-name))
4187
b4da00e9
RM
4188(defun recover-file (file)
4189 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
4190 ;; Actually putting the file name in the minibuffer should be used
4191 ;; only rarely.
4192 ;; Not just because users often use the default.
e1dadc17 4193 (interactive "FRecover file: ")
b4da00e9 4194 (setq file (expand-file-name file))
f7da6740 4195 (if (auto-save-file-name-p (file-name-nondirectory file))
4e163715 4196 (error "%s is an auto-save file" (abbreviate-file-name file)))
b4da00e9
RM
4197 (let ((file-name (let ((buffer-file-name file))
4198 (make-auto-save-file-name))))
945e1965
RS
4199 (cond ((if (file-exists-p file)
4200 (not (file-newer-than-file-p file-name file))
4201 (not (file-exists-p file-name)))
4e163715
SM
4202 (error "Auto-save file %s not current"
4203 (abbreviate-file-name file-name)))
b4da00e9 4204 ((save-window-excursion
ffc0e1ca
AS
4205 (with-output-to-temp-buffer "*Directory*"
4206 (buffer-disable-undo standard-output)
4207 (save-excursion
4208 (let ((switches dired-listing-switches))
4209 (if (file-symlink-p file)
4210 (setq switches (concat switches "L")))
4211 (set-buffer standard-output)
bc22fd18
EZ
4212 ;; Use insert-directory-safely, not insert-directory,
4213 ;; because these files might not exist. In particular,
4214 ;; FILE might not exist if the auto-save file was for
4215 ;; a buffer that didn't visit a file, such as "*mail*".
4216 ;; The code in v20.x called `ls' directly, so we need
4217 ;; to emulate what `ls' did in that case.
4218 (insert-directory-safely file switches)
4219 (insert-directory-safely file-name switches))))
b4da00e9
RM
4220 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4221 (switch-to-buffer (find-file-noselect file t))
518dc5be 4222 (let ((inhibit-read-only t)
1e87edf5
KH
4223 ;; Keep the current buffer-file-coding-system.
4224 (coding-system buffer-file-coding-system)
1d0ec0d1 4225 ;; Auto-saved file should be read with special coding.
77619f8e 4226 (coding-system-for-read 'auto-save-coding))
b4da00e9 4227 (erase-buffer)
1e87edf5
KH
4228 (insert-file-contents file-name nil)
4229 (set-buffer-file-coding-system coding-system))
8cfb9d46 4230 (after-find-file nil nil t))
ffa7ab70 4231 (t (error "Recover-file cancelled")))))
b4da00e9 4232
6598027d 4233(defun recover-session ()
9aee5392
RS
4234 "Recover auto save files from a previous Emacs session.
4235This command first displays a Dired buffer showing you the
4236previous sessions that you could recover from.
4237To choose one, move point to the proper line and then type C-c C-c.
4238Then you'll be asked about a number of files to recover."
4239 (interactive)
363a5030
RS
4240 (if (null auto-save-list-file-prefix)
4241 (error "You set `auto-save-list-file-prefix' to disable making session files"))
ffc0e1ca
AS
4242 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4243 (unless (file-directory-p dir)
194600a8
JPW
4244 (make-directory dir t))
4245 (unless (directory-files dir nil
4246 (concat "\\`" (regexp-quote
4247 (file-name-nondirectory
4248 auto-save-list-file-prefix)))
4249 t)
4250 (error "No previous sessions to recover")))
6f4983e6 4251 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
4252 (dired (concat auto-save-list-file-prefix "*")
4253 (concat dired-listing-switches "t")))
05e076c7
AS
4254 (save-excursion
4255 (goto-char (point-min))
4256 (or (looking-at " Move to the session you want to recover,")
4257 (let ((inhibit-read-only t))
4258 ;; Each line starts with a space
4259 ;; so that Font Lock mode won't highlight the first character.
4260 (insert " Move to the session you want to recover,\n"
4261 " then type C-c C-c to select it.\n\n"
4262 " You can also delete some of these files;\n"
4263 " type d on a line to mark that file for deletion.\n\n"))))
9aee5392 4264 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 4265 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 4266
80280bb7 4267(defun recover-session-finish ()
9aee5392
RS
4268 "Choose one saved session to recover auto-save files from.
4269This command is used in the special Dired buffer created by
80280bb7 4270\\[recover-session]."
9aee5392
RS
4271 (interactive)
4272 ;; Get the name of the session file to recover from.
4273 (let ((file (dired-get-filename))
953a03b2 4274 files
9aee5392 4275 (buffer (get-buffer-create " *recover*")))
c11032b9 4276 (dired-unmark 1)
033ef863 4277 (dired-do-flagged-delete t)
9aee5392
RS
4278 (unwind-protect
4279 (save-excursion
4280 ;; Read in the auto-save-list file.
4281 (set-buffer buffer)
4282 (erase-buffer)
4283 (insert-file-contents file)
953a03b2
RS
4284 ;; Loop thru the text of that file
4285 ;; and get out the names of the files to recover.
4286 (while (not (eobp))
4287 (let (thisfile autofile)
4288 (if (eolp)
4289 ;; This is a pair of lines for a non-file-visiting buffer.
4290 ;; Get the auto-save file name and manufacture
4291 ;; a "visited file name" from that.
4292 (progn
4293 (forward-line 1)
259be4e6
JB
4294 ;; If there is no auto-save file name, the
4295 ;; auto-save-list file is probably corrupted.
4296 (unless (eolp)
4297 (setq autofile
4298 (buffer-substring-no-properties
4299 (point)
e442c62b 4300 (line-end-position)))
259be4e6
JB
4301 (setq thisfile
4302 (expand-file-name
4303 (substring
4304 (file-name-nondirectory autofile)
4305 1 -1)
4306 (file-name-directory autofile))))
953a03b2
RS
4307 (forward-line 1))
4308 ;; This pair of lines is a file-visiting
4309 ;; buffer. Use the visited file name.
4310 (progn
4311 (setq thisfile
4312 (buffer-substring-no-properties
4313 (point) (progn (end-of-line) (point))))
4314 (forward-line 1)
4315 (setq autofile
4316 (buffer-substring-no-properties
4317 (point) (progn (end-of-line) (point))))
4318 (forward-line 1)))
4319 ;; Ignore a file if its auto-save file does not exist now.
259be4e6 4320 (if (and autofile (file-exists-p autofile))
953a03b2
RS
4321 (setq files (cons thisfile files)))))
4322 (setq files (nreverse files))
945e1965
RS
4323 ;; The file contains a pair of line for each auto-saved buffer.
4324 ;; The first line of the pair contains the visited file name
4325 ;; or is empty if the buffer was not visiting a file.
4326 ;; The second line is the auto-save file name.
953a03b2
RS
4327 (if files
4328 (map-y-or-n-p "Recover %s? "
4329 (lambda (file)
4330 (condition-case nil
4331 (save-excursion (recover-file file))
76d5492b 4332 (error
953a03b2
RS
4333 "Failed to recover `%s'" file)))
4334 files
4335 '("file" "files" "recover"))
4336 (message "No files can be recovered from this session now")))
9aee5392
RS
4337 (kill-buffer buffer))))
4338
73ba610a 4339(defun kill-some-buffers (&optional list)
243a3ae0 4340 "Kill some buffers. Asks the user whether to kill each one of them.
bb8eaf67 4341Non-interactively, if optional argument LIST is non-nil, it
243a3ae0 4342specifies the list of buffers to kill, asking for approval for each one."
b4da00e9 4343 (interactive)
73ba610a
RS
4344 (if (null list)
4345 (setq list (buffer-list)))
4346 (while list
4347 (let* ((buffer (car list))
4348 (name (buffer-name buffer)))
cbca0a4b
RS
4349 (and name ; Can be nil for an indirect buffer
4350 ; if we killed the base buffer.
4351 (not (string-equal name ""))
26b9ecbc 4352 (/= (aref name 0) ?\s)
73ba610a
RS
4353 (yes-or-no-p
4354 (format "Buffer %s %s. Kill? "
4355 name
4356 (if (buffer-modified-p buffer)
4357 "HAS BEEN EDITED" "is unmodified")))
4358 (kill-buffer buffer)))
4359 (setq list (cdr list))))
b4da00e9
RM
4360\f
4361(defun auto-save-mode (arg)
4362 "Toggle auto-saving of contents of current buffer.
f3e23606 4363With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
4364 (interactive "P")
4365 (setq buffer-auto-save-file-name
4366 (and (if (null arg)
74b9c2af 4367 (or (not buffer-auto-save-file-name)
4e0c8650 4368 ;; If auto-save is off because buffer has shrunk,
74b9c2af
RS
4369 ;; then toggling should turn it on.
4370 (< buffer-saved-size 0))
b4da00e9
RM
4371 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4372 (if (and buffer-file-name auto-save-visited-file-name
4373 (not buffer-read-only))
4374 buffer-file-name
4375 (make-auto-save-file-name))))
0b7f1ef2
RS
4376 ;; If -1 was stored here, to temporarily turn off saving,
4377 ;; turn it back on.
4378 (and (< buffer-saved-size 0)
4379 (setq buffer-saved-size 0))
b4da00e9
RM
4380 (if (interactive-p)
4381 (message "Auto-save %s (in this buffer)"
4382 (if buffer-auto-save-file-name "on" "off")))
4383 buffer-auto-save-file-name)
4384
4385(defun rename-auto-save-file ()
4386 "Adjust current buffer's auto save file name for current conditions.
4387Also rename any existing auto save file, if it was made in this session."
4388 (let ((osave buffer-auto-save-file-name))
4389 (setq buffer-auto-save-file-name
4390 (make-auto-save-file-name))
4391 (if (and osave buffer-auto-save-file-name
4392 (not (string= buffer-auto-save-file-name buffer-file-name))
4393 (not (string= buffer-auto-save-file-name osave))
4394 (file-exists-p osave)
4395 (recent-auto-save-p))
4396 (rename-file osave buffer-auto-save-file-name t))))
4397
4398(defun make-auto-save-file-name ()
4399 "Return file name to use for auto-saves of current buffer.
4400Does not consider `auto-save-visited-file-name' as that variable is checked
4401before calling this function. You can redefine this for customization.
4402See also `auto-save-file-name-p'."
4403 (if buffer-file-name
c1105d05
MA
4404 (let ((handler (find-file-name-handler buffer-file-name
4405 'make-auto-save-file-name)))
4406 (if handler
4407 (funcall handler 'make-auto-save-file-name)
4408 (let ((list auto-save-file-name-transforms)
4409 (filename buffer-file-name)
4410 result uniq)
4411 ;; Apply user-specified translations
4412 ;; to the file name.
4413 (while (and list (not result))
4414 (if (string-match (car (car list)) filename)
4415 (setq result (replace-match (cadr (car list)) t nil
4416 filename)
4417 uniq (car (cddr (car list)))))
4418 (setq list (cdr list)))
4419 (if result
4420 (if uniq
4421 (setq filename (concat
4422 (file-name-directory result)
4423 (subst-char-in-string
4424 ?/ ?!
4425 (replace-regexp-in-string "!" "!!"
4426 filename))))
4427 (setq filename result)))
4428 (setq result
4429 (if (and (eq system-type 'ms-dos)
4430 (not (msdos-long-file-names)))
4431 ;; We truncate the file name to DOS 8+3 limits
4432 ;; before doing anything else, because the regexp
4433 ;; passed to string-match below cannot handle
4434 ;; extensions longer than 3 characters, multiple
4435 ;; dots, and other atrocities.
4436 (let ((fn (dos-8+3-filename
4437 (file-name-nondirectory buffer-file-name))))
4438 (string-match
4439 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4440 fn)
4441 (concat (file-name-directory buffer-file-name)
4442 "#" (match-string 1 fn)
4443 "." (match-string 3 fn) "#"))
4444 (concat (file-name-directory filename)
4445 "#"
4446 (file-name-nondirectory filename)
4447 "#")))
4448 ;; Make sure auto-save file names don't contain characters
4449 ;; invalid for the underlying filesystem.
18b28ef1 4450 (if (and (memq system-type '(ms-dos windows-nt cygwin))
c1105d05
MA
4451 ;; Don't modify remote (ange-ftp) filenames
4452 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4453 (convert-standard-filename result)
4454 result))))
0a1763b4
RS
4455
4456 ;; Deal with buffers that don't have any associated files. (Mail
4457 ;; mode tends to create a good number of these.)
4458
7d483e8c 4459 (let ((buffer-name (buffer-name))
ff5c7181 4460 (limit 0)
77d18896 4461 file-name)
c3348e10
RS
4462 ;; Eliminate all slashes and backslashes by
4463 ;; replacing them with sequences that start with %.
4464 ;; Quote % also, to keep distinct names distinct.
4465 (while (string-match "[/\\%]" buffer-name limit)
4466 (let* ((character (aref buffer-name (match-beginning 0)))
4467 (replacement
4468 (cond ((eq character ?%) "%%")
4469 ((eq character ?/) "%+")
4470 ((eq character ?\\) "%-"))))
4471 (setq buffer-name (replace-match replacement t t buffer-name))
4472 (setq limit (1+ (match-end 0)))))
a8abaf83 4473 ;; Generate the file name.
ff5c7181
RS
4474 (setq file-name
4475 (make-temp-file
4476 (let ((fname
4477 (expand-file-name
4478 (format "#%s#" buffer-name)
4479 ;; Try a few alternative directories, to get one we can
4480 ;; write it.
4481 (cond
4482 ((file-writable-p default-directory) default-directory)
4483 ((file-writable-p "/var/tmp/") "/var/tmp/")
4484 ("~/")))))
18b28ef1 4485 (if (and (memq system-type '(ms-dos windows-nt cygwin))
ff5c7181
RS
4486 ;; Don't modify remote (ange-ftp) filenames
4487 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4488 ;; The call to convert-standard-filename is in case
4489 ;; buffer-name includes characters not allowed by the
4490 ;; DOS/Windows filesystems. make-temp-file writes to the
4491 ;; file it creates, so we must fix the file name _before_
4492 ;; make-temp-file is called.
4493 (convert-standard-filename fname)
4494 fname))
4495 nil "#"))
4496 ;; make-temp-file creates the file,
4497 ;; but we don't want it to exist until we do an auto-save.
4498 (condition-case ()
4499 (delete-file file-name)
4500 (file-error nil))
4501 file-name)))
b4da00e9
RM
4502
4503(defun auto-save-file-name-p (filename)
4504 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4505FILENAME should lack slashes. You can redefine this for customization."
4506 (string-match "^#.*#$" filename))
4507\f
6f4983e6
RS
4508(defun wildcard-to-regexp (wildcard)
4509 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4510The generated regexp will match a filename iff the filename
4511matches that wildcard according to shell rules. Only wildcards known
4512by `sh' are supported."
4513 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4514 ;; Copy the initial run of non-special characters.
4515 (result (substring wildcard 0 i))
4516 (len (length wildcard)))
4517 ;; If no special characters, we're almost done.
4518 (if i
4519 (while (< i len)
4520 (let ((ch (aref wildcard i))
4521 j)
4522 (setq
4523 result
4524 (concat result
4525 (cond
7e7c9c4e
RS
4526 ((and (eq ch ?\[)
4527 (< (1+ i) len)
4528 (eq (aref wildcard (1+ i)) ?\]))
4529 "\\[")
6f4983e6
RS
4530 ((eq ch ?\[) ; [...] maps to regexp char class
4531 (progn
4532 (setq i (1+ i))
4533 (concat
4534 (cond
4535 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4536 (progn
4537 (setq i (1+ i))
4538 (if (eq (aref wildcard i) ?\])
4539 (progn
4540 (setq i (1+ i))
4541 "[^]")
4542 "[^")))
4543 ((eq (aref wildcard i) ?^)
4544 ;; Found "[^". Insert a `\0' character
4545 ;; (which cannot happen in a filename)
4546 ;; into the character class, so that `^'
4547 ;; is not the first character after `[',
4548 ;; and thus non-special in a regexp.
4549 (progn
4550 (setq i (1+ i))
4551 "[\000^"))
4552 ((eq (aref wildcard i) ?\])
4553 ;; I don't think `]' can appear in a
4554 ;; character class in a wildcard, but
4555 ;; let's be general here.
4556 (progn
4557 (setq i (1+ i))
4558 "[]"))
4559 (t "["))
4560 (prog1 ; copy everything upto next `]'.
4561 (substring wildcard
4562 i
4563 (setq j (string-match
4564 "]" wildcard i)))
4565 (setq i (if j (1- j) (1- len)))))))
4566 ((eq ch ?.) "\\.")
4567 ((eq ch ?*) "[^\000]*")
4568 ((eq ch ?+) "\\+")
4569 ((eq ch ?^) "\\^")
4570 ((eq ch ?$) "\\$")
4571 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4572 ((eq ch ??) "[^\000]")
4573 (t (char-to-string ch)))))
4574 (setq i (1+ i)))))
4575 ;; Shell wildcards should match the entire filename,
4576 ;; not its part. Make the regexp say so.
4577 (concat "\\`" result "\\'")))
4578\f
21540597 4579(defcustom list-directory-brief-switches
b4da00e9 4580 (if (eq system-type 'vax-vms) "" "-CF")
ba83982b 4581 "Switches for `list-directory' to pass to `ls' for brief listing."
21540597
RS
4582 :type 'string
4583 :group 'dired)
b4da00e9 4584
21540597 4585(defcustom list-directory-verbose-switches
b4da00e9
RM
4586 (if (eq system-type 'vax-vms)
4587 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4588 "-l")
ba83982b 4589 "Switches for `list-directory' to pass to `ls' for verbose listing."
21540597
RS
4590 :type 'string
4591 :group 'dired)
b4da00e9 4592
5de148a2
RS
4593(defun file-expand-wildcards (pattern &optional full)
4594 "Expand wildcard pattern PATTERN.
4db2a7de
RS
4595This returns a list of file names which match the pattern.
4596
814af837 4597If PATTERN is written as an absolute file name,
4db2a7de
RS
4598the values are absolute also.
4599
4600If PATTERN is written as a relative file name, it is interpreted
4601relative to the current default directory, `default-directory'.
4602The file names returned are normally also relative to the current
4603default directory. However, if FULL is non-nil, they are absolute."
032388f3
RS
4604 (save-match-data
4605 (let* ((nondir (file-name-nondirectory pattern))
4606 (dirpart (file-name-directory pattern))
4607 ;; A list of all dirs that DIRPART specifies.
4608 ;; This can be more than one dir
4609 ;; if DIRPART contains wildcards.
4610 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4611 (mapcar 'file-name-as-directory
4612 (file-expand-wildcards (directory-file-name dirpart)))
4613 (list dirpart)))
4614 contents)
4615 (while dirs
4616 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
4617 (file-directory-p (directory-file-name (car dirs))))
4618 (let ((this-dir-contents
4619 ;; Filter out "." and ".."
4620 (delq nil
4621 (mapcar #'(lambda (name)
4622 (unless (string-match "\\`\\.\\.?\\'"
4623 (file-name-nondirectory name))
4624 name))
4625 (directory-files (or (car dirs) ".") full
4626 (wildcard-to-regexp nondir))))))
4627 (setq contents
4628 (nconc
4629 (if (and (car dirs) (not full))
4630 (mapcar (function (lambda (name) (concat (car dirs) name)))
4631 this-dir-contents)
4632 this-dir-contents)
4633 contents))))
4634 (setq dirs (cdr dirs)))
4635 contents)))
5de148a2 4636
b4da00e9
RM
4637(defun list-directory (dirname &optional verbose)
4638 "Display a list of files in or matching DIRNAME, a la `ls'.
4639DIRNAME is globbed by the shell if necessary.
4640Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4641Actions controlled by variables `list-directory-brief-switches'
4642and `list-directory-verbose-switches'."
4643 (interactive (let ((pfx current-prefix-arg))
4644 (list (read-file-name (if pfx "List directory (verbose): "
4645 "List directory (brief): ")
4646 nil default-directory nil)
4647 pfx)))
4648 (let ((switches (if verbose list-directory-verbose-switches
84905190
RS
4649 list-directory-brief-switches))
4650 buffer)
b4da00e9
RM
4651 (or dirname (setq dirname default-directory))
4652 (setq dirname (expand-file-name dirname))
4653 (with-output-to-temp-buffer "*Directory*"
84905190 4654 (setq buffer standard-output)
b4da00e9
RM
4655 (buffer-disable-undo standard-output)
4656 (princ "Directory ")
4657 (princ dirname)
4658 (terpri)
c3554e95
RS
4659 (save-excursion
4660 (set-buffer "*Directory*")
4661 (let ((wildcard (not (file-directory-p dirname))))
84905190
RS
4662 (insert-directory dirname switches wildcard (not wildcard)))))
4663 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4664 (with-current-buffer buffer
4665 (setq default-directory
4666 (if (file-directory-p dirname)
4667 (file-name-as-directory dirname)
4668 (file-name-directory dirname))))))
c3554e95 4669
ffc0e1ca
AS
4670(defun shell-quote-wildcard-pattern (pattern)
4671 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4672
4673PATTERN is assumed to represent a file-name wildcard suitable for the
4674underlying filesystem. For Unix and GNU/Linux, the characters from the
4675set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4676the parts of the pattern which don't include wildcard characters are
4677quoted with double quotes.
4678Existing quote characters in PATTERN are left alone, so you can pass
4679PATTERN that already quotes some of the special characters."
4680 (save-match-data
4681 (cond
c60ee5e7 4682 ((memq system-type '(ms-dos windows-nt cygwin))
ffc0e1ca
AS
4683 ;; DOS/Windows don't allow `"' in file names. So if the
4684 ;; argument has quotes, we can safely assume it is already
4685 ;; quoted by the caller.
4686 (if (or (string-match "[\"]" pattern)
4687 ;; We quote [&()#$'] in case their shell is a port of a
4688 ;; Unixy shell. We quote [,=+] because stock DOS and
4689 ;; Windows shells require that in some cases, such as
4690 ;; passing arguments to batch files that use positional
4691 ;; arguments like %1.
4692 (not (string-match "[ \t;&()#$',=+]" pattern)))
4693 pattern
4694 (let ((result "\"")
4695 (beg 0)
4696 end)
4697 (while (string-match "[*?]+" pattern beg)
4698 (setq end (match-beginning 0)
4699 result (concat result (substring pattern beg end)
4700 "\""
4701 (substring pattern end (match-end 0))
4702 "\"")
4703 beg (match-end 0)))
4704 (concat result (substring pattern beg) "\""))))
4705 (t
4706 (let ((beg 0))
4707 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4708 (setq pattern
4709 (concat (substring pattern 0 (match-beginning 0))
4710 "\\"
4711 (substring pattern (match-beginning 0)))
4712 beg (1+ (match-end 0)))))
4713 pattern))))
4714
4715
c3554e95
RS
4716(defvar insert-directory-program "ls"
4717 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4718
f4d04672 4719(defcustom directory-free-space-program "df"
ba83982b 4720 "Program to get the amount of free space on a file system.
f4d04672
RS
4721We assume the output has the format of `df'.
4722The value of this variable must be just a command name or file name;
4723if you want to specify options, use `directory-free-space-args'.
4724
01b26b90
EZ
4725A value of nil disables this feature.
4726
4727If the function `file-system-info' is defined, it is always used in
4728preference to the program given by this variable."
f4d04672
RS
4729 :type '(choice (string :tag "Program") (const :tag "None" nil))
4730 :group 'dired)
4731
525fdbc9
AS
4732(defcustom directory-free-space-args
4733 (if (eq system-type 'darwin) "-k" "-Pk")
ba83982b 4734 "Options to use when running `directory-free-space-program'."
f4d04672
RS
4735 :type 'string
4736 :group 'dired)
4737
01b26b90 4738(defun get-free-disk-space (dir)
26b9ecbc 4739 "Return the amount of free space on directory DIR's file system.
01b26b90 4740The result is a string that gives the number of free 1KB blocks,
26b9ecbc 4741or nil if the system call or the program which retrieve the information
01b26b90
EZ
4742fail.
4743
4744This function calls `file-system-info' if it is available, or invokes the
4745program specified by `directory-free-space-program' if that is non-nil."
4746 ;; Try to find the number of free blocks. Non-Posix systems don't
4747 ;; always have df, but might have an equivalent system call.
4748 (if (fboundp 'file-system-info)
4749 (let ((fsinfo (file-system-info dir)))
4750 (if fsinfo
4751 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4752 (save-match-data
4753 (with-temp-buffer
4754 (when (and directory-free-space-program
15502042
EZ
4755 (eq 0 (call-process directory-free-space-program
4756 nil t nil
4757 directory-free-space-args
4758 dir)))
01b26b90
EZ
4759 ;; Usual format is a header line followed by a line of
4760 ;; numbers.
4761 (goto-char (point-min))
4762 (forward-line 1)
4763 (if (not (eobp))
4764 (progn
4765 ;; Move to the end of the "available blocks" number.
4766 (skip-chars-forward "^ \t")
4767 (forward-word 3)
4768 ;; Copy it into AVAILABLE.
4769 (let ((end (point)))
4770 (forward-word -1)
4771 (buffer-substring (point) end)))))))))
4772
9bc260cf
MA
4773;; The following expression replaces `dired-move-to-filename-regexp'.
4774(defvar directory-listing-before-filename-regexp
4775 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
4776 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
4777 ;; In some locales, month abbreviations are as short as 2 letters,
4778 ;; and they can be followed by ".".
4779 ;; In Breton, a month name can include a quote character.
4780 (month (concat l-or-quote l-or-quote "+\\.?"))
4781 (s " ")
4782 (yyyy "[0-9][0-9][0-9][0-9]")
4783 (dd "[ 0-3][0-9]")
4784 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
4785 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
4786 (zone "[-+][0-2][0-9][0-5][0-9]")
4787 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
4788 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
4789 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
4790 "\\|" yyyy "-" iso-mm-dd "\\)"))
4791 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
4792 s "+"
4793 "\\(" HH:MM "\\|" yyyy "\\)"))
4794 (western-comma (concat month s "+" dd "," s "+" yyyy))
4795 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4796 ;; omits the Kanji characters after month and day-of-month.
4797 ;; On Mac OS X 10.3, the date format in East Asian locales is
4798 ;; day-of-month digits followed by month digits.
4799 (mm "[ 0-1]?[0-9]")
4800 (east-asian
4801 (concat "\\(" mm l "?" s dd l "?" s "+"
4802 "\\|" dd s mm s "+" "\\)"
4803 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
4804 ;; The "[0-9]" below requires the previous column to end in a digit.
4805 ;; This avoids recognizing `1 may 1997' as a date in the line:
4806 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4807
4808 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4809 ;; The ".*" below finds the last match if there are multiple matches.
4810 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4811 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4812
4813 ;; vc dired listings provide the state or blanks between file
4814 ;; permissions and date. The state is always surrounded by
4815 ;; parantheses:
4816 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4817 ;; This is not supported yet.
4818 (concat ".*[0-9][BkKMGTPEZY]?" s
4819 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
4820 s "+"))
4821 "Regular expression to match up to the file name in a directory listing.
4822The default value is designed to recognize dates and times
4823regardless of the language.")
01b26b90 4824
a1b0c2a7
RS
4825(defvar insert-directory-ls-version 'unknown)
4826
c3554e95
RS
4827;; insert-directory
4828;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4829;; FULL-DIRECTORY-P is nil.
4830;; The single line of output must display FILE's name as it was
4831;; given, namely, an absolute path name.
4832;; - must insert exactly one line for each file if WILDCARD or
4833;; FULL-DIRECTORY-P is t, plus one optional "total" line
4834;; before the file lines, plus optional text after the file lines.
4835;; Lines are delimited by "\n", so filenames containing "\n" are not
4836;; allowed.
4837;; File lines should display the basename.
4838;; - must be consistent with
4839;; - functions dired-move-to-filename, (these two define what a file line is)
4840;; dired-move-to-end-of-filename,
4841;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4842;; dired-insert-headerline
4843;; dired-after-subdir-garbage (defines what a "total" line is)
4844;; - variable dired-subdir-regexp
1fc85dae
KG
4845;; - may be passed "--dired" as the first argument in SWITCHES.
4846;; Filename handlers might have to remove this switch if their
4847;; "ls" command does not support it.
c3554e95 4848(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 4849 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 4850Leaves point after the inserted text.
8f8607be
LT
4851SWITCHES may be a string of options, or a list of strings
4852representing individual options.
c3554e95
RS
4853Optional third arg WILDCARD means treat FILE as shell wildcard.
4854Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4855switches do not contain `d', so that a full listing is expected.
4856
4857This works by running a directory listing program
406e12d9 4858whose name is in the variable `insert-directory-program'.
8f8607be
LT
4859If WILDCARD, it also runs the shell specified by `shell-file-name'.
4860
60ce7e3e 4861When SWITCHES contains the long `--dired' option, this function
8f8607be
LT
4862treats it specially, for the sake of dired. However, the
4863normally equivalent short `-D' option is just passed on to
4864`insert-directory-program', as any other option."
c870ab8e 4865 ;; We need the directory in order to find the right handler.
d2473540
AS
4866 (let ((handler (find-file-name-handler (expand-file-name file)
4867 'insert-directory)))
ebad92dc 4868 (if handler
c3554e95
RS
4869 (funcall handler 'insert-directory file switches
4870 wildcard full-directory-p)
b4da00e9 4871 (if (eq system-type 'vax-vms)
c3554e95 4872 (vms-read-directory file switches (current-buffer))
818286f4 4873 (let (result (beg (point)))
ebad92dc
RS
4874
4875 ;; Read the actual directory using `insert-directory-program'.
4876 ;; RESULT gets the status code.
99f01c91
KH
4877 (let* (;; We at first read by no-conversion, then after
4878 ;; putting text property `dired-filename, decode one
4879 ;; bunch by one to preserve that property.
4880 (coding-system-for-read 'no-conversion)
4881 ;; This is to control encoding the arguments in call-process.
c60ee5e7 4882 (coding-system-for-write
82e22b57
KH
4883 (and enable-multibyte-characters
4884 (or file-name-coding-system
99f01c91 4885 default-file-name-coding-system))))
ebad92dc
RS
4886 (setq result
4887 (if wildcard
4888 ;; Run ls in the directory part of the file pattern
4889 ;; using the last component as argument.
4890 (let ((default-directory
4891 (if (file-name-absolute-p file)
4892 (file-name-directory file)
4893 (file-name-directory (expand-file-name file))))
4894 (pattern (file-name-nondirectory file)))
4895 (call-process
4896 shell-file-name nil t nil
4897 "-c"
4898 (concat (if (memq system-type '(ms-dos windows-nt))
4899 ""
4900 "\\") ; Disregard Unix shell aliases!
4901 insert-directory-program
4902 " -d "
4903 (if (stringp switches)
4904 switches
4905 (mapconcat 'identity switches " "))
4906 " -- "
4907 ;; Quote some characters that have
4908 ;; special meanings in shells; but
4909 ;; don't quote the wildcards--we want
4910 ;; them to be special. We also
4911 ;; currently don't quote the quoting
4912 ;; characters in case people want to
4913 ;; use them explicitly to quote
4914 ;; wildcard characters.
4915 (shell-quote-wildcard-pattern pattern))))
4916 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4917 ;; directory if FILE is a symbolic link.
4918 (apply 'call-process
4919 insert-directory-program nil t nil
4920 (append
4921 (if (listp switches) switches
4922 (unless (equal switches "")
4923 ;; Split the switches at any spaces so we can
4924 ;; pass separate options as separate args.
4925 (split-string switches)))
4926 ;; Avoid lossage if FILE starts with `-'.
4927 '("--")
4928 (progn
4929 (if (string-match "\\`~" file)
4930 (setq file (expand-file-name file)))
4931 (list
4932 (if full-directory-p
4933 (concat (file-name-as-directory file) ".")
4934 file))))))))
4935
a1b0c2a7
RS
4936 ;; If we got "//DIRED//" in the output, it means we got a real
4937 ;; directory listing, even if `ls' returned nonzero.
4938 ;; So ignore any errors.
4939 (when (if (stringp switches)
4940 (string-match "--dired\\>" switches)
4941 (member "--dired" switches))
4942 (save-excursion
4943 (forward-line -2)
4944 (when (looking-at "//SUBDIRED//")
4945 (forward-line -1))
4946 (if (looking-at "//DIRED//")
4947 (setq result 0))))
4948
4949 (when (and (not (eq 0 result))
4950 (eq insert-directory-ls-version 'unknown))
4951 ;; The first time ls returns an error,
4952 ;; find the version numbers of ls,
4953 ;; and set insert-directory-ls-version
4954 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4955 ;; is equal or if the info cannot be obtained.
4956 ;; (That can mean it isn't GNU ls.)
4957 (let ((version-out
4958 (with-temp-buffer
4959 (call-process "ls" nil t nil "--version")
4960 (buffer-string))))
4961 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
4962 (let* ((version (match-string 1 version-out))
4963 (split (split-string version "[.]"))
027a4b6b 4964 (numbers (mapcar 'string-to-number split))
a1b0c2a7
RS
4965 (min '(5 2 1))
4966 comparison)
4967 (while (and (not comparison) (or numbers min))
4968 (cond ((null min)
4969 (setq comparison '>))
4970 ((null numbers)
4971 (setq comparison '<))
4972 ((> (car numbers) (car min))
4973 (setq comparison '>))
4974 ((< (car numbers) (car min))
4975 (setq comparison '<))
4976 (t
4977 (setq numbers (cdr numbers)
4978 min (cdr min)))))
4979 (setq insert-directory-ls-version (or comparison '=)))
4980 (setq insert-directory-ls-version nil))))
4981
4982 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4983 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
4984 (setq result 0))
4985
ebad92dc 4986 ;; If `insert-directory-program' failed, signal an error.
15502042 4987 (unless (eq 0 result)
f2440e42
RS
4988 ;; Delete the error message it may have output.
4989 (delete-region beg (point))
15502042
EZ
4990 ;; On non-Posix systems, we cannot open a directory, so
4991 ;; don't even try, because that will always result in
4992 ;; the ubiquitous "Access denied". Instead, show the
4993 ;; command line so the user can try to guess what went wrong.
4994 (if (and (file-directory-p file)
4995 (memq system-type '(ms-dos windows-nt)))
4996 (error
4997 "Reading directory: \"%s %s -- %s\" exited with status %s"
4998 insert-directory-program
4999 (if (listp switches) (concat switches) switches)
5000 file result)
5001 ;; Unix. Access the file to get a suitable error.
5002 (access-file file "Reading directory")
5003 (error "Listing directory failed but `access-file' worked")))
ebad92dc 5004
8f8607be
LT
5005 (when (if (stringp switches)
5006 (string-match "--dired\\>" switches)
5007 (member "--dired" switches))
9bb99df6
LT
5008 ;; The following overshoots by one line for an empty
5009 ;; directory listed with "--dired", but without "-a"
5010 ;; switch, where the ls output contains a
5011 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5012 ;; We take care of that case later.
ff7affeb 5013 (forward-line -2)
9423860f
AS
5014 (when (looking-at "//SUBDIRED//")
5015 (delete-region (point) (progn (forward-line 1) (point)))
5016 (forward-line -1))
9bb99df6
LT
5017 (if (looking-at "//DIRED//")
5018 (let ((end (line-end-position))
5019 (linebeg (point))
5020 error-lines)
5021 ;; Find all the lines that are error messages,
5022 ;; and record the bounds of each one.
5023 (goto-char beg)
5024 (while (< (point) linebeg)
5025 (or (eql (following-char) ?\s)
5026 (push (list (point) (line-end-position)) error-lines))
5027 (forward-line 1))
5028 (setq error-lines (nreverse error-lines))
5029 ;; Now read the numeric positions of file names.
5030 (goto-char linebeg)
5031 (forward-word 1)
5032 (forward-char 3)
5033 (while (< (point) end)
5034 (let ((start (insert-directory-adj-pos
5035 (+ beg (read (current-buffer)))
5036 error-lines))
5037 (end (insert-directory-adj-pos
a1b0c2a7 5038 (+ beg (read (current-buffer)))
9bb99df6 5039 error-lines)))
26b9ecbc 5040 (if (memq (char-after end) '(?\n ?\s))
9bb99df6
LT
5041 ;; End is followed by \n or by " -> ".
5042 (put-text-property start end 'dired-filename t)
5043 ;; It seems that we can't trust ls's output as to
5044 ;; byte positions of filenames.
5045 (put-text-property beg (point) 'dired-filename nil)
5046 (end-of-line))))
5047 (goto-char end)
5048 (beginning-of-line)
5049 (delete-region (point) (progn (forward-line 1) (point))))
5050 ;; Take care of the case where the ls output contains a
5051 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5052 ;; and we went one line too far back (see above).
5053 (forward-line 1))
5054 (if (looking-at "//DIRED-OPTIONS//")
5055 (delete-region (point) (progn (forward-line 1) (point)))))
ff7affeb 5056
99f01c91 5057 ;; Now decode what read if necessary.
b6647390
KH
5058 (let ((coding (or coding-system-for-read
5059 file-name-coding-system
5060 default-file-name-coding-system
5061 'undecided))
0bded065 5062 coding-no-eol
99f01c91 5063 val pos)
b6647390
KH
5064 (when (and enable-multibyte-characters
5065 (not (memq (coding-system-base coding)
5066 '(raw-text no-conversion))))
5067 ;; If no coding system is specified or detection is
5068 ;; requested, detect the coding.
5069 (if (eq (coding-system-base coding) 'undecided)
5070 (setq coding (detect-coding-region beg (point) t)))
5071 (if (not (eq (coding-system-base coding) 'undecided))
5072 (save-restriction
0bded065
AS
5073 (setq coding-no-eol
5074 (coding-system-change-eol-conversion coding 'unix))
b6647390
KH
5075 (narrow-to-region beg (point))
5076 (goto-char (point-min))
5077 (while (not (eobp))
5078 (setq pos (point)
5079 val (get-text-property (point) 'dired-filename))
5080 (goto-char (next-single-property-change
5081 (point) 'dired-filename nil (point-max)))
0bded065
AS
5082 ;; Force no eol conversion on a file name, so
5083 ;; that CR is preserved.
5084 (decode-coding-region pos (point)
5085 (if val coding-no-eol coding))
b6647390
KH
5086 (if val
5087 (put-text-property pos (point)
5088 'dired-filename t)))))))
99f01c91 5089
75bb5ca4
AS
5090 (if full-directory-p
5091 ;; Try to insert the amount of free space.
5092 (save-excursion
5093 (goto-char beg)
5094 ;; First find the line to put it on.
5095 (when (re-search-forward "^ *\\(total\\)" nil t)
5096 (let ((available (get-free-disk-space ".")))
5097 (when available
5098 ;; Replace "total" with "used", to avoid confusion.
5099 (replace-match "total used in directory" nil nil nil 1)
5100 (end-of-line)
5101 (insert " available " available)))))))))))
34342a07 5102
a1b0c2a7 5103(defun insert-directory-adj-pos (pos error-lines)
fead94d6 5104 "Convert `ls --dired' file name position value POS to a buffer position.
a1b0c2a7
RS
5105File name position values returned in ls --dired output
5106count only stdout; they don't count the error messages sent to stderr.
5107So this function converts to them to real buffer positions.
5108ERROR-LINES is a list of buffer positions of error message lines,
5109of the form (START END)."
5110 (while (and error-lines (< (caar error-lines) pos))
5111 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5112 (pop error-lines))
5113 pos)
5114
bc22fd18
EZ
5115(defun insert-directory-safely (file switches
5116 &optional wildcard full-directory-p)
5117 "Insert directory listing for FILE, formatted according to SWITCHES.
5118
5119Like `insert-directory', but if FILE does not exist, it inserts a
5120message to that effect instead of signaling an error."
5121 (if (file-exists-p file)
5122 (insert-directory file switches wildcard full-directory-p)
5123 ;; Simulate the message printed by `ls'.
5124 (insert (format "%s: No such file or directory\n" file))))
5125
88902b35 5126(defvar kill-emacs-query-functions nil
65d5c6de 5127 "Functions to call with no arguments to query about killing Emacs.
78c793d1
RS
5128If any of these functions returns nil, killing Emacs is cancelled.
5129`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
5130but `kill-emacs', the low level primitive, does not.
5131See also `kill-emacs-hook'.")
88902b35 5132
11f15305 5133(defcustom confirm-kill-emacs nil
9c2ba08f
EZ
5134 "How to ask for confirmation when leaving Emacs.
5135If nil, the default, don't ask at all. If the value is non-nil, it should
5136be a predicate function such as `yes-or-no-p'."
11f15305
GM
5137 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5138 (const :tag "Ask with y-or-n-p" y-or-n-p)
5139 (const :tag "Don't confirm" nil))
bdd9ab6e 5140 :group 'convenience
11f15305
GM
5141 :version "21.1")
5142
b4da00e9
RM
5143(defun save-buffers-kill-emacs (&optional arg)
5144 "Offer to save each buffer, then kill this Emacs process.
5145With prefix arg, silently save all file-visiting buffers, then kill."
5146 (interactive "P")
5147 (save-some-buffers arg t)
5148 (and (or (not (memq t (mapcar (function
5149 (lambda (buf) (and (buffer-file-name buf)
5150 (buffer-modified-p buf))))
5151 (buffer-list))))
5152 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5153 (or (not (fboundp 'process-list))
5154 ;; process-list is not defined on VMS.
5155 (let ((processes (process-list))
5156 active)
5157 (while processes
48a4a1fb
KS
5158 (and (memq (process-status (car processes)) '(run stop open listen))
5159 (process-query-on-exit-flag (car processes))
b4da00e9
RM
5160 (setq active t))
5161 (setq processes (cdr processes)))
5162 (or (not active)
48a4a1fb 5163 (list-processes t)
b4da00e9 5164 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 5165 ;; Query the user for other things, perhaps.
fb15c113 5166 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
11f15305
GM
5167 (or (null confirm-kill-emacs)
5168 (funcall confirm-kill-emacs "Really exit Emacs? "))
b4da00e9
RM
5169 (kill-emacs)))
5170\f
ffc0e1ca 5171;; We use /: as a prefix to "quote" a file name
47afc068
RS
5172;; so that magic file name handlers will not apply to it.
5173
5174(setq file-name-handler-alist
5175 (cons '("\\`/:" . file-name-non-special)
5176 file-name-handler-alist))
5177
5178;; We depend on being the last handler on the list,
5179;; so that anything else which does need handling
5180;; has been handled already.
5181;; So it is safe for us to inhibit *all* magic file name handlers.
5182
5183(defun file-name-non-special (operation &rest arguments)
5184 (let ((file-name-handler-alist nil)
5cb1f728
KH
5185 (default-directory
5186 (if (eq operation 'insert-directory)
5187 (directory-file-name
ffc0e1ca 5188 (expand-file-name
5cb1f728
KH
5189 (unhandled-file-name-directory default-directory)))
5190 default-directory))
47afc068
RS
5191 ;; Get a list of the indices of the args which are file names.
5192 (file-arg-indices
5193 (cdr (or (assq operation
ae3b2983 5194 ;; The first six are special because they
47afc068
RS
5195 ;; return a file name. We want to include the /:
5196 ;; in the return value.
5197 ;; So just avoid stripping it in the first place.
5198 '((expand-file-name . nil)
5199 (file-name-directory . nil)
5200 (file-name-as-directory . nil)
5201 (directory-file-name . nil)
c736f678 5202 (file-name-sans-versions . nil)
ae3b2983 5203 (find-backup-file-name . nil)
c736f678 5204 ;; `identity' means just return the first arg
6750c852
RS
5205 ;; not stripped of its quoting.
5206 (substitute-in-file-name identity)
ae3b2983
MA
5207 ;; `add' means add "/:" to the result.
5208 (file-truename add 0)
5209 ;; `quote' means add "/:" to buffer-file-name.
5210 (insert-file-contents quote 0)
5211 ;; `unquote-then-quote' means set buffer-file-name
5212 ;; temporarily to unquoted filename.
5213 (verify-visited-file-modtime unquote-then-quote)
5214 ;; List the arguments which are filenames.
c37adaa5
SM
5215 (file-name-completion 1)
5216 (file-name-all-completions 1)
ae3b2983 5217 (write-region 2 5)
47afc068
RS
5218 (rename-file 0 1)
5219 (copy-file 0 1)
5220 (make-symbolic-link 0 1)
5221 (add-name-to-file 0 1)))
5222 ;; For all other operations, treat the first argument only
5223 ;; as the file name.
5224 '(nil 0))))
6750c852 5225 method
47afc068
RS
5226 ;; Copy ARGUMENTS so we can replace elements in it.
5227 (arguments (copy-sequence arguments)))
6750c852
RS
5228 (if (symbolp (car file-arg-indices))
5229 (setq method (pop file-arg-indices)))
5230 ;; Strip off the /: from the file names that have it.
47afc068 5231 (save-match-data
18b9dced 5232 (while (consp file-arg-indices)
fe4d9852
KH
5233 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5234 (and (car pair)
5235 (string-match "\\`/:" (car pair))
5236 (setcar pair
5237 (if (= (length (car pair)) 2)
5238 "/"
5239 (substring (car pair) 2)))))
47afc068 5240 (setq file-arg-indices (cdr file-arg-indices))))
6750c852
RS
5241 (cond ((eq method 'identity)
5242 (car arguments))
ae3b2983 5243 ((eq method 'add)
6750c852 5244 (concat "/:" (apply operation arguments)))
ae3b2983 5245 ((eq method 'quote)
e8f30180
RS
5246 (unwind-protect
5247 (apply operation arguments)
ae3b2983
MA
5248 (setq buffer-file-name (concat "/:" buffer-file-name))))
5249 ((eq method 'unquote-then-quote)
5250 (let (res)
5251 (setq buffer-file-name (substring buffer-file-name 2))
5252 (setq res (apply operation arguments))
5253 (setq buffer-file-name (concat "/:" buffer-file-name))
5254 res))
6750c852
RS
5255 (t
5256 (apply operation arguments)))))
47afc068 5257\f
b4da00e9 5258(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
5259(define-key ctl-x-map "\C-r" 'find-file-read-only)
5260(define-key ctl-x-map "\C-v" 'find-alternate-file)
5261(define-key ctl-x-map "\C-s" 'save-buffer)
5262(define-key ctl-x-map "s" 'save-some-buffers)
5263(define-key ctl-x-map "\C-w" 'write-file)
5264(define-key ctl-x-map "i" 'insert-file)
5265(define-key esc-map "~" 'not-modified)
5266(define-key ctl-x-map "\C-d" 'list-directory)
5267(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
d758359d 5268(define-key ctl-x-map "\C-q" 'toggle-read-only)
b4da00e9
RM
5269
5270(define-key ctl-x-4-map "f" 'find-file-other-window)
5271(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5272(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5273(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 5274(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 5275
f98955ea
JB
5276(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5277(define-key ctl-x-5-map "f" 'find-file-other-frame)
5278(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5279(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
3095ccf5 5280(define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
c0274f38 5281
c3f6aa20 5282;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
c0274f38 5283;;; files.el ends here