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