| blob | 1d7870be488616b570c1f0900754a3a76fed88f1 |
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,
613 and also turn slashes into backslashes if the shell requires it (see
614 `w32-shell-dos-semantics').
616 See Info node `(elisp)Standard File Names' for more details."
621 ;; Replace invalid filename characters with !
625 name))
633 "Read directory name, prompting with PROMPT and completing in directory DIR.
634 Value is not expanded---you must call `expand-file-name' yourself.
635 Default name to DEFAULT-DIRNAME if user exits with the same
636 non-empty string that was inserted by this function.
637 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
638 or just DIR if INITIAL is nil.)
639 If the user exits with an empty minibuffer, this function returns
640 an empty string. (This can only happen if the user erased the
641 pre-inserted contents or if `insert-default-directory' is nil.)
642 Fourth arg MUSTMATCH non-nil means require existing directory's name.
643 Non-nil and non-t means also require confirmation after completion.
644 Fifth arg INITIAL specifies text to start with.
645 DIR should be an absolute directory name. It defaults to
646 the value of `default-directory'."
651 dir))
652 mustmatch initial
655 \f
657 "Show the current default directory.
658 With prefix argument INSERT, insert the current default directory
659 at point instead."
666 "Value of the CDPATH environment variable, as a list.
670 "Explode a search path into a list of directory names.
671 Directories are separated by `path-separator' (which is colon in
672 GNU and Unix systems). Substitute environment variables into the
673 resulting list of directory names. For an empty path element (i.e.,
674 a leading or trailing separator, or two adjacent separators), return
675 nil (meaning `default-directory') as the associated list element."
683 "Change current directory to given absolute file name DIR."
684 ;; Put the name into directory syntax now,
685 ;; because otherwise expand-file-name may give some bad results.
687 ;; We used to additionally call abbreviate-file-name here, for an
688 ;; unknown reason. Problem is that most buffers are setup
689 ;; without going through cd-absolute and don't call
690 ;; abbreviate-file-name on their default-directory, so the few that
691 ;; do end up using a superficially different directory.
703 "Make DIR become the current buffer's default directory.
704 If your environment includes a `CDPATH' variable, try each one of
705 that list of directories (separated by occurrences of
706 `path-separator') when resolving a relative directory name.
707 The path separator is colon in GNU and GNU-like systems."
710 ;; FIXME: There's a subtle bug in the completion below. Seems linked
711 ;; to a fundamental difficulty of implementing `predicate' correctly.
712 ;; The manifestation is that TAB may list non-directories in the case where
713 ;; those files also correspond to valid directories (if your cd-path is (A/
714 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
715 ;; will be listed as valid completions).
716 ;; This is because `a' (listed because of A/a) is indeed a valid choice
717 ;; (which will lead to the use of B/a).
722 cd-path nil))
731 default-directory default-directory
732 t))))
742 "Return non-nil if NAME ends with a directory separator character."
752 "Return list of all files under DIR that have file names matching REGEXP.
754 order, and files from each directory are sorted in alphabetical order.
755 Each file name appears in the returned list in its absolute form.
756 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
757 output directories whose names match REGEXP."
760 ;; When DIR is "/", remote file names like "/method:" could
761 ;; also be offered. We shall suppress them.
769 ;; Don't follow symlinks to other directories.
773 full-file regexp include-directories))))
784 "Load the Lisp file named FILE."
785 ;; This is a case where .elc and .so/.dll make a lot of sense.
789 completion-ignored-extensions))))
794 "Search for FILENAME through PATH.
795 If found, return the absolute file name of FILENAME; otherwise
796 return nil.
797 PATH should be a list of directories to look in, like the lists in
798 `exec-path' or `load-path'.
799 If SUFFIXES is non-nil, it should be a list of suffixes to append to
802 If non-nil, PREDICATE is used instead of `file-readable-p'.
804 This function will normally skip directories, so if you want it to find
805 directories, make sure the PREDICATE function returns `dir-ok' for them.
807 PREDICATE can also be an integer to pass to the `access' system call,
808 in which case file-name handlers are ignored. This usage is deprecated.
809 For compatibility, PREDICATE can also be one of the symbols
810 `executable', `readable', `writable', or `exists', or a list of
811 one or more of those symbols."
822 "Do completion for file names passed to `locate-file'."
825 ;; FIXME: maybe we should use completion-file-name-table instead,
826 ;; tho at least for `load', the arg is passed through
827 ;; substitute-in-file-name for historical reasons.
837 ;; If we have files like "foo.el" and "foo.elc", we could load one of
838 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
839 ;; preferred way. So if we list all 3, that gives a lot of redundant
840 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
841 ;; the user does want to pay attention to the extension. We try to
842 ;; diffuse this tension by stripping the suffix, except when the
843 ;; result is a single element (i.e. usually we only list "foo" unless
844 ;; it's the only remaining element in the list, in which case we do
845 ;; list "foo", "foo.elc" and "foo.el").
856 string-file dir))
861 ;; Switching from names to names+fullnames creates a non-monotonicity
862 ;; which can cause problems with things like partial-completion.
863 ;; To minimize the problem, filter out completion-regexp-list, so that
864 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
865 ;; from `names' which only matched `string' when they still had
866 ;; their suffix.
868 ;; Remove duplicates of the first element, so that we can easily check
869 ;; if `names' really only contains a single element.
872 ;; There's no more than one matching non-suffixed element, so expand
873 ;; the list by adding the suffixed elements as well.
876 string-dir names string-file pred action)))))
879 "Do completion for file names passed to `locate-file'.
880 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
884 string nil action))
888 "Regexp of directory names which stop the search in `locate-dominating-file'.
889 Any directory whose name matches this regexp will be treated like
890 a kind of root directory by `locate-dominating-file' which will stop its search
891 when it bumps into it.
892 The default regexp prevents fruitless and time-consuming attempts to find
893 special files in directories in which filenames are interpreted as hostnames,
896 ;; (defun locate-dominating-files (file regexp)
897 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
898 ;; Stop at the first parent where a matching file is found and return the list
899 ;; of files that that match in this directory."
900 ;; (catch 'found
901 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
902 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
903 ;; (let ((user nil)
904 ;; ;; Abbreviate, so as to stop when we cross ~/.
905 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
906 ;; files)
907 ;; (while (and dir
908 ;; ;; As a heuristic, we stop looking up the hierarchy of
909 ;; ;; directories as soon as we find a directory belonging to
910 ;; ;; another user. This should save us from looking in
911 ;; ;; things like /net and /afs. This assumes that all the
912 ;; ;; files inside a project belong to the same user.
913 ;; (let ((prev-user user))
914 ;; (setq user (nth 2 (file-attributes dir)))
915 ;; (or (null prev-user) (equal user prev-user))))
916 ;; (if (setq files (condition-case nil
917 ;; (directory-files dir 'full regexp 'nosort)
918 ;; (error nil)))
919 ;; (throw 'found files)
920 ;; (if (equal dir
921 ;; (setq dir (file-name-directory
922 ;; (directory-file-name dir))))
923 ;; (setq dir nil))))
924 ;; nil)))
927 "Look up the directory hierarchy from FILE for a directory containing NAME.
928 Stop at the first parent directory containing a file NAME,
929 and return the directory. Return nil if not found.
930 Instead of a string, NAME can also be a predicate taking one argument
931 \(a directory) and returning a non-nil value if that directory is the one for
932 which we're looking."
933 ;; We used to use the above locate-dominating-files code, but the
934 ;; directory-files call is very costly, so we're much better off doing
935 ;; multiple calls using the code in here.
936 ;;
937 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
938 ;; `name' in /home or in /.
941 ;; `user' is not initialized outside the loop because
942 ;; `file' may not exist, so we may have to walk up part of the
943 ;; hierarchy before we find the "initial UID". Note: currently unused
944 ;; (user nil)
945 try)
948 ;; FIXME: Disabled this heuristic because it is sometimes
949 ;; inappropriate.
950 ;; As a heuristic, we stop looking up the hierarchy of
951 ;; directories as soon as we find a directory belonging
952 ;; to another user. This should save us from looking in
953 ;; things like /net and /afs. This assumes that all the
954 ;; files inside a project belong to the same user.
955 ;; (let ((prev-user user))
956 ;; (setq user (nth 2 (file-attributes file)))
957 ;; (and prev-user (not (equal user prev-user))))
969 "Non-nil means warn if cannot access `user-emacs-directory'.
970 Set this to nil at your own risk..."
976 "Return an absolute per-user Emacs-specific file name.
977 If NEW-NAME exists in `user-emacs-directory', return it.
978 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
979 Else return NEW-NAME in `user-emacs-directory', creating the
980 directory if it does not exist."
988 at-home
989 ;; Make sure `user-emacs-directory' exists,
990 ;; unless we're in batch mode or dumping Emacs.
992 purify-flag
1002 user-emacs-directory-warning
1004 ;; Only warn once per Emacs session.
1008 Unable to %s `user-emacs-directory' (%s).
1009 Any data that would normally be written there may be lost!
1010 If you never want to see this message again,
1011 customize the variable `user-emacs-directory-warning'."
1012 errtype user-emacs-directory)))))
1013 bestname))))
1017 "Search for COMMAND in `exec-path' and return the absolute file name.
1018 Return nil if COMMAND is not found anywhere in `exec-path'."
1019 ;; Use 1 rather than file-executable-p to better match the behavior of
1020 ;; call-process.
1024 "Load the Emacs Lisp library named LIBRARY.
1025 LIBRARY should be a string.
1026 This is an interface to the function `load'. LIBRARY is searched
1027 for in `load-path', both with and without `load-suffixes' (as
1028 well as `load-file-rep-suffixes').
1030 See Info node `(emacs)Lisp Libraries' for more details.
1031 See `load-file' for a different interface to `load'."
1036 load-path
1041 "Test whether FILE specifies a location on a remote system.
1042 A file is considered remote if accessing it is likely to
1043 be slower or less reliable than accessing local files.
1045 `file-remote-p' never opens a new remote connection. It can
1046 only reuse a connection that is already open.
1048 Return nil or a string identifying the remote connection
1049 \(ideally a prefix of FILE). Return nil if FILE is a relative
1050 file name.
1052 When IDENTIFICATION is nil, the returned string is a complete
1053 remote identifier: with components method, user, and host. The
1054 components are those present in FILE, with defaults filled in for
1055 any that are missing.
1057 IDENTIFICATION can specify which part of the identification to
1058 return. IDENTIFICATION can be the symbol `method', `user',
1059 `host', or `localname'. Any other value is handled like nil and
1060 means to return the complete identification. The string returned
1061 for IDENTIFICATION `localname' can differ depending on whether
1062 there is an existing connection.
1064 If CONNECTED is non-nil, return an identification only if FILE is
1065 located on a remote system and a connection is established to
1066 that remote system.
1068 Tip: You can use this expansion of remote identifier components
1069 to derive a new remote file name from an existing one. For
1075 same remote identifier as FILE but expanded; a name such as
1080 nil)))
1082 ;; Probably this entire variable should be obsolete now, in favor of
1083 ;; something Tramp-related (?). It is not used in many places.
1084 ;; It's not clear what the best file for this to be in is, but given
1085 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1086 ;; rather than autoloaded.
1088 ;; This used to try various hard-coded places for remsh, rsh, and
1089 ;; rcmd, trying to guess based on location whether "rsh" was
1090 ;; "restricted shell" or "remote shell", but I don't see the point
1091 ;; in this day and age. Almost everyone will use ssh, and have
1092 ;; whatever command they want to use in PATH.
1099 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1106 "Whether to use the remote file-name cache for read access.
1107 When nil, never expire cached values (caution)
1108 When t, never use the cache (safe, but may be slow)
1109 A number means use cached values for that amount of seconds since caching.
1111 The attributes of remote files are cached for better performance.
1112 If they are changed outside of Emacs's control, the cached values
1113 become invalid, and must be reread. If you are sure that nothing
1114 other than Emacs changes the files, you can set this variable to nil.
1116 If a remote file is checked regularly, it might be a good idea to
1117 let-bind this variable to a value less than the interval between
1118 consecutive checks. For example:
1120 (defun display-time-file-nonempty-p (file)
1121 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1122 (and (file-exists-p file)
1123 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1134 "Copy the file FILE into a temporary file on this machine.
1135 Returns the name of the local copy, or nil, if FILE is directly
1136 accessible."
1137 ;; This formerly had an optional BUFFER argument that wasn't used by
1138 ;; anything.
1142 nil)))
1145 "Return the truename of FILENAME.
1146 If FILENAME is not absolute, first expands it against `default-directory'.
1147 The truename of a file name is found by chasing symbolic links
1148 both at the level of the file and at the level of the directories
1149 containing it, until no links are left at any level.
1152 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1153 ;; COUNTER can be a cons cell whose car is the count of how many
1154 ;; more links to chase before getting an error.
1155 ;; PREV-DIRS can be a cons cell whose car is an alist
1156 ;; of truenames we've just recently computed.
1170 ;; For speed, remove the ange-ftp completion handler from the list.
1171 ;; We know it's not needed here.
1172 ;; For even more speed, do this only on the outermost call.
1179 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1180 ;; case differences being ignored by the OS, and short "8.3 DOS"
1181 ;; name aliases existing for all files. (The short names are not
1182 ;; reported by directory-files, but can be used to refer to files.)
1183 ;; It seems appropriate for file-truename to resolve these issues in
1184 ;; the most natural way, which on Windows is to call the function
1185 ;; `w32-long-file-name' - this returns the exact name of a file as
1186 ;; it is stored on disk (expanding short name aliases with the full
1187 ;; name in the process).
1190 ;; If filename exists, use its long name. If it doesn't
1191 ;; exist, the recursion below on the directory of filename
1192 ;; will drill down until we find a directory that exists,
1193 ;; and use the long name of that, with the extra
1194 ;; non-existent path components concatenated.
1199 ;; If this file directly leads to a link, process that iteratively
1200 ;; so that we don't use lots of stack.
1206 ;; For file name that has a special handler, call handler.
1207 ;; This is so that ange-ftp can save time by doing a no-op.
1210 done t)
1212 target dirfile)
1213 ;; Get the truename of the directory.
1215 ;; If these are equal, we have the (or a) root directory.
1219 ;; If this is the same dir we last got the truename for,
1220 ;; save time--don't recalculate.
1230 done t)
1233 done t)
1234 ;; Put it back on the file name.
1236 ;; Is the file name the name of a link?
1239 ;; Yes => chase that link, then start all over
1240 ;; since the link may point to a directory name that uses links.
1241 ;; We can't safely use expand-file-name here
1242 ;; since target might look like foo/../bar where foo
1243 ;; is itself a link. Instead, we handle . and .. above.
1246 target
1248 done nil)
1249 ;; No, we are done!
1251 filename))
1254 "Chase links in FILENAME until a name that is not a link.
1255 Unlike `file-truename', this does not check whether a parent
1256 directory name is a symbolic link.
1257 If the optional argument LIMIT is a number,
1258 it means chase no more than that many links and then stop."
1266 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1269 ;; Handle `..' by hand, since it needs to work in the
1270 ;; target of any directory symlink.
1271 ;; This code is not quite complete; it does not handle
1272 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1276 ;; Chase links in the default dir of the symlink.
1280 ;; Now find the parent of that dir.
1284 newname))
1286 ;; A handy function to display file sizes in human-readable form.
1287 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1289 "Produce a string showing FILE-SIZE in human-readable form.
1291 Optional second argument FLAVOR controls the units and the display format:
1293 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1295 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1297 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1300 1024.0
1303 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1309 "%.1f%s%s"
1311 file-size
1313 "K"
1319 "^//[^/]+/"
1320 ;; regexp-opt.el is not dumped into emacs binary.
1321 ;;(concat
1322 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1324 "File systems which ought to be mounted."
1331 "The directory for writing temporary files.
1332 In case of a remote `default-directory', this is a directory for
1333 temporary files on that remote host. If such a directory does
1334 not exist, or `default-directory' ought to be located on a
1335 mounted file system (see `mounted-file-systems'), the function
1336 returns `default-directory'.
1337 For a non-remote and non-mounted `default-directory', the value of
1338 the variable `temporary-file-directory' is returned."
1344 default-directory
1345 temporary-file-directory))))
1348 "Create a temporary file.
1349 The returned file name (created by appending some random characters at the end
1350 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1351 is guaranteed to point to a newly created empty file.
1352 You can then use `write-region' to write new data into the file.
1354 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1356 If SUFFIX is non-nil, add that at the end of the file name."
1357 ;; Create temp files with strict access rights. It's easy to
1358 ;; loosen them later, whereas it's impossible to close the
1359 ;; time-window of loose permissions otherwise.
1368 temporary-file-directory)
1370 temporary-file-directory))))
1376 nil)
1378 ;; the file was somehow created by someone else between
1379 ;; `make-temp-name' and `write-region', let's try again.
1380 nil)
1381 file)))
1384 "Create a temporary file as close as possible to `default-directory'.
1385 If PREFIX is a relative file name, and `default-directory' is a
1386 remote file name or located on a mounted file systems, the
1387 temporary file is created in the directory returned by the
1388 function `temporary-file-directory'. Otherwise, the function
1389 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1390 same meaning as in `make-temp-file'."
1399 "Change the encoding of FILE's name from CODING to NEW-CODING.
1400 The value is a new name of FILE.
1401 Signals a `file-already-exists' error if a file of the new name
1402 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1403 is non-nil. A number as fourth arg means request confirmation if
1404 the new name already exists. This is what happens in interactive
1405 use with M-x."
1408 default-file-name-coding-system))
1410 from-coding to-coding)
1412 ;; We provide the default coding only when it seems that
1413 ;; the filename is correctly decoded by the default
1414 ;; coding.
1420 filename default-coding)
1421 default-coding))
1425 ;; We provide the default coding only when a user is going to
1426 ;; change the encoding not from the default coding.
1430 filename from-coding)))
1433 filename from-coding default-coding)
1434 default-coding)))
1438 default-file-name-coding-system))
1439 ;; FILE should have been decoded by DEFAULT-CODING.
1443 ;; Suppress further encoding.
1448 newname))
1449 \f
1451 "Whether confirmation is requested before visiting a new file or buffer.
1452 If nil, confirmation is not requested.
1453 If the value is `after-completion', confirmation is only
1454 requested if the user called `minibuffer-complete' right before
1455 `minibuffer-complete-and-exit'.
1456 Any other non-nil value means to request confirmation.
1458 This affects commands like `switch-to-buffer' and `find-file'."
1466 "Whether to request confirmation before visiting a new file or buffer.
1467 The variable `confirm-nonexistent-file-or-buffer' determines the
1468 return value, which may be passed as the REQUIRE-MATCH arg to
1469 `read-buffer' or `find-file-read-args'."
1477 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1479 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1480 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1481 instead of prepending it.
1483 BODY should use the minibuffer at most once.
1484 Recursive uses of the minibuffer are unaffected (FUN is not
1485 called additional times).
1487 This macro actually adds an auxiliary function that calls FUN,
1488 rather than FUN itself, to `minibuffer-setup-hook'."
1499 ;; Clear out this hook so it does not interfere
1500 ;; with any recursive minibuffer usage.
1511 t))
1514 "Edit file FILENAME.
1515 Switch to a buffer visiting file FILENAME,
1516 creating one if none already exists.
1517 Interactively, the default if you just type RET is the current directory,
1518 but the visited file name is available through the minibuffer history:
1519 type M-n to pull it into the minibuffer.
1521 You can visit files on remote machines by specifying something
1522 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1523 also visit local files as a different user by specifying
1524 /sudo::FILE for the file name.
1525 See the Info node `(tramp)File name Syntax' in the Tramp Info
1526 manual, for more about this.
1528 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1529 expand wildcards (if any) and visit multiple files. You can
1530 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1532 To visit a file without any kind of conversion and without
1543 "Edit file FILENAME, in another window.
1546 an existing one. See the function `display-buffer'.
1548 Interactively, the default if you just type RET is the current directory,
1549 but the visited file name is available through the minibuffer history:
1550 type M-n to pull it into the minibuffer.
1552 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1553 expand wildcards (if any) and visit multiple files."
1563 value)
1567 "Edit file FILENAME, in another frame.
1570 an existing one. See the function `display-buffer'.
1572 Interactively, the default if you just type RET is the current directory,
1573 but the visited file name is available through the minibuffer history:
1574 type M-n to pull it into the minibuffer.
1576 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1577 expand wildcards (if any) and visit multiple files."
1587 value)
1591 "Edit the existing file FILENAME.
1593 file names with wildcards."
1610 value))
1613 "Edit file FILENAME but don't allow changes.
1622 "Edit file FILENAME in another window but don't allow changes.
1631 "Edit file FILENAME in another frame but don't allow changes.
1640 "Find file FILENAME as a replacement for the file in the next window.
1641 This command does not select that window.
1645 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1646 expand wildcards (if any) and replace the file with multiple files."
1657 "Find alternate file: " file-dir nil
1659 t))))
1666 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1668 "Hook run when a buffer is killed.
1669 The buffer being killed is current while the hook is running.
1670 See `kill-buffer'.
1672 Note: Be careful with let-binding this hook considering it is
1676 "Find file FILENAME, select its buffer, kill previous buffer.
1677 If the current buffer now contains an empty file that you just visited
1678 \(presumably by mistake), use this command to visit the file you really want.
1682 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1683 expand wildcards (if any) and replace the file with multiple files.
1685 If the current buffer is an indirect buffer, or the base buffer
1686 for one or more indirect buffers, the other buffer(s) are not
1687 killed."
1696 "Find alternate file: " file-dir nil
1698 t)))
1712 ;; Run `kill-buffer-hook' here. It needs to happen before
1713 ;; variables like `buffer-file-name' etc are set to nil below,
1714 ;; because some of the hooks that could be invoked
1715 ;; (e.g., `save-place-to-alist') depend on those variables.
1716 ;;
1717 ;; Note that `kill-buffer-hook' is not what queries whether to
1718 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1719 ;; asks that itself. Thus, there's no need to temporarily do
1720 ;; `(set-buffer-modified-p nil)' before running this hook.
1722 ;; Okay, now we can end-of-life the old buffer.
1729 ;; This prevents us from finding the same buffer
1730 ;; if we specified the same file again.
1734 ;; Likewise for dired buffers.
1738 ;; This executes if find-file gets an error
1739 ;; and does not really find anything.
1740 ;; We put things back as they were.
1741 ;; If find-file actually finds something, we kill obuf below.
1750 ;; We already ran these; don't run them again.
1753 \f
1754 ;; FIXME we really need to fold the uniquify stuff in here by default,
1755 ;; not using advice, and add it to the doc string.
1757 "Create a suitably named buffer for visiting FILENAME, and return it.
1758 FILENAME (sans directory) is used unchanged if that name is free;
1759 otherwise a string <2> or <3> or ... is appended to get an unused name.
1761 Emacs treats buffers whose names begin with a space as internal buffers.
1762 To avoid confusion when visiting a file whose name begins with a space,
1769 lastname))))
1772 "Create and return a buffer with a name based on NAME.
1773 Choose the buffer's name using `generate-new-buffer-name'."
1777 "Regexp to match the automounter prefix in a directory name."
1786 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1788 home directory is a root directory) and removes automounter prefixes
1789 \(see the variable `automount-dir-prefix')."
1790 ;; Get rid of the prefixes added by the automounter.
1797 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1798 ;; To fix this right, we need a `file-name-case-sensitive-p'
1799 ;; function, but we don't have that yet, so just guess.
1802 ;; If any elt of directory-abbrev-alist matches this name,
1803 ;; abbreviate accordingly.
1809 ;; Compute and save the abbreviated homedir name.
1810 ;; We defer computing this until the first time it's needed, to
1811 ;; give time for directory-abbrev-alist to be set properly.
1812 ;; We include a slash at the end, to avoid spurious matches
1813 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1820 ;; If FILENAME starts with the abbreviated homedir,
1821 ;; make it start with `~' instead.
1823 ;; If the home dir is just /, don't change it.
1826 ;; MS-DOS root directories can come with a drive letter;
1827 ;; Novell Netware allows drive letters beyond `Z:'.
1835 filename)))
1838 "Return the buffer visiting file FILENAME (a string).
1839 This is like `get-file-buffer', except that it checks for any buffer
1840 visiting the same file, possibly under a different name.
1841 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1842 and others are ignored.
1843 If there is no such live buffer, return nil."
1856 found)
1866 ;; Verify this buffer's file number
1867 ;; still belongs to its file.
1870 attributes)
1874 found))))
1875 \f
1877 "Non-nil means file-visiting commands should handle wildcards.
1878 For example, if you specify `*.c', that would visit all the files
1879 whose names match the pattern."
1885 "Non-nil means suppress warning messages for symlinked files.
1886 When nil, Emacs prints a warning when visiting a file that is already
1887 visited, but with a different name. Setting this option to t
1888 suppresses this warning."
1894 "Maximum size of file above which a confirmation is requested.
1895 When nil, never request confirmation."
1902 "Warn if file size exceeds this percentage of available free memory.
1903 When nil, never issue warning. Beware: This probably doesn't do what you
1911 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1912 OP-TYPE specifies the file operation being performed (for message to user)."
1921 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1931 "You are trying to open a file whose size (%s)
1932 exceeds the %S%% of currently available free memory (%s).
1933 If that fails, try to open it with `find-file-literally'
1934 \(but note that some characters might be displayed incorrectly)."
1936 out-of-memory-warning-percentage
1940 "Like `message', except sometimes don't print to minibuffer.
1941 If the variable `save-silently' is non-nil, the message is not
1942 displayed on the minibuffer."
1947 "Read file FILENAME into a buffer and return the buffer.
1948 If a buffer exists visiting FILENAME, return that one, but
1949 verify that the file has not changed since visited or saved.
1950 The buffer is not selected, just returned to the caller.
1951 Optional second arg NOWARN non-nil means suppress any warning messages.
1952 Optional third arg RAWFILE non-nil means the file is read literally.
1953 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1954 and visit all the matching files. When wildcards are actually
1955 used and expanded, return a list of buffers that are visiting
1956 the various files."
1963 'find-directory-functions
1966 filename)))
1969 find-file-wildcards
1983 ;; Find any buffer for a file which has same truename.
1985 ;; Let user know if there is a buffer with the same truename.
1989 find-file-suppress-same-file-warnings
1993 ;; Optionally also find that buffer.
1996 ;; Check to see if the file looks uncommonly large.
2001 ;; We are using an existing buffer.
2008 ;; Certain files should be reverted automatically
2009 ;; if they have changed on disk and not in the buffer.
2017 found))
2027 "File %s changed on disk. Discard your edits? "
2032 "File %s changed on disk. Discard your edits in %s? "
2040 ;; Check if a formerly read-only file has become
2041 ;; writable and vice versa, but if the buffer agrees
2042 ;; with the new state of the file, that is ok too.
2052 buffer-file-name
2053 new-status new-status)))
2059 nonexistent
2060 ;; It is confusing to ask whether to visit
2061 ;; non-literally if they have the file in
2062 ;; hexl-mode or image-mode.
2068 "The file %s is already visited normally,
2069 and you have edited the buffer. Now you have asked to visit it literally,
2070 meaning no coding system handling, format conversion, or local variables.
2071 Emacs can only visit a file in one way at a time.
2073 Do you want to save the file, and visit it literally instead? "
2074 "The file %s is already visited literally,
2075 meaning no coding system handling, format conversion, or local variables.
2076 You have edited the buffer. Now you have asked to visit the file normally,
2077 but Emacs can only visit a file in one way at a time.
2084 rawfile truename number))
2088 "\
2089 Do you want to discard your changes, and visit the file literally now? "
2090 "\
2093 rawfile truename number)
2099 "The file %s is already visited normally.
2100 You have asked to visit it literally,
2101 meaning no coding system decoding, format conversion, or local variables.
2102 But Emacs can only visit a file in one way at a time.
2104 Do you want to revisit the file literally now? "
2105 "The file %s is already visited literally,
2106 meaning no coding system decoding, format conversion, or local variables.
2107 You have asked to visit it normally,
2108 but Emacs can only visit a file in one way at a time.
2113 rawfile truename number)
2116 ;; Return the buffer we are using.
2117 buf)
2118 ;; Create a new buffer.
2120 ;; find-file-noselect-1 may use a different buffer.
2122 rawfile truename number))))))
2128 ;; Needed in case we are re-visiting the file with a different
2129 ;; text representation.
2146 filename)))
2147 ;; Unconditionally set error
2157 filename)))
2158 ;; Run find-file-not-found-functions until one returns non-nil.
2160 ;; If they fail too, set error.
2162 ;; Record the file's truename, and maybe use that as visited name.
2170 ;; Set buffer's default directory to that of the file.
2172 ;; Turn off backup files for certain file names. Since
2173 ;; this is a permanent local, the major mode won't eliminate it.
2187 \f
2189 "Like `insert-file-contents', but only reads in the file literally.
2190 See `insert-file-contents' for an explanation of the parameters.
2191 A buffer may be modified in several ways after reading into the buffer,
2192 due to Emacs features such as format decoding, character code
2193 conversion, `find-file-hook', automatic uncompression, etc.
2195 This function ensures that none of these modifications will take place."
2201 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2202 ;; into a file operation instead!
2204 inhibit-file-name-handlers))
2211 filename)))
2212 ;; Check whether the file is uncommonly large
2223 "Insert contents of file FILENAME into buffer after point with no conversion.
2225 This function is meant for the user to run interactively.
2226 Don't call it from programs! Use `insert-file-contents-literally' instead.
2227 \(Its calling sequence is different; see its documentation)."
2233 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2234 This has the `permanent-local' property, which takes effect if you
2239 "Visit file FILENAME with no conversion of any kind.
2240 Format conversion and character code conversion are both disabled,
2241 and multibyte characters are disabled in the resulting buffer.
2242 The major mode used is Fundamental mode regardless of the file name,
2243 and local variable specifications in the file are ignored.
2244 Automatic uncompression and adding a newline at the end of the
2245 file due to `require-final-newline' is also disabled.
2247 You cannot absolutely rely on this function to result in
2248 visiting the file literally. If Emacs already has a buffer
2249 which is visiting the file, you get the existing buffer,
2250 regardless of whether it was created literally or not.
2252 In a Lisp program, if you want to be sure of accessing a file's
2253 contents literally, you should create a temporary buffer and then read
2254 the file contents into it using `insert-file-contents-literally'."
2257 "Find file literally: " nil default-directory
2260 \f
2262 _after-find-file-from-revert-buffer
2263 nomodes)
2264 "Called after finding a file and by the default revert function.
2265 Sets buffer mode, parses local variables.
2266 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2267 error in reading the file. WARN non-nil means warn if there
2268 exists an auto-save file more recent than the visited file.
2269 NOAUTO means don't mess with auto-save mode.
2270 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2271 \(see `revert-buffer-in-progress-p' for similar functionality).
2272 Fifth arg NOMODES non-nil means don't alter the file's modes.
2273 Finishes by calling the functions in `find-file-hook'
2274 unless NOMODES is non-nil."
2277 nil
2287 "Symbolic link that points to nonexistent file"
2291 ;; No need to warn if buffer is auto-saved
2292 ;; under the name of the visited file.
2294 auto-save-visited-file-name))
2297 buffer-file-name))
2317 ;; Make people do a little extra work (C-x C-q)
2318 ;; before altering a backup file.
2321 ;; When a file is marked read-only,
2322 ;; make the buffer read-only even if root is looking at it.
2330 ;; If requested, add a newline at the end of the file.
2341 view-read-only
2349 "Choose the major mode for this buffer automatically.
2350 Also sets up any specified local variables of the file.
2351 Uses the visited file name, the -*- line, and the local variables spec.
2353 This function is called automatically from `find-file'. In that case,
2354 we may set up the file-specified mode and local variables,
2355 depending on the value of `enable-local-variables'.
2356 In addition, if `local-enable-local-variables' is nil, we do
2357 not set local variables (though we do notice a mode specified with -*-.)
2359 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2360 or from Lisp without specifying the optional argument FIND-FILE;
2361 in that case, this function acts as if `enable-local-variables' were t."
2368 ;; FIXME this is less efficient than it could be, since both
2369 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2372 ;; `delay-mode-hooks' being non-nil will have prevented the major
2373 ;; mode's call to `run-mode-hooks' from calling
2374 ;; `hack-local-variables'. In that case, call it now.
2378 ;; Turn font lock off and on, to make sure it takes account of
2379 ;; whatever file local variables are relevant to it.
2381 ;; Font-lock-mode (now in font-core.el) can be ON when
2382 ;; font-lock.el still hasn't been loaded.
2389 "Non-nil means to try second pass through `auto-mode-alist'.
2390 This means that if the first case-sensitive search through the alist fails
2391 to find a matching major mode, a second case-insensitive search is made.
2392 On systems with case-insensitive file names, this variable is ignored,
2393 since only a single case-insensitive search through the alist is made."
2399 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2400 ;; c++-mode, java-mode and more) are added through autoload
2401 ;; directives in that file. That way is discouraged since it
2402 ;; spreads out the definition of the initial value.
2448 ;; Less common extensions come here
2449 ;; so more common ones above are found faster.
2457 ;; Besides .gdbinit, gdb documents other names to be usable for init
2458 ;; files, cross-debuggers can use something like
2459 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2460 ;; don't interfere with each other.
2462 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2463 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2464 ;; loaded when GDB reads an objfile called 'emacs'.
2472 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2496 ;; The Fortran standard does not say anything about file extensions.
2497 ;; .f90 was widely used for F90, now we seem to be trapped into
2498 ;; using a different extension for each language revision.
2499 ;; Anyway, the following extensions are supported by gfortran.
2507 ;; The list of archive file extensions should be in sync with
2508 ;; `auto-coding-alist' with `no-conversion' coding system.
2514 ;; Mailer puts message to be edited in
2515 ;; /tmp/Re.... or Message
2518 ;; some news reader is reported to use this
2531 ;; .emacs or .gnus or .viper following a directory delimiter in
2532 ;; Unix or MS-DOS syntax.
2535 ;; _emacs following a directory delimiter in MS-DOS syntax
2539 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2540 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2541 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2544 ;; .xs is also used for ld scripts, but seems to be more commonly
2545 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2547 ;; Explained in binutils ld/genscripts.sh. Eg:
2548 ;; A .x script file is the default script.
2549 ;; A .xr script is for linking without relocation (-r flag). Etc.
2553 ;; Common Lisp ASDF package system.
2560 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2572 ;; Windows candidates may be opened case sensitively on Unix
2578 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2579 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2580 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2581 ;; this has lower priority to avoid matching changelog.sgml etc.
2583 ;; either user's dot-files or under /etc or some such
2585 ;; alas not all ~/.*rc files are like this
2586 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2591 ;; this contains everything twice, with space and with colon :-(
2593 ;; Get rid of any trailing .n.m and try again.
2594 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2595 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2596 ;; Using mode nil rather than `ignore' would let the search continue
2597 ;; through this list (with the shortened name) rather than start over.
2600 ;; This should come after "in" stripping (e.g. config.h.in).
2601 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2603 ;; The following should come after the ChangeLog pattern
2604 ;; for the sake of ChangeLog.1, etc.
2605 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2607 "Alist of filename patterns vs corresponding major mode functions.
2608 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2609 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2610 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2611 mode function to use. FUNCTION will be called, unless it is nil.
2613 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2614 calling FUNCTION (if it's not nil), we delete the suffix that matched
2615 REGEXP and search the list again for another match.
2617 The extensions whose FUNCTION is `archive-mode' should also
2618 appear in `auto-coding-alist' with `no-conversion' coding system.
2620 See also `interpreter-mode-alist', which detects executable script modes
2621 based on the interpreters they specify to run,
2626 "Select Conf mode or XML mode according to start of file."
2636 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2637 ;; and pike-mode) are added through autoload directives in that
2638 ;; file. That way is discouraged since it spreads out the
2639 ;; definition of the initial value.
2668 "Alist mapping interpreter names to major modes.
2669 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2670 Each element looks like (REGEXP . MODE).
2671 If REGEXP matches the entire name (minus any directory part) of
2672 the interpreter specified in the first line of a script, enable
2673 major mode MODE.
2680 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2681 ;; because we are duplicating info from auto-mode-alist.
2682 ;; TODO many elements of this list are also in auto-coding-alist.
2691 "List of regexps matching file names in which to ignore local variables.
2693 Files matching this list are typically binary file formats.
2694 They may happen to contain sequences that look like local variable
2695 specifications, but are not really, or they may be containers for
2696 member files with their own local variable sections, which are
2697 not appropriate for the containing file.
2704 "List of regexps matching suffixes to remove from file names.
2705 The function `inhibit-local-variables-p' uses this: when checking
2706 a file name, it first discards from the end of the name anything that
2709 ;; Can't think of any situation in which you'd want this to be nil...
2714 "Return non-nil if file local variables should be ignored.
2715 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2716 and `inhibit-local-variables-suffixes'. If
2717 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2726 sufs)
2731 temp))
2736 "Regexp matching interpreters, for file mode determination.
2737 This regular expression is matched against the first line of a file
2738 to determine the file's mode in `set-auto-mode'. If it matches, the file
2739 is assumed to be interpreted by the interpreter matched by the second group
2740 of the regular expression. The mode is then determined as the mode
2744 "Alist of buffer beginnings vs. corresponding major mode functions.
2745 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2746 After visiting a file, if REGEXP matches the text at the beginning of the
2747 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2748 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2749 major mode.
2751 If FUNCTION is nil, then it is not called. (That is a way of saying
2759 ;; The < comes before the groups (but the first) to reduce backtracking.
2760 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2761 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2765 comment-re "*"
2768 . html-mode)
2770 ;; These two must come after html, because they are more general:
2775 . sgml-mode)
2778 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2779 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2780 After visiting a file, if REGEXP matches the text at the beginning of the
2781 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2782 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2783 have not specified a mode for this file.
2789 "Upper limit on `magic-mode-alist' regexp matches.
2793 "Select major mode appropriate for current buffer.
2795 To find the right major mode, this function checks for a -*- mode tag
2796 checks for a `mode:' entry in the Local Variables section of the file,
2797 checks if it uses an interpreter listed in `interpreter-mode-alist',
2798 matches the buffer beginning against `magic-mode-alist',
2799 compares the filename against the entries in `auto-mode-alist',
2800 then matches the buffer beginning against `magic-fallback-mode-alist'.
2802 If `enable-local-variables' is nil, or if the file name matches
2803 `inhibit-local-variables-regexps', this function does not check
2804 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2805 is nil, then the only mode: tag that can be relevant is a -*- one.
2807 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2808 set the major mode only if that would change it. In other words
2809 we don't actually set it to the same mode the buffer already has."
2810 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2812 end done mode modes)
2813 ;; Once we drop the deprecated feature where mode: is also allowed to
2814 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2815 ;; remove this section and just let (hack-local-variables t) handle it.
2816 ;; Find a -*- mode tag.
2820 ;; Note by design local-enable-local-variables does not matter here.
2822 try-locals
2825 ;; Find all specifications for the `mode:' variable
2826 ;; and execute them left to right.
2838 modes)))
2839 ;; Simple -*-MODE-*- case.
2842 modes))))
2843 ;; If we found modes to use, invoke them now, outside the save-excursion.
2851 ;; continuing would call minor modes again, toggling them off
2853 ;; hack-local-variables checks local-enable-local-variables etc, but
2854 ;; we might as well be explicit here for the sake of clarity.
2856 enable-local-variables
2857 local-enable-local-variables
2858 try-locals
2865 ;; If we didn't, look for an interpreter specified in the first line.
2866 ;; As a special case, allow for things like "#!/bin/env perl", which
2867 ;; finds the interpreter anywhere in $PATH.
2873 ;; Map interpreter name to a mode, signaling we're done at the
2874 ;; same time.
2881 interpreter-mode-alist)
2883 ;; If we found an interpreter mode to use, invoke it now.
2885 ;; Next try matching the buffer beginning against magic-mode-alist.
2899 ;; Next compare the filename against the entries in auto-mode-alist.
2904 ;; Remove backup-suffixes from file name.
2906 ;; Remove remote file name identification.
2911 ;; Find first matching alist entry.
2914 ;; System is case-insensitive.
2918 ;; System is case-sensitive.
2920 ;; First match case-sensitively.
2924 ;; Fallback to case-insensitive match.
2938 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2955 ;; When `keep-mode-if-same' is set, we are working on behalf of
2956 ;; set-visited-file-name. In that case, if the major mode specified is the
2957 ;; same one we already have, don't actually reset it. We don't want to lose
2958 ;; minor modes such as Font Lock.
2960 "Apply MODE and return it.
2961 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2962 any aliases and compared to current major mode. If they are the
2963 same, do nothing and return nil."
2969 mode)))
2972 "Regexp of lines to skip when looking for file-local settings.
2973 If the first line matches this regular expression, then the -*-...-*- file-
2977 "Find the -*- spec in the buffer.
2978 Call with point at the place to start searching from.
2979 If one is found, set point to the beginning and return the position
2980 of the end. Otherwise, return nil; may change point.
2981 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2982 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2983 have no effect."
2986 ;; Don't look for -*- if this file name matches any
2987 ;; of the regexps in inhibit-local-variables-regexps.
2990 ;; If the file begins with "#!" (exec
2991 ;; interpreter magic), look for mode frobs
2992 ;; in the first two lines. You cannot
2993 ;; necessarily put them in the first line
2994 ;; of such a file without screwing up the
2995 ;; interpreter invocation. The same holds
2996 ;; for '\" in man pages (preprocessor
2997 ;; magic for the `man' program).
3008 end))))
3009 \f
3010 ;;; Handling file local variables
3014 file-local-variables-alist dir-local-variables-alist)
3019 "Normal hook run after processing a file's local variables specs.
3020 Major modes can use this to examine user-specified local variables
3024 "List variable-value pairs that are considered safe.
3025 Each element is a cons cell (VAR . VAL), where VAR is a variable
3026 symbol and VAL is a value that is considered safe."
3027 :risky t
3032 ;; This should be here at least as long as Emacs supports write-file-hooks.
3037 "Expressions that are considered safe in an `eval:' local variable.
3038 Add expressions to this list if you want Emacs to evaluate them, when
3039 they appear in an `eval' local variable specification, without first
3040 asking you for confirmation."
3041 :risky t
3046 ;; Risky local variables:
3049 buffer-auto-save-file-name
3050 buffer-file-name
3051 buffer-file-truename
3052 buffer-undo-list
3053 debugger
3054 default-text-properties
3055 eval
3056 exec-directory
3057 exec-path
3058 file-name-handler-alist
3059 frame-title-format
3060 global-mode-string
3061 header-line-format
3062 icon-title-format
3063 inhibit-quit
3064 load-path
3065 max-lisp-eval-depth
3066 max-specpdl-size
3067 minor-mode-map-alist
3068 minor-mode-overriding-map-alist
3069 mode-line-format
3070 mode-name
3071 overriding-local-map
3072 overriding-terminal-local-map
3073 process-environment
3074 standard-input
3075 standard-output
3076 unread-command-events))
3078 ;; Safe local variables:
3079 ;;
3080 ;; For variables defined by major modes, the safety declarations can go into
3081 ;; the major mode's file, since that will be loaded before file variables are
3082 ;; processed.
3083 ;;
3084 ;; For variables defined by minor modes, put the safety declarations in the
3085 ;; file defining the minor mode after the defcustom/defvar using an autoload
3086 ;; cookie, e.g.:
3087 ;;
3088 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3089 ;;
3090 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3091 ;; minor mode file may not be loaded yet.
3092 ;;
3093 ;; For variables defined in the C source code the declaration should go here:
3115 "Alist of file-local variable settings in the current buffer.
3116 Each element in this list has the form (VAR . VALUE), where VAR
3117 is a file-local variable (a symbol) and VALUE is the value
3118 specified. The actual value in the buffer may differ from VALUE,
3124 "Alist of directory-local variable settings in the current buffer.
3125 Each element in this list has the form (VAR . VALUE), where VAR
3126 is a directory-local variable (a symbol) and VALUE is the value
3127 specified in .dir-locals.el. The actual value in the buffer
3128 may differ from VALUE, if it is changed by the major or minor modes,
3133 "Normal hook run before setting file-local variables.
3134 It is called after checking for unsafe/risky variables and
3135 setting `file-local-variables-alist', and before applying the
3136 variables stored in `file-local-variables-alist'. A hook
3137 function is allowed to change the contents of this alist.
3139 This hook is called only if there is at least one file-local
3143 "Get confirmation before setting up local variable values.
3144 ALL-VARS is the list of all variables to be set up.
3145 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3146 RISKY-VARS is the list of those that are marked as risky.
3147 If these settings come from directory-local variables, then
3148 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3155 unsafe-vars))
3157 ;; Set up the contents of the *Local Variables* buffer.
3165 ", and variables that are risky (**)."
3173 y -- to apply the local variables list.
3177 ! -- to apply the local variables list, and permanently mark these
3189 ;; Make strings with embedded whitespace easier to read.
3197 ;; Display the buffer and read a choice.
3205 ""
3208 char)
3227 "Return local variables specified in the -*- line.
3228 Returns an alist of elements (VAR . VAL), where VAR is a variable
3229 and VAL is the specified value. Ignores any specification for
3230 `mode:' and `coding:' (which should have already been handled
3231 by `set-auto-mode' and `set-auto-coding', respectively).
3232 Return nil if the -*- line is malformed.
3234 If MODE-ONLY is non-nil, just returns the symbol specifying the
3235 mode, if there is one, otherwise nil."
3240 result)
3242 nil)
3244 ;; Simple form: "-*- MODENAME -*-".
3248 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3249 ;; (last ";" is optional).
3250 ;; If MODE-ONLY, just check for `mode'.
3251 ;; Otherwise, parse the -*- line into the RESULT alist.
3259 ;; There used to be a downcase here,
3260 ;; but the manual didn't say so,
3261 ;; and people want to set var names that aren't all lc.
3267 ;; It is traditional to ignore
3268 ;; case when checking for `mode' in set-auto-mode,
3269 ;; so we must do that here as well.
3270 ;; That is inconsistent, but we're stuck with it.
3271 ;; The same can be said for `coding' in set-auto-coding.
3281 ;; Downcase "Mode:".
3287 result))))))
3290 "Filter local variable settings, querying the user if necessary.
3291 VARIABLES is the alist of variable-value settings. This alist is
3292 filtered based on the values of `ignored-local-variables',
3293 `enable-local-eval', `enable-local-variables', and (if necessary)
3294 user interaction. The results are added to
3295 `file-local-variables-alist', without applying them.
3296 If these settings come from directory-local variables, then
3297 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3298 ;; Find those variables that we may want to save to
3299 ;; `safe-local-variable-values'.
3305 ;; Ignore any variable in `ignored-local-variables'.
3306 nil)
3307 ;; Obey `enable-local-eval'.
3311 ;; In case previously marked safe (bug#5636).
3313 ;; If not safe and e-l-v = :safe, ignore totally.
3317 safe
3319 ;; Ignore duplicates (except `mode') in the present list.
3321 ;; Accept known-safe variables.
3325 ;; The variable is either risky or unsafe:
3332 ;; Query, unless all vars are safe or user wants no querying.
3338 risky-vars dir-name))
3348 ;; TODO? Warn once per file rather than once per session?
3352 "Parse and put into effect this buffer's local variables spec.
3353 Uses `hack-local-variables-apply' to apply the variables.
3355 If HANDLE-MODE is nil, we apply all the specified local
3356 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3357 except that any settings of `mode' are ignored.
3360 is specified, and return the corresponding mode symbol, or nil.
3361 In this case, we try to ignore minor-modes, and only return a
3362 major-mode.
3364 If `enable-local-variables' or `local-enable-local-variables' is nil,
3365 this function does nothing. If `inhibit-local-variables-regexps'
3366 applies to the file in question, the file is not scanned for
3367 local variables, but directory-local variables may still be applied."
3368 ;; We don't let inhibit-local-variables-p influence the value of
3369 ;; enable-local-variables, because then it would affect dir-local
3370 ;; variables. We don't want to search eg tar files for file local
3371 ;; variable sections, but there is no reason dir-locals cannot apply
3372 ;; to them. The real meaning of inhibit-local-variables-p is "do
3373 ;; not scan this file for local variables".
3376 result)
3380 ;; Note this is a no-op if enable-local-variables is nil.
3382 ;; This entire function is basically a no-op if enable-local-variables
3383 ;; is nil. All it does is set file-local-variables-alist to nil.
3385 ;; This part used to ignore enable-local-variables when handle-mode
3386 ;; was t. That was inappropriate, eg consider the
3387 ;; (artificial) example of:
3388 ;; (setq local-enable-local-variables nil)
3389 ;; Open a file foo.txt that contains "mode: sh".
3390 ;; It correctly opens in text-mode.
3391 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3393 ;; If HANDLE-MODE is t, and the prop line specifies a
3394 ;; mode, then we're done, and have no need to scan further.
3398 ;; Look for "Local variables:" line in last page.
3406 ;; suffix is what comes after "local variables:" in its line.
3407 ;; prefix is what comes before "local variables:" in its line.
3420 endpos
3426 nil t))
3427 ;; This used to be an error, but really all it means is
3428 ;; that this may simply not be a local-variables section,
3429 ;; so just ignore it.
3439 ;; Discard the prefix.
3444 ;; Discard the suffix.
3453 ;; Find the variable name;
3461 val val2)
3464 ;; Read the variable value.
3471 ;; Specifying minor-modes via mode: is
3472 ;; deprecated, but try to reject them anyway.
3482 'files
3484 "%s: `lexical-binding' at end of file unreliable"
3486 ;; We are called from
3487 ;; 'with-temp-buffer', so we need
3488 ;; to use 'thisbuf's name in the
3489 ;; warning message.
3495 'eval
3499 ;; Now we've read all the local variables.
3500 ;; If HANDLE-MODE is t, return whether the mode was specified.
3502 ;; Otherwise, set the variables.
3507 "Apply the elements of `file-local-variables-alist'.
3508 If there are any elements, runs `before-hack-local-variables-hook',
3509 then calls `hack-one-local-variable' to apply the alist elements one by one.
3510 Finishes by running `hack-local-variables-hook', regardless of whether
3511 the alist is empty or not.
3513 Note that this function ignores a `mode' entry if it specifies the same
3514 major mode as the buffer already has."
3516 ;; Any 'evals must run in the Right sequence.
3525 "Non-nil if SYM is safe as a file-local variable with value VAL.
3526 It is safe if any of these conditions are met:
3528 * There is a matching entry (SYM . VAL) in the
3529 `safe-local-variable-values' user option.
3531 * The `safe-local-variable' property of SYM is a function that
3532 evaluates to a non-nil value with VAL as an argument."
3536 ;; If the function signals an error, that means it
3537 ;; can't assure us that the value is safe.
3541 "Non-nil if SYM could be dangerous as a file-local variable.
3542 It is dangerous if either of these conditions are met:
3544 * Its `risky-local-variable' property is non-nil.
3550 ;; If this is an alias, check the base name.
3570 "Return t if it is safe to eval EXP when it is found in a file."
3572 ;; Detect certain `put' expressions.
3579 lisp-indent-function
3580 scheme-indent-function))
3581 ;; Only allow safe values (not functions).
3586 ;; Only allow indirect form specs.
3587 ;; During bootstrapping, edebug-basic-spec might not be
3588 ;; defined yet.
3592 ;; Allow expressions that the user requested.
3594 ;; Certain functions can be allowed with safe arguments
3595 ;; or can specify verification functions to try.
3597 ;; Allow (minor)-modes calls with no arguments.
3598 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3607 ok))
3615 ok))))))))
3629 "Set local variable VAR with value VAL.
3630 If VAR is `mode', call `VAL-mode' as a function unless it's
3631 already the major mode."
3633 (`mode
3639 (`eval
3645 ;; Make sure the string has no text properties.
3646 ;; Some text properties can get evaluated in various ways,
3647 ;; so it is risky to put them on with a local variable list.
3651 \f
3652 ;;; Handling directory-local variables, aka project settings.
3658 "List of cached directory roots for directory-local variable classes.
3659 Each element in this list has the form (DIR CLASS MTIME).
3660 DIR is the name of the directory.
3661 CLASS is the name of a variable class (a symbol).
3662 MTIME is the recorded modification time of the directory-local
3663 variables file associated with this entry. This time is a list
3664 of integers (the same format as `file-attributes'), and is
3665 used to test whether the cache entry is still valid.
3666 Alternatively, MTIME can be nil, which means the entry is always
3670 "Return the variable list for CLASS."
3674 "Collect directory-local variables from MODE-VARIABLES.
3675 VARIABLES is the initial list of variables.
3676 Returns the new list."
3681 ;; If variables are specified more than once, only use the last. (Why?)
3682 ;; The pseudo-variables mode and eval are different (bug#3430).
3685 ;; Need a new cons in case we setcdr later.
3689 "Collect entries from CLASS-VARIABLES into VARIABLES.
3690 ROOT is the root directory of the project.
3691 Return the new variables list."
3693 ;; Handle non-file buffers, too.
3696 ;; FIXME: Why not use file-relative-name?
3703 ;; Don't include this in the previous condition, because we
3704 ;; want to filter all strings before the next condition.
3718 ;; TODO someone might want to extend this to allow
3719 ;; integer values for subdir, where N means
3720 ;; variables apply to this directory and N levels
3721 ;; below it (0 == nil).
3724 alist variables))))))))
3726 ;; The file's content might be invalid (e.g. have a merge conflict), but
3727 ;; that shouldn't prevent the user from opening the file.
3729 nil))))
3732 "Declare that the DIRECTORY root is an instance of CLASS.
3733 DIRECTORY is the name of a directory, a string.
3734 CLASS is the name of a project class, a symbol.
3735 MTIME is either the modification time of the directory-local
3736 variables file that defined this class, or nil.
3738 When a file beneath DIRECTORY is visited, the mode-specific
3739 variables from CLASS are applied to the buffer. The variables
3740 for a class are defined using `dir-locals-set-class-variables'."
3747 "Map the type CLASS to a list of variable settings.
3748 CLASS is the project class, a symbol. VARIABLES is a list
3749 that declares directory-local variables for the class.
3750 An element in VARIABLES is either of the form:
3751 (MAJOR-MODE . ALIST)
3752 or
3753 (DIRECTORY . LIST)
3755 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3756 whose elements are of the form (VARIABLE . VALUE).
3758 In the second form, DIRECTORY is a directory name (a string), and
3759 LIST is a list of the form accepted by the function.
3761 When a file is visited, the file's class is found. A directory
3762 may be assigned a class using `dir-locals-set-directory-class'.
3763 Then variables are set in the file's buffer according to the
3764 VARIABLES list of the class. The list is processed in order.
3766 * If the element is of the form (MAJOR-MODE . ALIST), and the
3767 buffer's major mode is derived from MAJOR-MODE (as determined
3768 by `derived-mode-p'), then all the variables in ALIST are
3769 applied. A MAJOR-MODE of nil may be used to match any buffer.
3770 `make-local-variable' is called for each variable before it is
3771 set.
3773 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3774 is an initial substring of the file's directory, then LIST is
3775 applied by recursively following these rules."
3779 "File that contains directory-local variables.
3780 It has to be constant to enforce uniform values across different
3781 environments and users.
3782 See also `dir-locals-file-2', whose values override this one's.
3786 "File that contains directory-local variables.
3787 This essentially a second file that can be used like
3788 `dir-locals-file', so that users can have specify their personal
3789 dir-local variables even if the current directory already has a
3790 `dir-locals-file' that is shared with other users (such as in a
3791 git repository).
3795 "Return a list of all readable dir-locals files in DIRECTORY.
3796 The returned list is sorted by increasing priority. That is,
3797 values specified in the last file should take precedence over
3798 those in the first."
3802 dir-locals-file)
3803 directory))
3807 ;; The order here is important.
3814 out)))
3817 "Find the directory-local variables for FILE.
3818 This searches upward in the directory tree from FILE.
3819 It stops at the first directory that has been registered in
3820 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3821 If it finds an entry in the cache, it checks that it is valid.
3822 A cache entry with no modification time element (normally, one that
3823 has been assigned directly using `dir-locals-set-directory-class', not
3824 set from a file) is always valid.
3825 A cache entry based on a `dir-locals-file' is valid if the modification
3826 time stored in the cache matches the current file modification time.
3827 If not, the cache entry is cleared so that the file will be re-read.
3829 This function returns either:
3830 - nil (no directory local variables found),
3831 - the matching entry from `dir-locals-directory-cache' (a list),
3832 - or the full path to the directory (a string) containing at
3833 least one `dir-locals-file' in the case of no valid cache
3834 entry."
3838 dir-elt)
3839 ;; `locate-dominating-file' may have abbreviated the name.
3842 ;; Find the best cached value in `dir-locals-directory-cache'.
3853 ;; Found a potential cache entry. Check validity.
3854 ;; A cache entry with no MTIME is assumed to always be valid
3855 ;; (ie, set directly, not from a dir-locals file).
3856 ;; Note, we don't bother to check that there is a matching class
3857 ;; element in dir-locals-class-alist, since that's done by
3858 ;; dir-locals-set-directory-class.
3861 ;; The entry MTIME should match the most recent
3862 ;; MTIME among matching files.
3868 cached-files))))))
3869 ;; This cache entry is OK.
3870 dir-elt
3871 ;; This cache entry is invalid; clear it.
3874 ;; Return the first existing dir-locals file. Might be the same
3875 ;; as dir-elt's, might not (eg latter might have been deleted).
3876 locals-dir)
3877 ;; No cache entry.
3878 locals-dir)))
3881 "Load all variables files in DIR and register a new class and instance.
3882 DIR is the absolute name of a directory which must contain at
3883 least one dir-local file (which is a file holding variables to
3884 apply).
3885 Return the new class name, which is a symbol named DIR."
3899 variables
3905 dir class-name
3910 files))
3911 ;; If there was a problem, use the values we could get but
3912 ;; don't let the cache prevent future reads.
3914 class-name))
3920 "Non-nil means dir-local variables will be applied to remote files."
3928 "Read per-directory local variables for the current buffer.
3929 Store the directory-local variables in `dir-local-variables-alist'
3930 and `file-local-variables-alist', without applying them.
3932 This does nothing if either `enable-local-variables' or
3933 `enable-dir-local-variables' are nil."
3935 enable-dir-local-variables
3938 default-directory)))))
3939 ;; Find the variables file.
3969 "Apply directory-local variables to a non-file buffer.
3970 For non-file buffers, such as Dired buffers, directory-local
3971 variables are looked for in `default-directory' and its parent
3972 directories."
3976 \f
3979 However, the mode will not be changed if
3980 \(1) a local variables list or the `-*-' line specifies a major mode, or
3982 not suitable for ordinary files, or
3983 \(3) the new file name does not particularly specify any mode."
3988 "Change name of file visited in current buffer to FILENAME.
3989 This also renames the buffer to correspond to the new file.
3990 The next time the buffer is saved it will go in the newly specified file.
3991 FILENAME nil or an empty string means mark buffer as not visiting any file.
3992 Remember to delete the initial contents of the minibuffer
3993 if you wish to pass an empty string as the argument.
3995 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3996 confirmation in the case where another buffer is already visiting FILENAME.
3998 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3999 the old visited file has been renamed to the new name FILENAME."
4007 nil
4022 filename)))
4029 buffer-file-name filename)
4033 ;; If new-name == old-name, renaming would add a spurious <2>
4034 ;; and it's considered as a feature in rename-buffer.
4040 ;; Abbreviate the file names of the buffer.
4049 nil))
4050 ;; write-file-functions is normally used for things like ftp-find-file
4051 ;; that visit things that are not local files as if they were files.
4052 ;; Changing to visit an ordinary local file instead should flush the hook.
4057 ;; If buffer was read-only because of version control,
4058 ;; that reason is gone now, so make it writable.
4062 ;; Turn off backup files for certain file names.
4063 ;; Since this is a permanent local, the major mode won't eliminate it.
4065 backup-enable-predicate
4074 ;; If auto-save was not already on, turn it on if appropriate.
4077 ;; If auto save is on, start using a new name. We
4078 ;; deliberately don't rename or delete the old auto save
4079 ;; for the old visited file name. This is because
4080 ;; perhaps the user wants to save the new state and then
4081 ;; compare with the previous state from the auto save
4082 ;; file.
4084 ;; Rename the old auto save file if any.
4091 ;; Update the major mode, if the file name determines it.
4093 ;; Don't change the mode if it is special.
4096 ;; Don't change the mode if the local variable list specifies it.
4097 ;; The file name can influence whether the local variables apply.
4099 ;; h-l-v also checks it, but might as well be explicit.
4102 ;; TODO consider making normal-mode handle this case.
4110 "Write current buffer into file FILENAME.
4111 This makes the buffer visit that file, and marks it as not modified.
4113 If you specify just a directory name as FILENAME, that means to use
4114 the default file name but in that directory. You can also yank
4115 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4117 If the buffer is not already visiting a file, the default file name
4118 for the output file is the buffer name.
4120 If optional second arg CONFIRM is non-nil, this function
4121 asks for confirmation before overwriting an existing file.
4122 Interactively, confirmation is required unless you supply a prefix argument."
4123 ;; (interactive "FWrite file: ")
4127 nil nil nil nil)
4131 default-directory)
4132 nil nil))
4136 ;; If arg is just a directory,
4137 ;; use the default file name, but in that directory.
4144 ;; NS does its own confirm dialog.
4147 use-dialog-box))
4153 ;; Make buffer writable if file is writable.
4158 ;; It's likely that the VC status at the new location is different from
4159 ;; the one at the old location.
4161 \f
4163 "Return an alist of extended attributes of file FILENAME.
4165 Extended attributes are platform-specific metadata about the file,
4166 such as SELinux context, list of ACL entries, etc."
4171 "Set extended attributes of file FILENAME to ATTRIBUTES.
4173 ATTRIBUTES must be an alist of file attributes as returned by
4174 `file-extended-attributes'.
4175 Value is t if the function succeeds in setting the attributes."
4186 result))
4187 \f
4189 "Make a backup of the disk file visited by the current buffer, if appropriate.
4190 This is normally done before saving the buffer the first time.
4192 A backup may be done by renaming or by copying; see documentation of
4193 variable `make-backup-files'. If it's done by renaming, then the file is
4194 no longer accessible under its old name.
4196 The value is non-nil after a backup was made by renaming.
4197 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4198 MODES is the result of `file-modes' on the original
4199 file; this means that the caller, after saving the buffer, should change
4200 the modes of the new file to agree with the old modes.
4201 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4202 on the original file; this means that the caller, after saving
4203 the buffer, should change the extended attributes of the new file
4204 to agree with the old attributes.
4205 BACKUPNAME is the backup file name, which is the old file renamed."
4209 ;; If specified name is a symbolic link, chase it to the target.
4210 ;; This makes backups in the directory where the real file is.
4217 ;; If have old versions to maybe delete,
4218 ;; ask the user to confirm now, before doing anything.
4219 ;; But don't actually delete til later.
4225 real-file-name)))
4226 targets))
4231 backup-by-copying-when-privileged-mismatch)
4234 ;; Don't rename a suid or sgid file.
4243 real-file-name
4246 copy-when-priv-mismatch))))
4248 t)))))
4249 setmodes)
4252 ;; Actually make the backup file.
4255 modes extended-attributes)
4256 ;; rename-file should delete old backup.
4259 backupname)))
4261 ;; Now delete the old versions, if desired.
4265 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4269 backupname)
4272 modes extended-attributes)
4274 setmodes)))))))
4277 ;; Create temp files with strict access rights. It's easy to
4278 ;; loosen them later, whereas it's impossible to close the
4279 ;; time-window of loose permissions otherwise.
4282 ;; Try to overwrite old backup first.
4290 nil)
4292 ;; The file was somehow created by someone else between
4293 ;; `delete-file' and `copy-file', so let's try again.
4294 ;; rms says "I think there is also a possible race
4295 ;; condition for making backup files" (emacs-devel 20070821).
4296 nil)))
4297 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4306 ;; The last ~[[:digit]]+ matches relative versions in git,
4307 ;; e.g. `foo.js.~HEAD~1~'.
4308 "Regular expression matching the backup/version part of a file name.
4312 "Return file NAME sans backup versions or strings.
4313 This is a separate procedure so your site-init or startup file can
4314 redefine it.
4315 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4316 we do not remove backup version numbers, only true file version numbers.
4317 See also `file-name-version-regexp'."
4324 name))))))
4327 "Return t if deleting FILE and rewriting it would preserve the owner.
4328 Return nil if FILE does not exist, or if deleting and recreating it
4329 might not preserve the owner. If GROUP is non-nil, check whether
4330 the group would be preserved too."
4335 ;; Return t if the file doesn't exist, since it's true that no
4336 ;; information would be lost by an (attempted) delete and create.
4339 ;; Files created on Windows by Administrator (RID=500)
4340 ;; have the Administrators group (RID=544) recorded as
4341 ;; their owner. Rewriting them will still preserve the
4342 ;; owner.
4346 ;; On BSD-derived systems files always inherit the parent
4347 ;; directory's group, so skip the group-gid test.
4353 ;; On some systems, a file created in a setuid directory
4354 ;; inherits that directory's owner.
4358 ;; On many systems, a file created in a setgid directory
4359 ;; inherits that directory's group. On some systems
4360 ;; this happens even if the setgid bit is not set.
4367 The extension, in a file name, is the part that begins with the last `.',
4368 except that a leading `.' of the file name, if there is one, doesn't count."
4371 directory)
4375 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4376 ;; we don't want to expand it.
4379 filename))))
4383 The extension, in a file name, is the part that begins with the last `.',
4384 excluding version numbers and backup suffixes, except that a leading `.'
4385 of the file name, if there is one, doesn't count.
4386 Return nil for extensionless file names such as `foo'.
4387 Return the empty string for file names such as `foo.'.
4389 By default, the returned value excludes the period that starts the
4390 extension, but if the optional argument PERIOD is non-nil, the period
4391 is included in the value, and in that case, if FILENAME has no
4402 "Return the base name of the FILENAME: no directory, no extension.
4403 FILENAME defaults to `buffer-file-name'."
4408 #'make-backup-file-name--default-function
4409 "A function that `make-backup-file-name' uses to create backup file names.
4410 The function receives a single argument, the original file name.
4412 If you change this, you may need to change `backup-file-name-p' and
4413 `file-name-sans-versions' too.
4415 You could make this buffer-local to do something special for specific files.
4417 For historical reasons, a value of nil means to use the default function.
4418 This should not be relied upon.
4420 See also `backup-directory-alist'."
4427 "Alist of filename patterns and backup directory names.
4428 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4429 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4430 relative or absolute. If it is absolute, so that all matching files
4431 are backed up into the same directory, the file names in this
4432 directory will be the full name of the file backed up with all
4433 directory separators changed to `!' to prevent clashes. This will not
4434 work correctly if your filesystem truncates the resulting name.
4436 For the common case of all backups going into one directory, the alist
4438 directory name.
4440 If this variable is nil, or it fails to match a filename, the backup
4441 is made in the original file's directory.
4443 On MS-DOS filesystems without long names this variable is always
4444 ignored."
4450 "Default `backup-enable-predicate' function.
4451 Checks for files in `temporary-file-directory',
4454 caseless)
4455 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4456 ;; their long file-name equivalents, so compare-strings does TRT.
4460 caseless t))
4463 ;; Directory is under temporary-file-directory.
4468 ;; Directory is under /tmp.
4473 0 nil
4475 ;; Directory is under small-temporary-file-directory.
4480 "Create the non-numeric backup file name for FILE.
4481 This calls the function that `make-backup-file-name-function' specifies,
4482 with a single argument FILE."
4485 file))
4488 "Default function for `make-backup-file-name'.
4489 Normally this just returns FILE's name with `~' appended.
4490 It searches for a match for FILE in `backup-directory-alist'.
4491 If the directory for the backup doesn't exist, it is created."
4503 "Subroutine of `make-backup-file-name--default-function'.
4504 The function `find-backup-file-name' also uses this."
4506 elt backup-directory abs-backup-directory)
4511 alist nil)))
4512 ;; If backup-directory is relative, it should be relative to the
4513 ;; file's directory. By expanding explicitly here, we avoid
4514 ;; depending on default-directory.
4523 abs-backup-directory nil))))
4525 file
4529 ;; Normalize DOSish file names: downcase the drive
4530 ;; letter, if any, and replace the leading "x:" with
4531 ;; "/drive_x".
4534 ;; Replace any invalid file-name characters (for the
4535 ;; case of backing up remote files).
4539 "drive_"
4542 ""
4545 ;; Make the name unique by substituting directory
4546 ;; separators. It may not really be worth bothering about
4547 ;; doubling `!'s in the original name...
4552 backup-directory))
4557 "Return non-nil if FILE is a backup file name (numeric or not).
4558 This is a separate function so you can redefine it for customization.
4559 You may need to redefine `file-name-sans-versions' as well."
4564 ;; This is used in various files.
4565 ;; The usage of backup-extract-version-start is not very clean,
4566 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4568 "Given the name of a numeric backup file, FN, return the backup number.
4569 Uses the free variable `backup-extract-version-start', whose value should be
4570 the index in the name where the version number begins."
4577 "Find a file name for a backup file FN, and suggestions for deletions.
4578 Value is a list whose car is the name for the backup file
4579 and whose cdr is a list of old versions to consider deleting now.
4580 If the value is nil, don't make a backup.
4581 Uses `backup-directory-alist' in the same way as
4582 `make-backup-file-name--default-function' does."
4584 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4588 ;; We don't support numbered backups on plain MS-DOS
4589 ;; when long file names are unavailable.
4599 possibilities deserve-versions-p versions)
4602 base-versions
4605 possibilities)
4606 #'<)
4611 kept-old-versions
4612 kept-new-versions
4619 ;; Delete nothing if there is overflow
4620 ;; in the number of versions to keep.
4626 v))))))))))
4629 "Return number of names file FILENAME has."
4632 ;; (defun file-relative-name (filename &optional directory)
4633 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4634 ;; This function returns a relative file name which is equivalent to FILENAME
4635 ;; when used with that default directory as the default.
4636 ;; If this is impossible (which can happen on MSDOS and Windows
4637 ;; when the file name and directory use different drive names)
4638 ;; then it returns FILENAME."
4639 ;; (save-match-data
4640 ;; (let ((fname (expand-file-name filename)))
4641 ;; (setq directory (file-name-as-directory
4642 ;; (expand-file-name (or directory default-directory))))
4643 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4644 ;; ;; drive names, they can't be relative, so return the absolute name.
4645 ;; (if (and (or (eq system-type 'ms-dos)
4646 ;; (eq system-type 'cygwin)
4647 ;; (eq system-type 'windows-nt))
4648 ;; (not (string-equal (substring fname 0 2)
4649 ;; (substring directory 0 2))))
4650 ;; filename
4651 ;; (let ((ancestor ".")
4652 ;; (fname-dir (file-name-as-directory fname)))
4653 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4654 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4655 ;; (setq directory (file-name-directory (substring directory 0 -1))
4656 ;; ancestor (if (equal ancestor ".")
4657 ;; ".."
4658 ;; (concat "../" ancestor))))
4659 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4660 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4661 ;; ;; We matched within FNAME's directory part.
4662 ;; ;; Add the rest of FNAME onto ANCESTOR.
4663 ;; (let ((rest (substring fname (match-end 0))))
4664 ;; (if (and (equal ancestor ".")
4665 ;; (not (equal rest "")))
4666 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4667 ;; rest
4668 ;; (concat (file-name-as-directory ancestor) rest)))
4669 ;; ;; We matched FNAME's directory equivalent.
4670 ;; ancestor))))))
4673 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4674 This function returns a relative file name which is equivalent to FILENAME
4675 when used with that default directory as the default.
4676 If FILENAME is a relative file name, it will be interpreted as existing in
4677 `default-directory'.
4678 If FILENAME and DIRECTORY lie on different machines or on different drives
4679 on a DOS/Windows machine, it returns FILENAME in expanded form."
4683 default-directory))))
4688 read-file-name-completion-ignore-case)))
4691 ;; Test for different filesystems on DOS/Windows
4693 ;; Should `cygwin' really be included here? --stef
4696 ;; Test for different drive letters
4698 ;; Test for UNCs on different servers
4703 ;; Windows file names cannot have ? in
4704 ;; them, so use that to detect when
4705 ;; neither FILENAME nor DIRECTORY is a
4706 ;; UNC.
4708 0 nil
4714 ;; Test for different remote file system identification
4716 filename
4724 ".."
4726 ;; Now ancestor is empty, or .., or ../.., etc.
4728 ;; We matched within FILENAME's directory part.
4729 ;; Add the rest of FILENAME onto ANCESTOR.
4732 ;; But don't bother with ANCESTOR if it would give us `./'.
4733 rest
4735 ;; We matched FILENAME's directory equivalent.
4736 ancestor))))))
4737 \f
4739 "Save current buffer in visited file if modified.
4740 Variations are described below.
4742 By default, makes the previous version into a backup file
4743 if previously requested or if this is the first save.
4745 to become a backup when the next save is done.
4747 makes the previous version into a backup file.
4749 to become a backup when the next save is done,
4750 and makes the previous version into a backup file.
4752 With a numeric prefix argument of 0, never make the previous version
4753 into a backup file.
4755 Note that the various variables that control backups, such
4756 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4757 and `backup-inhibited', to name just the more popular ones, still
4758 control whether a backup will actually be produced, even when you
4761 If a file's name is FOO, the names of its numbered backup versions are
4762 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4763 Numeric backups (rather than FOO~) will be made if value of
4764 `version-control' is not the atom `never' and either there are already
4765 numeric versions of the file being backed up, or `version-control' is
4766 non-nil.
4767 We don't want excessive versions piling up, so there are variables
4768 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4769 and `kept-new-versions', which tells how many newest versions to keep.
4770 Defaults are 2 old versions and 2 new.
4771 `dired-kept-versions' controls dired's clean-directory (.) command.
4772 If `delete-old-versions' is nil, system will query user
4773 before trimming versions. Otherwise it does it silently.
4775 If `vc-make-backup-files' is nil, which is the default,
4776 no backup files are made for files managed by version control.
4777 (This is because the version control system itself records previous versions.)
4779 See the subroutine `basic-save-buffer' for more information."
4785 ;; We used to display the message below only for files > 50KB, but
4786 ;; then Rmail-mbox never displays it due to buffer swapping. If
4787 ;; the test is ever re-introduced, be sure to handle saving of
4788 ;; Rmail files.
4798 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4799 Normally delete only if the file was written by this Emacs since
4800 the last real save, but optional arg FORCE non-nil means delete anyway."
4814 "Normal hook that is run before a buffer is saved to its file."
4820 "Normal hook that is run after a buffer is saved to its file."
4826 "If non-nil, use this coding system for saving the buffer.
4827 More precisely, use this coding system in place of the
4828 value of `buffer-file-coding-system', when saving the buffer.
4829 Calling `write-region' for any purpose other than saving the buffer
4830 will still use `buffer-file-coding-system'; this variable has no effect
4837 "Save the current buffer in its visited file, if it has been modified.
4838 The hooks `write-contents-functions' and `write-file-functions' get a chance
4839 to do the job of saving; if they do not, then the buffer is saved in
4840 the visited file in the usual way.
4841 Before and after saving the buffer, this function runs
4842 `before-save-hook' and `after-save-hook', respectively."
4845 ;; In an indirect buffer, save its base buffer instead.
4849 ;; handle the case when no modification has been made but
4850 ;; the file disappeared since visited
4854 setmodes)
4855 ;; If buffer has no file name, ask user for one.
4863 ;; Signal an error if the user specified the name of an
4864 ;; existing directory.
4867 "File `%s' exists; overwrite? "
4868 filename))
4875 "%s has changed since visited or saved. Save anyway? "
4895 ;; Support VC version backups.
4897 ;; Don't let errors prevent saving the buffer.
4902 ;; If a hook returned t, file is already "written".
4903 ;; Otherwise, write it the usual way now.
4913 ;; Now we have saved the current buffer. Let's make sure
4914 ;; that buffer-file-coding-system is fixed to what
4915 ;; actually used for saving by binding it locally.
4930 ;; If the auto-save file was recent before this command,
4931 ;; delete it now.
4933 ;; Support VC `implicit' locking.
4940 ;; This does the "real job" of writing a buffer into its visited file
4941 ;; and making a backup file. This is what is normally done
4942 ;; but inhibited if one of write-file-functions returns non-nil.
4943 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4944 ;; backup-buffer.
4954 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4955 ;; backup-buffer.
4968 "File %s is write-protected; try to save anyway? "
4970 buffer-file-name)))
4984 dir))))
4985 ;; Write temp name, then rename it.
4986 ;; This requires write access to the containing dir,
4987 ;; which is why we don't try it if we don't have that access.
4989 tempname succeed
4992 ;; Create temp files with strict access rights. It's easy to
4993 ;; loosen them later, whereas it's impossible to close the
4994 ;; time-window of loose permissions otherwise.
4999 ;; Try various temporary names.
5000 ;; This code follows the example of make-temp-file,
5001 ;; but it calls write-region in the appropriate way
5002 ;; for saving the buffer.
5008 ;; Pass in nil&nil rather than point-min&max
5009 ;; cause we're saving the whole buffer.
5010 ;; write-region-annotate-functions may use it.
5012 tempname nil realname
5015 nil)
5017 ;; The file was somehow created by someone else between
5018 ;; `make-temp-name' and `write-region', let's try again.
5019 nil)
5021 ;; Reset the umask.
5023 ;; If we failed, restore the buffer's modtime.
5026 ;; Since we have created an entirely new file,
5027 ;; make sure it gets the right permission bits set.
5032 buffer-file-name)))
5033 ;; We succeeded in writing the temp file,
5034 ;; so rename it.
5036 ;; If file not writable, see if we can make it writable
5037 ;; temporarily while we write it.
5038 ;; But no need to do so if we have just backed it up
5039 ;; (setmodes is set) because that says we're superseding.
5041 ;; Change the mode back, after writing.
5044 buffer-file-name))
5045 ;; If set-file-extended-attributes fails, fall back on
5046 ;; set-file-modes.
5056 ;; Pass in nil&nil rather than point-min&max to indicate
5057 ;; we're saving the buffer rather than just a region.
5058 ;; write-region-annotate-functions may make us of it.
5060 buffer-file-name nil t buffer-file-truename)
5063 ;; If we get an error writing the new file, and we made
5064 ;; the backup by renaming, undo the backing-up.
5069 setmodes))
5075 `((?\C-r
5082 ;; Return nil to ask about BUF again.
5083 nil)
5096 ;; Return nil to ask about BUF again.
5097 nil)
5107 "Save some modified file-visiting buffers. Asks user about each one.
5108 You can answer `y' to save, `n' not to save, `C-r' to look at the
5109 buffer in question with `view-buffer' before deciding or `d' to
5110 view the differences using `diff-buffer-with-file'.
5112 This command first saves any buffers where `buffer-save-without-query' is
5113 non-nil, without asking.
5115 Optional argument (the prefix) non-nil means save all with no questions.
5116 Optional second argument PRED determines which buffers are considered:
5117 If PRED is nil, all the file-visiting buffers are considered.
5118 If PRED is t, then certain non-file buffers will also be considered.
5119 If PRED is a zero-argument function, it indicates for each buffer whether
5120 to consider it or not when called with that buffer current.
5122 See `save-some-buffers-action-alist' if you want to
5123 change the additional actions you can take on files."
5127 files-done abbrevs-done)
5129 ;; First save any buffers that we're supposed to save unconditionally.
5130 ;; That way the following code won't ask about them.
5135 ;; Ask about those buffers that merit it,
5136 ;; and record the number thus saved.
5140 ;; Note that killing some buffers may kill others via
5141 ;; hooks (e.g. Rmail and its viewing buffer).
5154 t
5166 save-some-buffers-action-alist))
5167 ;; Maybe to save abbrevs, and record whether
5168 ;; we either saved them or asked to.
5175 ;; Don't keep bothering user if he says no.
5189 \f
5191 "Clear out records of last mod time of visited file.
5192 Next attempt to save will not complain of a discrepancy."
5196 "Mark current buffer as unmodified, not needing to be saved.
5199 It is not a good idea to use this function in Lisp programs, because it
5200 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5208 "Change whether this buffer is read-only."
5216 "Insert contents of file FILENAME into buffer after point.
5217 Set mark after the inserted text.
5219 This function is meant for the user to run interactively.
5220 Don't call it from programs! Use `insert-file-contents' instead.
5221 \(Its calling sequence is different; see its documentation)."
5227 "Append the contents of the region to the end of file FILENAME.
5228 When called from a function, expects three arguments,
5229 START, END and FILENAME. START and END are normally buffer positions
5230 specifying the part of the buffer to write.
5231 If START is nil, that means to use the entire buffer contents.
5232 If START is a string, then output that string to the file
5233 instead of any buffer contents; END is ignored.
5235 This does character code conversion and applies annotations
5236 like `write-region' does."
5242 "Return most recent backup file for FILENAME or nil if no backups exist."
5243 ;; `make-backup-file-name' will get us the right directory for
5244 ;; ordinary or numeric backups. It might create a directory for
5245 ;; backups as a side-effect, according to `backup-directory-alist'.
5252 tem)
5261 newest))
5264 "Rename current buffer to a similar name not already taken.
5265 This function is useful for creating multiple shell process buffers
5266 or multiple mail buffers, etc.
5268 Note that some commands, in particular those based on `compilation-mode'
5269 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5270 appropriate mode even if it has been renamed. So as well as renaming
5271 the buffer, you also need to switch buffers before running another
5272 instance of such commands."
5280 ;; If the existing buffer name has a <NNN>,
5281 ;; which isn't part of the file name (if any),
5282 ;; then get rid of that.
5288 "Create the directory DIR and optionally any nonexistent parent dirs.
5289 If DIR already exists as a directory, signal an error, unless
5290 PARENTS is non-nil.
5292 Interactively, the default choice of directory to create is the
5293 current buffer's default directory. That is useful when you have
5294 visited a file in a nonexistent directory.
5296 Noninteractively, the second (optional) argument PARENTS, if
5297 non-nil, says whether to create parent directories that don't
5298 exist. Interactively, this happens by default.
5300 If creating the directory or directories fail, an error will be
5301 raised."
5304 nil nil)
5305 t))
5306 ;; If default-directory is a remote directory,
5307 ;; make sure we find its make-directory handler.
5315 create-list)
5317 ;; If directory is its own parent, then we can't
5318 ;; keep looping forever
5333 "Delete the directory named DIRECTORY. Does not follow symlinks.
5334 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5335 TRASH non-nil means to trash the directory instead, provided
5336 `delete-by-moving-to-trash' is non-nil.
5338 When called interactively, TRASH is t if no prefix argument is
5339 given. With a prefix argument, TRASH is nil."
5346 "Move directory to trash: "
5348 default-directory default-directory nil nil))))
5354 nil)
5356 ;; If default-directory is a remote directory, make sure we find its
5357 ;; delete-directory handler.
5364 ;; Only move non-empty dir to trash if recursive deletion was
5365 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5366 ;; case, where the operation fails in delete-directory-internal.
5367 ;; As `move-file-to-trash' trashes directories (empty or
5368 ;; otherwise) as a unit, we do not need to recurse here.
5370 ;; Check if directory is empty apart from "." and "..".
5375 ;; Otherwise, call ourselves recursively if needed.
5379 ;; This test is equivalent to
5380 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5381 ;; but more efficient
5385 ;; We do not want to delete "." and "..".
5391 "Return non-nil if files FILE1 and FILE2 name the same file.
5392 If FILE1 or FILE2 does not exist, the return value is unspecified."
5403 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5405 Return nil if DIR is not an existing directory."
5417 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5432 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5433 This function always sets the file modes of the output files to match
5434 the corresponding input file.
5436 The third arg KEEP-TIME non-nil means give the output files the same
5437 last-modified time as the old ones. (This works on only some systems.)
5439 A prefix arg makes KEEP-TIME non-nil.
5441 Noninteractively, the last argument PARENTS says whether to
5442 create parent directories if they don't exist. Interactively,
5443 this happens by default.
5445 If NEWNAME names an existing directory, copy DIRECTORY as a
5446 subdirectory there. However, if called from Lisp with a non-nil
5447 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5448 directly into NEWNAME instead."
5455 default-directory default-directory nil nil)
5456 current-prefix-arg t nil)))
5459 directory newname))
5460 ;; If default-directory is a remote directory, make sure we find its
5461 ;; copy-directory handler.
5466 newname keep-time parents copy-contents)
5468 ;; Compute target name.
5473 ;; If NEWNAME is not an existing directory, create it;
5474 ;; that is where we will copy the files of DIRECTORY.
5476 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5477 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5482 newname))
5486 newname))
5489 ;; Copy recursively.
5491 ;; We do not want to copy "." and "..".
5493 directory-files-no-dot-files-regexp))
5503 ;; Set directory attributes.
5509 \f
5510 ;; At time of writing, only info uses this.
5512 "Return a copy of DIRS with all non-existent directories removed.
5513 The optional argument KEEP is a list of directories to retain even if
5514 they don't exist, and REJECT is a list of directories to remove from
5515 DIRS, even if they exist; REJECT takes precedence over KEEP.
5517 Note that membership in REJECT and KEEP is checked using simple string
5518 comparison."
5524 dirs)))
5526 \f
5529 "Function to use to revert this buffer.
5530 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5531 which are the arguments that `revert-buffer' received.
5532 It also has access to the `preserve-modes' argument of `revert-buffer'
5533 via the `revert-buffer-preserve-modes' dynamic variable.
5535 For historical reasons, a value of nil means to use the default function.
5540 #'revert-buffer-insert-file-contents--default-function
5541 "Function to use to insert contents when reverting this buffer.
5542 The function receives two arguments: the first the nominal file name to use;
5543 the second is t if reading the auto-save file.
5545 The function is responsible for updating (or preserving) point.
5547 For historical reasons, a value of nil means to use the default function.
5551 "Default function to use for `buffer-stale-function'.
5552 This function ignores its argument.
5553 This returns non-nil if the current buffer is visiting a readable file
5554 whose modification time does not match that of the buffer.
5556 This function only handles buffers that are visiting files.
5557 Non-file buffers need a custom function"
5564 "Function to check whether a buffer needs reverting.
5565 This should be a function with one optional argument NOCONFIRM.
5566 Auto Revert Mode passes t for NOCONFIRM. The function should return
5567 non-nil if the buffer should be reverted. A return value of
5568 `fast' means that the need for reverting was not checked, but
5569 that reverting the buffer is fast. The buffer is current when
5570 this function is called.
5572 The idea behind the NOCONFIRM argument is that it should be
5573 non-nil if the buffer is going to be reverted without asking the
5574 user. In such situations, one has to be careful with potentially
5575 time consuming operations.
5577 For historical reasons, a value of nil means to use the default function.
5578 This should not be relied upon.
5580 For more information on how this variable is used by Auto Revert mode,
5584 "Normal hook for `revert-buffer' to run before reverting.
5585 The function `revert-buffer--default' runs this.
5589 "Normal hook for `revert-buffer' to run after reverting.
5590 Note that the hook value that it runs is the value that was in effect
5591 before reverting; that makes a difference if you have buffer-local
5592 hook functions.
5594 The function `revert-buffer--default' runs this.
5602 ;; `revert-buffer-function' was defined long ago to be a function of only
5603 ;; 2 arguments, so we have to use a dynbind variable to pass the
5604 ;; `preserve-modes' argument of `revert-buffer'.
5608 "Replace current buffer text with the text of the visited file on disk.
5609 This undoes all changes since the file was visited or saved.
5610 With a prefix argument, offer to revert from latest auto-save file, if
5611 that is more recent than the visited file.
5613 This command also implements an interface for special buffers
5614 that contain text which doesn't come from a file, but reflects
5615 some other data instead (e.g. Dired buffers, `buffer-list'
5616 buffers). This is done via the variable `revert-buffer-function'.
5617 In these cases, it should reconstruct the buffer contents from the
5618 appropriate data.
5620 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5621 to revert from the auto-save file when this is nil. Note that the
5622 sense of this argument is the reverse of the prefix argument, for the
5623 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5624 to nil.
5626 Optional second argument NOCONFIRM means don't ask for confirmation
5627 at all. (The variable `revert-without-query' offers another way to
5628 revert buffers without querying for confirmation.)
5630 Optional third argument PRESERVE-MODES non-nil means don't alter
5631 the files modes. Normally we reinitialize them using `normal-mode'.
5633 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5635 This function calls the function that `revert-buffer-function' specifies
5636 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5637 The default function runs the hooks `before-revert-hook' and
5638 `after-revert-hook'."
5639 ;; I admit it's odd to reverse the sense of the prefix argument, but
5640 ;; there is a lot of code out there which assumes that the first
5641 ;; argument should be t to avoid consulting the auto-save file, and
5642 ;; there's no straightforward way to encourage authors to notice a
5643 ;; reversal of the argument sense. So I'm just changing the user
5644 ;; interface, but leaving the programmatic interface the same.
5649 ignore-auto noconfirm)))
5652 "Default function for `revert-buffer'.
5653 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5654 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5655 start and end.
5657 Calls `revert-buffer-insert-file-contents-function' to reread the
5658 contents of the visited file, with two arguments: the first is the file
5659 name, the second is non-nil if reading an auto-save file.
5661 This function only handles buffers that are visiting files.
5662 Non-file buffers need a custom function."
5667 buffer-auto-save-file-name
5672 buffer-auto-save-file-name
5673 buffer-file-name)))
5683 file-name)))
5685 ;; If file was backed up but has changed since,
5686 ;; we should make another backup.
5690 ;; Effectively copy the after-revert-hook status,
5691 ;; since after-find-file will clobber it.
5694 after-revert-hook))
5696 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5700 file-name auto-save-p)
5701 ;; Recompute the truename in case changes in symlinks
5702 ;; have changed the truename.
5706 ;; Run after-revert-hook as it was before we reverted.
5710 local-hook)
5713 t)))))
5716 "Default function for `revert-buffer-insert-file-contents-function'.
5717 The function `revert-buffer--default' calls this.
5718 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5719 an auto-save file."
5723 "File %s no longer exists!"
5725 file-name))
5728 "File %s no longer readable!"
5730 file-name))
5732 ;; Bind buffer-file-name to nil
5733 ;; so that we don't try to lock the file.
5739 ;; Auto-saved file should be read by Emacs's
5740 ;; internal coding.
5744 buffer-file-coding-system-explicit
5747 coding-system-for-read
5749 coding-system-for-read)
5751 ;; As a coding system suitable for multibyte
5752 ;; buffer is specified, make the current
5753 ;; buffer multibyte.
5756 ;; This force after-insert-file-set-coding
5757 ;; (called from insert-file-contents) to set
5758 ;; buffer-file-coding-system to a proper value.
5761 ;; Note that this preserves point in an intelligent way.
5765 nil nil t))
5767 nil nil t))))))
5770 "Recover the visited file--get contents from its last auto-save file."
5775 "Visit file FILE, but get contents from its last auto-save file."
5776 ;; Actually putting the file name in the minibuffer should be used
5777 ;; only rarely.
5778 ;; Not just because users often use the default.
5791 "*Directory*" nil
5802 ;; Use insert-directory-safely, not insert-directory,
5803 ;; because these files might not exist. In particular,
5804 ;; FILE might not exist if the auto-save file was for
5805 ;; a buffer that didn't visit a file, such as "*mail*".
5806 ;; The code in v20.x called `ls' directly, so we need
5807 ;; to emulate what `ls' did in that case.
5812 ;; Keep the current buffer-file-coding-system.
5814 ;; Auto-saved file should be read with special coding.
5823 "Recover auto save files from a previous Emacs session.
5824 This command first displays a Dired buffer showing you the
5825 previous sessions that you could recover from.
5826 To choose one, move point to the proper line and then type C-c C-c.
5827 Then you'll be asked about a number of files to recover."
5837 directory-files-no-dot-files-regexp
5839 t)
5850 ;; Each line starts with a space
5851 ;; so that Font Lock mode won't highlight the first character.
5854 " To delete a session file, type \
5860 "Choose one saved session to recover auto-save files from.
5861 This command is used in the special Dired buffer created by
5864 ;; Get the name of the session file to recover from.
5866 files
5872 ;; Read in the auto-save-list file.
5875 ;; Loop thru the text of that file
5876 ;; and get out the names of the files to recover.
5880 ;; This is a pair of lines for a non-file-visiting buffer.
5881 ;; Get the auto-save file name and manufacture
5882 ;; a "visited file name" from that.
5885 ;; If there is no auto-save file name, the
5886 ;; auto-save-list file is probably corrupted.
5899 ;; This pair of lines is a file-visiting
5900 ;; buffer. Use the visited file name.
5910 ;; Ignore a file if its auto-save file does not exist now.
5914 ;; The file contains a pair of line for each auto-saved buffer.
5915 ;; The first line of the pair contains the visited file name
5916 ;; or is empty if the buffer was not visiting a file.
5917 ;; The second line is the auto-save file name.
5925 files
5931 "Kill BUFFER if confirmed."
5939 "Kill some buffers. Asks the user whether to kill each one of them.
5940 Non-interactively, if optional argument LIST is non-nil, it
5941 specifies the list of buffers to kill, asking for approval for each one."
5949 ; if we killed the base buffer.
5956 "Kill buffers whose name matches the specified REGEXP.
5957 The optional second argument indicates whether to kill internal buffers too."
5966 \f
5968 "Adjust current buffer's auto save file name for current conditions.
5969 Also rename any existing auto save file, if it was made in this session."
5981 "Return file name to use for auto-saves of current buffer.
5982 Does not consider `auto-save-visited-file-name' as that variable is checked
5983 before calling this function. You can redefine this for customization.
5984 See also `auto-save-file-name-p'."
5992 result uniq)
5993 ;; Apply user-specified translations
5994 ;; to the file name.
5998 filename)
6008 filename))))
6013 ;; We truncate the file name to DOS 8+3 limits
6014 ;; before doing anything else, because the regexp
6015 ;; passed to string-match below cannot handle
6016 ;; extensions longer than 3 characters, multiple
6017 ;; dots, and other atrocities.
6022 fn)
6027 "#"
6030 ;; Make sure auto-save file names don't contain characters
6031 ;; invalid for the underlying filesystem.
6033 ;; Don't modify remote (ange-ftp) filenames
6036 result))))
6038 ;; Deal with buffers that don't have any associated files. (Mail
6039 ;; mode tends to create a good number of these.)
6043 file-name)
6044 ;; Restrict the characters used in the file name to those which
6045 ;; are known to be safe on all filesystems, url-encoding the
6046 ;; rest.
6047 ;; We do this on all platforms, because even if we are not
6048 ;; running on DOS/Windows, the current directory may be on a
6049 ;; mounted VFAT filesystem, such as a USB memory stick.
6053 ;; For multibyte characters, this will produce more than
6054 ;; 2 hex digits, so is not true URL encoding.
6058 ;; Generate the file name.
6064 ;; Try a few alternative directories, to get one we can
6065 ;; write it.
6071 ;; Don't modify remote (ange-ftp) filenames
6073 ;; The call to convert-standard-filename is in case
6074 ;; buffer-name includes characters not allowed by the
6075 ;; DOS/Windows filesystems. make-temp-file writes to the
6076 ;; file it creates, so we must fix the file name _before_
6077 ;; make-temp-file is called.
6079 fname))
6081 ;; make-temp-file creates the file,
6082 ;; but we don't want it to exist until we do an auto-save.
6086 file-name)))
6089 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6090 FILENAME should lack slashes. You can redefine this for customization."
6092 \f
6094 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6095 The generated regexp will match a filename only if the filename
6096 matches that wildcard according to shell rules. Only wildcards known
6097 by `sh' are supported."
6099 ;; Copy the initial run of non-special characters.
6102 ;; If no special characters, we're almost done.
6106 j)
6108 result
6129 ;; Found "[^". Insert a `\0' character
6130 ;; (which cannot happen in a filename)
6131 ;; into the character class, so that `^'
6132 ;; is not the first character after `[',
6133 ;; and thus non-special in a regexp.
6138 ;; I don't think `]' can appear in a
6139 ;; character class in a wildcard, but
6140 ;; let's be general here.
6147 i
6160 ;; Shell wildcards should match the entire filename,
6161 ;; not its part. Make the regexp say so.
6163 \f
6166 "Switches for `list-directory' to pass to `ls' for brief listing."
6172 "Switches for `list-directory' to pass to `ls' for verbose listing."
6177 "Expand wildcard pattern PATTERN.
6178 This returns a list of file names which match the pattern.
6179 Files are sorted in `string<' order.
6181 If PATTERN is written as an absolute file name,
6182 the values are absolute also.
6184 If PATTERN is written as a relative file name, it is interpreted
6185 relative to the current default directory, `default-directory'.
6186 The file names returned are normally also relative to the current
6187 default directory. However, if FULL is non-nil, they are absolute."
6191 ;; A list of all dirs that DIRPART specifies.
6192 ;; This can be more than one dir
6193 ;; if DIRPART contains wildcards.
6197 dirpart)))
6201 contents)
6206 ;; Filter out "." and ".."
6211 name))
6218 this-dir-contents)
6219 this-dir-contents)
6220 contents)))))
6221 contents)))
6223 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6227 "Display a list of files in or matching DIRNAME, a la `ls'.
6228 DIRNAME is globbed by the shell if necessary.
6229 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6230 Actions controlled by variables `list-directory-brief-switches'
6231 and `list-directory-verbose-switches'."
6235 nil default-directory nil)
6236 pfx)))
6238 list-directory-brief-switches))
6239 buffer)
6251 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6259 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6261 PATTERN is assumed to represent a file-name wildcard suitable for the
6262 underlying filesystem. For Unix and GNU/Linux, each character from the
6264 the parts of the pattern which don't include wildcard characters are
6265 quoted with double quotes.
6268 on Windows), so PATTERN can use them to quote wildcard characters that
6269 need to be passed verbatim to shell commands."
6273 ;; DOS/Windows don't allow `"' in file names. So if the
6274 ;; argument has quotes, we can safely assume it is already
6275 ;; quoted by the caller.
6277 ;; We quote [&()#$`'] in case their shell is a port of a
6278 ;; Unixy shell. We quote [,=+] because stock DOS and
6279 ;; Windows shells require that in some cases, such as
6280 ;; passing arguments to batch files that use positional
6281 ;; arguments like %1.
6283 pattern
6286 end)
6303 pattern))))
6310 "Program to get the amount of free space on a file system.
6311 We assume the output has the format of `df'.
6312 The value of this variable must be just a command name or file name;
6313 if you want to specify options, use `directory-free-space-args'.
6315 A value of nil disables this feature.
6317 If the function `file-system-info' is defined, it is always used in
6318 preference to the program given by this variable."
6324 "Options to use when running `directory-free-space-program'."
6329 "Return the amount of free space on directory DIR's file system.
6330 The return value is a string describing the amount of free
6331 space (normally, the number of free 1KB blocks).
6333 This function calls `file-system-info' if it is available, or
6334 invokes the program specified by `directory-free-space-program'
6335 and `directory-free-space-args'. If the system call or program
6336 is unsuccessful, or if DIR is a remote directory, this function
6337 returns nil."
6339 ;; Try to find the number of free blocks. Non-Posix systems don't
6340 ;; always have df, but might have an equivalent system call.
6349 ;; Avoid failure if the default directory does
6350 ;; not exist (Bug#2631, Bug#3911).
6354 nil t nil
6355 directory-free-space-args
6358 ;; Assume that the "available" column is before the
6359 ;; "capacity" column. Find the "%" and scan backward.
6363 "[[:space:]]+[^[:space:]]+%[^%]*$"
6370 ;; The following expression replaces `dired-move-to-filename-regexp'.
6374 ;; In some locales, month abbreviations are as short as 2 letters,
6375 ;; and they can be followed by ".".
6376 ;; In Breton, a month name can include a quote character.
6389 s "+"
6392 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6393 ;; omits the Kanji characters after month and day-of-month.
6394 ;; On Mac OS X 10.3, the date format in East Asian locales is
6395 ;; day-of-month digits followed by month digits.
6401 ;; The "[0-9]" below requires the previous column to end in a digit.
6402 ;; This avoids recognizing `1 may 1997' as a date in the line:
6403 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6405 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6407 ;; For non-iso date formats, we add the ".*" in order to find
6408 ;; the last possible match. This avoids recognizing
6409 ;; `jservice 10 1024' as a date in the line:
6410 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6412 ;; vc dired listings provide the state or blanks between file
6413 ;; permissions and date. The state is always surrounded by
6414 ;; parentheses:
6415 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6416 ;; This is not supported yet.
6421 "Regular expression to match up to the file name in a directory listing.
6422 The default value is designed to recognize dates and times
6427 ;; insert-directory
6428 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6429 ;; FULL-DIRECTORY-P is nil.
6430 ;; The single line of output must display FILE's name as it was
6431 ;; given, namely, an absolute path name.
6432 ;; - must insert exactly one line for each file if WILDCARD or
6433 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6434 ;; before the file lines, plus optional text after the file lines.
6435 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6436 ;; allowed.
6437 ;; File lines should display the basename.
6438 ;; - must be consistent with
6439 ;; - functions dired-move-to-filename, (these two define what a file line is)
6440 ;; dired-move-to-end-of-filename,
6441 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6442 ;; dired-insert-headerline
6443 ;; dired-after-subdir-garbage (defines what a "total" line is)
6444 ;; - variable dired-subdir-regexp
6445 ;; - may be passed "--dired" as the first argument in SWITCHES.
6446 ;; Filename handlers might have to remove this switch if their
6447 ;; "ls" command does not support it.
6449 "Insert directory listing for FILE, formatted according to SWITCHES.
6450 Leaves point after the inserted text.
6451 SWITCHES may be a string of options, or a list of strings
6452 representing individual options.
6453 Optional third arg WILDCARD means treat FILE as shell wildcard.
6454 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6455 switches do not contain `d', so that a full listing is expected.
6457 This works by running a directory listing program
6458 whose name is in the variable `insert-directory-program'.
6459 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6461 When SWITCHES contains the long `--dired' option, this function
6462 treats it specially, for the sake of dired. However, the
6463 normally equivalent short `-D' option is just passed on to
6464 `insert-directory-program', as any other option."
6465 ;; We need the directory in order to find the right handler.
6470 wildcard full-directory-p)
6473 ;; Read the actual directory using `insert-directory-program'.
6474 ;; RESULT gets the status code.
6476 ;; putting text property `dired-filename, decode one
6477 ;; bunch by one to preserve that property.
6479 ;; This is to control encoding the arguments in call-process.
6483 default-file-name-coding-system))))
6486 ;; Run ls in the directory part of the file pattern
6487 ;; using the last component as argument.
6493 ;; NB since switches is passed to the shell, be
6494 ;; careful of malicious values, eg "-l;reboot".
6495 ;; See eg dired-safe-switches-p.
6497 shell-file-name nil t nil
6498 "-c"
6500 ""
6502 insert-directory-program
6503 " -d "
6505 switches
6507 " -- "
6508 ;; Quote some characters that have
6509 ;; special meanings in shells; but
6510 ;; don't quote the wildcards--we want
6511 ;; them to be special. We also
6512 ;; currently don't quote the quoting
6513 ;; characters in case people want to
6514 ;; use them explicitly to quote
6515 ;; wildcard characters.
6517 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6518 ;; directory if FILE is a symbolic link.
6526 insert-directory-program nil t nil
6530 ;; Split the switches at any spaces so we can
6531 ;; pass separate options as separate args.
6533 ;; Avoid lossage if FILE starts with `-'.
6541 file))))))))
6543 ;; If we got "//DIRED//" in the output, it means we got a real
6544 ;; directory listing, even if `ls' returned nonzero.
6545 ;; So ignore any errors.
6558 ;; The first time ls returns an error,
6559 ;; find the version numbers of ls,
6560 ;; and set insert-directory-ls-version
6561 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6562 ;; is equal or if the info cannot be obtained.
6563 ;; (That can mean it isn't GNU ls.)
6573 comparison)
6589 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6593 ;; If `insert-directory-program' failed, signal an error.
6595 ;; Delete the error message it may have output.
6597 ;; On non-Posix systems, we cannot open a directory, so
6598 ;; don't even try, because that will always result in
6599 ;; the ubiquitous "Access denied". Instead, show the
6600 ;; command line so the user can try to guess what went wrong.
6605 insert-directory-program
6607 file result)
6608 ;; Unix. Access the file to get a suitable error.
6615 ;; The following overshoots by one line for an empty
6616 ;; directory listed with "--dired", but without "-a"
6617 ;; switch, where the ls output contains a
6618 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6619 ;; We take care of that case later.
6627 error-lines)
6628 ;; Find all the lines that are error messages,
6629 ;; and record the bounds of each one.
6636 ;; Now read the numeric positions of file names.
6643 error-lines))
6646 error-lines)))
6648 ;; End is followed by \n or by " -> ".
6650 ;; It seems that we can't trust ls's output as to
6651 ;; byte positions of filenames.
6657 ;; Take care of the case where the ls output contains a
6658 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6659 ;; and we went one line too far back (see above).
6664 ;; Now decode what read if necessary.
6666 file-name-coding-system
6667 default-file-name-coding-system
6669 coding-no-eol
6670 val pos)
6674 ;; If no coding system is specified or detection is
6675 ;; requested, detect the coding.
6689 ;; Force no eol conversion on a file name, so
6690 ;; that CR is preserved.
6698 ;; Try to insert the amount of free space.
6701 ;; First find the line to put it on.
6705 ;; Replace "total" with "used", to avoid confusion.
6711 "Convert `ls --dired' file name position value POS to a buffer position.
6712 File name position values returned in ls --dired output
6713 count only stdout; they don't count the error messages sent to stderr.
6714 So this function converts to them to real buffer positions.
6715 ERROR-LINES is a list of buffer positions of error message lines,
6716 of the form (START END)."
6720 pos)
6724 "Insert directory listing for FILE, formatted according to SWITCHES.
6726 Like `insert-directory', but if FILE does not exist, it inserts a
6727 message to that effect instead of signaling an error."
6730 ;; Simulate the message printed by `ls'.
6734 "Functions to call with no arguments to query about killing Emacs.
6735 If any of these functions returns nil, killing Emacs is canceled.
6736 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6737 the low level primitive, does not. See also `kill-emacs-hook'."
6743 "How to ask for confirmation when leaving Emacs.
6744 If nil, the default, don't ask at all. If the value is non-nil, it should
6745 be a predicate function; for example `yes-or-no-p'."
6754 "Offer to save each buffer, then kill this Emacs process.
6755 With prefix ARG, silently save all file-visiting buffers without asking.
6756 If there are active processes where `process-query-on-exit-flag'
6757 returns non-nil, asks whether processes should be killed.
6758 Runs the members of `kill-emacs-query-functions' in turn and stops
6759 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6771 ;; process-list is not defined on MSDOS.
6773 active)
6791 ;; Query the user for other things, perhaps.
6798 "Offer to save each buffer, then kill the current connection.
6799 If the current frame has no client, kill Emacs itself using
6800 `save-buffers-kill-emacs'.
6802 With prefix ARG, silently save all file-visiting buffers, then kill.
6804 If emacsclient was started with a list of filenames to edit, then
6805 only these files will be asked to be saved."
6810 \f
6811 ;; We use /: as a prefix to "quote" a file name
6812 ;; so that magic file name handlers will not apply to it.
6816 file-name-handler-alist))
6818 ;; We depend on being the last handler on the list,
6819 ;; so that anything else which does need handling
6820 ;; has been handled already.
6821 ;; So it is safe for us to inhibit *all* magic file name handlers.
6830 default-directory))
6831 ;; Get a list of the indices of the args which are file names.
6834 ;; The first six are special because they
6835 ;; return a file name. We want to include the /:
6836 ;; in the return value.
6837 ;; So just avoid stripping it in the first place.
6844 ;; `identity' means just return the first arg
6845 ;; not stripped of its quoting.
6847 ;; `add' means add "/:" to the result.
6850 ;; `unquote-then-quote' means set buffer-file-name
6851 ;; temporarily to unquoted filename.
6853 ;; List the arguments which are filenames.
6861 ;; For all other operations, treat the first argument only
6862 ;; as the file name.
6864 method
6865 ;; Copy ARGUMENTS so we can replace elements in it.
6869 ;; Strip off the /: from the file names that have it.
6877 "/"
6883 (`insert-file-contents
6889 (`unquote-then-quote
6894 \f
6895 ;; Symbolic modes and read-file-modes.
6898 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6899 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6900 Others, or All) for whom to produce the mask.
6901 The bit-mask that is returned extracts from mode bits the access rights
6902 for the specified category of users."
6910 "Convert CHAR to a numeric value of mode bits.
6911 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6912 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6919 ;; Rights relative to the previous file modes.
6930 "Convert a symbolic mode string specification to an equivalent number.
6932 WHO-MASK is the bit-mask specifying the category of users to which to
6933 apply the access permissions. See `file-modes-char-to-who'.
6934 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6935 RIGHTS request to add, remove, or set permissions based on existing ones,
6942 char-right)
6949 num-rights
6953 op char-right)))
6954 num-rights))
6957 "Convert symbolic file modes to numeric file modes.
6958 MODES is the string to convert, it should match
6960 See Info node `(coreutils)File permissions' for more information on this
6961 notation.
6962 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6963 MODES request to add, remove, or set permissions based on existing ones,
6977 num-who num-modes)
6980 num-modes)))
6983 "Read file modes in octal or symbolic notation and return its numeric value.
6985 ORIG-FILE is the name of a file on whose mode bits to base returned
6986 permissions if what user types requests to add, remove, or set permissions
7002 nil nil default)))
7011 ;; Trashcan handling.
7013 "Directory for `move-file-to-trash' to move files and directories to.
7014 This directory is only used when the function `system-move-file-to-trash'
7015 is not defined.
7016 Relative paths are interpreted relative to `default-directory'.
7017 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7027 "Move the file (or directory) named FILENAME to the trash.
7028 When `delete-by-moving-to-trash' is non-nil, this function is
7029 called by `delete-file' and `delete-directory' instead of
7030 deleting files outright.
7032 If the function `system-move-file-to-trash' is defined, call it
7033 with FILENAME as an argument.
7034 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7035 directory.
7036 Otherwise, trash FILENAME using the freedesktop.org conventions,
7037 like the GNOME, KDE and XFCE desktop environments. Emacs only
7041 ;; If `trash-directory' is non-nil, move the file there.
7045 trash-dir)))
7046 ;; We can't trash a parent directory of trash-directory.
7049 trash-dir filename))
7052 ;; Ensure that the trashed file-name is unique.
7059 ;; If `system-move-file-to-trash' is defined, use it.
7062 ;; Otherwise, use the freedesktop.org method, as specified at
7063 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7074 ;; Check if we have permissions to delete.
7078 ;; The trashed file cannot be the trash dir or its parent.
7081 trash-files-dir filename))
7084 trash-info-dir filename))
7086 ;; Ensure that the trash directory exists; otherwise, create it.
7093 ;; Try to move to trash with .trashinfo undo information
7098 ;; Perform url-encoding on FN. For compatibility with
7099 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7100 ;; for path separators.
7105 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7106 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7119 fn))
7124 ;; Attempt to make .trashinfo file, trying up to 5
7125 ;; times. The .trashinfo file is opened with O_EXCL,
7126 ;; as per trash-spec 0.7, even if that can be a problem
7127 ;; on old NFS versions...
7131 trash-files-dir))
7133 success info-fn)
7138 trash-info-dir))
7146 ;; Uniquify new-fn. (Some file managers do not
7147 ;; like Emacs-style backup file names---e.g. bug
7148 ;; 170956 in Konqueror bug tracker.)
7153 ;; Finally, try to move the file to the trashcan.
7158 "The type field in ATTRIBUTES returned by `file-attributes'.
7159 The value is either t for directory, string (name linked to) for
7160 symbolic link, or nil."
7164 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7168 "The UID field in ATTRIBUTES returned by `file-attributes'.
7169 This is either a string or a number. If a string value cannot be
7170 looked up, a numeric value, either an integer or a float, is
7171 returned."
7175 "The GID 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 last access time in ATTRIBUTES returned by `file-attributes'.
7183 This a list of integers (HIGH LOW USEC PSEC) in the same style
7184 as (current-time)."
7188 "The modification time in ATTRIBUTES returned by `file-attributes'.
7189 This is the time of the last change to the file's contents, and
7190 is a list of integers (HIGH LOW USEC PSEC) in the same style
7191 as (current-time)."
7195 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7196 This is the time of last change to the file's attributes: owner
7197 and group, access mode bits, etc, and is a list of integers (HIGH
7198 LOW USEC PSEC) in the same style as (current-time)."
7202 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7203 This is a floating point number if the size is too large for an integer."
7207 "The file modes in ATTRIBUTES returned by `file-attributes'.
7208 This is a string of ten letters or dashes as in ls -l."
7212 "The inode number in ATTRIBUTES returned by `file-attributes'.
7213 If it is larger than what an Emacs integer can hold, this is of
7214 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7215 If even HIGH is too large for an Emacs integer, this is instead
7216 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7217 middle 24 bits, and finally the low 16 bits."
7221 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7222 If it is larger than what an Emacs integer can hold, this is of
7223 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7224 If even HIGH is too large for an Emacs integer, this is instead
7225 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7226 middle 24 bits, and finally the low 16 bits."
7229 \f
7254 ;;; files.el ends here