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