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