| blob | 4bd708deed873fab77dea58f227b1edfa2967a7c |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2016 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
34 "Backups of edited data files."
38 "Finding files."
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."
51 nil
52 "Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
57 FROM is matched against directory names anchored at the first
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."
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.
99 "If non-nil, backups will be inhibited.
100 This variable is intended for use by making it local to a buffer,
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
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."
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."
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."
142 "Predicate that looks at a file name and decides whether to make backups.
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."
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."
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."
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."
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.
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."
205 ;; The system null device. (Should reference NULL_DEVICE from C.)
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'."
253 "Whether to allow breaking hardlinks when saving files.
254 If non-nil, then when saving a file that exists under several
255 names \(i.e., has multiple hardlinks), break the hardlink
256 associated with `buffer-file-name' and write to a new file, so
257 that the other instances of the file are not affected by the
258 save.
260 If `buffer-file-name' refers to a symlink, do not break the symlink.
262 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
263 For example, if the directory in which a file is being saved is not
264 itself writable, then error instead of saving in some
265 hardlink-nonbreaking way.
267 See also `backup-by-copying' and `backup-by-copying-when-linked'."
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."
285 "When cleaning directory, number of versions to keep."
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
299 "Number of oldest versions to keep when a new numbered backup is made."
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
312 "Whether to add a newline automatically at the end of the file.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
331 "Whether to add a newline at end of file, in certain major modes.
332 Those modes set `require-final-newline' to this value when you enable them.
333 They do so because they are often used for files that are supposed
334 to end in newlines, and the question is how to arrange that.
336 A value of t means do this only when the file is about to be saved.
337 A value of `visit' means do this right after the file is visited.
338 A value of `visit-save' means do it at both of those times.
339 Any other non-nil value means ask user whether to add a newline, when saving.
341 A value of nil means do not add newlines. That is a risky choice in this
342 variable since this value is used for modes for files that ought to have
343 final newlines. So if you set this to nil, you must explicitly check and
344 add a final newline, whenever you save a file that really needs one."
354 "Non-nil says by default do auto-saving of every file-visiting buffer."
360 ;; Don't put "\\2" inside expand-file-name, since it will be
361 ;; transformed to "/2" on DOS/Windows.
363 "Transforms to apply to buffer file name before making auto-save file name.
364 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
365 REGEXP is a regular expression to match against the file name.
366 If it matches, `replace-match' is used to replace the
367 matching part with REPLACEMENT.
368 If the optional element UNIQUIFY is non-nil, the auto-save file name is
369 constructed by taking the directory part of the replaced file-name,
370 concatenated with the buffer file name with all directory separators
371 changed to `!' to prevent clashes. This will not work
372 correctly if your filesystem truncates the resulting name.
374 All the transforms in the list are tried, in the order they are listed.
375 When one transform applies, its result is final;
376 no further transforms are tried.
378 The default value is set up to put the auto-save file into the
379 temporary directory (see the variable `temporary-file-directory') for
380 editing a remote file.
382 On MS-DOS filesystems without long names this variable is always
383 ignored."
391 "Non-nil means save word abbrevs too when files are saved.
392 If `silently', don't ask the user before saving."
397 "Non-nil means allow `find-file' to visit directories.
398 To visit the directory, `find-file' runs `find-directory-functions'."
403 "List of functions to try in sequence to visit a directory.
404 Each function is called with the directory name as the sole argument
405 and should return either a buffer or nil."
409 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
411 "List of functions to try in sequence to get a file name at point.
412 Each function should return either nil or a file name found at the
413 location of point in the current buffer."
417 ;;;It is not useful to make this a local variable.
418 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
422 "List of functions to be called for `find-file' on nonexistent file.
423 These functions are called as soon as the error is detected.
424 Variable `buffer-file-name' is already set up.
427 ;;;It is not useful to make this a local variable.
428 ;;;(put 'find-file-hooks 'permanent-local t)
431 "List of functions to be called after a buffer is loaded from a file.
432 The buffer's local variables (if any) will have been processed before the
433 functions are called."
441 "List of functions to be called before writing out a buffer to a file.
442 If one of them returns non-nil, the file is considered already written
443 and the rest are not called.
444 These hooks are considered to pertain to the visited file.
445 So any buffer-local binding of this variable is discarded if you change
447 change the major mode.
449 This hook is not run if any of the functions in
450 `write-contents-functions' returns non-nil. Both hooks pertain
451 to how to save a buffer to file, for instance, choosing a suitable
452 coding system and setting mode bits. (See Info
453 node `(elisp)Saving Buffers'.) To perform various checks or
465 "List of functions to be called before writing out a buffer to a file.
466 If one of them returns non-nil, the file is considered already written
467 and the rest are not called and neither are the functions in
468 `write-file-functions'.
470 This variable is meant to be used for hooks that pertain to the
471 buffer's contents, not to the particular visited file; thus,
472 `set-visited-file-name' does not clear this variable; but changing the
473 major mode does clear it.
475 For hooks that _do_ pertain to the particular visited file, use
476 `write-file-functions'. Both this variable and
477 `write-file-functions' relate to how a buffer is saved to file.
478 To perform various checks or updates before the buffer is saved,
483 "Control use of local variables in files you visit.
484 The value can be t, nil, :safe, :all, or something else.
486 A value of t means file local variables specifications are obeyed
487 if all the specified variable values are safe; if any values are
488 not safe, Emacs queries you, once, whether to set them all.
489 \(When you say yes to certain values, they are remembered as safe.)
491 :safe means set the safe variables, and ignore the rest.
492 :all means set all variables, whether safe or not.
493 (Don't set it permanently to :all.)
494 A value of nil means always ignore the file local variables.
496 Any other value means always query you once whether to set them all.
497 \(When you say yes to certain values, they are remembered as safe, but
500 This variable also controls use of major modes specified in
501 a -*- line.
504 always obeys file local variable specifications and the -*- line,
505 and ignores this variable."
506 :risky t
515 "Non-nil means enable use of directory-local variables.
516 Some modes may wish to set this to nil to prevent directory-local
519 ;; This is an odd variable IMO.
520 ;; You might wonder why it is needed, when we could just do:
521 ;; (set (make-local-variable 'enable-local-variables) nil)
522 ;; These two are not precisely the same.
523 ;; Setting this variable does not cause -*- mode settings to be
524 ;; ignored, whereas setting enable-local-variables does.
525 ;; Only three places in Emacs use this variable: tar and arc modes,
526 ;; and rmail. The first two don't need it. They already use
527 ;; inhibit-local-variables-regexps, which is probably enough, and
528 ;; could also just set enable-local-variables locally to nil.
529 ;; Them setting it has the side-effect that dir-locals cannot apply to
530 ;; eg tar files (?). FIXME Is this appropriate?
531 ;; AFAICS, rmail is the only thing that needs this, and the only
532 ;; reason it uses it is for BABYL files (which are obsolete).
533 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
534 ;; to respect, so that find-file on a BABYL file will switch to
535 ;; rmail-mode automatically (this is nice, but hardly essential,
536 ;; since most people are used to explicitly running a command to
537 ;; access their mail; M-x gnus etc). Rmail files may happen to
538 ;; contain Local Variables sections in messages, which Rmail wants to
539 ;; ignore. So AFAICS the only reason this variable exists is for a
540 ;; minor convenience feature for handling of an obsolete Rmail file format.
542 "Like `enable-local-variables' but meant for buffer-local bindings.
543 The meaningful values are nil and non-nil. The default is non-nil.
544 If a major mode sets this to nil, buffer-locally, then any local
545 variables list in a file visited in that mode will be ignored.
547 This variable does not affect the use of major modes specified
552 The value can be t, nil or something else.
553 A value of t means obey `eval' variables.
554 A value of nil means ignore them; anything else means query."
555 :risky t
562 "Non-nil means buffers visiting files read-only do so in view mode.
563 In fact, this means that all read-only buffers normally have
564 View mode enabled, including buffers that are read-only because
565 you visit a file you cannot alter, and buffers you make read-only
571 "History list of file names entered in the minibuffer.
573 Maximum length of the history list is determined by the value
577 "If non-nil, avoid messages when saving files.
578 Error-related messages will still be printed, but all other
581 \f
584 "Provides support for ange-ftp host name completion.
585 Runs the usual ange-ftp hook, but only for completion operations."
586 ;; Having this here avoids the need to load ange-ftp when it's not
587 ;; really in use.
593 inhibit-file-name-handlers)))
601 "Convert a standard file's name to something suitable for the OS.
602 This means to guarantee valid names and perhaps to canonicalize
603 certain patterns.
605 FILENAME should be an absolute file name since the conversion rules
606 sometimes vary depending on the position in the file name. E.g. c:/foo
607 is a valid DOS file name, but c:/bar/c:/foo is not.
609 This function's standard definition is trivial; it just returns
610 the argument. However, on Windows and DOS, replace invalid
611 characters. On DOS, make sure to obey the 8.3 limitations.
612 In the native Windows build, turn Cygwin names into native names.
614 See Info node `(elisp)Standard File Names' for more details."
619 ;; Replace invalid filename characters with !
623 name))
631 "Read directory name, prompting with PROMPT and completing in directory DIR.
632 Value is not expanded---you must call `expand-file-name' yourself.
633 Default name to DEFAULT-DIRNAME if user exits with the same
634 non-empty string that was inserted by this function.
635 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
636 or just DIR if INITIAL is nil.)
637 If the user exits with an empty minibuffer, this function returns
638 an empty string. (This can only happen if the user erased the
639 pre-inserted contents or if `insert-default-directory' is nil.)
640 Fourth arg MUSTMATCH non-nil means require existing directory's name.
641 Non-nil and non-t means also require confirmation after completion.
642 Fifth arg INITIAL specifies text to start with.
643 DIR should be an absolute directory name. It defaults to
644 the value of `default-directory'."
649 dir))
650 mustmatch initial
653 \f
655 "Show the current default directory.
656 With prefix argument INSERT, insert the current default directory
657 at point instead."
664 "Value of the CDPATH environment variable, as a list.
668 "Explode a search path into a list of directory names.
669 Directories are separated by `path-separator' (which is colon in
670 GNU and Unix systems). Substitute environment variables into the
671 resulting list of directory names. For an empty path element (i.e.,
672 a leading or trailing separator, or two adjacent separators), return
673 nil (meaning `default-directory') as the associated list element."
681 "Change current directory to given absolute file name DIR."
682 ;; Put the name into directory syntax now,
683 ;; because otherwise expand-file-name may give some bad results.
685 ;; We used to additionally call abbreviate-file-name here, for an
686 ;; unknown reason. Problem is that most buffers are setup
687 ;; without going through cd-absolute and don't call
688 ;; abbreviate-file-name on their default-directory, so the few that
689 ;; do end up using a superficially different directory.
701 "Make DIR become the current buffer's default directory.
702 If your environment includes a `CDPATH' variable, try each one of
703 that list of directories (separated by occurrences of
704 `path-separator') when resolving a relative directory name.
705 The path separator is colon in GNU and GNU-like systems."
708 ;; FIXME: There's a subtle bug in the completion below. Seems linked
709 ;; to a fundamental difficulty of implementing `predicate' correctly.
710 ;; The manifestation is that TAB may list non-directories in the case where
711 ;; those files also correspond to valid directories (if your cd-path is (A/
712 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
713 ;; will be listed as valid completions).
714 ;; This is because `a' (listed because of A/a) is indeed a valid choice
715 ;; (which will lead to the use of B/a).
720 cd-path nil))
729 default-directory default-directory
730 t))))
740 "Return non-nil if NAME ends with a directory separator character."
750 "Return list of all files under DIR that have file names matching REGEXP.
752 order, and files from each directory are sorted in alphabetical order.
753 Each file name appears in the returned list in its absolute form.
754 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
755 output directories whose names match REGEXP."
758 ;; When DIR is "/", remote file names like "/method:" could
759 ;; also be offered. We shall suppress them.
767 ;; Don't follow symlinks to other directories.
771 full-file regexp include-directories))))
782 "Load the Lisp file named FILE."
783 ;; This is a case where .elc and .so/.dll make a lot of sense.
787 completion-ignored-extensions))))
792 "Search for FILENAME through PATH.
793 If found, return the absolute file name of FILENAME; otherwise
794 return nil.
795 PATH should be a list of directories to look in, like the lists in
796 `exec-path' or `load-path'.
797 If SUFFIXES is non-nil, it should be a list of suffixes to append to
800 If non-nil, PREDICATE is used instead of `file-readable-p'.
802 This function will normally skip directories, so if you want it to find
803 directories, make sure the PREDICATE function returns `dir-ok' for them.
805 PREDICATE can also be an integer to pass to the `access' system call,
806 in which case file-name handlers are ignored. This usage is deprecated.
807 For compatibility, PREDICATE can also be one of the symbols
808 `executable', `readable', `writable', or `exists', or a list of
809 one or more of those symbols."
820 "Do completion for file names passed to `locate-file'."
823 ;; FIXME: maybe we should use completion-file-name-table instead,
824 ;; tho at least for `load', the arg is passed through
825 ;; substitute-in-file-name for historical reasons.
835 ;; If we have files like "foo.el" and "foo.elc", we could load one of
836 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
837 ;; preferred way. So if we list all 3, that gives a lot of redundant
838 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
839 ;; the user does want to pay attention to the extension. We try to
840 ;; diffuse this tension by stripping the suffix, except when the
841 ;; result is a single element (i.e. usually we only list "foo" unless
842 ;; it's the only remaining element in the list, in which case we do
843 ;; list "foo", "foo.elc" and "foo.el").
854 string-file dir))
859 ;; Switching from names to names+fullnames creates a non-monotonicity
860 ;; which can cause problems with things like partial-completion.
861 ;; To minimize the problem, filter out completion-regexp-list, so that
862 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
863 ;; from `names' which only matched `string' when they still had
864 ;; their suffix.
866 ;; Remove duplicates of the first element, so that we can easily check
867 ;; if `names' really only contains a single element.
870 ;; There's no more than one matching non-suffixed element, so expand
871 ;; the list by adding the suffixed elements as well.
874 string-dir names string-file pred action)))))
877 "Do completion for file names passed to `locate-file'.
878 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
882 string nil action))
886 "Regexp of directory names which stop the search in `locate-dominating-file'.
887 Any directory whose name matches this regexp will be treated like
888 a kind of root directory by `locate-dominating-file' which will stop its search
889 when it bumps into it.
890 The default regexp prevents fruitless and time-consuming attempts to find
891 special files in directories in which filenames are interpreted as hostnames,
894 ;; (defun locate-dominating-files (file regexp)
895 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
896 ;; Stop at the first parent where a matching file is found and return the list
897 ;; of files that that match in this directory."
898 ;; (catch 'found
899 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
900 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
901 ;; (let ((user nil)
902 ;; ;; Abbreviate, so as to stop when we cross ~/.
903 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
904 ;; files)
905 ;; (while (and dir
906 ;; ;; As a heuristic, we stop looking up the hierarchy of
907 ;; ;; directories as soon as we find a directory belonging to
908 ;; ;; another user. This should save us from looking in
909 ;; ;; things like /net and /afs. This assumes that all the
910 ;; ;; files inside a project belong to the same user.
911 ;; (let ((prev-user user))
912 ;; (setq user (nth 2 (file-attributes dir)))
913 ;; (or (null prev-user) (equal user prev-user))))
914 ;; (if (setq files (condition-case nil
915 ;; (directory-files dir 'full regexp 'nosort)
916 ;; (error nil)))
917 ;; (throw 'found files)
918 ;; (if (equal dir
919 ;; (setq dir (file-name-directory
920 ;; (directory-file-name dir))))
921 ;; (setq dir nil))))
922 ;; nil)))
925 "Look up the directory hierarchy from FILE for a directory containing NAME.
926 Stop at the first parent directory containing a file NAME,
927 and return the directory. Return nil if not found.
928 Instead of a string, NAME can also be a predicate taking one argument
929 \(a directory) and returning a non-nil value if that directory is the one for
930 which we're looking."
931 ;; We used to use the above locate-dominating-files code, but the
932 ;; directory-files call is very costly, so we're much better off doing
933 ;; multiple calls using the code in here.
934 ;;
935 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
936 ;; `name' in /home or in /.
939 ;; `user' is not initialized outside the loop because
940 ;; `file' may not exist, so we may have to walk up part of the
941 ;; hierarchy before we find the "initial UID". Note: currently unused
942 ;; (user nil)
943 try)
946 ;; FIXME: Disabled this heuristic because it is sometimes
947 ;; inappropriate.
948 ;; As a heuristic, we stop looking up the hierarchy of
949 ;; directories as soon as we find a directory belonging
950 ;; to another user. This should save us from looking in
951 ;; things like /net and /afs. This assumes that all the
952 ;; files inside a project belong to the same user.
953 ;; (let ((prev-user user))
954 ;; (setq user (nth 2 (file-attributes file)))
955 ;; (and prev-user (not (equal user prev-user))))
967 "Non-nil means warn if cannot access `user-emacs-directory'.
968 Set this to nil at your own risk..."
974 "Return an absolute per-user Emacs-specific file name.
975 If NEW-NAME exists in `user-emacs-directory', return it.
976 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
977 Else return NEW-NAME in `user-emacs-directory', creating the
978 directory if it does not exist."
986 at-home
987 ;; Make sure `user-emacs-directory' exists,
988 ;; unless we're in batch mode or dumping Emacs.
990 purify-flag
1000 user-emacs-directory-warning
1002 ;; Only warn once per Emacs session.
1006 Unable to %s `user-emacs-directory' (%s).
1007 Any data that would normally be written there may be lost!
1008 If you never want to see this message again,
1009 customize the variable `user-emacs-directory-warning'."
1010 errtype user-emacs-directory)))))
1011 bestname))))
1015 "Search for COMMAND in `exec-path' and return the absolute file name.
1016 Return nil if COMMAND is not found anywhere in `exec-path'."
1017 ;; Use 1 rather than file-executable-p to better match the behavior of
1018 ;; call-process.
1022 "Load the Emacs Lisp library named LIBRARY.
1023 LIBRARY should be a string.
1024 This is an interface to the function `load'. LIBRARY is searched
1025 for in `load-path', both with and without `load-suffixes' (as
1026 well as `load-file-rep-suffixes').
1028 See Info node `(emacs)Lisp Libraries' for more details.
1029 See `load-file' for a different interface to `load'."
1034 load-path
1039 "Test whether FILE specifies a location on a remote system.
1040 A file is considered remote if accessing it is likely to
1041 be slower or less reliable than accessing local files.
1043 `file-remote-p' never opens a new remote connection. It can
1044 only reuse a connection that is already open.
1046 Return nil or a string identifying the remote connection
1047 \(ideally a prefix of FILE). Return nil if FILE is a relative
1048 file name.
1050 When IDENTIFICATION is nil, the returned string is a complete
1051 remote identifier: with components method, user, and host. The
1052 components are those present in FILE, with defaults filled in for
1053 any that are missing.
1055 IDENTIFICATION can specify which part of the identification to
1056 return. IDENTIFICATION can be the symbol `method', `user',
1057 `host', or `localname'. Any other value is handled like nil and
1058 means to return the complete identification. The string returned
1059 for IDENTIFICATION `localname' can differ depending on whether
1060 there is an existing connection.
1062 If CONNECTED is non-nil, return an identification only if FILE is
1063 located on a remote system and a connection is established to
1064 that remote system.
1066 Tip: You can use this expansion of remote identifier components
1067 to derive a new remote file name from an existing one. For
1073 same remote identifier as FILE but expanded; a name such as
1078 nil)))
1080 ;; Probably this entire variable should be obsolete now, in favor of
1081 ;; something Tramp-related (?). It is not used in many places.
1082 ;; It's not clear what the best file for this to be in is, but given
1083 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1084 ;; rather than autoloaded.
1086 ;; This used to try various hard-coded places for remsh, rsh, and
1087 ;; rcmd, trying to guess based on location whether "rsh" was
1088 ;; "restricted shell" or "remote shell", but I don't see the point
1089 ;; in this day and age. Almost everyone will use ssh, and have
1090 ;; whatever command they want to use in PATH.
1097 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1104 "Whether to use the remote file-name cache for read access.
1105 When nil, never expire cached values (caution)
1106 When t, never use the cache (safe, but may be slow)
1107 A number means use cached values for that amount of seconds since caching.
1109 The attributes of remote files are cached for better performance.
1110 If they are changed outside of Emacs's control, the cached values
1111 become invalid, and must be reread. If you are sure that nothing
1112 other than Emacs changes the files, you can set this variable to nil.
1114 If a remote file is checked regularly, it might be a good idea to
1115 let-bind this variable to a value less than the interval between
1116 consecutive checks. For example:
1118 (defun display-time-file-nonempty-p (file)
1119 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1120 (and (file-exists-p file)
1121 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1132 "Copy the file FILE into a temporary file on this machine.
1133 Returns the name of the local copy, or nil, if FILE is directly
1134 accessible."
1135 ;; This formerly had an optional BUFFER argument that wasn't used by
1136 ;; anything.
1140 nil)))
1143 "Return the truename of FILENAME.
1144 If FILENAME is not absolute, first expands it against `default-directory'.
1145 The truename of a file name is found by chasing symbolic links
1146 both at the level of the file and at the level of the directories
1147 containing it, until no links are left at any level.
1150 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1151 ;; COUNTER can be a cons cell whose car is the count of how many
1152 ;; more links to chase before getting an error.
1153 ;; PREV-DIRS can be a cons cell whose car is an alist
1154 ;; of truenames we've just recently computed.
1168 ;; For speed, remove the ange-ftp completion handler from the list.
1169 ;; We know it's not needed here.
1170 ;; For even more speed, do this only on the outermost call.
1177 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1178 ;; case differences being ignored by the OS, and short "8.3 DOS"
1179 ;; name aliases existing for all files. (The short names are not
1180 ;; reported by directory-files, but can be used to refer to files.)
1181 ;; It seems appropriate for file-truename to resolve these issues in
1182 ;; the most natural way, which on Windows is to call the function
1183 ;; `w32-long-file-name' - this returns the exact name of a file as
1184 ;; it is stored on disk (expanding short name aliases with the full
1185 ;; name in the process).
1188 ;; If filename exists, use its long name. If it doesn't
1189 ;; exist, the recursion below on the directory of filename
1190 ;; will drill down until we find a directory that exists,
1191 ;; and use the long name of that, with the extra
1192 ;; non-existent path components concatenated.
1197 ;; If this file directly leads to a link, process that iteratively
1198 ;; so that we don't use lots of stack.
1204 ;; For file name that has a special handler, call handler.
1205 ;; This is so that ange-ftp can save time by doing a no-op.
1208 done t)
1210 target dirfile)
1211 ;; Get the truename of the directory.
1213 ;; If these are equal, we have the (or a) root directory.
1217 ;; If this is the same dir we last got the truename for,
1218 ;; save time--don't recalculate.
1228 done t)
1231 done t)
1232 ;; Put it back on the file name.
1234 ;; Is the file name the name of a link?
1237 ;; Yes => chase that link, then start all over
1238 ;; since the link may point to a directory name that uses links.
1239 ;; We can't safely use expand-file-name here
1240 ;; since target might look like foo/../bar where foo
1241 ;; is itself a link. Instead, we handle . and .. above.
1244 target
1246 done nil)
1247 ;; No, we are done!
1249 filename))
1252 "Chase links in FILENAME until a name that is not a link.
1253 Unlike `file-truename', this does not check whether a parent
1254 directory name is a symbolic link.
1255 If the optional argument LIMIT is a number,
1256 it means chase no more than that many links and then stop."
1264 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1267 ;; Handle `..' by hand, since it needs to work in the
1268 ;; target of any directory symlink.
1269 ;; This code is not quite complete; it does not handle
1270 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1274 ;; Chase links in the default dir of the symlink.
1278 ;; Now find the parent of that dir.
1282 newname))
1284 ;; A handy function to display file sizes in human-readable form.
1285 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1287 "Produce a string showing FILE-SIZE in human-readable form.
1289 Optional second argument FLAVOR controls the units and the display format:
1291 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1293 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1295 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1298 1024.0
1301 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1307 "%.1f%s%s"
1309 file-size
1311 "K"
1317 "^//[^/]+/"
1318 ;; regexp-opt.el is not dumped into emacs binary.
1319 ;;(concat
1320 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1322 "File systems which ought to be mounted."
1329 "The directory for writing temporary files.
1330 In case of a remote `default-directory', this is a directory for
1331 temporary files on that remote host. If such a directory does
1332 not exist, or `default-directory' ought to be located on a
1333 mounted file system (see `mounted-file-systems'), the function
1334 returns `default-directory'.
1335 For a non-remote and non-mounted `default-directory', the value of
1336 the variable `temporary-file-directory' is returned."
1342 default-directory
1343 temporary-file-directory))))
1346 "Create a temporary file.
1347 The returned file name (created by appending some random characters at the end
1348 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1349 is guaranteed to point to a newly created empty file.
1350 You can then use `write-region' to write new data into the file.
1352 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1354 If SUFFIX is non-nil, add that at the end of the file name."
1355 ;; Create temp files with strict access rights. It's easy to
1356 ;; loosen them later, whereas it's impossible to close the
1357 ;; time-window of loose permissions otherwise.
1366 temporary-file-directory)
1368 temporary-file-directory))))
1374 nil)
1376 ;; the file was somehow created by someone else between
1377 ;; `make-temp-name' and `write-region', let's try again.
1378 nil)
1379 file)))
1382 "Create a temporary file as close as possible to `default-directory'.
1383 If PREFIX is a relative file name, and `default-directory' is a
1384 remote file name or located on a mounted file systems, the
1385 temporary file is created in the directory returned by the
1386 function `temporary-file-directory'. Otherwise, the function
1387 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1388 same meaning as in `make-temp-file'."
1397 "Change the encoding of FILE's name from CODING to NEW-CODING.
1398 The value is a new name of FILE.
1399 Signals a `file-already-exists' error if a file of the new name
1400 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1401 is non-nil. A number as fourth arg means request confirmation if
1402 the new name already exists. This is what happens in interactive
1403 use with M-x."
1406 default-file-name-coding-system))
1408 from-coding to-coding)
1410 ;; We provide the default coding only when it seems that
1411 ;; the filename is correctly decoded by the default
1412 ;; coding.
1418 filename default-coding)
1419 default-coding))
1423 ;; We provide the default coding only when a user is going to
1424 ;; change the encoding not from the default coding.
1428 filename from-coding)))
1431 filename from-coding default-coding)
1432 default-coding)))
1436 default-file-name-coding-system))
1437 ;; FILE should have been decoded by DEFAULT-CODING.
1441 ;; Suppress further encoding.
1446 newname))
1447 \f
1449 "Whether confirmation is requested before visiting a new file or buffer.
1450 If nil, confirmation is not requested.
1451 If the value is `after-completion', confirmation is only
1452 requested if the user called `minibuffer-complete' right before
1453 `minibuffer-complete-and-exit'.
1454 Any other non-nil value means to request confirmation.
1456 This affects commands like `switch-to-buffer' and `find-file'."
1464 "Whether to request confirmation before visiting a new file or buffer.
1465 The variable `confirm-nonexistent-file-or-buffer' determines the
1466 return value, which may be passed as the REQUIRE-MATCH arg to
1467 `read-buffer' or `find-file-read-args'."
1475 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1477 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1478 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1479 instead of prepending it.
1481 BODY should use the minibuffer at most once.
1482 Recursive uses of the minibuffer are unaffected (FUN is not
1483 called additional times).
1485 This macro actually adds an auxiliary function that calls FUN,
1486 rather than FUN itself, to `minibuffer-setup-hook'."
1497 ;; Clear out this hook so it does not interfere
1498 ;; with any recursive minibuffer usage.
1509 t))
1512 "Edit file FILENAME.
1513 Switch to a buffer visiting file FILENAME,
1514 creating one if none already exists.
1515 Interactively, the default if you just type RET is the current directory,
1516 but the visited file name is available through the minibuffer history:
1517 type M-n to pull it into the minibuffer.
1519 You can visit files on remote machines by specifying something
1520 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1521 also visit local files as a different user by specifying
1522 /sudo::FILE for the file name.
1523 See the Info node `(tramp)File name Syntax' in the Tramp Info
1524 manual, for more about this.
1526 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1527 expand wildcards (if any) and visit multiple files. You can
1528 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1530 To visit a file without any kind of conversion and without
1541 "Edit file FILENAME, in another window.
1544 an existing one. See the function `display-buffer'.
1546 Interactively, the default if you just type RET is the current directory,
1547 but the visited file name is available through the minibuffer history:
1548 type M-n to pull it into the minibuffer.
1550 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1551 expand wildcards (if any) and visit multiple files."
1561 value)
1565 "Edit file FILENAME, in another frame.
1568 an existing one. See the function `display-buffer'.
1570 Interactively, the default if you just type RET is the current directory,
1571 but the visited file name is available through the minibuffer history:
1572 type M-n to pull it into the minibuffer.
1574 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1575 expand wildcards (if any) and visit multiple files."
1585 value)
1589 "Edit the existing file FILENAME.
1591 file names with wildcards."
1608 value))
1611 "Edit file FILENAME but don't allow changes.
1620 "Edit file FILENAME in another window but don't allow changes.
1629 "Edit file FILENAME in another frame but don't allow changes.
1638 "Find file FILENAME as a replacement for the file in the next window.
1639 This command does not select that window.
1643 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1644 expand wildcards (if any) and replace the file with multiple files."
1655 "Find alternate file: " file-dir nil
1657 t))))
1664 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1666 "Hook run when a buffer is killed.
1667 The buffer being killed is current while the hook is running.
1668 See `kill-buffer'.
1670 Note: Be careful with let-binding this hook considering it is
1674 "Find file FILENAME, select its buffer, kill previous buffer.
1675 If the current buffer now contains an empty file that you just visited
1676 \(presumably by mistake), use this command to visit the file you really want.
1680 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1681 expand wildcards (if any) and replace the file with multiple files.
1683 If the current buffer is an indirect buffer, or the base buffer
1684 for one or more indirect buffers, the other buffer(s) are not
1685 killed."
1694 "Find alternate file: " file-dir nil
1696 t)))
1710 ;; Run `kill-buffer-hook' here. It needs to happen before
1711 ;; variables like `buffer-file-name' etc are set to nil below,
1712 ;; because some of the hooks that could be invoked
1713 ;; (e.g., `save-place-to-alist') depend on those variables.
1714 ;;
1715 ;; Note that `kill-buffer-hook' is not what queries whether to
1716 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1717 ;; asks that itself. Thus, there's no need to temporarily do
1718 ;; `(set-buffer-modified-p nil)' before running this hook.
1720 ;; Okay, now we can end-of-life the old buffer.
1727 ;; This prevents us from finding the same buffer
1728 ;; if we specified the same file again.
1732 ;; Likewise for dired buffers.
1736 ;; This executes if find-file gets an error
1737 ;; and does not really find anything.
1738 ;; We put things back as they were.
1739 ;; If find-file actually finds something, we kill obuf below.
1748 ;; We already ran these; don't run them again.
1751 \f
1752 ;; FIXME we really need to fold the uniquify stuff in here by default,
1753 ;; not using advice, and add it to the doc string.
1755 "Create a suitably named buffer for visiting FILENAME, and return it.
1756 FILENAME (sans directory) is used unchanged if that name is free;
1757 otherwise a string <2> or <3> or ... is appended to get an unused name.
1759 Emacs treats buffers whose names begin with a space as internal buffers.
1760 To avoid confusion when visiting a file whose name begins with a space,
1767 lastname))))
1770 "Create and return a buffer with a name based on NAME.
1771 Choose the buffer's name using `generate-new-buffer-name'."
1775 "Regexp to match the automounter prefix in a directory name."
1784 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1786 home directory is a root directory) and removes automounter prefixes
1787 \(see the variable `automount-dir-prefix')."
1788 ;; Get rid of the prefixes added by the automounter.
1795 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1796 ;; To fix this right, we need a `file-name-case-sensitive-p'
1797 ;; function, but we don't have that yet, so just guess.
1800 ;; If any elt of directory-abbrev-alist matches this name,
1801 ;; abbreviate accordingly.
1807 ;; Compute and save the abbreviated homedir name.
1808 ;; We defer computing this until the first time it's needed, to
1809 ;; give time for directory-abbrev-alist to be set properly.
1810 ;; We include a slash at the end, to avoid spurious matches
1811 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1818 ;; If FILENAME starts with the abbreviated homedir,
1819 ;; make it start with `~' instead.
1821 ;; If the home dir is just /, don't change it.
1824 ;; MS-DOS root directories can come with a drive letter;
1825 ;; Novell Netware allows drive letters beyond `Z:'.
1833 filename)))
1836 "Return the buffer visiting file FILENAME (a string).
1837 This is like `get-file-buffer', except that it checks for any buffer
1838 visiting the same file, possibly under a different name.
1839 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1840 and others are ignored.
1841 If there is no such live buffer, return nil."
1854 found)
1864 ;; Verify this buffer's file number
1865 ;; still belongs to its file.
1868 attributes)
1872 found))))
1873 \f
1875 "Non-nil means file-visiting commands should handle wildcards.
1876 For example, if you specify `*.c', that would visit all the files
1877 whose names match the pattern."
1883 "Non-nil means suppress warning messages for symlinked files.
1884 When nil, Emacs prints a warning when visiting a file that is already
1885 visited, but with a different name. Setting this option to t
1886 suppresses this warning."
1892 "Maximum size of file above which a confirmation is requested.
1893 When nil, never request confirmation."
1900 "Warn if file size exceeds this percentage of available free memory.
1901 When nil, never issue warning. Beware: This probably doesn't do what you
1909 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1910 OP-TYPE specifies the file operation being performed (for message to user)."
1919 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1929 "You are trying to open a file whose size (%s)
1930 exceeds the %S%% of currently available free memory (%s).
1931 If that fails, try to open it with `find-file-literally'
1932 \(but note that some characters might be displayed incorrectly)."
1934 out-of-memory-warning-percentage
1938 "Like `message', except sometimes don't print to minibuffer.
1939 If the variable `save-silently' is non-nil, the message is not
1940 displayed on the minibuffer."
1945 "Read file FILENAME into a buffer and return the buffer.
1946 If a buffer exists visiting FILENAME, return that one, but
1947 verify that the file has not changed since visited or saved.
1948 The buffer is not selected, just returned to the caller.
1949 Optional second arg NOWARN non-nil means suppress any warning messages.
1950 Optional third arg RAWFILE non-nil means the file is read literally.
1951 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1952 and visit all the matching files. When wildcards are actually
1953 used and expanded, return a list of buffers that are visiting
1954 the various files."
1961 'find-directory-functions
1964 filename)))
1967 find-file-wildcards
1981 ;; Find any buffer for a file which has same truename.
1983 ;; Let user know if there is a buffer with the same truename.
1987 find-file-suppress-same-file-warnings
1991 ;; Optionally also find that buffer.
1994 ;; Check to see if the file looks uncommonly large.
1999 ;; We are using an existing buffer.
2006 ;; Certain files should be reverted automatically
2007 ;; if they have changed on disk and not in the buffer.
2015 found))
2025 "File %s changed on disk. Discard your edits? "
2030 "File %s changed on disk. Discard your edits in %s? "
2038 ;; Check if a formerly read-only file has become
2039 ;; writable and vice versa, but if the buffer agrees
2040 ;; with the new state of the file, that is ok too.
2050 buffer-file-name
2051 new-status new-status)))
2057 nonexistent
2058 ;; It is confusing to ask whether to visit
2059 ;; non-literally if they have the file in
2060 ;; hexl-mode or image-mode.
2066 "The file %s is already visited normally,
2067 and you have edited the buffer. Now you have asked to visit it literally,
2068 meaning no coding system handling, format conversion, or local variables.
2069 Emacs can only visit a file in one way at a time.
2071 Do you want to save the file, and visit it literally instead? "
2072 "The file %s is already visited literally,
2073 meaning no coding system handling, format conversion, or local variables.
2074 You have edited the buffer. Now you have asked to visit the file normally,
2075 but Emacs can only visit a file in one way at a time.
2082 rawfile truename number))
2086 "\
2087 Do you want to discard your changes, and visit the file literally now? "
2088 "\
2091 rawfile truename number)
2097 "The file %s is already visited normally.
2098 You have asked to visit it literally,
2099 meaning no coding system decoding, format conversion, or local variables.
2100 But Emacs can only visit a file in one way at a time.
2102 Do you want to revisit the file literally now? "
2103 "The file %s is already visited literally,
2104 meaning no coding system decoding, format conversion, or local variables.
2105 You have asked to visit it normally,
2106 but Emacs can only visit a file in one way at a time.
2111 rawfile truename number)
2114 ;; Return the buffer we are using.
2115 buf)
2116 ;; Create a new buffer.
2118 ;; find-file-noselect-1 may use a different buffer.
2120 rawfile truename number))))))
2126 ;; Needed in case we are re-visiting the file with a different
2127 ;; text representation.
2144 filename)))
2145 ;; Unconditionally set error
2155 filename)))
2156 ;; Run find-file-not-found-functions until one returns non-nil.
2158 ;; If they fail too, set error.
2160 ;; Record the file's truename, and maybe use that as visited name.
2168 ;; Set buffer's default directory to that of the file.
2170 ;; Turn off backup files for certain file names. Since
2171 ;; this is a permanent local, the major mode won't eliminate it.
2185 \f
2187 "Like `insert-file-contents', but only reads in the file literally.
2188 See `insert-file-contents' for an explanation of the parameters.
2189 A buffer may be modified in several ways after reading into the buffer,
2190 due to Emacs features such as format decoding, character code
2191 conversion, `find-file-hook', automatic uncompression, etc.
2193 This function ensures that none of these modifications will take place."
2199 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2200 ;; into a file operation instead!
2202 inhibit-file-name-handlers))
2209 filename)))
2210 ;; Check whether the file is uncommonly large
2221 "Insert contents of file FILENAME into buffer after point with no conversion.
2223 This function is meant for the user to run interactively.
2224 Don't call it from programs! Use `insert-file-contents-literally' instead.
2225 \(Its calling sequence is different; see its documentation)."
2231 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2232 This has the `permanent-local' property, which takes effect if you
2237 "Visit file FILENAME with no conversion of any kind.
2238 Format conversion and character code conversion are both disabled,
2239 and multibyte characters are disabled in the resulting buffer.
2240 The major mode used is Fundamental mode regardless of the file name,
2241 and local variable specifications in the file are ignored.
2242 Automatic uncompression and adding a newline at the end of the
2243 file due to `require-final-newline' is also disabled.
2245 You cannot absolutely rely on this function to result in
2246 visiting the file literally. If Emacs already has a buffer
2247 which is visiting the file, you get the existing buffer,
2248 regardless of whether it was created literally or not.
2250 In a Lisp program, if you want to be sure of accessing a file's
2251 contents literally, you should create a temporary buffer and then read
2252 the file contents into it using `insert-file-contents-literally'."
2255 "Find file literally: " nil default-directory
2258 \f
2260 _after-find-file-from-revert-buffer
2261 nomodes)
2262 "Called after finding a file and by the default revert function.
2263 Sets buffer mode, parses local variables.
2264 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2265 error in reading the file. WARN non-nil means warn if there
2266 exists an auto-save file more recent than the visited file.
2267 NOAUTO means don't mess with auto-save mode.
2268 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2269 \(see `revert-buffer-in-progress-p' for similar functionality).
2270 Fifth arg NOMODES non-nil means don't alter the file's modes.
2271 Finishes by calling the functions in `find-file-hook'
2272 unless NOMODES is non-nil."
2275 nil
2285 "Symbolic link that points to nonexistent file"
2289 ;; No need to warn if buffer is auto-saved
2290 ;; under the name of the visited file.
2292 auto-save-visited-file-name))
2295 buffer-file-name))
2315 ;; Make people do a little extra work (C-x C-q)
2316 ;; before altering a backup file.
2319 ;; When a file is marked read-only,
2320 ;; make the buffer read-only even if root is looking at it.
2328 ;; If requested, add a newline at the end of the file.
2339 view-read-only
2347 "Choose the major mode for this buffer automatically.
2348 Also sets up any specified local variables of the file.
2349 Uses the visited file name, the -*- line, and the local variables spec.
2351 This function is called automatically from `find-file'. In that case,
2352 we may set up the file-specified mode and local variables,
2353 depending on the value of `enable-local-variables'.
2354 In addition, if `local-enable-local-variables' is nil, we do
2355 not set local variables (though we do notice a mode specified with -*-.)
2357 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2358 or from Lisp without specifying the optional argument FIND-FILE;
2359 in that case, this function acts as if `enable-local-variables' were t."
2366 ;; FIXME this is less efficient than it could be, since both
2367 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2370 ;; `delay-mode-hooks' being non-nil will have prevented the major
2371 ;; mode's call to `run-mode-hooks' from calling
2372 ;; `hack-local-variables'. In that case, call it now.
2376 ;; Turn font lock off and on, to make sure it takes account of
2377 ;; whatever file local variables are relevant to it.
2379 ;; Font-lock-mode (now in font-core.el) can be ON when
2380 ;; font-lock.el still hasn't been loaded.
2387 "Non-nil means to try second pass through `auto-mode-alist'.
2388 This means that if the first case-sensitive search through the alist fails
2389 to find a matching major mode, a second case-insensitive search is made.
2390 On systems with case-insensitive file names, this variable is ignored,
2391 since only a single case-insensitive search through the alist is made."
2397 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2398 ;; c++-mode, java-mode and more) are added through autoload
2399 ;; directives in that file. That way is discouraged since it
2400 ;; spreads out the definition of the initial value.
2446 ;; Less common extensions come here
2447 ;; so more common ones above are found faster.
2455 ;; Besides .gdbinit, gdb documents other names to be usable for init
2456 ;; files, cross-debuggers can use something like
2457 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2458 ;; don't interfere with each other.
2460 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2461 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2462 ;; loaded when GDB reads an objfile called 'emacs'.
2470 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2494 ;; The Fortran standard does not say anything about file extensions.
2495 ;; .f90 was widely used for F90, now we seem to be trapped into
2496 ;; using a different extension for each language revision.
2497 ;; Anyway, the following extensions are supported by gfortran.
2505 ;; The list of archive file extensions should be in sync with
2506 ;; `auto-coding-alist' with `no-conversion' coding system.
2512 ;; Mailer puts message to be edited in
2513 ;; /tmp/Re.... or Message
2516 ;; some news reader is reported to use this
2529 ;; .emacs or .gnus or .viper following a directory delimiter in
2530 ;; Unix or MS-DOS syntax.
2533 ;; _emacs following a directory delimiter in MS-DOS syntax
2537 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2538 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2539 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2542 ;; .xs is also used for ld scripts, but seems to be more commonly
2543 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2545 ;; Explained in binutils ld/genscripts.sh. Eg:
2546 ;; A .x script file is the default script.
2547 ;; A .xr script is for linking without relocation (-r flag). Etc.
2551 ;; Common Lisp ASDF package system.
2558 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2570 ;; Windows candidates may be opened case sensitively on Unix
2576 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2577 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2578 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2579 ;; this has lower priority to avoid matching changelog.sgml etc.
2581 ;; either user's dot-files or under /etc or some such
2583 ;; alas not all ~/.*rc files are like this
2584 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2589 ;; this contains everything twice, with space and with colon :-(
2591 ;; Get rid of any trailing .n.m and try again.
2592 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2593 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2594 ;; Using mode nil rather than `ignore' would let the search continue
2595 ;; through this list (with the shortened name) rather than start over.
2598 ;; This should come after "in" stripping (e.g. config.h.in).
2599 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2601 ;; The following should come after the ChangeLog pattern
2602 ;; for the sake of ChangeLog.1, etc.
2603 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2605 "Alist of filename patterns vs corresponding major mode functions.
2606 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2607 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2608 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2609 mode function to use. FUNCTION will be called, unless it is nil.
2611 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2612 calling FUNCTION (if it's not nil), we delete the suffix that matched
2613 REGEXP and search the list again for another match.
2615 The extensions whose FUNCTION is `archive-mode' should also
2616 appear in `auto-coding-alist' with `no-conversion' coding system.
2618 See also `interpreter-mode-alist', which detects executable script modes
2619 based on the interpreters they specify to run,
2624 "Select Conf mode or XML mode according to start of file."
2634 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2635 ;; and pike-mode) are added through autoload directives in that
2636 ;; file. That way is discouraged since it spreads out the
2637 ;; definition of the initial value.
2666 "Alist mapping interpreter names to major modes.
2667 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2668 Each element looks like (REGEXP . MODE).
2669 If REGEXP matches the entire name (minus any directory part) of
2670 the interpreter specified in the first line of a script, enable
2671 major mode MODE.
2678 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2679 ;; because we are duplicating info from auto-mode-alist.
2680 ;; TODO many elements of this list are also in auto-coding-alist.
2689 "List of regexps matching file names in which to ignore local variables.
2691 Files matching this list are typically binary file formats.
2692 They may happen to contain sequences that look like local variable
2693 specifications, but are not really, or they may be containers for
2694 member files with their own local variable sections, which are
2695 not appropriate for the containing file.
2702 "List of regexps matching suffixes to remove from file names.
2703 The function `inhibit-local-variables-p' uses this: when checking
2704 a file name, it first discards from the end of the name anything that
2707 ;; Can't think of any situation in which you'd want this to be nil...
2712 "Return non-nil if file local variables should be ignored.
2713 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2714 and `inhibit-local-variables-suffixes'. If
2715 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2724 sufs)
2729 temp))
2734 "Regexp matching interpreters, for file mode determination.
2735 This regular expression is matched against the first line of a file
2736 to determine the file's mode in `set-auto-mode'. If it matches, the file
2737 is assumed to be interpreted by the interpreter matched by the second group
2738 of the regular expression. The mode is then determined as the mode
2742 "Alist of buffer beginnings vs. corresponding major mode functions.
2743 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2744 After visiting a file, if REGEXP matches the text at the beginning of the
2745 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2746 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2747 major mode.
2749 If FUNCTION is nil, then it is not called. (That is a way of saying
2757 ;; The < comes before the groups (but the first) to reduce backtracking.
2758 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2759 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2763 comment-re "*"
2766 . html-mode)
2768 ;; These two must come after html, because they are more general:
2773 . sgml-mode)
2776 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2777 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2778 After visiting a file, if REGEXP matches the text at the beginning of the
2779 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2780 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2781 have not specified a mode for this file.
2787 "Upper limit on `magic-mode-alist' regexp matches.
2791 "Select major mode appropriate for current buffer.
2793 To find the right major mode, this function checks for a -*- mode tag
2794 checks for a `mode:' entry in the Local Variables section of the file,
2795 checks if it uses an interpreter listed in `interpreter-mode-alist',
2796 matches the buffer beginning against `magic-mode-alist',
2797 compares the filename against the entries in `auto-mode-alist',
2798 then matches the buffer beginning against `magic-fallback-mode-alist'.
2800 If `enable-local-variables' is nil, or if the file name matches
2801 `inhibit-local-variables-regexps', this function does not check
2802 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2803 is nil, then the only mode: tag that can be relevant is a -*- one.
2805 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2806 set the major mode only if that would change it. In other words
2807 we don't actually set it to the same mode the buffer already has."
2808 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2810 end done mode modes)
2811 ;; Once we drop the deprecated feature where mode: is also allowed to
2812 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2813 ;; remove this section and just let (hack-local-variables t) handle it.
2814 ;; Find a -*- mode tag.
2818 ;; Note by design local-enable-local-variables does not matter here.
2820 try-locals
2823 ;; Find all specifications for the `mode:' variable
2824 ;; and execute them left to right.
2836 modes)))
2837 ;; Simple -*-MODE-*- case.
2840 modes))))
2841 ;; If we found modes to use, invoke them now, outside the save-excursion.
2849 ;; continuing would call minor modes again, toggling them off
2851 ;; hack-local-variables checks local-enable-local-variables etc, but
2852 ;; we might as well be explicit here for the sake of clarity.
2854 enable-local-variables
2855 local-enable-local-variables
2856 try-locals
2863 ;; If we didn't, look for an interpreter specified in the first line.
2864 ;; As a special case, allow for things like "#!/bin/env perl", which
2865 ;; finds the interpreter anywhere in $PATH.
2871 ;; Map interpreter name to a mode, signaling we're done at the
2872 ;; same time.
2879 interpreter-mode-alist)
2881 ;; If we found an interpreter mode to use, invoke it now.
2883 ;; Next try matching the buffer beginning against magic-mode-alist.
2897 ;; Next compare the filename against the entries in auto-mode-alist.
2902 ;; Remove backup-suffixes from file name.
2904 ;; Remove remote file name identification.
2909 ;; Find first matching alist entry.
2912 ;; System is case-insensitive.
2916 ;; System is case-sensitive.
2918 ;; First match case-sensitively.
2922 ;; Fallback to case-insensitive match.
2936 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2953 ;; When `keep-mode-if-same' is set, we are working on behalf of
2954 ;; set-visited-file-name. In that case, if the major mode specified is the
2955 ;; same one we already have, don't actually reset it. We don't want to lose
2956 ;; minor modes such as Font Lock.
2958 "Apply MODE and return it.
2959 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2960 any aliases and compared to current major mode. If they are the
2961 same, do nothing and return nil."
2967 mode)))
2970 "Regexp of lines to skip when looking for file-local settings.
2971 If the first line matches this regular expression, then the -*-...-*- file-
2975 "Find the -*- spec in the buffer.
2976 Call with point at the place to start searching from.
2977 If one is found, set point to the beginning and return the position
2978 of the end. Otherwise, return nil; may change point.
2979 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2980 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2981 have no effect."
2984 ;; Don't look for -*- if this file name matches any
2985 ;; of the regexps in inhibit-local-variables-regexps.
2988 ;; If the file begins with "#!" (exec
2989 ;; interpreter magic), look for mode frobs
2990 ;; in the first two lines. You cannot
2991 ;; necessarily put them in the first line
2992 ;; of such a file without screwing up the
2993 ;; interpreter invocation. The same holds
2994 ;; for '\" in man pages (preprocessor
2995 ;; magic for the `man' program).
3006 end))))
3007 \f
3008 ;;; Handling file local variables
3012 file-local-variables-alist dir-local-variables-alist)
3017 "Normal hook run after processing a file's local variables specs.
3018 Major modes can use this to examine user-specified local variables
3022 "List variable-value pairs that are considered safe.
3023 Each element is a cons cell (VAR . VAL), where VAR is a variable
3024 symbol and VAL is a value that is considered safe."
3025 :risky t
3030 ;; This should be here at least as long as Emacs supports write-file-hooks.
3035 "Expressions that are considered safe in an `eval:' local variable.
3036 Add expressions to this list if you want Emacs to evaluate them, when
3037 they appear in an `eval' local variable specification, without first
3038 asking you for confirmation."
3039 :risky t
3044 ;; Risky local variables:
3047 buffer-auto-save-file-name
3048 buffer-file-name
3049 buffer-file-truename
3050 buffer-undo-list
3051 debugger
3052 default-text-properties
3053 eval
3054 exec-directory
3055 exec-path
3056 file-name-handler-alist
3057 frame-title-format
3058 global-mode-string
3059 header-line-format
3060 icon-title-format
3061 inhibit-quit
3062 load-path
3063 max-lisp-eval-depth
3064 max-specpdl-size
3065 minor-mode-map-alist
3066 minor-mode-overriding-map-alist
3067 mode-line-format
3068 mode-name
3069 overriding-local-map
3070 overriding-terminal-local-map
3071 process-environment
3072 standard-input
3073 standard-output
3074 unread-command-events))
3076 ;; Safe local variables:
3077 ;;
3078 ;; For variables defined by major modes, the safety declarations can go into
3079 ;; the major mode's file, since that will be loaded before file variables are
3080 ;; processed.
3081 ;;
3082 ;; For variables defined by minor modes, put the safety declarations in the
3083 ;; file defining the minor mode after the defcustom/defvar using an autoload
3084 ;; cookie, e.g.:
3085 ;;
3086 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3087 ;;
3088 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3089 ;; minor mode file may not be loaded yet.
3090 ;;
3091 ;; For variables defined in the C source code the declaration should go here:
3113 "Alist of file-local variable settings in the current buffer.
3114 Each element in this list has the form (VAR . VALUE), where VAR
3115 is a file-local variable (a symbol) and VALUE is the value
3116 specified. The actual value in the buffer may differ from VALUE,
3122 "Alist of directory-local variable settings in the current buffer.
3123 Each element in this list has the form (VAR . VALUE), where VAR
3124 is a directory-local variable (a symbol) and VALUE is the value
3125 specified in .dir-locals.el. The actual value in the buffer
3126 may differ from VALUE, if it is changed by the major or minor modes,
3131 "Normal hook run before setting file-local variables.
3132 It is called after checking for unsafe/risky variables and
3133 setting `file-local-variables-alist', and before applying the
3134 variables stored in `file-local-variables-alist'. A hook
3135 function is allowed to change the contents of this alist.
3137 This hook is called only if there is at least one file-local
3141 "Get confirmation before setting up local variable values.
3142 ALL-VARS is the list of all variables to be set up.
3143 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3144 RISKY-VARS is the list of those that are marked as risky.
3145 If these settings come from directory-local variables, then
3146 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3153 unsafe-vars))
3155 ;; Set up the contents of the *Local Variables* buffer.
3163 ", and variables that are risky (**)."
3171 y -- to apply the local variables list.
3175 ! -- to apply the local variables list, and permanently mark these
3187 ;; Make strings with embedded whitespace easier to read.
3195 ;; Display the buffer and read a choice.
3203 ""
3206 char)
3225 "Return local variables specified in the -*- line.
3226 Usually returns an alist of elements (VAR . VAL), where VAR is a
3227 variable and VAL is the specified value. Ignores any
3228 specification for `coding:', and sometimes for `mode' (which
3229 should have already been handled by `set-auto-coding' and
3230 `set-auto-mode', respectively). Return nil if the -*- line is
3231 malformed.
3233 If HANDLE-MODE is nil, we return the alist of all the local
3234 variables in the line except `coding' as described above. If it
3235 is neither nil nor t, we do the same, except that any settings of
3236 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3237 all settings in the line except for `mode', which \(if present) we
3238 return as the symbol specifying the mode."
3243 result)
3245 nil)
3247 ;; Simple form: "-*- MODENAME -*-".
3251 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3252 ;; (last ";" is optional).
3253 ;; If HANDLE-MODE is t, just check for `mode'.
3254 ;; Otherwise, parse the -*- line into the RESULT alist.
3262 ;; There used to be a downcase here,
3263 ;; but the manual didn't say so,
3264 ;; and people want to set var names that aren't all lc.
3270 ;; It is traditional to ignore
3271 ;; case when checking for `mode' in set-auto-mode,
3272 ;; so we must do that here as well.
3273 ;; That is inconsistent, but we're stuck with it.
3274 ;; The same can be said for `coding' in set-auto-coding.
3288 ;; Downcase "Mode:".
3291 val)
3292 result)
3295 result))))))
3298 "Filter local variable settings, querying the user if necessary.
3299 VARIABLES is the alist of variable-value settings. This alist is
3300 filtered based on the values of `ignored-local-variables',
3301 `enable-local-eval', `enable-local-variables', and (if necessary)
3302 user interaction. The results are added to
3303 `file-local-variables-alist', without applying them.
3304 If these settings come from directory-local variables, then
3305 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3306 ;; Find those variables that we may want to save to
3307 ;; `safe-local-variable-values'.
3313 ;; Ignore any variable in `ignored-local-variables'.
3314 nil)
3315 ;; Obey `enable-local-eval'.
3319 ;; In case previously marked safe (bug#5636).
3321 ;; If not safe and e-l-v = :safe, ignore totally.
3325 safe
3327 ;; Ignore duplicates (except `mode') in the present list.
3329 ;; Accept known-safe variables.
3333 ;; The variable is either risky or unsafe:
3340 ;; Query, unless all vars are safe or user wants no querying.
3346 risky-vars dir-name))
3356 ;; TODO? Warn once per file rather than once per session?
3360 "Parse and put into effect this buffer's local variables spec.
3361 Uses `hack-local-variables-apply' to apply the variables.
3363 If HANDLE-MODE is nil, we apply all the specified local
3364 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3365 except that any settings of `mode' are ignored.
3368 is specified, and return the corresponding mode symbol, or nil.
3369 In this case, we try to ignore minor-modes, and only return a
3370 major-mode.
3372 If `enable-local-variables' or `local-enable-local-variables' is nil,
3373 this function does nothing. If `inhibit-local-variables-regexps'
3374 applies to the file in question, the file is not scanned for
3375 local variables, but directory-local variables may still be applied."
3376 ;; We don't let inhibit-local-variables-p influence the value of
3377 ;; enable-local-variables, because then it would affect dir-local
3378 ;; variables. We don't want to search eg tar files for file local
3379 ;; variable sections, but there is no reason dir-locals cannot apply
3380 ;; to them. The real meaning of inhibit-local-variables-p is "do
3381 ;; not scan this file for local variables".
3384 result)
3388 ;; Note this is a no-op if enable-local-variables is nil.
3390 ;; This entire function is basically a no-op if enable-local-variables
3391 ;; is nil. All it does is set file-local-variables-alist to nil.
3393 ;; This part used to ignore enable-local-variables when handle-mode
3394 ;; was t. That was inappropriate, eg consider the
3395 ;; (artificial) example of:
3396 ;; (setq local-enable-local-variables nil)
3397 ;; Open a file foo.txt that contains "mode: sh".
3398 ;; It correctly opens in text-mode.
3399 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3401 ;; If HANDLE-MODE is t, and the prop line specifies a
3402 ;; mode, then we're done, and have no need to scan further.
3404 handle-mode))
3406 ;; Look for "Local variables:" line in last page.
3414 ;; suffix is what comes after "local variables:" in its line.
3415 ;; prefix is what comes before "local variables:" in its line.
3428 endpos
3434 nil t))
3435 ;; This used to be an error, but really all it means is
3436 ;; that this may simply not be a local-variables section,
3437 ;; so just ignore it.
3447 ;; Discard the prefix.
3452 ;; Discard the suffix.
3461 ;; Find the variable name;
3469 val val2)
3472 ;; Read the variable value.
3479 ;; Specifying minor-modes via mode: is
3480 ;; deprecated, but try to reject them anyway.
3490 'files
3492 "%s: `lexical-binding' at end of file unreliable"
3494 ;; We are called from
3495 ;; 'with-temp-buffer', so we need
3496 ;; to use 'thisbuf's name in the
3497 ;; warning message.
3503 'eval
3507 ;; Now we've read all the local variables.
3508 ;; If HANDLE-MODE is t, return whether the mode was specified.
3510 ;; Otherwise, set the variables.
3515 "Apply the elements of `file-local-variables-alist'.
3516 If there are any elements, runs `before-hack-local-variables-hook',
3517 then calls `hack-one-local-variable' to apply the alist elements one by one.
3518 Finishes by running `hack-local-variables-hook', regardless of whether
3519 the alist is empty or not.
3521 Note that this function ignores a `mode' entry if it specifies the same
3522 major mode as the buffer already has."
3524 ;; Any 'evals must run in the Right sequence.
3533 "Non-nil if SYM is safe as a file-local variable with value VAL.
3534 It is safe if any of these conditions are met:
3536 * There is a matching entry (SYM . VAL) in the
3537 `safe-local-variable-values' user option.
3539 * The `safe-local-variable' property of SYM is a function that
3540 evaluates to a non-nil value with VAL as an argument."
3544 ;; If the function signals an error, that means it
3545 ;; can't assure us that the value is safe.
3549 "Non-nil if SYM could be dangerous as a file-local variable.
3550 It is dangerous if either of these conditions are met:
3552 * Its `risky-local-variable' property is non-nil.
3558 ;; If this is an alias, check the base name.
3578 "Return t if it is safe to eval EXP when it is found in a file."
3580 ;; Detect certain `put' expressions.
3587 lisp-indent-function
3588 scheme-indent-function))
3589 ;; Only allow safe values (not functions).
3594 ;; Only allow indirect form specs.
3595 ;; During bootstrapping, edebug-basic-spec might not be
3596 ;; defined yet.
3600 ;; Allow expressions that the user requested.
3602 ;; Certain functions can be allowed with safe arguments
3603 ;; or can specify verification functions to try.
3605 ;; Allow (minor)-modes calls with no arguments.
3606 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3615 ok))
3623 ok))))))))
3637 "Set local variable VAR with value VAL.
3638 If VAR is `mode', call `VAL-mode' as a function unless it's
3639 already the major mode."
3641 (`mode
3647 (`eval
3653 ;; Make sure the string has no text properties.
3654 ;; Some text properties can get evaluated in various ways,
3655 ;; so it is risky to put them on with a local variable list.
3659 \f
3660 ;;; Handling directory-local variables, aka project settings.
3666 "List of cached directory roots for directory-local variable classes.
3667 Each element in this list has the form (DIR CLASS MTIME).
3668 DIR is the name of the directory.
3669 CLASS is the name of a variable class (a symbol).
3670 MTIME is the recorded modification time of the directory-local
3671 variables file associated with this entry. This time is a list
3672 of integers (the same format as `file-attributes'), and is
3673 used to test whether the cache entry is still valid.
3674 Alternatively, MTIME can be nil, which means the entry is always
3678 "Return the variable list for CLASS."
3682 "Collect directory-local variables from MODE-VARIABLES.
3683 VARIABLES is the initial list of variables.
3684 Returns the new list."
3689 ;; If variables are specified more than once, only use the last. (Why?)
3690 ;; The pseudo-variables mode and eval are different (bug#3430).
3693 ;; Need a new cons in case we setcdr later.
3697 "Collect entries from CLASS-VARIABLES into VARIABLES.
3698 ROOT is the root directory of the project.
3699 Return the new variables list."
3701 ;; Handle non-file buffers, too.
3704 ;; FIXME: Why not use file-relative-name?
3711 ;; Don't include this in the previous condition, because we
3712 ;; want to filter all strings before the next condition.
3726 ;; TODO someone might want to extend this to allow
3727 ;; integer values for subdir, where N means
3728 ;; variables apply to this directory and N levels
3729 ;; below it (0 == nil).
3732 alist variables))))))))
3734 ;; The file's content might be invalid (e.g. have a merge conflict), but
3735 ;; that shouldn't prevent the user from opening the file.
3737 nil))))
3740 "Declare that the DIRECTORY root is an instance of CLASS.
3741 DIRECTORY is the name of a directory, a string.
3742 CLASS is the name of a project class, a symbol.
3743 MTIME is either the modification time of the directory-local
3744 variables file that defined this class, or nil.
3746 When a file beneath DIRECTORY is visited, the mode-specific
3747 variables from CLASS are applied to the buffer. The variables
3748 for a class are defined using `dir-locals-set-class-variables'."
3755 "Map the type CLASS to a list of variable settings.
3756 CLASS is the project class, a symbol. VARIABLES is a list
3757 that declares directory-local variables for the class.
3758 An element in VARIABLES is either of the form:
3759 (MAJOR-MODE . ALIST)
3760 or
3761 (DIRECTORY . LIST)
3763 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3764 whose elements are of the form (VARIABLE . VALUE).
3766 In the second form, DIRECTORY is a directory name (a string), and
3767 LIST is a list of the form accepted by the function.
3769 When a file is visited, the file's class is found. A directory
3770 may be assigned a class using `dir-locals-set-directory-class'.
3771 Then variables are set in the file's buffer according to the
3772 VARIABLES list of the class. The list is processed in order.
3774 * If the element is of the form (MAJOR-MODE . ALIST), and the
3775 buffer's major mode is derived from MAJOR-MODE (as determined
3776 by `derived-mode-p'), then all the variables in ALIST are
3777 applied. A MAJOR-MODE of nil may be used to match any buffer.
3778 `make-local-variable' is called for each variable before it is
3779 set.
3781 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3782 is an initial substring of the file's directory, then LIST is
3783 applied by recursively following these rules."
3787 "File that contains directory-local variables.
3788 It has to be constant to enforce uniform values across different
3789 environments and users.
3790 See also `dir-locals-file-2', whose values override this one's.
3794 "File that contains directory-local variables.
3795 This essentially a second file that can be used like
3796 `dir-locals-file', so that users can have specify their personal
3797 dir-local variables even if the current directory already has a
3798 `dir-locals-file' that is shared with other users (such as in a
3799 git repository).
3803 "Return a list of all readable dir-locals files in DIRECTORY.
3804 The returned list is sorted by increasing priority. That is,
3805 values specified in the last file should take precedence over
3806 those in the first."
3810 dir-locals-file)
3811 directory))
3815 ;; The order here is important.
3822 out)))
3825 "Find the directory-local variables for FILE.
3826 This searches upward in the directory tree from FILE.
3827 It stops at the first directory that has been registered in
3828 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3829 If it finds an entry in the cache, it checks that it is valid.
3830 A cache entry with no modification time element (normally, one that
3831 has been assigned directly using `dir-locals-set-directory-class', not
3832 set from a file) is always valid.
3833 A cache entry based on a `dir-locals-file' is valid if the modification
3834 time stored in the cache matches the current file modification time.
3835 If not, the cache entry is cleared so that the file will be re-read.
3837 This function returns either:
3838 - nil (no directory local variables found),
3839 - the matching entry from `dir-locals-directory-cache' (a list),
3840 - or the full path to the directory (a string) containing at
3841 least one `dir-locals-file' in the case of no valid cache
3842 entry."
3846 dir-elt)
3847 ;; `locate-dominating-file' may have abbreviated the name.
3850 ;; Find the best cached value in `dir-locals-directory-cache'.
3861 ;; Found a potential cache entry. Check validity.
3862 ;; A cache entry with no MTIME is assumed to always be valid
3863 ;; (ie, set directly, not from a dir-locals file).
3864 ;; Note, we don't bother to check that there is a matching class
3865 ;; element in dir-locals-class-alist, since that's done by
3866 ;; dir-locals-set-directory-class.
3869 ;; The entry MTIME should match the most recent
3870 ;; MTIME among matching files.
3876 cached-files))))))
3877 ;; This cache entry is OK.
3878 dir-elt
3879 ;; This cache entry is invalid; clear it.
3882 ;; Return the first existing dir-locals file. Might be the same
3883 ;; as dir-elt's, might not (eg latter might have been deleted).
3884 locals-dir)
3885 ;; No cache entry.
3886 locals-dir)))
3889 "Load all variables files in DIR and register a new class and instance.
3890 DIR is the absolute name of a directory which must contain at
3891 least one dir-local file (which is a file holding variables to
3892 apply).
3893 Return the new class name, which is a symbol named DIR."
3907 variables
3913 dir class-name
3918 files))
3919 ;; If there was a problem, use the values we could get but
3920 ;; don't let the cache prevent future reads.
3922 class-name))
3928 "Non-nil means dir-local variables will be applied to remote files."
3936 "Read per-directory local variables for the current buffer.
3937 Store the directory-local variables in `dir-local-variables-alist'
3938 and `file-local-variables-alist', without applying them.
3940 This does nothing if either `enable-local-variables' or
3941 `enable-dir-local-variables' are nil."
3943 enable-dir-local-variables
3946 default-directory)))))
3947 ;; Find the variables file.
3977 "Apply directory-local variables to a non-file buffer.
3978 For non-file buffers, such as Dired buffers, directory-local
3979 variables are looked for in `default-directory' and its parent
3980 directories."
3984 \f
3987 However, the mode will not be changed if
3988 \(1) a local variables list or the `-*-' line specifies a major mode, or
3990 not suitable for ordinary files, or
3991 \(3) the new file name does not particularly specify any mode."
3996 "Change name of file visited in current buffer to FILENAME.
3997 This also renames the buffer to correspond to the new file.
3998 The next time the buffer is saved it will go in the newly specified file.
3999 FILENAME nil or an empty string means mark buffer as not visiting any file.
4000 Remember to delete the initial contents of the minibuffer
4001 if you wish to pass an empty string as the argument.
4003 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4004 confirmation in the case where another buffer is already visiting FILENAME.
4006 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4007 the old visited file has been renamed to the new name FILENAME."
4015 nil
4030 filename)))
4037 buffer-file-name filename)
4041 ;; If new-name == old-name, renaming would add a spurious <2>
4042 ;; and it's considered as a feature in rename-buffer.
4048 ;; Abbreviate the file names of the buffer.
4057 nil))
4058 ;; write-file-functions is normally used for things like ftp-find-file
4059 ;; that visit things that are not local files as if they were files.
4060 ;; Changing to visit an ordinary local file instead should flush the hook.
4065 ;; If buffer was read-only because of version control,
4066 ;; that reason is gone now, so make it writable.
4070 ;; Turn off backup files for certain file names.
4071 ;; Since this is a permanent local, the major mode won't eliminate it.
4073 backup-enable-predicate
4082 ;; If auto-save was not already on, turn it on if appropriate.
4085 ;; If auto save is on, start using a new name. We
4086 ;; deliberately don't rename or delete the old auto save
4087 ;; for the old visited file name. This is because
4088 ;; perhaps the user wants to save the new state and then
4089 ;; compare with the previous state from the auto save
4090 ;; file.
4092 ;; Rename the old auto save file if any.
4099 ;; Update the major mode, if the file name determines it.
4101 ;; Don't change the mode if it is special.
4104 ;; Don't change the mode if the local variable list specifies it.
4105 ;; The file name can influence whether the local variables apply.
4107 ;; h-l-v also checks it, but might as well be explicit.
4110 ;; TODO consider making normal-mode handle this case.
4118 "Write current buffer into file FILENAME.
4119 This makes the buffer visit that file, and marks it as not modified.
4121 If you specify just a directory name as FILENAME, that means to use
4122 the default file name but in that directory. You can also yank
4123 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4125 If the buffer is not already visiting a file, the default file name
4126 for the output file is the buffer name.
4128 If optional second arg CONFIRM is non-nil, this function
4129 asks for confirmation before overwriting an existing file.
4130 Interactively, confirmation is required unless you supply a prefix argument."
4131 ;; (interactive "FWrite file: ")
4135 nil nil nil nil)
4139 default-directory)
4140 nil nil))
4144 ;; If arg is just a directory,
4145 ;; use the default file name, but in that directory.
4152 ;; NS does its own confirm dialog.
4155 use-dialog-box))
4161 ;; Make buffer writable if file is writable.
4166 ;; It's likely that the VC status at the new location is different from
4167 ;; the one at the old location.
4169 \f
4171 "Return an alist of extended attributes of file FILENAME.
4173 Extended attributes are platform-specific metadata about the file,
4174 such as SELinux context, list of ACL entries, etc."
4179 "Set extended attributes of file FILENAME to ATTRIBUTES.
4181 ATTRIBUTES must be an alist of file attributes as returned by
4182 `file-extended-attributes'.
4183 Value is t if the function succeeds in setting the attributes."
4194 result))
4195 \f
4197 "Make a backup of the disk file visited by the current buffer, if appropriate.
4198 This is normally done before saving the buffer the first time.
4200 A backup may be done by renaming or by copying; see documentation of
4201 variable `make-backup-files'. If it's done by renaming, then the file is
4202 no longer accessible under its old name.
4204 The value is non-nil after a backup was made by renaming.
4205 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4206 MODES is the result of `file-modes' on the original
4207 file; this means that the caller, after saving the buffer, should change
4208 the modes of the new file to agree with the old modes.
4209 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4210 on the original file; this means that the caller, after saving
4211 the buffer, should change the extended attributes of the new file
4212 to agree with the old attributes.
4213 BACKUPNAME is the backup file name, which is the old file renamed."
4217 ;; If specified name is a symbolic link, chase it to the target.
4218 ;; This makes backups in the directory where the real file is.
4225 ;; If have old versions to maybe delete,
4226 ;; ask the user to confirm now, before doing anything.
4227 ;; But don't actually delete til later.
4233 real-file-name)))
4234 targets))
4239 backup-by-copying-when-privileged-mismatch)
4242 ;; Don't rename a suid or sgid file.
4251 real-file-name
4254 copy-when-priv-mismatch))))
4256 t)))))
4257 setmodes)
4260 ;; Actually make the backup file.
4263 modes extended-attributes)
4264 ;; rename-file should delete old backup.
4267 backupname)))
4269 ;; Now delete the old versions, if desired.
4273 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4277 backupname)
4280 modes extended-attributes)
4282 setmodes)))))))
4285 ;; Create temp files with strict access rights. It's easy to
4286 ;; loosen them later, whereas it's impossible to close the
4287 ;; time-window of loose permissions otherwise.
4290 ;; Try to overwrite old backup first.
4298 nil)
4300 ;; The file was somehow created by someone else between
4301 ;; `delete-file' and `copy-file', so let's try again.
4302 ;; rms says "I think there is also a possible race
4303 ;; condition for making backup files" (emacs-devel 20070821).
4304 nil)))
4305 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4314 ;; The last ~[[:digit]]+ matches relative versions in git,
4315 ;; e.g. `foo.js.~HEAD~1~'.
4316 "Regular expression matching the backup/version part of a file name.
4320 "Return file NAME sans backup versions or strings.
4321 This is a separate procedure so your site-init or startup file can
4322 redefine it.
4323 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4324 we do not remove backup version numbers, only true file version numbers.
4325 See also `file-name-version-regexp'."
4332 name))))))
4335 "Return t if deleting FILE and rewriting it would preserve the owner.
4336 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4337 the group would be preserved too."
4342 ;; Return t if the file doesn't exist, since it's true that no
4343 ;; information would be lost by an (attempted) delete and create.
4346 ;; Files created on Windows by Administrator (RID=500)
4347 ;; have the Administrators group (RID=544) recorded as
4348 ;; their owner. Rewriting them will still preserve the
4349 ;; owner.
4353 ;; On BSD-derived systems files always inherit the parent
4354 ;; directory's group, so skip the group-gid test.
4360 ;; On some systems, a file created in a setuid directory
4361 ;; inherits that directory's owner.
4365 ;; On many systems, a file created in a setgid directory
4366 ;; inherits that directory's group. On some systems
4367 ;; this happens even if the setgid bit is not set.
4374 The extension, in a file name, is the part that begins with the last `.',
4375 except that a leading `.' of the file name, if there is one, doesn't count."
4378 directory)
4382 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4383 ;; we don't want to expand it.
4386 filename))))
4390 The extension, in a file name, is the part that begins with the last `.',
4391 excluding version numbers and backup suffixes, except that a leading `.'
4392 of the file name, if there is one, doesn't count.
4393 Return nil for extensionless file names such as `foo'.
4394 Return the empty string for file names such as `foo.'.
4396 By default, the returned value excludes the period that starts the
4397 extension, but if the optional argument PERIOD is non-nil, the period
4398 is included in the value, and in that case, if FILENAME has no
4409 "Return the base name of the FILENAME: no directory, no extension.
4410 FILENAME defaults to `buffer-file-name'."
4415 #'make-backup-file-name--default-function
4416 "A function that `make-backup-file-name' uses to create backup file names.
4417 The function receives a single argument, the original file name.
4419 If you change this, you may need to change `backup-file-name-p' and
4420 `file-name-sans-versions' too.
4422 You could make this buffer-local to do something special for specific files.
4424 For historical reasons, a value of nil means to use the default function.
4425 This should not be relied upon.
4427 See also `backup-directory-alist'."
4434 "Alist of filename patterns and backup directory names.
4435 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4436 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4437 relative or absolute. If it is absolute, so that all matching files
4438 are backed up into the same directory, the file names in this
4439 directory will be the full name of the file backed up with all
4440 directory separators changed to `!' to prevent clashes. This will not
4441 work correctly if your filesystem truncates the resulting name.
4443 For the common case of all backups going into one directory, the alist
4445 directory name.
4447 If this variable is nil, or it fails to match a filename, the backup
4448 is made in the original file's directory.
4450 On MS-DOS filesystems without long names this variable is always
4451 ignored."
4457 "Default `backup-enable-predicate' function.
4458 Checks for files in `temporary-file-directory',
4461 caseless)
4462 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4463 ;; their long file-name equivalents, so compare-strings does TRT.
4467 caseless t))
4470 ;; Directory is under temporary-file-directory.
4475 ;; Directory is under /tmp.
4480 0 nil
4482 ;; Directory is under small-temporary-file-directory.
4487 "Create the non-numeric backup file name for FILE.
4488 This calls the function that `make-backup-file-name-function' specifies,
4489 with a single argument FILE."
4492 file))
4495 "Default function for `make-backup-file-name'.
4496 Normally this just returns FILE's name with `~' appended.
4497 It searches for a match for FILE in `backup-directory-alist'.
4498 If the directory for the backup doesn't exist, it is created."
4510 "Subroutine of `make-backup-file-name--default-function'.
4511 The function `find-backup-file-name' also uses this."
4513 elt backup-directory abs-backup-directory)
4518 alist nil)))
4519 ;; If backup-directory is relative, it should be relative to the
4520 ;; file's directory. By expanding explicitly here, we avoid
4521 ;; depending on default-directory.
4530 abs-backup-directory nil))))
4532 file
4536 ;; Normalize DOSish file names: downcase the drive
4537 ;; letter, if any, and replace the leading "x:" with
4538 ;; "/drive_x".
4541 ;; Replace any invalid file-name characters (for the
4542 ;; case of backing up remote files).
4546 "drive_"
4549 ""
4552 ;; Make the name unique by substituting directory
4553 ;; separators. It may not really be worth bothering about
4554 ;; doubling `!'s in the original name...
4559 backup-directory))
4564 "Return non-nil if FILE is a backup file name (numeric or not).
4565 This is a separate function so you can redefine it for customization.
4566 You may need to redefine `file-name-sans-versions' as well."
4571 ;; This is used in various files.
4572 ;; The usage of backup-extract-version-start is not very clean,
4573 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4575 "Given the name of a numeric backup file, FN, return the backup number.
4576 Uses the free variable `backup-extract-version-start', whose value should be
4577 the index in the name where the version number begins."
4584 "Find a file name for a backup file FN, and suggestions for deletions.
4585 Value is a list whose car is the name for the backup file
4586 and whose cdr is a list of old versions to consider deleting now.
4587 If the value is nil, don't make a backup.
4588 Uses `backup-directory-alist' in the same way as
4589 `make-backup-file-name--default-function' does."
4591 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4595 ;; We don't support numbered backups on plain MS-DOS
4596 ;; when long file names are unavailable.
4606 possibilities deserve-versions-p versions)
4609 base-versions
4612 possibilities)
4613 #'<)
4618 kept-old-versions
4619 kept-new-versions
4626 ;; Delete nothing if there is overflow
4627 ;; in the number of versions to keep.
4633 v))))))))))
4636 "Return number of names file FILENAME has."
4639 ;; (defun file-relative-name (filename &optional directory)
4640 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4641 ;; This function returns a relative file name which is equivalent to FILENAME
4642 ;; when used with that default directory as the default.
4643 ;; If this is impossible (which can happen on MSDOS and Windows
4644 ;; when the file name and directory use different drive names)
4645 ;; then it returns FILENAME."
4646 ;; (save-match-data
4647 ;; (let ((fname (expand-file-name filename)))
4648 ;; (setq directory (file-name-as-directory
4649 ;; (expand-file-name (or directory default-directory))))
4650 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4651 ;; ;; drive names, they can't be relative, so return the absolute name.
4652 ;; (if (and (or (eq system-type 'ms-dos)
4653 ;; (eq system-type 'cygwin)
4654 ;; (eq system-type 'windows-nt))
4655 ;; (not (string-equal (substring fname 0 2)
4656 ;; (substring directory 0 2))))
4657 ;; filename
4658 ;; (let ((ancestor ".")
4659 ;; (fname-dir (file-name-as-directory fname)))
4660 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4661 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4662 ;; (setq directory (file-name-directory (substring directory 0 -1))
4663 ;; ancestor (if (equal ancestor ".")
4664 ;; ".."
4665 ;; (concat "../" ancestor))))
4666 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4667 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4668 ;; ;; We matched within FNAME's directory part.
4669 ;; ;; Add the rest of FNAME onto ANCESTOR.
4670 ;; (let ((rest (substring fname (match-end 0))))
4671 ;; (if (and (equal ancestor ".")
4672 ;; (not (equal rest "")))
4673 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4674 ;; rest
4675 ;; (concat (file-name-as-directory ancestor) rest)))
4676 ;; ;; We matched FNAME's directory equivalent.
4677 ;; ancestor))))))
4680 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4681 This function returns a relative file name which is equivalent to FILENAME
4682 when used with that default directory as the default.
4683 If FILENAME is a relative file name, it will be interpreted as existing in
4684 `default-directory'.
4685 If FILENAME and DIRECTORY lie on different machines or on different drives
4686 on a DOS/Windows machine, it returns FILENAME in expanded form."
4690 default-directory))))
4695 read-file-name-completion-ignore-case)))
4698 ;; Test for different filesystems on DOS/Windows
4700 ;; Should `cygwin' really be included here? --stef
4703 ;; Test for different drive letters
4705 ;; Test for UNCs on different servers
4710 ;; Windows file names cannot have ? in
4711 ;; them, so use that to detect when
4712 ;; neither FILENAME nor DIRECTORY is a
4713 ;; UNC.
4715 0 nil
4721 ;; Test for different remote file system identification
4723 filename
4731 ".."
4733 ;; Now ancestor is empty, or .., or ../.., etc.
4735 ;; We matched within FILENAME's directory part.
4736 ;; Add the rest of FILENAME onto ANCESTOR.
4739 ;; But don't bother with ANCESTOR if it would give us `./'.
4740 rest
4742 ;; We matched FILENAME's directory equivalent.
4743 ancestor))))))
4744 \f
4746 "Save current buffer in visited file if modified.
4747 Variations are described below.
4749 By default, makes the previous version into a backup file
4750 if previously requested or if this is the first save.
4752 to become a backup when the next save is done.
4754 makes the previous version into a backup file.
4756 to become a backup when the next save is done,
4757 and makes the previous version into a backup file.
4759 With a numeric prefix argument of 0, never make the previous version
4760 into a backup file.
4762 Note that the various variables that control backups, such
4763 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4764 and `backup-inhibited', to name just the more popular ones, still
4765 control whether a backup will actually be produced, even when you
4768 If a file's name is FOO, the names of its numbered backup versions are
4769 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4770 Numeric backups (rather than FOO~) will be made if value of
4771 `version-control' is not the atom `never' and either there are already
4772 numeric versions of the file being backed up, or `version-control' is
4773 non-nil.
4774 We don't want excessive versions piling up, so there are variables
4775 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4776 and `kept-new-versions', which tells how many newest versions to keep.
4777 Defaults are 2 old versions and 2 new.
4778 `dired-kept-versions' controls dired's clean-directory (.) command.
4779 If `delete-old-versions' is nil, system will query user
4780 before trimming versions. Otherwise it does it silently.
4782 If `vc-make-backup-files' is nil, which is the default,
4783 no backup files are made for files managed by version control.
4784 (This is because the version control system itself records previous versions.)
4786 See the subroutine `basic-save-buffer' for more information."
4792 ;; We used to display the message below only for files > 50KB, but
4793 ;; then Rmail-mbox never displays it due to buffer swapping. If
4794 ;; the test is ever re-introduced, be sure to handle saving of
4795 ;; Rmail files.
4805 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4806 Normally delete only if the file was written by this Emacs since
4807 the last real save, but optional arg FORCE non-nil means delete anyway."
4821 "Normal hook that is run before a buffer is saved to its file."
4827 "Normal hook that is run after a buffer is saved to its file."
4833 "If non-nil, use this coding system for saving the buffer.
4834 More precisely, use this coding system in place of the
4835 value of `buffer-file-coding-system', when saving the buffer.
4836 Calling `write-region' for any purpose other than saving the buffer
4837 will still use `buffer-file-coding-system'; this variable has no effect
4844 "Save the current buffer in its visited file, if it has been modified.
4845 The hooks `write-contents-functions' and `write-file-functions' get a chance
4846 to do the job of saving; if they do not, then the buffer is saved in
4847 the visited file in the usual way.
4848 Before and after saving the buffer, this function runs
4849 `before-save-hook' and `after-save-hook', respectively."
4852 ;; In an indirect buffer, save its base buffer instead.
4856 ;; handle the case when no modification has been made but
4857 ;; the file disappeared since visited
4861 setmodes)
4862 ;; If buffer has no file name, ask user for one.
4870 ;; Signal an error if the user specified the name of an
4871 ;; existing directory.
4874 "File `%s' exists; overwrite? "
4875 filename))
4882 "%s has changed since visited or saved. Save anyway? "
4902 ;; Support VC version backups.
4904 ;; Don't let errors prevent saving the buffer.
4909 ;; If a hook returned t, file is already "written".
4910 ;; Otherwise, write it the usual way now.
4920 ;; Now we have saved the current buffer. Let's make sure
4921 ;; that buffer-file-coding-system is fixed to what
4922 ;; actually used for saving by binding it locally.
4937 ;; If the auto-save file was recent before this command,
4938 ;; delete it now.
4940 ;; Support VC `implicit' locking.
4947 ;; This does the "real job" of writing a buffer into its visited file
4948 ;; and making a backup file. This is what is normally done
4949 ;; but inhibited if one of write-file-functions returns non-nil.
4950 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4951 ;; backup-buffer.
4961 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4962 ;; backup-buffer.
4975 "File %s is write-protected; try to save anyway? "
4977 buffer-file-name)))
4991 dir))))
4992 ;; Write temp name, then rename it.
4993 ;; This requires write access to the containing dir,
4994 ;; which is why we don't try it if we don't have that access.
4996 tempname succeed
4999 ;; Create temp files with strict access rights. It's easy to
5000 ;; loosen them later, whereas it's impossible to close the
5001 ;; time-window of loose permissions otherwise.
5006 ;; Try various temporary names.
5007 ;; This code follows the example of make-temp-file,
5008 ;; but it calls write-region in the appropriate way
5009 ;; for saving the buffer.
5015 ;; Pass in nil&nil rather than point-min&max
5016 ;; cause we're saving the whole buffer.
5017 ;; write-region-annotate-functions may use it.
5019 tempname nil realname
5022 nil)
5024 ;; The file was somehow created by someone else between
5025 ;; `make-temp-name' and `write-region', let's try again.
5026 nil)
5028 ;; Reset the umask.
5030 ;; If we failed, restore the buffer's modtime.
5033 ;; Since we have created an entirely new file,
5034 ;; make sure it gets the right permission bits set.
5039 buffer-file-name)))
5040 ;; We succeeded in writing the temp file,
5041 ;; so rename it.
5043 ;; If file not writable, see if we can make it writable
5044 ;; temporarily while we write it.
5045 ;; But no need to do so if we have just backed it up
5046 ;; (setmodes is set) because that says we're superseding.
5048 ;; Change the mode back, after writing.
5051 buffer-file-name))
5052 ;; If set-file-extended-attributes fails, fall back on
5053 ;; set-file-modes.
5063 ;; Pass in nil&nil rather than point-min&max to indicate
5064 ;; we're saving the buffer rather than just a region.
5065 ;; write-region-annotate-functions may make us of it.
5067 buffer-file-name nil t buffer-file-truename)
5070 ;; If we get an error writing the new file, and we made
5071 ;; the backup by renaming, undo the backing-up.
5076 setmodes))
5082 `((?\C-r
5089 ;; Return nil to ask about BUF again.
5090 nil)
5103 ;; Return nil to ask about BUF again.
5104 nil)
5114 "Save some modified file-visiting buffers. Asks user about each one.
5115 You can answer `y' to save, `n' not to save, `C-r' to look at the
5116 buffer in question with `view-buffer' before deciding or `d' to
5117 view the differences using `diff-buffer-with-file'.
5119 This command first saves any buffers where `buffer-save-without-query' is
5120 non-nil, without asking.
5122 Optional argument (the prefix) non-nil means save all with no questions.
5123 Optional second argument PRED determines which buffers are considered:
5124 If PRED is nil, all the file-visiting buffers are considered.
5125 If PRED is t, then certain non-file buffers will also be considered.
5126 If PRED is a zero-argument function, it indicates for each buffer whether
5127 to consider it or not when called with that buffer current.
5129 See `save-some-buffers-action-alist' if you want to
5130 change the additional actions you can take on files."
5134 files-done abbrevs-done)
5136 ;; First save any buffers that we're supposed to save unconditionally.
5137 ;; That way the following code won't ask about them.
5142 ;; Ask about those buffers that merit it,
5143 ;; and record the number thus saved.
5147 ;; Note that killing some buffers may kill others via
5148 ;; hooks (e.g. Rmail and its viewing buffer).
5161 t
5173 save-some-buffers-action-alist))
5174 ;; Maybe to save abbrevs, and record whether
5175 ;; we either saved them or asked to.
5182 ;; Don't keep bothering user if he says no.
5196 \f
5198 "Clear out records of last mod time of visited file.
5199 Next attempt to save will not complain of a discrepancy."
5203 "Mark current buffer as unmodified, not needing to be saved.
5206 It is not a good idea to use this function in Lisp programs, because it
5207 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5215 "Change whether this buffer is read-only."
5223 "Insert contents of file FILENAME into buffer after point.
5224 Set mark after the inserted text.
5226 This function is meant for the user to run interactively.
5227 Don't call it from programs! Use `insert-file-contents' instead.
5228 \(Its calling sequence is different; see its documentation)."
5234 "Append the contents of the region to the end of file FILENAME.
5235 When called from a function, expects three arguments,
5236 START, END and FILENAME. START and END are normally buffer positions
5237 specifying the part of the buffer to write.
5238 If START is nil, that means to use the entire buffer contents.
5239 If START is a string, then output that string to the file
5240 instead of any buffer contents; END is ignored.
5242 This does character code conversion and applies annotations
5243 like `write-region' does."
5249 "Return most recent backup file for FILENAME or nil if no backups exist."
5250 ;; `make-backup-file-name' will get us the right directory for
5251 ;; ordinary or numeric backups. It might create a directory for
5252 ;; backups as a side-effect, according to `backup-directory-alist'.
5259 tem)
5268 newest))
5271 "Rename current buffer to a similar name not already taken.
5272 This function is useful for creating multiple shell process buffers
5273 or multiple mail buffers, etc.
5275 Note that some commands, in particular those based on `compilation-mode'
5276 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5277 appropriate mode even if it has been renamed. So as well as renaming
5278 the buffer, you also need to switch buffers before running another
5279 instance of such commands."
5287 ;; If the existing buffer name has a <NNN>,
5288 ;; which isn't part of the file name (if any),
5289 ;; then get rid of that.
5295 "Create the directory DIR and optionally any nonexistent parent dirs.
5296 If DIR already exists as a directory, signal an error, unless
5297 PARENTS is non-nil.
5299 Interactively, the default choice of directory to create is the
5300 current buffer's default directory. That is useful when you have
5301 visited a file in a nonexistent directory.
5303 Noninteractively, the second (optional) argument PARENTS, if
5304 non-nil, says whether to create parent directories that don't
5305 exist. Interactively, this happens by default.
5307 If creating the directory or directories fail, an error will be
5308 raised."
5311 nil nil)
5312 t))
5313 ;; If default-directory is a remote directory,
5314 ;; make sure we find its make-directory handler.
5322 create-list)
5324 ;; If directory is its own parent, then we can't
5325 ;; keep looping forever
5340 "Delete the directory named DIRECTORY. Does not follow symlinks.
5341 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5342 TRASH non-nil means to trash the directory instead, provided
5343 `delete-by-moving-to-trash' is non-nil.
5345 When called interactively, TRASH is t if no prefix argument is
5346 given. With a prefix argument, TRASH is nil."
5353 "Move directory to trash: "
5355 default-directory default-directory nil nil))))
5361 nil)
5363 ;; If default-directory is a remote directory, make sure we find its
5364 ;; delete-directory handler.
5371 ;; Only move non-empty dir to trash if recursive deletion was
5372 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5373 ;; case, where the operation fails in delete-directory-internal.
5374 ;; As `move-file-to-trash' trashes directories (empty or
5375 ;; otherwise) as a unit, we do not need to recurse here.
5377 ;; Check if directory is empty apart from "." and "..".
5382 ;; Otherwise, call ourselves recursively if needed.
5386 ;; This test is equivalent to
5387 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5388 ;; but more efficient
5392 ;; We do not want to delete "." and "..".
5398 "Return non-nil if files FILE1 and FILE2 name the same file.
5399 If FILE1 or FILE2 does not exist, the return value is unspecified."
5410 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5412 Return nil if DIR is not an existing directory."
5424 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5439 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5440 This function always sets the file modes of the output files to match
5441 the corresponding input file.
5443 The third arg KEEP-TIME non-nil means give the output files the same
5444 last-modified time as the old ones. (This works on only some systems.)
5446 A prefix arg makes KEEP-TIME non-nil.
5448 Noninteractively, the last argument PARENTS says whether to
5449 create parent directories if they don't exist. Interactively,
5450 this happens by default.
5452 If NEWNAME names an existing directory, copy DIRECTORY as a
5453 subdirectory there. However, if called from Lisp with a non-nil
5454 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5455 directly into NEWNAME instead."
5462 default-directory default-directory nil nil)
5463 current-prefix-arg t nil)))
5466 directory newname))
5467 ;; If default-directory is a remote directory, make sure we find its
5468 ;; copy-directory handler.
5473 newname keep-time parents copy-contents)
5475 ;; Compute target name.
5480 ;; If NEWNAME is not an existing directory, create it;
5481 ;; that is where we will copy the files of DIRECTORY.
5483 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5484 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5489 newname))
5493 newname))
5496 ;; Copy recursively.
5498 ;; We do not want to copy "." and "..".
5500 directory-files-no-dot-files-regexp))
5510 ;; Set directory attributes.
5516 \f
5517 ;; At time of writing, only info uses this.
5519 "Return a copy of DIRS with all non-existent directories removed.
5520 The optional argument KEEP is a list of directories to retain even if
5521 they don't exist, and REJECT is a list of directories to remove from
5522 DIRS, even if they exist; REJECT takes precedence over KEEP.
5524 Note that membership in REJECT and KEEP is checked using simple string
5525 comparison."
5531 dirs)))
5533 \f
5536 "Function to use to revert this buffer.
5537 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5538 which are the arguments that `revert-buffer' received.
5539 It also has access to the `preserve-modes' argument of `revert-buffer'
5540 via the `revert-buffer-preserve-modes' dynamic variable.
5542 For historical reasons, a value of nil means to use the default function.
5547 #'revert-buffer-insert-file-contents--default-function
5548 "Function to use to insert contents when reverting this buffer.
5549 The function receives two arguments: the first the nominal file name to use;
5550 the second is t if reading the auto-save file.
5552 The function is responsible for updating (or preserving) point.
5554 For historical reasons, a value of nil means to use the default function.
5558 "Default function to use for `buffer-stale-function'.
5559 This function ignores its argument.
5560 This returns non-nil if the current buffer is visiting a readable file
5561 whose modification time does not match that of the buffer.
5563 This function only handles buffers that are visiting files.
5564 Non-file buffers need a custom function"
5571 "Function to check whether a buffer needs reverting.
5572 This should be a function with one optional argument NOCONFIRM.
5573 Auto Revert Mode passes t for NOCONFIRM. The function should return
5574 non-nil if the buffer should be reverted. A return value of
5575 `fast' means that the need for reverting was not checked, but
5576 that reverting the buffer is fast. The buffer is current when
5577 this function is called.
5579 The idea behind the NOCONFIRM argument is that it should be
5580 non-nil if the buffer is going to be reverted without asking the
5581 user. In such situations, one has to be careful with potentially
5582 time consuming operations.
5584 For historical reasons, a value of nil means to use the default function.
5585 This should not be relied upon.
5587 For more information on how this variable is used by Auto Revert mode,
5591 "Normal hook for `revert-buffer' to run before reverting.
5592 The function `revert-buffer--default' runs this.
5596 "Normal hook for `revert-buffer' to run after reverting.
5597 Note that the hook value that it runs is the value that was in effect
5598 before reverting; that makes a difference if you have buffer-local
5599 hook functions.
5601 The function `revert-buffer--default' runs this.
5609 ;; `revert-buffer-function' was defined long ago to be a function of only
5610 ;; 2 arguments, so we have to use a dynbind variable to pass the
5611 ;; `preserve-modes' argument of `revert-buffer'.
5615 "Replace current buffer text with the text of the visited file on disk.
5616 This undoes all changes since the file was visited or saved.
5617 With a prefix argument, offer to revert from latest auto-save file, if
5618 that is more recent than the visited file.
5620 This command also implements an interface for special buffers
5621 that contain text which doesn't come from a file, but reflects
5622 some other data instead (e.g. Dired buffers, `buffer-list'
5623 buffers). This is done via the variable `revert-buffer-function'.
5624 In these cases, it should reconstruct the buffer contents from the
5625 appropriate data.
5627 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5628 to revert from the auto-save file when this is nil. Note that the
5629 sense of this argument is the reverse of the prefix argument, for the
5630 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5631 to nil.
5633 Optional second argument NOCONFIRM means don't ask for confirmation
5634 at all. (The variable `revert-without-query' offers another way to
5635 revert buffers without querying for confirmation.)
5637 Optional third argument PRESERVE-MODES non-nil means don't alter
5638 the files modes. Normally we reinitialize them using `normal-mode'.
5640 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5642 This function calls the function that `revert-buffer-function' specifies
5643 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5644 The default function runs the hooks `before-revert-hook' and
5645 `after-revert-hook'."
5646 ;; I admit it's odd to reverse the sense of the prefix argument, but
5647 ;; there is a lot of code out there which assumes that the first
5648 ;; argument should be t to avoid consulting the auto-save file, and
5649 ;; there's no straightforward way to encourage authors to notice a
5650 ;; reversal of the argument sense. So I'm just changing the user
5651 ;; interface, but leaving the programmatic interface the same.
5656 ignore-auto noconfirm)))
5659 "Default function for `revert-buffer'.
5660 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5661 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5662 start and end.
5664 Calls `revert-buffer-insert-file-contents-function' to reread the
5665 contents of the visited file, with two arguments: the first is the file
5666 name, the second is non-nil if reading an auto-save file.
5668 This function only handles buffers that are visiting files.
5669 Non-file buffers need a custom function."
5674 buffer-auto-save-file-name
5679 buffer-auto-save-file-name
5680 buffer-file-name)))
5690 file-name)))
5692 ;; If file was backed up but has changed since,
5693 ;; we should make another backup.
5697 ;; Effectively copy the after-revert-hook status,
5698 ;; since after-find-file will clobber it.
5701 after-revert-hook))
5703 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5707 file-name auto-save-p)
5708 ;; Recompute the truename in case changes in symlinks
5709 ;; have changed the truename.
5713 ;; Run after-revert-hook as it was before we reverted.
5717 local-hook)
5720 t)))))
5723 "Default function for `revert-buffer-insert-file-contents-function'.
5724 The function `revert-buffer--default' calls this.
5725 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5726 an auto-save file."
5730 "File %s no longer exists!"
5732 file-name))
5735 "File %s no longer readable!"
5737 file-name))
5739 ;; Bind buffer-file-name to nil
5740 ;; so that we don't try to lock the file.
5746 ;; Auto-saved file should be read by Emacs's
5747 ;; internal coding.
5751 buffer-file-coding-system-explicit
5754 coding-system-for-read
5756 coding-system-for-read)
5758 ;; As a coding system suitable for multibyte
5759 ;; buffer is specified, make the current
5760 ;; buffer multibyte.
5763 ;; This force after-insert-file-set-coding
5764 ;; (called from insert-file-contents) to set
5765 ;; buffer-file-coding-system to a proper value.
5768 ;; Note that this preserves point in an intelligent way.
5772 nil nil t))
5774 nil nil t))))))
5777 "Recover the visited file--get contents from its last auto-save file."
5782 "Visit file FILE, but get contents from its last auto-save file."
5783 ;; Actually putting the file name in the minibuffer should be used
5784 ;; only rarely.
5785 ;; Not just because users often use the default.
5798 "*Directory*" nil
5809 ;; Use insert-directory-safely, not insert-directory,
5810 ;; because these files might not exist. In particular,
5811 ;; FILE might not exist if the auto-save file was for
5812 ;; a buffer that didn't visit a file, such as "*mail*".
5813 ;; The code in v20.x called `ls' directly, so we need
5814 ;; to emulate what `ls' did in that case.
5819 ;; Keep the current buffer-file-coding-system.
5821 ;; Auto-saved file should be read with special coding.
5830 "Recover auto save files from a previous Emacs session.
5831 This command first displays a Dired buffer showing you the
5832 previous sessions that you could recover from.
5833 To choose one, move point to the proper line and then type C-c C-c.
5834 Then you'll be asked about a number of files to recover."
5844 directory-files-no-dot-files-regexp
5846 t)
5857 ;; Each line starts with a space
5858 ;; so that Font Lock mode won't highlight the first character.
5861 " To delete a session file, type \
5867 "Choose one saved session to recover auto-save files from.
5868 This command is used in the special Dired buffer created by
5871 ;; Get the name of the session file to recover from.
5873 files
5879 ;; Read in the auto-save-list file.
5882 ;; Loop thru the text of that file
5883 ;; and get out the names of the files to recover.
5887 ;; This is a pair of lines for a non-file-visiting buffer.
5888 ;; Get the auto-save file name and manufacture
5889 ;; a "visited file name" from that.
5892 ;; If there is no auto-save file name, the
5893 ;; auto-save-list file is probably corrupted.
5906 ;; This pair of lines is a file-visiting
5907 ;; buffer. Use the visited file name.
5917 ;; Ignore a file if its auto-save file does not exist now.
5921 ;; The file contains a pair of line for each auto-saved buffer.
5922 ;; The first line of the pair contains the visited file name
5923 ;; or is empty if the buffer was not visiting a file.
5924 ;; The second line is the auto-save file name.
5932 files
5938 "Kill BUFFER if confirmed."
5946 "Kill some buffers. Asks the user whether to kill each one of them.
5947 Non-interactively, if optional argument LIST is non-nil, it
5948 specifies the list of buffers to kill, asking for approval for each one."
5956 ; if we killed the base buffer.
5963 "Kill buffers whose name matches the specified REGEXP.
5964 The optional second argument indicates whether to kill internal buffers too."
5973 \f
5975 "Adjust current buffer's auto save file name for current conditions.
5976 Also rename any existing auto save file, if it was made in this session."
5988 "Return file name to use for auto-saves of current buffer.
5989 Does not consider `auto-save-visited-file-name' as that variable is checked
5990 before calling this function. You can redefine this for customization.
5991 See also `auto-save-file-name-p'."
5999 result uniq)
6000 ;; Apply user-specified translations
6001 ;; to the file name.
6005 filename)
6015 filename))))
6020 ;; We truncate the file name to DOS 8+3 limits
6021 ;; before doing anything else, because the regexp
6022 ;; passed to string-match below cannot handle
6023 ;; extensions longer than 3 characters, multiple
6024 ;; dots, and other atrocities.
6029 fn)
6034 "#"
6037 ;; Make sure auto-save file names don't contain characters
6038 ;; invalid for the underlying filesystem.
6040 ;; Don't modify remote (ange-ftp) filenames
6043 result))))
6045 ;; Deal with buffers that don't have any associated files. (Mail
6046 ;; mode tends to create a good number of these.)
6050 file-name)
6051 ;; Restrict the characters used in the file name to those which
6052 ;; are known to be safe on all filesystems, url-encoding the
6053 ;; rest.
6054 ;; We do this on all platforms, because even if we are not
6055 ;; running on DOS/Windows, the current directory may be on a
6056 ;; mounted VFAT filesystem, such as a USB memory stick.
6060 ;; For multibyte characters, this will produce more than
6061 ;; 2 hex digits, so is not true URL encoding.
6065 ;; Generate the file name.
6071 ;; Try a few alternative directories, to get one we can
6072 ;; write it.
6078 ;; Don't modify remote (ange-ftp) filenames
6080 ;; The call to convert-standard-filename is in case
6081 ;; buffer-name includes characters not allowed by the
6082 ;; DOS/Windows filesystems. make-temp-file writes to the
6083 ;; file it creates, so we must fix the file name _before_
6084 ;; make-temp-file is called.
6086 fname))
6088 ;; make-temp-file creates the file,
6089 ;; but we don't want it to exist until we do an auto-save.
6093 file-name)))
6096 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6097 FILENAME should lack slashes. You can redefine this for customization."
6099 \f
6101 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6102 The generated regexp will match a filename only if the filename
6103 matches that wildcard according to shell rules. Only wildcards known
6104 by `sh' are supported."
6106 ;; Copy the initial run of non-special characters.
6109 ;; If no special characters, we're almost done.
6113 j)
6115 result
6136 ;; Found "[^". Insert a `\0' character
6137 ;; (which cannot happen in a filename)
6138 ;; into the character class, so that `^'
6139 ;; is not the first character after `[',
6140 ;; and thus non-special in a regexp.
6145 ;; I don't think `]' can appear in a
6146 ;; character class in a wildcard, but
6147 ;; let's be general here.
6154 i
6167 ;; Shell wildcards should match the entire filename,
6168 ;; not its part. Make the regexp say so.
6170 \f
6173 "Switches for `list-directory' to pass to `ls' for brief listing."
6179 "Switches for `list-directory' to pass to `ls' for verbose listing."
6184 "Expand wildcard pattern PATTERN.
6185 This returns a list of file names which match the pattern.
6186 Files are sorted in `string<' order.
6188 If PATTERN is written as an absolute file name,
6189 the values are absolute also.
6191 If PATTERN is written as a relative file name, it is interpreted
6192 relative to the current default directory, `default-directory'.
6193 The file names returned are normally also relative to the current
6194 default directory. However, if FULL is non-nil, they are absolute."
6198 ;; A list of all dirs that DIRPART specifies.
6199 ;; This can be more than one dir
6200 ;; if DIRPART contains wildcards.
6204 dirpart)))
6208 contents)
6213 ;; Filter out "." and ".."
6218 name))
6225 this-dir-contents)
6226 this-dir-contents)
6227 contents)))))
6228 contents)))
6230 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6234 "Display a list of files in or matching DIRNAME, a la `ls'.
6235 DIRNAME is globbed by the shell if necessary.
6236 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6237 Actions controlled by variables `list-directory-brief-switches'
6238 and `list-directory-verbose-switches'."
6242 nil default-directory nil)
6243 pfx)))
6245 list-directory-brief-switches))
6246 buffer)
6258 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6266 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6268 PATTERN is assumed to represent a file-name wildcard suitable for the
6269 underlying filesystem. For Unix and GNU/Linux, each character from the
6271 the parts of the pattern which don't include wildcard characters are
6272 quoted with double quotes.
6275 on Windows), so PATTERN can use them to quote wildcard characters that
6276 need to be passed verbatim to shell commands."
6280 ;; DOS/Windows don't allow `"' in file names. So if the
6281 ;; argument has quotes, we can safely assume it is already
6282 ;; quoted by the caller.
6284 ;; We quote [&()#$`'] in case their shell is a port of a
6285 ;; Unixy shell. We quote [,=+] because stock DOS and
6286 ;; Windows shells require that in some cases, such as
6287 ;; passing arguments to batch files that use positional
6288 ;; arguments like %1.
6290 pattern
6293 end)
6310 pattern))))
6317 "Program to get the amount of free space on a file system.
6318 We assume the output has the format of `df'.
6319 The value of this variable must be just a command name or file name;
6320 if you want to specify options, use `directory-free-space-args'.
6322 A value of nil disables this feature.
6324 If the function `file-system-info' is defined, it is always used in
6325 preference to the program given by this variable."
6331 "Options to use when running `directory-free-space-program'."
6336 "Return the amount of free space on directory DIR's file system.
6337 The return value is a string describing the amount of free
6338 space (normally, the number of free 1KB blocks).
6340 This function calls `file-system-info' if it is available, or
6341 invokes the program specified by `directory-free-space-program'
6342 and `directory-free-space-args'. If the system call or program
6343 is unsuccessful, or if DIR is a remote directory, this function
6344 returns nil."
6346 ;; Try to find the number of free blocks. Non-Posix systems don't
6347 ;; always have df, but might have an equivalent system call.
6356 ;; Avoid failure if the default directory does
6357 ;; not exist (Bug#2631, Bug#3911).
6361 nil t nil
6362 directory-free-space-args
6365 ;; Assume that the "available" column is before the
6366 ;; "capacity" column. Find the "%" and scan backward.
6370 "[[:space:]]+[^[:space:]]+%[^%]*$"
6377 ;; The following expression replaces `dired-move-to-filename-regexp'.
6381 ;; In some locales, month abbreviations are as short as 2 letters,
6382 ;; and they can be followed by ".".
6383 ;; In Breton, a month name can include a quote character.
6396 s "+"
6399 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6400 ;; omits the Kanji characters after month and day-of-month.
6401 ;; On Mac OS X 10.3, the date format in East Asian locales is
6402 ;; day-of-month digits followed by month digits.
6408 ;; The "[0-9]" below requires the previous column to end in a digit.
6409 ;; This avoids recognizing `1 may 1997' as a date in the line:
6410 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6412 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6414 ;; For non-iso date formats, we add the ".*" in order to find
6415 ;; the last possible match. This avoids recognizing
6416 ;; `jservice 10 1024' as a date in the line:
6417 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6419 ;; vc dired listings provide the state or blanks between file
6420 ;; permissions and date. The state is always surrounded by
6421 ;; parentheses:
6422 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6423 ;; This is not supported yet.
6428 "Regular expression to match up to the file name in a directory listing.
6429 The default value is designed to recognize dates and times
6434 ;; insert-directory
6435 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6436 ;; FULL-DIRECTORY-P is nil.
6437 ;; The single line of output must display FILE's name as it was
6438 ;; given, namely, an absolute path name.
6439 ;; - must insert exactly one line for each file if WILDCARD or
6440 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6441 ;; before the file lines, plus optional text after the file lines.
6442 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6443 ;; allowed.
6444 ;; File lines should display the basename.
6445 ;; - must be consistent with
6446 ;; - functions dired-move-to-filename, (these two define what a file line is)
6447 ;; dired-move-to-end-of-filename,
6448 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6449 ;; dired-insert-headerline
6450 ;; dired-after-subdir-garbage (defines what a "total" line is)
6451 ;; - variable dired-subdir-regexp
6452 ;; - may be passed "--dired" as the first argument in SWITCHES.
6453 ;; Filename handlers might have to remove this switch if their
6454 ;; "ls" command does not support it.
6456 "Insert directory listing for FILE, formatted according to SWITCHES.
6457 Leaves point after the inserted text.
6458 SWITCHES may be a string of options, or a list of strings
6459 representing individual options.
6460 Optional third arg WILDCARD means treat FILE as shell wildcard.
6461 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6462 switches do not contain `d', so that a full listing is expected.
6464 This works by running a directory listing program
6465 whose name is in the variable `insert-directory-program'.
6466 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6468 When SWITCHES contains the long `--dired' option, this function
6469 treats it specially, for the sake of dired. However, the
6470 normally equivalent short `-D' option is just passed on to
6471 `insert-directory-program', as any other option."
6472 ;; We need the directory in order to find the right handler.
6477 wildcard full-directory-p)
6480 ;; Read the actual directory using `insert-directory-program'.
6481 ;; RESULT gets the status code.
6483 ;; putting text property `dired-filename, decode one
6484 ;; bunch by one to preserve that property.
6486 ;; This is to control encoding the arguments in call-process.
6490 default-file-name-coding-system))))
6493 ;; Run ls in the directory part of the file pattern
6494 ;; using the last component as argument.
6500 ;; NB since switches is passed to the shell, be
6501 ;; careful of malicious values, eg "-l;reboot".
6502 ;; See eg dired-safe-switches-p.
6504 shell-file-name nil t nil
6505 "-c"
6507 ""
6509 insert-directory-program
6510 " -d "
6512 switches
6514 " -- "
6515 ;; Quote some characters that have
6516 ;; special meanings in shells; but
6517 ;; don't quote the wildcards--we want
6518 ;; them to be special. We also
6519 ;; currently don't quote the quoting
6520 ;; characters in case people want to
6521 ;; use them explicitly to quote
6522 ;; wildcard characters.
6524 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6525 ;; directory if FILE is a symbolic link.
6533 insert-directory-program nil t nil
6537 ;; Split the switches at any spaces so we can
6538 ;; pass separate options as separate args.
6540 ;; Avoid lossage if FILE starts with `-'.
6548 file))))))))
6550 ;; If we got "//DIRED//" in the output, it means we got a real
6551 ;; directory listing, even if `ls' returned nonzero.
6552 ;; So ignore any errors.
6565 ;; The first time ls returns an error,
6566 ;; find the version numbers of ls,
6567 ;; and set insert-directory-ls-version
6568 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6569 ;; is equal or if the info cannot be obtained.
6570 ;; (That can mean it isn't GNU ls.)
6580 comparison)
6596 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6600 ;; If `insert-directory-program' failed, signal an error.
6602 ;; Delete the error message it may have output.
6604 ;; On non-Posix systems, we cannot open a directory, so
6605 ;; don't even try, because that will always result in
6606 ;; the ubiquitous "Access denied". Instead, show the
6607 ;; command line so the user can try to guess what went wrong.
6612 insert-directory-program
6614 file result)
6615 ;; Unix. Access the file to get a suitable error.
6622 ;; The following overshoots by one line for an empty
6623 ;; directory listed with "--dired", but without "-a"
6624 ;; switch, where the ls output contains a
6625 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6626 ;; We take care of that case later.
6634 error-lines)
6635 ;; Find all the lines that are error messages,
6636 ;; and record the bounds of each one.
6643 ;; Now read the numeric positions of file names.
6650 error-lines))
6653 error-lines)))
6655 ;; End is followed by \n or by " -> ".
6657 ;; It seems that we can't trust ls's output as to
6658 ;; byte positions of filenames.
6664 ;; Take care of the case where the ls output contains a
6665 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6666 ;; and we went one line too far back (see above).
6671 ;; Now decode what read if necessary.
6673 file-name-coding-system
6674 default-file-name-coding-system
6676 coding-no-eol
6677 val pos)
6681 ;; If no coding system is specified or detection is
6682 ;; requested, detect the coding.
6696 ;; Force no eol conversion on a file name, so
6697 ;; that CR is preserved.
6705 ;; Try to insert the amount of free space.
6708 ;; First find the line to put it on.
6712 ;; Replace "total" with "used", to avoid confusion.
6718 "Convert `ls --dired' file name position value POS to a buffer position.
6719 File name position values returned in ls --dired output
6720 count only stdout; they don't count the error messages sent to stderr.
6721 So this function converts to them to real buffer positions.
6722 ERROR-LINES is a list of buffer positions of error message lines,
6723 of the form (START END)."
6727 pos)
6731 "Insert directory listing for FILE, formatted according to SWITCHES.
6733 Like `insert-directory', but if FILE does not exist, it inserts a
6734 message to that effect instead of signaling an error."
6737 ;; Simulate the message printed by `ls'.
6741 "Functions to call with no arguments to query about killing Emacs.
6742 If any of these functions returns nil, killing Emacs is canceled.
6743 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6744 the low level primitive, does not. See also `kill-emacs-hook'."
6750 "How to ask for confirmation when leaving Emacs.
6751 If nil, the default, don't ask at all. If the value is non-nil, it should
6752 be a predicate function; for example `yes-or-no-p'."
6761 "Offer to save each buffer, then kill this Emacs process.
6762 With prefix ARG, silently save all file-visiting buffers without asking.
6763 If there are active processes where `process-query-on-exit-flag'
6764 returns non-nil, asks whether processes should be killed.
6765 Runs the members of `kill-emacs-query-functions' in turn and stops
6766 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6778 ;; process-list is not defined on MSDOS.
6780 active)
6798 ;; Query the user for other things, perhaps.
6805 "Offer to save each buffer, then kill the current connection.
6806 If the current frame has no client, kill Emacs itself using
6807 `save-buffers-kill-emacs'.
6809 With prefix ARG, silently save all file-visiting buffers, then kill.
6811 If emacsclient was started with a list of filenames to edit, then
6812 only these files will be asked to be saved."
6817 \f
6818 ;; We use /: as a prefix to "quote" a file name
6819 ;; so that magic file name handlers will not apply to it.
6823 file-name-handler-alist))
6825 ;; We depend on being the last handler on the list,
6826 ;; so that anything else which does need handling
6827 ;; has been handled already.
6828 ;; So it is safe for us to inhibit *all* magic file name handlers.
6837 default-directory))
6838 ;; Get a list of the indices of the args which are file names.
6841 ;; The first six are special because they
6842 ;; return a file name. We want to include the /:
6843 ;; in the return value.
6844 ;; So just avoid stripping it in the first place.
6851 ;; `identity' means just return the first arg
6852 ;; not stripped of its quoting.
6854 ;; `add' means add "/:" to the result.
6857 ;; `unquote-then-quote' means set buffer-file-name
6858 ;; temporarily to unquoted filename.
6860 ;; List the arguments which are filenames.
6868 ;; For all other operations, treat the first argument only
6869 ;; as the file name.
6871 method
6872 ;; Copy ARGUMENTS so we can replace elements in it.
6876 ;; Strip off the /: from the file names that have it.
6884 "/"
6890 (`insert-file-contents
6896 (`unquote-then-quote
6901 \f
6902 ;; Symbolic modes and read-file-modes.
6905 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6906 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6907 Others, or All) for whom to produce the mask.
6908 The bit-mask that is returned extracts from mode bits the access rights
6909 for the specified category of users."
6917 "Convert CHAR to a numeric value of mode bits.
6918 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6919 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6926 ;; Rights relative to the previous file modes.
6937 "Convert a symbolic mode string specification to an equivalent number.
6939 WHO-MASK is the bit-mask specifying the category of users to which to
6940 apply the access permissions. See `file-modes-char-to-who'.
6941 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6942 RIGHTS request to add, remove, or set permissions based on existing ones,
6949 char-right)
6956 num-rights
6960 op char-right)))
6961 num-rights))
6964 "Convert symbolic file modes to numeric file modes.
6965 MODES is the string to convert, it should match
6967 See Info node `(coreutils)File permissions' for more information on this
6968 notation.
6969 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6970 MODES request to add, remove, or set permissions based on existing ones,
6984 num-who num-modes)
6987 num-modes)))
6990 "Read file modes in octal or symbolic notation and return its numeric value.
6992 ORIG-FILE is the name of a file on whose mode bits to base returned
6993 permissions if what user types requests to add, remove, or set permissions
7009 nil nil default)))
7018 ;; Trashcan handling.
7020 "Directory for `move-file-to-trash' to move files and directories to.
7021 This directory is only used when the function `system-move-file-to-trash'
7022 is not defined.
7023 Relative paths are interpreted relative to `default-directory'.
7024 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7034 "Move the file (or directory) named FILENAME to the trash.
7035 When `delete-by-moving-to-trash' is non-nil, this function is
7036 called by `delete-file' and `delete-directory' instead of
7037 deleting files outright.
7039 If the function `system-move-file-to-trash' is defined, call it
7040 with FILENAME as an argument.
7041 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7042 directory.
7043 Otherwise, trash FILENAME using the freedesktop.org conventions,
7044 like the GNOME, KDE and XFCE desktop environments. Emacs only
7048 ;; If `trash-directory' is non-nil, move the file there.
7052 trash-dir)))
7053 ;; We can't trash a parent directory of trash-directory.
7056 trash-dir filename))
7059 ;; Ensure that the trashed file-name is unique.
7066 ;; If `system-move-file-to-trash' is defined, use it.
7069 ;; Otherwise, use the freedesktop.org method, as specified at
7070 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7081 ;; Check if we have permissions to delete.
7085 ;; The trashed file cannot be the trash dir or its parent.
7088 trash-files-dir filename))
7091 trash-info-dir filename))
7093 ;; Ensure that the trash directory exists; otherwise, create it.
7100 ;; Try to move to trash with .trashinfo undo information
7105 ;; Perform url-encoding on FN. For compatibility with
7106 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7107 ;; for path separators.
7112 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7113 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7126 fn))
7131 ;; Attempt to make .trashinfo file, trying up to 5
7132 ;; times. The .trashinfo file is opened with O_EXCL,
7133 ;; as per trash-spec 0.7, even if that can be a problem
7134 ;; on old NFS versions...
7138 trash-files-dir))
7140 success info-fn)
7145 trash-info-dir))
7153 ;; Uniquify new-fn. (Some file managers do not
7154 ;; like Emacs-style backup file names---e.g. bug
7155 ;; 170956 in Konqueror bug tracker.)
7160 ;; Finally, try to move the file to the trashcan.
7165 "The type field in ATTRIBUTES returned by `file-attributes'.
7166 The value is either t for directory, string (name linked to) for
7167 symbolic link, or nil."
7171 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7175 "The UID field in ATTRIBUTES returned by `file-attributes'.
7176 This is either a string or a number. If a string value cannot be
7177 looked up, a numeric value, either an integer or a float, is
7178 returned."
7182 "The GID field in ATTRIBUTES returned by `file-attributes'.
7183 This is either a string or a number. If a string value cannot be
7184 looked up, a numeric value, either an integer or a float, is
7185 returned."
7189 "The last access time in ATTRIBUTES returned by `file-attributes'.
7190 This a list of integers (HIGH LOW USEC PSEC) in the same style
7191 as (current-time)."
7195 "The modification time in ATTRIBUTES returned by `file-attributes'.
7196 This is the time of the last change to the file's contents, and
7197 is a list of integers (HIGH LOW USEC PSEC) in the same style
7198 as (current-time)."
7202 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7203 This is the time of last change to the file's attributes: owner
7204 and group, access mode bits, etc, and is a list of integers (HIGH
7205 LOW USEC PSEC) in the same style as (current-time)."
7209 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7210 This is a floating point number if the size is too large for an integer."
7214 "The file modes in ATTRIBUTES returned by `file-attributes'.
7215 This is a string of ten letters or dashes as in ls -l."
7219 "The inode number in ATTRIBUTES returned by `file-attributes'.
7220 If it is larger than what an Emacs integer can hold, this is of
7221 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7222 If even HIGH is too large for an Emacs integer, this is instead
7223 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7224 middle 24 bits, and finally the low 16 bits."
7228 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7229 If it is larger than what an Emacs integer can hold, this is of
7230 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7231 If even HIGH is too large for an Emacs integer, this is instead
7232 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7233 middle 24 bits, and finally the low 16 bits."
7237 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7238 ATTR-NAMES are symbols with the selected attribute names.
7240 Valid attribute names are: type, link-number, user-id, group-id,
7241 access-time, modification-time, status-change-time, size, modes,
7242 inode-number and device-number."
7244 modification-time status-change-time
7245 size modes inode-number device-number))
7246 result)
7252 attributes)
7253 result)
7256 \f
7281 ;;; files.el ends here