| blob | 0978fa254f6cac88ff39706d59cc028fcf0301ec |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2017 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:
38 "Backups of edited data files."
42 "Finding files."
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 a match for FROM with TO when a directory name matches FROM. This
59 replacement is done when setting up the default directory of a
60 newly visited file buffer.
62 FROM is a regexp that is matched against directory names anchored at
66 FROM and TO should be equivalent names, which refer to the
67 same directory. TO should be an absolute directory name.
68 Do not use `~' in the TO strings.
70 Use this feature when you have directories which you normally refer to
71 via absolute symbolic links. Make TO the name of the link, and FROM
72 a regexp matching the name it is linked to."
81 "Non-nil means make a backup of a file the first time it is saved.
82 This can be done by renaming the file or by copying.
84 Renaming means that Emacs renames the existing file so that it is a
85 backup file, then writes the buffer into a new file. Any other names
86 that the old file had will now refer to the backup file. The new file
87 is owned by you and its group is defaulted.
89 Copying means that Emacs copies the existing file into the backup
90 file, then writes the buffer on top of the existing file. Any other
91 names that the old file had will now refer to the new (edited) file.
92 The file's owner and group are unchanged.
94 The choice of renaming or copying is controlled by the variables
95 `backup-by-copying', `backup-by-copying-when-linked',
96 `backup-by-copying-when-mismatch' and
97 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
101 ;; Do this so that local variables based on the file name
102 ;; are not overridden by the major mode.
104 "If non-nil, backups will be inhibited.
105 This variable is intended for use by making it local to a buffer,
110 "Non-nil means always use copying to create backup files.
111 See documentation of variable `make-backup-files'."
116 "Non-nil means use copying to create backups for files with multiple names.
117 This causes the alternate names to refer to the latest version as edited.
118 This variable is relevant only if `backup-by-copying' is nil."
123 "Non-nil means create backups by copying if this preserves owner or group.
124 Renaming may still be used (subject to control of other variables)
125 when it would not result in changing the owner or group of the file;
126 that is, for files which are owned by you and whose group matches
127 the default for a new file created there by you.
128 This variable is relevant only if `backup-by-copying' is nil."
135 "Non-nil means create backups by copying to preserve a privileged owner.
136 Renaming may still be used (subject to control of other variables)
137 when it would not result in changing the owner of the file or if the owner
138 has a user id greater than the value of this variable. This is useful
139 when low-numbered uid's are used for special system users (such as root)
140 that must maintain ownership of certain files.
141 This variable is relevant only if `backup-by-copying' and
142 `backup-by-copying-when-mismatch' are nil."
147 "Predicate that looks at a file name and decides whether to make backups.
151 "Non-nil in a buffer means always offer to save buffer on exit.
152 Do so even if the buffer is not visiting a file.
153 Automatically local in all buffers."
160 "Non-nil means find a file under alternative names, in existing buffers.
161 This means if any existing buffer is visiting the file you want
162 under another name, you get the existing buffer instead of a new buffer."
167 "Non-nil means visiting a file uses its truename as the visited-file name.
168 That is, the buffer visiting the file has the truename as the
169 value of `buffer-file-name'. The truename of a file is found by
170 chasing all links both at the file level and at the levels of the
171 containing directories."
177 "Specify which files should be reverted without query.
178 The value is a list of regular expressions.
179 If the file name matches one of these regular expressions,
180 then `revert-buffer' reverts the file without querying
181 if the file has changed on disk and you have not edited the buffer."
186 "The device number and file number of the file visited in the current buffer.
187 The value is a list of the form (FILENUM DEVNUM).
188 This pair of numbers uniquely identifies the file.
202 "The directory for writing small temporary files.
203 If non-nil, this directory is used instead of `temporary-file-directory'
204 by programs that create small temporary files. This is for systems that
205 have fast storage with limited space, such as a RAM disk."
210 ;; The system null device. (Should reference NULL_DEVICE from C.)
237 "Non-nil means protect against I/O errors while saving files.
238 Some modes set this non-nil in particular buffers.
240 This feature works by writing the new contents into a temporary file
241 and then renaming the temporary file to replace the original.
242 In this way, any I/O error in writing leaves the original untouched,
243 and there is never any instant where the file is nonexistent.
245 Note that this feature forces backups to be made by copying.
246 Yet, at the same time, saving a precious file
247 breaks any hard links between it and other files.
249 This feature is advisory: for example, if the directory in which the
250 file is being saved is not writable, Emacs may ignore a non-nil value
251 of `file-precious-flag' and write directly into the file.
253 See also: `break-hardlink-on-save'."
258 "Whether to allow breaking hardlinks when saving files.
259 If non-nil, then when saving a file that exists under several
260 names \(i.e., has multiple hardlinks), break the hardlink
261 associated with `buffer-file-name' and write to a new file, so
262 that the other instances of the file are not affected by the
263 save.
265 If `buffer-file-name' refers to a symlink, do not break the symlink.
267 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
268 For example, if the directory in which a file is being saved is not
269 itself writable, then error instead of saving in some
270 hardlink-nonbreaking way.
272 See also `backup-by-copying' and `backup-by-copying-when-linked'."
278 "Control use of version numbers for backup files.
279 When t, make numeric backup versions unconditionally.
280 When nil, make them for files that have some already.
281 The value `never' means do not make them."
288 "Return whether X is safe as local value for `version-control'."
295 "When cleaning directory, number of versions to keep."
301 "If t, delete excess backup versions silently.
302 If nil, ask confirmation. Any other value prevents any trimming."
309 "Number of oldest versions to keep when a new numbered backup is made."
315 "Number of newest versions to keep when a new numbered backup is made.
316 Includes the new backup. Must be > 0"
322 "Whether to add a newline automatically at the end of the file.
324 A value of t means do this only when the file is about to be saved.
325 A value of `visit' means do this right after the file is visited.
326 A value of `visit-save' means do it at both of those times.
327 Any other non-nil value means ask user whether to add a newline, when saving.
328 A value of nil means don't add newlines.
330 Certain major modes set this locally to the value obtained
331 from `mode-require-final-newline'."
341 "Whether to add a newline at end of file, in certain major modes.
342 Those modes set `require-final-newline' to this value when you enable them.
343 They do so because they are often used for files that are supposed
344 to end in newlines, and the question is how to arrange that.
346 A value of t means do this only when the file is about to be saved.
347 A value of `visit' means do this right after the file is visited.
348 A value of `visit-save' means do it at both of those times.
349 Any other non-nil value means ask user whether to add a newline, when saving.
351 A value of nil means do not add newlines. That is a risky choice in this
352 variable since this value is used for modes for files that ought to have
353 final newlines. So if you set this to nil, you must explicitly check and
354 add a final newline, whenever you save a file that really needs one."
364 "Non-nil says by default do auto-saving of every file-visiting buffer."
370 ;; Don't put "\\2" inside expand-file-name, since it will be
371 ;; transformed to "/2" on DOS/Windows.
373 "Transforms to apply to buffer file name before making auto-save file name.
374 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
375 REGEXP is a regular expression to match against the file name.
376 If it matches, `replace-match' is used to replace the
377 matching part with REPLACEMENT.
378 If the optional element UNIQUIFY is non-nil, the auto-save file name is
379 constructed by taking the directory part of the replaced file-name,
380 concatenated with the buffer file name with all directory separators
381 changed to `!' to prevent clashes. This will not work
382 correctly if your filesystem truncates the resulting name.
384 All the transforms in the list are tried, in the order they are listed.
385 When one transform applies, its result is final;
386 no further transforms are tried.
388 The default value is set up to put the auto-save file into the
389 temporary directory (see the variable `temporary-file-directory') for
390 editing a remote file.
392 On MS-DOS filesystems without long names this variable is always
393 ignored."
403 "Interval in seconds for `auto-save-visited-mode'.
404 If `auto-save-visited-mode' is enabled, Emacs will save all
405 buffers visiting a file to the visited file after it has been
406 idle for `auto-save-visited-interval' seconds."
416 "Toggle automatic saving to file-visiting buffers on or off.
417 With a prefix argument ARG, enable regular saving of all buffers
418 visiting a file if ARG is positive, and disable it otherwise.
419 Unlike `auto-save-mode', this mode will auto-save buffer contents
420 to the visited files directly and will also run all save-related
421 hooks. See Info node `Saving' for details of the save process.
423 If called from Lisp, enable the mode if ARG is omitted or nil,
424 and toggle it if ARG is `toggle'."
426 :global t
431 auto-save-visited-interval :repeat
435 auto-save-visited-file-name)))))))
441 "Non-nil means save word abbrevs too when files are saved.
442 If `silently', don't ask the user before saving."
447 "Non-nil means allow `find-file' to visit directories.
448 To visit the directory, `find-file' runs `find-directory-functions'."
453 "List of functions to try in sequence to visit a directory.
454 Each function is called with the directory name as the sole argument
455 and should return either a buffer or nil."
459 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
461 "List of functions to try in sequence to get a file name at point.
462 Each function should return either nil or a file name found at the
463 location of point in the current buffer."
467 ;;;It is not useful to make this a local variable.
468 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
472 "List of functions to be called for `find-file' on nonexistent file.
473 These functions are called as soon as the error is detected.
474 Variable `buffer-file-name' is already set up.
477 ;;;It is not useful to make this a local variable.
478 ;;;(put 'find-file-hooks 'permanent-local t)
481 "List of functions to be called after a buffer is loaded from a file.
482 The buffer's local variables (if any) will have been processed before the
483 functions are called."
491 "List of functions to be called before saving a buffer to a file.
492 Only used by `save-buffer'.
493 If one of them returns non-nil, the file is considered already written
494 and the rest are not called.
495 These hooks are considered to pertain to the visited file.
496 So any buffer-local binding of this variable is discarded if you change
498 change the major mode.
500 This hook is not run if any of the functions in
501 `write-contents-functions' returns non-nil. Both hooks pertain
502 to how to save a buffer to file, for instance, choosing a suitable
503 coding system and setting mode bits. (See Info
504 node `(elisp)Saving Buffers'.) To perform various checks or
516 "List of functions to be called before writing out a buffer to a file.
517 Only used by `save-buffer'.
518 If one of them returns non-nil, the file is considered already written
519 and the rest are not called and neither are the functions in
520 `write-file-functions'.
522 This variable is meant to be used for hooks that pertain to the
523 buffer's contents, not to the particular visited file; thus,
524 `set-visited-file-name' does not clear this variable; but changing the
525 major mode does clear it.
527 For hooks that _do_ pertain to the particular visited file, use
528 `write-file-functions'. Both this variable and
529 `write-file-functions' relate to how a buffer is saved to file.
530 To perform various checks or updates before the buffer is saved,
535 "Control use of local variables in files you visit.
536 The value can be t, nil, :safe, :all, or something else.
538 A value of t means file local variables specifications are obeyed
539 if all the specified variable values are safe; if any values are
540 not safe, Emacs queries you, once, whether to set them all.
541 \(When you say yes to certain values, they are remembered as safe.)
543 :safe means set the safe variables, and ignore the rest.
544 :all means set all variables, whether safe or not.
545 (Don't set it permanently to :all.)
546 A value of nil means always ignore the file local variables.
548 Any other value means always query you once whether to set them all.
549 \(When you say yes to certain values, they are remembered as safe, but
552 This variable also controls use of major modes specified in
553 a -*- line.
556 always obeys file local variable specifications and the -*- line,
557 and ignores this variable."
558 :risky t
567 "Non-nil means enable use of directory-local variables.
568 Some modes may wish to set this to nil to prevent directory-local
571 ;; This is an odd variable IMO.
572 ;; You might wonder why it is needed, when we could just do:
573 ;; (set (make-local-variable 'enable-local-variables) nil)
574 ;; These two are not precisely the same.
575 ;; Setting this variable does not cause -*- mode settings to be
576 ;; ignored, whereas setting enable-local-variables does.
577 ;; Only three places in Emacs use this variable: tar and arc modes,
578 ;; and rmail. The first two don't need it. They already use
579 ;; inhibit-local-variables-regexps, which is probably enough, and
580 ;; could also just set enable-local-variables locally to nil.
581 ;; Them setting it has the side-effect that dir-locals cannot apply to
582 ;; eg tar files (?). FIXME Is this appropriate?
583 ;; AFAICS, rmail is the only thing that needs this, and the only
584 ;; reason it uses it is for BABYL files (which are obsolete).
585 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
586 ;; to respect, so that find-file on a BABYL file will switch to
587 ;; rmail-mode automatically (this is nice, but hardly essential,
588 ;; since most people are used to explicitly running a command to
589 ;; access their mail; M-x gnus etc). Rmail files may happen to
590 ;; contain Local Variables sections in messages, which Rmail wants to
591 ;; ignore. So AFAICS the only reason this variable exists is for a
592 ;; minor convenience feature for handling of an obsolete Rmail file format.
594 "Like `enable-local-variables' but meant for buffer-local bindings.
595 The meaningful values are nil and non-nil. The default is non-nil.
596 If a major mode sets this to nil, buffer-locally, then any local
597 variables list in a file visited in that mode will be ignored.
599 This variable does not affect the use of major modes specified
604 The value can be t, nil or something else.
605 A value of t means obey `eval' variables.
606 A value of nil means ignore them; anything else means query."
607 :risky t
614 "Non-nil means buffers visiting files read-only do so in view mode.
615 In fact, this means that all read-only buffers normally have
616 View mode enabled, including buffers that are read-only because
617 you visit a file you cannot alter, and buffers you make read-only
623 "History list of file names entered in the minibuffer.
625 Maximum length of the history list is determined by the value
629 "If non-nil, avoid messages when saving files.
630 Error-related messages will still be printed, but all other
633 \f
636 "Provides support for ange-ftp host name completion.
637 Runs the usual ange-ftp hook, but only for completion operations."
638 ;; Having this here avoids the need to load ange-ftp when it's not
639 ;; really in use.
645 inhibit-file-name-handlers)))
653 "Convert a standard file's name to something suitable for the OS.
654 This means to guarantee valid names and perhaps to canonicalize
655 certain patterns.
657 FILENAME should be an absolute file name since the conversion rules
658 sometimes vary depending on the position in the file name. E.g. c:/foo
659 is a valid DOS file name, but c:/bar/c:/foo is not.
661 This function's standard definition is trivial; it just returns
662 the argument. However, on Windows and DOS, replace invalid
663 characters. On DOS, make sure to obey the 8.3 limitations.
664 In the native Windows build, turn Cygwin names into native names.
666 See Info node `(elisp)Standard File Names' for more details."
671 ;; Replace invalid filename characters with !
675 name))
683 "Read directory name, prompting with PROMPT and completing in directory DIR.
684 Value is not expanded---you must call `expand-file-name' yourself.
685 Default name to DEFAULT-DIRNAME if user exits with the same
686 non-empty string that was inserted by this function.
687 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
688 or just DIR if INITIAL is nil.)
689 If the user exits with an empty minibuffer, this function returns
690 an empty string. (This can only happen if the user erased the
691 pre-inserted contents or if `insert-default-directory' is nil.)
692 Fourth arg MUSTMATCH non-nil means require existing directory's name.
693 Non-nil and non-t means also require confirmation after completion.
694 Fifth arg INITIAL specifies text to start with.
695 DIR should be an absolute directory name. It defaults to
696 the value of `default-directory'."
701 dir))
702 mustmatch initial
705 \f
707 "Show the current default directory.
708 With prefix argument INSERT, insert the current default directory
709 at point instead."
716 "Value of the CDPATH environment variable, as a list.
720 "Explode a search path into a list of directory names.
721 Directories are separated by `path-separator' (which is colon in
722 GNU and Unix systems). Substitute environment variables into the
723 resulting list of directory names. For an empty path element (i.e.,
724 a leading or trailing separator, or two adjacent separators), return
725 nil (meaning `default-directory') as the associated list element."
733 "Change current directory to given absolute file name DIR."
734 ;; Put the name into directory syntax now,
735 ;; because otherwise expand-file-name may give some bad results.
737 ;; We used to additionally call abbreviate-file-name here, for an
738 ;; unknown reason. Problem is that most buffers are setup
739 ;; without going through cd-absolute and don't call
740 ;; abbreviate-file-name on their default-directory, so the few that
741 ;; do end up using a superficially different directory.
753 "Make DIR become the current buffer's default directory.
754 If your environment includes a `CDPATH' variable, try each one of
755 that list of directories (separated by occurrences of
756 `path-separator') when resolving a relative directory name.
757 The path separator is colon in GNU and GNU-like systems."
760 ;; FIXME: There's a subtle bug in the completion below. Seems linked
761 ;; to a fundamental difficulty of implementing `predicate' correctly.
762 ;; The manifestation is that TAB may list non-directories in the case where
763 ;; those files also correspond to valid directories (if your cd-path is (A/
764 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
765 ;; will be listed as valid completions).
766 ;; This is because `a' (listed because of A/a) is indeed a valid choice
767 ;; (which will lead to the use of B/a).
772 cd-path nil))
781 default-directory default-directory
782 t))))
792 "Return non-nil if NAME ends with a directory separator character."
802 "Return list of all files under DIR that have file names matching REGEXP.
804 order, and files from each directory are sorted in alphabetical order.
805 Each file name appears in the returned list in its absolute form.
806 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
807 output directories whose names match REGEXP."
810 ;; When DIR is "/", remote file names like "/method:" could
811 ;; also be offered. We shall suppress them.
819 ;; Don't follow symlinks to other directories.
823 full-file regexp include-directories))))
834 "Load the Lisp file named FILE."
835 ;; This is a case where .elc and .so/.dll make a lot of sense.
839 completion-ignored-extensions))))
844 "Search for FILENAME through PATH.
845 If found, return the absolute file name of FILENAME; otherwise
846 return nil.
847 PATH should be a list of directories to look in, like the lists in
848 `exec-path' or `load-path'.
849 If SUFFIXES is non-nil, it should be a list of suffixes to append to
852 If non-nil, PREDICATE is used instead of `file-readable-p'.
854 This function will normally skip directories, so if you want it to find
855 directories, make sure the PREDICATE function returns `dir-ok' for them.
857 PREDICATE can also be an integer to pass to the `access' system call,
858 in which case file-name handlers are ignored. This usage is deprecated.
859 For compatibility, PREDICATE can also be one of the symbols
860 `executable', `readable', `writable', or `exists', or a list of
861 one or more of those symbols."
872 "Do completion for file names passed to `locate-file'."
875 ;; FIXME: maybe we should use completion-file-name-table instead,
876 ;; tho at least for `load', the arg is passed through
877 ;; substitute-in-file-name for historical reasons.
887 ;; If we have files like "foo.el" and "foo.elc", we could load one of
888 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
889 ;; preferred way. So if we list all 3, that gives a lot of redundant
890 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
891 ;; the user does want to pay attention to the extension. We try to
892 ;; diffuse this tension by stripping the suffix, except when the
893 ;; result is a single element (i.e. usually we only list "foo" unless
894 ;; it's the only remaining element in the list, in which case we do
895 ;; list "foo", "foo.elc" and "foo.el").
906 string-file dir))
911 ;; Switching from names to names+fullnames creates a non-monotonicity
912 ;; which can cause problems with things like partial-completion.
913 ;; To minimize the problem, filter out completion-regexp-list, so that
914 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
915 ;; from `names' which only matched `string' when they still had
916 ;; their suffix.
918 ;; Remove duplicates of the first element, so that we can easily check
919 ;; if `names' really only contains a single element.
922 ;; There's no more than one matching non-suffixed element, so expand
923 ;; the list by adding the suffixed elements as well.
926 string-dir names string-file pred action)))))
929 "Do completion for file names passed to `locate-file'.
930 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
934 string nil action))
938 "Regexp of directory names which stop the search in `locate-dominating-file'.
939 Any directory whose name matches this regexp will be treated like
940 a kind of root directory by `locate-dominating-file' which will stop its search
941 when it bumps into it.
942 The default regexp prevents fruitless and time-consuming attempts to find
943 special files in directories in which filenames are interpreted as hostnames,
946 ;; (defun locate-dominating-files (file regexp)
947 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
948 ;; Stop at the first parent where a matching file is found and return the list
949 ;; of files that that match in this directory."
950 ;; (catch 'found
951 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
952 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
953 ;; (let ((user nil)
954 ;; ;; Abbreviate, so as to stop when we cross ~/.
955 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
956 ;; files)
957 ;; (while (and dir
958 ;; ;; As a heuristic, we stop looking up the hierarchy of
959 ;; ;; directories as soon as we find a directory belonging to
960 ;; ;; another user. This should save us from looking in
961 ;; ;; things like /net and /afs. This assumes that all the
962 ;; ;; files inside a project belong to the same user.
963 ;; (let ((prev-user user))
964 ;; (setq user (nth 2 (file-attributes dir)))
965 ;; (or (null prev-user) (equal user prev-user))))
966 ;; (if (setq files (condition-case nil
967 ;; (directory-files dir 'full regexp 'nosort)
968 ;; (error nil)))
969 ;; (throw 'found files)
970 ;; (if (equal dir
971 ;; (setq dir (file-name-directory
972 ;; (directory-file-name dir))))
973 ;; (setq dir nil))))
974 ;; nil)))
977 "Look up the directory hierarchy from FILE for a directory containing NAME.
978 Stop at the first parent directory containing a file NAME,
979 and return the directory. Return nil if not found.
980 Instead of a string, NAME can also be a predicate taking one argument
981 \(a directory) and returning a non-nil value if that directory is the one for
982 which we're looking."
983 ;; We used to use the above locate-dominating-files code, but the
984 ;; directory-files call is very costly, so we're much better off doing
985 ;; multiple calls using the code in here.
986 ;;
987 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
988 ;; `name' in /home or in /.
991 ;; `user' is not initialized outside the loop because
992 ;; `file' may not exist, so we may have to walk up part of the
993 ;; hierarchy before we find the "initial UID". Note: currently unused
994 ;; (user nil)
995 try)
998 ;; FIXME: Disabled this heuristic because it is sometimes
999 ;; inappropriate.
1000 ;; As a heuristic, we stop looking up the hierarchy of
1001 ;; directories as soon as we find a directory belonging
1002 ;; to another user. This should save us from looking in
1003 ;; things like /net and /afs. This assumes that all the
1004 ;; files inside a project belong to the same user.
1005 ;; (let ((prev-user user))
1006 ;; (setq user (nth 2 (file-attributes file)))
1007 ;; (and prev-user (not (equal user prev-user))))
1019 "Non-nil means warn if cannot access `user-emacs-directory'.
1020 Set this to nil at your own risk..."
1026 "Return an absolute per-user Emacs-specific file name.
1027 If NEW-NAME exists in `user-emacs-directory', return it.
1028 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
1029 Else return NEW-NAME in `user-emacs-directory', creating the
1030 directory if it does not exist."
1038 at-home
1039 ;; Make sure `user-emacs-directory' exists,
1040 ;; unless we're in batch mode or dumping Emacs.
1042 purify-flag
1052 user-emacs-directory-warning
1054 ;; Only warn once per Emacs session.
1058 Unable to %s `user-emacs-directory' (%s).
1059 Any data that would normally be written there may be lost!
1060 If you never want to see this message again,
1061 customize the variable `user-emacs-directory-warning'."
1062 errtype user-emacs-directory)))))
1063 bestname))))
1067 "Search for COMMAND in `exec-path' and return the absolute file name.
1068 Return nil if COMMAND is not found anywhere in `exec-path'."
1069 ;; Use 1 rather than file-executable-p to better match the behavior of
1070 ;; call-process.
1074 "Load the Emacs Lisp library named LIBRARY.
1075 LIBRARY should be a string.
1076 This is an interface to the function `load'. LIBRARY is searched
1077 for in `load-path', both with and without `load-suffixes' (as
1078 well as `load-file-rep-suffixes').
1080 See Info node `(emacs)Lisp Libraries' for more details.
1081 See `load-file' for a different interface to `load'."
1086 load-path
1091 "Test whether FILE specifies a location on a remote system.
1092 A file is considered remote if accessing it is likely to
1093 be slower or less reliable than accessing local files.
1095 `file-remote-p' never opens a new remote connection. It can
1096 only reuse a connection that is already open.
1098 Return nil or a string identifying the remote connection
1099 \(ideally a prefix of FILE). Return nil if FILE is a relative
1100 file name.
1102 When IDENTIFICATION is nil, the returned string is a complete
1103 remote identifier: with components method, user, and host. The
1104 components are those present in FILE, with defaults filled in for
1105 any that are missing.
1107 IDENTIFICATION can specify which part of the identification to
1108 return. IDENTIFICATION can be the symbol `method', `user',
1109 `host', or `localname'. Any other value is handled like nil and
1110 means to return the complete identification. The string returned
1111 for IDENTIFICATION `localname' can differ depending on whether
1112 there is an existing connection.
1114 If CONNECTED is non-nil, return an identification only if FILE is
1115 located on a remote system and a connection is established to
1116 that remote system.
1118 Tip: You can use this expansion of remote identifier components
1119 to derive a new remote file name from an existing one. For
1125 same remote identifier as FILE but expanded; a name such as
1130 nil)))
1132 ;; Probably this entire variable should be obsolete now, in favor of
1133 ;; something Tramp-related (?). It is not used in many places.
1134 ;; It's not clear what the best file for this to be in is, but given
1135 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1136 ;; rather than autoloaded.
1138 ;; This used to try various hard-coded places for remsh, rsh, and
1139 ;; rcmd, trying to guess based on location whether "rsh" was
1140 ;; "restricted shell" or "remote shell", but I don't see the point
1141 ;; in this day and age. Almost everyone will use ssh, and have
1142 ;; whatever command they want to use in PATH.
1149 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1156 "Whether to use the remote file-name cache for read access.
1157 When nil, never expire cached values (caution)
1158 When t, never use the cache (safe, but may be slow)
1159 A number means use cached values for that amount of seconds since caching.
1161 The attributes of remote files are cached for better performance.
1162 If they are changed outside of Emacs's control, the cached values
1163 become invalid, and must be reread. If you are sure that nothing
1164 other than Emacs changes the files, you can set this variable to nil.
1166 If a remote file is checked regularly, it might be a good idea to
1167 let-bind this variable to a value less than the interval between
1168 consecutive checks. For example:
1170 (defun display-time-file-nonempty-p (file)
1171 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1172 (and (file-exists-p file)
1173 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1184 "Return the local name component of FILE.
1185 It returns a file name which can be used directly as argument of
1186 `process-file', `start-file-process', or `shell-command'."
1190 "Copy the file FILE into a temporary file on this machine.
1191 Returns the name of the local copy, or nil, if FILE is directly
1192 accessible."
1193 ;; This formerly had an optional BUFFER argument that wasn't used by
1194 ;; anything.
1198 nil)))
1201 "Return the truename of FILENAME.
1202 If FILENAME is not absolute, first expands it against `default-directory'.
1203 The truename of a file name is found by chasing symbolic links
1204 both at the level of the file and at the level of the directories
1205 containing it, until no links are left at any level.
1208 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1209 ;; COUNTER can be a cons cell whose car is the count of how many
1210 ;; more links to chase before getting an error.
1211 ;; PREV-DIRS can be a cons cell whose car is an alist
1212 ;; of truenames we've just recently computed.
1226 ;; For speed, remove the ange-ftp completion handler from the list.
1227 ;; We know it's not needed here.
1228 ;; For even more speed, do this only on the outermost call.
1235 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1236 ;; case differences being ignored by the OS, and short "8.3 DOS"
1237 ;; name aliases existing for all files. (The short names are not
1238 ;; reported by directory-files, but can be used to refer to files.)
1239 ;; It seems appropriate for file-truename to resolve these issues in
1240 ;; the most natural way, which on Windows is to call the function
1241 ;; `w32-long-file-name' - this returns the exact name of a file as
1242 ;; it is stored on disk (expanding short name aliases with the full
1243 ;; name in the process).
1246 ;; If filename exists, use its long name. If it doesn't
1247 ;; exist, the recursion below on the directory of filename
1248 ;; will drill down until we find a directory that exists,
1249 ;; and use the long name of that, with the extra
1250 ;; non-existent path components concatenated.
1255 ;; If this file directly leads to a link, process that iteratively
1256 ;; so that we don't use lots of stack.
1262 ;; For file name that has a special handler, call handler.
1263 ;; This is so that ange-ftp can save time by doing a no-op.
1266 done t)
1268 target dirfile)
1269 ;; Get the truename of the directory.
1271 ;; If these are equal, we have the (or a) root directory.
1275 ;; If this is the same dir we last got the truename for,
1276 ;; save time--don't recalculate.
1286 done t)
1289 done t)
1290 ;; Put it back on the file name.
1292 ;; Is the file name the name of a link?
1295 ;; Yes => chase that link, then start all over
1296 ;; since the link may point to a directory name that uses links.
1297 ;; We can't safely use expand-file-name here
1298 ;; since target might look like foo/../bar where foo
1299 ;; is itself a link. Instead, we handle . and .. above.
1302 target
1304 done nil)
1305 ;; No, we are done!
1307 filename))
1310 "Chase links in FILENAME until a name that is not a link.
1311 Unlike `file-truename', this does not check whether a parent
1312 directory name is a symbolic link.
1313 If the optional argument LIMIT is a number,
1314 it means chase no more than that many links and then stop."
1322 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1325 ;; Handle `..' by hand, since it needs to work in the
1326 ;; target of any directory symlink.
1327 ;; This code is not quite complete; it does not handle
1328 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1332 ;; Chase links in the default dir of the symlink.
1336 ;; Now find the parent of that dir.
1340 newname))
1342 ;; A handy function to display file sizes in human-readable form.
1343 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1345 "Produce a string showing FILE-SIZE in human-readable form.
1347 Optional second argument FLAVOR controls the units and the display format:
1349 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1351 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1353 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1356 1024.0
1359 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1365 "%.1f%s%s"
1367 file-size
1369 "K"
1375 "^//[^/]+/"
1376 ;; regexp-opt.el is not dumped into emacs binary.
1377 ;;(concat
1378 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1380 "File systems which ought to be mounted."
1387 "The directory for writing temporary files.
1388 In case of a remote `default-directory', this is a directory for
1389 temporary files on that remote host. If such a directory does
1390 not exist, or `default-directory' ought to be located on a
1391 mounted file system (see `mounted-file-systems'), the function
1392 returns `default-directory'.
1393 For a non-remote and non-mounted `default-directory', the value of
1394 the variable `temporary-file-directory' is returned."
1400 default-directory
1401 temporary-file-directory))))
1404 "Create a temporary file.
1405 The returned file name (created by appending some random characters at the end
1406 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1407 is guaranteed to point to a newly created empty file.
1408 You can then use `write-region' to write new data into the file.
1410 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1412 If SUFFIX is non-nil, add that at the end of the file name."
1413 ;; Create temp files with strict access rights. It's easy to
1414 ;; loosen them later, whereas it's impossible to close the
1415 ;; time-window of loose permissions otherwise.
1424 temporary-file-directory)
1426 temporary-file-directory))))
1432 nil)
1434 ;; the file was somehow created by someone else between
1435 ;; `make-temp-name' and `write-region', let's try again.
1436 nil)
1437 file)))
1440 "Create a temporary file as close as possible to `default-directory'.
1441 If PREFIX is a relative file name, and `default-directory' is a
1442 remote file name or located on a mounted file systems, the
1443 temporary file is created in the directory returned by the
1444 function `temporary-file-directory'. Otherwise, the function
1445 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1446 same meaning as in `make-temp-file'."
1455 "Change the encoding of FILE's name from CODING to NEW-CODING.
1456 The value is a new name of FILE.
1457 Signals a `file-already-exists' error if a file of the new name
1458 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1459 is non-nil. A number as fourth arg means request confirmation if
1460 the new name already exists. This is what happens in interactive
1461 use with M-x."
1464 default-file-name-coding-system))
1466 from-coding to-coding)
1468 ;; We provide the default coding only when it seems that
1469 ;; the filename is correctly decoded by the default
1470 ;; coding.
1476 filename default-coding)
1477 default-coding))
1481 ;; We provide the default coding only when a user is going to
1482 ;; change the encoding not from the default coding.
1486 filename from-coding)))
1489 filename from-coding default-coding)
1490 default-coding)))
1494 default-file-name-coding-system))
1495 ;; FILE should have been decoded by DEFAULT-CODING.
1499 ;; Suppress further encoding.
1504 newname))
1505 \f
1507 "Whether confirmation is requested before visiting a new file or buffer.
1508 If nil, confirmation is not requested.
1509 If the value is `after-completion', confirmation is only
1510 requested if the user called `minibuffer-complete' right before
1511 `minibuffer-complete-and-exit'.
1512 Any other non-nil value means to request confirmation.
1514 This affects commands like `switch-to-buffer' and `find-file'."
1522 "Whether to request confirmation before visiting a new file or buffer.
1523 The variable `confirm-nonexistent-file-or-buffer' determines the
1524 return value, which may be passed as the REQUIRE-MATCH arg to
1525 `read-buffer' or `find-file-read-args'."
1533 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1535 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1536 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1537 instead of prepending it.
1539 BODY should use the minibuffer at most once.
1540 Recursive uses of the minibuffer are unaffected (FUN is not
1541 called additional times).
1543 This macro actually adds an auxiliary function that calls FUN,
1544 rather than FUN itself, to `minibuffer-setup-hook'."
1555 ;; Clear out this hook so it does not interfere
1556 ;; with any recursive minibuffer usage.
1567 t))
1570 "Edit file FILENAME.
1571 Switch to a buffer visiting file FILENAME,
1572 creating one if none already exists.
1573 Interactively, the default if you just type RET is the current directory,
1574 but the visited file name is available through the minibuffer history:
1575 type M-n to pull it into the minibuffer.
1577 You can visit files on remote machines by specifying something
1578 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1579 also visit local files as a different user by specifying
1580 /sudo::FILE for the file name.
1581 See the Info node `(tramp)File name Syntax' in the Tramp Info
1582 manual, for more about this.
1584 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1585 expand wildcards (if any) and visit multiple files. You can
1586 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1588 To visit a file without any kind of conversion and without
1599 "Edit file FILENAME, in another window.
1602 an existing one. See the function `display-buffer'.
1604 Interactively, the default if you just type RET is the current directory,
1605 but the visited file name is available through the minibuffer history:
1606 type M-n to pull it into the minibuffer.
1608 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1609 expand wildcards (if any) and visit multiple files."
1619 value)
1623 "Edit file FILENAME, in another frame.
1626 an existing one. See the function `display-buffer'.
1628 Interactively, the default if you just type RET is the current directory,
1629 but the visited file name is available through the minibuffer history:
1630 type M-n to pull it into the minibuffer.
1632 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1633 expand wildcards (if any) and visit multiple files."
1643 value)
1647 "Edit the existing file FILENAME.
1649 file names with wildcards."
1666 value))
1669 "Edit file FILENAME but don't allow changes.
1678 "Edit file FILENAME in another window but don't allow changes.
1687 "Edit file FILENAME in another frame but don't allow changes.
1696 "Find file FILENAME as a replacement for the file in the next window.
1697 This command does not select that window.
1701 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1702 expand wildcards (if any) and replace the file with multiple files."
1713 "Find alternate file: " file-dir nil
1715 t))))
1722 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1724 "Hook run when a buffer is killed.
1725 The buffer being killed is current while the hook is running.
1726 See `kill-buffer'.
1728 Note: Be careful with let-binding this hook considering it is
1732 "Find file FILENAME, select its buffer, kill previous buffer.
1733 If the current buffer now contains an empty file that you just visited
1734 \(presumably by mistake), use this command to visit the file you really want.
1738 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1739 expand wildcards (if any) and replace the file with multiple files.
1741 If the current buffer is an indirect buffer, or the base buffer
1742 for one or more indirect buffers, the other buffer(s) are not
1743 killed."
1752 "Find alternate file: " file-dir nil
1754 t)))
1768 ;; Run `kill-buffer-hook' here. It needs to happen before
1769 ;; variables like `buffer-file-name' etc are set to nil below,
1770 ;; because some of the hooks that could be invoked
1771 ;; (e.g., `save-place-to-alist') depend on those variables.
1772 ;;
1773 ;; Note that `kill-buffer-hook' is not what queries whether to
1774 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1775 ;; asks that itself. Thus, there's no need to temporarily do
1776 ;; `(set-buffer-modified-p nil)' before running this hook.
1778 ;; Okay, now we can end-of-life the old buffer.
1785 ;; This prevents us from finding the same buffer
1786 ;; if we specified the same file again.
1790 ;; Likewise for dired buffers.
1794 ;; This executes if find-file gets an error
1795 ;; and does not really find anything.
1796 ;; We put things back as they were.
1797 ;; If find-file actually finds something, we kill obuf below.
1806 ;; We already ran these; don't run them again.
1809 \f
1810 ;; FIXME we really need to fold the uniquify stuff in here by default,
1811 ;; not using advice, and add it to the doc string.
1813 "Create a suitably named buffer for visiting FILENAME, and return it.
1814 FILENAME (sans directory) is used unchanged if that name is free;
1815 otherwise a string <2> or <3> or ... is appended to get an unused name.
1817 Emacs treats buffers whose names begin with a space as internal buffers.
1818 To avoid confusion when visiting a file whose name begins with a space,
1825 lastname))))
1828 "Create and return a buffer with a name based on NAME.
1829 Choose the buffer's name using `generate-new-buffer-name'."
1833 "Regexp to match the automounter prefix in a directory name."
1839 "Regexp matching the user's homedir at the beginning of file name.
1843 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1845 home directory is a root directory) and removes automounter prefixes
1846 \(see the variable `automount-dir-prefix')."
1847 ;; Get rid of the prefixes added by the automounter.
1854 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1856 ;; If any elt of directory-abbrev-alist matches this name,
1857 ;; abbreviate accordingly.
1863 ;; Compute and save the abbreviated homedir name.
1864 ;; We defer computing this until the first time it's needed, to
1865 ;; give time for directory-abbrev-alist to be set properly.
1866 ;; We include a slash at the end, to avoid spurious matches
1867 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1875 ;; Depending on whether default-directory does or
1876 ;; doesn't include non-ASCII characters, the value
1877 ;; of abbreviated-home-dir could be multibyte or
1878 ;; unibyte. In the latter case, we need to decode
1879 ;; it. Note that this function is called for the
1880 ;; first time (from startup.el) when
1881 ;; locale-coding-system is already set up.
1883 abbreviated-home-dir
1886 'utf-8
1887 locale-coding-system))))))
1889 ;; If FILENAME starts with the abbreviated homedir,
1890 ;; make it start with `~' instead.
1892 ;; If the home dir is just /, don't change it.
1895 ;; MS-DOS root directories can come with a drive letter;
1896 ;; Novell Netware allows drive letters beyond `Z:'.
1904 filename)))
1907 "Return the buffer visiting file FILENAME (a string).
1908 This is like `get-file-buffer', except that it checks for any buffer
1909 visiting the same file, possibly under a different name.
1910 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1911 and others are ignored.
1912 If there is no such live buffer, return nil."
1925 found)
1935 ;; Verify this buffer's file number
1936 ;; still belongs to its file.
1939 attributes)
1943 found))))
1944 \f
1946 "Non-nil means file-visiting commands should handle wildcards.
1947 For example, if you specify `*.c', that would visit all the files
1948 whose names match the pattern."
1954 "Non-nil means suppress warning messages for symlinked files.
1955 When nil, Emacs prints a warning when visiting a file that is already
1956 visited, but with a different name. Setting this option to t
1957 suppresses this warning."
1963 "Maximum size of file above which a confirmation is requested.
1964 When nil, never request confirmation."
1971 "Warn if file size exceeds this percentage of available free memory.
1972 When nil, never issue warning. Beware: This probably doesn't do what you
1980 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1981 OP-TYPE specifies the file operation being performed (for message to user)."
1990 "Warn if an attempt to open file of SIZE bytes may run out of memory."
2000 "You are trying to open a file whose size (%s)
2001 exceeds the %S%% of currently available free memory (%s).
2002 If that fails, try to open it with `find-file-literally'
2003 \(but note that some characters might be displayed incorrectly)."
2005 out-of-memory-warning-percentage
2009 "Like `message', except sometimes don't print to minibuffer.
2010 If the variable `save-silently' is non-nil, the message is not
2011 displayed on the minibuffer."
2016 "Read file FILENAME into a buffer and return the buffer.
2017 If a buffer exists visiting FILENAME, return that one, but
2018 verify that the file has not changed since visited or saved.
2019 The buffer is not selected, just returned to the caller.
2020 Optional second arg NOWARN non-nil means suppress any warning messages.
2021 Optional third arg RAWFILE non-nil means the file is read literally.
2022 Optional fourth arg WILDCARDS non-nil means do wildcard processing
2023 and visit all the matching files. When wildcards are actually
2024 used and expanded, return a list of buffers that are visiting
2025 the various files."
2032 'find-directory-functions
2035 filename)))
2038 find-file-wildcards
2052 ;; Find any buffer for a file which has same truename.
2054 ;; Let user know if there is a buffer with the same truename.
2058 find-file-suppress-same-file-warnings
2062 ;; Optionally also find that buffer.
2065 ;; Check to see if the file looks uncommonly large.
2070 ;; We are using an existing buffer.
2077 ;; Certain files should be reverted automatically
2078 ;; if they have changed on disk and not in the buffer.
2086 found))
2096 "File %s changed on disk. Discard your edits? "
2101 "File %s changed on disk. Discard your edits in %s? "
2109 ;; Check if a formerly read-only file has become
2110 ;; writable and vice versa, but if the buffer agrees
2111 ;; with the new state of the file, that is ok too.
2121 buffer-file-name
2122 new-status new-status)))
2128 nonexistent
2129 ;; It is confusing to ask whether to visit
2130 ;; non-literally if they have the file in
2131 ;; hexl-mode or image-mode.
2137 "The file %s is already visited normally,
2138 and you have edited the buffer. Now you have asked to visit it literally,
2139 meaning no coding system handling, format conversion, or local variables.
2140 Emacs can only visit a file in one way at a time.
2142 Do you want to save the file, and visit it literally instead? "
2143 "The file %s is already visited literally,
2144 meaning no coding system handling, format conversion, or local variables.
2145 You have edited the buffer. Now you have asked to visit the file normally,
2146 but Emacs can only visit a file in one way at a time.
2153 rawfile truename number))
2157 "\
2158 Do you want to discard your changes, and visit the file literally now? "
2159 "\
2162 rawfile truename number)
2168 "The file %s is already visited normally.
2169 You have asked to visit it literally,
2170 meaning no coding system decoding, format conversion, or local variables.
2171 But Emacs can only visit a file in one way at a time.
2173 Do you want to revisit the file literally now? "
2174 "The file %s is already visited literally,
2175 meaning no coding system decoding, format conversion, or local variables.
2176 You have asked to visit it normally,
2177 but Emacs can only visit a file in one way at a time.
2182 rawfile truename number)
2185 ;; Return the buffer we are using.
2186 buf)
2187 ;; Create a new buffer.
2189 ;; find-file-noselect-1 may use a different buffer.
2191 rawfile truename number))))))
2197 ;; Needed in case we are re-visiting the file with a different
2198 ;; text representation.
2215 filename)))
2216 ;; Unconditionally set error
2226 filename)))
2227 ;; Run find-file-not-found-functions until one returns non-nil.
2229 ;; If they fail too, set error.
2231 ;; Record the file's truename, and maybe use that as visited name.
2239 ;; Set buffer's default directory to that of the file.
2241 ;; Turn off backup files for certain file names. Since
2242 ;; this is a permanent local, the major mode won't eliminate it.
2256 \f
2258 "Like `insert-file-contents', but only reads in the file literally.
2259 See `insert-file-contents' for an explanation of the parameters.
2260 A buffer may be modified in several ways after reading into the buffer,
2261 due to Emacs features such as format decoding, character code
2262 conversion, `find-file-hook', automatic uncompression, etc.
2264 This function ensures that none of these modifications will take place."
2270 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2271 ;; into a file operation instead!
2273 inhibit-file-name-handlers))
2280 filename)))
2281 ;; Check whether the file is uncommonly large
2292 "Insert contents of file FILENAME into buffer after point with no conversion.
2294 This function is meant for the user to run interactively.
2295 Don't call it from programs! Use `insert-file-contents-literally' instead.
2296 \(Its calling sequence is different; see its documentation)."
2302 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2303 This has the `permanent-local' property, which takes effect if you
2308 "Visit file FILENAME with no conversion of any kind.
2309 Format conversion and character code conversion are both disabled,
2310 and multibyte characters are disabled in the resulting buffer.
2311 The major mode used is Fundamental mode regardless of the file name,
2312 and local variable specifications in the file are ignored.
2313 Automatic uncompression and adding a newline at the end of the
2314 file due to `require-final-newline' is also disabled.
2316 You cannot absolutely rely on this function to result in
2317 visiting the file literally. If Emacs already has a buffer
2318 which is visiting the file, you get the existing buffer,
2319 regardless of whether it was created literally or not.
2321 In a Lisp program, if you want to be sure of accessing a file's
2322 contents literally, you should create a temporary buffer and then read
2323 the file contents into it using `insert-file-contents-literally'."
2326 "Find file literally: " nil default-directory
2329 \f
2331 _after-find-file-from-revert-buffer
2332 nomodes)
2333 "Called after finding a file and by the default revert function.
2334 Sets buffer mode, parses local variables.
2335 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2336 error in reading the file. WARN non-nil means warn if there
2337 exists an auto-save file more recent than the visited file.
2338 NOAUTO means don't mess with auto-save mode.
2339 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2340 \(see `revert-buffer-in-progress-p' for similar functionality).
2341 Fifth arg NOMODES non-nil means don't alter the file's modes.
2342 Finishes by calling the functions in `find-file-hook'
2343 unless NOMODES is non-nil."
2346 nil
2356 "Symbolic link that points to nonexistent file"
2360 ;; No need to warn if buffer is auto-saved
2361 ;; under the name of the visited file.
2363 auto-save-visited-file-name))
2366 buffer-file-name))
2386 ;; Make people do a little extra work (C-x C-q)
2387 ;; before altering a backup file.
2390 ;; When a file is marked read-only,
2391 ;; make the buffer read-only even if root is looking at it.
2399 ;; If requested, add a newline at the end of the file.
2410 view-read-only
2418 "Choose the major mode for this buffer automatically.
2419 Also sets up any specified local variables of the file.
2420 Uses the visited file name, the -*- line, and the local variables spec.
2422 This function is called automatically from `find-file'. In that case,
2423 we may set up the file-specified mode and local variables,
2424 depending on the value of `enable-local-variables'.
2425 In addition, if `local-enable-local-variables' is nil, we do
2426 not set local variables (though we do notice a mode specified with -*-.)
2428 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2429 or from Lisp without specifying the optional argument FIND-FILE;
2430 in that case, this function acts as if `enable-local-variables' were t."
2437 ;; FIXME this is less efficient than it could be, since both
2438 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2441 ;; `delay-mode-hooks' being non-nil will have prevented the major
2442 ;; mode's call to `run-mode-hooks' from calling
2443 ;; `hack-local-variables'. In that case, call it now.
2447 ;; Turn font lock off and on, to make sure it takes account of
2448 ;; whatever file local variables are relevant to it.
2450 ;; Font-lock-mode (now in font-core.el) can be ON when
2451 ;; font-lock.el still hasn't been loaded.
2458 "Non-nil means to try second pass through `auto-mode-alist'.
2459 This means that if the first case-sensitive search through the alist fails
2460 to find a matching major mode, a second case-insensitive search is made.
2461 On systems with case-insensitive file names, this variable is ignored,
2462 since only a single case-insensitive search through the alist is made."
2468 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2469 ;; c++-mode, java-mode and more) are added through autoload
2470 ;; directives in that file. That way is discouraged since it
2471 ;; spreads out the definition of the initial value.
2517 ;; Less common extensions come here
2518 ;; so more common ones above are found faster.
2526 ;; Besides .gdbinit, gdb documents other names to be usable for init
2527 ;; files, cross-debuggers can use something like
2528 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2529 ;; don't interfere with each other.
2531 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2532 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2533 ;; loaded when GDB reads an objfile called 'emacs'.
2541 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2565 ;; The Fortran standard does not say anything about file extensions.
2566 ;; .f90 was widely used for F90, now we seem to be trapped into
2567 ;; using a different extension for each language revision.
2568 ;; Anyway, the following extensions are supported by gfortran.
2576 ;; The list of archive file extensions should be in sync with
2577 ;; `auto-coding-alist' with `no-conversion' coding system.
2583 ;; Mailer puts message to be edited in
2584 ;; /tmp/Re.... or Message
2587 ;; some news reader is reported to use this
2601 ;; .emacs or .gnus or .viper following a directory delimiter in
2602 ;; Unix or MS-DOS syntax.
2605 ;; _emacs following a directory delimiter in MS-DOS syntax
2609 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2610 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2611 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2614 ;; .xs is also used for ld scripts, but seems to be more commonly
2615 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2617 ;; Explained in binutils ld/genscripts.sh. Eg:
2618 ;; A .x script file is the default script.
2619 ;; A .xr script is for linking without relocation (-r flag). Etc.
2623 ;; Common Lisp ASDF package system.
2630 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2642 ;; Windows candidates may be opened case sensitively on Unix
2648 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2649 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2650 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2651 ;; this has lower priority to avoid matching changelog.sgml etc.
2653 ;; either user's dot-files or under /etc or some such
2655 ;; alas not all ~/.*rc files are like this
2656 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2661 ;; this contains everything twice, with space and with colon :-(
2663 ;; Get rid of any trailing .n.m and try again.
2664 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2665 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2666 ;; Using mode nil rather than `ignore' would let the search continue
2667 ;; through this list (with the shortened name) rather than start over.
2670 ;; This should come after "in" stripping (e.g. config.h.in).
2671 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2673 ;; The following should come after the ChangeLog pattern
2674 ;; for the sake of ChangeLog.1, etc.
2675 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2677 "Alist of filename patterns vs corresponding major mode functions.
2678 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2679 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2680 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2681 mode function to use. FUNCTION will be called, unless it is nil.
2683 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2684 calling FUNCTION (if it's not nil), we delete the suffix that matched
2685 REGEXP and search the list again for another match.
2687 The extensions whose FUNCTION is `archive-mode' should also
2688 appear in `auto-coding-alist' with `no-conversion' coding system.
2690 See also `interpreter-mode-alist', which detects executable script modes
2691 based on the interpreters they specify to run,
2696 "Select Conf mode or XML mode according to start of file."
2706 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2707 ;; and pike-mode) are added through autoload directives in that
2708 ;; file. That way is discouraged since it spreads out the
2709 ;; definition of the initial value.
2738 "Alist mapping interpreter names to major modes.
2739 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2740 Each element looks like (REGEXP . MODE).
2741 If REGEXP matches the entire name (minus any directory part) of
2742 the interpreter specified in the first line of a script, enable
2743 major mode MODE.
2750 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2751 ;; because we are duplicating info from auto-mode-alist.
2752 ;; TODO many elements of this list are also in auto-coding-alist.
2761 "List of regexps matching file names in which to ignore local variables.
2763 Files matching this list are typically binary file formats.
2764 They may happen to contain sequences that look like local variable
2765 specifications, but are not really, or they may be containers for
2766 member files with their own local variable sections, which are
2767 not appropriate for the containing file.
2774 "List of regexps matching suffixes to remove from file names.
2775 The function `inhibit-local-variables-p' uses this: when checking
2776 a file name, it first discards from the end of the name anything that
2779 ;; Can't think of any situation in which you'd want this to be nil...
2784 "Return non-nil if file local variables should be ignored.
2785 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2786 and `inhibit-local-variables-suffixes'. If
2787 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2796 sufs)
2801 temp))
2806 "Regexp matching interpreters, for file mode determination.
2807 This regular expression is matched against the first line of a file
2808 to determine the file's mode in `set-auto-mode'. If it matches, the file
2809 is assumed to be interpreted by the interpreter matched by the second group
2810 of the regular expression. The mode is then determined as the mode
2814 "Alist of buffer beginnings vs. corresponding major mode functions.
2815 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2816 After visiting a file, if REGEXP matches the text at the beginning of the
2817 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2818 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2819 major mode.
2821 If FUNCTION is nil, then it is not called. (That is a way of saying
2829 ;; The < comes before the groups (but the first) to reduce backtracking.
2830 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2831 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2835 comment-re "*"
2838 . mhtml-mode)
2840 ;; These two must come after html, because they are more general:
2845 . sgml-mode)
2848 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2849 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2850 After visiting a file, if REGEXP matches the text at the beginning of the
2851 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2852 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2853 have not specified a mode for this file.
2859 "Upper limit on `magic-mode-alist' regexp matches.
2863 "Select major mode appropriate for current buffer.
2865 To find the right major mode, this function checks for a -*- mode tag
2866 checks for a `mode:' entry in the Local Variables section of the file,
2867 checks if it uses an interpreter listed in `interpreter-mode-alist',
2868 matches the buffer beginning against `magic-mode-alist',
2869 compares the filename against the entries in `auto-mode-alist',
2870 then matches the buffer beginning against `magic-fallback-mode-alist'.
2872 If `enable-local-variables' is nil, or if the file name matches
2873 `inhibit-local-variables-regexps', this function does not check
2874 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2875 is nil, then the only mode: tag that can be relevant is a -*- one.
2877 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2878 set the major mode only if that would change it. In other words
2879 we don't actually set it to the same mode the buffer already has."
2880 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2882 end done mode modes)
2883 ;; Once we drop the deprecated feature where mode: is also allowed to
2884 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2885 ;; remove this section and just let (hack-local-variables t) handle it.
2886 ;; Find a -*- mode tag.
2890 ;; Note by design local-enable-local-variables does not matter here.
2892 try-locals
2895 ;; Find all specifications for the `mode:' variable
2896 ;; and execute them left to right.
2908 modes)))
2909 ;; Simple -*-MODE-*- case.
2912 modes))))
2913 ;; If we found modes to use, invoke them now, outside the save-excursion.
2921 ;; continuing would call minor modes again, toggling them off
2923 ;; hack-local-variables checks local-enable-local-variables etc, but
2924 ;; we might as well be explicit here for the sake of clarity.
2926 enable-local-variables
2927 local-enable-local-variables
2928 try-locals
2935 ;; If we didn't, look for an interpreter specified in the first line.
2936 ;; As a special case, allow for things like "#!/bin/env perl", which
2937 ;; finds the interpreter anywhere in $PATH.
2943 ;; Map interpreter name to a mode, signaling we're done at the
2944 ;; same time.
2951 interpreter-mode-alist)
2953 ;; If we found an interpreter mode to use, invoke it now.
2955 ;; Next try matching the buffer beginning against magic-mode-alist.
2964 nil magic-mode-alist
2973 "Problem in magic-mode-alist with element %s"
2974 re))))))))
2976 ;; Next compare the filename against the entries in auto-mode-alist.
2982 buffer-file-name)))
2983 ;; Remove backup-suffixes from file name.
2985 ;; Remove remote file name identification.
2990 ;; Find first matching alist entry.
2993 ;; Filesystem is case-insensitive.
2997 ;; Filesystem is case-sensitive.
2999 ;; First match case-sensitively.
3003 ;; Fallback to case-insensitive match.
3017 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
3034 "Problem with magic-fallback-mode-alist element: %s"
3035 re))))))))
3040 ;; When `keep-mode-if-same' is set, we are working on behalf of
3041 ;; set-visited-file-name. In that case, if the major mode specified is the
3042 ;; same one we already have, don't actually reset it. We don't want to lose
3043 ;; minor modes such as Font Lock.
3045 "Apply MODE and return it.
3046 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
3047 any aliases and compared to current major mode. If they are the
3048 same, do nothing and return nil."
3054 mode)))
3057 "Regexp of lines to skip when looking for file-local settings.
3058 If the first line matches this regular expression, then the -*-...-*- file-
3062 "Find the -*- spec in the buffer.
3063 Call with point at the place to start searching from.
3064 If one is found, set point to the beginning and return the position
3065 of the end. Otherwise, return nil; may change point.
3066 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3067 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3068 have no effect."
3071 ;; Don't look for -*- if this file name matches any
3072 ;; of the regexps in inhibit-local-variables-regexps.
3075 ;; If the file begins with "#!" (exec
3076 ;; interpreter magic), look for mode frobs
3077 ;; in the first two lines. You cannot
3078 ;; necessarily put them in the first line
3079 ;; of such a file without screwing up the
3080 ;; interpreter invocation. The same holds
3081 ;; for '\" in man pages (preprocessor
3082 ;; magic for the `man' program).
3093 end))))
3094 \f
3095 ;;; Handling file local variables
3099 file-local-variables-alist dir-local-variables-alist)
3104 "Normal hook run after processing a file's local variables specs.
3105 Major modes can use this to examine user-specified local variables
3109 "List variable-value pairs that are considered safe.
3110 Each element is a cons cell (VAR . VAL), where VAR is a variable
3111 symbol and VAL is a value that is considered safe."
3112 :risky t
3117 ;; This should be here at least as long as Emacs supports write-file-hooks.
3122 "Expressions that are considered safe in an `eval:' local variable.
3123 Add expressions to this list if you want Emacs to evaluate them, when
3124 they appear in an `eval' local variable specification, without first
3125 asking you for confirmation."
3126 :risky t
3131 ;; Risky local variables:
3134 buffer-auto-save-file-name
3135 buffer-file-name
3136 buffer-file-truename
3137 buffer-undo-list
3138 debugger
3139 default-text-properties
3140 eval
3141 exec-directory
3142 exec-path
3143 file-name-handler-alist
3144 frame-title-format
3145 global-mode-string
3146 header-line-format
3147 icon-title-format
3148 inhibit-quit
3149 load-path
3150 max-lisp-eval-depth
3151 max-specpdl-size
3152 minor-mode-map-alist
3153 minor-mode-overriding-map-alist
3154 mode-line-format
3155 mode-name
3156 overriding-local-map
3157 overriding-terminal-local-map
3158 process-environment
3159 standard-input
3160 standard-output
3161 unread-command-events))
3163 ;; Safe local variables:
3164 ;;
3165 ;; For variables defined by major modes, the safety declarations can go into
3166 ;; the major mode's file, since that will be loaded before file variables are
3167 ;; processed.
3168 ;;
3169 ;; For variables defined by minor modes, put the safety declarations in the
3170 ;; file defining the minor mode after the defcustom/defvar using an autoload
3171 ;; cookie, e.g.:
3172 ;;
3173 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3174 ;;
3175 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3176 ;; minor mode file may not be loaded yet.
3177 ;;
3178 ;; For variables defined in the C source code the declaration should go here:
3200 "Alist of file-local variable settings in the current buffer.
3201 Each element in this list has the form (VAR . VALUE), where VAR
3202 is a file-local variable (a symbol) and VALUE is the value
3203 specified. The actual value in the buffer may differ from VALUE,
3209 "Alist of directory-local variable settings in the current buffer.
3210 Each element in this list has the form (VAR . VALUE), where VAR
3211 is a directory-local variable (a symbol) and VALUE is the value
3212 specified in .dir-locals.el. The actual value in the buffer
3213 may differ from VALUE, if it is changed by the major or minor modes,
3218 "Normal hook run before setting file-local variables.
3219 It is called after checking for unsafe/risky variables and
3220 setting `file-local-variables-alist', and before applying the
3221 variables stored in `file-local-variables-alist'. A hook
3222 function is allowed to change the contents of this alist.
3224 This hook is called only if there is at least one file-local
3228 "Get confirmation before setting up local variable values.
3229 ALL-VARS is the list of all variables to be set up.
3230 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3231 RISKY-VARS is the list of those that are marked as risky.
3232 If these settings come from directory-local variables, then
3233 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3240 unsafe-vars))
3242 ;; Set up the contents of the *Local Variables* buffer.
3250 ", and variables that are risky (**)."
3258 y -- to apply the local variables list.
3262 ! -- to apply the local variables list, and permanently mark these
3274 ;; Make strings with embedded whitespace easier to read.
3282 ;; Display the buffer and read a choice.
3290 ""
3293 char)
3312 "Return local variables specified in the -*- line.
3313 Usually returns an alist of elements (VAR . VAL), where VAR is a
3314 variable and VAL is the specified value. Ignores any
3315 specification for `coding:', and sometimes for `mode' (which
3316 should have already been handled by `set-auto-coding' and
3317 `set-auto-mode', respectively). Return nil if the -*- line is
3318 malformed.
3320 If HANDLE-MODE is nil, we return the alist of all the local
3321 variables in the line except `coding' as described above. If it
3322 is neither nil nor t, we do the same, except that any settings of
3323 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3324 all settings in the line except for `mode', which \(if present) we
3325 return as the symbol specifying the mode."
3330 result)
3332 nil)
3334 ;; Simple form: "-*- MODENAME -*-".
3338 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3339 ;; (last ";" is optional).
3340 ;; If HANDLE-MODE is t, just check for `mode'.
3341 ;; Otherwise, parse the -*- line into the RESULT alist.
3349 ;; There used to be a downcase here,
3350 ;; but the manual didn't say so,
3351 ;; and people want to set var names that aren't all lc.
3357 ;; It is traditional to ignore
3358 ;; case when checking for `mode' in set-auto-mode,
3359 ;; so we must do that here as well.
3360 ;; That is inconsistent, but we're stuck with it.
3361 ;; The same can be said for `coding' in set-auto-coding.
3375 ;; Downcase "Mode:".
3378 val)
3379 result)
3382 result))))))
3385 "Filter local variable settings, querying the user if necessary.
3386 VARIABLES is the alist of variable-value settings. This alist is
3387 filtered based on the values of `ignored-local-variables',
3388 `enable-local-eval', `enable-local-variables', and (if necessary)
3389 user interaction. The results are added to
3390 `file-local-variables-alist', without applying them.
3391 If these settings come from directory-local variables, then
3392 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3393 ;; Find those variables that we may want to save to
3394 ;; `safe-local-variable-values'.
3400 ;; Ignore any variable in `ignored-local-variables'.
3401 nil)
3402 ;; Obey `enable-local-eval'.
3406 ;; In case previously marked safe (bug#5636).
3408 ;; If not safe and e-l-v = :safe, ignore totally.
3412 safe
3414 ;; Ignore duplicates (except `mode') in the present list.
3416 ;; Accept known-safe variables.
3420 ;; The variable is either risky or unsafe:
3427 ;; Query, unless all vars are safe or user wants no querying.
3433 risky-vars dir-name))
3443 ;; TODO? Warn once per file rather than once per session?
3447 "Parse and put into effect this buffer's local variables spec.
3448 Uses `hack-local-variables-apply' to apply the variables.
3450 If HANDLE-MODE is nil, we apply all the specified local
3451 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3452 except that any settings of `mode' are ignored.
3455 is specified, and return the corresponding mode symbol, or nil.
3456 In this case, we try to ignore minor-modes, and only return a
3457 major-mode.
3459 If `enable-local-variables' or `local-enable-local-variables' is nil,
3460 this function does nothing. If `inhibit-local-variables-regexps'
3461 applies to the file in question, the file is not scanned for
3462 local variables, but directory-local variables may still be applied."
3463 ;; We don't let inhibit-local-variables-p influence the value of
3464 ;; enable-local-variables, because then it would affect dir-local
3465 ;; variables. We don't want to search eg tar files for file local
3466 ;; variable sections, but there is no reason dir-locals cannot apply
3467 ;; to them. The real meaning of inhibit-local-variables-p is "do
3468 ;; not scan this file for local variables".
3471 result)
3475 ;; Note this is a no-op if enable-local-variables is nil.
3477 ;; This entire function is basically a no-op if enable-local-variables
3478 ;; is nil. All it does is set file-local-variables-alist to nil.
3480 ;; This part used to ignore enable-local-variables when handle-mode
3481 ;; was t. That was inappropriate, eg consider the
3482 ;; (artificial) example of:
3483 ;; (setq local-enable-local-variables nil)
3484 ;; Open a file foo.txt that contains "mode: sh".
3485 ;; It correctly opens in text-mode.
3486 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3488 ;; If HANDLE-MODE is t, and the prop line specifies a
3489 ;; mode, then we're done, and have no need to scan further.
3491 handle-mode))
3493 ;; Look for "Local variables:" line in last page.
3501 ;; suffix is what comes after "local variables:" in its line.
3502 ;; prefix is what comes before "local variables:" in its line.
3515 endpos
3521 nil t))
3522 ;; This used to be an error, but really all it means is
3523 ;; that this may simply not be a local-variables section,
3524 ;; so just ignore it.
3534 ;; Discard the prefix.
3539 ;; Discard the suffix.
3548 ;; Find the variable name;
3556 val val2)
3559 ;; Read the variable value.
3566 ;; Specifying minor-modes via mode: is
3567 ;; deprecated, but try to reject them anyway.
3577 'files
3579 "%s: `lexical-binding' at end of file unreliable"
3581 ;; We are called from
3582 ;; 'with-temp-buffer', so we need
3583 ;; to use 'thisbuf's name in the
3584 ;; warning message.
3590 'eval
3594 ;; Now we've read all the local variables.
3595 ;; If HANDLE-MODE is t, return whether the mode was specified.
3597 ;; Otherwise, set the variables.
3602 "Apply the elements of `file-local-variables-alist'.
3603 If there are any elements, runs `before-hack-local-variables-hook',
3604 then calls `hack-one-local-variable' to apply the alist elements one by one.
3605 Finishes by running `hack-local-variables-hook', regardless of whether
3606 the alist is empty or not.
3608 Note that this function ignores a `mode' entry if it specifies the same
3609 major mode as the buffer already has."
3611 ;; Any 'evals must run in the Right sequence.
3620 "Non-nil if SYM is safe as a file-local variable with value VAL.
3621 It is safe if any of these conditions are met:
3623 * There is a matching entry (SYM . VAL) in the
3624 `safe-local-variable-values' user option.
3626 * The `safe-local-variable' property of SYM is a function that
3627 evaluates to a non-nil value with VAL as an argument."
3631 ;; If the function signals an error, that means it
3632 ;; can't assure us that the value is safe.
3636 "Non-nil if SYM could be dangerous as a file-local variable.
3637 It is dangerous if either of these conditions are met:
3639 * Its `risky-local-variable' property is non-nil.
3645 ;; If this is an alias, check the base name.
3665 "Return t if it is safe to eval EXP when it is found in a file."
3667 ;; Detect certain `put' expressions.
3674 lisp-indent-function
3675 scheme-indent-function))
3676 ;; Only allow safe values (not functions).
3681 ;; Only allow indirect form specs.
3682 ;; During bootstrapping, edebug-basic-spec might not be
3683 ;; defined yet.
3687 ;; Allow expressions that the user requested.
3689 ;; Certain functions can be allowed with safe arguments
3690 ;; or can specify verification functions to try.
3692 ;; Allow (minor)-modes calls with no arguments.
3693 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3702 ok))
3710 ok))))))))
3724 "Set local variable VAR with value VAL.
3725 If VAR is `mode', call `VAL-mode' as a function unless it's
3726 already the major mode."
3728 (`mode
3734 (`eval
3740 ;; Make sure the string has no text properties.
3741 ;; Some text properties can get evaluated in various ways,
3742 ;; so it is risky to put them on with a local variable list.
3746 \f
3747 ;;; Handling directory-local variables, aka project settings.
3753 "List of cached directory roots for directory-local variable classes.
3754 Each element in this list has the form (DIR CLASS MTIME).
3755 DIR is the name of the directory.
3756 CLASS is the name of a variable class (a symbol).
3757 MTIME is the recorded modification time of the directory-local
3758 variables file associated with this entry. This time is a list
3759 of integers (the same format as `file-attributes'), and is
3760 used to test whether the cache entry is still valid.
3761 Alternatively, MTIME can be nil, which means the entry is always
3765 "Return the variable list for CLASS."
3769 "Collect directory-local variables from MODE-VARIABLES.
3770 VARIABLES is the initial list of variables.
3771 Returns the new list."
3776 ;; If variables are specified more than once, only use the last. (Why?)
3777 ;; The pseudo-variables mode and eval are different (bug#3430).
3780 ;; Need a new cons in case we setcdr later.
3784 "Collect entries from CLASS-VARIABLES into VARIABLES.
3785 ROOT is the root directory of the project.
3786 Return the new variables list."
3788 ;; Handle non-file buffers, too.
3792 ;; FIXME: Why not use file-relative-name?
3799 ;; Don't include this in the previous condition, because we
3800 ;; want to filter all strings before the next condition.
3814 ;; TODO someone might want to extend this to allow
3815 ;; integer values for subdir, where N means
3816 ;; variables apply to this directory and N levels
3817 ;; below it (0 == nil).
3820 alist variables))))))))
3822 ;; The file's content might be invalid (e.g. have a merge conflict), but
3823 ;; that shouldn't prevent the user from opening the file.
3825 nil))))
3828 "Declare that the DIRECTORY root is an instance of CLASS.
3829 DIRECTORY is the name of a directory, a string.
3830 CLASS is the name of a project class, a symbol.
3831 MTIME is either the modification time of the directory-local
3832 variables file that defined this class, or nil.
3834 When a file beneath DIRECTORY is visited, the mode-specific
3835 variables from CLASS are applied to the buffer. The variables
3836 for a class are defined using `dir-locals-set-class-variables'."
3843 "Map the type CLASS to a list of variable settings.
3844 CLASS is the project class, a symbol. VARIABLES is a list
3845 that declares directory-local variables for the class.
3846 An element in VARIABLES is either of the form:
3847 (MAJOR-MODE . ALIST)
3848 or
3849 (DIRECTORY . LIST)
3851 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3852 whose elements are of the form (VARIABLE . VALUE).
3854 In the second form, DIRECTORY is a directory name (a string), and
3855 LIST is a list of the form accepted by the function.
3857 When a file is visited, the file's class is found. A directory
3858 may be assigned a class using `dir-locals-set-directory-class'.
3859 Then variables are set in the file's buffer according to the
3860 VARIABLES list of the class. The list is processed in order.
3862 * If the element is of the form (MAJOR-MODE . ALIST), and the
3863 buffer's major mode is derived from MAJOR-MODE (as determined
3864 by `derived-mode-p'), then all the variables in ALIST are
3865 applied. A MAJOR-MODE of nil may be used to match any buffer.
3866 `make-local-variable' is called for each variable before it is
3867 set.
3869 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3870 is an initial substring of the file's directory, then LIST is
3871 applied by recursively following these rules."
3875 "File that contains directory-local variables.
3876 It has to be constant to enforce uniform values across different
3877 environments and users.
3878 See also `dir-locals-file-2', whose values override this one's.
3882 "File that contains directory-local variables.
3883 This essentially a second file that can be used like
3884 `dir-locals-file', so that users can have specify their personal
3885 dir-local variables even if the current directory already has a
3886 `dir-locals-file' that is shared with other users (such as in a
3887 git repository).
3891 "Return a list of all readable dir-locals files in DIRECTORY.
3892 The returned list is sorted by increasing priority. That is,
3893 values specified in the last file should take precedence over
3894 those in the first."
3898 dir-locals-file)
3899 directory))
3903 ;; The order here is important.
3910 out)))
3913 "Find the directory-local variables for FILE.
3914 This searches upward in the directory tree from FILE.
3915 It stops at the first directory that has been registered in
3916 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3917 If it finds an entry in the cache, it checks that it is valid.
3918 A cache entry with no modification time element (normally, one that
3919 has been assigned directly using `dir-locals-set-directory-class', not
3920 set from a file) is always valid.
3921 A cache entry based on a `dir-locals-file' is valid if the modification
3922 time stored in the cache matches the current file modification time.
3923 If not, the cache entry is cleared so that the file will be re-read.
3925 This function returns either:
3926 - nil (no directory local variables found),
3927 - the matching entry from `dir-locals-directory-cache' (a list),
3928 - or the full path to the directory (a string) containing at
3929 least one `dir-locals-file' in the case of no valid cache
3930 entry."
3934 dir-elt)
3935 ;; `locate-dominating-file' may have abbreviated the name.
3938 ;; Find the best cached value in `dir-locals-directory-cache'.
3949 ;; Found a potential cache entry. Check validity.
3950 ;; A cache entry with no MTIME is assumed to always be valid
3951 ;; (ie, set directly, not from a dir-locals file).
3952 ;; Note, we don't bother to check that there is a matching class
3953 ;; element in dir-locals-class-alist, since that's done by
3954 ;; dir-locals-set-directory-class.
3957 ;; The entry MTIME should match the most recent
3958 ;; MTIME among matching files.
3964 cached-files))))))
3965 ;; This cache entry is OK.
3966 dir-elt
3967 ;; This cache entry is invalid; clear it.
3970 ;; Return the first existing dir-locals file. Might be the same
3971 ;; as dir-elt's, might not (eg latter might have been deleted).
3972 locals-dir)
3973 ;; No cache entry.
3974 locals-dir)))
3977 "Load all variables files in DIR and register a new class and instance.
3978 DIR is the absolute name of a directory which must contain at
3979 least one dir-local file (which is a file holding variables to
3980 apply).
3981 Return the new class name, which is a symbol named DIR."
3995 variables
4001 dir class-name
4006 files))
4007 ;; If there was a problem, use the values we could get but
4008 ;; don't let the cache prevent future reads.
4010 class-name))
4016 "Non-nil means dir-local variables will be applied to remote files."
4024 "Read per-directory local variables for the current buffer.
4025 Store the directory-local variables in `dir-local-variables-alist'
4026 and `file-local-variables-alist', without applying them.
4028 This does nothing if either `enable-local-variables' or
4029 `enable-dir-local-variables' are nil."
4031 enable-dir-local-variables
4034 default-directory)))))
4035 ;; Find the variables file.
4065 "Apply directory-local variables to a non-file buffer.
4066 For non-file buffers, such as Dired buffers, directory-local
4067 variables are looked for in `default-directory' and its parent
4068 directories."
4072 \f
4075 However, the mode will not be changed if
4076 \(1) a local variables list or the `-*-' line specifies a major mode, or
4078 not suitable for ordinary files, or
4079 \(3) the new file name does not particularly specify any mode."
4084 "Change name of file visited in current buffer to FILENAME.
4085 This also renames the buffer to correspond to the new file.
4086 The next time the buffer is saved it will go in the newly specified file.
4087 FILENAME nil or an empty string means mark buffer as not visiting any file.
4088 Remember to delete the initial contents of the minibuffer
4089 if you wish to pass an empty string as the argument.
4091 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4092 confirmation in the case where another buffer is already visiting FILENAME.
4094 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4095 the old visited file has been renamed to the new name FILENAME."
4103 nil
4118 filename)))
4125 buffer-file-name filename)
4129 ;; If new-name == old-name, renaming would add a spurious <2>
4130 ;; and it's considered as a feature in rename-buffer.
4136 ;; Abbreviate the file names of the buffer.
4145 nil))
4146 ;; write-file-functions is normally used for things like ftp-find-file
4147 ;; that visit things that are not local files as if they were files.
4148 ;; Changing to visit an ordinary local file instead should flush the hook.
4153 ;; If buffer was read-only because of version control,
4154 ;; that reason is gone now, so make it writable.
4158 ;; Turn off backup files for certain file names.
4159 ;; Since this is a permanent local, the major mode won't eliminate it.
4161 backup-enable-predicate
4170 ;; If auto-save was not already on, turn it on if appropriate.
4173 ;; If auto save is on, start using a new name. We
4174 ;; deliberately don't rename or delete the old auto save
4175 ;; for the old visited file name. This is because
4176 ;; perhaps the user wants to save the new state and then
4177 ;; compare with the previous state from the auto save
4178 ;; file.
4180 ;; Rename the old auto save file if any.
4187 ;; Update the major mode, if the file name determines it.
4189 ;; Don't change the mode if it is special.
4192 ;; Don't change the mode if the local variable list specifies it.
4193 ;; The file name can influence whether the local variables apply.
4195 ;; h-l-v also checks it, but might as well be explicit.
4198 ;; TODO consider making normal-mode handle this case.
4206 "Write current buffer into file FILENAME.
4207 This makes the buffer visit that file, and marks it as not modified.
4209 If you specify just a directory name as FILENAME, that means to use
4210 the default file name but in that directory. You can also yank
4211 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4213 If the buffer is not already visiting a file, the default file name
4214 for the output file is the buffer name.
4216 If optional second arg CONFIRM is non-nil, this function
4217 asks for confirmation before overwriting an existing file.
4218 Interactively, confirmation is required unless you supply a prefix argument."
4219 ;; (interactive "FWrite file: ")
4223 nil nil nil nil)
4227 default-directory)
4228 nil nil))
4232 ;; If arg is just a directory,
4233 ;; use the default file name, but in that directory.
4240 ;; NS does its own confirm dialog.
4243 use-dialog-box))
4249 ;; Make buffer writable if file is writable.
4254 ;; It's likely that the VC status at the new location is different from
4255 ;; the one at the old location.
4257 \f
4259 "Return an alist of extended attributes of file FILENAME.
4261 Extended attributes are platform-specific metadata about the file,
4262 such as SELinux context, list of ACL entries, etc."
4267 "Set extended attributes of file FILENAME to ATTRIBUTES.
4269 ATTRIBUTES must be an alist of file attributes as returned by
4270 `file-extended-attributes'.
4271 Value is t if the function succeeds in setting the attributes."
4282 result))
4283 \f
4285 "Make a backup of the disk file visited by the current buffer, if appropriate.
4286 This is normally done before saving the buffer the first time.
4288 A backup may be done by renaming or by copying; see documentation of
4289 variable `make-backup-files'. If it's done by renaming, then the file is
4290 no longer accessible under its old name.
4292 The value is non-nil after a backup was made by renaming.
4293 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4294 MODES is the result of `file-modes' on the original
4295 file; this means that the caller, after saving the buffer, should change
4296 the modes of the new file to agree with the old modes.
4297 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4298 on the original file; this means that the caller, after saving
4299 the buffer, should change the extended attributes of the new file
4300 to agree with the old attributes.
4301 BACKUPNAME is the backup file name, which is the old file renamed."
4305 ;; If specified name is a symbolic link, chase it to the target.
4306 ;; This makes backups in the directory where the real file is.
4313 ;; If have old versions to maybe delete,
4314 ;; ask the user to confirm now, before doing anything.
4315 ;; But don't actually delete til later.
4321 real-file-name)))
4322 targets))
4327 backup-by-copying-when-privileged-mismatch)
4330 ;; Don't rename a suid or sgid file.
4339 real-file-name
4342 copy-when-priv-mismatch))))
4344 t)))))
4345 setmodes)
4348 ;; Actually make the backup file.
4351 modes extended-attributes)
4352 ;; rename-file should delete old backup.
4355 backupname)))
4357 ;; Now delete the old versions, if desired.
4361 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4365 backupname)
4368 modes extended-attributes)
4370 setmodes)))))))
4373 ;; Create temp files with strict access rights. It's easy to
4374 ;; loosen them later, whereas it's impossible to close the
4375 ;; time-window of loose permissions otherwise.
4378 ;; Try to overwrite old backup first.
4386 nil)
4388 ;; The file was somehow created by someone else between
4389 ;; `delete-file' and `copy-file', so let's try again.
4390 ;; rms says "I think there is also a possible race
4391 ;; condition for making backup files" (emacs-devel 20070821).
4392 nil)))
4393 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4402 ;; The last ~[[:digit]]+ matches relative versions in git,
4403 ;; e.g. `foo.js.~HEAD~1~'.
4404 "Regular expression matching the backup/version part of a file name.
4408 "Return file NAME sans backup versions or strings.
4409 This is a separate procedure so your site-init or startup file can
4410 redefine it.
4411 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4412 we do not remove backup version numbers, only true file version numbers.
4413 See also `file-name-version-regexp'."
4420 name))))))
4423 "Return t if deleting FILE and rewriting it would preserve the owner.
4424 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4425 the group would be preserved too."
4430 ;; Return t if the file doesn't exist, since it's true that no
4431 ;; information would be lost by an (attempted) delete and create.
4434 ;; Files created on Windows by Administrator (RID=500)
4435 ;; have the Administrators group (RID=544) recorded as
4436 ;; their owner. Rewriting them will still preserve the
4437 ;; owner.
4441 ;; On BSD-derived systems files always inherit the parent
4442 ;; directory's group, so skip the group-gid test.
4448 ;; On some systems, a file created in a setuid directory
4449 ;; inherits that directory's owner.
4453 ;; On many systems, a file created in a setgid directory
4454 ;; inherits that directory's group. On some systems
4455 ;; this happens even if the setgid bit is not set.
4462 The extension, in a file name, is the part that begins with the last `.',
4463 except that a leading `.' of the file name, if there is one, doesn't count."
4466 directory)
4470 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4471 ;; we don't want to expand it.
4474 filename))))
4478 The extension, in a file name, is the part that begins with the last `.',
4479 excluding version numbers and backup suffixes, except that a leading `.'
4480 of the file name, if there is one, doesn't count.
4481 Return nil for extensionless file names such as `foo'.
4482 Return the empty string for file names such as `foo.'.
4484 By default, the returned value excludes the period that starts the
4485 extension, but if the optional argument PERIOD is non-nil, the period
4486 is included in the value, and in that case, if FILENAME has no
4497 "Return the base name of the FILENAME: no directory, no extension.
4498 FILENAME defaults to `buffer-file-name'."
4503 #'make-backup-file-name--default-function
4504 "A function that `make-backup-file-name' uses to create backup file names.
4505 The function receives a single argument, the original file name.
4507 If you change this, you may need to change `backup-file-name-p' and
4508 `file-name-sans-versions' too.
4510 You could make this buffer-local to do something special for specific files.
4512 For historical reasons, a value of nil means to use the default function.
4513 This should not be relied upon.
4515 See also `backup-directory-alist'."
4522 "Alist of filename patterns and backup directory names.
4523 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4524 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4525 relative or absolute. If it is absolute, so that all matching files
4526 are backed up into the same directory, the file names in this
4527 directory will be the full name of the file backed up with all
4528 directory separators changed to `!' to prevent clashes. This will not
4529 work correctly if your filesystem truncates the resulting name.
4531 For the common case of all backups going into one directory, the alist
4533 directory name.
4535 If this variable is nil, or it fails to match a filename, the backup
4536 is made in the original file's directory.
4538 On MS-DOS filesystems without long names this variable is always
4539 ignored."
4545 "Default `backup-enable-predicate' function.
4546 Checks for files in `temporary-file-directory',
4549 caseless)
4550 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4551 ;; their long file-name equivalents, so compare-strings does TRT.
4555 caseless t))
4558 ;; Directory is under temporary-file-directory.
4563 ;; Directory is under /tmp.
4568 0 nil
4570 ;; Directory is under small-temporary-file-directory.
4575 "Create the non-numeric backup file name for FILE.
4576 This calls the function that `make-backup-file-name-function' specifies,
4577 with a single argument FILE."
4580 file))
4583 "Default function for `make-backup-file-name'.
4584 Normally this just returns FILE's name with `~' appended.
4585 It searches for a match for FILE in `backup-directory-alist'.
4586 If the directory for the backup doesn't exist, it is created."
4598 "Subroutine of `make-backup-file-name--default-function'.
4599 The function `find-backup-file-name' also uses this."
4601 elt backup-directory abs-backup-directory)
4606 alist nil)))
4607 ;; If backup-directory is relative, it should be relative to the
4608 ;; file's directory. By expanding explicitly here, we avoid
4609 ;; depending on default-directory.
4618 abs-backup-directory nil))))
4620 file
4624 ;; Normalize DOSish file names: downcase the drive
4625 ;; letter, if any, and replace the leading "x:" with
4626 ;; "/drive_x".
4629 ;; Replace any invalid file-name characters (for the
4630 ;; case of backing up remote files).
4634 "drive_"
4637 ""
4640 ;; Make the name unique by substituting directory
4641 ;; separators. It may not really be worth bothering about
4642 ;; doubling `!'s in the original name...
4647 backup-directory))
4652 "Return non-nil if FILE is a backup file name (numeric or not).
4653 This is a separate function so you can redefine it for customization.
4654 You may need to redefine `file-name-sans-versions' as well."
4659 ;; This is used in various files.
4660 ;; The usage of backup-extract-version-start is not very clean,
4661 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4663 "Given the name of a numeric backup file, FN, return the backup number.
4664 Uses the free variable `backup-extract-version-start', whose value should be
4665 the index in the name where the version number begins."
4672 "Find a file name for a backup file FN, and suggestions for deletions.
4673 Value is a list whose car is the name for the backup file
4674 and whose cdr is a list of old versions to consider deleting now.
4675 If the value is nil, don't make a backup.
4676 Uses `backup-directory-alist' in the same way as
4677 `make-backup-file-name--default-function' does."
4679 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4683 ;; We don't support numbered backups on plain MS-DOS
4684 ;; when long file names are unavailable.
4694 possibilities deserve-versions-p versions)
4697 base-versions
4700 possibilities)
4701 #'<)
4706 kept-old-versions
4707 kept-new-versions
4714 ;; Delete nothing if there is overflow
4715 ;; in the number of versions to keep.
4721 v))))))))))
4724 "Return number of names file FILENAME has."
4727 ;; (defun file-relative-name (filename &optional directory)
4728 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4729 ;; This function returns a relative file name which is equivalent to FILENAME
4730 ;; when used with that default directory as the default.
4731 ;; If this is impossible (which can happen on MSDOS and Windows
4732 ;; when the file name and directory use different drive names)
4733 ;; then it returns FILENAME."
4734 ;; (save-match-data
4735 ;; (let ((fname (expand-file-name filename)))
4736 ;; (setq directory (file-name-as-directory
4737 ;; (expand-file-name (or directory default-directory))))
4738 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4739 ;; ;; drive names, they can't be relative, so return the absolute name.
4740 ;; (if (and (or (eq system-type 'ms-dos)
4741 ;; (eq system-type 'cygwin)
4742 ;; (eq system-type 'windows-nt))
4743 ;; (not (string-equal (substring fname 0 2)
4744 ;; (substring directory 0 2))))
4745 ;; filename
4746 ;; (let ((ancestor ".")
4747 ;; (fname-dir (file-name-as-directory fname)))
4748 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4749 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4750 ;; (setq directory (file-name-directory (substring directory 0 -1))
4751 ;; ancestor (if (equal ancestor ".")
4752 ;; ".."
4753 ;; (concat "../" ancestor))))
4754 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4755 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4756 ;; ;; We matched within FNAME's directory part.
4757 ;; ;; Add the rest of FNAME onto ANCESTOR.
4758 ;; (let ((rest (substring fname (match-end 0))))
4759 ;; (if (and (equal ancestor ".")
4760 ;; (not (equal rest "")))
4761 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4762 ;; rest
4763 ;; (concat (file-name-as-directory ancestor) rest)))
4764 ;; ;; We matched FNAME's directory equivalent.
4765 ;; ancestor))))))
4768 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4769 This function returns a relative file name which is equivalent to FILENAME
4770 when used with that default directory as the default.
4771 If FILENAME is a relative file name, it will be interpreted as existing in
4772 `default-directory'.
4773 If FILENAME and DIRECTORY lie on different machines or on different drives
4774 on a DOS/Windows machine, it returns FILENAME in expanded form."
4778 default-directory))))
4783 read-file-name-completion-ignore-case)))
4786 ;; Test for different filesystems on DOS/Windows
4788 ;; Should `cygwin' really be included here? --stef
4791 ;; Test for different drive letters
4793 ;; Test for UNCs on different servers
4798 ;; Windows file names cannot have ? in
4799 ;; them, so use that to detect when
4800 ;; neither FILENAME nor DIRECTORY is a
4801 ;; UNC.
4803 0 nil
4809 ;; Test for different remote file system identification
4811 filename
4819 ".."
4821 ;; Now ancestor is empty, or .., or ../.., etc.
4823 ;; We matched within FILENAME's directory part.
4824 ;; Add the rest of FILENAME onto ANCESTOR.
4827 ;; But don't bother with ANCESTOR if it would give us `./'.
4828 rest
4830 ;; We matched FILENAME's directory equivalent.
4831 ancestor))))))
4832 \f
4834 "Save current buffer in visited file if modified.
4835 Variations are described below.
4837 By default, makes the previous version into a backup file
4838 if previously requested or if this is the first save.
4840 to become a backup when the next save is done.
4842 makes the previous version into a backup file.
4844 to become a backup when the next save is done,
4845 and makes the previous version into a backup file.
4847 With a numeric prefix argument of 0, never make the previous version
4848 into a backup file.
4850 Note that the various variables that control backups, such
4851 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4852 and `backup-inhibited', to name just the more popular ones, still
4853 control whether a backup will actually be produced, even when you
4856 If a file's name is FOO, the names of its numbered backup versions are
4857 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4858 Numeric backups (rather than FOO~) will be made if value of
4859 `version-control' is not the atom `never' and either there are already
4860 numeric versions of the file being backed up, or `version-control' is
4861 non-nil.
4862 We don't want excessive versions piling up, so there are variables
4863 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4864 and `kept-new-versions', which tells how many newest versions to keep.
4865 Defaults are 2 old versions and 2 new.
4866 `dired-kept-versions' controls dired's clean-directory (.) command.
4867 If `delete-old-versions' is nil, system will query user
4868 before trimming versions. Otherwise it does it silently.
4870 If `vc-make-backup-files' is nil, which is the default,
4871 no backup files are made for files managed by version control.
4872 (This is because the version control system itself records previous versions.)
4874 See the subroutine `basic-save-buffer' for more information."
4880 ;; We used to display the message below only for files > 50KB, but
4881 ;; then Rmail-mbox never displays it due to buffer swapping. If
4882 ;; the test is ever re-introduced, be sure to handle saving of
4883 ;; Rmail files.
4893 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4894 Normally delete only if the file was written by this Emacs since
4895 the last real save, but optional arg FORCE non-nil means delete anyway."
4909 "Normal hook that is run before a buffer is saved to its file.
4910 Only used by `save-buffer'."
4916 "Normal hook that is run after a buffer is saved to its file.
4917 Only used by `save-buffer'."
4923 "If non-nil, use this coding system for saving the buffer.
4924 More precisely, use this coding system in place of the
4925 value of `buffer-file-coding-system', when saving the buffer.
4926 Calling `write-region' for any purpose other than saving the buffer
4927 will still use `buffer-file-coding-system'; this variable has no effect
4934 "Save the current buffer in its visited file, if it has been modified.
4935 The hooks `write-contents-functions' and `write-file-functions' get a chance
4936 to do the job of saving; if they do not, then the buffer is saved in
4937 the visited file in the usual way.
4938 Before and after saving the buffer, this function runs
4939 `before-save-hook' and `after-save-hook', respectively."
4942 ;; In an indirect buffer, save its base buffer instead.
4946 ;; handle the case when no modification has been made but
4947 ;; the file disappeared since visited
4951 setmodes)
4952 ;; If buffer has no file name, ask user for one.
4960 ;; Signal an error if the user specified the name of an
4961 ;; existing directory.
4964 "File `%s' exists; overwrite? "
4965 filename))
4972 "%s has changed since visited or saved. Save anyway? "
4992 ;; Support VC version backups.
4994 ;; Don't let errors prevent saving the buffer.
4999 ;; If a hook returned t, file is already "written".
5000 ;; Otherwise, write it the usual way now.
5010 ;; Now we have saved the current buffer. Let's make sure
5011 ;; that buffer-file-coding-system is fixed to what
5012 ;; actually used for saving by binding it locally.
5027 ;; If the auto-save file was recent before this command,
5028 ;; delete it now.
5030 ;; Support VC `implicit' locking.
5037 ;; This does the "real job" of writing a buffer into its visited file
5038 ;; and making a backup file. This is what is normally done
5039 ;; but inhibited if one of write-file-functions returns non-nil.
5040 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5041 ;; backup-buffer.
5051 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5052 ;; backup-buffer.
5065 "File %s is write-protected; try to save anyway? "
5067 buffer-file-name)))
5081 dir))))
5082 ;; Write temp name, then rename it.
5083 ;; This requires write access to the containing dir,
5084 ;; which is why we don't try it if we don't have that access.
5086 tempname succeed
5089 ;; Create temp files with strict access rights. It's easy to
5090 ;; loosen them later, whereas it's impossible to close the
5091 ;; time-window of loose permissions otherwise.
5096 ;; Try various temporary names.
5097 ;; This code follows the example of make-temp-file,
5098 ;; but it calls write-region in the appropriate way
5099 ;; for saving the buffer.
5105 ;; Pass in nil&nil rather than point-min&max
5106 ;; cause we're saving the whole buffer.
5107 ;; write-region-annotate-functions may use it.
5109 tempname nil realname
5112 nil)
5114 ;; The file was somehow created by someone else between
5115 ;; `make-temp-name' and `write-region', let's try again.
5116 nil)
5118 ;; Reset the umask.
5120 ;; If we failed, restore the buffer's modtime.
5123 ;; Since we have created an entirely new file,
5124 ;; make sure it gets the right permission bits set.
5129 buffer-file-name)))
5130 ;; We succeeded in writing the temp file,
5131 ;; so rename it.
5133 ;; If file not writable, see if we can make it writable
5134 ;; temporarily while we write it.
5135 ;; But no need to do so if we have just backed it up
5136 ;; (setmodes is set) because that says we're superseding.
5138 ;; Change the mode back, after writing.
5141 buffer-file-name))
5142 ;; If set-file-extended-attributes fails, fall back on
5143 ;; set-file-modes.
5153 ;; Pass in nil&nil rather than point-min&max to indicate
5154 ;; we're saving the buffer rather than just a region.
5155 ;; write-region-annotate-functions may make us of it.
5157 buffer-file-name nil t buffer-file-truename)
5160 ;; If we get an error writing the new file, and we made
5161 ;; the backup by renaming, undo the backing-up.
5166 setmodes))
5172 `((?\C-r
5179 ;; Return nil to ask about BUF again.
5180 nil)
5193 ;; Return nil to ask about BUF again.
5194 nil)
5204 "Default predicate for `save-some-buffers'.
5205 This allows you to stop `save-some-buffers' from asking
5206 about certain files that you'd usually rather not save."
5212 "Save some modified file-visiting buffers. Asks user about each one.
5213 You can answer `y' to save, `n' not to save, `C-r' to look at the
5214 buffer in question with `view-buffer' before deciding or `d' to
5215 view the differences using `diff-buffer-with-file'.
5217 This command first saves any buffers where `buffer-save-without-query' is
5218 non-nil, without asking.
5220 Optional argument (the prefix) non-nil means save all with no questions.
5221 Optional second argument PRED determines which buffers are considered:
5222 If PRED is nil, all the file-visiting buffers are considered.
5223 If PRED is t, then certain non-file buffers will also be considered.
5224 If PRED is a zero-argument function, it indicates for each buffer whether
5225 to consider it or not when called with that buffer current.
5226 PRED defaults to the value of `save-some-buffers-default-predicate'.
5228 See `save-some-buffers-action-alist' if you want to
5229 change the additional actions you can take on files."
5235 files-done abbrevs-done)
5237 ;; First save any buffers that we're supposed to save unconditionally.
5238 ;; That way the following code won't ask about them.
5243 ;; Ask about those buffers that merit it,
5244 ;; and record the number thus saved.
5248 ;; Note that killing some buffers may kill others via
5249 ;; hooks (e.g. Rmail and its viewing buffer).
5262 t
5274 save-some-buffers-action-alist))
5275 ;; Maybe to save abbrevs, and record whether
5276 ;; we either saved them or asked to.
5283 ;; Don't keep bothering user if he says no.
5297 \f
5299 "Clear out records of last mod time of visited file.
5300 Next attempt to save will not complain of a discrepancy."
5304 "Mark current buffer as unmodified, not needing to be saved.
5307 It is not a good idea to use this function in Lisp programs, because it
5308 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5316 "Change whether this buffer is read-only."
5324 "Insert contents of file FILENAME into buffer after point.
5325 Set mark after the inserted text.
5327 This function is meant for the user to run interactively.
5328 Don't call it from programs! Use `insert-file-contents' instead.
5329 \(Its calling sequence is different; see its documentation)."
5335 "Append the contents of the region to the end of file FILENAME.
5336 When called from a function, expects three arguments,
5337 START, END and FILENAME. START and END are normally buffer positions
5338 specifying the part of the buffer to write.
5339 If START is nil, that means to use the entire buffer contents.
5340 If START is a string, then output that string to the file
5341 instead of any buffer contents; END is ignored.
5343 This does character code conversion and applies annotations
5344 like `write-region' does."
5350 "Return most recent backup file for FILENAME or nil if no backups exist."
5351 ;; `make-backup-file-name' will get us the right directory for
5352 ;; ordinary or numeric backups. It might create a directory for
5353 ;; backups as a side-effect, according to `backup-directory-alist'.
5360 tem)
5369 newest))
5372 "Rename current buffer to a similar name not already taken.
5373 This function is useful for creating multiple shell process buffers
5374 or multiple mail buffers, etc.
5376 Note that some commands, in particular those based on `compilation-mode'
5377 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5378 appropriate mode even if it has been renamed. So as well as renaming
5379 the buffer, you also need to switch buffers before running another
5380 instance of such commands."
5388 ;; If the existing buffer name has a <NNN>,
5389 ;; which isn't part of the file name (if any),
5390 ;; then get rid of that.
5396 "Create the directory DIR and optionally any nonexistent parent dirs.
5397 If DIR already exists as a directory, signal an error, unless
5398 PARENTS is non-nil.
5400 Interactively, the default choice of directory to create is the
5401 current buffer's default directory. That is useful when you have
5402 visited a file in a nonexistent directory.
5404 Noninteractively, the second (optional) argument PARENTS, if
5405 non-nil, says whether to create parent directories that don't
5406 exist. Interactively, this happens by default.
5408 If creating the directory or directories fail, an error will be
5409 raised."
5412 nil nil)
5413 t))
5414 ;; If default-directory is a remote directory,
5415 ;; make sure we find its make-directory handler.
5423 create-list)
5425 ;; If directory is its own parent, then we can't
5426 ;; keep looping forever
5441 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5442 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5443 non-nil and if FN fails due to a missing file or directory."
5449 "Delete the directory named DIRECTORY. Does not follow symlinks.
5450 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5451 no error if something else is simultaneously deleting them.
5452 TRASH non-nil means to trash the directory instead, provided
5453 `delete-by-moving-to-trash' is non-nil.
5455 When called interactively, TRASH is nil if and only if a prefix
5456 argument is given, and a further prompt asks the user for
5457 RECURSIVE if DIRECTORY is nonempty."
5464 "Move directory to trash: "
5466 default-directory default-directory nil nil))))
5472 nil)
5474 ;; If default-directory is a remote directory, make sure we find its
5475 ;; delete-directory handler.
5482 ;; Only move non-empty dir to trash if recursive deletion was
5483 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5484 ;; case, where the operation fails in delete-directory-internal.
5485 ;; As `move-file-to-trash' trashes directories (empty or
5486 ;; otherwise) as a unit, we do not need to recurse here.
5488 ;; Check if directory is empty apart from "." and "..".
5493 ;; Otherwise, call ourselves recursively if needed.
5498 directory-files-no-dot-files-regexp))
5502 ;; This test is equivalent to but more efficient
5503 ;; than (and (file-directory-p fn)
5504 ;; (not (file-symlink-p fn))).
5508 files))
5509 directory-exists))
5513 "Return non-nil if files FILE1 and FILE2 name the same file.
5514 If FILE1 or FILE2 does not exist, the return value is unspecified."
5525 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5527 Return nil if DIR is not an existing directory."
5539 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5554 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5555 This function always sets the file modes of the output files to match
5556 the corresponding input file.
5558 The third arg KEEP-TIME non-nil means give the output files the same
5559 last-modified time as the old ones. (This works on only some systems.)
5561 A prefix arg makes KEEP-TIME non-nil.
5563 Noninteractively, the last argument PARENTS says whether to
5564 create parent directories if they don't exist. Interactively,
5565 this happens by default.
5567 If NEWNAME names an existing directory, copy DIRECTORY as a
5568 subdirectory there. However, if called from Lisp with a non-nil
5569 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5570 directly into NEWNAME instead."
5577 default-directory default-directory nil nil)
5578 current-prefix-arg t nil)))
5581 directory newname))
5582 ;; If default-directory is a remote directory, make sure we find its
5583 ;; copy-directory handler.
5588 newname keep-time parents copy-contents)
5590 ;; Compute target name.
5595 ;; If NEWNAME is not an existing directory, create it;
5596 ;; that is where we will copy the files of DIRECTORY.
5598 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5599 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5604 newname))
5608 newname))
5611 ;; Copy recursively.
5613 ;; We do not want to copy "." and "..".
5615 directory-files-no-dot-files-regexp))
5625 ;; Set directory attributes.
5631 \f
5632 ;; At time of writing, only info uses this.
5634 "Return a copy of DIRS with all non-existent directories removed.
5635 The optional argument KEEP is a list of directories to retain even if
5636 they don't exist, and REJECT is a list of directories to remove from
5637 DIRS, even if they exist; REJECT takes precedence over KEEP.
5639 Note that membership in REJECT and KEEP is checked using simple string
5640 comparison."
5646 dirs)))
5648 \f
5651 "Function to use to revert this buffer.
5652 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5653 which are the arguments that `revert-buffer' received.
5654 It also has access to the `preserve-modes' argument of `revert-buffer'
5655 via the `revert-buffer-preserve-modes' dynamic variable.
5657 For historical reasons, a value of nil means to use the default function.
5662 #'revert-buffer-insert-file-contents--default-function
5663 "Function to use to insert contents when reverting this buffer.
5664 The function receives two arguments: the first the nominal file name to use;
5665 the second is t if reading the auto-save file.
5667 The function is responsible for updating (or preserving) point.
5669 For historical reasons, a value of nil means to use the default function.
5673 "Default function to use for `buffer-stale-function'.
5674 This function ignores its argument.
5675 This returns non-nil if the current buffer is visiting a readable file
5676 whose modification time does not match that of the buffer.
5678 This function only handles buffers that are visiting files.
5679 Non-file buffers need a custom function"
5686 "Function to check whether a buffer needs reverting.
5687 This should be a function with one optional argument NOCONFIRM.
5688 Auto Revert Mode passes t for NOCONFIRM. The function should return
5689 non-nil if the buffer should be reverted. A return value of
5690 `fast' means that the need for reverting was not checked, but
5691 that reverting the buffer is fast. The buffer is current when
5692 this function is called.
5694 The idea behind the NOCONFIRM argument is that it should be
5695 non-nil if the buffer is going to be reverted without asking the
5696 user. In such situations, one has to be careful with potentially
5697 time consuming operations.
5699 For historical reasons, a value of nil means to use the default function.
5700 This should not be relied upon.
5702 For more information on how this variable is used by Auto Revert mode,
5706 "Normal hook for `revert-buffer' to run before reverting.
5707 The function `revert-buffer--default' runs this.
5711 "Normal hook for `revert-buffer' to run after reverting.
5712 Note that the hook value that it runs is the value that was in effect
5713 before reverting; that makes a difference if you have buffer-local
5714 hook functions.
5716 The function `revert-buffer--default' runs this.
5724 ;; `revert-buffer-function' was defined long ago to be a function of only
5725 ;; 2 arguments, so we have to use a dynbind variable to pass the
5726 ;; `preserve-modes' argument of `revert-buffer'.
5730 "Replace current buffer text with the text of the visited file on disk.
5731 This undoes all changes since the file was visited or saved.
5732 With a prefix argument, offer to revert from latest auto-save file, if
5733 that is more recent than the visited file.
5735 This command also implements an interface for special buffers
5736 that contain text which doesn't come from a file, but reflects
5737 some other data instead (e.g. Dired buffers, `buffer-list'
5738 buffers). This is done via the variable `revert-buffer-function'.
5739 In these cases, it should reconstruct the buffer contents from the
5740 appropriate data.
5742 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5743 to revert from the auto-save file when this is nil. Note that the
5744 sense of this argument is the reverse of the prefix argument, for the
5745 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5746 to nil.
5748 Optional second argument NOCONFIRM means don't ask for confirmation
5749 at all. (The variable `revert-without-query' offers another way to
5750 revert buffers without querying for confirmation.)
5752 Optional third argument PRESERVE-MODES non-nil means don't alter
5753 the files modes. Normally we reinitialize them using `normal-mode'.
5755 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5757 This function calls the function that `revert-buffer-function' specifies
5758 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5759 The default function runs the hooks `before-revert-hook' and
5760 `after-revert-hook'."
5761 ;; I admit it's odd to reverse the sense of the prefix argument, but
5762 ;; there is a lot of code out there which assumes that the first
5763 ;; argument should be t to avoid consulting the auto-save file, and
5764 ;; there's no straightforward way to encourage authors to notice a
5765 ;; reversal of the argument sense. So I'm just changing the user
5766 ;; interface, but leaving the programmatic interface the same.
5771 ignore-auto noconfirm)))
5774 "Default function for `revert-buffer'.
5775 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5776 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5777 start and end.
5779 Calls `revert-buffer-insert-file-contents-function' to reread the
5780 contents of the visited file, with two arguments: the first is the file
5781 name, the second is non-nil if reading an auto-save file.
5783 This function only handles buffers that are visiting files.
5784 Non-file buffers need a custom function."
5789 buffer-auto-save-file-name
5794 buffer-auto-save-file-name
5795 buffer-file-name)))
5805 file-name)))
5807 ;; If file was backed up but has changed since,
5808 ;; we should make another backup.
5812 ;; Effectively copy the after-revert-hook status,
5813 ;; since after-find-file will clobber it.
5816 after-revert-hook))
5818 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5822 file-name auto-save-p)
5823 ;; Recompute the truename in case changes in symlinks
5824 ;; have changed the truename.
5828 ;; Run after-revert-hook as it was before we reverted.
5832 local-hook)
5835 t)))))
5838 "Default function for `revert-buffer-insert-file-contents-function'.
5839 The function `revert-buffer--default' calls this.
5840 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5841 an auto-save file."
5845 "File %s no longer exists!"
5847 file-name))
5850 "File %s no longer readable!"
5852 file-name))
5854 ;; Bind buffer-file-name to nil
5855 ;; so that we don't try to lock the file.
5861 ;; Auto-saved file should be read by Emacs's
5862 ;; internal coding.
5866 buffer-file-coding-system-explicit
5869 coding-system-for-read
5871 coding-system-for-read)
5873 ;; As a coding system suitable for multibyte
5874 ;; buffer is specified, make the current
5875 ;; buffer multibyte.
5878 ;; This force after-insert-file-set-coding
5879 ;; (called from insert-file-contents) to set
5880 ;; buffer-file-coding-system to a proper value.
5883 ;; Note that this preserves point in an intelligent way.
5887 nil nil t))
5889 nil nil t))))))
5892 "Recover the visited file--get contents from its last auto-save file."
5899 "Visit file FILE, but get contents from its last auto-save file."
5900 ;; Actually putting the file name in the minibuffer should be used
5901 ;; only rarely.
5902 ;; Not just because users often use the default.
5915 "*Directory*" nil
5926 ;; Use insert-directory-safely, not insert-directory,
5927 ;; because these files might not exist. In particular,
5928 ;; FILE might not exist if the auto-save file was for
5929 ;; a buffer that didn't visit a file, such as "*mail*".
5930 ;; The code in v20.x called `ls' directly, so we need
5931 ;; to emulate what `ls' did in that case.
5936 ;; Keep the current buffer-file-coding-system.
5938 ;; Auto-saved file should be read with special coding.
5947 "Recover auto save files from a previous Emacs session.
5948 This command first displays a Dired buffer showing you the
5949 previous sessions that you could recover from.
5950 To choose one, move point to the proper line and then type C-c C-c.
5951 Then you'll be asked about a number of files to recover."
5961 directory-files-no-dot-files-regexp
5963 t)
5974 ;; Each line starts with a space
5975 ;; so that Font Lock mode won't highlight the first character.
5978 " To delete a session file, type \
5984 "Choose one saved session to recover auto-save files from.
5985 This command is used in the special Dired buffer created by
5988 ;; Get the name of the session file to recover from.
5990 files
5996 ;; Read in the auto-save-list file.
5999 ;; Loop thru the text of that file
6000 ;; and get out the names of the files to recover.
6004 ;; This is a pair of lines for a non-file-visiting buffer.
6005 ;; Get the auto-save file name and manufacture
6006 ;; a "visited file name" from that.
6009 ;; If there is no auto-save file name, the
6010 ;; auto-save-list file is probably corrupted.
6023 ;; This pair of lines is a file-visiting
6024 ;; buffer. Use the visited file name.
6034 ;; Ignore a file if its auto-save file does not exist now.
6038 ;; The file contains a pair of line for each auto-saved buffer.
6039 ;; The first line of the pair contains the visited file name
6040 ;; or is empty if the buffer was not visiting a file.
6041 ;; The second line is the auto-save file name.
6049 files
6055 "Kill BUFFER if confirmed."
6063 "Kill some buffers. Asks the user whether to kill each one of them.
6064 Non-interactively, if optional argument LIST is non-nil, it
6065 specifies the list of buffers to kill, asking for approval for each one."
6073 ; if we killed the base buffer.
6080 "Kill buffers whose name matches the specified REGEXP.
6081 The optional second argument indicates whether to kill internal buffers too."
6090 \f
6092 "Adjust current buffer's auto save file name for current conditions.
6093 Also rename any existing auto save file, if it was made in this session."
6105 "Return file name to use for auto-saves of current buffer.
6106 Does not consider `auto-save-visited-file-name' as that variable is checked
6107 before calling this function. You can redefine this for customization.
6108 See also `auto-save-file-name-p'."
6116 result uniq)
6117 ;; Apply user-specified translations
6118 ;; to the file name.
6122 filename)
6132 filename))))
6137 ;; We truncate the file name to DOS 8+3 limits
6138 ;; before doing anything else, because the regexp
6139 ;; passed to string-match below cannot handle
6140 ;; extensions longer than 3 characters, multiple
6141 ;; dots, and other atrocities.
6146 fn)
6151 "#"
6154 ;; Make sure auto-save file names don't contain characters
6155 ;; invalid for the underlying filesystem.
6157 ;; Don't modify remote filenames
6160 result))))
6162 ;; Deal with buffers that don't have any associated files. (Mail
6163 ;; mode tends to create a good number of these.)
6167 file-name)
6168 ;; Restrict the characters used in the file name to those which
6169 ;; are known to be safe on all filesystems, url-encoding the
6170 ;; rest.
6171 ;; We do this on all platforms, because even if we are not
6172 ;; running on DOS/Windows, the current directory may be on a
6173 ;; mounted VFAT filesystem, such as a USB memory stick.
6177 ;; For multibyte characters, this will produce more than
6178 ;; 2 hex digits, so is not true URL encoding.
6182 ;; Generate the file name.
6188 ;; Try a few alternative directories, to get one we can
6189 ;; write it.
6195 ;; Don't modify remote filenames
6197 ;; The call to convert-standard-filename is in case
6198 ;; buffer-name includes characters not allowed by the
6199 ;; DOS/Windows filesystems. make-temp-file writes to the
6200 ;; file it creates, so we must fix the file name _before_
6201 ;; make-temp-file is called.
6203 fname))
6205 ;; make-temp-file creates the file,
6206 ;; but we don't want it to exist until we do an auto-save.
6210 file-name)))
6213 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6214 FILENAME should lack slashes. You can redefine this for customization."
6216 \f
6218 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6219 The generated regexp will match a filename only if the filename
6220 matches that wildcard according to shell rules. Only wildcards known
6221 by `sh' are supported."
6223 ;; Copy the initial run of non-special characters.
6226 ;; If no special characters, we're almost done.
6230 j)
6232 result
6253 ;; Found "[^". Insert a `\0' character
6254 ;; (which cannot happen in a filename)
6255 ;; into the character class, so that `^'
6256 ;; is not the first character after `[',
6257 ;; and thus non-special in a regexp.
6262 ;; I don't think `]' can appear in a
6263 ;; character class in a wildcard, but
6264 ;; let's be general here.
6271 i
6284 ;; Shell wildcards should match the entire filename,
6285 ;; not its part. Make the regexp say so.
6287 \f
6290 "Switches for `list-directory' to pass to `ls' for brief listing."
6296 "Switches for `list-directory' to pass to `ls' for verbose listing."
6301 "Expand wildcard pattern PATTERN.
6302 This returns a list of file names which match the pattern.
6303 Files are sorted in `string<' order.
6305 If PATTERN is written as an absolute file name,
6306 the values are absolute also.
6308 If PATTERN is written as a relative file name, it is interpreted
6309 relative to the current default directory, `default-directory'.
6310 The file names returned are normally also relative to the current
6311 default directory. However, if FULL is non-nil, they are absolute."
6315 ;; A list of all dirs that DIRPART specifies.
6316 ;; This can be more than one dir
6317 ;; if DIRPART contains wildcards.
6323 contents)
6328 ;; Filter out "." and ".."
6333 name))
6340 this-dir-contents)
6341 this-dir-contents)
6342 contents)))))
6343 contents)))
6345 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6349 "Display a list of files in or matching DIRNAME, a la `ls'.
6350 DIRNAME is globbed by the shell if necessary.
6351 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6352 Actions controlled by variables `list-directory-brief-switches'
6353 and `list-directory-verbose-switches'."
6357 nil default-directory nil)
6358 pfx)))
6360 list-directory-brief-switches))
6361 buffer)
6373 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6381 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6383 PATTERN is assumed to represent a file-name wildcard suitable for the
6384 underlying filesystem. For Unix and GNU/Linux, each character from the
6386 the parts of the pattern which don't include wildcard characters are
6387 quoted with double quotes.
6390 on Windows), so PATTERN can use them to quote wildcard characters that
6391 need to be passed verbatim to shell commands."
6395 ;; DOS/Windows don't allow `"' in file names. So if the
6396 ;; argument has quotes, we can safely assume it is already
6397 ;; quoted by the caller.
6399 ;; We quote [&()#$`'] in case their shell is a port of a
6400 ;; Unixy shell. We quote [,=+] because stock DOS and
6401 ;; Windows shells require that in some cases, such as
6402 ;; passing arguments to batch files that use positional
6403 ;; arguments like %1.
6405 pattern
6408 end)
6425 pattern))))
6432 "Program to get the amount of free space on a file system.
6433 We assume the output has the format of `df'.
6434 The value of this variable must be just a command name or file name;
6435 if you want to specify options, use `directory-free-space-args'.
6437 A value of nil disables this feature.
6439 If the function `file-system-info' is defined, it is always used in
6440 preference to the program given by this variable."
6446 "Options to use when running `directory-free-space-program'."
6451 "Return the amount of free space on directory DIR's file system.
6452 The return value is a string describing the amount of free
6453 space (normally, the number of free 1KB blocks).
6455 This function calls `file-system-info' if it is available, or
6456 invokes the program specified by `directory-free-space-program'
6457 and `directory-free-space-args'. If the system call or program
6458 is unsuccessful, or if DIR is a remote directory, this function
6459 returns nil."
6461 ;; Try to find the number of free blocks. Non-Posix systems don't
6462 ;; always have df, but might have an equivalent system call.
6471 ;; Avoid failure if the default directory does
6472 ;; not exist (Bug#2631, Bug#3911).
6476 nil t nil
6477 directory-free-space-args
6480 ;; Assume that the "available" column is before the
6481 ;; "capacity" column. Find the "%" and scan backward.
6485 "[[:space:]]+[^[:space:]]+%[^%]*$"
6492 ;; The following expression replaces `dired-move-to-filename-regexp'.
6496 ;; In some locales, month abbreviations are as short as 2 letters,
6497 ;; and they can be followed by ".".
6498 ;; In Breton, a month name can include a quote character.
6511 s "+"
6514 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6515 ;; omits the Kanji characters after month and day-of-month.
6516 ;; On Mac OS X 10.3, the date format in East Asian locales is
6517 ;; day-of-month digits followed by month digits.
6523 ;; The "[0-9]" below requires the previous column to end in a digit.
6524 ;; This avoids recognizing `1 may 1997' as a date in the line:
6525 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6527 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6529 ;; For non-iso date formats, we add the ".*" in order to find
6530 ;; the last possible match. This avoids recognizing
6531 ;; `jservice 10 1024' as a date in the line:
6532 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6534 ;; vc dired listings provide the state or blanks between file
6535 ;; permissions and date. The state is always surrounded by
6536 ;; parentheses:
6537 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6538 ;; This is not supported yet.
6543 "Regular expression to match up to the file name in a directory listing.
6544 The default value is designed to recognize dates and times
6549 ;; insert-directory
6550 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6551 ;; FULL-DIRECTORY-P is nil.
6552 ;; The single line of output must display FILE's name as it was
6553 ;; given, namely, an absolute path name.
6554 ;; - must insert exactly one line for each file if WILDCARD or
6555 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6556 ;; before the file lines, plus optional text after the file lines.
6557 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6558 ;; allowed.
6559 ;; File lines should display the basename.
6560 ;; - must be consistent with
6561 ;; - functions dired-move-to-filename, (these two define what a file line is)
6562 ;; dired-move-to-end-of-filename,
6563 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6564 ;; dired-insert-headerline
6565 ;; dired-after-subdir-garbage (defines what a "total" line is)
6566 ;; - variable dired-subdir-regexp
6567 ;; - may be passed "--dired" as the first argument in SWITCHES.
6568 ;; Filename handlers might have to remove this switch if their
6569 ;; "ls" command does not support it.
6571 "Insert directory listing for FILE, formatted according to SWITCHES.
6572 Leaves point after the inserted text.
6573 SWITCHES may be a string of options, or a list of strings
6574 representing individual options.
6575 Optional third arg WILDCARD means treat FILE as shell wildcard.
6576 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6577 switches do not contain `d', so that a full listing is expected.
6579 This works by running a directory listing program
6580 whose name is in the variable `insert-directory-program'.
6581 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6583 When SWITCHES contains the long `--dired' option, this function
6584 treats it specially, for the sake of dired. However, the
6585 normally equivalent short `-D' option is just passed on to
6586 `insert-directory-program', as any other option."
6587 ;; We need the directory in order to find the right handler.
6592 wildcard full-directory-p)
6595 ;; Read the actual directory using `insert-directory-program'.
6596 ;; RESULT gets the status code.
6598 ;; putting text property `dired-filename, decode one
6599 ;; bunch by one to preserve that property.
6601 ;; This is to control encoding the arguments in call-process.
6605 default-file-name-coding-system))))
6608 ;; Run ls in the directory part of the file pattern
6609 ;; using the last component as argument.
6615 ;; NB since switches is passed to the shell, be
6616 ;; careful of malicious values, eg "-l;reboot".
6617 ;; See eg dired-safe-switches-p.
6619 shell-file-name nil t nil
6620 "-c"
6622 ""
6624 insert-directory-program
6625 " -d "
6627 switches
6629 " -- "
6630 ;; Quote some characters that have
6631 ;; special meanings in shells; but
6632 ;; don't quote the wildcards--we want
6633 ;; them to be special. We also
6634 ;; currently don't quote the quoting
6635 ;; characters in case people want to
6636 ;; use them explicitly to quote
6637 ;; wildcard characters.
6639 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6640 ;; directory if FILE is a symbolic link.
6648 insert-directory-program nil t nil
6652 ;; Split the switches at any spaces so we can
6653 ;; pass separate options as separate args.
6655 ;; Avoid lossage if FILE starts with `-'.
6663 file))))))))
6665 ;; If we got "//DIRED//" in the output, it means we got a real
6666 ;; directory listing, even if `ls' returned nonzero.
6667 ;; So ignore any errors.
6680 ;; The first time ls returns an error,
6681 ;; find the version numbers of ls,
6682 ;; and set insert-directory-ls-version
6683 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6684 ;; is equal or if the info cannot be obtained.
6685 ;; (That can mean it isn't GNU ls.)
6695 comparison)
6711 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6715 ;; If `insert-directory-program' failed, signal an error.
6717 ;; Delete the error message it may have output.
6719 ;; On non-Posix systems, we cannot open a directory, so
6720 ;; don't even try, because that will always result in
6721 ;; the ubiquitous "Access denied". Instead, show the
6722 ;; command line so the user can try to guess what went wrong.
6727 insert-directory-program
6729 file result)
6730 ;; Unix. Access the file to get a suitable error.
6737 ;; The following overshoots by one line for an empty
6738 ;; directory listed with "--dired", but without "-a"
6739 ;; switch, where the ls output contains a
6740 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6741 ;; We take care of that case later.
6749 error-lines)
6750 ;; Find all the lines that are error messages,
6751 ;; and record the bounds of each one.
6758 ;; Now read the numeric positions of file names.
6765 error-lines))
6768 error-lines)))
6770 ;; End is followed by \n or by " -> ".
6772 ;; It seems that we can't trust ls's output as to
6773 ;; byte positions of filenames.
6779 ;; Take care of the case where the ls output contains a
6780 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6781 ;; and we went one line too far back (see above).
6786 ;; Now decode what read if necessary.
6788 file-name-coding-system
6789 default-file-name-coding-system
6791 coding-no-eol
6792 val pos)
6796 ;; If no coding system is specified or detection is
6797 ;; requested, detect the coding.
6811 ;; Force no eol conversion on a file name, so
6812 ;; that CR is preserved.
6820 ;; Try to insert the amount of free space.
6823 ;; First find the line to put it on.
6827 ;; Replace "total" with "used", to avoid confusion.
6833 "Convert `ls --dired' file name position value POS to a buffer position.
6834 File name position values returned in ls --dired output
6835 count only stdout; they don't count the error messages sent to stderr.
6836 So this function converts to them to real buffer positions.
6837 ERROR-LINES is a list of buffer positions of error message lines,
6838 of the form (START END)."
6842 pos)
6846 "Insert directory listing for FILE, formatted according to SWITCHES.
6848 Like `insert-directory', but if FILE does not exist, it inserts a
6849 message to that effect instead of signaling an error."
6852 ;; Simulate the message printed by `ls'.
6856 "Functions to call with no arguments to query about killing Emacs.
6857 If any of these functions returns nil, killing Emacs is canceled.
6858 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6859 the low level primitive, does not. See also `kill-emacs-hook'."
6865 "How to ask for confirmation when leaving Emacs.
6866 If nil, the default, don't ask at all. If the value is non-nil, it should
6867 be a predicate function; for example `yes-or-no-p'."
6876 "Non-nil if Emacs should confirm killing processes on exit.
6877 If this variable is nil, the value of
6878 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6879 processes with a non-nil `process-query-on-exit-flag', Emacs will
6880 prompt the user before killing them."
6886 "Offer to save each buffer, then kill this Emacs process.
6887 With prefix ARG, silently save all file-visiting buffers without asking.
6888 If there are active processes where `process-query-on-exit-flag'
6889 returns non-nil and `confirm-kill-processes' is non-nil,
6890 asks whether processes should be killed.
6891 Runs the members of `kill-emacs-query-functions' in turn and stops
6892 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6894 ;; Don't use save-some-buffers-default-predicate, because we want
6895 ;; to ask about all the buffers before killing Emacs.
6906 ;; process-list is not defined on MSDOS.
6909 active)
6927 ;; Query the user for other things, perhaps.
6934 "Offer to save each buffer, then kill the current connection.
6935 If the current frame has no client, kill Emacs itself using
6936 `save-buffers-kill-emacs'.
6938 With prefix ARG, silently save all file-visiting buffers, then kill.
6940 If emacsclient was started with a list of filenames to edit, then
6941 only these files will be asked to be saved."
6946 \f
6947 ;; We use /: as a prefix to "quote" a file name
6948 ;; so that magic file name handlers will not apply to it.
6952 file-name-handler-alist))
6954 ;; We depend on being the last handler on the list,
6955 ;; so that anything else which does need handling
6956 ;; has been handled already.
6957 ;; So it is safe for us to inhibit *all* magic file name handlers.
6962 ;; Some operations respect file name handlers in
6963 ;; `default-directory'. Because core function like
6964 ;; `call-process' don't care about file name handlers in
6965 ;; `default-directory', we here have to resolve the
6966 ;; directory into a local one. For `process-file',
6967 ;; `start-file-process', and `shell-command', this fixes
6968 ;; Bug#25949.
6970 shell-command))
6974 default-directory))
6975 ;; Get a list of the indices of the args which are file names.
6978 ;; The first six are special because they
6979 ;; return a file name. We want to include the /:
6980 ;; in the return value.
6981 ;; So just avoid stripping it in the first place.
6988 ;; `identity' means just return the first arg
6989 ;; not stripped of its quoting.
6991 ;; `add' means add "/:" to the result.
6994 ;; `unquote-then-quote' means set buffer-file-name
6995 ;; temporarily to unquoted filename.
6997 ;; List the arguments which are filenames.
7005 ;; For all other operations, treat the first argument only
7006 ;; as the file name.
7008 method
7009 ;; Copy ARGUMENTS so we can replace elements in it.
7013 ;; Strip off the /: from the file names that have it.
7021 "/"
7027 (`insert-file-contents
7033 (`unquote-then-quote
7041 If NAME is a remote file name, check the local part of NAME."
7046 If NAME is a remote file name, the local part of NAME is quoted.
7047 If NAME is already a quoted file name, NAME is returned unchanged."
7049 name
7054 If NAME is a remote file name, the local part of NAME is unquoted."
7060 \f
7061 ;; Symbolic modes and read-file-modes.
7064 "Convert CHAR to a numeric bit-mask for extracting mode bits.
7065 CHAR is in [ugoa] and represents the category of users (Owner, Group,
7066 Others, or All) for whom to produce the mask.
7067 The bit-mask that is returned extracts from mode bits the access rights
7068 for the specified category of users."
7076 "Convert CHAR to a numeric value of mode bits.
7077 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7078 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7085 ;; Rights relative to the previous file modes.
7096 "Convert a symbolic mode string specification to an equivalent number.
7098 WHO-MASK is the bit-mask specifying the category of users to which to
7099 apply the access permissions. See `file-modes-char-to-who'.
7100 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7101 RIGHTS request to add, remove, or set permissions based on existing ones,
7108 char-right)
7115 num-rights
7119 op char-right)))
7120 num-rights))
7123 "Convert symbolic file modes to numeric file modes.
7124 MODES is the string to convert, it should match
7126 See Info node `(coreutils)File permissions' for more information on this
7127 notation.
7128 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7129 MODES request to add, remove, or set permissions based on existing ones,
7143 num-who num-modes)
7146 num-modes)))
7149 "Read file modes in octal or symbolic notation and return its numeric value.
7151 ORIG-FILE is the name of a file on whose mode bits to base returned
7152 permissions if what user types requests to add, remove, or set permissions
7168 nil nil default)))
7177 ;; Trashcan handling.
7179 "Directory for `move-file-to-trash' to move files and directories to.
7180 This directory is only used when the function `system-move-file-to-trash'
7181 is not defined.
7182 Relative paths are interpreted relative to `default-directory'.
7183 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7193 "Move the file (or directory) named FILENAME to the trash.
7194 When `delete-by-moving-to-trash' is non-nil, this function is
7195 called by `delete-file' and `delete-directory' instead of
7196 deleting files outright.
7198 If the function `system-move-file-to-trash' is defined, call it
7199 with FILENAME as an argument.
7200 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7201 directory.
7202 Otherwise, trash FILENAME using the freedesktop.org conventions,
7203 like the GNOME, KDE and XFCE desktop environments. Emacs only
7207 ;; If `trash-directory' is non-nil, move the file there.
7211 trash-dir)))
7212 ;; We can't trash a parent directory of trash-directory.
7215 trash-dir filename))
7218 ;; Ensure that the trashed file-name is unique.
7225 ;; If `system-move-file-to-trash' is defined, use it.
7228 ;; Otherwise, use the freedesktop.org method, as specified at
7229 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7240 ;; Check if we have permissions to delete.
7244 ;; The trashed file cannot be the trash dir or its parent.
7247 trash-files-dir filename))
7250 trash-info-dir filename))
7252 ;; Ensure that the trash directory exists; otherwise, create it.
7259 ;; Try to move to trash with .trashinfo undo information
7264 ;; Perform url-encoding on FN. For compatibility with
7265 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7266 ;; for path separators.
7271 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7272 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7285 fn))
7290 ;; Attempt to make .trashinfo file, trying up to 5
7291 ;; times. The .trashinfo file is opened with O_EXCL,
7292 ;; as per trash-spec 0.7, even if that can be a problem
7293 ;; on old NFS versions...
7297 trash-files-dir))
7299 success info-fn)
7304 trash-info-dir))
7312 ;; Uniquify new-fn. (Some file managers do not
7313 ;; like Emacs-style backup file names---e.g. bug
7314 ;; 170956 in Konqueror bug tracker.)
7319 ;; Finally, try to move the file to the trashcan.
7324 "The type field in ATTRIBUTES returned by `file-attributes'.
7325 The value is either t for directory, string (name linked to) for
7326 symbolic link, or nil."
7330 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7334 "The UID field in ATTRIBUTES returned by `file-attributes'.
7335 This is either a string or a number. If a string value cannot be
7336 looked up, a numeric value, either an integer or a float, is
7337 returned."
7341 "The GID field in ATTRIBUTES returned by `file-attributes'.
7342 This is either a string or a number. If a string value cannot be
7343 looked up, a numeric value, either an integer or a float, is
7344 returned."
7348 "The last access time in ATTRIBUTES returned by `file-attributes'.
7349 This a list of integers (HIGH LOW USEC PSEC) in the same style
7350 as (current-time)."
7354 "The modification time in ATTRIBUTES returned by `file-attributes'.
7355 This is the time of the last change to the file's contents, and
7356 is a list of integers (HIGH LOW USEC PSEC) in the same style
7357 as (current-time)."
7361 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7362 This is the time of last change to the file's attributes: owner
7363 and group, access mode bits, etc, and is a list of integers (HIGH
7364 LOW USEC PSEC) in the same style as (current-time)."
7368 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7369 This is a floating point number if the size is too large for an integer."
7373 "The file modes in ATTRIBUTES returned by `file-attributes'.
7374 This is a string of ten letters or dashes as in ls -l."
7378 "The inode number in ATTRIBUTES returned by `file-attributes'.
7379 If it is larger than what an Emacs integer can hold, this is of
7380 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7381 If even HIGH is too large for an Emacs integer, this is instead
7382 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7383 middle 24 bits, and finally the low 16 bits."
7387 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7388 If it is larger than what an Emacs integer can hold, this is of
7389 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7390 If even HIGH is too large for an Emacs integer, this is instead
7391 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7392 middle 24 bits, and finally the low 16 bits."
7396 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7397 ATTR-NAMES are symbols with the selected attribute names.
7399 Valid attribute names are: type, link-number, user-id, group-id,
7400 access-time, modification-time, status-change-time, size, modes,
7401 inode-number and device-number."
7403 modification-time status-change-time
7404 size modes inode-number device-number))
7405 result)
7411 attributes)
7412 result)
7415 \f
7440 ;;; files.el ends here