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