1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2014 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
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/>.
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.
31 (defvar font-lock-keywords)
34 "Backups of edited data files."
37 (defgroup find-file nil
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."
50 (defcustom directory-abbrev-alist
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"
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'."
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'."
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."
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."
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)
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."
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."
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."
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)
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."
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)))
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))
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'."
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
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'."
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))
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."
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))
299 (defcustom kept-old-versions 2
300 "Number of oldest versions to keep when a new numbered backup is made."
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"
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'."
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
354 (defcustom auto-save-default t
355 "Non-nil says by default do auto-saving of every file-visiting buffer."
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
386 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
387 (boolean :tag "Uniquify")))
388 :initialize 'custom-initialize-delay
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))
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'."
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))
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))
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."
437 :options '(auto-insert)
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
504 The command \\[normal-mode], when used interactively,
505 always obeys file local variable specifications and the -*- line,
506 and ignores this variable."
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))
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
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."
557 :type '(choice (const :tag "Obey" t)
558 (const :tag "Ignore" nil)
559 (other :tag "Query" other))
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 \\[toggle-read-only]."
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 (put 'ange-ftp-completion-hook-function 'safe-magic t)
578 (defun ange-ftp-completion-hook-function (op &rest args)
579 "Provides support for ange-ftp host name completion.
580 Runs the usual ange-ftp hook, but only for completion operations."
581 ;; Having this here avoids the need to load ange-ftp when it's not
583 (if (memq op '(file-name-completion file-name-all-completions))
584 (apply 'ange-ftp-hook-function op args)
585 (let ((inhibit-file-name-handlers
586 (cons 'ange-ftp-completion-hook-function
587 (and (eq inhibit-file-name-operation op)
588 inhibit-file-name-handlers)))
589 (inhibit-file-name-operation op))
592 (declare-function dos-convert-standard-filename "dos-fns.el" (filename))
593 (declare-function w32-convert-standard-filename "w32-fns.el" (filename))
595 (defun convert-standard-filename (filename)
596 "Convert a standard file's name to something suitable for the OS.
597 This means to guarantee valid names and perhaps to canonicalize
600 FILENAME should be an absolute file name since the conversion rules
601 sometimes vary depending on the position in the file name. E.g. c:/foo
602 is a valid DOS file name, but c:/bar/c:/foo is not.
604 This function's standard definition is trivial; it just returns
605 the argument. However, on Windows and DOS, replace invalid
606 characters. On DOS, make sure to obey the 8.3 limitations.
607 In the native Windows build, turn Cygwin names into native names,
608 and also turn slashes into backslashes if the shell requires it (see
609 `w32-shell-dos-semantics').
611 See Info node `(elisp)Standard File Names' for more details."
613 ((eq system-type 'cygwin)
614 (let ((name (copy-sequence filename))
616 ;; Replace invalid filename characters with !
617 (while (string-match "[?*:<>|\"\000-\037]" name start)
618 (aset name (match-beginning 0) ?!)
619 (setq start (match-end 0)))
621 ((eq system-type 'windows-nt)
622 (w32-convert-standard-filename filename))
623 ((eq system-type 'ms-dos)
624 (dos-convert-standard-filename filename))
627 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
628 "Read directory name, prompting with PROMPT and completing in directory DIR.
629 Value is not expanded---you must call `expand-file-name' yourself.
630 Default name to DEFAULT-DIRNAME if user exits with the same
631 non-empty string that was inserted by this function.
632 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
633 or just DIR if INITIAL is nil.)
634 If the user exits with an empty minibuffer, this function returns
635 an empty string. (This can only happen if the user erased the
636 pre-inserted contents or if `insert-default-directory' is nil.)
637 Fourth arg MUSTMATCH non-nil means require existing directory's name.
638 Non-nil and non-t means also require confirmation after completion.
639 Fifth arg INITIAL specifies text to start with.
640 DIR should be an absolute directory name. It defaults to
641 the value of `default-directory'."
643 (setq dir default-directory))
644 (read-file-name prompt dir (or default-dirname
645 (if initial (expand-file-name initial dir)
652 "Show the current default directory."
654 (message "Directory %s" default-directory))
657 "Value of the CDPATH environment variable, as a list.
658 Not actually set up until the first time you use it.")
660 (defun parse-colon-path (search-path)
661 "Explode a search path into a list of directory names.
662 Directories are separated by `path-separator' (which is colon in
663 GNU and Unix systems). Substitute environment variables into the
664 resulting list of directory names. For an empty path element (i.e.,
665 a leading or trailing separator, or two adjacent separators), return
666 nil (meaning `default-directory') as the associated list element."
667 (when (stringp search-path)
670 (substitute-in-file-name (file-name-as-directory f))))
671 (split-string search-path path-separator))))
673 (defun cd-absolute (dir)
674 "Change current directory to given absolute file name DIR."
675 ;; Put the name into directory syntax now,
676 ;; because otherwise expand-file-name may give some bad results.
677 (setq dir (file-name-as-directory dir))
678 ;; We used to additionally call abbreviate-file-name here, for an
679 ;; unknown reason. Problem is that most buffers are setup
680 ;; without going through cd-absolute and don't call
681 ;; abbreviate-file-name on their default-directory, so the few that
682 ;; do end up using a superficially different directory.
683 (setq dir (expand-file-name dir))
684 (if (not (file-directory-p dir))
685 (if (file-exists-p dir)
686 (error "%s is not a directory" dir)
687 (error "%s: no such directory" dir))
688 (unless (file-accessible-directory-p dir)
689 (error "Cannot cd to %s: Permission denied" dir))
690 (setq default-directory dir)
691 (setq list-buffers-directory dir)))
694 "Make DIR become the current buffer's default directory.
695 If your environment includes a `CDPATH' variable, try each one of
696 that list of directories (separated by occurrences of
697 `path-separator') when resolving a relative directory name.
698 The path separator is colon in GNU and GNU-like systems."
701 ;; FIXME: There's a subtle bug in the completion below. Seems linked
702 ;; to a fundamental difficulty of implementing `predicate' correctly.
703 ;; The manifestation is that TAB may list non-directories in the case where
704 ;; those files also correspond to valid directories (if your cd-path is (A/
705 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
706 ;; will be listed as valid completions).
707 ;; This is because `a' (listed because of A/a) is indeed a valid choice
708 ;; (which will lead to the use of B/a).
709 (minibuffer-with-setup-hook
711 (setq minibuffer-completion-table
712 (apply-partially #'locate-file-completion-table
714 (setq minibuffer-completion-predicate
716 (locate-file dir cd-path nil
717 (lambda (f) (and (file-directory-p f) 'dir-ok))))))
719 (setq cd-path (or (parse-colon-path (getenv "CDPATH"))
721 (read-directory-name "Change default directory: "
722 default-directory default-directory
725 (setq cd-path (or (parse-colon-path (getenv "CDPATH"))
728 (or (locate-file dir cd-path nil
729 (lambda (f) (and (file-directory-p f) 'dir-ok)))
730 (error "No such directory found via CDPATH environment variable"))))
732 (defun load-file (file)
733 "Load the Lisp file named FILE."
734 ;; This is a case where .elc makes a lot of sense.
735 (interactive (list (let ((completion-ignored-extensions
736 (remove ".elc" completion-ignored-extensions)))
737 (read-file-name "Load file: " nil nil 'lambda))))
738 (load (expand-file-name file) nil nil t))
740 (defun locate-file (filename path &optional suffixes predicate)
741 "Search for FILENAME through PATH.
742 If found, return the absolute file name of FILENAME; otherwise
744 PATH should be a list of directories to look in, like the lists in
745 `exec-path' or `load-path'.
746 If SUFFIXES is non-nil, it should be a list of suffixes to append to
747 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
748 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
749 If non-nil, PREDICATE is used instead of `file-readable-p'.
751 This function will normally skip directories, so if you want it to find
752 directories, make sure the PREDICATE function returns `dir-ok' for them.
754 PREDICATE can also be an integer to pass to the `access' system call,
755 in which case file-name handlers are ignored. This usage is deprecated.
756 For compatibility, PREDICATE can also be one of the symbols
757 `executable', `readable', `writable', or `exists', or a list of
758 one or more of those symbols."
759 (if (and predicate (symbolp predicate) (not (functionp predicate)))
760 (setq predicate (list predicate)))
761 (when (and (consp predicate) (not (functionp predicate)))
763 (logior (if (memq 'executable predicate) 1 0)
764 (if (memq 'writable predicate) 2 0)
765 (if (memq 'readable predicate) 4 0))))
766 (locate-file-internal filename path suffixes predicate))
768 (defun locate-file-completion-table (dirs suffixes string pred action)
769 "Do completion for file names passed to `locate-file'."
771 ((file-name-absolute-p string)
772 ;; FIXME: maybe we should use completion-file-name-table instead,
773 ;; tho at least for `load', the arg is passed through
774 ;; substitute-in-file-name for historical reasons.
775 (read-file-name-internal string pred action))
776 ((eq (car-safe action) 'boundaries)
777 (let ((suffix (cdr action)))
779 ,(length (file-name-directory string))
780 ,@(let ((x (file-name-directory suffix)))
781 (if x (1- (length x)) (length suffix))))))
784 ;; If we have files like "foo.el" and "foo.elc", we could load one of
785 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
786 ;; preferred way. So if we list all 3, that gives a lot of redundant
787 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
788 ;; the user does want to pay attention to the extension. We try to
789 ;; diffuse this tension by stripping the suffix, except when the
790 ;; result is a single element (i.e. usually we only list "foo" unless
791 ;; it's the only remaining element in the list, in which case we do
792 ;; list "foo", "foo.elc" and "foo.el").
794 (suffix (concat (regexp-opt suffixes t) "\\'"))
795 (string-dir (file-name-directory string))
796 (string-file (file-name-nondirectory string)))
799 (setq dir default-directory))
800 (if string-dir (setq dir (expand-file-name string-dir dir)))
801 (when (file-directory-p dir)
802 (dolist (file (file-name-all-completions
804 (if (not (string-match suffix file))
806 (push file fullnames)
807 (push (substring file 0 (match-beginning 0)) names)))))
808 ;; Switching from names to names+fullnames creates a non-monotonicity
809 ;; which can cause problems with things like partial-completion.
810 ;; To minimize the problem, filter out completion-regexp-list, so that
811 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
812 ;; from `names' which only matched `string' when they still had
814 (setq names (all-completions string names))
815 ;; Remove duplicates of the first element, so that we can easily check
816 ;; if `names' really only contains a single element.
817 (when (cdr names) (setcdr names (delete (car names) (cdr names))))
819 ;; There's no more than one matching non-suffixed element, so expand
820 ;; the list by adding the suffixed elements as well.
821 (setq names (nconc names fullnames)))
822 (completion-table-with-context
823 string-dir names string-file pred action)))))
825 (defun locate-file-completion (string path-and-suffixes action)
826 "Do completion for file names passed to `locate-file'.
827 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
828 (declare (obsolete locate-file-completion-table "23.1"))
829 (locate-file-completion-table (car path-and-suffixes)
830 (cdr path-and-suffixes)
833 (defvar locate-dominating-stop-dir-regexp
834 (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
835 "Regexp of directory names which stop the search in `locate-dominating-file'.
836 Any directory whose name matches this regexp will be treated like
837 a kind of root directory by `locate-dominating-file' which will stop its search
838 when it bumps into it.
839 The default regexp prevents fruitless and time-consuming attempts to find
840 special files in directories in which filenames are interpreted as hostnames,
841 or mount points potentially requiring authentication as a different user.")
843 ;; (defun locate-dominating-files (file regexp)
844 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
845 ;; Stop at the first parent where a matching file is found and return the list
846 ;; of files that that match in this directory."
848 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
849 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
851 ;; ;; Abbreviate, so as to stop when we cross ~/.
852 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
855 ;; ;; As a heuristic, we stop looking up the hierarchy of
856 ;; ;; directories as soon as we find a directory belonging to
857 ;; ;; another user. This should save us from looking in
858 ;; ;; things like /net and /afs. This assumes that all the
859 ;; ;; files inside a project belong to the same user.
860 ;; (let ((prev-user user))
861 ;; (setq user (nth 2 (file-attributes dir)))
862 ;; (or (null prev-user) (equal user prev-user))))
863 ;; (if (setq files (condition-case nil
864 ;; (directory-files dir 'full regexp 'nosort)
866 ;; (throw 'found files)
868 ;; (setq dir (file-name-directory
869 ;; (directory-file-name dir))))
873 (defun locate-dominating-file (file name)
874 "Look up the directory hierarchy from FILE for a directory containing NAME.
875 Stop at the first parent directory containing a file NAME,
876 and return the directory. Return nil if not found.
877 Instead of a string, NAME can also be a predicate taking one argument
878 \(a directory) and returning a non-nil value if that directory is the one for
879 which we're looking."
880 ;; We used to use the above locate-dominating-files code, but the
881 ;; directory-files call is very costly, so we're much better off doing
882 ;; multiple calls using the code in here.
884 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
885 ;; `name' in /home or in /.
886 (setq file (abbreviate-file-name (expand-file-name file)))
888 ;; `user' is not initialized outside the loop because
889 ;; `file' may not exist, so we may have to walk up part of the
890 ;; hierarchy before we find the "initial UID". Note: currently unused
895 ;; FIXME: Disabled this heuristic because it is sometimes
897 ;; As a heuristic, we stop looking up the hierarchy of
898 ;; directories as soon as we find a directory belonging
899 ;; to another user. This should save us from looking in
900 ;; things like /net and /afs. This assumes that all the
901 ;; files inside a project belong to the same user.
902 ;; (let ((prev-user user))
903 ;; (setq user (nth 2 (file-attributes file)))
904 ;; (and prev-user (not (equal user prev-user))))
905 (string-match locate-dominating-stop-dir-regexp file)))
906 (setq try (if (stringp name)
907 (file-exists-p (expand-file-name name file))
908 (funcall name file)))
909 (cond (try (setq root file))
910 ((equal file (setq file (file-name-directory
911 (directory-file-name file))))
913 (if root (file-name-as-directory root))))
915 (defcustom user-emacs-directory-warning t
916 "Non-nil means warn if cannot access `user-emacs-directory'.
917 Set this to nil at your own risk..."
919 :group 'initialization
922 (defun locate-user-emacs-file (new-name &optional old-name)
923 "Return an absolute per-user Emacs-specific file name.
924 If NEW-NAME exists in `user-emacs-directory', return it.
925 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
926 Else return NEW-NAME in `user-emacs-directory', creating the
927 directory if it does not exist."
928 (convert-standard-filename
929 (let* ((home (concat "~" (or init-file-user "")))
930 (at-home (and old-name (expand-file-name old-name home)))
931 (bestname (abbreviate-file-name
932 (expand-file-name new-name user-emacs-directory))))
933 (if (and at-home (not (file-readable-p bestname))
934 (file-readable-p at-home))
936 ;; Make sure `user-emacs-directory' exists,
937 ;; unless we're in batch mode or dumping Emacs.
941 (if (file-directory-p user-emacs-directory)
942 (or (file-accessible-directory-p user-emacs-directory)
943 (setq errtype "access"))
944 (with-file-modes ?\700
946 (make-directory user-emacs-directory)
947 (error (setq errtype "create")))))
949 user-emacs-directory-warning
950 (not (get 'user-emacs-directory-warning 'this-session)))
951 ;; Only warn once per Emacs session.
952 (put 'user-emacs-directory-warning 'this-session t)
953 (display-warning 'initialization
955 Unable to %s `user-emacs-directory' (%s).
956 Any data that would normally be written there may be lost!
957 If you never want to see this message again,
958 customize the variable `user-emacs-directory-warning'."
959 errtype user-emacs-directory)))))
963 (defun executable-find (command)
964 "Search for COMMAND in `exec-path' and return the absolute file name.
965 Return nil if COMMAND is not found anywhere in `exec-path'."
966 ;; Use 1 rather than file-executable-p to better match the behavior of
968 (locate-file command exec-path exec-suffixes 1))
970 (defun load-library (library)
971 "Load the Emacs Lisp library named LIBRARY.
972 This is an interface to the function `load'. LIBRARY is searched
973 for in `load-path', both with and without `load-suffixes' (as
974 well as `load-file-rep-suffixes').
976 See Info node `(emacs)Lisp Libraries' for more details.
977 See `load-file' for a different interface to `load'."
979 (list (completing-read "Load library: "
980 (apply-partially 'locate-file-completion-table
982 (get-load-suffixes)))))
985 (defun file-remote-p (file &optional identification connected)
986 "Test whether FILE specifies a location on a remote system.
987 A file is considered remote if accessing it is likely to
988 be slower or less reliable than accessing local files.
990 `file-remote-p' never opens a new remote connection. It can
991 only reuse a connection that is already open.
993 Return nil or a string identifying the remote connection
994 \(ideally a prefix of FILE). Return nil if FILE is a relative
997 When IDENTIFICATION is nil, the returned string is a complete
998 remote identifier: with components method, user, and host. The
999 components are those present in FILE, with defaults filled in for
1000 any that are missing.
1002 IDENTIFICATION can specify which part of the identification to
1003 return. IDENTIFICATION can be the symbol `method', `user',
1004 `host', or `localname'. Any other value is handled like nil and
1005 means to return the complete identification. The string returned
1006 for IDENTIFICATION `localname' can differ depending on whether
1007 there is an existing connection.
1009 If CONNECTED is non-nil, return an identification only if FILE is
1010 located on a remote system and a connection is established to
1013 Tip: You can use this expansion of remote identifier components
1014 to derive a new remote file name from an existing one. For
1015 example, if FILE is \"/sudo::/path/to/file\" then
1017 \(concat \(file-remote-p FILE) \"/bin/sh\")
1019 returns a remote file name for file \"/bin/sh\" that has the
1020 same remote identifier as FILE but expanded; a name such as
1021 \"/sudo:root@myhost:/bin/sh\"."
1022 (let ((handler (find-file-name-handler file 'file-remote-p)))
1024 (funcall handler 'file-remote-p file identification connected)
1027 ;; Probably this entire variable should be obsolete now, in favor of
1028 ;; something Tramp-related (?). It is not used in many places.
1029 ;; It's not clear what the best file for this to be in is, but given
1030 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1031 ;; rather than autoloaded.
1032 (defcustom remote-shell-program
1033 ;; This used to try various hard-coded places for remsh, rsh, and
1034 ;; rcmd, trying to guess based on location whether "rsh" was
1035 ;; "restricted shell" or "remote shell", but I don't see the point
1036 ;; in this day and age. Almost everyone will use ssh, and have
1037 ;; whatever command they want to use in PATH.
1039 (let ((list '("ssh" "remsh" "rcmd" "rsh")))
1041 (not (executable-find (car list)))
1042 (setq list (cdr list))))
1043 (or (car list) "ssh")))
1044 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1045 :version "24.3" ; ssh rather than rsh, etc
1046 :initialize 'custom-initialize-delay
1050 (defcustom remote-file-name-inhibit-cache 10
1051 "Whether to use the remote file-name cache for read access.
1052 When `nil', never expire cached values (caution)
1053 When `t', never use the cache (safe, but may be slow)
1054 A number means use cached values for that amount of seconds since caching.
1056 The attributes of remote files are cached for better performance.
1057 If they are changed outside of Emacs's control, the cached values
1058 become invalid, and must be reread. If you are sure that nothing
1059 other than Emacs changes the files, you can set this variable to `nil'.
1061 If a remote file is checked regularly, it might be a good idea to
1062 let-bind this variable to a value less than the interval between
1063 consecutive checks. For example:
1065 (defun display-time-file-nonempty-p (file)
1066 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1067 (and (file-exists-p file)
1068 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1072 (const :tag "Do not inhibit file name cache" nil)
1073 (const :tag "Do not use file name cache" t)
1074 (integer :tag "Do not use file name cache"
1075 :format "Do not use file name cache older then %v seconds"
1078 (defun file-local-copy (file)
1079 "Copy the file FILE into a temporary file on this machine.
1080 Returns the name of the local copy, or nil, if FILE is directly
1082 ;; This formerly had an optional BUFFER argument that wasn't used by
1084 (let ((handler (find-file-name-handler file 'file-local-copy)))
1086 (funcall handler 'file-local-copy file)
1089 (defun file-truename (filename &optional counter prev-dirs)
1090 "Return the truename of FILENAME.
1091 If FILENAME is not absolute, first expands it against `default-directory'.
1092 The truename of a file name is found by chasing symbolic links
1093 both at the level of the file and at the level of the directories
1094 containing it, until no links are left at any level.
1096 \(fn FILENAME)" ;; Don't document the optional arguments.
1097 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1098 ;; COUNTER can be a cons cell whose car is the count of how many
1099 ;; more links to chase before getting an error.
1100 ;; PREV-DIRS can be a cons cell whose car is an alist
1101 ;; of truenames we've just recently computed.
1102 (cond ((or (string= filename "") (string= filename "~"))
1103 (setq filename (expand-file-name filename))
1104 (if (string= filename "")
1105 (setq filename "/")))
1106 ((and (string= (substring filename 0 1) "~")
1107 (string-match "~[^/]*/?" filename))
1109 (substring filename 0 (match-end 0)))
1110 (rest (substring filename (match-end 0))))
1111 (setq filename (concat (expand-file-name first-part) rest)))))
1113 (or counter (setq counter (list 100)))
1115 ;; For speed, remove the ange-ftp completion handler from the list.
1116 ;; We know it's not needed here.
1117 ;; For even more speed, do this only on the outermost call.
1118 (file-name-handler-alist
1119 (if prev-dirs file-name-handler-alist
1120 (let ((tem (copy-sequence file-name-handler-alist)))
1121 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
1122 (or prev-dirs (setq prev-dirs (list nil)))
1124 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1125 ;; case differences being ignored by the OS, and short "8.3 DOS"
1126 ;; name aliases existing for all files. (The short names are not
1127 ;; reported by directory-files, but can be used to refer to files.)
1128 ;; It seems appropriate for file-truename to resolve these issues in
1129 ;; the most natural way, which on Windows is to call the function
1130 ;; `w32-long-file-name' - this returns the exact name of a file as
1131 ;; it is stored on disk (expanding short name aliases with the full
1132 ;; name in the process).
1133 (if (eq system-type 'windows-nt)
1134 (unless (string-match "[[*?]" filename)
1135 ;; If filename exists, use its long name. If it doesn't
1136 ;; exist, the recursion below on the directory of filename
1137 ;; will drill down until we find a directory that exists,
1138 ;; and use the long name of that, with the extra
1139 ;; non-existent path components concatenated.
1140 (let ((longname (w32-long-file-name filename)))
1142 (setq filename longname)))))
1144 ;; If this file directly leads to a link, process that iteratively
1145 ;; so that we don't use lots of stack.
1147 (setcar counter (1- (car counter)))
1148 (if (< (car counter) 0)
1149 (error "Apparent cycle of symbolic links for %s" filename))
1150 (let ((handler (find-file-name-handler filename 'file-truename)))
1151 ;; For file name that has a special handler, call handler.
1152 ;; This is so that ange-ftp can save time by doing a no-op.
1154 (setq filename (funcall handler 'file-truename filename)
1156 (let ((dir (or (file-name-directory filename) default-directory))
1158 ;; Get the truename of the directory.
1159 (setq dirfile (directory-file-name dir))
1160 ;; If these are equal, we have the (or a) root directory.
1161 (or (string= dir dirfile)
1162 (and (memq system-type '(windows-nt ms-dos cygwin))
1163 (eq (compare-strings dir 0 nil dirfile 0 nil t) t))
1164 ;; If this is the same dir we last got the truename for,
1165 ;; save time--don't recalculate.
1166 (if (assoc dir (car prev-dirs))
1167 (setq dir (cdr (assoc dir (car prev-dirs))))
1169 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
1170 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
1172 (if (equal ".." (file-name-nondirectory filename))
1174 (directory-file-name (file-name-directory (directory-file-name dir)))
1176 (if (equal "." (file-name-nondirectory filename))
1177 (setq filename (directory-file-name dir)
1179 ;; Put it back on the file name.
1180 (setq filename (concat dir (file-name-nondirectory filename)))
1181 ;; Is the file name the name of a link?
1182 (setq target (file-symlink-p filename))
1184 ;; Yes => chase that link, then start all over
1185 ;; since the link may point to a directory name that uses links.
1186 ;; We can't safely use expand-file-name here
1187 ;; since target might look like foo/../bar where foo
1188 ;; is itself a link. Instead, we handle . and .. above.
1190 (if (file-name-absolute-p target)
1192 (concat dir target))
1195 (setq done t))))))))
1198 (defun file-chase-links (filename &optional limit)
1199 "Chase links in FILENAME until a name that is not a link.
1200 Unlike `file-truename', this does not check whether a parent
1201 directory name is a symbolic link.
1202 If the optional argument LIMIT is a number,
1203 it means chase no more than that many links and then stop."
1204 (let (tem (newname filename)
1206 (while (and (or (null limit) (< count limit))
1207 (setq tem (file-symlink-p newname)))
1209 (if (and (null limit) (= count 100))
1210 (error "Apparent cycle of symbolic links for %s" filename))
1211 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1212 (while (string-match "//+" tem)
1213 (setq tem (replace-match "/" nil nil tem)))
1214 ;; Handle `..' by hand, since it needs to work in the
1215 ;; target of any directory symlink.
1216 ;; This code is not quite complete; it does not handle
1217 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1218 (while (string-match "\\`\\.\\./" tem)
1219 (setq tem (substring tem 3))
1220 (setq newname (expand-file-name newname))
1221 ;; Chase links in the default dir of the symlink.
1224 (directory-file-name (file-name-directory newname))))
1225 ;; Now find the parent of that dir.
1226 (setq newname (file-name-directory newname)))
1227 (setq newname (expand-file-name tem (file-name-directory newname)))
1228 (setq count (1+ count))))
1231 ;; A handy function to display file sizes in human-readable form.
1232 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1233 (defun file-size-human-readable (file-size &optional flavor)
1234 "Produce a string showing FILE-SIZE in human-readable form.
1236 Optional second argument FLAVOR controls the units and the display format:
1238 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1239 suffixes are \"k\", \"M\", \"G\", \"T\", etc.
1240 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1241 are \"k\", \"M\", \"G\", \"T\", etc.
1242 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1243 are \"KiB\", \"MiB\", \"GiB\", \"TiB\", etc."
1244 (let ((power (if (or (null flavor) (eq flavor 'iec))
1248 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1249 (list "" "k" "M" "G" "T" "P" "E" "Z" "Y")))
1250 (while (and (>= file-size power) (cdr post-fixes))
1251 (setq file-size (/ file-size power)
1252 post-fixes (cdr post-fixes)))
1253 (format (if (> (mod file-size 1.0) 0.05)
1257 (if (and (eq flavor 'iec) (string= (car post-fixes) "k"))
1260 (if (eq flavor 'iec) "iB" ""))))
1262 (defun make-temp-file (prefix &optional dir-flag suffix)
1263 "Create a temporary file.
1264 The returned file name (created by appending some random characters at the end
1265 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1266 is guaranteed to point to a newly created empty file.
1267 You can then use `write-region' to write new data into the file.
1269 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1271 If SUFFIX is non-nil, add that at the end of the file name."
1272 ;; Create temp files with strict access rights. It's easy to
1273 ;; loosen them later, whereas it's impossible to close the
1274 ;; time-window of loose permissions otherwise.
1275 (with-file-modes ?\700
1277 (while (condition-case ()
1281 (if (zerop (length prefix))
1282 (file-name-as-directory
1283 temporary-file-directory)
1284 (expand-file-name prefix
1285 temporary-file-directory))))
1287 (setq file (concat file suffix)))
1289 (make-directory file)
1290 (write-region "" nil file nil 'silent nil 'excl))
1292 (file-already-exists t))
1293 ;; the file was somehow created by someone else between
1294 ;; `make-temp-name' and `write-region', let's try again.
1298 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1299 "Change the encoding of FILE's name from CODING to NEW-CODING.
1300 The value is a new name of FILE.
1301 Signals a `file-already-exists' error if a file of the new name
1302 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1303 is non-nil. A number as fourth arg means request confirmation if
1304 the new name already exists. This is what happens in interactive
1307 (let ((default-coding (or file-name-coding-system
1308 default-file-name-coding-system))
1309 (filename (read-file-name "Recode filename: " nil nil t))
1310 from-coding to-coding)
1311 (if (and default-coding
1312 ;; We provide the default coding only when it seems that
1313 ;; the filename is correctly decoded by the default
1315 (let ((charsets (find-charset-string filename)))
1316 (and (not (memq 'eight-bit-control charsets))
1317 (not (memq 'eight-bit-graphic charsets)))))
1318 (setq from-coding (read-coding-system
1319 (format "Recode filename %s from (default %s): "
1320 filename default-coding)
1322 (setq from-coding (read-coding-system
1323 (format "Recode filename %s from: " filename))))
1325 ;; We provide the default coding only when a user is going to
1326 ;; change the encoding not from the default coding.
1327 (if (eq from-coding default-coding)
1328 (setq to-coding (read-coding-system
1329 (format "Recode filename %s from %s to: "
1330 filename from-coding)))
1331 (setq to-coding (read-coding-system
1332 (format "Recode filename %s from %s to (default %s): "
1333 filename from-coding default-coding)
1335 (list filename from-coding to-coding)))
1337 (let* ((default-coding (or file-name-coding-system
1338 default-file-name-coding-system))
1339 ;; FILE should have been decoded by DEFAULT-CODING.
1340 (encoded (encode-coding-string file default-coding))
1341 (newname (decode-coding-string encoded coding))
1342 (new-encoded (encode-coding-string newname new-coding))
1343 ;; Suppress further encoding.
1344 (file-name-coding-system nil)
1345 (default-file-name-coding-system nil)
1346 (locale-coding-system nil))
1347 (rename-file encoded new-encoded ok-if-already-exists)
1350 (defcustom confirm-nonexistent-file-or-buffer 'after-completion
1351 "Whether confirmation is requested before visiting a new file or buffer.
1352 If nil, confirmation is not requested.
1353 If the value is `after-completion', confirmation is only
1354 requested if the user called `minibuffer-complete' right before
1355 `minibuffer-complete-and-exit'.
1356 Any other non-nil value means to request confirmation.
1358 This affects commands like `switch-to-buffer' and `find-file'."
1361 :type '(choice (const :tag "After completion" after-completion)
1362 (const :tag "Never" nil)
1363 (other :tag "Always" t)))
1365 (defun confirm-nonexistent-file-or-buffer ()
1366 "Whether to request confirmation before visiting a new file or buffer.
1367 The variable `confirm-nonexistent-file-or-buffer' determines the
1368 return value, which may be passed as the REQUIRE-MATCH arg to
1369 `read-buffer' or `find-file-read-args'."
1370 (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion)
1371 'confirm-after-completion)
1372 (confirm-nonexistent-file-or-buffer
1376 (defmacro minibuffer-with-setup-hook (fun &rest body)
1377 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1378 BODY should use the minibuffer at most once.
1379 Recursive uses of the minibuffer are unaffected (FUN is not
1380 called additional times).
1382 This macro actually adds an auxiliary function that calls FUN,
1383 rather than FUN itself, to `minibuffer-setup-hook'."
1384 (declare (indent 1) (debug t))
1385 (let ((hook (make-symbol "setup-hook")))
1389 ;; Clear out this hook so it does not interfere
1390 ;; with any recursive minibuffer usage.
1391 (remove-hook 'minibuffer-setup-hook ,hook)
1395 (add-hook 'minibuffer-setup-hook ,hook)
1397 (remove-hook 'minibuffer-setup-hook ,hook)))))
1399 (defun find-file-read-args (prompt mustmatch)
1400 (list (read-file-name prompt nil default-directory mustmatch)
1403 (defun find-file (filename &optional wildcards)
1404 "Edit file FILENAME.
1405 Switch to a buffer visiting file FILENAME,
1406 creating one if none already exists.
1407 Interactively, the default if you just type RET is the current directory,
1408 but the visited file name is available through the minibuffer history:
1409 type M-n to pull it into the minibuffer.
1411 You can visit files on remote machines by specifying something
1412 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1413 also visit local files as a different user by specifying
1414 /sudo::FILE for the file name.
1415 See the Info node `(tramp)File name Syntax' in the Tramp Info
1416 manual, for more about this.
1418 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1419 expand wildcards (if any) and visit multiple files. You can
1420 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1422 To visit a file without any kind of conversion and without
1423 automatically choosing a major mode, use \\[find-file-literally]."
1425 (find-file-read-args "Find file: "
1426 (confirm-nonexistent-file-or-buffer)))
1427 (let ((value (find-file-noselect filename nil nil wildcards)))
1429 (mapcar 'switch-to-buffer (nreverse value))
1430 (switch-to-buffer value))))
1432 (defun find-file-other-window (filename &optional wildcards)
1433 "Edit file FILENAME, in another window.
1435 Like \\[find-file] (which see), but creates a new window or reuses
1436 an existing one. See the function `display-buffer'.
1438 Interactively, the default if you just type RET is the current directory,
1439 but the visited file name is available through the minibuffer history:
1440 type M-n to pull it into the minibuffer.
1442 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1443 expand wildcards (if any) and visit multiple files."
1445 (find-file-read-args "Find file in other window: "
1446 (confirm-nonexistent-file-or-buffer)))
1447 (let ((value (find-file-noselect filename nil nil wildcards)))
1450 (setq value (nreverse value))
1451 (cons (switch-to-buffer-other-window (car value))
1452 (mapcar 'switch-to-buffer (cdr value))))
1453 (switch-to-buffer-other-window value))))
1455 (defun find-file-other-frame (filename &optional wildcards)
1456 "Edit file FILENAME, in another frame.
1458 Like \\[find-file] (which see), but creates a new frame or reuses
1459 an existing one. See the function `display-buffer'.
1461 Interactively, the default if you just type RET is the current directory,
1462 but the visited file name is available through the minibuffer history:
1463 type M-n to pull it into the minibuffer.
1465 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1466 expand wildcards (if any) and visit multiple files."
1468 (find-file-read-args "Find file in other frame: "
1469 (confirm-nonexistent-file-or-buffer)))
1470 (let ((value (find-file-noselect filename nil nil wildcards)))
1473 (setq value (nreverse value))
1474 (cons (switch-to-buffer-other-frame (car value))
1475 (mapcar 'switch-to-buffer (cdr value))))
1476 (switch-to-buffer-other-frame value))))
1478 (defun find-file-existing (filename)
1479 "Edit the existing file FILENAME.
1480 Like \\[find-file], but only allow a file that exists, and do not allow
1481 file names with wildcards."
1482 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1483 (if (and (not (called-interactively-p 'interactive))
1484 (not (file-exists-p filename)))
1485 (error "%s does not exist" filename)
1486 (find-file filename)
1489 (defun find-file--read-only (fun filename wildcards)
1490 (unless (or (and wildcards find-file-wildcards
1491 (not (string-match "\\`/:" filename))
1492 (string-match "[[*?]" filename))
1493 (file-exists-p filename))
1494 (error "%s does not exist" filename))
1495 (let ((value (funcall fun filename wildcards)))
1496 (mapc (lambda (b) (with-current-buffer b (read-only-mode 1)))
1497 (if (listp value) value (list value)))
1500 (defun find-file-read-only (filename &optional wildcards)
1501 "Edit file FILENAME but don't allow changes.
1502 Like \\[find-file], but marks buffer as read-only.
1503 Use \\[toggle-read-only] to permit editing."
1505 (find-file-read-args "Find file read-only: "
1506 (confirm-nonexistent-file-or-buffer)))
1507 (find-file--read-only #'find-file filename wildcards))
1509 (defun find-file-read-only-other-window (filename &optional wildcards)
1510 "Edit file FILENAME in another window but don't allow changes.
1511 Like \\[find-file-other-window], but marks buffer as read-only.
1512 Use \\[toggle-read-only] to permit editing."
1514 (find-file-read-args "Find file read-only other window: "
1515 (confirm-nonexistent-file-or-buffer)))
1516 (find-file--read-only #'find-file-other-window filename wildcards))
1518 (defun find-file-read-only-other-frame (filename &optional wildcards)
1519 "Edit file FILENAME in another frame but don't allow changes.
1520 Like \\[find-file-other-frame], but marks buffer as read-only.
1521 Use \\[toggle-read-only] to permit editing."
1523 (find-file-read-args "Find file read-only other frame: "
1524 (confirm-nonexistent-file-or-buffer)))
1525 (find-file--read-only #'find-file-other-frame filename wildcards))
1527 (defun find-alternate-file-other-window (filename &optional wildcards)
1528 "Find file FILENAME as a replacement for the file in the next window.
1529 This command does not select that window.
1531 See \\[find-file] for the possible forms of the FILENAME argument.
1533 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1534 expand wildcards (if any) and replace the file with multiple files."
1536 (save-selected-window
1538 (let ((file buffer-file-name)
1542 (setq file-name (file-name-nondirectory file)
1543 file-dir (file-name-directory file)))
1544 (list (read-file-name
1545 "Find alternate file: " file-dir nil
1546 (confirm-nonexistent-file-or-buffer) file-name)
1549 (find-file-other-window filename wildcards)
1550 (save-selected-window
1552 (find-alternate-file filename wildcards))))
1554 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1555 (defvar kill-buffer-hook nil
1556 "Hook run when a buffer is killed.
1557 The buffer being killed is current while the hook is running.
1560 Note: Be careful with let-binding this hook considering it is
1561 frequently used for cleanup.")
1563 (defun find-alternate-file (filename &optional wildcards)
1564 "Find file FILENAME, select its buffer, kill previous buffer.
1565 If the current buffer now contains an empty file that you just visited
1566 \(presumably by mistake), use this command to visit the file you really want.
1568 See \\[find-file] for the possible forms of the FILENAME argument.
1570 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1571 expand wildcards (if any) and replace the file with multiple files.
1573 If the current buffer is an indirect buffer, or the base buffer
1574 for one or more indirect buffers, the other buffer(s) are not
1577 (let ((file buffer-file-name)
1581 (setq file-name (file-name-nondirectory file)
1582 file-dir (file-name-directory file)))
1583 (list (read-file-name
1584 "Find alternate file: " file-dir nil
1585 (confirm-nonexistent-file-or-buffer) file-name)
1587 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1589 (and (buffer-modified-p) buffer-file-name
1590 (not (yes-or-no-p "Kill and replace the buffer without saving it? "))
1592 (let ((obuf (current-buffer))
1593 (ofile buffer-file-name)
1594 (onum buffer-file-number)
1595 (odir dired-directory)
1596 (otrue buffer-file-truename)
1597 (oname (buffer-name)))
1598 ;; Run `kill-buffer-hook' here. It needs to happen before
1599 ;; variables like `buffer-file-name' etc are set to nil below,
1600 ;; because some of the hooks that could be invoked
1601 ;; (e.g., `save-place-to-alist') depend on those variables.
1603 ;; Note that `kill-buffer-hook' is not what queries whether to
1604 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1605 ;; asks that itself. Thus, there's no need to temporarily do
1606 ;; `(set-buffer-modified-p nil)' before running this hook.
1607 (run-hooks 'kill-buffer-hook)
1608 ;; Okay, now we can end-of-life the old buffer.
1609 (if (get-buffer " **lose**")
1610 (kill-buffer " **lose**"))
1611 (rename-buffer " **lose**")
1615 ;; This prevents us from finding the same buffer
1616 ;; if we specified the same file again.
1617 (setq buffer-file-name nil)
1618 (setq buffer-file-number nil)
1619 (setq buffer-file-truename nil)
1620 ;; Likewise for dired buffers.
1621 (setq dired-directory nil)
1622 (find-file filename wildcards))
1623 (when (eq obuf (current-buffer))
1624 ;; This executes if find-file gets an error
1625 ;; and does not really find anything.
1626 ;; We put things back as they were.
1627 ;; If find-file actually finds something, we kill obuf below.
1628 (setq buffer-file-name ofile)
1629 (setq buffer-file-number onum)
1630 (setq buffer-file-truename otrue)
1631 (setq dired-directory odir)
1633 (rename-buffer oname)))
1634 (unless (eq (current-buffer) obuf)
1635 (with-current-buffer obuf
1636 ;; We already ran these; don't run them again.
1637 (let (kill-buffer-query-functions kill-buffer-hook)
1638 (kill-buffer obuf))))))
1640 ;; FIXME we really need to fold the uniquify stuff in here by default,
1641 ;; not using advice, and add it to the doc string.
1642 (defun create-file-buffer (filename)
1643 "Create a suitably named buffer for visiting FILENAME, and return it.
1644 FILENAME (sans directory) is used unchanged if that name is free;
1645 otherwise a string <2> or <3> or ... is appended to get an unused name.
1647 Emacs treats buffers whose names begin with a space as internal buffers.
1648 To avoid confusion when visiting a file whose name begins with a space,
1649 this function prepends a \"|\" to the final result if necessary."
1650 (let ((lastname (file-name-nondirectory filename)))
1651 (if (string= lastname "")
1652 (setq lastname filename))
1653 (generate-new-buffer (if (string-match-p "\\` " lastname)
1654 (concat "|" lastname)
1657 (defun generate-new-buffer (name)
1658 "Create and return a buffer with a name based on NAME.
1659 Choose the buffer's name using `generate-new-buffer-name'."
1660 (get-buffer-create (generate-new-buffer-name name)))
1662 (defcustom automount-dir-prefix (purecopy "^/tmp_mnt/")
1663 "Regexp to match the automounter prefix in a directory name."
1666 (make-obsolete-variable 'automount-dir-prefix 'directory-abbrev-alist "24.3")
1668 (defvar abbreviated-home-dir nil
1669 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1671 (defun abbreviate-file-name (filename)
1672 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1673 This also substitutes \"~\" for the user's home directory (unless the
1674 home directory is a root directory) and removes automounter prefixes
1675 \(see the variable `automount-dir-prefix')."
1676 ;; Get rid of the prefixes added by the automounter.
1678 (if (and automount-dir-prefix
1679 (string-match automount-dir-prefix filename)
1680 (file-exists-p (file-name-directory
1681 (substring filename (1- (match-end 0))))))
1682 (setq filename (substring filename (1- (match-end 0)))))
1683 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1684 ;; To fix this right, we need a `file-name-case-sensitive-p'
1685 ;; function, but we don't have that yet, so just guess.
1686 (let ((case-fold-search
1687 (memq system-type '(ms-dos windows-nt darwin cygwin))))
1688 ;; If any elt of directory-abbrev-alist matches this name,
1689 ;; abbreviate accordingly.
1690 (dolist (dir-abbrev directory-abbrev-alist)
1691 (if (string-match (car dir-abbrev) filename)
1693 (concat (cdr dir-abbrev)
1694 (substring filename (match-end 0))))))
1695 ;; Compute and save the abbreviated homedir name.
1696 ;; We defer computing this until the first time it's needed, to
1697 ;; give time for directory-abbrev-alist to be set properly.
1698 ;; We include a slash at the end, to avoid spurious matches
1699 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1700 (or abbreviated-home-dir
1701 (setq abbreviated-home-dir
1702 (let ((abbreviated-home-dir "$foo"))
1703 (concat "\\`" (abbreviate-file-name (expand-file-name "~"))
1706 ;; If FILENAME starts with the abbreviated homedir,
1707 ;; make it start with `~' instead.
1708 (if (and (string-match abbreviated-home-dir filename)
1709 ;; If the home dir is just /, don't change it.
1710 (not (and (= (match-end 0) 1)
1711 (= (aref filename 0) ?/)))
1712 ;; MS-DOS root directories can come with a drive letter;
1713 ;; Novell Netware allows drive letters beyond `Z:'.
1714 (not (and (memq system-type '(ms-dos windows-nt cygwin))
1716 (string-match "^[a-zA-`]:/$" filename)))))
1719 (match-string 1 filename)
1720 (substring filename (match-end 0)))))
1723 (defun find-buffer-visiting (filename &optional predicate)
1724 "Return the buffer visiting file FILENAME (a string).
1725 This is like `get-file-buffer', except that it checks for any buffer
1726 visiting the same file, possibly under a different name.
1727 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1728 and others are ignored.
1729 If there is no such live buffer, return nil."
1730 (let ((predicate (or predicate #'identity))
1731 (truename (abbreviate-file-name (file-truename filename))))
1732 (or (let ((buf (get-file-buffer filename)))
1733 (when (and buf (funcall predicate buf)) buf))
1734 (let ((list (buffer-list)) found)
1735 (while (and (not found) list)
1736 (with-current-buffer (car list)
1737 (if (and buffer-file-name
1738 (string= buffer-file-truename truename)
1739 (funcall predicate (current-buffer)))
1740 (setq found (car list))))
1741 (setq list (cdr list)))
1743 (let* ((attributes (file-attributes truename))
1744 (number (nthcdr 10 attributes))
1745 (list (buffer-list)) found)
1746 (and buffer-file-numbers-unique
1747 (car-safe number) ;Make sure the inode is not just nil.
1748 (while (and (not found) list)
1749 (with-current-buffer (car list)
1750 (if (and buffer-file-name
1751 (equal buffer-file-number number)
1752 ;; Verify this buffer's file number
1753 ;; still belongs to its file.
1754 (file-exists-p buffer-file-name)
1755 (equal (file-attributes buffer-file-truename)
1757 (funcall predicate (current-buffer)))
1758 (setq found (car list))))
1759 (setq list (cdr list))))
1762 (defcustom find-file-wildcards t
1763 "Non-nil means file-visiting commands should handle wildcards.
1764 For example, if you specify `*.c', that would visit all the files
1765 whose names match the pattern."
1770 (defcustom find-file-suppress-same-file-warnings nil
1771 "Non-nil means suppress warning messages for symlinked files.
1772 When nil, Emacs prints a warning when visiting a file that is already
1773 visited, but with a different name. Setting this option to t
1774 suppresses this warning."
1779 (defcustom large-file-warning-threshold 10000000
1780 "Maximum size of file above which a confirmation is requested.
1781 When nil, never request confirmation."
1785 :type '(choice integer (const :tag "Never request confirmation" nil)))
1787 (defun abort-if-file-too-large (size op-type filename)
1788 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1789 OP-TYPE specifies the file operation being performed (for message to user)."
1790 (when (and large-file-warning-threshold size
1791 (> size large-file-warning-threshold)
1792 (not (y-or-n-p (format "File %s is large (%s), really %s? "
1793 (file-name-nondirectory filename)
1794 (file-size-human-readable size) op-type))))
1797 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1798 "Read file FILENAME into a buffer and return the buffer.
1799 If a buffer exists visiting FILENAME, return that one, but
1800 verify that the file has not changed since visited or saved.
1801 The buffer is not selected, just returned to the caller.
1802 Optional second arg NOWARN non-nil means suppress any warning messages.
1803 Optional third arg RAWFILE non-nil means the file is read literally.
1804 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1805 and visit all the matching files. When wildcards are actually
1806 used and expanded, return a list of buffers that are visiting
1809 (abbreviate-file-name
1810 (expand-file-name filename)))
1811 (if (file-directory-p filename)
1812 (or (and find-file-run-dired
1813 (run-hook-with-args-until-success
1814 'find-directory-functions
1815 (if find-file-visit-truename
1816 (abbreviate-file-name (file-truename filename))
1818 (error "%s is a directory" filename))
1821 (not (string-match "\\`/:" filename))
1822 (string-match "[[*?]" filename))
1823 (let ((files (condition-case nil
1824 (file-expand-wildcards filename t)
1825 (error (list filename))))
1826 (find-file-wildcards nil))
1828 (find-file-noselect filename)
1829 (mapcar #'find-file-noselect files)))
1830 (let* ((buf (get-file-buffer filename))
1831 (truename (abbreviate-file-name (file-truename filename)))
1832 (attributes (file-attributes truename))
1833 (number (nthcdr 10 attributes))
1834 ;; Find any buffer for a file which has same truename.
1835 (other (and (not buf) (find-buffer-visiting filename))))
1836 ;; Let user know if there is a buffer with the same truename.
1840 find-file-suppress-same-file-warnings
1841 (string-equal filename (buffer-file-name other))
1842 (message "%s and %s are the same file"
1843 filename (buffer-file-name other)))
1844 ;; Optionally also find that buffer.
1845 (if (or find-file-existing-other-name find-file-visit-truename)
1847 ;; Check to see if the file looks uncommonly large.
1848 (when (not (or buf nowarn))
1849 (abort-if-file-too-large (nth 7 attributes) "open" filename))
1851 ;; We are using an existing buffer.
1854 (verify-visited-file-modtime buf)
1855 (cond ((not (file-exists-p filename))
1856 (setq nonexistent t)
1857 (message "File %s no longer exists!" filename))
1858 ;; Certain files should be reverted automatically
1859 ;; if they have changed on disk and not in the buffer.
1860 ((and (not (buffer-modified-p buf))
1861 (let ((tail revert-without-query)
1864 (if (string-match (car tail) filename)
1866 (setq tail (cdr tail)))
1868 (with-current-buffer buf
1869 (message "Reverting file %s..." filename)
1871 (message "Reverting file %s...done" filename)))
1873 (if (string= (file-name-nondirectory filename)
1876 (if (buffer-modified-p buf)
1877 "File %s changed on disk. Discard your edits? "
1878 "File %s changed on disk. Reread from disk? ")
1879 (file-name-nondirectory filename))
1881 (if (buffer-modified-p buf)
1882 "File %s changed on disk. Discard your edits in %s? "
1883 "File %s changed on disk. Reread from disk into %s? ")
1884 (file-name-nondirectory filename)
1885 (buffer-name buf))))
1886 (with-current-buffer buf
1887 (revert-buffer t t)))))
1888 (with-current-buffer buf
1890 ;; Check if a formerly read-only file has become
1891 ;; writable and vice versa, but if the buffer agrees
1892 ;; with the new state of the file, that is ok too.
1893 (let ((read-only (not (file-writable-p buffer-file-name))))
1894 (unless (or nonexistent
1895 (eq read-only buffer-file-read-only)
1896 (eq read-only buffer-read-only))
1899 (if read-only "read-only" "writable"))
1901 (format "File %s is %s on disk. Make buffer %s, too? "
1903 new-status new-status)))
1904 (y-or-n-p question)))
1905 (setq buffer-read-only read-only)))
1906 (setq buffer-file-read-only read-only))
1908 (unless (or (eq (null rawfile) (null find-file-literally))
1910 ;; It is confusing to ask whether to visit
1911 ;; non-literally if they have the file in
1912 ;; hexl-mode or image-mode.
1913 (memq major-mode '(hexl-mode image-mode)))
1914 (if (buffer-modified-p)
1918 "The file %s is already visited normally,
1919 and you have edited the buffer. Now you have asked to visit it literally,
1920 meaning no coding system handling, format conversion, or local variables.
1921 Emacs can only visit a file in one way at a time.
1923 Do you want to save the file, and visit it literally instead? "
1924 "The file %s is already visited literally,
1925 meaning no coding system handling, format conversion, or local variables.
1926 You have edited the buffer. Now you have asked to visit the file normally,
1927 but Emacs can only visit a file in one way at a time.
1929 Do you want to save the file, and visit it normally instead? ")
1930 (file-name-nondirectory filename)))
1933 (find-file-noselect-1 buf filename nowarn
1934 rawfile truename number))
1939 Do you want to discard your changes, and visit the file literally now? "
1941 Do you want to discard your changes, and visit the file normally now? ")))
1942 (find-file-noselect-1 buf filename nowarn
1943 rawfile truename number)
1944 (error (if rawfile "File already visited non-literally"
1945 "File already visited literally"))))
1949 "The file %s is already visited normally.
1950 You have asked to visit it literally,
1951 meaning no coding system decoding, format conversion, or local variables.
1952 But Emacs can only visit a file in one way at a time.
1954 Do you want to revisit the file literally now? "
1955 "The file %s is already visited literally,
1956 meaning no coding system decoding, format conversion, or local variables.
1957 You have asked to visit it normally,
1958 but Emacs can only visit a file in one way at a time.
1960 Do you want to revisit the file normally now? ")
1961 (file-name-nondirectory filename)))
1962 (find-file-noselect-1 buf filename nowarn
1963 rawfile truename number)
1964 (error (if rawfile "File already visited non-literally"
1965 "File already visited literally"))))))
1966 ;; Return the buffer we are using.
1968 ;; Create a new buffer.
1969 (setq buf (create-file-buffer filename))
1970 ;; find-file-noselect-1 may use a different buffer.
1971 (find-file-noselect-1 buf filename nowarn
1972 rawfile truename number))))))
1974 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1976 (with-current-buffer buf
1977 (kill-local-variable 'find-file-literally)
1978 ;; Needed in case we are re-visiting the file with a different
1979 ;; text representation.
1980 (kill-local-variable 'buffer-file-coding-system)
1981 (kill-local-variable 'cursor-type)
1982 (let ((inhibit-read-only t))
1984 (and (default-value 'enable-multibyte-characters)
1986 (set-buffer-multibyte t))
1989 (let ((inhibit-read-only t))
1990 (insert-file-contents-literally filename t))
1992 (when (and (file-exists-p filename)
1993 (not (file-readable-p filename)))
1995 (signal 'file-error (list "File is not readable"
1997 ;; Unconditionally set error
2000 (let ((inhibit-read-only t))
2001 (insert-file-contents filename t))
2003 (when (and (file-exists-p filename)
2004 (not (file-readable-p filename)))
2006 (signal 'file-error (list "File is not readable"
2008 ;; Run find-file-not-found-functions until one returns non-nil.
2009 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
2010 ;; If they fail too, set error.
2012 ;; Record the file's truename, and maybe use that as visited name.
2013 (if (equal filename buffer-file-name)
2014 (setq buffer-file-truename truename)
2015 (setq buffer-file-truename
2016 (abbreviate-file-name (file-truename buffer-file-name))))
2017 (setq buffer-file-number number)
2018 (if find-file-visit-truename
2019 (setq buffer-file-name (expand-file-name buffer-file-truename)))
2020 ;; Set buffer's default directory to that of the file.
2021 (setq default-directory (file-name-directory buffer-file-name))
2022 ;; Turn off backup files for certain file names. Since
2023 ;; this is a permanent local, the major mode won't eliminate it.
2024 (and backup-enable-predicate
2025 (not (funcall backup-enable-predicate buffer-file-name))
2027 (make-local-variable 'backup-inhibited)
2028 (setq backup-inhibited t)))
2031 (set-buffer-multibyte nil)
2032 (setq buffer-file-coding-system 'no-conversion)
2033 (set-buffer-major-mode buf)
2034 (setq-local find-file-literally t))
2035 (after-find-file error (not nowarn)))
2038 (defun insert-file-contents-literally (filename &optional visit beg end replace)
2039 "Like `insert-file-contents', but only reads in the file literally.
2040 A buffer may be modified in several ways after reading into the buffer,
2041 to Emacs features such as format decoding, character code
2042 conversion, `find-file-hook', automatic uncompression, etc.
2044 This function ensures that none of these modifications will take place."
2045 (let ((format-alist nil)
2046 (after-insert-file-functions nil)
2047 (coding-system-for-read 'no-conversion)
2048 (coding-system-for-write 'no-conversion)
2049 (inhibit-file-name-handlers
2050 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2051 ;; into a file operation instead!
2052 (append '(jka-compr-handler image-file-handler epa-file-handler)
2053 inhibit-file-name-handlers))
2054 (inhibit-file-name-operation 'insert-file-contents))
2055 (insert-file-contents filename visit beg end replace)))
2057 (defun insert-file-1 (filename insert-func)
2058 (if (file-directory-p filename)
2059 (signal 'file-error (list "Opening input file" "file is a directory"
2061 ;; Check whether the file is uncommonly large
2062 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert" filename)
2063 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
2064 #'buffer-modified-p))
2065 (tem (funcall insert-func filename)))
2066 (push-mark (+ (point) (car (cdr tem))))
2068 (message "File %s already visited and modified in buffer %s"
2069 filename (buffer-name buffer)))))
2071 (defun insert-file-literally (filename)
2072 "Insert contents of file FILENAME into buffer after point with no conversion.
2074 This function is meant for the user to run interactively.
2075 Don't call it from programs! Use `insert-file-contents-literally' instead.
2076 \(Its calling sequence is different; see its documentation)."
2077 (declare (interactive-only insert-file-contents-literally))
2078 (interactive "*fInsert file literally: ")
2079 (insert-file-1 filename #'insert-file-contents-literally))
2081 (defvar find-file-literally nil
2082 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2083 This has the `permanent-local' property, which takes effect if you
2084 make the variable buffer-local.")
2085 (put 'find-file-literally 'permanent-local t)
2087 (defun find-file-literally (filename)
2088 "Visit file FILENAME with no conversion of any kind.
2089 Format conversion and character code conversion are both disabled,
2090 and multibyte characters are disabled in the resulting buffer.
2091 The major mode used is Fundamental mode regardless of the file name,
2092 and local variable specifications in the file are ignored.
2093 Automatic uncompression and adding a newline at the end of the
2094 file due to `require-final-newline' is also disabled.
2096 You cannot absolutely rely on this function to result in
2097 visiting the file literally. If Emacs already has a buffer
2098 which is visiting the file, you get the existing buffer,
2099 regardless of whether it was created literally or not.
2101 In a Lisp program, if you want to be sure of accessing a file's
2102 contents literally, you should create a temporary buffer and then read
2103 the file contents into it using `insert-file-contents-literally'."
2105 (list (read-file-name
2106 "Find file literally: " nil default-directory
2107 (confirm-nonexistent-file-or-buffer))))
2108 (switch-to-buffer (find-file-noselect filename nil t)))
2110 (defun after-find-file (&optional error warn noauto
2111 _after-find-file-from-revert-buffer
2113 "Called after finding a file and by the default revert function.
2114 Sets buffer mode, parses local variables.
2115 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2116 error in reading the file. WARN non-nil means warn if there
2117 exists an auto-save file more recent than the visited file.
2118 NOAUTO means don't mess with auto-save mode.
2119 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2120 \(see `revert-buffer-in-progress-p' for similar functionality).
2121 Fifth arg NOMODES non-nil means don't alter the file's modes.
2122 Finishes by calling the functions in `find-file-hook'
2123 unless NOMODES is non-nil."
2124 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
2131 ((and error (file-attributes buffer-file-name))
2132 (setq buffer-read-only t)
2133 (if (and (file-symlink-p buffer-file-name)
2135 (file-chase-links buffer-file-name))))
2136 "Symbolic link that points to nonexistent file"
2137 "File exists, but cannot be read"))
2138 ((not buffer-read-only)
2140 ;; No need to warn if buffer is auto-saved
2141 ;; under the name of the visited file.
2142 (not (and buffer-file-name
2143 auto-save-visited-file-name))
2144 (file-newer-than-file-p (or buffer-auto-save-file-name
2145 (make-auto-save-file-name))
2147 (format "%s has auto save data; consider M-x recover-this-file"
2148 (file-name-nondirectory buffer-file-name))
2149 (setq not-serious t)
2150 (if error "(New file)" nil)))
2152 (setq not-serious t)
2153 "Note: file is write protected")
2154 ((file-attributes (directory-file-name default-directory))
2155 "File not found and directory write-protected")
2156 ((file-exists-p (file-name-directory buffer-file-name))
2157 (setq buffer-read-only nil))
2159 (setq buffer-read-only nil)
2160 "Use M-x make-directory RET RET to create the directory and its parents"))))
2163 (or not-serious (sit-for 1 t))))
2164 (when (and auto-save-default (not noauto))
2165 (auto-save-mode 1)))
2166 ;; Make people do a little extra work (C-x C-q)
2167 ;; before altering a backup file.
2168 (when (backup-file-name-p buffer-file-name)
2169 (setq buffer-read-only t))
2170 ;; When a file is marked read-only,
2171 ;; make the buffer read-only even if root is looking at it.
2172 (when (and (file-modes (buffer-file-name))
2173 (zerop (logand (file-modes (buffer-file-name)) #o222)))
2174 (setq buffer-read-only t))
2176 (when (and view-read-only view-mode)
2179 ;; If requested, add a newline at the end of the file.
2180 (and (memq require-final-newline '(visit visit-save))
2181 (> (point-max) (point-min))
2182 (/= (char-after (1- (point-max))) ?\n)
2183 (not (and (eq selective-display t)
2184 (= (char-after (1- (point-max))) ?\r)))
2185 (not buffer-read-only)
2187 (goto-char (point-max))
2188 (ignore-errors (insert "\n"))))
2189 (when (and buffer-read-only
2191 (not (eq (get major-mode 'mode-class) 'special)))
2193 (run-hooks 'find-file-hook)))
2195 (defmacro report-errors (format &rest body)
2196 "Eval BODY and turn any error into a FORMAT message.
2197 FORMAT can have a %s escape which will be replaced with the actual error.
2198 If `debug-on-error' is set, errors are not caught, so that you can
2200 Avoid using a large BODY since it is duplicated."
2201 (declare (debug t) (indent 1))
2206 (error (message ,format (prin1-to-string err))))))
2208 (defun normal-mode (&optional find-file)
2209 "Choose the major mode for this buffer automatically.
2210 Also sets up any specified local variables of the file.
2211 Uses the visited file name, the -*- line, and the local variables spec.
2213 This function is called automatically from `find-file'. In that case,
2214 we may set up the file-specified mode and local variables,
2215 depending on the value of `enable-local-variables'.
2216 In addition, if `local-enable-local-variables' is nil, we do
2217 not set local variables (though we do notice a mode specified with -*-.)
2219 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2220 or from Lisp without specifying the optional argument FIND-FILE;
2221 in that case, this function acts as if `enable-local-variables' were t."
2224 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
2225 ;; FIXME this is less efficient than it could be, since both
2226 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2227 (report-errors "File mode specification error: %s"
2229 (report-errors "File local-variables error: %s"
2230 (hack-local-variables)))
2231 ;; Turn font lock off and on, to make sure it takes account of
2232 ;; whatever file local variables are relevant to it.
2233 (when (and font-lock-mode
2234 ;; Font-lock-mode (now in font-core.el) can be ON when
2235 ;; font-lock.el still hasn't been loaded.
2236 (boundp 'font-lock-keywords)
2237 (eq (car font-lock-keywords) t))
2238 (setq font-lock-keywords (cadr font-lock-keywords))
2239 (font-lock-mode 1)))
2241 (defcustom auto-mode-case-fold t
2242 "Non-nil means to try second pass through `auto-mode-alist'.
2243 This means that if the first case-sensitive search through the alist fails
2244 to find a matching major mode, a second case-insensitive search is made.
2245 On systems with case-insensitive file names, this variable is ignored,
2246 since only a single case-insensitive search through the alist is made."
2251 (defvar auto-mode-alist
2252 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2253 ;; c++-mode, java-mode and more) are added through autoload
2254 ;; directives in that file. That way is discouraged since it
2255 ;; spreads out the definition of the initial value.
2258 (cons (purecopy (car elt)) (cdr elt)))
2259 `(;; do this first, so that .html.pl is Polish html, not Perl
2260 ("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
2261 ("\\.svgz?\\'" . image-mode)
2262 ("\\.svgz?\\'" . xml-mode)
2263 ("\\.x[bp]m\\'" . image-mode)
2264 ("\\.x[bp]m\\'" . c-mode)
2265 ("\\.p[bpgn]m\\'" . image-mode)
2266 ("\\.tiff?\\'" . image-mode)
2267 ("\\.gif\\'" . image-mode)
2268 ("\\.png\\'" . image-mode)
2269 ("\\.jpe?g\\'" . image-mode)
2270 ("\\.te?xt\\'" . text-mode)
2271 ("\\.[tT]e[xX]\\'" . tex-mode)
2272 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
2273 ("\\.ltx\\'" . latex-mode)
2274 ("\\.dtx\\'" . doctex-mode)
2275 ("\\.org\\'" . org-mode)
2276 ("\\.el\\'" . emacs-lisp-mode)
2277 ("Project\\.ede\\'" . emacs-lisp-mode)
2278 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
2279 ("\\.l\\'" . lisp-mode)
2280 ("\\.li?sp\\'" . lisp-mode)
2281 ("\\.[fF]\\'" . fortran-mode)
2282 ("\\.for\\'" . fortran-mode)
2283 ("\\.p\\'" . pascal-mode)
2284 ("\\.pas\\'" . pascal-mode)
2285 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode)
2286 ("\\.ad[abs]\\'" . ada-mode)
2287 ("\\.ad[bs].dg\\'" . ada-mode)
2288 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
2289 ("Imakefile\\'" . makefile-imake-mode)
2290 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2291 ("\\.makepp\\'" . makefile-makepp-mode)
2292 ,@(if (memq system-type '(berkeley-unix darwin))
2293 '(("\\.mk\\'" . makefile-bsdmake-mode)
2294 ("\\.make\\'" . makefile-bsdmake-mode)
2295 ("GNUmakefile\\'" . makefile-gmake-mode)
2296 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2297 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
2298 ("\\.make\\'" . makefile-gmake-mode)
2299 ("[Mm]akefile\\'" . makefile-gmake-mode)))
2300 ("\\.am\\'" . makefile-automake-mode)
2301 ;; Less common extensions come here
2302 ;; so more common ones above are found faster.
2303 ("\\.texinfo\\'" . texinfo-mode)
2304 ("\\.te?xi\\'" . texinfo-mode)
2305 ("\\.[sS]\\'" . asm-mode)
2306 ("\\.asm\\'" . asm-mode)
2307 ("\\.css\\'" . css-mode)
2308 ("\\.mixal\\'" . mixal-mode)
2309 ("\\.gcov\\'" . compilation-mode)
2310 ;; Besides .gdbinit, gdb documents other names to be usable for init
2311 ;; files, cross-debuggers can use something like
2312 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2313 ;; don't interfere with each other.
2314 ("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode)
2315 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2316 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2317 ;; loaded when GDB reads an objfile called 'emacs'.
2318 ("-gdb\\.gdb" . gdb-script-mode)
2319 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2320 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2321 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2322 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2323 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2324 ("\\.bash\\'" . sh-mode)
2325 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2326 ("\\(/\\|\\`\\)\\.\\(shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2327 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2328 ("\\.m?spec\\'" . sh-mode)
2329 ("\\.m[mes]\\'" . nroff-mode)
2330 ("\\.man\\'" . nroff-mode)
2331 ("\\.sty\\'" . latex-mode)
2332 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2333 ("\\.bbl\\'" . latex-mode)
2334 ("\\.bib\\'" . bibtex-mode)
2335 ("\\.bst\\'" . bibtex-style-mode)
2336 ("\\.sql\\'" . sql-mode)
2337 ("\\.m[4c]\\'" . m4-mode)
2338 ("\\.mf\\'" . metafont-mode)
2339 ("\\.mp\\'" . metapost-mode)
2340 ("\\.vhdl?\\'" . vhdl-mode)
2341 ("\\.article\\'" . text-mode)
2342 ("\\.letter\\'" . text-mode)
2343 ("\\.i?tcl\\'" . tcl-mode)
2344 ("\\.exp\\'" . tcl-mode)
2345 ("\\.itk\\'" . tcl-mode)
2346 ("\\.icn\\'" . icon-mode)
2347 ("\\.sim\\'" . simula-mode)
2348 ("\\.mss\\'" . scribe-mode)
2349 ;; The Fortran standard does not say anything about file extensions.
2350 ;; .f90 was widely used for F90, now we seem to be trapped into
2351 ;; using a different extension for each language revision.
2352 ;; Anyway, the following extensions are supported by gfortran.
2353 ("\\.f9[05]\\'" . f90-mode)
2354 ("\\.f0[38]\\'" . f90-mode)
2355 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2356 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
2357 ("\\.srt\\'" . srecode-template-mode)
2358 ("\\.prolog\\'" . prolog-mode)
2359 ("\\.tar\\'" . tar-mode)
2360 ;; The list of archive file extensions should be in sync with
2361 ;; `auto-coding-alist' with `no-conversion' coding system.
2363 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\
2364 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode)
2365 ("\\.oxt\\'" . archive-mode) ;(Open|Libre)Office extensions.
2366 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages.
2367 ;; Mailer puts message to be edited in
2368 ;; /tmp/Re.... or Message
2369 ("\\`/tmp/Re" . text-mode)
2370 ("/Message[0-9]*\\'" . text-mode)
2371 ;; some news reader is reported to use this
2372 ("\\`/tmp/fol/" . text-mode)
2373 ("\\.oak\\'" . scheme-mode)
2374 ("\\.sgml?\\'" . sgml-mode)
2375 ("\\.x[ms]l\\'" . xml-mode)
2376 ("\\.dbk\\'" . xml-mode)
2377 ("\\.dtd\\'" . sgml-mode)
2378 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2379 ("\\.js\\'" . javascript-mode)
2380 ("\\.json\\'" . javascript-mode)
2381 ("\\.[ds]?vh?\\'" . verilog-mode)
2382 ("\\.by\\'" . bovine-grammar-mode)
2383 ("\\.wy\\'" . wisent-grammar-mode)
2384 ;; .emacs or .gnus or .viper following a directory delimiter in
2385 ;; Unix, MSDOG or VMS syntax.
2386 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2387 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2388 ;; _emacs following a directory delimiter
2390 ("[:/]_emacs\\'" . emacs-lisp-mode)
2391 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2392 ("\\.ml\\'" . lisp-mode)
2393 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2394 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2395 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2396 ("\\.ld[si]?\\'" . ld-script-mode)
2397 ("ld\\.?script\\'" . ld-script-mode)
2398 ;; .xs is also used for ld scripts, but seems to be more commonly
2399 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2400 ("\\.xs\\'" . c-mode)
2401 ;; Explained in binutils ld/genscripts.sh. Eg:
2402 ;; A .x script file is the default script.
2403 ;; A .xr script is for linking without relocation (-r flag). Etc.
2404 ("\\.x[abdsru]?[cnw]?\\'" . ld-script-mode)
2405 ("\\.zone\\'" . dns-mode)
2406 ("\\.soa\\'" . dns-mode)
2407 ;; Common Lisp ASDF package system.
2408 ("\\.asd\\'" . lisp-mode)
2409 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2410 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2411 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2412 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2413 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2414 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2415 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2416 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
2417 ("BROWSE\\'" . ebrowse-tree-mode)
2418 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2419 ("#\\*mail\\*" . mail-mode)
2420 ("\\.g\\'" . antlr-mode)
2421 ("\\.mod\\'" . m2-mode)
2422 ("\\.ses\\'" . ses-mode)
2423 ("\\.docbook\\'" . sgml-mode)
2424 ("\\.com\\'" . dcl-mode)
2425 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2426 ;; Windows candidates may be opened case sensitively on Unix
2427 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2428 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2429 ("\\.ppd\\'" . conf-ppd-mode)
2430 ("java.+\\.conf\\'" . conf-javaprop-mode)
2431 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2432 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2433 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2434 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2435 ;; this has lower priority to avoid matching changelog.sgml etc.
2436 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2437 ;; either user's dot-files or under /etc or some such
2438 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2439 ;; alas not all ~/.*rc files are like this
2440 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2441 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2442 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2443 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2444 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2445 ;; this contains everything twice, with space and with colon :-(
2446 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2447 ;; Get rid of any trailing .n.m and try again.
2448 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2449 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2450 ;; Using mode nil rather than `ignore' would let the search continue
2451 ;; through this list (with the shortened name) rather than start over.
2452 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2453 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)
2454 ;; This should come after "in" stripping (e.g. config.h.in).
2455 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2456 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
2457 ;; The following should come after the ChangeLog pattern
2458 ;; for the sake of ChangeLog.1, etc.
2459 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2460 ("\\.[1-9]\\'" . nroff-mode)))
2461 "Alist of filename patterns vs corresponding major mode functions.
2462 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2463 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2464 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2465 mode function to use. FUNCTION will be called, unless it is nil.
2467 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2468 calling FUNCTION (if it's not nil), we delete the suffix that matched
2469 REGEXP and search the list again for another match.
2471 The extensions whose FUNCTION is `archive-mode' should also
2472 appear in `auto-coding-alist' with `no-conversion' coding system.
2474 See also `interpreter-mode-alist', which detects executable script modes
2475 based on the interpreters they specify to run,
2476 and `magic-mode-alist', which determines modes based on file contents.")
2477 (put 'auto-mode-alist 'risky-local-variable t)
2479 (defun conf-mode-maybe ()
2480 "Select Conf mode or XML mode according to start of file."
2484 (goto-char (point-min))
2485 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2489 (defvar interpreter-mode-alist
2490 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2491 ;; and pike-mode) are added through autoload directives in that
2492 ;; file. That way is discouraged since it spreads out the
2493 ;; definition of the initial value.
2496 (cons (purecopy (car l)) (cdr l)))
2497 '(("\\(mini\\)?perl5?" . perl-mode)
2498 ("wishx?" . tcl-mode)
2499 ("tcl\\(sh\\)?" . tcl-mode)
2500 ("expect" . tcl-mode)
2501 ("octave" . octave-mode)
2502 ("scm" . scheme-mode)
2503 ("[acjkwz]sh" . sh-mode)
2504 ("r?bash2?" . sh-mode)
2507 ("\\(dt\\|pd\\|w\\)ksh" . sh-mode)
2509 ("i?tcsh" . sh-mode)
2514 ("tail" . text-mode)
2515 ("more" . text-mode)
2516 ("less" . text-mode)
2518 ("make" . makefile-gmake-mode) ; Debian uses this
2519 ("guile" . scheme-mode)
2520 ("clisp" . lisp-mode)
2521 ("emacs" . emacs-lisp-mode)))
2522 "Alist mapping interpreter names to major modes.
2523 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2524 Each element looks like (REGEXP . MODE).
2525 If \\\\`REGEXP\\\\' matches the name (minus any directory part) of
2526 the interpreter specified in the first line of a script, enable
2529 See also `auto-mode-alist'.")
2531 (define-obsolete-variable-alias 'inhibit-first-line-modes-regexps
2532 'inhibit-file-local-variables-regexps "24.1")
2534 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2535 ;; because we are duplicating info from auto-mode-alist.
2536 ;; TODO many elements of this list are also in auto-coding-alist.
2537 (defvar inhibit-local-variables-regexps
2538 (mapcar 'purecopy '("\\.tar\\'" "\\.t[bg]z\\'"
2539 "\\.arc\\'" "\\.zip\\'" "\\.lzh\\'" "\\.lha\\'"
2540 "\\.zoo\\'" "\\.[jew]ar\\'" "\\.xpi\\'" "\\.rar\\'"
2542 "\\.sx[dmicw]\\'" "\\.odt\\'"
2543 "\\.diff\\'" "\\.patch\\'"
2544 "\\.tiff?\\'" "\\.gif\\'" "\\.png\\'" "\\.jpe?g\\'"))
2545 "List of regexps matching file names in which to ignore local variables.
2546 This includes `-*-' lines as well as trailing \"Local Variables\" sections.
2547 Files matching this list are typically binary file formats.
2548 They may happen to contain sequences that look like local variable
2549 specifications, but are not really, or they may be containers for
2550 member files with their own local variable sections, which are
2551 not appropriate for the containing file.
2552 The function `inhibit-local-variables-p' uses this.")
2554 (define-obsolete-variable-alias 'inhibit-first-line-modes-suffixes
2555 'inhibit-local-variables-suffixes "24.1")
2557 (defvar inhibit-local-variables-suffixes nil
2558 "List of regexps matching suffixes to remove from file names.
2559 The function `inhibit-local-variables-p' uses this: when checking
2560 a file name, it first discards from the end of the name anything that
2561 matches one of these regexps.")
2563 ;; Can't think of any situation in which you'd want this to be nil...
2564 (defvar inhibit-local-variables-ignore-case t
2565 "Non-nil means `inhibit-local-variables-p' ignores case.")
2567 (defun inhibit-local-variables-p ()
2568 "Return non-nil if file local variables should be ignored.
2569 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2570 and `inhibit-local-variables-suffixes'. If
2571 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2572 (let ((temp inhibit-local-variables-regexps)
2573 (name (if buffer-file-name
2574 (file-name-sans-versions buffer-file-name)
2576 (case-fold-search inhibit-local-variables-ignore-case))
2577 (while (let ((sufs inhibit-local-variables-suffixes))
2578 (while (and sufs (not (string-match (car sufs) name)))
2579 (setq sufs (cdr sufs)))
2581 (setq name (substring name 0 (match-beginning 0))))
2583 (not (string-match (car temp) name)))
2584 (setq temp (cdr temp)))
2587 (defvar auto-mode-interpreter-regexp
2588 (purecopy "#![ \t]?\\([^ \t\n]*\
2589 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2590 "Regexp matching interpreters, for file mode determination.
2591 This regular expression is matched against the first line of a file
2592 to determine the file's mode in `set-auto-mode'. If it matches, the file
2593 is assumed to be interpreted by the interpreter matched by the second group
2594 of the regular expression. The mode is then determined as the mode
2595 associated with that interpreter in `interpreter-mode-alist'.")
2597 (defvar magic-mode-alist nil
2598 "Alist of buffer beginnings vs. corresponding major mode functions.
2599 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2600 After visiting a file, if REGEXP matches the text at the beginning of the
2601 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2602 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2605 If FUNCTION is nil, then it is not called. (That is a way of saying
2606 \"allow `auto-mode-alist' to decide for these files.\")")
2607 (put 'magic-mode-alist 'risky-local-variable t)
2609 (defvar magic-fallback-mode-alist
2611 `((image-type-auto-detected-p . image-mode)
2612 ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip
2613 ;; The < comes before the groups (but the first) to reduce backtracking.
2614 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2615 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2616 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2617 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2618 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2620 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2621 "[Hh][Tt][Mm][Ll]"))
2623 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2624 ;; These two must come after html, because they are more general:
2625 ("<\\?xml " . xml-mode)
2626 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2627 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2628 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2631 ("# xmcd " . conf-unix-mode)))
2632 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2633 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2634 After visiting a file, if REGEXP matches the text at the beginning of the
2635 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2636 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2637 have not specified a mode for this file.
2639 If FUNCTION is nil, then it is not called.")
2640 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2642 (defvar magic-mode-regexp-match-limit 4000
2643 "Upper limit on `magic-mode-alist' regexp matches.
2644 Also applies to `magic-fallback-mode-alist'.")
2646 (defun set-auto-mode (&optional keep-mode-if-same)
2647 "Select major mode appropriate for current buffer.
2649 To find the right major mode, this function checks for a -*- mode tag
2650 checks for a `mode:' entry in the Local Variables section of the file,
2651 checks if it uses an interpreter listed in `interpreter-mode-alist',
2652 matches the buffer beginning against `magic-mode-alist',
2653 compares the filename against the entries in `auto-mode-alist',
2654 then matches the buffer beginning against `magic-fallback-mode-alist'.
2656 If `enable-local-variables' is nil, or if the file name matches
2657 `inhibit-local-variables-regexps', this function does not check
2658 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2659 is nil, then the only mode: tag that can be relevant is a -*- one.
2661 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2662 set the major mode only if that would change it. In other words
2663 we don't actually set it to the same mode the buffer already has."
2664 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2665 (let ((try-locals (not (inhibit-local-variables-p)))
2666 end done mode modes)
2667 ;; Once we drop the deprecated feature where mode: is also allowed to
2668 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2669 ;; remove this section and just let (hack-local-variables t) handle it.
2670 ;; Find a -*- mode tag.
2672 (goto-char (point-min))
2673 (skip-chars-forward " \t\n")
2674 ;; Note by design local-enable-local-variables does not matter here.
2675 (and enable-local-variables
2677 (setq end (set-auto-mode-1))
2678 (if (save-excursion (search-forward ":" end t))
2679 ;; Find all specifications for the `mode:' variable
2680 ;; and execute them left to right.
2681 (while (let ((case-fold-search t))
2682 (or (and (looking-at "mode:")
2683 (goto-char (match-end 0)))
2684 (re-search-forward "[ \t;]mode:" end t)))
2685 (skip-chars-forward " \t")
2686 (let ((beg (point)))
2687 (if (search-forward ";" end t)
2690 (skip-chars-backward " \t")
2691 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2693 ;; Simple -*-MODE-*- case.
2694 (push (intern (concat (downcase (buffer-substring (point) end))
2697 ;; If we found modes to use, invoke them now, outside the save-excursion.
2700 (dolist (mode (nreverse modes))
2701 (if (not (functionp mode))
2702 (message "Ignoring unknown mode `%s'" mode)
2704 (or (set-auto-mode-0 mode keep-mode-if-same)
2705 ;; continuing would call minor modes again, toggling them off
2706 (throw 'nop nil))))))
2707 ;; hack-local-variables checks local-enable-local-variables etc, but
2708 ;; we might as well be explicit here for the sake of clarity.
2710 enable-local-variables
2711 local-enable-local-variables
2713 (setq mode (hack-local-variables t))
2714 (not (memq mode modes)) ; already tried and failed
2715 (if (not (functionp mode))
2716 (message "Ignoring unknown mode `%s'" mode)
2718 (set-auto-mode-0 mode keep-mode-if-same)))
2719 ;; If we didn't, look for an interpreter specified in the first line.
2720 ;; As a special case, allow for things like "#!/bin/env perl", which
2721 ;; finds the interpreter anywhere in $PATH.
2723 (setq mode (save-excursion
2724 (goto-char (point-min))
2725 (if (looking-at auto-mode-interpreter-regexp)
2727 ;; Map interpreter name to a mode, signaling we're done at the
2729 (setq done (assoc-default
2730 (file-name-nondirectory mode)
2733 (format "\\`%s\\'" (car e))
2735 interpreter-mode-alist)
2737 ;; If we found an interpreter mode to use, invoke it now.
2738 (set-auto-mode-0 done keep-mode-if-same))
2739 ;; Next try matching the buffer beginning against magic-mode-alist.
2741 (if (setq done (save-excursion
2742 (goto-char (point-min))
2744 (narrow-to-region (point-min)
2746 (+ (point-min) magic-mode-regexp-match-limit)))
2747 (assoc-default nil magic-mode-alist
2751 (looking-at re)))))))
2752 (set-auto-mode-0 done keep-mode-if-same)))
2753 ;; Next compare the filename against the entries in auto-mode-alist.
2755 (if buffer-file-name
2756 (let ((name buffer-file-name)
2757 (remote-id (file-remote-p buffer-file-name)))
2758 ;; Remove backup-suffixes from file name.
2759 (setq name (file-name-sans-versions name))
2760 ;; Remove remote file name identification.
2761 (when (and (stringp remote-id)
2762 (string-match (regexp-quote remote-id) name))
2763 (setq name (substring name (match-end 0))))
2765 ;; Find first matching alist entry.
2767 (if (memq system-type '(windows-nt cygwin))
2768 ;; System is case-insensitive.
2769 (let ((case-fold-search t))
2770 (assoc-default name auto-mode-alist
2772 ;; System is case-sensitive.
2774 ;; First match case-sensitively.
2775 (let ((case-fold-search nil))
2776 (assoc-default name auto-mode-alist
2778 ;; Fallback to case-insensitive match.
2779 (and auto-mode-case-fold
2780 (let ((case-fold-search t))
2781 (assoc-default name auto-mode-alist
2786 (setq mode (car mode)
2787 name (substring name 0 (match-beginning 0)))
2790 (set-auto-mode-0 mode keep-mode-if-same)
2792 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2794 (if (setq done (save-excursion
2795 (goto-char (point-min))
2797 (narrow-to-region (point-min)
2799 (+ (point-min) magic-mode-regexp-match-limit)))
2800 (assoc-default nil magic-fallback-mode-alist
2804 (looking-at re)))))))
2805 (set-auto-mode-0 done keep-mode-if-same)))
2807 (set-buffer-major-mode (current-buffer)))))
2809 ;; When `keep-mode-if-same' is set, we are working on behalf of
2810 ;; set-visited-file-name. In that case, if the major mode specified is the
2811 ;; same one we already have, don't actually reset it. We don't want to lose
2812 ;; minor modes such as Font Lock.
2813 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2814 "Apply MODE and return it.
2815 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2816 any aliases and compared to current major mode. If they are the
2817 same, do nothing and return nil."
2818 (unless (and keep-mode-if-same
2819 (eq (indirect-function mode)
2820 (indirect-function major-mode)))
2825 (defvar file-auto-mode-skip "^\\(#!\\|'\\\\\"\\)"
2826 "Regexp of lines to skip when looking for file-local settings.
2827 If the first line matches this regular expression, then the -*-...-*- file-
2828 local settings will be consulted on the second line instead of the first.")
2830 (defun set-auto-mode-1 ()
2831 "Find the -*- spec in the buffer.
2832 Call with point at the place to start searching from.
2833 If one is found, set point to the beginning and return the position
2834 of the end. Otherwise, return nil; may change point.
2835 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2836 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2840 ;; Don't look for -*- if this file name matches any
2841 ;; of the regexps in inhibit-local-variables-regexps.
2842 (not (inhibit-local-variables-p))
2843 (search-forward "-*-" (line-end-position
2844 ;; If the file begins with "#!" (exec
2845 ;; interpreter magic), look for mode frobs
2846 ;; in the first two lines. You cannot
2847 ;; necessarily put them in the first line
2848 ;; of such a file without screwing up the
2849 ;; interpreter invocation. The same holds
2850 ;; for '\" in man pages (preprocessor
2851 ;; magic for the `man' program).
2852 (and (looking-at file-auto-mode-skip) 2)) t)
2854 (skip-chars-forward " \t")
2856 (search-forward "-*-" (line-end-position) t))
2859 (skip-chars-backward " \t")
2864 ;;; Handling file local variables
2866 (defvar ignored-local-variables
2867 '(ignored-local-variables safe-local-variable-values
2868 file-local-variables-alist dir-local-variables-alist)
2869 "Variables to be ignored in a file's local variable spec.")
2870 (put 'ignored-local-variables 'risky-local-variable t)
2872 (defvar hack-local-variables-hook nil
2873 "Normal hook run after processing a file's local variables specs.
2874 Major modes can use this to examine user-specified local variables
2875 in order to initialize other data structure based on them.")
2877 (defcustom safe-local-variable-values nil
2878 "List variable-value pairs that are considered safe.
2879 Each element is a cons cell (VAR . VAL), where VAR is a variable
2880 symbol and VAL is a value that is considered safe."
2885 (defcustom safe-local-eval-forms
2886 ;; This should be here at least as long as Emacs supports write-file-hooks.
2887 '((add-hook 'write-file-hooks 'time-stamp)
2888 (add-hook 'write-file-functions 'time-stamp)
2889 (add-hook 'before-save-hook 'time-stamp nil t)
2890 (add-hook 'before-save-hook 'delete-trailing-whitespace nil t))
2891 "Expressions that are considered safe in an `eval:' local variable.
2892 Add expressions to this list if you want Emacs to evaluate them, when
2893 they appear in an `eval' local variable specification, without first
2894 asking you for confirmation."
2897 :version "24.1" ; added write-file-hooks
2898 :type '(repeat sexp))
2900 ;; Risky local variables:
2901 (mapc (lambda (var) (put var 'risky-local-variable t))
2903 buffer-auto-save-file-name
2905 buffer-file-truename
2908 default-text-properties
2912 file-name-handler-alist
2921 minor-mode-map-alist
2922 minor-mode-overriding-map-alist
2925 overriding-local-map
2926 overriding-terminal-local-map
2930 unread-command-events))
2932 ;; Safe local variables:
2934 ;; For variables defined by major modes, the safety declarations can go into
2935 ;; the major mode's file, since that will be loaded before file variables are
2938 ;; For variables defined by minor modes, put the safety declarations in the
2939 ;; file defining the minor mode after the defcustom/defvar using an autoload
2942 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2944 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2945 ;; minor mode file may not be loaded yet.
2947 ;; For variables defined in the C source code the declaration should go here:
2950 '((buffer-read-only . booleanp) ;; C source code
2951 (default-directory . stringp) ;; C source code
2952 (fill-column . integerp) ;; C source code
2953 (indent-tabs-mode . booleanp) ;; C source code
2954 (left-margin . integerp) ;; C source code
2955 (no-update-autoloads . booleanp)
2956 (lexical-binding . booleanp) ;; C source code
2957 (tab-width . integerp) ;; C source code
2958 (truncate-lines . booleanp) ;; C source code
2959 (word-wrap . booleanp) ;; C source code
2960 (bidi-display-reordering . booleanp))) ;; C source code
2961 (put (car pair) 'safe-local-variable (cdr pair)))
2963 (put 'bidi-paragraph-direction 'safe-local-variable
2964 (lambda (v) (memq v '(nil right-to-left left-to-right))))
2966 (put 'c-set-style 'safe-local-eval-function t)
2968 (defvar file-local-variables-alist nil
2969 "Alist of file-local variable settings in the current buffer.
2970 Each element in this list has the form (VAR . VALUE), where VAR
2971 is a file-local variable (a symbol) and VALUE is the value
2972 specified. The actual value in the buffer may differ from VALUE,
2973 if it is changed by the major or minor modes, or by the user.")
2974 (make-variable-buffer-local 'file-local-variables-alist)
2975 (put 'file-local-variables-alist 'permanent-local t)
2977 (defvar dir-local-variables-alist nil
2978 "Alist of directory-local variable settings in the current buffer.
2979 Each element in this list has the form (VAR . VALUE), where VAR
2980 is a directory-local variable (a symbol) and VALUE is the value
2981 specified in .dir-locals.el. The actual value in the buffer
2982 may differ from VALUE, if it is changed by the major or minor modes,
2984 (make-variable-buffer-local 'dir-local-variables-alist)
2986 (defvar before-hack-local-variables-hook nil
2987 "Normal hook run before setting file-local variables.
2988 It is called after checking for unsafe/risky variables and
2989 setting `file-local-variables-alist', and before applying the
2990 variables stored in `file-local-variables-alist'. A hook
2991 function is allowed to change the contents of this alist.
2993 This hook is called only if there is at least one file-local
2996 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name)
2997 "Get confirmation before setting up local variable values.
2998 ALL-VARS is the list of all variables to be set up.
2999 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3000 RISKY-VARS is the list of those that are marked as risky.
3001 If these settings come from directory-local variables, then
3002 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3003 (unless noninteractive
3004 (let ((name (cond (dir-name)
3006 (file-name-nondirectory buffer-file-name))
3007 ((concat "buffer " (buffer-name)))))
3008 (offer-save (and (eq enable-local-variables t)
3010 (buf (get-buffer-create "*Local Variables*")))
3011 ;; Set up the contents of the *Local Variables* buffer.
3012 (with-current-buffer buf
3016 (insert "The local variables list in " name
3017 "\ncontains values that may not be safe (*)"
3019 ", and variables that are risky (**)."
3022 (insert "The local variables list in " name
3023 "\ncontains variables that are risky (**)."))
3025 (insert "A local variables list is specified in " name ".")))
3026 (insert "\n\nDo you want to apply it? You can type
3027 y -- to apply the local variables list.
3028 n -- to ignore the local variables list.")
3031 ! -- to apply the local variables list, and permanently mark these
3032 values (*) as safe (in the future, they will be set automatically.)\n\n")
3034 (dolist (elt all-vars)
3035 (cond ((member elt unsafe-vars)
3037 ((member elt risky-vars)
3041 (princ (car elt) buf)
3043 ;; Make strings with embedded whitespace easier to read.
3044 (let ((print-escape-newlines t))
3045 (prin1 (cdr elt) buf))
3047 (set (make-local-variable 'cursor-type) nil)
3048 (set-buffer-modified-p nil)
3049 (goto-char (point-min)))
3051 ;; Display the buffer and read a choice.
3052 (save-window-excursion
3054 (let* ((exit-chars '(?y ?n ?\s ?\C-g ?\C-v))
3055 (prompt (format "Please type %s%s: "
3056 (if offer-save "y, n, or !" "y or n")
3057 (if (< (line-number-at-pos (point-max))
3058 (window-body-height))
3060 (push ?\C-v exit-chars)
3061 ", or C-v to scroll")))
3063 (if offer-save (push ?! exit-chars))
3065 (setq char (read-char-choice prompt exit-chars t))
3066 (when (eq char ?\C-v)
3069 (error (goto-char (point-min))
3072 (when (and offer-save (= char ?!) unsafe-vars)
3073 (customize-push-and-save 'safe-local-variable-values unsafe-vars))
3074 (prog1 (memq char '(?! ?\s ?y))
3075 (quit-window t)))))))
3077 (defconst hack-local-variable-regexp
3078 "[ \t]*\\([^][;\"'?()\\ \t\n]+\\)[ \t]*:[ \t]*")
3080 (defun hack-local-variables-prop-line (&optional mode-only)
3081 "Return local variables specified in the -*- line.
3082 Returns an alist of elements (VAR . VAL), where VAR is a variable
3083 and VAL is the specified value. Ignores any specification for
3084 `mode:' and `coding:' (which should have already been handled
3085 by `set-auto-mode' and `set-auto-coding', respectively).
3086 Return nil if the -*- line is malformed.
3088 If MODE-ONLY is non-nil, just returns the symbol specifying the
3089 mode, if there is one, otherwise nil."
3090 (catch 'malformed-line
3092 (goto-char (point-min))
3093 (let ((end (set-auto-mode-1))
3097 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
3098 ;; Simple form: "-*- MODENAME -*-".
3100 (intern (concat (match-string 1) "-mode"))))
3102 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3103 ;; (last ";" is optional).
3104 ;; If MODE-ONLY, just check for `mode'.
3105 ;; Otherwise, parse the -*- line into the RESULT alist.
3106 (while (not (or (and mode-only result)
3108 (unless (looking-at hack-local-variable-regexp)
3109 (message "Malformed mode-line: %S"
3110 (buffer-substring-no-properties (point) end))
3111 (throw 'malformed-line nil))
3112 (goto-char (match-end 0))
3113 ;; There used to be a downcase here,
3114 ;; but the manual didn't say so,
3115 ;; and people want to set var names that aren't all lc.
3116 (let* ((key (intern (match-string 1)))
3117 (val (save-restriction
3118 (narrow-to-region (point) end)
3119 (let ((read-circle nil))
3120 (read (current-buffer)))))
3121 ;; It is traditional to ignore
3122 ;; case when checking for `mode' in set-auto-mode,
3123 ;; so we must do that here as well.
3124 ;; That is inconsistent, but we're stuck with it.
3125 ;; The same can be said for `coding' in set-auto-coding.
3126 (keyname (downcase (symbol-name key))))
3128 (and (equal keyname "mode")
3130 (intern (concat (downcase (symbol-name val))
3132 (or (equal keyname "coding")
3134 (push (cons (cond ((eq key 'eval) 'eval)
3135 ;; Downcase "Mode:".
3136 ((equal keyname "mode") 'mode)
3137 (t (indirect-variable key)))
3140 (skip-chars-forward " \t;")))
3143 (defun hack-local-variables-filter (variables dir-name)
3144 "Filter local variable settings, querying the user if necessary.
3145 VARIABLES is the alist of variable-value settings. This alist is
3146 filtered based on the values of `ignored-local-variables',
3147 `enable-local-eval', `enable-local-variables', and (if necessary)
3148 user interaction. The results are added to
3149 `file-local-variables-alist', without applying them.
3150 If these settings come from directory-local variables, then
3151 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3152 ;; Find those variables that we may want to save to
3153 ;; `safe-local-variable-values'.
3154 (let (all-vars risky-vars unsafe-vars)
3155 (dolist (elt variables)
3156 (let ((var (car elt))
3158 (cond ((memq var ignored-local-variables)
3159 ;; Ignore any variable in `ignored-local-variables'.
3161 ;; Obey `enable-local-eval'.
3163 (when enable-local-eval
3164 (let ((safe (or (hack-one-local-variable-eval-safep val)
3165 ;; In case previously marked safe (bug#5636).
3166 (safe-local-variable-p var val))))
3167 ;; If not safe and e-l-v = :safe, ignore totally.
3168 (when (or safe (not (eq enable-local-variables :safe)))
3170 (or (eq enable-local-eval t)
3172 (push elt unsafe-vars))))))
3173 ;; Ignore duplicates (except `mode') in the present list.
3174 ((and (assq var all-vars) (not (eq var 'mode))) nil)
3175 ;; Accept known-safe variables.
3176 ((or (memq var '(mode unibyte coding))
3177 (safe-local-variable-p var val))
3178 (push elt all-vars))
3179 ;; The variable is either risky or unsafe:
3180 ((not (eq enable-local-variables :safe))
3182 (if (risky-local-variable-p var val)
3183 (push elt risky-vars)
3184 (push elt unsafe-vars))))))
3186 ;; Query, unless all vars are safe or user wants no querying.
3187 (or (and (eq enable-local-variables t)
3190 (memq enable-local-variables '(:all :safe))
3191 (hack-local-variables-confirm all-vars unsafe-vars
3192 risky-vars dir-name))
3193 (dolist (elt all-vars)
3194 (unless (memq (car elt) '(eval mode))
3196 (setq dir-local-variables-alist
3197 (assq-delete-all (car elt) dir-local-variables-alist)))
3198 (setq file-local-variables-alist
3199 (assq-delete-all (car elt) file-local-variables-alist)))
3200 (push elt file-local-variables-alist)))))
3202 ;; TODO? Warn once per file rather than once per session?
3203 (defvar hack-local-variables--warned-lexical nil)
3205 (defun hack-local-variables (&optional mode-only)
3206 "Parse and put into effect this buffer's local variables spec.
3207 Uses `hack-local-variables-apply' to apply the variables.
3209 If MODE-ONLY is non-nil, all we do is check whether a \"mode:\"
3210 is specified, and return the corresponding mode symbol, or nil.
3211 In this case, we try to ignore minor-modes, and only return a
3214 If `enable-local-variables' or `local-enable-local-variables' is nil,
3215 this function does nothing. If `inhibit-local-variables-regexps'
3216 applies to the file in question, the file is not scanned for
3217 local variables, but directory-local variables may still be applied."
3218 ;; We don't let inhibit-local-variables-p influence the value of
3219 ;; enable-local-variables, because then it would affect dir-local
3220 ;; variables. We don't want to search eg tar files for file local
3221 ;; variable sections, but there is no reason dir-locals cannot apply
3222 ;; to them. The real meaning of inhibit-local-variables-p is "do
3223 ;; not scan this file for local variables".
3224 (let ((enable-local-variables
3225 (and local-enable-local-variables enable-local-variables))
3228 (setq file-local-variables-alist nil)
3229 (report-errors "Directory-local variables error: %s"
3230 ;; Note this is a no-op if enable-local-variables is nil.
3231 (hack-dir-local-variables)))
3232 ;; This entire function is basically a no-op if enable-local-variables
3233 ;; is nil. All it does is set file-local-variables-alist to nil.
3234 (when enable-local-variables
3235 ;; This part used to ignore enable-local-variables when mode-only
3236 ;; was non-nil. That was inappropriate, eg consider the
3237 ;; (artificial) example of:
3238 ;; (setq local-enable-local-variables nil)
3239 ;; Open a file foo.txt that contains "mode: sh".
3240 ;; It correctly opens in text-mode.
3241 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3242 (unless (or (inhibit-local-variables-p)
3243 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3244 ;; mode, then we're done, and have no need to scan further.
3245 (and (setq result (hack-local-variables-prop-line mode-only))
3247 ;; Look for "Local variables:" line in last page.
3249 (goto-char (point-max))
3250 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3252 (when (let ((case-fold-search t))
3253 (search-forward "Local Variables:" nil t))
3254 (skip-chars-forward " \t")
3255 ;; suffix is what comes after "local variables:" in its line.
3256 ;; prefix is what comes before "local variables:" in its line.
3259 (regexp-quote (buffer-substring (point)
3260 (line-end-position)))
3263 (concat "^" (regexp-quote
3264 (buffer-substring (line-beginning-position)
3265 (match-beginning 0))))))
3268 (let ((startpos (point))
3270 (thisbuf (current-buffer)))
3272 (unless (let ((case-fold-search t))
3274 (concat prefix "[ \t]*End:[ \t]*" suffix)
3276 ;; This used to be an error, but really all it means is
3277 ;; that this may simply not be a local-variables section,
3278 ;; so just ignore it.
3279 (message "Local variables list is not properly terminated"))
3281 (setq endpos (point)))
3284 (insert-buffer-substring thisbuf startpos endpos)
3285 (goto-char (point-min))
3286 (subst-char-in-region (point) (point-max) ?\^m ?\n)
3288 ;; Discard the prefix.
3289 (if (looking-at prefix)
3290 (delete-region (point) (match-end 0))
3291 (error "Local variables entry is missing the prefix"))
3293 ;; Discard the suffix.
3294 (if (looking-back suffix)
3295 (delete-region (match-beginning 0) (point))
3296 (error "Local variables entry is missing the suffix"))
3298 (goto-char (point-min))
3300 (while (not (or (eobp)
3301 (and mode-only result)))
3302 ;; Find the variable name;
3303 (unless (looking-at hack-local-variable-regexp)
3304 (error "Malformed local variable line: %S"
3305 (buffer-substring-no-properties
3306 (point) (line-end-position))))
3307 (goto-char (match-end 1))
3308 (let* ((str (match-string 1))
3311 (and (equal (downcase (symbol-name var)) "mode")
3313 ;; Read the variable value.
3314 (skip-chars-forward "^:")
3316 (let ((read-circle nil))
3317 (setq val (read (current-buffer))))
3320 ;; Specifying minor-modes via mode: is
3321 ;; deprecated, but try to reject them anyway.
3324 (setq val2 (downcase (symbol-name val)))))
3325 (setq result (intern (concat val2 "-mode"))))
3326 (cond ((eq var 'coding))
3327 ((eq var 'lexical-binding)
3328 (unless hack-local-variables--warned-lexical
3329 (setq hack-local-variables--warned-lexical t)
3332 (format "%s: `lexical-binding' at end of file unreliable"
3333 (file-name-nondirectory
3334 (or buffer-file-name ""))))))
3337 (push (cons (if (eq var 'eval)
3339 (indirect-variable var))
3341 (forward-line 1))))))))
3342 ;; Now we've read all the local variables.
3343 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3344 (if mode-only result
3345 ;; Otherwise, set the variables.
3346 (hack-local-variables-filter result nil)
3347 (hack-local-variables-apply)))))
3349 (defun hack-local-variables-apply ()
3350 "Apply the elements of `file-local-variables-alist'.
3351 If there are any elements, runs `before-hack-local-variables-hook',
3352 then calls `hack-one-local-variable' to apply the alist elements one by one.
3353 Finishes by running `hack-local-variables-hook', regardless of whether
3354 the alist is empty or not.
3356 Note that this function ignores a `mode' entry if it specifies the same
3357 major mode as the buffer already has."
3358 (when file-local-variables-alist
3359 ;; Any 'evals must run in the Right sequence.
3360 (setq file-local-variables-alist
3361 (nreverse file-local-variables-alist))
3362 (run-hooks 'before-hack-local-variables-hook)
3363 (dolist (elt file-local-variables-alist)
3364 (hack-one-local-variable (car elt) (cdr elt))))
3365 (run-hooks 'hack-local-variables-hook))
3367 (defun safe-local-variable-p (sym val)
3368 "Non-nil if SYM is safe as a file-local variable with value VAL.
3369 It is safe if any of these conditions are met:
3371 * There is a matching entry (SYM . VAL) in the
3372 `safe-local-variable-values' user option.
3374 * The `safe-local-variable' property of SYM is a function that
3375 evaluates to a non-nil value with VAL as an argument."
3376 (or (member (cons sym val) safe-local-variable-values)
3377 (let ((safep (get sym 'safe-local-variable)))
3378 (and (functionp safep)
3379 ;; If the function signals an error, that means it
3380 ;; can't assure us that the value is safe.
3381 (with-demoted-errors (funcall safep val))))))
3383 (defun risky-local-variable-p (sym &optional _ignored)
3384 "Non-nil if SYM could be dangerous as a file-local variable.
3385 It is dangerous if either of these conditions are met:
3387 * Its `risky-local-variable' property is non-nil.
3389 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3390 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3391 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3392 \"map-alist\", or \"bindat-spec\"."
3393 ;; If this is an alias, check the base name.
3395 (setq sym (indirect-variable sym))
3397 (or (get sym 'risky-local-variable)
3398 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3399 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3400 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3401 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
3403 (defun hack-one-local-variable-quotep (exp)
3404 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3406 (defun hack-one-local-variable-constantp (exp)
3407 (or (and (not (symbolp exp)) (not (consp exp)))
3410 (hack-one-local-variable-quotep exp)))
3412 (defun hack-one-local-variable-eval-safep (exp)
3413 "Return t if it is safe to eval EXP when it is found in a file."
3414 (or (not (consp exp))
3415 ;; Detect certain `put' expressions.
3416 (and (eq (car exp) 'put)
3417 (hack-one-local-variable-quotep (nth 1 exp))
3418 (hack-one-local-variable-quotep (nth 2 exp))
3419 (let ((prop (nth 1 (nth 2 exp)))
3421 (cond ((memq prop '(lisp-indent-hook
3422 lisp-indent-function
3423 scheme-indent-function))
3424 ;; Only allow safe values (not functions).
3426 (and (hack-one-local-variable-quotep val)
3427 (eq (nth 1 val) 'defun))))
3428 ((eq prop 'edebug-form-spec)
3429 ;; Only allow indirect form specs.
3430 ;; During bootstrapping, edebug-basic-spec might not be
3432 (and (fboundp 'edebug-basic-spec)
3433 (hack-one-local-variable-quotep val)
3434 (edebug-basic-spec (nth 1 val)))))))
3435 ;; Allow expressions that the user requested.
3436 (member exp safe-local-eval-forms)
3437 ;; Certain functions can be allowed with safe arguments
3438 ;; or can specify verification functions to try.
3439 (and (symbolp (car exp))
3440 ;; Allow (minor)-modes calls with no arguments.
3441 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3442 (or (and (member (cdr exp) '(nil (1) (0) (-1)))
3443 (string-match "-mode\\'" (symbol-name (car exp))))
3444 (let ((prop (get (car exp) 'safe-local-eval-function)))
3447 (dolist (arg (cdr exp))
3448 (unless (hack-one-local-variable-constantp arg)
3455 (dolist (function prop)
3456 (if (funcall function exp)
3460 (defun hack-one-local-variable--obsolete (var)
3461 (let ((o (get var 'byte-obsolete-variable)))
3463 (let ((instead (nth 0 o))
3465 (message "%s is obsolete%s; %s"
3466 var (if since (format " (since %s)" since))
3467 (if (stringp instead) instead
3468 (format "use `%s' instead" instead)))))))
3470 (defun hack-one-local-variable (var val)
3471 "Set local variable VAR with value VAL.
3472 If VAR is `mode', call `VAL-mode' as a function unless it's
3473 already the major mode."
3476 (let ((mode (intern (concat (downcase (symbol-name val))
3478 (unless (eq (indirect-function mode)
3479 (indirect-function major-mode))
3483 (`(add-hook ',hook . ,_) (hack-one-local-variable--obsolete hook)))
3484 (save-excursion (eval val)))
3486 (hack-one-local-variable--obsolete var)
3487 ;; Make sure the string has no text properties.
3488 ;; Some text properties can get evaluated in various ways,
3489 ;; so it is risky to put them on with a local variable list.
3491 (set-text-properties 0 (length val) nil val))
3492 (set (make-local-variable var) val))))
3494 ;;; Handling directory-local variables, aka project settings.
3496 (defvar dir-locals-class-alist '()
3497 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3499 (defvar dir-locals-directory-cache '()
3500 "List of cached directory roots for directory-local variable classes.
3501 Each element in this list has the form (DIR CLASS MTIME).
3502 DIR is the name of the directory.
3503 CLASS is the name of a variable class (a symbol).
3504 MTIME is the recorded modification time of the directory-local
3505 variables file associated with this entry. This time is a list
3506 of integers (the same format as `file-attributes'), and is
3507 used to test whether the cache entry is still valid.
3508 Alternatively, MTIME can be nil, which means the entry is always
3511 (defsubst dir-locals-get-class-variables (class)
3512 "Return the variable list for CLASS."
3513 (cdr (assq class dir-locals-class-alist)))
3515 (defun dir-locals-collect-mode-variables (mode-variables variables)
3516 "Collect directory-local variables from MODE-VARIABLES.
3517 VARIABLES is the initial list of variables.
3518 Returns the new list."
3519 (dolist (pair mode-variables variables)
3520 (let* ((variable (car pair))
3522 (slot (assq variable variables)))
3523 ;; If variables are specified more than once, only use the last. (Why?)
3524 ;; The pseudo-variables mode and eval are different (bug#3430).
3525 (if (and slot (not (memq variable '(mode eval))))
3527 ;; Need a new cons in case we setcdr later.
3528 (push (cons variable value) variables)))))
3530 (defun dir-locals-collect-variables (class-variables root variables)
3531 "Collect entries from CLASS-VARIABLES into VARIABLES.
3532 ROOT is the root directory of the project.
3533 Return the new variables list."
3534 (let* ((file-name (buffer-file-name))
3535 (sub-file-name (if file-name
3536 ;; FIXME: Why not use file-relative-name?
3537 (substring file-name (length root)))))
3539 (dolist (entry class-variables variables)
3540 (let ((key (car entry)))
3543 ;; Don't include this in the previous condition, because we
3544 ;; want to filter all strings before the next condition.
3545 (when (and sub-file-name
3546 (>= (length sub-file-name) (length key))
3547 (string-prefix-p key sub-file-name))
3548 (setq variables (dir-locals-collect-variables
3549 (cdr entry) root variables))))
3551 (derived-mode-p key))
3552 (let* ((alist (cdr entry))
3553 (subdirs (assq 'subdirs alist)))
3554 (if (or (not subdirs)
3556 (setq alist (delq subdirs alist))
3558 ;; TODO someone might want to extend this to allow
3559 ;; integer values for subdir, where N means
3560 ;; variables apply to this directory and N levels
3561 ;; below it (0 == nil).
3562 (equal root default-directory))
3563 (setq variables (dir-locals-collect-mode-variables
3564 alist variables))))))))
3566 ;; The file's content might be invalid (e.g. have a merge conflict), but
3567 ;; that shouldn't prevent the user from opening the file.
3568 (message ".dir-locals error: %s" (error-message-string err))
3571 (defun dir-locals-set-directory-class (directory class &optional mtime)
3572 "Declare that the DIRECTORY root is an instance of CLASS.
3573 DIRECTORY is the name of a directory, a string.
3574 CLASS is the name of a project class, a symbol.
3575 MTIME is either the modification time of the directory-local
3576 variables file that defined this class, or nil.
3578 When a file beneath DIRECTORY is visited, the mode-specific
3579 variables from CLASS are applied to the buffer. The variables
3580 for a class are defined using `dir-locals-set-class-variables'."
3581 (setq directory (file-name-as-directory (expand-file-name directory)))
3582 (unless (assq class dir-locals-class-alist)
3583 (error "No such class `%s'" (symbol-name class)))
3584 (push (list directory class mtime) dir-locals-directory-cache))
3586 (defun dir-locals-set-class-variables (class variables)
3587 "Map the type CLASS to a list of variable settings.
3588 CLASS is the project class, a symbol. VARIABLES is a list
3589 that declares directory-local variables for the class.
3590 An element in VARIABLES is either of the form:
3591 (MAJOR-MODE . ALIST)
3595 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3596 whose elements are of the form (VARIABLE . VALUE).
3598 In the second form, DIRECTORY is a directory name (a string), and
3599 LIST is a list of the form accepted by the function.
3601 When a file is visited, the file's class is found. A directory
3602 may be assigned a class using `dir-locals-set-directory-class'.
3603 Then variables are set in the file's buffer according to the
3604 VARIABLES list of the class. The list is processed in order.
3606 * If the element is of the form (MAJOR-MODE . ALIST), and the
3607 buffer's major mode is derived from MAJOR-MODE (as determined
3608 by `derived-mode-p'), then all the variables in ALIST are
3609 applied. A MAJOR-MODE of nil may be used to match any buffer.
3610 `make-local-variable' is called for each variable before it is
3613 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3614 is an initial substring of the file's directory, then LIST is
3615 applied by recursively following these rules."
3616 (let ((elt (assq class dir-locals-class-alist)))
3618 (setcdr elt variables)
3619 (push (cons class variables) dir-locals-class-alist))))
3621 (defconst dir-locals-file ".dir-locals.el"
3622 "File that contains directory-local variables.
3623 It has to be constant to enforce uniform values
3624 across different environments and users.")
3626 (defun dir-locals-find-file (file)
3627 "Find the directory-local variables for FILE.
3628 This searches upward in the directory tree from FILE.
3629 It stops at the first directory that has been registered in
3630 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3631 If it finds an entry in the cache, it checks that it is valid.
3632 A cache entry with no modification time element (normally, one that
3633 has been assigned directly using `dir-locals-set-directory-class', not
3634 set from a file) is always valid.
3635 A cache entry based on a `dir-locals-file' is valid if the modification
3636 time stored in the cache matches the current file modification time.
3637 If not, the cache entry is cleared so that the file will be re-read.
3639 This function returns either nil (no directory local variables found),
3640 or the matching entry from `dir-locals-directory-cache' (a list),
3641 or the full path to the `dir-locals-file' (a string) in the case
3642 of no valid cache entry."
3643 (setq file (expand-file-name file))
3644 (let* ((dir-locals-file-name
3645 (if (eq system-type 'ms-dos)
3646 (dosified-file-name dir-locals-file)
3648 (locals-file (locate-dominating-file file dir-locals-file-name))
3650 ;; `locate-dominating-file' may have abbreviated the name.
3652 (setq locals-file (expand-file-name dir-locals-file-name locals-file)))
3653 ;; Let dir-locals-read-from-file inform us via demoted-errors
3654 ;; about unreadable files, etc.
3655 ;; Maybe we'd want to keep searching though - that is
3656 ;; a locate-dominating-file issue.
3657 ;;; (or (not (file-readable-p locals-file))
3658 ;;; (not (file-regular-p locals-file)))
3659 ;;; (setq locals-file nil))
3660 ;; Find the best cached value in `dir-locals-directory-cache'.
3661 (dolist (elt dir-locals-directory-cache)
3662 (when (and (eq t (compare-strings file nil (length (car elt))
3665 '(windows-nt cygwin ms-dos))))
3666 (> (length (car elt)) (length (car dir-elt))))
3667 (setq dir-elt elt)))
3669 (or (null locals-file)
3670 (<= (length (file-name-directory locals-file))
3671 (length (car dir-elt)))))
3672 ;; Found a potential cache entry. Check validity.
3673 ;; A cache entry with no MTIME is assumed to always be valid
3674 ;; (ie, set directly, not from a dir-locals file).
3675 ;; Note, we don't bother to check that there is a matching class
3676 ;; element in dir-locals-class-alist, since that's done by
3677 ;; dir-locals-set-directory-class.
3678 (if (or (null (nth 2 dir-elt))
3679 (let ((cached-file (expand-file-name dir-locals-file-name
3681 (and (file-readable-p cached-file)
3682 (equal (nth 2 dir-elt)
3683 (nth 5 (file-attributes cached-file))))))
3684 ;; This cache entry is OK.
3686 ;; This cache entry is invalid; clear it.
3687 (setq dir-locals-directory-cache
3688 (delq dir-elt dir-locals-directory-cache))
3689 ;; Return the first existing dir-locals file. Might be the same
3690 ;; as dir-elt's, might not (eg latter might have been deleted).
3695 (defun dir-locals-read-from-file (file)
3696 "Load a variables FILE and register a new class and instance.
3697 FILE is the name of the file holding the variables to apply.
3698 The new class name is the same as the directory in which FILE
3699 is found. Returns the new class name."
3701 (with-demoted-errors "Error reading dir-locals: %S"
3702 (insert-file-contents file)
3703 (unless (zerop (buffer-size))
3704 (let* ((dir-name (file-name-directory file))
3705 (class-name (intern dir-name))
3706 (variables (let ((read-circle nil))
3707 (read (current-buffer)))))
3708 (dir-locals-set-class-variables class-name variables)
3709 (dir-locals-set-directory-class dir-name class-name
3710 (nth 5 (file-attributes file)))
3713 (defcustom enable-remote-dir-locals nil
3714 "Non-nil means dir-local variables will be applied to remote files."
3719 (defvar hack-dir-local-variables--warned-coding nil)
3721 (defun hack-dir-local-variables ()
3722 "Read per-directory local variables for the current buffer.
3723 Store the directory-local variables in `dir-local-variables-alist'
3724 and `file-local-variables-alist', without applying them.
3726 This does nothing if either `enable-local-variables' or
3727 `enable-dir-local-variables' are nil."
3728 (when (and enable-local-variables
3729 enable-dir-local-variables
3730 (or enable-remote-dir-locals
3731 (not (file-remote-p (or (buffer-file-name)
3732 default-directory)))))
3733 ;; Find the variables file.
3734 (let ((variables-file (dir-locals-find-file
3735 (or (buffer-file-name) default-directory)))
3739 ((stringp variables-file)
3740 (setq dir-name (file-name-directory variables-file)
3741 class (dir-locals-read-from-file variables-file)))
3742 ((consp variables-file)
3743 (setq dir-name (nth 0 variables-file))
3744 (setq class (nth 1 variables-file))))
3747 (dir-locals-collect-variables
3748 (dir-locals-get-class-variables class) dir-name nil)))
3750 (dolist (elt variables)
3751 (if (eq (car elt) 'coding)
3752 (unless hack-dir-local-variables--warned-coding
3753 (setq hack-dir-local-variables--warned-coding t)
3754 (display-warning :warning
3755 "Coding cannot be specified by dir-locals"))
3756 (unless (memq (car elt) '(eval mode))
3757 (setq dir-local-variables-alist
3758 (assq-delete-all (car elt) dir-local-variables-alist)))
3759 (push elt dir-local-variables-alist)))
3760 (hack-local-variables-filter variables dir-name)))))))
3762 (defun hack-dir-local-variables-non-file-buffer ()
3763 "Apply directory-local variables to a non-file buffer.
3764 For non-file buffers, such as Dired buffers, directory-local
3765 variables are looked for in `default-directory' and its parent
3767 (hack-dir-local-variables)
3768 (hack-local-variables-apply))
3771 (defcustom change-major-mode-with-file-name t
3772 "Non-nil means \\[write-file] should set the major mode from the file name.
3773 However, the mode will not be changed if
3774 \(1) a local variables list or the `-*-' line specifies a major mode, or
3775 \(2) the current major mode is a \"special\" mode,
3776 \ not suitable for ordinary files, or
3777 \(3) the new file name does not particularly specify any mode."
3779 :group 'editing-basics)
3781 (defun set-visited-file-name (filename &optional no-query along-with-file)
3782 "Change name of file visited in current buffer to FILENAME.
3783 This also renames the buffer to correspond to the new file.
3784 The next time the buffer is saved it will go in the newly specified file.
3785 FILENAME nil or an empty string means mark buffer as not visiting any file.
3786 Remember to delete the initial contents of the minibuffer
3787 if you wish to pass an empty string as the argument.
3789 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3790 confirmation in the case where another buffer is already visiting FILENAME.
3792 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3793 the old visited file has been renamed to the new name FILENAME."
3794 (interactive "FSet visited file name: ")
3795 (if (buffer-base-buffer)
3796 (error "An indirect buffer cannot visit a file"))
3797 (let (truename old-try-locals)
3800 (if (string-equal filename "")
3802 (expand-file-name filename))))
3805 (setq truename (file-truename filename))
3806 (if find-file-visit-truename
3807 (setq filename truename))))
3809 (let ((new-name (file-name-nondirectory filename)))
3810 (if (string= new-name "")
3811 (error "Empty file name"))))
3812 (let ((buffer (and filename (find-buffer-visiting filename))))
3813 (and buffer (not (eq buffer (current-buffer)))
3815 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3818 (or (equal filename buffer-file-name)
3820 (and filename (lock-buffer filename))
3822 (setq old-try-locals (not (inhibit-local-variables-p))
3823 buffer-file-name filename)
3824 (if filename ; make buffer name reflect filename.
3825 (let ((new-name (file-name-nondirectory buffer-file-name)))
3826 (setq default-directory (file-name-directory buffer-file-name))
3827 ;; If new-name == old-name, renaming would add a spurious <2>
3828 ;; and it's considered as a feature in rename-buffer.
3829 (or (string= new-name (buffer-name))
3830 (rename-buffer new-name t))))
3831 (setq buffer-backed-up nil)
3833 (clear-visited-file-modtime))
3834 ;; Abbreviate the file names of the buffer.
3837 (setq buffer-file-truename (abbreviate-file-name truename))
3838 (if find-file-visit-truename
3839 (setq buffer-file-name truename))))
3840 (setq buffer-file-number
3842 (nthcdr 10 (file-attributes buffer-file-name))
3844 ;; write-file-functions is normally used for things like ftp-find-file
3845 ;; that visit things that are not local files as if they were files.
3846 ;; Changing to visit an ordinary local file instead should flush the hook.
3847 (kill-local-variable 'write-file-functions)
3848 (kill-local-variable 'local-write-file-hooks)
3849 (kill-local-variable 'revert-buffer-function)
3850 (kill-local-variable 'backup-inhibited)
3851 ;; If buffer was read-only because of version control,
3852 ;; that reason is gone now, so make it writable.
3854 (setq buffer-read-only nil))
3855 (kill-local-variable 'vc-mode)
3856 ;; Turn off backup files for certain file names.
3857 ;; Since this is a permanent local, the major mode won't eliminate it.
3858 (and buffer-file-name
3859 backup-enable-predicate
3860 (not (funcall backup-enable-predicate buffer-file-name))
3862 (make-local-variable 'backup-inhibited)
3863 (setq backup-inhibited t)))
3864 (let ((oauto buffer-auto-save-file-name))
3865 ;; If auto-save was not already on, turn it on if appropriate.
3866 (if (not buffer-auto-save-file-name)
3867 (and buffer-file-name auto-save-default
3869 ;; If auto save is on, start using a new name.
3870 ;; We deliberately don't rename or delete the old auto save
3871 ;; for the old visited file name. This is because perhaps
3872 ;; the user wants to save the new state and then compare with the
3873 ;; previous state from the auto save file.
3874 (setq buffer-auto-save-file-name
3875 (make-auto-save-file-name)))
3876 ;; Rename the old auto save file if any.
3877 (and oauto buffer-auto-save-file-name
3878 (file-exists-p oauto)
3879 (rename-file oauto buffer-auto-save-file-name t)))
3880 (and buffer-file-name
3881 (not along-with-file)
3882 (set-buffer-modified-p t))
3883 ;; Update the major mode, if the file name determines it.
3885 ;; Don't change the mode if it is special.
3886 (or (not change-major-mode-with-file-name)
3887 (get major-mode 'mode-class)
3888 ;; Don't change the mode if the local variable list specifies it.
3889 ;; The file name can influence whether the local variables apply.
3891 ;; h-l-v also checks it, but might as well be explicit.
3892 (not (inhibit-local-variables-p))
3893 (hack-local-variables t))
3894 ;; TODO consider making normal-mode handle this case.
3895 (let ((old major-mode))
3897 (or (eq old major-mode)
3898 (hack-local-variables))))
3901 (defun write-file (filename &optional confirm)
3902 "Write current buffer into file FILENAME.
3903 This makes the buffer visit that file, and marks it as not modified.
3905 If you specify just a directory name as FILENAME, that means to use
3906 the default file name but in that directory. You can also yank
3907 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3909 If the buffer is not already visiting a file, the default file name
3910 for the output file is the buffer name.
3912 If optional second arg CONFIRM is non-nil, this function
3913 asks for confirmation before overwriting an existing file.
3914 Interactively, confirmation is required unless you supply a prefix argument."
3915 ;; (interactive "FWrite file: ")
3917 (list (if buffer-file-name
3918 (read-file-name "Write file: "
3920 (read-file-name "Write file: " default-directory
3922 (file-name-nondirectory (buffer-name))
3925 (not current-prefix-arg)))
3926 (or (null filename) (string-equal filename "")
3928 ;; If arg is just a directory,
3929 ;; use the default file name, but in that directory.
3930 (if (file-directory-p filename)
3931 (setq filename (concat (file-name-as-directory filename)
3932 (file-name-nondirectory
3933 (or buffer-file-name (buffer-name))))))
3935 (file-exists-p filename)
3936 ;; NS does its own confirm dialog.
3937 (not (and (eq (framep-on-display) 'ns)
3938 (listp last-nonmenu-event)
3940 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3941 (error "Canceled")))
3942 (set-visited-file-name filename (not confirm))))
3943 (set-buffer-modified-p t)
3944 ;; Make buffer writable if file is writable.
3945 (and buffer-file-name
3946 (file-writable-p buffer-file-name)
3947 (setq buffer-read-only nil))
3949 ;; It's likely that the VC status at the new location is different from
3950 ;; the one at the old location.
3951 (vc-find-file-hook))
3953 (defun file-extended-attributes (filename)
3954 "Return an alist of extended attributes of file FILENAME.
3956 Extended attributes are platform-specific metadata about the file,
3957 such as SELinux context, list of ACL entries, etc."
3958 `((acl . ,(file-acl filename))
3959 (selinux-context . ,(file-selinux-context filename))))
3961 (defun set-file-extended-attributes (filename attributes)
3962 "Set extended attributes of file FILENAME to ATTRIBUTES.
3964 ATTRIBUTES must be an alist of file attributes as returned by
3965 `file-extended-attributes'."
3966 (dolist (elt attributes)
3967 (let ((attr (car elt))
3969 (cond ((eq attr 'acl)
3970 (set-file-acl filename val))
3971 ((eq attr 'selinux-context)
3972 (set-file-selinux-context filename val))))))
3974 (defun backup-buffer ()
3975 "Make a backup of the disk file visited by the current buffer, if appropriate.
3976 This is normally done before saving the buffer the first time.
3978 A backup may be done by renaming or by copying; see documentation of
3979 variable `make-backup-files'. If it's done by renaming, then the file is
3980 no longer accessible under its old name.
3982 The value is non-nil after a backup was made by renaming.
3983 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
3984 MODES is the result of `file-modes' on the original
3985 file; this means that the caller, after saving the buffer, should change
3986 the modes of the new file to agree with the old modes.
3987 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
3988 on the original file; this means that the caller, after saving
3989 the buffer, should change the extended attributes of the new file
3990 to agree with the old attributes.
3991 BACKUPNAME is the backup file name, which is the old file renamed."
3992 (if (and make-backup-files (not backup-inhibited)
3993 (not buffer-backed-up)
3994 (file-exists-p buffer-file-name)
3995 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3997 (let ((real-file-name buffer-file-name)
3998 backup-info backupname targets setmodes)
3999 ;; If specified name is a symbolic link, chase it to the target.
4000 ;; Thus we make the backups in the directory where the real file is.
4001 (setq real-file-name (file-chase-links real-file-name))
4002 (setq backup-info (find-backup-file-name real-file-name)
4003 backupname (car backup-info)
4004 targets (cdr backup-info))
4005 ;; (if (file-directory-p buffer-file-name)
4006 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
4009 (let ((delete-old-versions
4010 ;; If have old versions to maybe delete,
4011 ;; ask the user to confirm now, before doing anything.
4012 ;; But don't actually delete til later.
4014 (or (eq delete-old-versions t) (eq delete-old-versions nil))
4015 (or delete-old-versions
4016 (y-or-n-p (format "Delete excess backup versions of %s? "
4018 (modes (file-modes buffer-file-name))
4019 (extended-attributes
4020 (file-extended-attributes buffer-file-name)))
4021 ;; Actually write the back up file.
4023 (if (or file-precious-flag
4024 ; (file-symlink-p buffer-file-name)
4026 ;; Don't rename a suid or sgid file.
4027 (and modes (< 0 (logand modes #o6000)))
4028 (not (file-writable-p (file-name-directory real-file-name)))
4029 (and backup-by-copying-when-linked
4030 (> (file-nlinks real-file-name) 1))
4031 (and (or backup-by-copying-when-mismatch
4032 (integerp backup-by-copying-when-privileged-mismatch))
4033 (let ((attr (file-attributes real-file-name)))
4034 (and (or backup-by-copying-when-mismatch
4035 (and (integerp (nth 2 attr))
4036 (integerp backup-by-copying-when-privileged-mismatch)
4037 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
4038 (not (file-ownership-preserved-p
4039 real-file-name t))))))
4040 (backup-buffer-copy real-file-name
4042 extended-attributes)
4043 ;; rename-file should delete old backup.
4044 (rename-file real-file-name backupname t)
4045 (setq setmodes (list modes extended-attributes
4048 ;; If trouble writing the backup, write it in
4049 ;; .emacs.d/%backup%.
4050 (setq backupname (locate-user-emacs-file "%backup%~"))
4051 (message "Cannot write backup file; backing up in %s"
4054 (backup-buffer-copy real-file-name backupname
4055 modes extended-attributes)))
4056 (setq buffer-backed-up t)
4057 ;; Now delete the old versions, if desired.
4058 (if delete-old-versions
4061 (delete-file (car targets))
4063 (setq targets (cdr targets))))
4065 (file-error nil))))))
4067 (defun backup-buffer-copy (from-name to-name modes extended-attributes)
4068 ;; Create temp files with strict access rights. It's easy to
4069 ;; loosen them later, whereas it's impossible to close the
4070 ;; time-window of loose permissions otherwise.
4071 (with-file-modes ?\700
4072 (when (condition-case nil
4073 ;; Try to overwrite old backup first.
4074 (copy-file from-name to-name t t t)
4076 (while (condition-case nil
4078 (when (file-exists-p to-name)
4079 (delete-file to-name))
4080 (copy-file from-name to-name nil t t)
4082 (file-already-exists t))
4083 ;; The file was somehow created by someone else between
4084 ;; `delete-file' and `copy-file', so let's try again.
4085 ;; rms says "I think there is also a possible race
4086 ;; condition for making backup files" (emacs-devel 20070821).
4088 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4089 (unless (and extended-attributes
4090 (with-demoted-errors
4091 (set-file-extended-attributes to-name extended-attributes)))
4093 (set-file-modes to-name (logand modes #o1777)))))
4095 (defvar file-name-version-regexp
4096 "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+\\(?:~[[:digit:]]+\\)?~\\)"
4097 ;; The last ~[[:digit]]+ matches relative versions in git,
4098 ;; e.g. `foo.js.~HEAD~1~'.
4099 "Regular expression matching the backup/version part of a file name.
4100 Used by `file-name-sans-versions'.")
4102 (defun file-name-sans-versions (name &optional keep-backup-version)
4103 "Return file NAME sans backup versions or strings.
4104 This is a separate procedure so your site-init or startup file can
4106 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4107 we do not remove backup version numbers, only true file version numbers.
4108 See also `file-name-version-regexp'."
4109 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
4111 (funcall handler 'file-name-sans-versions name keep-backup-version)
4113 (unless keep-backup-version
4114 (string-match (concat file-name-version-regexp "\\'")
4117 (defun file-ownership-preserved-p (file &optional group)
4118 "Return t if deleting FILE and rewriting it would preserve the owner.
4119 Return nil if FILE does not exist, or if deleting and recreating it
4120 might not preserve the owner. If GROUP is non-nil, check whether
4121 the group would be preserved too."
4122 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
4124 (funcall handler 'file-ownership-preserved-p file group)
4125 (let ((attributes (file-attributes file 'integer)))
4126 ;; Return t if the file doesn't exist, since it's true that no
4127 ;; information would be lost by an (attempted) delete and create.
4128 (or (null attributes)
4129 (and (or (= (nth 2 attributes) (user-uid))
4130 ;; Files created on Windows by Administrator (RID=500)
4131 ;; have the Administrators group (RID=544) recorded as
4132 ;; their owner. Rewriting them will still preserve the
4134 (and (eq system-type 'windows-nt)
4135 (= (user-uid) 500) (= (nth 2 attributes) 544)))
4137 ;; On BSD-derived systems files always inherit the parent
4138 ;; directory's group, so skip the group-gid test.
4139 (memq system-type '(berkeley-unix darwin gnu/kfreebsd))
4140 (= (nth 3 attributes) (group-gid)))
4141 (let* ((parent (or (file-name-directory file) "."))
4142 (parent-attributes (file-attributes parent 'integer)))
4143 (and parent-attributes
4144 ;; On some systems, a file created in a setuid directory
4145 ;; inherits that directory's owner.
4147 (= (nth 2 parent-attributes) (user-uid))
4148 (string-match "^...[^sS]" (nth 8 parent-attributes)))
4149 ;; On many systems, a file created in a setgid directory
4150 ;; inherits that directory's group. On some systems
4151 ;; this happens even if the setgid bit is not set.
4153 (= (nth 3 parent-attributes)
4154 (nth 3 attributes)))))))))))
4156 (defun file-name-sans-extension (filename)
4157 "Return FILENAME sans final \"extension\".
4158 The extension, in a file name, is the part that follows the last `.',
4159 except that a leading `.', if any, doesn't count."
4161 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
4163 (if (and (string-match "\\.[^.]*\\'" file)
4164 (not (eq 0 (match-beginning 0))))
4165 (if (setq directory (file-name-directory filename))
4166 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4167 ;; we don't want to expand it.
4168 (concat directory (substring file 0 (match-beginning 0)))
4169 (substring file 0 (match-beginning 0)))
4172 (defun file-name-extension (filename &optional period)
4173 "Return FILENAME's final \"extension\".
4174 The extension, in a file name, is the part that follows the last `.',
4175 excluding version numbers and backup suffixes,
4176 except that a leading `.', if any, doesn't count.
4177 Return nil for extensionless file names such as `foo'.
4178 Return the empty string for file names such as `foo.'.
4180 If PERIOD is non-nil, then the returned value includes the period
4181 that delimits the extension, and if FILENAME has no extension,
4184 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
4185 (if (and (string-match "\\.[^.]*\\'" file)
4186 (not (eq 0 (match-beginning 0))))
4187 (substring file (+ (match-beginning 0) (if period 0 1)))
4191 (defun file-name-base (&optional filename)
4192 "Return the base name of the FILENAME: no directory, no extension.
4193 FILENAME defaults to `buffer-file-name'."
4194 (file-name-sans-extension
4195 (file-name-nondirectory (or filename (buffer-file-name)))))
4197 (defcustom make-backup-file-name-function
4198 #'make-backup-file-name--default-function
4199 "A function that `make-backup-file-name' uses to create backup file names.
4200 The function receives a single argument, the original file name.
4202 If you change this, you may need to change `backup-file-name-p' and
4203 `file-name-sans-versions' too.
4205 You could make this buffer-local to do something special for specific files.
4207 For historical reasons, a value of nil means to use the default function.
4208 This should not be relied upon.
4210 See also `backup-directory-alist'."
4211 :version "24.4" ; nil -> make-backup-file-name--default-function
4213 :type '(choice (const :tag "Deprecated way to get the default function" nil)
4214 (function :tag "Function")))
4216 (defcustom backup-directory-alist nil
4217 "Alist of filename patterns and backup directory names.
4218 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4219 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4220 relative or absolute. If it is absolute, so that all matching files
4221 are backed up into the same directory, the file names in this
4222 directory will be the full name of the file backed up with all
4223 directory separators changed to `!' to prevent clashes. This will not
4224 work correctly if your filesystem truncates the resulting name.
4226 For the common case of all backups going into one directory, the alist
4227 should contain a single element pairing \".\" with the appropriate
4230 If this variable is nil, or it fails to match a filename, the backup
4231 is made in the original file's directory.
4233 On MS-DOS filesystems without long names this variable is always
4236 :type '(repeat (cons (regexp :tag "Regexp matching filename")
4237 (directory :tag "Backup directory name"))))
4239 (defun normal-backup-enable-predicate (name)
4240 "Default `backup-enable-predicate' function.
4241 Checks for files in `temporary-file-directory',
4242 `small-temporary-file-directory', and /tmp."
4243 (let ((temporary-file-directory temporary-file-directory)
4245 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4246 ;; their long file-name equivalents, so compare-strings does TRT.
4247 (if (memq system-type '(ms-dos windows-nt))
4248 (setq temporary-file-directory (file-truename temporary-file-directory)
4249 name (file-truename name)
4251 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
4252 name 0 nil caseless)))
4253 ;; Directory is under temporary-file-directory.
4254 (and (not (eq comp t))
4255 (< comp (- (length temporary-file-directory)))))
4256 (let ((comp (compare-strings "/tmp" 0 nil
4258 ;; Directory is under /tmp.
4259 (and (not (eq comp t))
4260 (< comp (- (length "/tmp")))))
4261 (if small-temporary-file-directory
4262 (let ((comp (compare-strings small-temporary-file-directory
4264 name 0 nil caseless)))
4265 ;; Directory is under small-temporary-file-directory.
4266 (and (not (eq comp t))
4267 (< comp (- (length small-temporary-file-directory))))))))))
4269 (defun make-backup-file-name (file)
4270 "Create the non-numeric backup file name for FILE.
4271 This calls the function that `make-backup-file-name-function' specifies,
4272 with a single argument FILE."
4273 (funcall (or make-backup-file-name-function
4274 #'make-backup-file-name--default-function)
4277 (defun make-backup-file-name--default-function (file)
4278 "Default function for `make-backup-file-name'.
4279 Normally this just returns FILE's name with `~' appended.
4280 It searches for a match for FILE in `backup-directory-alist'.
4281 If the directory for the backup doesn't exist, it is created."
4282 (if (and (eq system-type 'ms-dos)
4283 (not (msdos-long-file-names)))
4284 (let ((fn (file-name-nondirectory file)))
4285 (concat (file-name-directory file)
4286 (or (and (string-match "\\`[^.]+\\'" fn)
4287 (concat (match-string 0 fn) ".~"))
4288 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
4289 (concat (match-string 0 fn) "~")))))
4290 (concat (make-backup-file-name-1 file) "~")))
4292 (defun make-backup-file-name-1 (file)
4293 "Subroutine of `make-backup-file-name--default-function'.
4294 The function `find-backup-file-name' also uses this."
4295 (let ((alist backup-directory-alist)
4296 elt backup-directory abs-backup-directory)
4298 (setq elt (pop alist))
4299 (if (string-match (car elt) file)
4300 (setq backup-directory (cdr elt)
4302 ;; If backup-directory is relative, it should be relative to the
4303 ;; file's directory. By expanding explicitly here, we avoid
4304 ;; depending on default-directory.
4305 (if backup-directory
4306 (setq abs-backup-directory
4307 (expand-file-name backup-directory
4308 (file-name-directory file))))
4309 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
4311 (make-directory abs-backup-directory 'parents)
4312 (file-error (setq backup-directory nil
4313 abs-backup-directory nil))))
4314 (if (null backup-directory)
4316 (if (file-name-absolute-p backup-directory)
4318 (when (memq system-type '(windows-nt ms-dos cygwin))
4319 ;; Normalize DOSish file names: downcase the drive
4320 ;; letter, if any, and replace the leading "x:" with
4322 (or (file-name-absolute-p file)
4323 (setq file (expand-file-name file))) ; make defaults explicit
4324 ;; Replace any invalid file-name characters (for the
4325 ;; case of backing up remote files).
4326 (setq file (expand-file-name (convert-standard-filename file)))
4327 (if (eq (aref file 1) ?:)
4328 (setq file (concat "/"
4330 (char-to-string (downcase (aref file 0)))
4331 (if (eq (aref file 2) ?/)
4334 (substring file 2)))))
4335 ;; Make the name unique by substituting directory
4336 ;; separators. It may not really be worth bothering about
4337 ;; doubling `!'s in the original name...
4339 (subst-char-in-string
4341 (replace-regexp-in-string "!" "!!" file))
4343 (expand-file-name (file-name-nondirectory file)
4344 (file-name-as-directory abs-backup-directory))))))
4346 (defun backup-file-name-p (file)
4347 "Return non-nil if FILE is a backup file name (numeric or not).
4348 This is a separate function so you can redefine it for customization.
4349 You may need to redefine `file-name-sans-versions' as well."
4350 (string-match "~\\'" file))
4352 (defvar backup-extract-version-start)
4354 ;; This is used in various files.
4355 ;; The usage of backup-extract-version-start is not very clean,
4356 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4357 (defun backup-extract-version (fn)
4358 "Given the name of a numeric backup file, FN, return the backup number.
4359 Uses the free variable `backup-extract-version-start', whose value should be
4360 the index in the name where the version number begins."
4361 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
4362 (= (match-beginning 0) backup-extract-version-start))
4363 (string-to-number (substring fn backup-extract-version-start -1))
4366 (defun find-backup-file-name (fn)
4367 "Find a file name for a backup file FN, and suggestions for deletions.
4368 Value is a list whose car is the name for the backup file
4369 and whose cdr is a list of old versions to consider deleting now.
4370 If the value is nil, don't make a backup.
4371 Uses `backup-directory-alist' in the same way as
4372 `make-backup-file-name--default-function' does."
4373 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
4374 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4376 (funcall handler 'find-backup-file-name fn)
4377 (if (or (eq version-control 'never)
4378 ;; We don't support numbered backups on plain MS-DOS
4379 ;; when long file names are unavailable.
4380 (and (eq system-type 'ms-dos)
4381 (not (msdos-long-file-names))))
4382 (list (make-backup-file-name fn))
4383 (let* ((basic-name (make-backup-file-name-1 fn))
4384 (base-versions (concat (file-name-nondirectory basic-name)
4386 (backup-extract-version-start (length base-versions))
4388 (number-to-delete 0)
4389 possibilities deserve-versions-p versions)
4391 (setq possibilities (file-name-all-completions
4393 (file-name-directory basic-name))
4394 versions (sort (mapcar #'backup-extract-version
4397 high-water-mark (apply 'max 0 versions)
4398 deserve-versions-p (or version-control
4399 (> high-water-mark 0))
4400 number-to-delete (- (length versions)
4404 (file-error (setq possibilities nil)))
4405 (if (not deserve-versions-p)
4406 (list (make-backup-file-name fn))
4407 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
4408 (if (and (> number-to-delete 0)
4409 ;; Delete nothing if there is overflow
4410 ;; in the number of versions to keep.
4411 (>= (+ kept-new-versions kept-old-versions -1) 0))
4413 (format "%s.~%d~" basic-name n))
4414 (let ((v (nthcdr kept-old-versions versions)))
4415 (rplacd (nthcdr (1- number-to-delete) v) ())
4418 (defun file-nlinks (filename)
4419 "Return number of names file FILENAME has."
4420 (car (cdr (file-attributes filename))))
4422 ;; (defun file-relative-name (filename &optional directory)
4423 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4424 ;; This function returns a relative file name which is equivalent to FILENAME
4425 ;; when used with that default directory as the default.
4426 ;; If this is impossible (which can happen on MSDOS and Windows
4427 ;; when the file name and directory use different drive names)
4428 ;; then it returns FILENAME."
4430 ;; (let ((fname (expand-file-name filename)))
4431 ;; (setq directory (file-name-as-directory
4432 ;; (expand-file-name (or directory default-directory))))
4433 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4434 ;; ;; drive names, they can't be relative, so return the absolute name.
4435 ;; (if (and (or (eq system-type 'ms-dos)
4436 ;; (eq system-type 'cygwin)
4437 ;; (eq system-type 'windows-nt))
4438 ;; (not (string-equal (substring fname 0 2)
4439 ;; (substring directory 0 2))))
4441 ;; (let ((ancestor ".")
4442 ;; (fname-dir (file-name-as-directory fname)))
4443 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4444 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4445 ;; (setq directory (file-name-directory (substring directory 0 -1))
4446 ;; ancestor (if (equal ancestor ".")
4448 ;; (concat "../" ancestor))))
4449 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4450 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4451 ;; ;; We matched within FNAME's directory part.
4452 ;; ;; Add the rest of FNAME onto ANCESTOR.
4453 ;; (let ((rest (substring fname (match-end 0))))
4454 ;; (if (and (equal ancestor ".")
4455 ;; (not (equal rest "")))
4456 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4458 ;; (concat (file-name-as-directory ancestor) rest)))
4459 ;; ;; We matched FNAME's directory equivalent.
4462 (defun file-relative-name (filename &optional directory)
4463 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4464 This function returns a relative file name which is equivalent to FILENAME
4465 when used with that default directory as the default.
4466 If FILENAME is a relative file name, it will be interpreted as existing in
4467 `default-directory'.
4468 If FILENAME and DIRECTORY lie on different machines or on different drives
4469 on a DOS/Windows machine, it returns FILENAME in expanded form."
4472 (file-name-as-directory (expand-file-name (or directory
4473 default-directory))))
4474 (setq filename (expand-file-name filename))
4475 (let ((fremote (file-remote-p filename))
4476 (dremote (file-remote-p directory))
4477 (fold-case (or (memq system-type '(ms-dos cygwin windows-nt))
4478 read-file-name-completion-ignore-case)))
4479 (if ;; Conditions for separate trees
4481 ;; Test for different filesystems on DOS/Windows
4483 ;; Should `cygwin' really be included here? --stef
4484 (memq system-type '(ms-dos cygwin windows-nt))
4486 ;; Test for different drive letters
4487 (not (eq t (compare-strings filename 0 2 directory 0 2 fold-case)))
4488 ;; Test for UNCs on different servers
4489 (not (eq t (compare-strings
4491 (if (string-match "\\`//\\([^:/]+\\)/" filename)
4492 (match-string 1 filename)
4493 ;; Windows file names cannot have ? in
4494 ;; them, so use that to detect when
4495 ;; neither FILENAME nor DIRECTORY is a
4500 (if (string-match "\\`//\\([^:/]+\\)/" directory)
4501 (match-string 1 directory)
4504 ;; Test for different remote file system identification
4505 (not (equal fremote dremote)))
4507 (let ((ancestor ".")
4508 (filename-dir (file-name-as-directory filename)))
4511 (eq t (compare-strings filename-dir nil (length directory)
4512 directory nil nil fold-case))
4513 (eq t (compare-strings filename nil (length directory)
4514 directory nil nil fold-case))))
4515 (setq directory (file-name-directory (substring directory 0 -1))
4516 ancestor (if (equal ancestor ".")
4518 (concat "../" ancestor))))
4519 ;; Now ancestor is empty, or .., or ../.., etc.
4520 (if (eq t (compare-strings filename nil (length directory)
4521 directory nil nil fold-case))
4522 ;; We matched within FILENAME's directory part.
4523 ;; Add the rest of FILENAME onto ANCESTOR.
4524 (let ((rest (substring filename (length directory))))
4525 (if (and (equal ancestor ".") (not (equal rest "")))
4526 ;; But don't bother with ANCESTOR if it would give us `./'.
4528 (concat (file-name-as-directory ancestor) rest)))
4529 ;; We matched FILENAME's directory equivalent.
4532 (defun save-buffer (&optional arg)
4533 "Save current buffer in visited file if modified.
4534 Variations are described below.
4536 By default, makes the previous version into a backup file
4537 if previously requested or if this is the first save.
4538 Prefixed with one \\[universal-argument], marks this version
4539 to become a backup when the next save is done.
4540 Prefixed with two \\[universal-argument]'s,
4541 unconditionally makes the previous version into a backup file.
4542 Prefixed with three \\[universal-argument]'s, marks this version
4543 to become a backup when the next save is done,
4544 and unconditionally makes the previous version into a backup file.
4546 With a numeric prefix argument of 0, never make the previous version
4549 If a file's name is FOO, the names of its numbered backup versions are
4550 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4551 Numeric backups (rather than FOO~) will be made if value of
4552 `version-control' is not the atom `never' and either there are already
4553 numeric versions of the file being backed up, or `version-control' is
4555 We don't want excessive versions piling up, so there are variables
4556 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4557 and `kept-new-versions', which tells how many newest versions to keep.
4558 Defaults are 2 old versions and 2 new.
4559 `dired-kept-versions' controls dired's clean-directory (.) command.
4560 If `delete-old-versions' is nil, system will query user
4561 before trimming versions. Otherwise it does it silently.
4563 If `vc-make-backup-files' is nil, which is the default,
4564 no backup files are made for files managed by version control.
4565 (This is because the version control system itself records previous versions.)
4567 See the subroutine `basic-save-buffer' for more information."
4569 (let ((modp (buffer-modified-p))
4570 (make-backup-files (or (and make-backup-files (not (eq arg 0)))
4571 (memq arg '(16 64)))))
4572 (and modp (memq arg '(16 64)) (setq buffer-backed-up nil))
4573 ;; We used to display the message below only for files > 50KB, but
4574 ;; then Rmail-mbox never displays it due to buffer swapping. If
4575 ;; the test is ever re-introduced, be sure to handle saving of
4577 (if (and modp (buffer-file-name))
4578 (message "Saving file %s..." (buffer-file-name)))
4580 (and modp (memq arg '(4 64)) (setq buffer-backed-up nil))))
4582 (defun delete-auto-save-file-if-necessary (&optional force)
4583 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4584 Normally delete only if the file was written by this Emacs since
4585 the last real save, but optional arg FORCE non-nil means delete anyway."
4586 (and buffer-auto-save-file-name delete-auto-save-files
4587 (not (string= buffer-file-name buffer-auto-save-file-name))
4588 (or force (recent-auto-save-p))
4591 (delete-file buffer-auto-save-file-name)
4593 (set-buffer-auto-saved))))
4595 (defvar auto-save-hook nil
4596 "Normal hook run just before auto-saving.")
4598 (defcustom before-save-hook nil
4599 "Normal hook that is run before a buffer is saved to its file."
4600 :options '(copyright-update time-stamp)
4604 (defcustom after-save-hook nil
4605 "Normal hook that is run after a buffer is saved to its file."
4606 :options '(executable-make-buffer-file-executable-if-script-p)
4610 (defvar save-buffer-coding-system nil
4611 "If non-nil, use this coding system for saving the buffer.
4612 More precisely, use this coding system in place of the
4613 value of `buffer-file-coding-system', when saving the buffer.
4614 Calling `write-region' for any purpose other than saving the buffer
4615 will still use `buffer-file-coding-system'; this variable has no effect
4618 (make-variable-buffer-local 'save-buffer-coding-system)
4619 (put 'save-buffer-coding-system 'permanent-local t)
4621 (defun basic-save-buffer ()
4622 "Save the current buffer in its visited file, if it has been modified.
4623 The hooks `write-contents-functions' and `write-file-functions' get a chance
4624 to do the job of saving; if they do not, then the buffer is saved in
4625 the visited file in the usual way.
4626 Before and after saving the buffer, this function runs
4627 `before-save-hook' and `after-save-hook', respectively."
4629 (save-current-buffer
4630 ;; In an indirect buffer, save its base buffer instead.
4631 (if (buffer-base-buffer)
4632 (set-buffer (buffer-base-buffer)))
4633 (if (or (buffer-modified-p)
4634 ;; handle the case when no modification has been made but
4635 ;; the file disappeared since visited
4636 (and buffer-file-name
4637 (not (file-exists-p buffer-file-name))))
4638 (let ((recent-save (recent-auto-save-p))
4640 ;; If buffer has no file name, ask user for one.
4641 (or buffer-file-name
4644 (read-file-name "File to save in: "
4645 nil (expand-file-name (buffer-name))))))
4646 (if (file-exists-p filename)
4647 (if (file-directory-p filename)
4648 ;; Signal an error if the user specified the name of an
4649 ;; existing directory.
4650 (error "%s is a directory" filename)
4651 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4653 (error "Canceled"))))
4654 (set-visited-file-name filename)))
4655 (or (verify-visited-file-modtime (current-buffer))
4656 (not (file-exists-p buffer-file-name))
4659 "%s has changed since visited or saved. Save anyway? "
4660 (file-name-nondirectory buffer-file-name)))
4661 (user-error "Save not confirmed"))
4665 (and (> (point-max) (point-min))
4666 (not find-file-literally)
4667 (/= (char-after (1- (point-max))) ?\n)
4668 (not (and (eq selective-display t)
4669 (= (char-after (1- (point-max))) ?\r)))
4670 (or (eq require-final-newline t)
4671 (eq require-final-newline 'visit-save)
4672 (and require-final-newline
4674 (format "Buffer %s does not end in newline. Add one? "
4677 (goto-char (point-max))
4679 ;; Support VC version backups.
4681 ;; Don't let errors prevent saving the buffer.
4682 (with-demoted-errors (run-hooks 'before-save-hook))
4683 (or (run-hook-with-args-until-success 'write-contents-functions)
4684 (run-hook-with-args-until-success 'local-write-file-hooks)
4685 (run-hook-with-args-until-success 'write-file-functions)
4686 ;; If a hook returned t, file is already "written".
4687 ;; Otherwise, write it the usual way now.
4688 (let ((dir (file-name-directory
4689 (expand-file-name buffer-file-name))))
4690 (unless (file-exists-p dir)
4692 (format "Directory `%s' does not exist; create? " dir))
4693 (make-directory dir t)
4694 (error "Canceled")))
4695 (setq setmodes (basic-save-buffer-1))))
4696 ;; Now we have saved the current buffer. Let's make sure
4697 ;; that buffer-file-coding-system is fixed to what
4698 ;; actually used for saving by binding it locally.
4699 (if save-buffer-coding-system
4700 (setq save-buffer-coding-system last-coding-system-used)
4701 (setq buffer-file-coding-system last-coding-system-used))
4702 (setq buffer-file-number
4703 (nthcdr 10 (file-attributes buffer-file-name)))
4708 (with-demoted-errors
4709 (set-file-modes buffer-file-name (car setmodes)))
4710 (set-file-extended-attributes buffer-file-name
4713 ;; If the auto-save file was recent before this command,
4715 (delete-auto-save-file-if-necessary recent-save)
4716 ;; Support VC `implicit' locking.
4718 (run-hooks 'after-save-hook))
4719 (message "(No changes need to be saved)"))))
4721 ;; This does the "real job" of writing a buffer into its visited file
4722 ;; and making a backup file. This is what is normally done
4723 ;; but inhibited if one of write-file-functions returns non-nil.
4724 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4726 (defun basic-save-buffer-1 ()
4728 (if save-buffer-coding-system
4729 (let ((coding-system-for-write save-buffer-coding-system))
4730 (basic-save-buffer-2))
4731 (basic-save-buffer-2))
4732 (if buffer-file-coding-system-explicit
4733 (setcar buffer-file-coding-system-explicit last-coding-system-used))))
4735 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4737 (defun basic-save-buffer-2 ()
4738 (let (tempsetmodes setmodes writecoding)
4739 (if (not (file-writable-p buffer-file-name))
4740 (let ((dir (file-name-directory buffer-file-name)))
4741 (if (not (file-directory-p dir))
4742 (if (file-exists-p dir)
4743 (error "%s is not a directory" dir)
4744 (error "%s: no such directory" dir))
4745 (if (not (file-exists-p buffer-file-name))
4746 (error "Directory %s write-protected" dir)
4749 "File %s is write-protected; try to save anyway? "
4750 (file-name-nondirectory
4752 (setq tempsetmodes t)
4753 (error "Attempt to save to a file which you aren't allowed to write"))))))
4754 ;; This may involve prompting, so do it now before backing up the file.
4755 ;; Otherwise there can be a delay while the user answers the
4756 ;; prompt during which the original file has been renamed. (Bug#13522)
4758 ;; Args here should match write-region call below around
4759 ;; which we use writecoding.
4760 (choose-write-coding-system nil nil buffer-file-name nil t
4761 buffer-file-truename))
4762 (or buffer-backed-up
4763 (setq setmodes (backup-buffer)))
4764 (let* ((dir (file-name-directory buffer-file-name))
4765 (dir-writable (file-writable-p dir)))
4766 (if (or (and file-precious-flag dir-writable)
4767 (and break-hardlink-on-save
4768 (file-exists-p buffer-file-name)
4769 (> (file-nlinks buffer-file-name) 1)
4771 (error (concat (format
4772 "Directory %s write-protected; " dir)
4773 "cannot break hardlink when saving")))))
4774 ;; Write temp name, then rename it.
4775 ;; This requires write access to the containing dir,
4776 ;; which is why we don't try it if we don't have that access.
4777 (let ((realname buffer-file-name)
4779 (umask (default-file-modes))
4780 (old-modtime (visited-file-modtime)))
4781 ;; Create temp files with strict access rights. It's easy to
4782 ;; loosen them later, whereas it's impossible to close the
4783 ;; time-window of loose permissions otherwise.
4786 (clear-visited-file-modtime)
4787 (set-default-file-modes ?\700)
4788 ;; Try various temporary names.
4789 ;; This code follows the example of make-temp-file,
4790 ;; but it calls write-region in the appropriate way
4791 ;; for saving the buffer.
4792 (while (condition-case ()
4796 (expand-file-name "tmp" dir)))
4797 ;; Pass in nil&nil rather than point-min&max
4798 ;; cause we're saving the whole buffer.
4799 ;; write-region-annotate-functions may use it.
4800 (write-region nil nil
4801 tempname nil realname
4802 buffer-file-truename 'excl)
4804 (file-already-exists t))
4805 ;; The file was somehow created by someone else between
4806 ;; `make-temp-name' and `write-region', let's try again.
4810 (set-default-file-modes umask)
4811 ;; If we failed, restore the buffer's modtime.
4813 (set-visited-file-modtime old-modtime)))
4814 ;; Since we have created an entirely new file,
4815 ;; make sure it gets the right permission bits set.
4816 (setq setmodes (or setmodes
4817 (list (or (file-modes buffer-file-name)
4818 (logand ?\666 umask))
4819 (file-extended-attributes buffer-file-name)
4821 ;; We succeeded in writing the temp file,
4823 (rename-file tempname buffer-file-name t))
4824 ;; If file not writable, see if we can make it writable
4825 ;; temporarily while we write it.
4826 ;; But no need to do so if we have just backed it up
4827 ;; (setmodes is set) because that says we're superseding.
4828 (cond ((and tempsetmodes (not setmodes))
4829 ;; Change the mode back, after writing.
4830 (setq setmodes (list (file-modes buffer-file-name)
4831 (file-extended-attributes buffer-file-name)
4833 ;; If set-file-extended-attributes fails, fall back on
4836 (with-demoted-errors
4837 (set-file-extended-attributes buffer-file-name
4839 (set-file-modes buffer-file-name
4840 (logior (car setmodes) 128))))))
4843 ;; Pass in nil&nil rather than point-min&max to indicate
4844 ;; we're saving the buffer rather than just a region.
4845 ;; write-region-annotate-functions may make us of it.
4846 (let ((coding-system-for-write writecoding)
4847 (coding-system-require-warning nil))
4848 (write-region nil nil
4849 buffer-file-name nil t buffer-file-truename)
4851 ;; If we get an error writing the new file, and we made
4852 ;; the backup by renaming, undo the backing-up.
4853 (and setmodes (not success)
4855 (rename-file (nth 2 setmodes) buffer-file-name t)
4856 (setq buffer-backed-up nil))))))
4859 (declare-function diff-no-select "diff"
4860 (old new &optional switches no-async buf))
4862 (defvar save-some-buffers-action-alist
4865 (if (not enable-recursive-minibuffers)
4866 (progn (display-buffer buf)
4867 (setq other-window-scroll-buffer buf))
4868 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4870 ;; Return nil to ask about BUF again.
4872 ,(purecopy "view this buffer"))
4874 (if (null (buffer-file-name buf))
4875 (message "Not applicable: no file")
4876 (require 'diff) ;for diff-no-select.
4877 (let ((diffbuf (diff-no-select (buffer-file-name buf) buf
4879 (if (not enable-recursive-minibuffers)
4880 (progn (display-buffer diffbuf)
4881 (setq other-window-scroll-buffer diffbuf))
4882 (view-buffer diffbuf (lambda (_) (exit-recursive-edit)))
4884 ;; Return nil to ask about BUF again.
4886 ,(purecopy "view changes in this buffer")))
4887 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4888 (put 'save-some-buffers-action-alist 'risky-local-variable t)
4890 (defvar buffer-save-without-query nil
4891 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4892 (make-variable-buffer-local 'buffer-save-without-query)
4894 (defun save-some-buffers (&optional arg pred)
4895 "Save some modified file-visiting buffers. Asks user about each one.
4896 You can answer `y' to save, `n' not to save, `C-r' to look at the
4897 buffer in question with `view-buffer' before deciding or `d' to
4898 view the differences using `diff-buffer-with-file'.
4900 This command first saves any buffers where `buffer-save-without-query' is
4901 non-nil, without asking.
4903 Optional argument (the prefix) non-nil means save all with no questions.
4904 Optional second argument PRED determines which buffers are considered:
4905 If PRED is nil, all the file-visiting buffers are considered.
4906 If PRED is t, then certain non-file buffers will also be considered.
4907 If PRED is a zero-argument function, it indicates for each buffer whether
4908 to consider it or not when called with that buffer current.
4910 See `save-some-buffers-action-alist' if you want to
4911 change the additional actions you can take on files."
4913 (save-window-excursion
4914 (let* (queried autosaved-buffers
4915 files-done abbrevs-done)
4916 (dolist (buffer (buffer-list))
4917 ;; First save any buffers that we're supposed to save unconditionally.
4918 ;; That way the following code won't ask about them.
4919 (with-current-buffer buffer
4920 (when (and buffer-save-without-query (buffer-modified-p))
4921 (push (buffer-name) autosaved-buffers)
4923 ;; Ask about those buffers that merit it,
4924 ;; and record the number thus saved.
4928 ;; Note that killing some buffers may kill others via
4929 ;; hooks (e.g. Rmail and its viewing buffer).
4930 (and (buffer-live-p buffer)
4931 (buffer-modified-p buffer)
4932 (not (buffer-base-buffer buffer))
4934 (buffer-file-name buffer)
4938 (and buffer-offer-save (> (buffer-size) 0)))))
4939 (or (not (functionp pred))
4940 (with-current-buffer buffer (funcall pred)))
4944 (if (buffer-file-name buffer)
4945 (format "Save file %s? "
4946 (buffer-file-name buffer))
4947 (format "Save buffer %s? "
4948 (buffer-name buffer))))))
4950 (with-current-buffer buffer
4953 '("buffer" "buffers" "save")
4954 save-some-buffers-action-alist))
4955 ;; Maybe to save abbrevs, and record whether
4956 ;; we either saved them or asked to.
4957 (and save-abbrevs abbrevs-changed
4960 (eq save-abbrevs 'silently)
4961 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
4962 (write-abbrev-file nil))
4963 ;; Don't keep bothering user if he says no.
4964 (setq abbrevs-changed nil)
4965 (setq abbrevs-done t)))
4966 (or queried (> files-done 0) abbrevs-done
4968 ((null autosaved-buffers)
4969 (message "(No files need saving)"))
4970 ((= (length autosaved-buffers) 1)
4971 (message "(Saved %s)" (car autosaved-buffers)))
4973 (message "(Saved %d files: %s)"
4974 (length autosaved-buffers)
4975 (mapconcat 'identity autosaved-buffers ", "))))))))
4977 (defun clear-visited-file-modtime ()
4978 "Clear out records of last mod time of visited file.
4979 Next attempt to save will certainly not complain of a discrepancy."
4980 (set-visited-file-modtime 0))
4982 (defun not-modified (&optional arg)
4983 "Mark current buffer as unmodified, not needing to be saved.
4984 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4986 It is not a good idea to use this function in Lisp programs, because it
4987 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4988 (declare (interactive-only set-buffer-modified-p))
4990 (message (if arg "Modification-flag set"
4991 "Modification-flag cleared"))
4992 (set-buffer-modified-p arg))
4994 (defun toggle-read-only (&optional arg interactive)
4995 (declare (obsolete read-only-mode "24.3"))
4996 (interactive (list current-prefix-arg t))
4998 (call-interactively 'read-only-mode)
4999 (read-only-mode (or arg 'toggle))))
5001 (defun insert-file (filename)
5002 "Insert contents of file FILENAME into buffer after point.
5003 Set mark after the inserted text.
5005 This function is meant for the user to run interactively.
5006 Don't call it from programs! Use `insert-file-contents' instead.
5007 \(Its calling sequence is different; see its documentation)."
5008 (declare (interactive-only insert-file-contents))
5009 (interactive "*fInsert file: ")
5010 (insert-file-1 filename #'insert-file-contents))
5012 (defun append-to-file (start end filename)
5013 "Append the contents of the region to the end of file FILENAME.
5014 When called from a function, expects three arguments,
5015 START, END and FILENAME. START and END are normally buffer positions
5016 specifying the part of the buffer to write.
5017 If START is nil, that means to use the entire buffer contents.
5018 If START is a string, then output that string to the file
5019 instead of any buffer contents; END is ignored.
5021 This does character code conversion and applies annotations
5022 like `write-region' does."
5023 (interactive "r\nFAppend to file: ")
5024 (write-region start end filename t))
5026 (defun file-newest-backup (filename)
5027 "Return most recent backup file for FILENAME or nil if no backups exist."
5028 ;; `make-backup-file-name' will get us the right directory for
5029 ;; ordinary or numeric backups. It might create a directory for
5030 ;; backups as a side-effect, according to `backup-directory-alist'.
5031 (let* ((filename (file-name-sans-versions
5032 (make-backup-file-name (expand-file-name filename))))
5033 (file (file-name-nondirectory filename))
5034 (dir (file-name-directory filename))
5035 (comp (file-name-all-completions file dir))
5039 (setq tem (pop comp))
5040 (cond ((and (backup-file-name-p tem)
5041 (string= (file-name-sans-versions tem) file))
5042 (setq tem (concat dir tem))
5043 (if (or (null newest)
5044 (file-newer-than-file-p tem newest))
5045 (setq newest tem)))))
5048 (defun rename-uniquely ()
5049 "Rename current buffer to a similar name not already taken.
5050 This function is useful for creating multiple shell process buffers
5051 or multiple mail buffers, etc.
5053 Note that some commands, in particular those based on `compilation-mode'
5054 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5055 appropriate mode even if it has been renamed. So as well as renaming
5056 the buffer, you also need to switch buffers before running another
5057 instance of such commands."
5060 (let ((base-name (buffer-name)))
5061 (and (string-match "<[0-9]+>\\'" base-name)
5062 (not (and buffer-file-name
5064 (file-name-nondirectory buffer-file-name))))
5065 ;; If the existing buffer name has a <NNN>,
5066 ;; which isn't part of the file name (if any),
5067 ;; then get rid of that.
5068 (setq base-name (substring base-name 0 (match-beginning 0))))
5069 (rename-buffer (generate-new-buffer-name base-name))
5070 (force-mode-line-update))))
5072 (defun make-directory (dir &optional parents)
5073 "Create the directory DIR and optionally any nonexistent parent dirs.
5074 If DIR already exists as a directory, signal an error, unless
5077 Interactively, the default choice of directory to create is the
5078 current buffer's default directory. That is useful when you have
5079 visited a file in a nonexistent directory.
5081 Noninteractively, the second (optional) argument PARENTS, if
5082 non-nil, says whether to create parent directories that don't
5083 exist. Interactively, this happens by default.
5085 If creating the directory or directories fail, an error will be
5088 (list (read-file-name "Make directory: " default-directory default-directory
5091 ;; If default-directory is a remote directory,
5092 ;; make sure we find its make-directory handler.
5093 (setq dir (expand-file-name dir))
5094 (let ((handler (find-file-name-handler dir 'make-directory)))
5096 (funcall handler 'make-directory dir parents)
5098 (make-directory-internal dir)
5099 (let ((dir (directory-file-name (expand-file-name dir)))
5101 (while (and (not (file-exists-p dir))
5102 ;; If directory is its own parent, then we can't
5103 ;; keep looping forever
5105 (directory-file-name
5106 (file-name-directory dir)))))
5107 (setq create-list (cons dir create-list)
5108 dir (directory-file-name (file-name-directory dir))))
5110 (make-directory-internal (car create-list))
5111 (setq create-list (cdr create-list))))))))
5113 (defconst directory-files-no-dot-files-regexp
5114 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
5115 "Regexp matching any file name except \".\" and \"..\".")
5117 (defun delete-directory (directory &optional recursive trash)
5118 "Delete the directory named DIRECTORY. Does not follow symlinks.
5119 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5120 TRASH non-nil means to trash the directory instead, provided
5121 `delete-by-moving-to-trash' is non-nil.
5123 When called interactively, TRASH is t if no prefix argument is
5124 given. With a prefix argument, TRASH is nil."
5126 (let* ((trashing (and delete-by-moving-to-trash
5127 (null current-prefix-arg)))
5128 (dir (expand-file-name
5129 (read-directory-name
5131 "Move directory to trash: "
5132 "Delete directory: ")
5133 default-directory default-directory nil nil))))
5135 (if (directory-files dir nil directory-files-no-dot-files-regexp)
5137 (format "Directory `%s' is not empty, really %s? "
5138 dir (if trashing "trash" "delete")))
5140 (null current-prefix-arg))))
5141 ;; If default-directory is a remote directory, make sure we find its
5142 ;; delete-directory handler.
5143 (setq directory (directory-file-name (expand-file-name directory)))
5144 (let ((handler (find-file-name-handler directory 'delete-directory)))
5147 (funcall handler 'delete-directory directory recursive))
5148 ((and delete-by-moving-to-trash trash)
5149 ;; Only move non-empty dir to trash if recursive deletion was
5150 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5151 ;; case, where the operation fails in delete-directory-internal.
5152 ;; As `move-file-to-trash' trashes directories (empty or
5153 ;; otherwise) as a unit, we do not need to recurse here.
5154 (if (and (not recursive)
5155 ;; Check if directory is empty apart from "." and "..".
5157 directory 'full directory-files-no-dot-files-regexp))
5158 (error "Directory is not empty, not moving to trash")
5159 (move-file-to-trash directory)))
5160 ;; Otherwise, call ourselves recursively if needed.
5162 (if (and recursive (not (file-symlink-p directory)))
5163 (mapc (lambda (file)
5164 ;; This test is equivalent to
5165 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5166 ;; but more efficient
5167 (if (eq t (car (file-attributes file)))
5168 (delete-directory file recursive nil)
5169 (delete-file file nil)))
5170 ;; We do not want to delete "." and "..".
5172 directory 'full directory-files-no-dot-files-regexp)))
5173 (delete-directory-internal directory)))))
5175 (defun file-equal-p (file1 file2)
5176 "Return non-nil if files FILE1 and FILE2 name the same file.
5177 If FILE1 or FILE2 does not exist, the return value is unspecified."
5178 (let ((handler (or (find-file-name-handler file1 'file-equal-p)
5179 (find-file-name-handler file2 'file-equal-p))))
5181 (funcall handler 'file-equal-p file1 file2)
5182 (let (f1-attr f2-attr)
5183 (and (setq f1-attr (file-attributes (file-truename file1)))
5184 (setq f2-attr (file-attributes (file-truename file2)))
5185 (equal f1-attr f2-attr))))))
5187 (defun file-in-directory-p (file dir)
5188 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5189 A directory is considered to be \"in\" itself.
5190 Return nil if DIR is not an existing directory."
5191 (let ((handler (or (find-file-name-handler file 'file-in-directory-p)
5192 (find-file-name-handler dir 'file-in-directory-p))))
5194 (funcall handler 'file-in-directory-p file dir)
5195 (when (file-directory-p dir) ; DIR must exist.
5196 (setq file (file-truename file)
5197 dir (file-truename dir))
5198 (let ((ls1 (split-string file "/" t))
5199 (ls2 (split-string dir "/" t))
5200 (root (if (string-match "\\`/" file) "/" ""))
5202 (while (and ls1 ls2 (not mismatch))
5203 (if (string-equal (car ls1) (car ls2))
5204 (setq root (concat root (car ls1) "/"))
5209 (file-equal-p root dir)))))))
5211 (defun copy-directory (directory newname &optional keep-time parents copy-contents)
5212 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5213 This function always sets the file modes of the output files to match
5214 the corresponding input file.
5216 The third arg KEEP-TIME non-nil means give the output files the same
5217 last-modified time as the old ones. (This works on only some systems.)
5219 A prefix arg makes KEEP-TIME non-nil.
5221 Noninteractively, the last argument PARENTS says whether to
5222 create parent directories if they don't exist. Interactively,
5223 this happens by default.
5225 If NEWNAME names an existing directory, copy DIRECTORY as a
5226 subdirectory there. However, if called from Lisp with a non-nil
5227 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5228 directly into NEWNAME instead."
5230 (let ((dir (read-directory-name
5231 "Copy directory: " default-directory default-directory t nil)))
5233 (read-directory-name
5234 (format "Copy directory %s to: " dir)
5235 default-directory default-directory nil nil)
5236 current-prefix-arg t nil)))
5237 (when (file-in-directory-p newname directory)
5238 (error "Cannot copy `%s' into its subdirectory `%s'"
5240 ;; If default-directory is a remote directory, make sure we find its
5241 ;; copy-directory handler.
5242 (let ((handler (or (find-file-name-handler directory 'copy-directory)
5243 (find-file-name-handler newname 'copy-directory))))
5245 (funcall handler 'copy-directory directory
5246 newname keep-time parents copy-contents)
5248 ;; Compute target name.
5249 (setq directory (directory-file-name (expand-file-name directory))
5250 newname (directory-file-name (expand-file-name newname)))
5252 (cond ((not (file-directory-p newname))
5253 ;; If NEWNAME is not an existing directory, create it;
5254 ;; that is where we will copy the files of DIRECTORY.
5255 (make-directory newname parents))
5256 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5257 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5258 ((not copy-contents)
5259 (setq newname (expand-file-name
5260 (file-name-nondirectory
5261 (directory-file-name directory))
5263 (and (file-exists-p newname)
5264 (not (file-directory-p newname))
5265 (error "Cannot overwrite non-directory %s with a directory"
5267 (make-directory newname t)))
5269 ;; Copy recursively.
5271 ;; We do not want to copy "." and "..".
5272 (directory-files directory 'full
5273 directory-files-no-dot-files-regexp))
5274 (let ((target (expand-file-name (file-name-nondirectory file) newname))
5275 (filetype (car (file-attributes file))))
5277 ((eq filetype t) ; Directory but not a symlink.
5278 (copy-directory file newname keep-time parents))
5279 ((stringp filetype) ; Symbolic link
5280 (make-symbolic-link filetype target t))
5281 ((copy-file file target t keep-time)))))
5283 ;; Set directory attributes.
5284 (let ((modes (file-modes directory))
5285 (times (and keep-time (nth 5 (file-attributes directory)))))
5286 (if modes (set-file-modes newname modes))
5287 (if times (set-file-times newname times))))))
5290 ;; At time of writing, only info uses this.
5291 (defun prune-directory-list (dirs &optional keep reject)
5292 "Return a copy of DIRS with all non-existent directories removed.
5293 The optional argument KEEP is a list of directories to retain even if
5294 they don't exist, and REJECT is a list of directories to remove from
5295 DIRS, even if they exist; REJECT takes precedence over KEEP.
5297 Note that membership in REJECT and KEEP is checked using simple string
5300 (mapcar (lambda (dir)
5301 (and (not (member dir reject))
5302 (or (member dir keep) (file-directory-p dir))
5307 (put 'revert-buffer-function 'permanent-local t)
5308 (defvar revert-buffer-function #'revert-buffer--default
5309 "Function to use to revert this buffer.
5310 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5311 which are the arguments that `revert-buffer' received.
5312 It also has access to the `preserve-modes' argument of `revert-buffer'
5313 via the `revert-buffer-preserve-modes' dynamic variable.
5315 For historical reasons, a value of nil means to use the default function.
5316 This should not be relied upon.")
5318 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
5319 (defvar revert-buffer-insert-file-contents-function
5320 #'revert-buffer-insert-file-contents--default-function
5321 "Function to use to insert contents when reverting this buffer.
5322 The function receives two arguments: the first the nominal file name to use;
5323 the second is t if reading the auto-save file.
5325 The function is responsible for updating (or preserving) point.
5327 For historical reasons, a value of nil means to use the default function.
5328 This should not be relied upon.")
5330 (defun buffer-stale--default-function (&optional _noconfirm)
5331 "Default function to use for `buffer-stale-function'.
5332 This function ignores its argument.
5333 This returns non-nil if the current buffer is visiting a readable file
5334 whose modification time does not match that of the buffer.
5336 This function only handles buffers that are visiting files.
5337 Non-file buffers need a custom function"
5338 (and buffer-file-name
5339 (file-readable-p buffer-file-name)
5340 (not (verify-visited-file-modtime (current-buffer)))))
5342 (defvar buffer-stale-function #'buffer-stale--default-function
5343 "Function to check whether a buffer needs reverting.
5344 This should be a function with one optional argument NOCONFIRM.
5345 Auto Revert Mode passes t for NOCONFIRM. The function should return
5346 non-nil if the buffer should be reverted. A return value of
5347 `fast' means that the need for reverting was not checked, but
5348 that reverting the buffer is fast. The buffer is current when
5349 this function is called.
5351 The idea behind the NOCONFIRM argument is that it should be
5352 non-nil if the buffer is going to be reverted without asking the
5353 user. In such situations, one has to be careful with potentially
5354 time consuming operations.
5356 For historical reasons, a value of nil means to use the default function.
5357 This should not be relied upon.
5359 For more information on how this variable is used by Auto Revert mode,
5360 see Info node `(emacs)Supporting additional buffers'.")
5362 (defvar before-revert-hook nil
5363 "Normal hook for `revert-buffer' to run before reverting.
5364 The function `revert-buffer--default' runs this.
5365 A customized `revert-buffer-function' need not run this hook.")
5367 (defvar after-revert-hook nil
5368 "Normal hook for `revert-buffer' to run after reverting.
5369 Note that the hook value that it runs is the value that was in effect
5370 before reverting; that makes a difference if you have buffer-local
5373 The function `revert-buffer--default' runs this.
5374 A customized `revert-buffer-function' need not run this hook.")
5376 (defvar revert-buffer-in-progress-p nil
5377 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.")
5379 (defvar revert-buffer-internal-hook)
5381 ;; `revert-buffer-function' was defined long ago to be a function of only
5382 ;; 2 arguments, so we have to use a dynbind variable to pass the
5383 ;; `preserve-modes' argument of `revert-buffer'.
5384 (defvar revert-buffer-preserve-modes)
5386 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
5387 "Replace current buffer text with the text of the visited file on disk.
5388 This undoes all changes since the file was visited or saved.
5389 With a prefix argument, offer to revert from latest auto-save file, if
5390 that is more recent than the visited file.
5392 This command also implements an interface for special buffers
5393 that contain text which doesn't come from a file, but reflects
5394 some other data instead (e.g. Dired buffers, `buffer-list'
5395 buffers). This is done via the variable `revert-buffer-function'.
5396 In these cases, it should reconstruct the buffer contents from the
5399 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5400 to revert from the auto-save file when this is nil. Note that the
5401 sense of this argument is the reverse of the prefix argument, for the
5402 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5405 Optional second argument NOCONFIRM means don't ask for confirmation
5406 at all. (The variable `revert-without-query' offers another way to
5407 revert buffers without querying for confirmation.)
5409 Optional third argument PRESERVE-MODES non-nil means don't alter
5410 the files modes. Normally we reinitialize them using `normal-mode'.
5412 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5414 This function calls the function that `revert-buffer-function' specifies
5415 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5416 The default function runs the hooks `before-revert-hook' and
5417 `after-revert-hook'."
5418 ;; I admit it's odd to reverse the sense of the prefix argument, but
5419 ;; there is a lot of code out there which assumes that the first
5420 ;; argument should be t to avoid consulting the auto-save file, and
5421 ;; there's no straightforward way to encourage authors to notice a
5422 ;; reversal of the argument sense. So I'm just changing the user
5423 ;; interface, but leaving the programmatic interface the same.
5424 (interactive (list (not current-prefix-arg)))
5425 (let ((revert-buffer-in-progress-p t)
5426 (revert-buffer-preserve-modes preserve-modes))
5427 (funcall (or revert-buffer-function #'revert-buffer--default)
5428 ignore-auto noconfirm)))
5430 (defun revert-buffer--default (ignore-auto noconfirm)
5431 "Default function for `revert-buffer'.
5432 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5433 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5436 Calls `revert-buffer-insert-file-contents-function' to reread the
5437 contents of the visited file, with two arguments: the first is the file
5438 name, the second is non-nil if reading an auto-save file.
5440 This function only handles buffers that are visiting files.
5441 Non-file buffers need a custom function."
5442 (with-current-buffer (or (buffer-base-buffer (current-buffer))
5444 (let* ((auto-save-p (and (not ignore-auto)
5445 (recent-auto-save-p)
5446 buffer-auto-save-file-name
5447 (file-readable-p buffer-auto-save-file-name)
5449 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
5450 (file-name (if auto-save-p
5451 buffer-auto-save-file-name
5453 (cond ((null file-name)
5454 (error "Buffer does not seem to be associated with any file"))
5456 (and (not (buffer-modified-p))
5458 (dolist (regexp revert-without-query)
5459 (when (string-match regexp file-name)
5460 (throw 'found t)))))
5461 (yes-or-no-p (format "Revert buffer from file %s? "
5463 (run-hooks 'before-revert-hook)
5464 ;; If file was backed up but has changed since,
5465 ;; we should make another backup.
5466 (and (not auto-save-p)
5467 (not (verify-visited-file-modtime (current-buffer)))
5468 (setq buffer-backed-up nil))
5469 ;; Effectively copy the after-revert-hook status,
5470 ;; since after-find-file will clobber it.
5471 (let ((global-hook (default-value 'after-revert-hook))
5472 (local-hook (when (local-variable-p 'after-revert-hook)
5474 (inhibit-read-only t))
5475 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5477 (or revert-buffer-insert-file-contents-function
5478 #'revert-buffer-insert-file-contents--default-function)
5479 file-name auto-save-p)
5480 ;; Recompute the truename in case changes in symlinks
5481 ;; have changed the truename.
5482 (setq buffer-file-truename
5483 (abbreviate-file-name (file-truename buffer-file-name)))
5484 (after-find-file nil nil t nil revert-buffer-preserve-modes)
5485 ;; Run after-revert-hook as it was before we reverted.
5486 (setq-default revert-buffer-internal-hook global-hook)
5488 (set (make-local-variable 'revert-buffer-internal-hook)
5490 (kill-local-variable 'revert-buffer-internal-hook))
5491 (run-hooks 'revert-buffer-internal-hook))
5494 (defun revert-buffer-insert-file-contents--default-function (file-name auto-save-p)
5495 "Default function for `revert-buffer-insert-file-contents-function'.
5496 The function `revert-buffer--default' calls this.
5497 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5500 ((not (file-exists-p file-name))
5501 (error (if buffer-file-number
5502 "File %s no longer exists!"
5503 "Cannot revert nonexistent file %s")
5505 ((not (file-readable-p file-name))
5506 (error (if buffer-file-number
5507 "File %s no longer readable!"
5508 "Cannot revert unreadable file %s")
5511 ;; Bind buffer-file-name to nil
5512 ;; so that we don't try to lock the file.
5513 (let ((buffer-file-name nil))
5517 (let ((coding-system-for-read
5518 ;; Auto-saved file should be read by Emacs's
5520 (if auto-save-p 'auto-save-coding
5521 (or coding-system-for-read
5523 buffer-file-coding-system-explicit
5524 (car buffer-file-coding-system-explicit))))))
5525 (if (and (not enable-multibyte-characters)
5526 coding-system-for-read
5527 (not (memq (coding-system-base
5528 coding-system-for-read)
5529 '(no-conversion raw-text))))
5530 ;; As a coding system suitable for multibyte
5531 ;; buffer is specified, make the current
5532 ;; buffer multibyte.
5533 (set-buffer-multibyte t))
5535 ;; This force after-insert-file-set-coding
5536 ;; (called from insert-file-contents) to set
5537 ;; buffer-file-coding-system to a proper value.
5538 (kill-local-variable 'buffer-file-coding-system)
5540 ;; Note that this preserves point in an intelligent way.
5541 (if revert-buffer-preserve-modes
5542 (let ((buffer-file-format buffer-file-format))
5543 (insert-file-contents file-name (not auto-save-p)
5545 (insert-file-contents file-name (not auto-save-p)
5548 (defun recover-this-file ()
5549 "Recover the visited file--get contents from its last auto-save file."
5551 (recover-file buffer-file-name))
5553 (defun recover-file (file)
5554 "Visit file FILE, but get contents from its last auto-save file."
5555 ;; Actually putting the file name in the minibuffer should be used
5557 ;; Not just because users often use the default.
5558 (interactive "FRecover file: ")
5559 (setq file (expand-file-name file))
5560 (if (auto-save-file-name-p (file-name-nondirectory file))
5561 (error "%s is an auto-save file" (abbreviate-file-name file)))
5562 (let ((file-name (let ((buffer-file-name file))
5563 (make-auto-save-file-name))))
5564 (cond ((if (file-exists-p file)
5565 (not (file-newer-than-file-p file-name file))
5566 (not (file-exists-p file-name)))
5567 (error "Auto-save file %s not current"
5568 (abbreviate-file-name file-name)))
5569 ((with-temp-buffer-window
5571 #'(lambda (window _value)
5572 (with-selected-window window
5574 (yes-or-no-p (format "Recover auto save file %s? " file-name))
5575 (when (window-live-p window)
5576 (quit-restore-window window 'kill)))))
5577 (with-current-buffer standard-output
5578 (let ((switches dired-listing-switches))
5579 (if (file-symlink-p file)
5580 (setq switches (concat switches " -L")))
5581 ;; Use insert-directory-safely, not insert-directory,
5582 ;; because these files might not exist. In particular,
5583 ;; FILE might not exist if the auto-save file was for
5584 ;; a buffer that didn't visit a file, such as "*mail*".
5585 ;; The code in v20.x called `ls' directly, so we need
5586 ;; to emulate what `ls' did in that case.
5587 (insert-directory-safely file switches)
5588 (insert-directory-safely file-name switches))))
5589 (switch-to-buffer (find-file-noselect file t))
5590 (let ((inhibit-read-only t)
5591 ;; Keep the current buffer-file-coding-system.
5592 (coding-system buffer-file-coding-system)
5593 ;; Auto-saved file should be read with special coding.
5594 (coding-system-for-read 'auto-save-coding))
5596 (insert-file-contents file-name nil)
5597 (set-buffer-file-coding-system coding-system))
5598 (after-find-file nil nil t))
5599 (t (user-error "Recover-file canceled")))))
5601 (defun recover-session ()
5602 "Recover auto save files from a previous Emacs session.
5603 This command first displays a Dired buffer showing you the
5604 previous sessions that you could recover from.
5605 To choose one, move point to the proper line and then type C-c C-c.
5606 Then you'll be asked about a number of files to recover."
5608 (if (null auto-save-list-file-prefix)
5609 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5610 (let ((dir (file-name-directory auto-save-list-file-prefix)))
5611 (unless (file-directory-p dir)
5612 (make-directory dir t))
5613 (unless (directory-files dir nil
5614 (concat "\\`" (regexp-quote
5615 (file-name-nondirectory
5616 auto-save-list-file-prefix)))
5618 (error "No previous sessions to recover")))
5619 (let ((ls-lisp-support-shell-wildcards t))
5620 (dired (concat auto-save-list-file-prefix "*")
5621 (concat dired-listing-switches " -t")))
5622 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5623 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish)
5625 (goto-char (point-min))
5626 (or (looking-at " Move to the session you want to recover,")
5627 (let ((inhibit-read-only t))
5628 ;; Each line starts with a space
5629 ;; so that Font Lock mode won't highlight the first character.
5630 (insert " To recover a session, move to it and type C-c C-c.\n"
5631 (substitute-command-keys
5632 " To delete a session file, type \
5633 \\[dired-flag-file-deletion] on its line to flag
5634 the file for deletion, then \\[dired-do-flagged-delete] to \
5635 delete flagged files.\n\n"))))))
5637 (defun recover-session-finish ()
5638 "Choose one saved session to recover auto-save files from.
5639 This command is used in the special Dired buffer created by
5640 \\[recover-session]."
5642 ;; Get the name of the session file to recover from.
5643 (let ((file (dired-get-filename))
5645 (buffer (get-buffer-create " *recover*")))
5647 (dired-do-flagged-delete t)
5649 (with-current-buffer buffer
5650 ;; Read in the auto-save-list file.
5652 (insert-file-contents file)
5653 ;; Loop thru the text of that file
5654 ;; and get out the names of the files to recover.
5656 (let (thisfile autofile)
5658 ;; This is a pair of lines for a non-file-visiting buffer.
5659 ;; Get the auto-save file name and manufacture
5660 ;; a "visited file name" from that.
5663 ;; If there is no auto-save file name, the
5664 ;; auto-save-list file is probably corrupted.
5667 (buffer-substring-no-properties
5669 (line-end-position)))
5673 (file-name-nondirectory autofile)
5675 (file-name-directory autofile))))
5677 ;; This pair of lines is a file-visiting
5678 ;; buffer. Use the visited file name.
5681 (buffer-substring-no-properties
5682 (point) (progn (end-of-line) (point))))
5685 (buffer-substring-no-properties
5686 (point) (progn (end-of-line) (point))))
5688 ;; Ignore a file if its auto-save file does not exist now.
5689 (if (and autofile (file-exists-p autofile))
5690 (setq files (cons thisfile files)))))
5691 (setq files (nreverse files))
5692 ;; The file contains a pair of line for each auto-saved buffer.
5693 ;; The first line of the pair contains the visited file name
5694 ;; or is empty if the buffer was not visiting a file.
5695 ;; The second line is the auto-save file name.
5697 (map-y-or-n-p "Recover %s? "
5700 (save-excursion (recover-file file))
5702 "Failed to recover `%s'" file)))
5704 '("file" "files" "recover"))
5705 (message "No files can be recovered from this session now")))
5706 (kill-buffer buffer))))
5708 (defun kill-buffer-ask (buffer)
5709 "Kill BUFFER if confirmed."
5710 (when (yes-or-no-p (format "Buffer %s %s. Kill? "
5711 (buffer-name buffer)
5712 (if (buffer-modified-p buffer)
5713 "HAS BEEN EDITED" "is unmodified")))
5714 (kill-buffer buffer)))
5716 (defun kill-some-buffers (&optional list)
5717 "Kill some buffers. Asks the user whether to kill each one of them.
5718 Non-interactively, if optional argument LIST is non-nil, it
5719 specifies the list of buffers to kill, asking for approval for each one."
5722 (setq list (buffer-list)))
5724 (let* ((buffer (car list))
5725 (name (buffer-name buffer)))
5726 (and name ; Can be nil for an indirect buffer
5727 ; if we killed the base buffer.
5728 (not (string-equal name ""))
5729 (/= (aref name 0) ?\s)
5730 (kill-buffer-ask buffer)))
5731 (setq list (cdr list))))
5733 (defun kill-matching-buffers (regexp &optional internal-too)
5734 "Kill buffers whose name matches the specified REGEXP.
5735 The optional second argument indicates whether to kill internal buffers too."
5736 (interactive "sKill buffers matching this regular expression: \nP")
5737 (dolist (buffer (buffer-list))
5738 (let ((name (buffer-name buffer)))
5739 (when (and name (not (string-equal name ""))
5740 (or internal-too (/= (aref name 0) ?\s))
5741 (string-match regexp name))
5742 (kill-buffer-ask buffer)))))
5745 (defun rename-auto-save-file ()
5746 "Adjust current buffer's auto save file name for current conditions.
5747 Also rename any existing auto save file, if it was made in this session."
5748 (let ((osave buffer-auto-save-file-name))
5749 (setq buffer-auto-save-file-name
5750 (make-auto-save-file-name))
5751 (if (and osave buffer-auto-save-file-name
5752 (not (string= buffer-auto-save-file-name buffer-file-name))
5753 (not (string= buffer-auto-save-file-name osave))
5754 (file-exists-p osave)
5755 (recent-auto-save-p))
5756 (rename-file osave buffer-auto-save-file-name t))))
5758 (defun make-auto-save-file-name ()
5759 "Return file name to use for auto-saves of current buffer.
5760 Does not consider `auto-save-visited-file-name' as that variable is checked
5761 before calling this function. You can redefine this for customization.
5762 See also `auto-save-file-name-p'."
5763 (if buffer-file-name
5764 (let ((handler (find-file-name-handler buffer-file-name
5765 'make-auto-save-file-name)))
5767 (funcall handler 'make-auto-save-file-name)
5768 (let ((list auto-save-file-name-transforms)
5769 (filename buffer-file-name)
5771 ;; Apply user-specified translations
5772 ;; to the file name.
5773 (while (and list (not result))
5774 (if (string-match (car (car list)) filename)
5775 (setq result (replace-match (cadr (car list)) t nil
5777 uniq (car (cddr (car list)))))
5778 (setq list (cdr list)))
5781 (setq filename (concat
5782 (file-name-directory result)
5783 (subst-char-in-string
5785 (replace-regexp-in-string "!" "!!"
5787 (setq filename result)))
5789 (if (and (eq system-type 'ms-dos)
5790 (not (msdos-long-file-names)))
5791 ;; We truncate the file name to DOS 8+3 limits
5792 ;; before doing anything else, because the regexp
5793 ;; passed to string-match below cannot handle
5794 ;; extensions longer than 3 characters, multiple
5795 ;; dots, and other atrocities.
5796 (let ((fn (dos-8+3-filename
5797 (file-name-nondirectory buffer-file-name))))
5799 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5801 (concat (file-name-directory buffer-file-name)
5802 "#" (match-string 1 fn)
5803 "." (match-string 3 fn) "#"))
5804 (concat (file-name-directory filename)
5806 (file-name-nondirectory filename)
5808 ;; Make sure auto-save file names don't contain characters
5809 ;; invalid for the underlying filesystem.
5810 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5811 ;; Don't modify remote (ange-ftp) filenames
5812 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
5813 (convert-standard-filename result)
5816 ;; Deal with buffers that don't have any associated files. (Mail
5817 ;; mode tends to create a good number of these.)
5819 (let ((buffer-name (buffer-name))
5822 ;; Restrict the characters used in the file name to those which
5823 ;; are known to be safe on all filesystems, url-encoding the
5825 ;; We do this on all platforms, because even if we are not
5826 ;; running on DOS/Windows, the current directory may be on a
5827 ;; mounted VFAT filesystem, such as a USB memory stick.
5828 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
5829 (let* ((character (aref buffer-name (match-beginning 0)))
5831 ;; For multibyte characters, this will produce more than
5832 ;; 2 hex digits, so is not true URL encoding.
5833 (format "%%%02X" character)))
5834 (setq buffer-name (replace-match replacement t t buffer-name))
5835 (setq limit (1+ (match-end 0)))))
5836 ;; Generate the file name.
5841 (format "#%s#" buffer-name)
5842 ;; Try a few alternative directories, to get one we can
5845 ((file-writable-p default-directory) default-directory)
5846 ((file-writable-p "/var/tmp/") "/var/tmp/")
5848 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5849 ;; Don't modify remote (ange-ftp) filenames
5850 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5851 ;; The call to convert-standard-filename is in case
5852 ;; buffer-name includes characters not allowed by the
5853 ;; DOS/Windows filesystems. make-temp-file writes to the
5854 ;; file it creates, so we must fix the file name _before_
5855 ;; make-temp-file is called.
5856 (convert-standard-filename fname)
5859 ;; make-temp-file creates the file,
5860 ;; but we don't want it to exist until we do an auto-save.
5862 (delete-file file-name)
5866 (defun auto-save-file-name-p (filename)
5867 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5868 FILENAME should lack slashes. You can redefine this for customization."
5869 (string-match "\\`#.*#\\'" filename))
5871 (defun wildcard-to-regexp (wildcard)
5872 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5873 The generated regexp will match a filename only if the filename
5874 matches that wildcard according to shell rules. Only wildcards known
5875 by `sh' are supported."
5876 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5877 ;; Copy the initial run of non-special characters.
5878 (result (substring wildcard 0 i))
5879 (len (length wildcard)))
5880 ;; If no special characters, we're almost done.
5883 (let ((ch (aref wildcard i))
5891 (eq (aref wildcard (1+ i)) ?\]))
5893 ((eq ch ?\[) ; [...] maps to regexp char class
5898 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5901 (if (eq (aref wildcard i) ?\])
5906 ((eq (aref wildcard i) ?^)
5907 ;; Found "[^". Insert a `\0' character
5908 ;; (which cannot happen in a filename)
5909 ;; into the character class, so that `^'
5910 ;; is not the first character after `[',
5911 ;; and thus non-special in a regexp.
5915 ((eq (aref wildcard i) ?\])
5916 ;; I don't think `]' can appear in a
5917 ;; character class in a wildcard, but
5918 ;; let's be general here.
5923 (prog1 ; copy everything upto next `]'.
5926 (setq j (string-match
5928 (setq i (if j (1- j) (1- len)))))))
5930 ((eq ch ?*) "[^\000]*")
5934 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5935 ((eq ch ??) "[^\000]")
5936 (t (char-to-string ch)))))
5938 ;; Shell wildcards should match the entire filename,
5939 ;; not its part. Make the regexp say so.
5940 (concat "\\`" result "\\'")))
5942 (defcustom list-directory-brief-switches
5944 "Switches for `list-directory' to pass to `ls' for brief listing."
5948 (defcustom list-directory-verbose-switches
5950 "Switches for `list-directory' to pass to `ls' for verbose listing."
5954 (defun file-expand-wildcards (pattern &optional full)
5955 "Expand wildcard pattern PATTERN.
5956 This returns a list of file names which match the pattern.
5958 If PATTERN is written as an absolute file name,
5959 the values are absolute also.
5961 If PATTERN is written as a relative file name, it is interpreted
5962 relative to the current default directory, `default-directory'.
5963 The file names returned are normally also relative to the current
5964 default directory. However, if FULL is non-nil, they are absolute."
5966 (let* ((nondir (file-name-nondirectory pattern))
5967 (dirpart (file-name-directory pattern))
5968 ;; A list of all dirs that DIRPART specifies.
5969 ;; This can be more than one dir
5970 ;; if DIRPART contains wildcards.
5971 (dirs (if (and dirpart
5972 (string-match "[[*?]"
5973 (or (file-remote-p dirpart 'localname)
5975 (mapcar 'file-name-as-directory
5976 (file-expand-wildcards (directory-file-name dirpart)))
5980 (when (or (null dir) ; Possible if DIRPART is not wild.
5981 (file-accessible-directory-p dir))
5982 (let ((this-dir-contents
5983 ;; Filter out "." and ".."
5985 (mapcar #'(lambda (name)
5986 (unless (string-match "\\`\\.\\.?\\'"
5987 (file-name-nondirectory name))
5989 (directory-files (or dir ".") full
5990 (wildcard-to-regexp nondir))))))
5993 (if (and dir (not full))
5994 (mapcar #'(lambda (name) (concat dir name))
6000 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6001 (provide 'files '(remote-wildcards))
6003 (defun list-directory (dirname &optional verbose)
6004 "Display a list of files in or matching DIRNAME, a la `ls'.
6005 DIRNAME is globbed by the shell if necessary.
6006 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6007 Actions controlled by variables `list-directory-brief-switches'
6008 and `list-directory-verbose-switches'."
6009 (interactive (let ((pfx current-prefix-arg))
6010 (list (read-directory-name (if pfx "List directory (verbose): "
6011 "List directory (brief): ")
6012 nil default-directory nil)
6014 (let ((switches (if verbose list-directory-verbose-switches
6015 list-directory-brief-switches))
6017 (or dirname (setq dirname default-directory))
6018 (setq dirname (expand-file-name dirname))
6019 (with-output-to-temp-buffer "*Directory*"
6020 (setq buffer standard-output)
6021 (buffer-disable-undo standard-output)
6022 (princ "Directory ")
6025 (with-current-buffer "*Directory*"
6026 (let ((wildcard (not (file-directory-p dirname))))
6027 (insert-directory dirname switches wildcard (not wildcard)))))
6028 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6029 (with-current-buffer buffer
6030 (setq default-directory
6031 (if (file-directory-p dirname)
6032 (file-name-as-directory dirname)
6033 (file-name-directory dirname))))))
6035 (defun shell-quote-wildcard-pattern (pattern)
6036 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6038 PATTERN is assumed to represent a file-name wildcard suitable for the
6039 underlying filesystem. For Unix and GNU/Linux, each character from the
6040 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
6041 the parts of the pattern which don't include wildcard characters are
6042 quoted with double quotes.
6044 This function leaves alone existing quote characters (\\ on Unix and \"
6045 on Windows), so PATTERN can use them to quote wildcard characters that
6046 need to be passed verbatim to shell commands."
6049 ((memq system-type '(ms-dos windows-nt cygwin))
6050 ;; DOS/Windows don't allow `"' in file names. So if the
6051 ;; argument has quotes, we can safely assume it is already
6052 ;; quoted by the caller.
6053 (if (or (string-match "[\"]" pattern)
6054 ;; We quote [&()#$'] in case their shell is a port of a
6055 ;; Unixy shell. We quote [,=+] because stock DOS and
6056 ;; Windows shells require that in some cases, such as
6057 ;; passing arguments to batch files that use positional
6058 ;; arguments like %1.
6059 (not (string-match "[ \t;&()#$',=+]" pattern)))
6064 (while (string-match "[*?]+" pattern beg)
6065 (setq end (match-beginning 0)
6066 result (concat result (substring pattern beg end)
6068 (substring pattern end (match-end 0))
6071 (concat result (substring pattern beg) "\""))))
6074 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
6076 (concat (substring pattern 0 (match-beginning 0))
6078 (substring pattern (match-beginning 0)))
6079 beg (1+ (match-end 0)))))
6083 (defvar insert-directory-program (purecopy "ls")
6084 "Absolute or relative name of the `ls' program used by `insert-directory'.")
6086 (defcustom directory-free-space-program (purecopy "df")
6087 "Program to get the amount of free space on a file system.
6088 We assume the output has the format of `df'.
6089 The value of this variable must be just a command name or file name;
6090 if you want to specify options, use `directory-free-space-args'.
6092 A value of nil disables this feature.
6094 If the function `file-system-info' is defined, it is always used in
6095 preference to the program given by this variable."
6096 :type '(choice (string :tag "Program") (const :tag "None" nil))
6099 (defcustom directory-free-space-args
6100 (purecopy (if (eq system-type 'darwin) "-k" "-Pk"))
6101 "Options to use when running `directory-free-space-program'."
6105 (defun get-free-disk-space (dir)
6106 "Return the amount of free space on directory DIR's file system.
6107 The return value is a string describing the amount of free
6108 space (normally, the number of free 1KB blocks).
6110 This function calls `file-system-info' if it is available, or
6111 invokes the program specified by `directory-free-space-program'
6112 and `directory-free-space-args'. If the system call or program
6113 is unsuccessful, or if DIR is a remote directory, this function
6115 (unless (file-remote-p dir)
6116 ;; Try to find the number of free blocks. Non-Posix systems don't
6117 ;; always have df, but might have an equivalent system call.
6118 (if (fboundp 'file-system-info)
6119 (let ((fsinfo (file-system-info dir)))
6121 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
6122 (setq dir (expand-file-name dir))
6125 (when (and directory-free-space-program
6126 ;; Avoid failure if the default directory does
6127 ;; not exist (Bug#2631, Bug#3911).
6128 (let ((default-directory
6129 (locate-dominating-file dir 'file-directory-p)))
6130 (eq (process-file directory-free-space-program
6132 directory-free-space-args
6133 (file-relative-name dir))
6135 ;; Assume that the "available" column is before the
6136 ;; "capacity" column. Find the "%" and scan backward.
6137 (goto-char (point-min))
6139 (when (re-search-forward
6140 "[[:space:]]+[^[:space:]]+%[^%]*$"
6141 (line-end-position) t)
6142 (goto-char (match-beginning 0))
6143 (let ((endpt (point)))
6144 (skip-chars-backward "^[:space:]")
6145 (buffer-substring-no-properties (point) endpt)))))))))
6147 ;; The following expression replaces `dired-move-to-filename-regexp'.
6148 (defvar directory-listing-before-filename-regexp
6149 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
6150 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
6151 ;; In some locales, month abbreviations are as short as 2 letters,
6152 ;; and they can be followed by ".".
6153 ;; In Breton, a month name can include a quote character.
6154 (month (concat l-or-quote l-or-quote "+\\.?"))
6156 (yyyy "[0-9][0-9][0-9][0-9]")
6158 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
6159 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
6160 (zone "[-+][0-2][0-9][0-5][0-9]")
6161 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
6162 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
6163 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
6164 "\\|" yyyy "-" iso-mm-dd "\\)"))
6165 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
6167 "\\(" HH:MM "\\|" yyyy "\\)"))
6168 (western-comma (concat month s "+" dd "," s "+" yyyy))
6169 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6170 ;; omits the Kanji characters after month and day-of-month.
6171 ;; On Mac OS X 10.3, the date format in East Asian locales is
6172 ;; day-of-month digits followed by month digits.
6175 (concat "\\(" mm l "?" s dd l "?" s "+"
6176 "\\|" dd s mm s "+" "\\)"
6177 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
6178 ;; The "[0-9]" below requires the previous column to end in a digit.
6179 ;; This avoids recognizing `1 may 1997' as a date in the line:
6180 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6182 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6184 ;; For non-iso date formats, we add the ".*" in order to find
6185 ;; the last possible match. This avoids recognizing
6186 ;; `jservice 10 1024' as a date in the line:
6187 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6189 ;; vc dired listings provide the state or blanks between file
6190 ;; permissions and date. The state is always surrounded by
6192 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6193 ;; This is not supported yet.
6194 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
6195 "\\|.*[0-9][BkKMGTPEZY]? "
6196 "\\(" western "\\|" western-comma "\\|" east-asian "\\)"
6198 "Regular expression to match up to the file name in a directory listing.
6199 The default value is designed to recognize dates and times
6200 regardless of the language.")
6202 (defvar insert-directory-ls-version 'unknown)
6205 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6206 ;; FULL-DIRECTORY-P is nil.
6207 ;; The single line of output must display FILE's name as it was
6208 ;; given, namely, an absolute path name.
6209 ;; - must insert exactly one line for each file if WILDCARD or
6210 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6211 ;; before the file lines, plus optional text after the file lines.
6212 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6214 ;; File lines should display the basename.
6215 ;; - must be consistent with
6216 ;; - functions dired-move-to-filename, (these two define what a file line is)
6217 ;; dired-move-to-end-of-filename,
6218 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6219 ;; dired-insert-headerline
6220 ;; dired-after-subdir-garbage (defines what a "total" line is)
6221 ;; - variable dired-subdir-regexp
6222 ;; - may be passed "--dired" as the first argument in SWITCHES.
6223 ;; Filename handlers might have to remove this switch if their
6224 ;; "ls" command does not support it.
6225 (defun insert-directory (file switches &optional wildcard full-directory-p)
6226 "Insert directory listing for FILE, formatted according to SWITCHES.
6227 Leaves point after the inserted text.
6228 SWITCHES may be a string of options, or a list of strings
6229 representing individual options.
6230 Optional third arg WILDCARD means treat FILE as shell wildcard.
6231 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6232 switches do not contain `d', so that a full listing is expected.
6234 This works by running a directory listing program
6235 whose name is in the variable `insert-directory-program'.
6236 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6238 When SWITCHES contains the long `--dired' option, this function
6239 treats it specially, for the sake of dired. However, the
6240 normally equivalent short `-D' option is just passed on to
6241 `insert-directory-program', as any other option."
6242 ;; We need the directory in order to find the right handler.
6243 (let ((handler (find-file-name-handler (expand-file-name file)
6244 'insert-directory)))
6246 (funcall handler 'insert-directory file switches
6247 wildcard full-directory-p)
6248 (let (result (beg (point)))
6250 ;; Read the actual directory using `insert-directory-program'.
6251 ;; RESULT gets the status code.
6252 (let* (;; We at first read by no-conversion, then after
6253 ;; putting text property `dired-filename, decode one
6254 ;; bunch by one to preserve that property.
6255 (coding-system-for-read 'no-conversion)
6256 ;; This is to control encoding the arguments in call-process.
6257 (coding-system-for-write
6258 (and enable-multibyte-characters
6259 (or file-name-coding-system
6260 default-file-name-coding-system))))
6263 ;; Run ls in the directory part of the file pattern
6264 ;; using the last component as argument.
6265 (let ((default-directory
6266 (if (file-name-absolute-p file)
6267 (file-name-directory file)
6268 (file-name-directory (expand-file-name file))))
6269 (pattern (file-name-nondirectory file)))
6270 ;; NB since switches is passed to the shell, be
6271 ;; careful of malicious values, eg "-l;reboot".
6272 ;; See eg dired-safe-switches-p.
6274 shell-file-name nil t nil
6276 (concat (if (memq system-type '(ms-dos windows-nt))
6278 "\\") ; Disregard Unix shell aliases!
6279 insert-directory-program
6281 (if (stringp switches)
6283 (mapconcat 'identity switches " "))
6285 ;; Quote some characters that have
6286 ;; special meanings in shells; but
6287 ;; don't quote the wildcards--we want
6288 ;; them to be special. We also
6289 ;; currently don't quote the quoting
6290 ;; characters in case people want to
6291 ;; use them explicitly to quote
6292 ;; wildcard characters.
6293 (shell-quote-wildcard-pattern pattern))))
6294 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6295 ;; directory if FILE is a symbolic link.
6296 (unless full-directory-p
6299 ((stringp switches) (concat switches " -d"))
6300 ((member "-d" switches) switches)
6301 (t (append switches '("-d"))))))
6302 (apply 'call-process
6303 insert-directory-program nil t nil
6305 (if (listp switches) switches
6306 (unless (equal switches "")
6307 ;; Split the switches at any spaces so we can
6308 ;; pass separate options as separate args.
6309 (split-string switches)))
6310 ;; Avoid lossage if FILE starts with `-'.
6313 (if (string-match "\\`~" file)
6314 (setq file (expand-file-name file)))
6316 (if full-directory-p
6317 (concat (file-name-as-directory file) ".")
6320 ;; If we got "//DIRED//" in the output, it means we got a real
6321 ;; directory listing, even if `ls' returned nonzero.
6322 ;; So ignore any errors.
6323 (when (if (stringp switches)
6324 (string-match "--dired\\>" switches)
6325 (member "--dired" switches))
6328 (when (looking-at "//SUBDIRED//")
6330 (if (looking-at "//DIRED//")
6333 (when (and (not (eq 0 result))
6334 (eq insert-directory-ls-version 'unknown))
6335 ;; The first time ls returns an error,
6336 ;; find the version numbers of ls,
6337 ;; and set insert-directory-ls-version
6338 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6339 ;; is equal or if the info cannot be obtained.
6340 ;; (That can mean it isn't GNU ls.)
6343 (call-process "ls" nil t nil "--version")
6345 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
6346 (let* ((version (match-string 1 version-out))
6347 (split (split-string version "[.]"))
6348 (numbers (mapcar 'string-to-number split))
6351 (while (and (not comparison) (or numbers min))
6353 (setq comparison '>))
6355 (setq comparison '<))
6356 ((> (car numbers) (car min))
6357 (setq comparison '>))
6358 ((< (car numbers) (car min))
6359 (setq comparison '<))
6361 (setq numbers (cdr numbers)
6363 (setq insert-directory-ls-version (or comparison '=)))
6364 (setq insert-directory-ls-version nil))))
6366 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6367 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
6370 ;; If `insert-directory-program' failed, signal an error.
6371 (unless (eq 0 result)
6372 ;; Delete the error message it may have output.
6373 (delete-region beg (point))
6374 ;; On non-Posix systems, we cannot open a directory, so
6375 ;; don't even try, because that will always result in
6376 ;; the ubiquitous "Access denied". Instead, show the
6377 ;; command line so the user can try to guess what went wrong.
6378 (if (and (file-directory-p file)
6379 (memq system-type '(ms-dos windows-nt)))
6381 "Reading directory: \"%s %s -- %s\" exited with status %s"
6382 insert-directory-program
6383 (if (listp switches) (concat switches) switches)
6385 ;; Unix. Access the file to get a suitable error.
6386 (access-file file "Reading directory")
6387 (error "Listing directory failed but `access-file' worked")))
6389 (when (if (stringp switches)
6390 (string-match "--dired\\>" switches)
6391 (member "--dired" switches))
6392 ;; The following overshoots by one line for an empty
6393 ;; directory listed with "--dired", but without "-a"
6394 ;; switch, where the ls output contains a
6395 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6396 ;; We take care of that case later.
6398 (when (looking-at "//SUBDIRED//")
6399 (delete-region (point) (progn (forward-line 1) (point)))
6401 (if (looking-at "//DIRED//")
6402 (let ((end (line-end-position))
6405 ;; Find all the lines that are error messages,
6406 ;; and record the bounds of each one.
6408 (while (< (point) linebeg)
6409 (or (eql (following-char) ?\s)
6410 (push (list (point) (line-end-position)) error-lines))
6412 (setq error-lines (nreverse error-lines))
6413 ;; Now read the numeric positions of file names.
6417 (while (< (point) end)
6418 (let ((start (insert-directory-adj-pos
6419 (+ beg (read (current-buffer)))
6421 (end (insert-directory-adj-pos
6422 (+ beg (read (current-buffer)))
6424 (if (memq (char-after end) '(?\n ?\s))
6425 ;; End is followed by \n or by " -> ".
6426 (put-text-property start end 'dired-filename t)
6427 ;; It seems that we can't trust ls's output as to
6428 ;; byte positions of filenames.
6429 (put-text-property beg (point) 'dired-filename nil)
6433 (delete-region (point) (progn (forward-line 1) (point))))
6434 ;; Take care of the case where the ls output contains a
6435 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6436 ;; and we went one line too far back (see above).
6438 (if (looking-at "//DIRED-OPTIONS//")
6439 (delete-region (point) (progn (forward-line 1) (point)))))
6441 ;; Now decode what read if necessary.
6442 (let ((coding (or coding-system-for-read
6443 file-name-coding-system
6444 default-file-name-coding-system
6448 (when (and enable-multibyte-characters
6449 (not (memq (coding-system-base coding)
6450 '(raw-text no-conversion))))
6451 ;; If no coding system is specified or detection is
6452 ;; requested, detect the coding.
6453 (if (eq (coding-system-base coding) 'undecided)
6454 (setq coding (detect-coding-region beg (point) t)))
6455 (if (not (eq (coding-system-base coding) 'undecided))
6458 (coding-system-change-eol-conversion coding 'unix))
6459 (narrow-to-region beg (point))
6460 (goto-char (point-min))
6463 val (get-text-property (point) 'dired-filename))
6464 (goto-char (next-single-property-change
6465 (point) 'dired-filename nil (point-max)))
6466 ;; Force no eol conversion on a file name, so
6467 ;; that CR is preserved.
6468 (decode-coding-region pos (point)
6469 (if val coding-no-eol coding))
6471 (put-text-property pos (point)
6472 'dired-filename t)))))))
6474 (if full-directory-p
6475 ;; Try to insert the amount of free space.
6478 ;; First find the line to put it on.
6479 (when (re-search-forward "^ *\\(total\\)" nil t)
6480 (let ((available (get-free-disk-space ".")))
6482 ;; Replace "total" with "used", to avoid confusion.
6483 (replace-match "total used in directory" nil nil nil 1)
6485 (insert " available " available))))))))))
6487 (defun insert-directory-adj-pos (pos error-lines)
6488 "Convert `ls --dired' file name position value POS to a buffer position.
6489 File name position values returned in ls --dired output
6490 count only stdout; they don't count the error messages sent to stderr.
6491 So this function converts to them to real buffer positions.
6492 ERROR-LINES is a list of buffer positions of error message lines,
6493 of the form (START END)."
6494 (while (and error-lines (< (caar error-lines) pos))
6495 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
6499 (defun insert-directory-safely (file switches
6500 &optional wildcard full-directory-p)
6501 "Insert directory listing for FILE, formatted according to SWITCHES.
6503 Like `insert-directory', but if FILE does not exist, it inserts a
6504 message to that effect instead of signaling an error."
6505 (if (file-exists-p file)
6506 (insert-directory file switches wildcard full-directory-p)
6507 ;; Simulate the message printed by `ls'.
6508 (insert (format "%s: No such file or directory\n" file))))
6510 (defvar kill-emacs-query-functions nil
6511 "Functions to call with no arguments to query about killing Emacs.
6512 If any of these functions returns nil, killing Emacs is canceled.
6513 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6514 the low level primitive, does not. See also `kill-emacs-hook'.")
6516 (defcustom confirm-kill-emacs nil
6517 "How to ask for confirmation when leaving Emacs.
6518 If nil, the default, don't ask at all. If the value is non-nil, it should
6519 be a predicate function; for example `yes-or-no-p'."
6520 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
6521 (const :tag "Ask with y-or-n-p" y-or-n-p)
6522 (const :tag "Don't confirm" nil)
6523 (function :tag "Predicate function"))
6527 (defun save-buffers-kill-emacs (&optional arg)
6528 "Offer to save each buffer, then kill this Emacs process.
6529 With prefix ARG, silently save all file-visiting buffers without asking.
6530 If there are active processes where `process-query-on-exit-flag'
6531 returns non-nil, asks whether processes should be killed.
6532 Runs the members of `kill-emacs-query-functions' in turn and stops
6533 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6535 (save-some-buffers arg t)
6536 (and (or (not (memq t (mapcar (function
6537 (lambda (buf) (and (buffer-file-name buf)
6538 (buffer-modified-p buf))))
6540 (yes-or-no-p "Modified buffers exist; exit anyway? "))
6541 (or (not (fboundp 'process-list))
6542 ;; process-list is not defined on MSDOS.
6543 (let ((processes (process-list))
6546 (and (memq (process-status (car processes)) '(run stop open listen))
6547 (process-query-on-exit-flag (car processes))
6549 (setq processes (cdr processes)))
6551 (with-current-buffer-window
6552 (get-buffer-create "*Process List*") nil
6553 #'(lambda (window _value)
6554 (with-selected-window window
6556 (yes-or-no-p "Active processes exist; kill them and exit anyway? ")
6557 (when (window-live-p window)
6558 (quit-restore-window window 'kill)))))
6559 (list-processes t)))))
6560 ;; Query the user for other things, perhaps.
6561 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
6562 (or (null confirm-kill-emacs)
6563 (funcall confirm-kill-emacs "Really exit Emacs? "))
6566 (defun save-buffers-kill-terminal (&optional arg)
6567 "Offer to save each buffer, then kill the current connection.
6568 If the current frame has no client, kill Emacs itself.
6570 With prefix ARG, silently save all file-visiting buffers, then kill.
6572 If emacsclient was started with a list of filenames to edit, then
6573 only these files will be asked to be saved."
6575 (if (frame-parameter nil 'client)
6576 (server-save-buffers-kill-terminal arg)
6577 (save-buffers-kill-emacs arg)))
6579 ;; We use /: as a prefix to "quote" a file name
6580 ;; so that magic file name handlers will not apply to it.
6582 (setq file-name-handler-alist
6583 (cons (cons (purecopy "\\`/:") 'file-name-non-special)
6584 file-name-handler-alist))
6586 ;; We depend on being the last handler on the list,
6587 ;; so that anything else which does need handling
6588 ;; has been handled already.
6589 ;; So it is safe for us to inhibit *all* magic file name handlers.
6591 (defun file-name-non-special (operation &rest arguments)
6592 (let ((file-name-handler-alist nil)
6594 (if (eq operation 'insert-directory)
6595 (directory-file-name
6597 (unhandled-file-name-directory default-directory)))
6599 ;; Get a list of the indices of the args which are file names.
6601 (cdr (or (assq operation
6602 ;; The first six are special because they
6603 ;; return a file name. We want to include the /:
6604 ;; in the return value.
6605 ;; So just avoid stripping it in the first place.
6606 '((expand-file-name . nil)
6607 (file-name-directory . nil)
6608 (file-name-as-directory . nil)
6609 (directory-file-name . nil)
6610 (file-name-sans-versions . nil)
6611 (find-backup-file-name . nil)
6612 ;; `identity' means just return the first arg
6613 ;; not stripped of its quoting.
6614 (substitute-in-file-name identity)
6615 ;; `add' means add "/:" to the result.
6616 (file-truename add 0)
6617 (insert-file-contents insert-file-contents 0)
6618 ;; `unquote-then-quote' means set buffer-file-name
6619 ;; temporarily to unquoted filename.
6620 (verify-visited-file-modtime unquote-then-quote)
6621 ;; List the arguments which are filenames.
6622 (file-name-completion 1)
6623 (file-name-all-completions 1)
6627 (make-symbolic-link 0 1)
6628 (add-name-to-file 0 1)))
6629 ;; For all other operations, treat the first argument only
6630 ;; as the file name.
6633 ;; Copy ARGUMENTS so we can replace elements in it.
6634 (arguments (copy-sequence arguments)))
6635 (if (symbolp (car file-arg-indices))
6636 (setq method (pop file-arg-indices)))
6637 ;; Strip off the /: from the file names that have it.
6639 (while (consp file-arg-indices)
6640 (let ((pair (nthcdr (car file-arg-indices) arguments)))
6642 (string-match "\\`/:" (car pair))
6644 (if (= (length (car pair)) 2)
6646 (substring (car pair) 2)))))
6647 (setq file-arg-indices (cdr file-arg-indices))))
6649 (`identity (car arguments))
6650 (`add (concat "/:" (apply operation arguments)))
6651 (`insert-file-contents
6652 (let ((visit (nth 1 arguments)))
6654 (apply operation arguments)
6655 (when (and visit buffer-file-name)
6656 (setq buffer-file-name (concat "/:" buffer-file-name))))))
6657 (`unquote-then-quote
6658 (let ((buffer-file-name (substring buffer-file-name 2)))
6659 (apply operation arguments)))
6661 (apply operation arguments)))))
6663 ;; Symbolic modes and read-file-modes.
6665 (defun file-modes-char-to-who (char)
6666 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6667 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6668 Others, or All) for whom to produce the mask.
6669 The bit-mask that is returned extracts from mode bits the access rights
6670 for the specified category of users."
6671 (cond ((= char ?u) #o4700)
6672 ((= char ?g) #o2070)
6673 ((= char ?o) #o1007)
6674 ((= char ?a) #o7777)
6675 (t (error "%c: bad `who' character" char))))
6677 (defun file-modes-char-to-right (char &optional from)
6678 "Convert CHAR to a numeric value of mode bits.
6679 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6680 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6681 (or from (setq from 0))
6682 (cond ((= char ?r) #o0444)
6683 ((= char ?w) #o0222)
6684 ((= char ?x) #o0111)
6685 ((= char ?s) #o1000)
6686 ((= char ?t) #o6000)
6687 ;; Rights relative to the previous file modes.
6688 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
6689 ((= char ?u) (let ((uright (logand #o4700 from)))
6690 (+ uright (/ uright #o10) (/ uright #o100))))
6691 ((= char ?g) (let ((gright (logand #o2070 from)))
6692 (+ gright (/ gright #o10) (* gright #o10))))
6693 ((= char ?o) (let ((oright (logand #o1007 from)))
6694 (+ oright (* oright #o10) (* oright #o100))))
6695 (t (error "%c: bad right character" char))))
6697 (defun file-modes-rights-to-number (rights who-mask &optional from)
6698 "Convert a symbolic mode string specification to an equivalent number.
6699 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6700 WHO-MASK is the bit-mask specifying the category of users to which to
6701 apply the access permissions. See `file-modes-char-to-who'.
6702 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6703 RIGHTS request to add, remove, or set permissions based on existing ones,
6705 (let* ((num-rights (or from 0))
6706 (list-rights (string-to-list rights))
6707 (op (pop list-rights)))
6708 (while (memq op '(?+ ?- ?=))
6711 (while (memq (setq char-right (pop list-rights))
6712 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
6715 (file-modes-char-to-right char-right num-rights))))
6716 (setq num-right (logand who-mask num-right)
6718 (cond ((= op ?+) (logior num-rights num-right))
6719 ((= op ?-) (logand num-rights (lognot num-right)))
6720 (t (logior (logand num-rights (lognot who-mask)) num-right)))
6724 (defun file-modes-symbolic-to-number (modes &optional from)
6725 "Convert symbolic file modes to numeric file modes.
6726 MODES is the string to convert, it should match
6727 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6728 See Info node `(coreutils)File permissions' for more information on this
6730 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6731 MODES request to add, remove, or set permissions based on existing ones,
6734 (let ((case-fold-search nil)
6735 (num-modes (or from 0)))
6736 (while (/= (string-to-char modes) 0)
6737 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes)
6738 (let ((num-who (apply 'logior 0
6739 (mapcar 'file-modes-char-to-who
6740 (match-string 1 modes)))))
6742 (setq num-who (default-file-modes)))
6744 (file-modes-rights-to-number (substring modes (match-end 1))
6746 modes (substring modes (match-end 3))))
6747 (error "Parse error in modes near `%s'" (substring modes 0))))
6750 (defun read-file-modes (&optional prompt orig-file)
6751 "Read file modes in octal or symbolic notation and return its numeric value.
6752 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6753 ORIG-FILE is the name of a file on whose mode bits to base returned
6754 permissions if what user types requests to add, remove, or set permissions
6755 based on existing mode bits, as in \"og+rX-w\"."
6756 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
6757 (error "File not found")))
6758 (modestr (and (stringp orig-file)
6759 (nth 8 (file-attributes orig-file))))
6761 (and (stringp modestr)
6762 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
6763 (replace-regexp-in-string
6765 (format "u=%s,g=%s,o=%s"
6766 (match-string 1 modestr)
6767 (match-string 2 modestr)
6768 (match-string 3 modestr)))))
6769 (value (read-string (or prompt "File modes (octal or symbolic): ")
6772 (if (string-match "^[0-7]+" value)
6773 (string-to-number value 8)
6774 (file-modes-symbolic-to-number value modes)))))
6776 (define-obsolete-variable-alias 'cache-long-line-scans
6777 'cache-long-scans "24.4")
6779 ;; Trashcan handling.
6780 (defcustom trash-directory nil
6781 "Directory for `move-file-to-trash' to move files and directories to.
6782 This directory is only used when the function `system-move-file-to-trash'
6784 Relative paths are interpreted relative to `default-directory'.
6785 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6786 :type '(choice (const nil) directory)
6790 (defvar trash--hexify-table)
6792 (declare-function system-move-file-to-trash "w32fns.c" (filename))
6794 (defun move-file-to-trash (filename)
6795 "Move the file (or directory) named FILENAME to the trash.
6796 When `delete-by-moving-to-trash' is non-nil, this function is
6797 called by `delete-file' and `delete-directory' instead of
6798 deleting files outright.
6800 If the function `system-move-file-to-trash' is defined, call it
6801 with FILENAME as an argument.
6802 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6804 Otherwise, trash FILENAME using the freedesktop.org conventions,
6805 like the GNOME, KDE and XFCE desktop environments. Emacs only
6806 moves files to \"home trash\", ignoring per-volume trashcans."
6807 (interactive "fMove file to trash: ")
6808 (cond (trash-directory
6809 ;; If `trash-directory' is non-nil, move the file there.
6810 (let* ((trash-dir (expand-file-name trash-directory))
6811 (fn (directory-file-name (expand-file-name filename)))
6812 (new-fn (expand-file-name (file-name-nondirectory fn)
6814 ;; We can't trash a parent directory of trash-directory.
6815 (if (string-prefix-p fn trash-dir)
6816 (error "Trash directory `%s' is a subdirectory of `%s'"
6817 trash-dir filename))
6818 (unless (file-directory-p trash-dir)
6819 (make-directory trash-dir t))
6820 ;; Ensure that the trashed file-name is unique.
6821 (if (file-exists-p new-fn)
6822 (let ((version-control t)
6823 (backup-directory-alist nil))
6824 (setq new-fn (car (find-backup-file-name new-fn)))))
6825 (let (delete-by-moving-to-trash)
6826 (rename-file fn new-fn))))
6827 ;; If `system-move-file-to-trash' is defined, use it.
6828 ((fboundp 'system-move-file-to-trash)
6829 (system-move-file-to-trash filename))
6830 ;; Otherwise, use the freedesktop.org method, as specified at
6831 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6833 (let* ((xdg-data-dir
6834 (directory-file-name
6835 (expand-file-name "Trash"
6836 (or (getenv "XDG_DATA_HOME")
6837 "~/.local/share"))))
6838 (trash-files-dir (expand-file-name "files" xdg-data-dir))
6839 (trash-info-dir (expand-file-name "info" xdg-data-dir))
6840 (fn (directory-file-name (expand-file-name filename))))
6842 ;; Check if we have permissions to delete.
6843 (unless (file-writable-p (directory-file-name
6844 (file-name-directory fn)))
6845 (error "Cannot move %s to trash: Permission denied" filename))
6846 ;; The trashed file cannot be the trash dir or its parent.
6847 (if (string-prefix-p fn trash-files-dir)
6848 (error "The trash directory %s is a subdirectory of %s"
6849 trash-files-dir filename))
6850 (if (string-prefix-p fn trash-info-dir)
6851 (error "The trash directory %s is a subdirectory of %s"
6852 trash-info-dir filename))
6854 ;; Ensure that the trash directory exists; otherwise, create it.
6855 (with-file-modes #o700
6856 (unless (file-exists-p trash-files-dir)
6857 (make-directory trash-files-dir t))
6858 (unless (file-exists-p trash-info-dir)
6859 (make-directory trash-info-dir t)))
6861 ;; Try to move to trash with .trashinfo undo information
6864 (set-buffer-file-coding-system 'utf-8-unix)
6865 (insert "[Trash Info]\nPath=")
6866 ;; Perform url-encoding on FN. For compatibility with
6867 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6868 ;; for path separators.
6869 (unless (boundp 'trash--hexify-table)
6870 (setq trash--hexify-table (make-vector 256 nil))
6871 (let ((unreserved-chars
6872 (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6873 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6874 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6875 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2
6876 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?'
6879 (aset trash--hexify-table byte
6880 (if (memq byte unreserved-chars)
6881 (char-to-string byte)
6882 (format "%%%02x" byte))))))
6883 (mapc (lambda (byte)
6884 (insert (aref trash--hexify-table byte)))
6885 (if (multibyte-string-p fn)
6886 (encode-coding-string fn 'utf-8)
6888 (insert "\nDeletionDate="
6889 (format-time-string "%Y-%m-%dT%T")
6892 ;; Attempt to make .trashinfo file, trying up to 5
6893 ;; times. The .trashinfo file is opened with O_EXCL,
6894 ;; as per trash-spec 0.7, even if that can be a problem
6895 ;; on old NFS versions...
6897 (base-fn (expand-file-name
6898 (file-name-nondirectory fn)
6903 (setq info-fn (expand-file-name
6904 (concat (file-name-nondirectory new-fn)
6907 (unless (condition-case nil
6909 (write-region nil nil info-fn nil
6910 'quiet info-fn 'excl)
6911 (setq tries 0 success t))
6912 (file-already-exists nil))
6913 (setq tries (1- tries))
6914 ;; Uniquify new-fn. (Some file managers do not
6915 ;; like Emacs-style backup file names---e.g. bug
6916 ;; 170956 in Konqueror bug tracker.)
6917 (setq new-fn (make-temp-name (concat base-fn "_")))))
6919 (error "Cannot move %s to trash: Lock failed" filename))
6921 ;; Finally, try to move the file to the trashcan.
6922 (let ((delete-by-moving-to-trash nil))
6923 (rename-file fn new-fn)))))))))
6926 (define-key ctl-x-map "\C-f" 'find-file)
6927 (define-key ctl-x-map "\C-r" 'find-file-read-only)
6928 (define-key ctl-x-map "\C-v" 'find-alternate-file)
6929 (define-key ctl-x-map "\C-s" 'save-buffer)
6930 (define-key ctl-x-map "s" 'save-some-buffers)
6931 (define-key ctl-x-map "\C-w" 'write-file)
6932 (define-key ctl-x-map "i" 'insert-file)
6933 (define-key esc-map "~" 'not-modified)
6934 (define-key ctl-x-map "\C-d" 'list-directory)
6935 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
6936 (define-key ctl-x-map "\C-q" 'read-only-mode)
6938 (define-key ctl-x-4-map "f" 'find-file-other-window)
6939 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
6940 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
6941 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
6942 (define-key ctl-x-4-map "\C-o" 'display-buffer)
6944 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
6945 (define-key ctl-x-5-map "f" 'find-file-other-frame)
6946 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
6947 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
6948 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
6950 ;;; files.el ends here