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