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