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