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