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