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