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