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