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