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