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