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