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