| blob | 790f6cedfd6978edfe8596227cd5108634430e69 |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2016 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
34 "Backups of edited data files."
38 "Finding files."
43 "Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that the auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 a match for FROM with TO when a directory name matches FROM. This
55 replacement is done when setting up the default directory of a
56 newly visited file buffer.
58 FROM is a regexp that is matched against directory names anchored at
62 FROM and TO should be equivalent names, which refer to the
63 same directory. TO should be an absolute directory name.
64 Do not use `~' in the TO strings.
66 Use this feature when you have directories which you normally refer to
67 via absolute symbolic links. Make TO the name of the link, and FROM
68 a regexp matching the name it is linked to."
77 "Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
100 "If non-nil, backups will be inhibited.
101 This variable is intended for use by making it local to a buffer,
106 "Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
112 "Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
119 "Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
131 "Non-nil means create backups by copying to preserve a privileged owner.
132 Renaming may still be used (subject to control of other variables)
133 when it would not result in changing the owner of the file or if the owner
134 has a user id greater than the value of this variable. This is useful
135 when low-numbered uid's are used for special system users (such as root)
136 that must maintain ownership of certain files.
137 This variable is relevant only if `backup-by-copying' and
138 `backup-by-copying-when-mismatch' are nil."
143 "Predicate that looks at a file name and decides whether to make backups.
147 "Non-nil in a buffer means always offer to save buffer on exit.
148 Do so even if the buffer is not visiting a file.
149 Automatically local in all buffers."
156 "Non-nil means find a file under alternative names, in existing buffers.
157 This means if any existing buffer is visiting the file you want
158 under another name, you get the existing buffer instead of a new buffer."
163 "Non-nil means visiting a file uses its truename as the visited-file name.
164 That is, the buffer visiting the file has the truename as the
165 value of `buffer-file-name'. The truename of a file is found by
166 chasing all links both at the file level and at the levels of the
167 containing directories."
173 "Specify which files should be reverted without query.
174 The value is a list of regular expressions.
175 If the file name matches one of these regular expressions,
176 then `revert-buffer' reverts the file without querying
177 if the file has changed on disk and you have not edited the buffer."
182 "The device number and file number of the file visited in the current buffer.
183 The value is a list of the form (FILENUM DEVNUM).
184 This pair of numbers uniquely identifies the file.
198 "The directory for writing small temporary files.
199 If non-nil, this directory is used instead of `temporary-file-directory'
200 by programs that create small temporary files. This is for systems that
201 have fast storage with limited space, such as a RAM disk."
206 ;; The system null device. (Should reference NULL_DEVICE from C.)
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
254 "Whether to allow breaking hardlinks when saving files.
255 If non-nil, then when saving a file that exists under several
256 names \(i.e., has multiple hardlinks), break the hardlink
257 associated with `buffer-file-name' and write to a new file, so
258 that the other instances of the file are not affected by the
259 save.
261 If `buffer-file-name' refers to a symlink, do not break the symlink.
263 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
264 For example, if the directory in which a file is being saved is not
265 itself writable, then error instead of saving in some
266 hardlink-nonbreaking way.
268 See also `backup-by-copying' and `backup-by-copying-when-linked'."
274 "Control use of version numbers for backup files.
275 When t, make numeric backup versions unconditionally.
276 When nil, make them for files that have some already.
277 The value `never' means do not make them."
286 "When cleaning directory, number of versions to keep."
292 "If t, delete excess backup versions silently.
293 If nil, ask confirmation. Any other value prevents any trimming."
300 "Number of oldest versions to keep when a new numbered backup is made."
306 "Number of newest versions to keep when a new numbered backup is made.
307 Includes the new backup. Must be > 0"
313 "Whether to add a newline automatically at the end of the file.
315 A value of t means do this only when the file is about to be saved.
316 A value of `visit' means do this right after the file is visited.
317 A value of `visit-save' means do it at both of those times.
318 Any other non-nil value means ask user whether to add a newline, when saving.
319 A value of nil means don't add newlines.
321 Certain major modes set this locally to the value obtained
322 from `mode-require-final-newline'."
332 "Whether to add a newline at end of file, in certain major modes.
333 Those modes set `require-final-newline' to this value when you enable them.
334 They do so because they are often used for files that are supposed
335 to end in newlines, and the question is how to arrange that.
337 A value of t means do this only when the file is about to be saved.
338 A value of `visit' means do this right after the file is visited.
339 A value of `visit-save' means do it at both of those times.
340 Any other non-nil value means ask user whether to add a newline, when saving.
342 A value of nil means do not add newlines. That is a risky choice in this
343 variable since this value is used for modes for files that ought to have
344 final newlines. So if you set this to nil, you must explicitly check and
345 add a final newline, whenever you save a file that really needs one."
355 "Non-nil says by default do auto-saving of every file-visiting buffer."
361 ;; Don't put "\\2" inside expand-file-name, since it will be
362 ;; transformed to "/2" on DOS/Windows.
364 "Transforms to apply to buffer file name before making auto-save file name.
365 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
366 REGEXP is a regular expression to match against the file name.
367 If it matches, `replace-match' is used to replace the
368 matching part with REPLACEMENT.
369 If the optional element UNIQUIFY is non-nil, the auto-save file name is
370 constructed by taking the directory part of the replaced file-name,
371 concatenated with the buffer file name with all directory separators
372 changed to `!' to prevent clashes. This will not work
373 correctly if your filesystem truncates the resulting name.
375 All the transforms in the list are tried, in the order they are listed.
376 When one transform applies, its result is final;
377 no further transforms are tried.
379 The default value is set up to put the auto-save file into the
380 temporary directory (see the variable `temporary-file-directory') for
381 editing a remote file.
383 On MS-DOS filesystems without long names this variable is always
384 ignored."
392 "Non-nil means save word abbrevs too when files are saved.
393 If `silently', don't ask the user before saving."
398 "Non-nil means allow `find-file' to visit directories.
399 To visit the directory, `find-file' runs `find-directory-functions'."
404 "List of functions to try in sequence to visit a directory.
405 Each function is called with the directory name as the sole argument
406 and should return either a buffer or nil."
410 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
412 "List of functions to try in sequence to get a file name at point.
413 Each function should return either nil or a file name found at the
414 location of point in the current buffer."
418 ;;;It is not useful to make this a local variable.
419 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
423 "List of functions to be called for `find-file' on nonexistent file.
424 These functions are called as soon as the error is detected.
425 Variable `buffer-file-name' is already set up.
428 ;;;It is not useful to make this a local variable.
429 ;;;(put 'find-file-hooks 'permanent-local t)
432 "List of functions to be called after a buffer is loaded from a file.
433 The buffer's local variables (if any) will have been processed before the
434 functions are called."
442 "List of functions to be called before writing out a buffer to a file.
443 If one of them returns non-nil, the file is considered already written
444 and the rest are not called.
445 These hooks are considered to pertain to the visited file.
446 So any buffer-local binding of this variable is discarded if you change
448 change the major mode.
450 This hook is not run if any of the functions in
451 `write-contents-functions' returns non-nil. Both hooks pertain
452 to how to save a buffer to file, for instance, choosing a suitable
453 coding system and setting mode bits. (See Info
454 node `(elisp)Saving Buffers'.) To perform various checks or
466 "List of functions to be called before writing out a buffer to a file.
467 If one of them returns non-nil, the file is considered already written
468 and the rest are not called and neither are the functions in
469 `write-file-functions'.
471 This variable is meant to be used for hooks that pertain to the
472 buffer's contents, not to the particular visited file; thus,
473 `set-visited-file-name' does not clear this variable; but changing the
474 major mode does clear it.
476 For hooks that _do_ pertain to the particular visited file, use
477 `write-file-functions'. Both this variable and
478 `write-file-functions' relate to how a buffer is saved to file.
479 To perform various checks or updates before the buffer is saved,
484 "Control use of local variables in files you visit.
485 The value can be t, nil, :safe, :all, or something else.
487 A value of t means file local variables specifications are obeyed
488 if all the specified variable values are safe; if any values are
489 not safe, Emacs queries you, once, whether to set them all.
490 \(When you say yes to certain values, they are remembered as safe.)
492 :safe means set the safe variables, and ignore the rest.
493 :all means set all variables, whether safe or not.
494 (Don't set it permanently to :all.)
495 A value of nil means always ignore the file local variables.
497 Any other value means always query you once whether to set them all.
498 \(When you say yes to certain values, they are remembered as safe, but
501 This variable also controls use of major modes specified in
502 a -*- line.
505 always obeys file local variable specifications and the -*- line,
506 and ignores this variable."
507 :risky t
516 "Non-nil means enable use of directory-local variables.
517 Some modes may wish to set this to nil to prevent directory-local
520 ;; This is an odd variable IMO.
521 ;; You might wonder why it is needed, when we could just do:
522 ;; (set (make-local-variable 'enable-local-variables) nil)
523 ;; These two are not precisely the same.
524 ;; Setting this variable does not cause -*- mode settings to be
525 ;; ignored, whereas setting enable-local-variables does.
526 ;; Only three places in Emacs use this variable: tar and arc modes,
527 ;; and rmail. The first two don't need it. They already use
528 ;; inhibit-local-variables-regexps, which is probably enough, and
529 ;; could also just set enable-local-variables locally to nil.
530 ;; Them setting it has the side-effect that dir-locals cannot apply to
531 ;; eg tar files (?). FIXME Is this appropriate?
532 ;; AFAICS, rmail is the only thing that needs this, and the only
533 ;; reason it uses it is for BABYL files (which are obsolete).
534 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
535 ;; to respect, so that find-file on a BABYL file will switch to
536 ;; rmail-mode automatically (this is nice, but hardly essential,
537 ;; since most people are used to explicitly running a command to
538 ;; access their mail; M-x gnus etc). Rmail files may happen to
539 ;; contain Local Variables sections in messages, which Rmail wants to
540 ;; ignore. So AFAICS the only reason this variable exists is for a
541 ;; minor convenience feature for handling of an obsolete Rmail file format.
543 "Like `enable-local-variables' but meant for buffer-local bindings.
544 The meaningful values are nil and non-nil. The default is non-nil.
545 If a major mode sets this to nil, buffer-locally, then any local
546 variables list in a file visited in that mode will be ignored.
548 This variable does not affect the use of major modes specified
553 The value can be t, nil or something else.
554 A value of t means obey `eval' variables.
555 A value of nil means ignore them; anything else means query."
556 :risky t
563 "Non-nil means buffers visiting files read-only do so in view mode.
564 In fact, this means that all read-only buffers normally have
565 View mode enabled, including buffers that are read-only because
566 you visit a file you cannot alter, and buffers you make read-only
572 "History list of file names entered in the minibuffer.
574 Maximum length of the history list is determined by the value
578 "If non-nil, avoid messages when saving files.
579 Error-related messages will still be printed, but all other
582 \f
585 "Provides support for ange-ftp host name completion.
586 Runs the usual ange-ftp hook, but only for completion operations."
587 ;; Having this here avoids the need to load ange-ftp when it's not
588 ;; really in use.
594 inhibit-file-name-handlers)))
602 "Convert a standard file's name to something suitable for the OS.
603 This means to guarantee valid names and perhaps to canonicalize
604 certain patterns.
606 FILENAME should be an absolute file name since the conversion rules
607 sometimes vary depending on the position in the file name. E.g. c:/foo
608 is a valid DOS file name, but c:/bar/c:/foo is not.
610 This function's standard definition is trivial; it just returns
611 the argument. However, on Windows and DOS, replace invalid
612 characters. On DOS, make sure to obey the 8.3 limitations.
613 In the native Windows build, turn Cygwin names into native names.
615 See Info node `(elisp)Standard File Names' for more details."
620 ;; Replace invalid filename characters with !
624 name))
632 "Read directory name, prompting with PROMPT and completing in directory DIR.
633 Value is not expanded---you must call `expand-file-name' yourself.
634 Default name to DEFAULT-DIRNAME if user exits with the same
635 non-empty string that was inserted by this function.
636 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
637 or just DIR if INITIAL is nil.)
638 If the user exits with an empty minibuffer, this function returns
639 an empty string. (This can only happen if the user erased the
640 pre-inserted contents or if `insert-default-directory' is nil.)
641 Fourth arg MUSTMATCH non-nil means require existing directory's name.
642 Non-nil and non-t means also require confirmation after completion.
643 Fifth arg INITIAL specifies text to start with.
644 DIR should be an absolute directory name. It defaults to
645 the value of `default-directory'."
650 dir))
651 mustmatch initial
654 \f
656 "Show the current default directory.
657 With prefix argument INSERT, insert the current default directory
658 at point instead."
665 "Value of the CDPATH environment variable, as a list.
669 "Explode a search path into a list of directory names.
670 Directories are separated by `path-separator' (which is colon in
671 GNU and Unix systems). Substitute environment variables into the
672 resulting list of directory names. For an empty path element (i.e.,
673 a leading or trailing separator, or two adjacent separators), return
674 nil (meaning `default-directory') as the associated list element."
682 "Change current directory to given absolute file name DIR."
683 ;; Put the name into directory syntax now,
684 ;; because otherwise expand-file-name may give some bad results.
686 ;; We used to additionally call abbreviate-file-name here, for an
687 ;; unknown reason. Problem is that most buffers are setup
688 ;; without going through cd-absolute and don't call
689 ;; abbreviate-file-name on their default-directory, so the few that
690 ;; do end up using a superficially different directory.
702 "Make DIR become the current buffer's default directory.
703 If your environment includes a `CDPATH' variable, try each one of
704 that list of directories (separated by occurrences of
705 `path-separator') when resolving a relative directory name.
706 The path separator is colon in GNU and GNU-like systems."
709 ;; FIXME: There's a subtle bug in the completion below. Seems linked
710 ;; to a fundamental difficulty of implementing `predicate' correctly.
711 ;; The manifestation is that TAB may list non-directories in the case where
712 ;; those files also correspond to valid directories (if your cd-path is (A/
713 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
714 ;; will be listed as valid completions).
715 ;; This is because `a' (listed because of A/a) is indeed a valid choice
716 ;; (which will lead to the use of B/a).
721 cd-path nil))
730 default-directory default-directory
731 t))))
741 "Return non-nil if NAME ends with a directory separator character."
751 "Return list of all files under DIR that have file names matching REGEXP.
753 order, and files from each directory are sorted in alphabetical order.
754 Each file name appears in the returned list in its absolute form.
755 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
756 output directories whose names match REGEXP."
759 ;; When DIR is "/", remote file names like "/method:" could
760 ;; also be offered. We shall suppress them.
768 ;; Don't follow symlinks to other directories.
772 full-file regexp include-directories))))
783 "Load the Lisp file named FILE."
784 ;; This is a case where .elc and .so/.dll make a lot of sense.
788 completion-ignored-extensions))))
793 "Search for FILENAME through PATH.
794 If found, return the absolute file name of FILENAME; otherwise
795 return nil.
796 PATH should be a list of directories to look in, like the lists in
797 `exec-path' or `load-path'.
798 If SUFFIXES is non-nil, it should be a list of suffixes to append to
801 If non-nil, PREDICATE is used instead of `file-readable-p'.
803 This function will normally skip directories, so if you want it to find
804 directories, make sure the PREDICATE function returns `dir-ok' for them.
806 PREDICATE can also be an integer to pass to the `access' system call,
807 in which case file-name handlers are ignored. This usage is deprecated.
808 For compatibility, PREDICATE can also be one of the symbols
809 `executable', `readable', `writable', or `exists', or a list of
810 one or more of those symbols."
821 "Do completion for file names passed to `locate-file'."
824 ;; FIXME: maybe we should use completion-file-name-table instead,
825 ;; tho at least for `load', the arg is passed through
826 ;; substitute-in-file-name for historical reasons.
836 ;; If we have files like "foo.el" and "foo.elc", we could load one of
837 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
838 ;; preferred way. So if we list all 3, that gives a lot of redundant
839 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
840 ;; the user does want to pay attention to the extension. We try to
841 ;; diffuse this tension by stripping the suffix, except when the
842 ;; result is a single element (i.e. usually we only list "foo" unless
843 ;; it's the only remaining element in the list, in which case we do
844 ;; list "foo", "foo.elc" and "foo.el").
855 string-file dir))
860 ;; Switching from names to names+fullnames creates a non-monotonicity
861 ;; which can cause problems with things like partial-completion.
862 ;; To minimize the problem, filter out completion-regexp-list, so that
863 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
864 ;; from `names' which only matched `string' when they still had
865 ;; their suffix.
867 ;; Remove duplicates of the first element, so that we can easily check
868 ;; if `names' really only contains a single element.
871 ;; There's no more than one matching non-suffixed element, so expand
872 ;; the list by adding the suffixed elements as well.
875 string-dir names string-file pred action)))))
878 "Do completion for file names passed to `locate-file'.
879 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
883 string nil action))
887 "Regexp of directory names which stop the search in `locate-dominating-file'.
888 Any directory whose name matches this regexp will be treated like
889 a kind of root directory by `locate-dominating-file' which will stop its search
890 when it bumps into it.
891 The default regexp prevents fruitless and time-consuming attempts to find
892 special files in directories in which filenames are interpreted as hostnames,
895 ;; (defun locate-dominating-files (file regexp)
896 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
897 ;; Stop at the first parent where a matching file is found and return the list
898 ;; of files that that match in this directory."
899 ;; (catch 'found
900 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
901 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
902 ;; (let ((user nil)
903 ;; ;; Abbreviate, so as to stop when we cross ~/.
904 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
905 ;; files)
906 ;; (while (and dir
907 ;; ;; As a heuristic, we stop looking up the hierarchy of
908 ;; ;; directories as soon as we find a directory belonging to
909 ;; ;; another user. This should save us from looking in
910 ;; ;; things like /net and /afs. This assumes that all the
911 ;; ;; files inside a project belong to the same user.
912 ;; (let ((prev-user user))
913 ;; (setq user (nth 2 (file-attributes dir)))
914 ;; (or (null prev-user) (equal user prev-user))))
915 ;; (if (setq files (condition-case nil
916 ;; (directory-files dir 'full regexp 'nosort)
917 ;; (error nil)))
918 ;; (throw 'found files)
919 ;; (if (equal dir
920 ;; (setq dir (file-name-directory
921 ;; (directory-file-name dir))))
922 ;; (setq dir nil))))
923 ;; nil)))
926 "Look up the directory hierarchy from FILE for a directory containing NAME.
927 Stop at the first parent directory containing a file NAME,
928 and return the directory. Return nil if not found.
929 Instead of a string, NAME can also be a predicate taking one argument
930 \(a directory) and returning a non-nil value if that directory is the one for
931 which we're looking."
932 ;; We used to use the above locate-dominating-files code, but the
933 ;; directory-files call is very costly, so we're much better off doing
934 ;; multiple calls using the code in here.
935 ;;
936 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
937 ;; `name' in /home or in /.
940 ;; `user' is not initialized outside the loop because
941 ;; `file' may not exist, so we may have to walk up part of the
942 ;; hierarchy before we find the "initial UID". Note: currently unused
943 ;; (user nil)
944 try)
947 ;; FIXME: Disabled this heuristic because it is sometimes
948 ;; inappropriate.
949 ;; As a heuristic, we stop looking up the hierarchy of
950 ;; directories as soon as we find a directory belonging
951 ;; to another user. This should save us from looking in
952 ;; things like /net and /afs. This assumes that all the
953 ;; files inside a project belong to the same user.
954 ;; (let ((prev-user user))
955 ;; (setq user (nth 2 (file-attributes file)))
956 ;; (and prev-user (not (equal user prev-user))))
968 "Non-nil means warn if cannot access `user-emacs-directory'.
969 Set this to nil at your own risk..."
975 "Return an absolute per-user Emacs-specific file name.
976 If NEW-NAME exists in `user-emacs-directory', return it.
977 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
978 Else return NEW-NAME in `user-emacs-directory', creating the
979 directory if it does not exist."
987 at-home
988 ;; Make sure `user-emacs-directory' exists,
989 ;; unless we're in batch mode or dumping Emacs.
991 purify-flag
1001 user-emacs-directory-warning
1003 ;; Only warn once per Emacs session.
1007 Unable to %s `user-emacs-directory' (%s).
1008 Any data that would normally be written there may be lost!
1009 If you never want to see this message again,
1010 customize the variable `user-emacs-directory-warning'."
1011 errtype user-emacs-directory)))))
1012 bestname))))
1016 "Search for COMMAND in `exec-path' and return the absolute file name.
1017 Return nil if COMMAND is not found anywhere in `exec-path'."
1018 ;; Use 1 rather than file-executable-p to better match the behavior of
1019 ;; call-process.
1023 "Load the Emacs Lisp library named LIBRARY.
1024 LIBRARY should be a string.
1025 This is an interface to the function `load'. LIBRARY is searched
1026 for in `load-path', both with and without `load-suffixes' (as
1027 well as `load-file-rep-suffixes').
1029 See Info node `(emacs)Lisp Libraries' for more details.
1030 See `load-file' for a different interface to `load'."
1035 load-path
1040 "Test whether FILE specifies a location on a remote system.
1041 A file is considered remote if accessing it is likely to
1042 be slower or less reliable than accessing local files.
1044 `file-remote-p' never opens a new remote connection. It can
1045 only reuse a connection that is already open.
1047 Return nil or a string identifying the remote connection
1048 \(ideally a prefix of FILE). Return nil if FILE is a relative
1049 file name.
1051 When IDENTIFICATION is nil, the returned string is a complete
1052 remote identifier: with components method, user, and host. The
1053 components are those present in FILE, with defaults filled in for
1054 any that are missing.
1056 IDENTIFICATION can specify which part of the identification to
1057 return. IDENTIFICATION can be the symbol `method', `user',
1058 `host', or `localname'. Any other value is handled like nil and
1059 means to return the complete identification. The string returned
1060 for IDENTIFICATION `localname' can differ depending on whether
1061 there is an existing connection.
1063 If CONNECTED is non-nil, return an identification only if FILE is
1064 located on a remote system and a connection is established to
1065 that remote system.
1067 Tip: You can use this expansion of remote identifier components
1068 to derive a new remote file name from an existing one. For
1074 same remote identifier as FILE but expanded; a name such as
1079 nil)))
1081 ;; Probably this entire variable should be obsolete now, in favor of
1082 ;; something Tramp-related (?). It is not used in many places.
1083 ;; It's not clear what the best file for this to be in is, but given
1084 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1085 ;; rather than autoloaded.
1087 ;; This used to try various hard-coded places for remsh, rsh, and
1088 ;; rcmd, trying to guess based on location whether "rsh" was
1089 ;; "restricted shell" or "remote shell", but I don't see the point
1090 ;; in this day and age. Almost everyone will use ssh, and have
1091 ;; whatever command they want to use in PATH.
1098 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1105 "Whether to use the remote file-name cache for read access.
1106 When nil, never expire cached values (caution)
1107 When t, never use the cache (safe, but may be slow)
1108 A number means use cached values for that amount of seconds since caching.
1110 The attributes of remote files are cached for better performance.
1111 If they are changed outside of Emacs's control, the cached values
1112 become invalid, and must be reread. If you are sure that nothing
1113 other than Emacs changes the files, you can set this variable to nil.
1115 If a remote file is checked regularly, it might be a good idea to
1116 let-bind this variable to a value less than the interval between
1117 consecutive checks. For example:
1119 (defun display-time-file-nonempty-p (file)
1120 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1121 (and (file-exists-p file)
1122 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1133 "Return the local name component of FILE.
1134 It returns a file name which can be used directly as argument of
1135 `process-file', `start-file-process', or `shell-command'."
1139 "Copy the file FILE into a temporary file on this machine.
1140 Returns the name of the local copy, or nil, if FILE is directly
1141 accessible."
1142 ;; This formerly had an optional BUFFER argument that wasn't used by
1143 ;; anything.
1147 nil)))
1150 "Return the truename of FILENAME.
1151 If FILENAME is not absolute, first expands it against `default-directory'.
1152 The truename of a file name is found by chasing symbolic links
1153 both at the level of the file and at the level of the directories
1154 containing it, until no links are left at any level.
1157 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1158 ;; COUNTER can be a cons cell whose car is the count of how many
1159 ;; more links to chase before getting an error.
1160 ;; PREV-DIRS can be a cons cell whose car is an alist
1161 ;; of truenames we've just recently computed.
1175 ;; For speed, remove the ange-ftp completion handler from the list.
1176 ;; We know it's not needed here.
1177 ;; For even more speed, do this only on the outermost call.
1184 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1185 ;; case differences being ignored by the OS, and short "8.3 DOS"
1186 ;; name aliases existing for all files. (The short names are not
1187 ;; reported by directory-files, but can be used to refer to files.)
1188 ;; It seems appropriate for file-truename to resolve these issues in
1189 ;; the most natural way, which on Windows is to call the function
1190 ;; `w32-long-file-name' - this returns the exact name of a file as
1191 ;; it is stored on disk (expanding short name aliases with the full
1192 ;; name in the process).
1195 ;; If filename exists, use its long name. If it doesn't
1196 ;; exist, the recursion below on the directory of filename
1197 ;; will drill down until we find a directory that exists,
1198 ;; and use the long name of that, with the extra
1199 ;; non-existent path components concatenated.
1204 ;; If this file directly leads to a link, process that iteratively
1205 ;; so that we don't use lots of stack.
1211 ;; For file name that has a special handler, call handler.
1212 ;; This is so that ange-ftp can save time by doing a no-op.
1215 done t)
1217 target dirfile)
1218 ;; Get the truename of the directory.
1220 ;; If these are equal, we have the (or a) root directory.
1224 ;; If this is the same dir we last got the truename for,
1225 ;; save time--don't recalculate.
1235 done t)
1238 done t)
1239 ;; Put it back on the file name.
1241 ;; Is the file name the name of a link?
1244 ;; Yes => chase that link, then start all over
1245 ;; since the link may point to a directory name that uses links.
1246 ;; We can't safely use expand-file-name here
1247 ;; since target might look like foo/../bar where foo
1248 ;; is itself a link. Instead, we handle . and .. above.
1251 target
1253 done nil)
1254 ;; No, we are done!
1256 filename))
1259 "Chase links in FILENAME until a name that is not a link.
1260 Unlike `file-truename', this does not check whether a parent
1261 directory name is a symbolic link.
1262 If the optional argument LIMIT is a number,
1263 it means chase no more than that many links and then stop."
1271 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1274 ;; Handle `..' by hand, since it needs to work in the
1275 ;; target of any directory symlink.
1276 ;; This code is not quite complete; it does not handle
1277 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1281 ;; Chase links in the default dir of the symlink.
1285 ;; Now find the parent of that dir.
1289 newname))
1291 ;; A handy function to display file sizes in human-readable form.
1292 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1294 "Produce a string showing FILE-SIZE in human-readable form.
1296 Optional second argument FLAVOR controls the units and the display format:
1298 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1300 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1302 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1305 1024.0
1308 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1314 "%.1f%s%s"
1316 file-size
1318 "K"
1324 "^//[^/]+/"
1325 ;; regexp-opt.el is not dumped into emacs binary.
1326 ;;(concat
1327 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1329 "File systems which ought to be mounted."
1336 "The directory for writing temporary files.
1337 In case of a remote `default-directory', this is a directory for
1338 temporary files on that remote host. If such a directory does
1339 not exist, or `default-directory' ought to be located on a
1340 mounted file system (see `mounted-file-systems'), the function
1341 returns `default-directory'.
1342 For a non-remote and non-mounted `default-directory', the value of
1343 the variable `temporary-file-directory' is returned."
1349 default-directory
1350 temporary-file-directory))))
1353 "Create a temporary file.
1354 The returned file name (created by appending some random characters at the end
1355 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1356 is guaranteed to point to a newly created empty file.
1357 You can then use `write-region' to write new data into the file.
1359 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1361 If SUFFIX is non-nil, add that at the end of the file name."
1362 ;; Create temp files with strict access rights. It's easy to
1363 ;; loosen them later, whereas it's impossible to close the
1364 ;; time-window of loose permissions otherwise.
1373 temporary-file-directory)
1375 temporary-file-directory))))
1381 nil)
1383 ;; the file was somehow created by someone else between
1384 ;; `make-temp-name' and `write-region', let's try again.
1385 nil)
1386 file)))
1389 "Create a temporary file as close as possible to `default-directory'.
1390 If PREFIX is a relative file name, and `default-directory' is a
1391 remote file name or located on a mounted file systems, the
1392 temporary file is created in the directory returned by the
1393 function `temporary-file-directory'. Otherwise, the function
1394 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1395 same meaning as in `make-temp-file'."
1404 "Change the encoding of FILE's name from CODING to NEW-CODING.
1405 The value is a new name of FILE.
1406 Signals a `file-already-exists' error if a file of the new name
1407 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1408 is non-nil. A number as fourth arg means request confirmation if
1409 the new name already exists. This is what happens in interactive
1410 use with M-x."
1413 default-file-name-coding-system))
1415 from-coding to-coding)
1417 ;; We provide the default coding only when it seems that
1418 ;; the filename is correctly decoded by the default
1419 ;; coding.
1425 filename default-coding)
1426 default-coding))
1430 ;; We provide the default coding only when a user is going to
1431 ;; change the encoding not from the default coding.
1435 filename from-coding)))
1438 filename from-coding default-coding)
1439 default-coding)))
1443 default-file-name-coding-system))
1444 ;; FILE should have been decoded by DEFAULT-CODING.
1448 ;; Suppress further encoding.
1453 newname))
1454 \f
1456 "Whether confirmation is requested before visiting a new file or buffer.
1457 If nil, confirmation is not requested.
1458 If the value is `after-completion', confirmation is only
1459 requested if the user called `minibuffer-complete' right before
1460 `minibuffer-complete-and-exit'.
1461 Any other non-nil value means to request confirmation.
1463 This affects commands like `switch-to-buffer' and `find-file'."
1471 "Whether to request confirmation before visiting a new file or buffer.
1472 The variable `confirm-nonexistent-file-or-buffer' determines the
1473 return value, which may be passed as the REQUIRE-MATCH arg to
1474 `read-buffer' or `find-file-read-args'."
1482 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1484 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1485 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1486 instead of prepending it.
1488 BODY should use the minibuffer at most once.
1489 Recursive uses of the minibuffer are unaffected (FUN is not
1490 called additional times).
1492 This macro actually adds an auxiliary function that calls FUN,
1493 rather than FUN itself, to `minibuffer-setup-hook'."
1504 ;; Clear out this hook so it does not interfere
1505 ;; with any recursive minibuffer usage.
1516 t))
1519 "Edit file FILENAME.
1520 Switch to a buffer visiting file FILENAME,
1521 creating one if none already exists.
1522 Interactively, the default if you just type RET is the current directory,
1523 but the visited file name is available through the minibuffer history:
1524 type M-n to pull it into the minibuffer.
1526 You can visit files on remote machines by specifying something
1527 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1528 also visit local files as a different user by specifying
1529 /sudo::FILE for the file name.
1530 See the Info node `(tramp)File name Syntax' in the Tramp Info
1531 manual, for more about this.
1533 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1534 expand wildcards (if any) and visit multiple files. You can
1535 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1537 To visit a file without any kind of conversion and without
1548 "Edit file FILENAME, in another window.
1551 an existing one. See the function `display-buffer'.
1553 Interactively, the default if you just type RET is the current directory,
1554 but the visited file name is available through the minibuffer history:
1555 type M-n to pull it into the minibuffer.
1557 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1558 expand wildcards (if any) and visit multiple files."
1568 value)
1572 "Edit file FILENAME, in another frame.
1575 an existing one. See the function `display-buffer'.
1577 Interactively, the default if you just type RET is the current directory,
1578 but the visited file name is available through the minibuffer history:
1579 type M-n to pull it into the minibuffer.
1581 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1582 expand wildcards (if any) and visit multiple files."
1592 value)
1596 "Edit the existing file FILENAME.
1598 file names with wildcards."
1615 value))
1618 "Edit file FILENAME but don't allow changes.
1627 "Edit file FILENAME in another window but don't allow changes.
1636 "Edit file FILENAME in another frame but don't allow changes.
1645 "Find file FILENAME as a replacement for the file in the next window.
1646 This command does not select that window.
1650 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1651 expand wildcards (if any) and replace the file with multiple files."
1662 "Find alternate file: " file-dir nil
1664 t))))
1671 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1673 "Hook run when a buffer is killed.
1674 The buffer being killed is current while the hook is running.
1675 See `kill-buffer'.
1677 Note: Be careful with let-binding this hook considering it is
1681 "Find file FILENAME, select its buffer, kill previous buffer.
1682 If the current buffer now contains an empty file that you just visited
1683 \(presumably by mistake), use this command to visit the file you really want.
1687 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1688 expand wildcards (if any) and replace the file with multiple files.
1690 If the current buffer is an indirect buffer, or the base buffer
1691 for one or more indirect buffers, the other buffer(s) are not
1692 killed."
1701 "Find alternate file: " file-dir nil
1703 t)))
1717 ;; Run `kill-buffer-hook' here. It needs to happen before
1718 ;; variables like `buffer-file-name' etc are set to nil below,
1719 ;; because some of the hooks that could be invoked
1720 ;; (e.g., `save-place-to-alist') depend on those variables.
1721 ;;
1722 ;; Note that `kill-buffer-hook' is not what queries whether to
1723 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1724 ;; asks that itself. Thus, there's no need to temporarily do
1725 ;; `(set-buffer-modified-p nil)' before running this hook.
1727 ;; Okay, now we can end-of-life the old buffer.
1734 ;; This prevents us from finding the same buffer
1735 ;; if we specified the same file again.
1739 ;; Likewise for dired buffers.
1743 ;; This executes if find-file gets an error
1744 ;; and does not really find anything.
1745 ;; We put things back as they were.
1746 ;; If find-file actually finds something, we kill obuf below.
1755 ;; We already ran these; don't run them again.
1758 \f
1759 ;; FIXME we really need to fold the uniquify stuff in here by default,
1760 ;; not using advice, and add it to the doc string.
1762 "Create a suitably named buffer for visiting FILENAME, and return it.
1763 FILENAME (sans directory) is used unchanged if that name is free;
1764 otherwise a string <2> or <3> or ... is appended to get an unused name.
1766 Emacs treats buffers whose names begin with a space as internal buffers.
1767 To avoid confusion when visiting a file whose name begins with a space,
1774 lastname))))
1777 "Create and return a buffer with a name based on NAME.
1778 Choose the buffer's name using `generate-new-buffer-name'."
1782 "Regexp to match the automounter prefix in a directory name."
1788 "Regexp matching the user's homedir at the beginning of file name.
1792 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1794 home directory is a root directory) and removes automounter prefixes
1795 \(see the variable `automount-dir-prefix')."
1796 ;; Get rid of the prefixes added by the automounter.
1803 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1805 ;; If any elt of directory-abbrev-alist matches this name,
1806 ;; abbreviate accordingly.
1812 ;; Compute and save the abbreviated homedir name.
1813 ;; We defer computing this until the first time it's needed, to
1814 ;; give time for directory-abbrev-alist to be set properly.
1815 ;; We include a slash at the end, to avoid spurious matches
1816 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1824 ;; Depending on whether default-directory does or
1825 ;; doesn't include non-ASCII characters, the value
1826 ;; of abbreviated-home-dir could be multibyte or
1827 ;; unibyte. In the latter case, we need to decode
1828 ;; it. Note that this function is called for the
1829 ;; first time (from startup.el) when
1830 ;; locale-coding-system is already set up.
1832 abbreviated-home-dir
1835 'utf-8
1836 locale-coding-system))))))
1838 ;; If FILENAME starts with the abbreviated homedir,
1839 ;; make it start with `~' instead.
1841 ;; If the home dir is just /, don't change it.
1844 ;; MS-DOS root directories can come with a drive letter;
1845 ;; Novell Netware allows drive letters beyond `Z:'.
1853 filename)))
1856 "Return the buffer visiting file FILENAME (a string).
1857 This is like `get-file-buffer', except that it checks for any buffer
1858 visiting the same file, possibly under a different name.
1859 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1860 and others are ignored.
1861 If there is no such live buffer, return nil."
1874 found)
1884 ;; Verify this buffer's file number
1885 ;; still belongs to its file.
1888 attributes)
1892 found))))
1893 \f
1895 "Non-nil means file-visiting commands should handle wildcards.
1896 For example, if you specify `*.c', that would visit all the files
1897 whose names match the pattern."
1903 "Non-nil means suppress warning messages for symlinked files.
1904 When nil, Emacs prints a warning when visiting a file that is already
1905 visited, but with a different name. Setting this option to t
1906 suppresses this warning."
1912 "Maximum size of file above which a confirmation is requested.
1913 When nil, never request confirmation."
1920 "Warn if file size exceeds this percentage of available free memory.
1921 When nil, never issue warning. Beware: This probably doesn't do what you
1929 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1930 OP-TYPE specifies the file operation being performed (for message to user)."
1939 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1949 "You are trying to open a file whose size (%s)
1950 exceeds the %S%% of currently available free memory (%s).
1951 If that fails, try to open it with `find-file-literally'
1952 \(but note that some characters might be displayed incorrectly)."
1954 out-of-memory-warning-percentage
1958 "Like `message', except sometimes don't print to minibuffer.
1959 If the variable `save-silently' is non-nil, the message is not
1960 displayed on the minibuffer."
1965 "Read file FILENAME into a buffer and return the buffer.
1966 If a buffer exists visiting FILENAME, return that one, but
1967 verify that the file has not changed since visited or saved.
1968 The buffer is not selected, just returned to the caller.
1969 Optional second arg NOWARN non-nil means suppress any warning messages.
1970 Optional third arg RAWFILE non-nil means the file is read literally.
1971 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1972 and visit all the matching files. When wildcards are actually
1973 used and expanded, return a list of buffers that are visiting
1974 the various files."
1981 'find-directory-functions
1984 filename)))
1987 find-file-wildcards
2001 ;; Find any buffer for a file which has same truename.
2003 ;; Let user know if there is a buffer with the same truename.
2007 find-file-suppress-same-file-warnings
2011 ;; Optionally also find that buffer.
2014 ;; Check to see if the file looks uncommonly large.
2019 ;; We are using an existing buffer.
2026 ;; Certain files should be reverted automatically
2027 ;; if they have changed on disk and not in the buffer.
2035 found))
2045 "File %s changed on disk. Discard your edits? "
2050 "File %s changed on disk. Discard your edits in %s? "
2058 ;; Check if a formerly read-only file has become
2059 ;; writable and vice versa, but if the buffer agrees
2060 ;; with the new state of the file, that is ok too.
2070 buffer-file-name
2071 new-status new-status)))
2077 nonexistent
2078 ;; It is confusing to ask whether to visit
2079 ;; non-literally if they have the file in
2080 ;; hexl-mode or image-mode.
2086 "The file %s is already visited normally,
2087 and you have edited the buffer. Now you have asked to visit it literally,
2088 meaning no coding system handling, format conversion, or local variables.
2089 Emacs can only visit a file in one way at a time.
2091 Do you want to save the file, and visit it literally instead? "
2092 "The file %s is already visited literally,
2093 meaning no coding system handling, format conversion, or local variables.
2094 You have edited the buffer. Now you have asked to visit the file normally,
2095 but Emacs can only visit a file in one way at a time.
2102 rawfile truename number))
2106 "\
2107 Do you want to discard your changes, and visit the file literally now? "
2108 "\
2111 rawfile truename number)
2117 "The file %s is already visited normally.
2118 You have asked to visit it literally,
2119 meaning no coding system decoding, format conversion, or local variables.
2120 But Emacs can only visit a file in one way at a time.
2122 Do you want to revisit the file literally now? "
2123 "The file %s is already visited literally,
2124 meaning no coding system decoding, format conversion, or local variables.
2125 You have asked to visit it normally,
2126 but Emacs can only visit a file in one way at a time.
2131 rawfile truename number)
2134 ;; Return the buffer we are using.
2135 buf)
2136 ;; Create a new buffer.
2138 ;; find-file-noselect-1 may use a different buffer.
2140 rawfile truename number))))))
2146 ;; Needed in case we are re-visiting the file with a different
2147 ;; text representation.
2164 filename)))
2165 ;; Unconditionally set error
2175 filename)))
2176 ;; Run find-file-not-found-functions until one returns non-nil.
2178 ;; If they fail too, set error.
2180 ;; Record the file's truename, and maybe use that as visited name.
2188 ;; Set buffer's default directory to that of the file.
2190 ;; Turn off backup files for certain file names. Since
2191 ;; this is a permanent local, the major mode won't eliminate it.
2205 \f
2207 "Like `insert-file-contents', but only reads in the file literally.
2208 See `insert-file-contents' for an explanation of the parameters.
2209 A buffer may be modified in several ways after reading into the buffer,
2210 due to Emacs features such as format decoding, character code
2211 conversion, `find-file-hook', automatic uncompression, etc.
2213 This function ensures that none of these modifications will take place."
2219 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2220 ;; into a file operation instead!
2222 inhibit-file-name-handlers))
2229 filename)))
2230 ;; Check whether the file is uncommonly large
2241 "Insert contents of file FILENAME into buffer after point with no conversion.
2243 This function is meant for the user to run interactively.
2244 Don't call it from programs! Use `insert-file-contents-literally' instead.
2245 \(Its calling sequence is different; see its documentation)."
2251 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2252 This has the `permanent-local' property, which takes effect if you
2257 "Visit file FILENAME with no conversion of any kind.
2258 Format conversion and character code conversion are both disabled,
2259 and multibyte characters are disabled in the resulting buffer.
2260 The major mode used is Fundamental mode regardless of the file name,
2261 and local variable specifications in the file are ignored.
2262 Automatic uncompression and adding a newline at the end of the
2263 file due to `require-final-newline' is also disabled.
2265 You cannot absolutely rely on this function to result in
2266 visiting the file literally. If Emacs already has a buffer
2267 which is visiting the file, you get the existing buffer,
2268 regardless of whether it was created literally or not.
2270 In a Lisp program, if you want to be sure of accessing a file's
2271 contents literally, you should create a temporary buffer and then read
2272 the file contents into it using `insert-file-contents-literally'."
2275 "Find file literally: " nil default-directory
2278 \f
2280 _after-find-file-from-revert-buffer
2281 nomodes)
2282 "Called after finding a file and by the default revert function.
2283 Sets buffer mode, parses local variables.
2284 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2285 error in reading the file. WARN non-nil means warn if there
2286 exists an auto-save file more recent than the visited file.
2287 NOAUTO means don't mess with auto-save mode.
2288 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2289 \(see `revert-buffer-in-progress-p' for similar functionality).
2290 Fifth arg NOMODES non-nil means don't alter the file's modes.
2291 Finishes by calling the functions in `find-file-hook'
2292 unless NOMODES is non-nil."
2295 nil
2305 "Symbolic link that points to nonexistent file"
2309 ;; No need to warn if buffer is auto-saved
2310 ;; under the name of the visited file.
2312 auto-save-visited-file-name))
2315 buffer-file-name))
2335 ;; Make people do a little extra work (C-x C-q)
2336 ;; before altering a backup file.
2339 ;; When a file is marked read-only,
2340 ;; make the buffer read-only even if root is looking at it.
2348 ;; If requested, add a newline at the end of the file.
2359 view-read-only
2367 "Choose the major mode for this buffer automatically.
2368 Also sets up any specified local variables of the file.
2369 Uses the visited file name, the -*- line, and the local variables spec.
2371 This function is called automatically from `find-file'. In that case,
2372 we may set up the file-specified mode and local variables,
2373 depending on the value of `enable-local-variables'.
2374 In addition, if `local-enable-local-variables' is nil, we do
2375 not set local variables (though we do notice a mode specified with -*-.)
2377 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2378 or from Lisp without specifying the optional argument FIND-FILE;
2379 in that case, this function acts as if `enable-local-variables' were t."
2386 ;; FIXME this is less efficient than it could be, since both
2387 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2390 ;; `delay-mode-hooks' being non-nil will have prevented the major
2391 ;; mode's call to `run-mode-hooks' from calling
2392 ;; `hack-local-variables'. In that case, call it now.
2396 ;; Turn font lock off and on, to make sure it takes account of
2397 ;; whatever file local variables are relevant to it.
2399 ;; Font-lock-mode (now in font-core.el) can be ON when
2400 ;; font-lock.el still hasn't been loaded.
2407 "Non-nil means to try second pass through `auto-mode-alist'.
2408 This means that if the first case-sensitive search through the alist fails
2409 to find a matching major mode, a second case-insensitive search is made.
2410 On systems with case-insensitive file names, this variable is ignored,
2411 since only a single case-insensitive search through the alist is made."
2417 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2418 ;; c++-mode, java-mode and more) are added through autoload
2419 ;; directives in that file. That way is discouraged since it
2420 ;; spreads out the definition of the initial value.
2466 ;; Less common extensions come here
2467 ;; so more common ones above are found faster.
2475 ;; Besides .gdbinit, gdb documents other names to be usable for init
2476 ;; files, cross-debuggers can use something like
2477 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2478 ;; don't interfere with each other.
2480 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2481 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2482 ;; loaded when GDB reads an objfile called 'emacs'.
2490 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2514 ;; The Fortran standard does not say anything about file extensions.
2515 ;; .f90 was widely used for F90, now we seem to be trapped into
2516 ;; using a different extension for each language revision.
2517 ;; Anyway, the following extensions are supported by gfortran.
2525 ;; The list of archive file extensions should be in sync with
2526 ;; `auto-coding-alist' with `no-conversion' coding system.
2532 ;; Mailer puts message to be edited in
2533 ;; /tmp/Re.... or Message
2536 ;; some news reader is reported to use this
2549 ;; .emacs or .gnus or .viper following a directory delimiter in
2550 ;; Unix or MS-DOS syntax.
2553 ;; _emacs following a directory delimiter in MS-DOS syntax
2557 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2558 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2559 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2562 ;; .xs is also used for ld scripts, but seems to be more commonly
2563 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2565 ;; Explained in binutils ld/genscripts.sh. Eg:
2566 ;; A .x script file is the default script.
2567 ;; A .xr script is for linking without relocation (-r flag). Etc.
2571 ;; Common Lisp ASDF package system.
2578 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2590 ;; Windows candidates may be opened case sensitively on Unix
2596 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2597 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2598 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2599 ;; this has lower priority to avoid matching changelog.sgml etc.
2601 ;; either user's dot-files or under /etc or some such
2603 ;; alas not all ~/.*rc files are like this
2604 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2609 ;; this contains everything twice, with space and with colon :-(
2611 ;; Get rid of any trailing .n.m and try again.
2612 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2613 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2614 ;; Using mode nil rather than `ignore' would let the search continue
2615 ;; through this list (with the shortened name) rather than start over.
2618 ;; This should come after "in" stripping (e.g. config.h.in).
2619 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2621 ;; The following should come after the ChangeLog pattern
2622 ;; for the sake of ChangeLog.1, etc.
2623 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2625 "Alist of filename patterns vs corresponding major mode functions.
2626 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2627 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2628 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2629 mode function to use. FUNCTION will be called, unless it is nil.
2631 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2632 calling FUNCTION (if it's not nil), we delete the suffix that matched
2633 REGEXP and search the list again for another match.
2635 The extensions whose FUNCTION is `archive-mode' should also
2636 appear in `auto-coding-alist' with `no-conversion' coding system.
2638 See also `interpreter-mode-alist', which detects executable script modes
2639 based on the interpreters they specify to run,
2644 "Select Conf mode or XML mode according to start of file."
2654 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2655 ;; and pike-mode) are added through autoload directives in that
2656 ;; file. That way is discouraged since it spreads out the
2657 ;; definition of the initial value.
2686 "Alist mapping interpreter names to major modes.
2687 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2688 Each element looks like (REGEXP . MODE).
2689 If REGEXP matches the entire name (minus any directory part) of
2690 the interpreter specified in the first line of a script, enable
2691 major mode MODE.
2698 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2699 ;; because we are duplicating info from auto-mode-alist.
2700 ;; TODO many elements of this list are also in auto-coding-alist.
2709 "List of regexps matching file names in which to ignore local variables.
2711 Files matching this list are typically binary file formats.
2712 They may happen to contain sequences that look like local variable
2713 specifications, but are not really, or they may be containers for
2714 member files with their own local variable sections, which are
2715 not appropriate for the containing file.
2722 "List of regexps matching suffixes to remove from file names.
2723 The function `inhibit-local-variables-p' uses this: when checking
2724 a file name, it first discards from the end of the name anything that
2727 ;; Can't think of any situation in which you'd want this to be nil...
2732 "Return non-nil if file local variables should be ignored.
2733 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2734 and `inhibit-local-variables-suffixes'. If
2735 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2744 sufs)
2749 temp))
2754 "Regexp matching interpreters, for file mode determination.
2755 This regular expression is matched against the first line of a file
2756 to determine the file's mode in `set-auto-mode'. If it matches, the file
2757 is assumed to be interpreted by the interpreter matched by the second group
2758 of the regular expression. The mode is then determined as the mode
2762 "Alist of buffer beginnings vs. corresponding major mode functions.
2763 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2764 After visiting a file, if REGEXP matches the text at the beginning of the
2765 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2766 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2767 major mode.
2769 If FUNCTION is nil, then it is not called. (That is a way of saying
2777 ;; The < comes before the groups (but the first) to reduce backtracking.
2778 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2779 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2783 comment-re "*"
2786 . html-mode)
2788 ;; These two must come after html, because they are more general:
2793 . sgml-mode)
2796 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2797 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2798 After visiting a file, if REGEXP matches the text at the beginning of the
2799 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2800 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2801 have not specified a mode for this file.
2807 "Upper limit on `magic-mode-alist' regexp matches.
2811 "Select major mode appropriate for current buffer.
2813 To find the right major mode, this function checks for a -*- mode tag
2814 checks for a `mode:' entry in the Local Variables section of the file,
2815 checks if it uses an interpreter listed in `interpreter-mode-alist',
2816 matches the buffer beginning against `magic-mode-alist',
2817 compares the filename against the entries in `auto-mode-alist',
2818 then matches the buffer beginning against `magic-fallback-mode-alist'.
2820 If `enable-local-variables' is nil, or if the file name matches
2821 `inhibit-local-variables-regexps', this function does not check
2822 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2823 is nil, then the only mode: tag that can be relevant is a -*- one.
2825 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2826 set the major mode only if that would change it. In other words
2827 we don't actually set it to the same mode the buffer already has."
2828 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2830 end done mode modes)
2831 ;; Once we drop the deprecated feature where mode: is also allowed to
2832 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2833 ;; remove this section and just let (hack-local-variables t) handle it.
2834 ;; Find a -*- mode tag.
2838 ;; Note by design local-enable-local-variables does not matter here.
2840 try-locals
2843 ;; Find all specifications for the `mode:' variable
2844 ;; and execute them left to right.
2856 modes)))
2857 ;; Simple -*-MODE-*- case.
2860 modes))))
2861 ;; If we found modes to use, invoke them now, outside the save-excursion.
2869 ;; continuing would call minor modes again, toggling them off
2871 ;; hack-local-variables checks local-enable-local-variables etc, but
2872 ;; we might as well be explicit here for the sake of clarity.
2874 enable-local-variables
2875 local-enable-local-variables
2876 try-locals
2883 ;; If we didn't, look for an interpreter specified in the first line.
2884 ;; As a special case, allow for things like "#!/bin/env perl", which
2885 ;; finds the interpreter anywhere in $PATH.
2891 ;; Map interpreter name to a mode, signaling we're done at the
2892 ;; same time.
2899 interpreter-mode-alist)
2901 ;; If we found an interpreter mode to use, invoke it now.
2903 ;; Next try matching the buffer beginning against magic-mode-alist.
2917 ;; Next compare the filename against the entries in auto-mode-alist.
2923 buffer-file-name)))
2924 ;; Remove backup-suffixes from file name.
2926 ;; Remove remote file name identification.
2931 ;; Find first matching alist entry.
2934 ;; Filesystem is case-insensitive.
2938 ;; Filesystem is case-sensitive.
2940 ;; First match case-sensitively.
2944 ;; Fallback to case-insensitive match.
2958 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2975 ;; When `keep-mode-if-same' is set, we are working on behalf of
2976 ;; set-visited-file-name. In that case, if the major mode specified is the
2977 ;; same one we already have, don't actually reset it. We don't want to lose
2978 ;; minor modes such as Font Lock.
2980 "Apply MODE and return it.
2981 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2982 any aliases and compared to current major mode. If they are the
2983 same, do nothing and return nil."
2989 mode)))
2992 "Regexp of lines to skip when looking for file-local settings.
2993 If the first line matches this regular expression, then the -*-...-*- file-
2997 "Find the -*- spec in the buffer.
2998 Call with point at the place to start searching from.
2999 If one is found, set point to the beginning and return the position
3000 of the end. Otherwise, return nil; may change point.
3001 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3002 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3003 have no effect."
3006 ;; Don't look for -*- if this file name matches any
3007 ;; of the regexps in inhibit-local-variables-regexps.
3010 ;; If the file begins with "#!" (exec
3011 ;; interpreter magic), look for mode frobs
3012 ;; in the first two lines. You cannot
3013 ;; necessarily put them in the first line
3014 ;; of such a file without screwing up the
3015 ;; interpreter invocation. The same holds
3016 ;; for '\" in man pages (preprocessor
3017 ;; magic for the `man' program).
3028 end))))
3029 \f
3030 ;;; Handling file local variables
3034 file-local-variables-alist dir-local-variables-alist)
3039 "Normal hook run after processing a file's local variables specs.
3040 Major modes can use this to examine user-specified local variables
3044 "List variable-value pairs that are considered safe.
3045 Each element is a cons cell (VAR . VAL), where VAR is a variable
3046 symbol and VAL is a value that is considered safe."
3047 :risky t
3052 ;; This should be here at least as long as Emacs supports write-file-hooks.
3057 "Expressions that are considered safe in an `eval:' local variable.
3058 Add expressions to this list if you want Emacs to evaluate them, when
3059 they appear in an `eval' local variable specification, without first
3060 asking you for confirmation."
3061 :risky t
3066 ;; Risky local variables:
3069 buffer-auto-save-file-name
3070 buffer-file-name
3071 buffer-file-truename
3072 buffer-undo-list
3073 debugger
3074 default-text-properties
3075 eval
3076 exec-directory
3077 exec-path
3078 file-name-handler-alist
3079 frame-title-format
3080 global-mode-string
3081 header-line-format
3082 icon-title-format
3083 inhibit-quit
3084 load-path
3085 max-lisp-eval-depth
3086 max-specpdl-size
3087 minor-mode-map-alist
3088 minor-mode-overriding-map-alist
3089 mode-line-format
3090 mode-name
3091 overriding-local-map
3092 overriding-terminal-local-map
3093 process-environment
3094 standard-input
3095 standard-output
3096 unread-command-events))
3098 ;; Safe local variables:
3099 ;;
3100 ;; For variables defined by major modes, the safety declarations can go into
3101 ;; the major mode's file, since that will be loaded before file variables are
3102 ;; processed.
3103 ;;
3104 ;; For variables defined by minor modes, put the safety declarations in the
3105 ;; file defining the minor mode after the defcustom/defvar using an autoload
3106 ;; cookie, e.g.:
3107 ;;
3108 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3109 ;;
3110 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3111 ;; minor mode file may not be loaded yet.
3112 ;;
3113 ;; For variables defined in the C source code the declaration should go here:
3135 "Alist of file-local variable settings in the current buffer.
3136 Each element in this list has the form (VAR . VALUE), where VAR
3137 is a file-local variable (a symbol) and VALUE is the value
3138 specified. The actual value in the buffer may differ from VALUE,
3144 "Alist of directory-local variable settings in the current buffer.
3145 Each element in this list has the form (VAR . VALUE), where VAR
3146 is a directory-local variable (a symbol) and VALUE is the value
3147 specified in .dir-locals.el. The actual value in the buffer
3148 may differ from VALUE, if it is changed by the major or minor modes,
3153 "Normal hook run before setting file-local variables.
3154 It is called after checking for unsafe/risky variables and
3155 setting `file-local-variables-alist', and before applying the
3156 variables stored in `file-local-variables-alist'. A hook
3157 function is allowed to change the contents of this alist.
3159 This hook is called only if there is at least one file-local
3163 "Get confirmation before setting up local variable values.
3164 ALL-VARS is the list of all variables to be set up.
3165 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3166 RISKY-VARS is the list of those that are marked as risky.
3167 If these settings come from directory-local variables, then
3168 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3175 unsafe-vars))
3177 ;; Set up the contents of the *Local Variables* buffer.
3185 ", and variables that are risky (**)."
3193 y -- to apply the local variables list.
3197 ! -- to apply the local variables list, and permanently mark these
3209 ;; Make strings with embedded whitespace easier to read.
3217 ;; Display the buffer and read a choice.
3225 ""
3228 char)
3247 "Return local variables specified in the -*- line.
3248 Usually returns an alist of elements (VAR . VAL), where VAR is a
3249 variable and VAL is the specified value. Ignores any
3250 specification for `coding:', and sometimes for `mode' (which
3251 should have already been handled by `set-auto-coding' and
3252 `set-auto-mode', respectively). Return nil if the -*- line is
3253 malformed.
3255 If HANDLE-MODE is nil, we return the alist of all the local
3256 variables in the line except `coding' as described above. If it
3257 is neither nil nor t, we do the same, except that any settings of
3258 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3259 all settings in the line except for `mode', which \(if present) we
3260 return as the symbol specifying the mode."
3265 result)
3267 nil)
3269 ;; Simple form: "-*- MODENAME -*-".
3273 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3274 ;; (last ";" is optional).
3275 ;; If HANDLE-MODE is t, just check for `mode'.
3276 ;; Otherwise, parse the -*- line into the RESULT alist.
3284 ;; There used to be a downcase here,
3285 ;; but the manual didn't say so,
3286 ;; and people want to set var names that aren't all lc.
3292 ;; It is traditional to ignore
3293 ;; case when checking for `mode' in set-auto-mode,
3294 ;; so we must do that here as well.
3295 ;; That is inconsistent, but we're stuck with it.
3296 ;; The same can be said for `coding' in set-auto-coding.
3310 ;; Downcase "Mode:".
3313 val)
3314 result)
3317 result))))))
3320 "Filter local variable settings, querying the user if necessary.
3321 VARIABLES is the alist of variable-value settings. This alist is
3322 filtered based on the values of `ignored-local-variables',
3323 `enable-local-eval', `enable-local-variables', and (if necessary)
3324 user interaction. The results are added to
3325 `file-local-variables-alist', without applying them.
3326 If these settings come from directory-local variables, then
3327 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3328 ;; Find those variables that we may want to save to
3329 ;; `safe-local-variable-values'.
3335 ;; Ignore any variable in `ignored-local-variables'.
3336 nil)
3337 ;; Obey `enable-local-eval'.
3341 ;; In case previously marked safe (bug#5636).
3343 ;; If not safe and e-l-v = :safe, ignore totally.
3347 safe
3349 ;; Ignore duplicates (except `mode') in the present list.
3351 ;; Accept known-safe variables.
3355 ;; The variable is either risky or unsafe:
3362 ;; Query, unless all vars are safe or user wants no querying.
3368 risky-vars dir-name))
3378 ;; TODO? Warn once per file rather than once per session?
3382 "Parse and put into effect this buffer's local variables spec.
3383 Uses `hack-local-variables-apply' to apply the variables.
3385 If HANDLE-MODE is nil, we apply all the specified local
3386 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3387 except that any settings of `mode' are ignored.
3390 is specified, and return the corresponding mode symbol, or nil.
3391 In this case, we try to ignore minor-modes, and only return a
3392 major-mode.
3394 If `enable-local-variables' or `local-enable-local-variables' is nil,
3395 this function does nothing. If `inhibit-local-variables-regexps'
3396 applies to the file in question, the file is not scanned for
3397 local variables, but directory-local variables may still be applied."
3398 ;; We don't let inhibit-local-variables-p influence the value of
3399 ;; enable-local-variables, because then it would affect dir-local
3400 ;; variables. We don't want to search eg tar files for file local
3401 ;; variable sections, but there is no reason dir-locals cannot apply
3402 ;; to them. The real meaning of inhibit-local-variables-p is "do
3403 ;; not scan this file for local variables".
3406 result)
3410 ;; Note this is a no-op if enable-local-variables is nil.
3412 ;; This entire function is basically a no-op if enable-local-variables
3413 ;; is nil. All it does is set file-local-variables-alist to nil.
3415 ;; This part used to ignore enable-local-variables when handle-mode
3416 ;; was t. That was inappropriate, eg consider the
3417 ;; (artificial) example of:
3418 ;; (setq local-enable-local-variables nil)
3419 ;; Open a file foo.txt that contains "mode: sh".
3420 ;; It correctly opens in text-mode.
3421 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3423 ;; If HANDLE-MODE is t, and the prop line specifies a
3424 ;; mode, then we're done, and have no need to scan further.
3426 handle-mode))
3428 ;; Look for "Local variables:" line in last page.
3436 ;; suffix is what comes after "local variables:" in its line.
3437 ;; prefix is what comes before "local variables:" in its line.
3450 endpos
3456 nil t))
3457 ;; This used to be an error, but really all it means is
3458 ;; that this may simply not be a local-variables section,
3459 ;; so just ignore it.
3469 ;; Discard the prefix.
3474 ;; Discard the suffix.
3483 ;; Find the variable name;
3491 val val2)
3494 ;; Read the variable value.
3501 ;; Specifying minor-modes via mode: is
3502 ;; deprecated, but try to reject them anyway.
3512 'files
3514 "%s: `lexical-binding' at end of file unreliable"
3516 ;; We are called from
3517 ;; 'with-temp-buffer', so we need
3518 ;; to use 'thisbuf's name in the
3519 ;; warning message.
3525 'eval
3529 ;; Now we've read all the local variables.
3530 ;; If HANDLE-MODE is t, return whether the mode was specified.
3532 ;; Otherwise, set the variables.
3537 "Apply the elements of `file-local-variables-alist'.
3538 If there are any elements, runs `before-hack-local-variables-hook',
3539 then calls `hack-one-local-variable' to apply the alist elements one by one.
3540 Finishes by running `hack-local-variables-hook', regardless of whether
3541 the alist is empty or not.
3543 Note that this function ignores a `mode' entry if it specifies the same
3544 major mode as the buffer already has."
3546 ;; Any 'evals must run in the Right sequence.
3555 "Non-nil if SYM is safe as a file-local variable with value VAL.
3556 It is safe if any of these conditions are met:
3558 * There is a matching entry (SYM . VAL) in the
3559 `safe-local-variable-values' user option.
3561 * The `safe-local-variable' property of SYM is a function that
3562 evaluates to a non-nil value with VAL as an argument."
3566 ;; If the function signals an error, that means it
3567 ;; can't assure us that the value is safe.
3571 "Non-nil if SYM could be dangerous as a file-local variable.
3572 It is dangerous if either of these conditions are met:
3574 * Its `risky-local-variable' property is non-nil.
3580 ;; If this is an alias, check the base name.
3600 "Return t if it is safe to eval EXP when it is found in a file."
3602 ;; Detect certain `put' expressions.
3609 lisp-indent-function
3610 scheme-indent-function))
3611 ;; Only allow safe values (not functions).
3616 ;; Only allow indirect form specs.
3617 ;; During bootstrapping, edebug-basic-spec might not be
3618 ;; defined yet.
3622 ;; Allow expressions that the user requested.
3624 ;; Certain functions can be allowed with safe arguments
3625 ;; or can specify verification functions to try.
3627 ;; Allow (minor)-modes calls with no arguments.
3628 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3637 ok))
3645 ok))))))))
3659 "Set local variable VAR with value VAL.
3660 If VAR is `mode', call `VAL-mode' as a function unless it's
3661 already the major mode."
3663 (`mode
3669 (`eval
3675 ;; Make sure the string has no text properties.
3676 ;; Some text properties can get evaluated in various ways,
3677 ;; so it is risky to put them on with a local variable list.
3681 \f
3682 ;;; Handling directory-local variables, aka project settings.
3688 "List of cached directory roots for directory-local variable classes.
3689 Each element in this list has the form (DIR CLASS MTIME).
3690 DIR is the name of the directory.
3691 CLASS is the name of a variable class (a symbol).
3692 MTIME is the recorded modification time of the directory-local
3693 variables file associated with this entry. This time is a list
3694 of integers (the same format as `file-attributes'), and is
3695 used to test whether the cache entry is still valid.
3696 Alternatively, MTIME can be nil, which means the entry is always
3700 "Return the variable list for CLASS."
3704 "Collect directory-local variables from MODE-VARIABLES.
3705 VARIABLES is the initial list of variables.
3706 Returns the new list."
3711 ;; If variables are specified more than once, only use the last. (Why?)
3712 ;; The pseudo-variables mode and eval are different (bug#3430).
3715 ;; Need a new cons in case we setcdr later.
3719 "Collect entries from CLASS-VARIABLES into VARIABLES.
3720 ROOT is the root directory of the project.
3721 Return the new variables list."
3723 ;; Handle non-file buffers, too.
3726 ;; FIXME: Why not use file-relative-name?
3733 ;; Don't include this in the previous condition, because we
3734 ;; want to filter all strings before the next condition.
3748 ;; TODO someone might want to extend this to allow
3749 ;; integer values for subdir, where N means
3750 ;; variables apply to this directory and N levels
3751 ;; below it (0 == nil).
3754 alist variables))))))))
3756 ;; The file's content might be invalid (e.g. have a merge conflict), but
3757 ;; that shouldn't prevent the user from opening the file.
3759 nil))))
3762 "Declare that the DIRECTORY root is an instance of CLASS.
3763 DIRECTORY is the name of a directory, a string.
3764 CLASS is the name of a project class, a symbol.
3765 MTIME is either the modification time of the directory-local
3766 variables file that defined this class, or nil.
3768 When a file beneath DIRECTORY is visited, the mode-specific
3769 variables from CLASS are applied to the buffer. The variables
3770 for a class are defined using `dir-locals-set-class-variables'."
3777 "Map the type CLASS to a list of variable settings.
3778 CLASS is the project class, a symbol. VARIABLES is a list
3779 that declares directory-local variables for the class.
3780 An element in VARIABLES is either of the form:
3781 (MAJOR-MODE . ALIST)
3782 or
3783 (DIRECTORY . LIST)
3785 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3786 whose elements are of the form (VARIABLE . VALUE).
3788 In the second form, DIRECTORY is a directory name (a string), and
3789 LIST is a list of the form accepted by the function.
3791 When a file is visited, the file's class is found. A directory
3792 may be assigned a class using `dir-locals-set-directory-class'.
3793 Then variables are set in the file's buffer according to the
3794 VARIABLES list of the class. The list is processed in order.
3796 * If the element is of the form (MAJOR-MODE . ALIST), and the
3797 buffer's major mode is derived from MAJOR-MODE (as determined
3798 by `derived-mode-p'), then all the variables in ALIST are
3799 applied. A MAJOR-MODE of nil may be used to match any buffer.
3800 `make-local-variable' is called for each variable before it is
3801 set.
3803 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3804 is an initial substring of the file's directory, then LIST is
3805 applied by recursively following these rules."
3809 "File that contains directory-local variables.
3810 It has to be constant to enforce uniform values across different
3811 environments and users.
3812 See also `dir-locals-file-2', whose values override this one's.
3816 "File that contains directory-local variables.
3817 This essentially a second file that can be used like
3818 `dir-locals-file', so that users can have specify their personal
3819 dir-local variables even if the current directory already has a
3820 `dir-locals-file' that is shared with other users (such as in a
3821 git repository).
3825 "Return a list of all readable dir-locals files in DIRECTORY.
3826 The returned list is sorted by increasing priority. That is,
3827 values specified in the last file should take precedence over
3828 those in the first."
3832 dir-locals-file)
3833 directory))
3837 ;; The order here is important.
3844 out)))
3847 "Find the directory-local variables for FILE.
3848 This searches upward in the directory tree from FILE.
3849 It stops at the first directory that has been registered in
3850 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3851 If it finds an entry in the cache, it checks that it is valid.
3852 A cache entry with no modification time element (normally, one that
3853 has been assigned directly using `dir-locals-set-directory-class', not
3854 set from a file) is always valid.
3855 A cache entry based on a `dir-locals-file' is valid if the modification
3856 time stored in the cache matches the current file modification time.
3857 If not, the cache entry is cleared so that the file will be re-read.
3859 This function returns either:
3860 - nil (no directory local variables found),
3861 - the matching entry from `dir-locals-directory-cache' (a list),
3862 - or the full path to the directory (a string) containing at
3863 least one `dir-locals-file' in the case of no valid cache
3864 entry."
3868 dir-elt)
3869 ;; `locate-dominating-file' may have abbreviated the name.
3872 ;; Find the best cached value in `dir-locals-directory-cache'.
3883 ;; Found a potential cache entry. Check validity.
3884 ;; A cache entry with no MTIME is assumed to always be valid
3885 ;; (ie, set directly, not from a dir-locals file).
3886 ;; Note, we don't bother to check that there is a matching class
3887 ;; element in dir-locals-class-alist, since that's done by
3888 ;; dir-locals-set-directory-class.
3891 ;; The entry MTIME should match the most recent
3892 ;; MTIME among matching files.
3898 cached-files))))))
3899 ;; This cache entry is OK.
3900 dir-elt
3901 ;; This cache entry is invalid; clear it.
3904 ;; Return the first existing dir-locals file. Might be the same
3905 ;; as dir-elt's, might not (eg latter might have been deleted).
3906 locals-dir)
3907 ;; No cache entry.
3908 locals-dir)))
3911 "Load all variables files in DIR and register a new class and instance.
3912 DIR is the absolute name of a directory which must contain at
3913 least one dir-local file (which is a file holding variables to
3914 apply).
3915 Return the new class name, which is a symbol named DIR."
3929 variables
3935 dir class-name
3940 files))
3941 ;; If there was a problem, use the values we could get but
3942 ;; don't let the cache prevent future reads.
3944 class-name))
3950 "Non-nil means dir-local variables will be applied to remote files."
3958 "Read per-directory local variables for the current buffer.
3959 Store the directory-local variables in `dir-local-variables-alist'
3960 and `file-local-variables-alist', without applying them.
3962 This does nothing if either `enable-local-variables' or
3963 `enable-dir-local-variables' are nil."
3965 enable-dir-local-variables
3968 default-directory)))))
3969 ;; Find the variables file.
3999 "Apply directory-local variables to a non-file buffer.
4000 For non-file buffers, such as Dired buffers, directory-local
4001 variables are looked for in `default-directory' and its parent
4002 directories."
4006 \f
4009 However, the mode will not be changed if
4010 \(1) a local variables list or the `-*-' line specifies a major mode, or
4012 not suitable for ordinary files, or
4013 \(3) the new file name does not particularly specify any mode."
4018 "Change name of file visited in current buffer to FILENAME.
4019 This also renames the buffer to correspond to the new file.
4020 The next time the buffer is saved it will go in the newly specified file.
4021 FILENAME nil or an empty string means mark buffer as not visiting any file.
4022 Remember to delete the initial contents of the minibuffer
4023 if you wish to pass an empty string as the argument.
4025 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4026 confirmation in the case where another buffer is already visiting FILENAME.
4028 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4029 the old visited file has been renamed to the new name FILENAME."
4037 nil
4052 filename)))
4059 buffer-file-name filename)
4063 ;; If new-name == old-name, renaming would add a spurious <2>
4064 ;; and it's considered as a feature in rename-buffer.
4070 ;; Abbreviate the file names of the buffer.
4079 nil))
4080 ;; write-file-functions is normally used for things like ftp-find-file
4081 ;; that visit things that are not local files as if they were files.
4082 ;; Changing to visit an ordinary local file instead should flush the hook.
4087 ;; If buffer was read-only because of version control,
4088 ;; that reason is gone now, so make it writable.
4092 ;; Turn off backup files for certain file names.
4093 ;; Since this is a permanent local, the major mode won't eliminate it.
4095 backup-enable-predicate
4104 ;; If auto-save was not already on, turn it on if appropriate.
4107 ;; If auto save is on, start using a new name. We
4108 ;; deliberately don't rename or delete the old auto save
4109 ;; for the old visited file name. This is because
4110 ;; perhaps the user wants to save the new state and then
4111 ;; compare with the previous state from the auto save
4112 ;; file.
4114 ;; Rename the old auto save file if any.
4121 ;; Update the major mode, if the file name determines it.
4123 ;; Don't change the mode if it is special.
4126 ;; Don't change the mode if the local variable list specifies it.
4127 ;; The file name can influence whether the local variables apply.
4129 ;; h-l-v also checks it, but might as well be explicit.
4132 ;; TODO consider making normal-mode handle this case.
4140 "Write current buffer into file FILENAME.
4141 This makes the buffer visit that file, and marks it as not modified.
4143 If you specify just a directory name as FILENAME, that means to use
4144 the default file name but in that directory. You can also yank
4145 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4147 If the buffer is not already visiting a file, the default file name
4148 for the output file is the buffer name.
4150 If optional second arg CONFIRM is non-nil, this function
4151 asks for confirmation before overwriting an existing file.
4152 Interactively, confirmation is required unless you supply a prefix argument."
4153 ;; (interactive "FWrite file: ")
4157 nil nil nil nil)
4161 default-directory)
4162 nil nil))
4166 ;; If arg is just a directory,
4167 ;; use the default file name, but in that directory.
4174 ;; NS does its own confirm dialog.
4177 use-dialog-box))
4183 ;; Make buffer writable if file is writable.
4188 ;; It's likely that the VC status at the new location is different from
4189 ;; the one at the old location.
4191 \f
4193 "Return an alist of extended attributes of file FILENAME.
4195 Extended attributes are platform-specific metadata about the file,
4196 such as SELinux context, list of ACL entries, etc."
4201 "Set extended attributes of file FILENAME to ATTRIBUTES.
4203 ATTRIBUTES must be an alist of file attributes as returned by
4204 `file-extended-attributes'.
4205 Value is t if the function succeeds in setting the attributes."
4216 result))
4217 \f
4219 "Make a backup of the disk file visited by the current buffer, if appropriate.
4220 This is normally done before saving the buffer the first time.
4222 A backup may be done by renaming or by copying; see documentation of
4223 variable `make-backup-files'. If it's done by renaming, then the file is
4224 no longer accessible under its old name.
4226 The value is non-nil after a backup was made by renaming.
4227 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4228 MODES is the result of `file-modes' on the original
4229 file; this means that the caller, after saving the buffer, should change
4230 the modes of the new file to agree with the old modes.
4231 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4232 on the original file; this means that the caller, after saving
4233 the buffer, should change the extended attributes of the new file
4234 to agree with the old attributes.
4235 BACKUPNAME is the backup file name, which is the old file renamed."
4239 ;; If specified name is a symbolic link, chase it to the target.
4240 ;; This makes backups in the directory where the real file is.
4247 ;; If have old versions to maybe delete,
4248 ;; ask the user to confirm now, before doing anything.
4249 ;; But don't actually delete til later.
4255 real-file-name)))
4256 targets))
4261 backup-by-copying-when-privileged-mismatch)
4264 ;; Don't rename a suid or sgid file.
4273 real-file-name
4276 copy-when-priv-mismatch))))
4278 t)))))
4279 setmodes)
4282 ;; Actually make the backup file.
4285 modes extended-attributes)
4286 ;; rename-file should delete old backup.
4289 backupname)))
4291 ;; Now delete the old versions, if desired.
4295 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4299 backupname)
4302 modes extended-attributes)
4304 setmodes)))))))
4307 ;; Create temp files with strict access rights. It's easy to
4308 ;; loosen them later, whereas it's impossible to close the
4309 ;; time-window of loose permissions otherwise.
4312 ;; Try to overwrite old backup first.
4320 nil)
4322 ;; The file was somehow created by someone else between
4323 ;; `delete-file' and `copy-file', so let's try again.
4324 ;; rms says "I think there is also a possible race
4325 ;; condition for making backup files" (emacs-devel 20070821).
4326 nil)))
4327 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4336 ;; The last ~[[:digit]]+ matches relative versions in git,
4337 ;; e.g. `foo.js.~HEAD~1~'.
4338 "Regular expression matching the backup/version part of a file name.
4342 "Return file NAME sans backup versions or strings.
4343 This is a separate procedure so your site-init or startup file can
4344 redefine it.
4345 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4346 we do not remove backup version numbers, only true file version numbers.
4347 See also `file-name-version-regexp'."
4354 name))))))
4357 "Return t if deleting FILE and rewriting it would preserve the owner.
4358 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4359 the group would be preserved too."
4364 ;; Return t if the file doesn't exist, since it's true that no
4365 ;; information would be lost by an (attempted) delete and create.
4368 ;; Files created on Windows by Administrator (RID=500)
4369 ;; have the Administrators group (RID=544) recorded as
4370 ;; their owner. Rewriting them will still preserve the
4371 ;; owner.
4375 ;; On BSD-derived systems files always inherit the parent
4376 ;; directory's group, so skip the group-gid test.
4382 ;; On some systems, a file created in a setuid directory
4383 ;; inherits that directory's owner.
4387 ;; On many systems, a file created in a setgid directory
4388 ;; inherits that directory's group. On some systems
4389 ;; this happens even if the setgid bit is not set.
4396 The extension, in a file name, is the part that begins with the last `.',
4397 except that a leading `.' of the file name, if there is one, doesn't count."
4400 directory)
4404 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4405 ;; we don't want to expand it.
4408 filename))))
4412 The extension, in a file name, is the part that begins with the last `.',
4413 excluding version numbers and backup suffixes, except that a leading `.'
4414 of the file name, if there is one, doesn't count.
4415 Return nil for extensionless file names such as `foo'.
4416 Return the empty string for file names such as `foo.'.
4418 By default, the returned value excludes the period that starts the
4419 extension, but if the optional argument PERIOD is non-nil, the period
4420 is included in the value, and in that case, if FILENAME has no
4431 "Return the base name of the FILENAME: no directory, no extension.
4432 FILENAME defaults to `buffer-file-name'."
4437 #'make-backup-file-name--default-function
4438 "A function that `make-backup-file-name' uses to create backup file names.
4439 The function receives a single argument, the original file name.
4441 If you change this, you may need to change `backup-file-name-p' and
4442 `file-name-sans-versions' too.
4444 You could make this buffer-local to do something special for specific files.
4446 For historical reasons, a value of nil means to use the default function.
4447 This should not be relied upon.
4449 See also `backup-directory-alist'."
4456 "Alist of filename patterns and backup directory names.
4457 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4458 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4459 relative or absolute. If it is absolute, so that all matching files
4460 are backed up into the same directory, the file names in this
4461 directory will be the full name of the file backed up with all
4462 directory separators changed to `!' to prevent clashes. This will not
4463 work correctly if your filesystem truncates the resulting name.
4465 For the common case of all backups going into one directory, the alist
4467 directory name.
4469 If this variable is nil, or it fails to match a filename, the backup
4470 is made in the original file's directory.
4472 On MS-DOS filesystems without long names this variable is always
4473 ignored."
4479 "Default `backup-enable-predicate' function.
4480 Checks for files in `temporary-file-directory',
4483 caseless)
4484 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4485 ;; their long file-name equivalents, so compare-strings does TRT.
4489 caseless t))
4492 ;; Directory is under temporary-file-directory.
4497 ;; Directory is under /tmp.
4502 0 nil
4504 ;; Directory is under small-temporary-file-directory.
4509 "Create the non-numeric backup file name for FILE.
4510 This calls the function that `make-backup-file-name-function' specifies,
4511 with a single argument FILE."
4514 file))
4517 "Default function for `make-backup-file-name'.
4518 Normally this just returns FILE's name with `~' appended.
4519 It searches for a match for FILE in `backup-directory-alist'.
4520 If the directory for the backup doesn't exist, it is created."
4532 "Subroutine of `make-backup-file-name--default-function'.
4533 The function `find-backup-file-name' also uses this."
4535 elt backup-directory abs-backup-directory)
4540 alist nil)))
4541 ;; If backup-directory is relative, it should be relative to the
4542 ;; file's directory. By expanding explicitly here, we avoid
4543 ;; depending on default-directory.
4552 abs-backup-directory nil))))
4554 file
4558 ;; Normalize DOSish file names: downcase the drive
4559 ;; letter, if any, and replace the leading "x:" with
4560 ;; "/drive_x".
4563 ;; Replace any invalid file-name characters (for the
4564 ;; case of backing up remote files).
4568 "drive_"
4571 ""
4574 ;; Make the name unique by substituting directory
4575 ;; separators. It may not really be worth bothering about
4576 ;; doubling `!'s in the original name...
4581 backup-directory))
4586 "Return non-nil if FILE is a backup file name (numeric or not).
4587 This is a separate function so you can redefine it for customization.
4588 You may need to redefine `file-name-sans-versions' as well."
4593 ;; This is used in various files.
4594 ;; The usage of backup-extract-version-start is not very clean,
4595 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4597 "Given the name of a numeric backup file, FN, return the backup number.
4598 Uses the free variable `backup-extract-version-start', whose value should be
4599 the index in the name where the version number begins."
4606 "Find a file name for a backup file FN, and suggestions for deletions.
4607 Value is a list whose car is the name for the backup file
4608 and whose cdr is a list of old versions to consider deleting now.
4609 If the value is nil, don't make a backup.
4610 Uses `backup-directory-alist' in the same way as
4611 `make-backup-file-name--default-function' does."
4613 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4617 ;; We don't support numbered backups on plain MS-DOS
4618 ;; when long file names are unavailable.
4628 possibilities deserve-versions-p versions)
4631 base-versions
4634 possibilities)
4635 #'<)
4640 kept-old-versions
4641 kept-new-versions
4648 ;; Delete nothing if there is overflow
4649 ;; in the number of versions to keep.
4655 v))))))))))
4658 "Return number of names file FILENAME has."
4661 ;; (defun file-relative-name (filename &optional directory)
4662 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4663 ;; This function returns a relative file name which is equivalent to FILENAME
4664 ;; when used with that default directory as the default.
4665 ;; If this is impossible (which can happen on MSDOS and Windows
4666 ;; when the file name and directory use different drive names)
4667 ;; then it returns FILENAME."
4668 ;; (save-match-data
4669 ;; (let ((fname (expand-file-name filename)))
4670 ;; (setq directory (file-name-as-directory
4671 ;; (expand-file-name (or directory default-directory))))
4672 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4673 ;; ;; drive names, they can't be relative, so return the absolute name.
4674 ;; (if (and (or (eq system-type 'ms-dos)
4675 ;; (eq system-type 'cygwin)
4676 ;; (eq system-type 'windows-nt))
4677 ;; (not (string-equal (substring fname 0 2)
4678 ;; (substring directory 0 2))))
4679 ;; filename
4680 ;; (let ((ancestor ".")
4681 ;; (fname-dir (file-name-as-directory fname)))
4682 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4683 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4684 ;; (setq directory (file-name-directory (substring directory 0 -1))
4685 ;; ancestor (if (equal ancestor ".")
4686 ;; ".."
4687 ;; (concat "../" ancestor))))
4688 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4689 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4690 ;; ;; We matched within FNAME's directory part.
4691 ;; ;; Add the rest of FNAME onto ANCESTOR.
4692 ;; (let ((rest (substring fname (match-end 0))))
4693 ;; (if (and (equal ancestor ".")
4694 ;; (not (equal rest "")))
4695 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4696 ;; rest
4697 ;; (concat (file-name-as-directory ancestor) rest)))
4698 ;; ;; We matched FNAME's directory equivalent.
4699 ;; ancestor))))))
4702 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4703 This function returns a relative file name which is equivalent to FILENAME
4704 when used with that default directory as the default.
4705 If FILENAME is a relative file name, it will be interpreted as existing in
4706 `default-directory'.
4707 If FILENAME and DIRECTORY lie on different machines or on different drives
4708 on a DOS/Windows machine, it returns FILENAME in expanded form."
4712 default-directory))))
4717 read-file-name-completion-ignore-case)))
4720 ;; Test for different filesystems on DOS/Windows
4722 ;; Should `cygwin' really be included here? --stef
4725 ;; Test for different drive letters
4727 ;; Test for UNCs on different servers
4732 ;; Windows file names cannot have ? in
4733 ;; them, so use that to detect when
4734 ;; neither FILENAME nor DIRECTORY is a
4735 ;; UNC.
4737 0 nil
4743 ;; Test for different remote file system identification
4745 filename
4753 ".."
4755 ;; Now ancestor is empty, or .., or ../.., etc.
4757 ;; We matched within FILENAME's directory part.
4758 ;; Add the rest of FILENAME onto ANCESTOR.
4761 ;; But don't bother with ANCESTOR if it would give us `./'.
4762 rest
4764 ;; We matched FILENAME's directory equivalent.
4765 ancestor))))))
4766 \f
4768 "Save current buffer in visited file if modified.
4769 Variations are described below.
4771 By default, makes the previous version into a backup file
4772 if previously requested or if this is the first save.
4774 to become a backup when the next save is done.
4776 makes the previous version into a backup file.
4778 to become a backup when the next save is done,
4779 and makes the previous version into a backup file.
4781 With a numeric prefix argument of 0, never make the previous version
4782 into a backup file.
4784 Note that the various variables that control backups, such
4785 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4786 and `backup-inhibited', to name just the more popular ones, still
4787 control whether a backup will actually be produced, even when you
4790 If a file's name is FOO, the names of its numbered backup versions are
4791 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4792 Numeric backups (rather than FOO~) will be made if value of
4793 `version-control' is not the atom `never' and either there are already
4794 numeric versions of the file being backed up, or `version-control' is
4795 non-nil.
4796 We don't want excessive versions piling up, so there are variables
4797 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4798 and `kept-new-versions', which tells how many newest versions to keep.
4799 Defaults are 2 old versions and 2 new.
4800 `dired-kept-versions' controls dired's clean-directory (.) command.
4801 If `delete-old-versions' is nil, system will query user
4802 before trimming versions. Otherwise it does it silently.
4804 If `vc-make-backup-files' is nil, which is the default,
4805 no backup files are made for files managed by version control.
4806 (This is because the version control system itself records previous versions.)
4808 See the subroutine `basic-save-buffer' for more information."
4814 ;; We used to display the message below only for files > 50KB, but
4815 ;; then Rmail-mbox never displays it due to buffer swapping. If
4816 ;; the test is ever re-introduced, be sure to handle saving of
4817 ;; Rmail files.
4827 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4828 Normally delete only if the file was written by this Emacs since
4829 the last real save, but optional arg FORCE non-nil means delete anyway."
4843 "Normal hook that is run before a buffer is saved to its file."
4849 "Normal hook that is run after a buffer is saved to its file."
4855 "If non-nil, use this coding system for saving the buffer.
4856 More precisely, use this coding system in place of the
4857 value of `buffer-file-coding-system', when saving the buffer.
4858 Calling `write-region' for any purpose other than saving the buffer
4859 will still use `buffer-file-coding-system'; this variable has no effect
4866 "Save the current buffer in its visited file, if it has been modified.
4867 The hooks `write-contents-functions' and `write-file-functions' get a chance
4868 to do the job of saving; if they do not, then the buffer is saved in
4869 the visited file in the usual way.
4870 Before and after saving the buffer, this function runs
4871 `before-save-hook' and `after-save-hook', respectively."
4874 ;; In an indirect buffer, save its base buffer instead.
4878 ;; handle the case when no modification has been made but
4879 ;; the file disappeared since visited
4883 setmodes)
4884 ;; If buffer has no file name, ask user for one.
4892 ;; Signal an error if the user specified the name of an
4893 ;; existing directory.
4896 "File `%s' exists; overwrite? "
4897 filename))
4904 "%s has changed since visited or saved. Save anyway? "
4924 ;; Support VC version backups.
4926 ;; Don't let errors prevent saving the buffer.
4931 ;; If a hook returned t, file is already "written".
4932 ;; Otherwise, write it the usual way now.
4942 ;; Now we have saved the current buffer. Let's make sure
4943 ;; that buffer-file-coding-system is fixed to what
4944 ;; actually used for saving by binding it locally.
4959 ;; If the auto-save file was recent before this command,
4960 ;; delete it now.
4962 ;; Support VC `implicit' locking.
4969 ;; This does the "real job" of writing a buffer into its visited file
4970 ;; and making a backup file. This is what is normally done
4971 ;; but inhibited if one of write-file-functions returns non-nil.
4972 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4973 ;; backup-buffer.
4983 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4984 ;; backup-buffer.
4997 "File %s is write-protected; try to save anyway? "
4999 buffer-file-name)))
5013 dir))))
5014 ;; Write temp name, then rename it.
5015 ;; This requires write access to the containing dir,
5016 ;; which is why we don't try it if we don't have that access.
5018 tempname succeed
5021 ;; Create temp files with strict access rights. It's easy to
5022 ;; loosen them later, whereas it's impossible to close the
5023 ;; time-window of loose permissions otherwise.
5028 ;; Try various temporary names.
5029 ;; This code follows the example of make-temp-file,
5030 ;; but it calls write-region in the appropriate way
5031 ;; for saving the buffer.
5037 ;; Pass in nil&nil rather than point-min&max
5038 ;; cause we're saving the whole buffer.
5039 ;; write-region-annotate-functions may use it.
5041 tempname nil realname
5044 nil)
5046 ;; The file was somehow created by someone else between
5047 ;; `make-temp-name' and `write-region', let's try again.
5048 nil)
5050 ;; Reset the umask.
5052 ;; If we failed, restore the buffer's modtime.
5055 ;; Since we have created an entirely new file,
5056 ;; make sure it gets the right permission bits set.
5061 buffer-file-name)))
5062 ;; We succeeded in writing the temp file,
5063 ;; so rename it.
5065 ;; If file not writable, see if we can make it writable
5066 ;; temporarily while we write it.
5067 ;; But no need to do so if we have just backed it up
5068 ;; (setmodes is set) because that says we're superseding.
5070 ;; Change the mode back, after writing.
5073 buffer-file-name))
5074 ;; If set-file-extended-attributes fails, fall back on
5075 ;; set-file-modes.
5085 ;; Pass in nil&nil rather than point-min&max to indicate
5086 ;; we're saving the buffer rather than just a region.
5087 ;; write-region-annotate-functions may make us of it.
5089 buffer-file-name nil t buffer-file-truename)
5092 ;; If we get an error writing the new file, and we made
5093 ;; the backup by renaming, undo the backing-up.
5098 setmodes))
5104 `((?\C-r
5111 ;; Return nil to ask about BUF again.
5112 nil)
5125 ;; Return nil to ask about BUF again.
5126 nil)
5136 "Save some modified file-visiting buffers. Asks user about each one.
5137 You can answer `y' to save, `n' not to save, `C-r' to look at the
5138 buffer in question with `view-buffer' before deciding or `d' to
5139 view the differences using `diff-buffer-with-file'.
5141 This command first saves any buffers where `buffer-save-without-query' is
5142 non-nil, without asking.
5144 Optional argument (the prefix) non-nil means save all with no questions.
5145 Optional second argument PRED determines which buffers are considered:
5146 If PRED is nil, all the file-visiting buffers are considered.
5147 If PRED is t, then certain non-file buffers will also be considered.
5148 If PRED is a zero-argument function, it indicates for each buffer whether
5149 to consider it or not when called with that buffer current.
5151 See `save-some-buffers-action-alist' if you want to
5152 change the additional actions you can take on files."
5156 files-done abbrevs-done)
5158 ;; First save any buffers that we're supposed to save unconditionally.
5159 ;; That way the following code won't ask about them.
5164 ;; Ask about those buffers that merit it,
5165 ;; and record the number thus saved.
5169 ;; Note that killing some buffers may kill others via
5170 ;; hooks (e.g. Rmail and its viewing buffer).
5183 t
5195 save-some-buffers-action-alist))
5196 ;; Maybe to save abbrevs, and record whether
5197 ;; we either saved them or asked to.
5204 ;; Don't keep bothering user if he says no.
5218 \f
5220 "Clear out records of last mod time of visited file.
5221 Next attempt to save will not complain of a discrepancy."
5225 "Mark current buffer as unmodified, not needing to be saved.
5228 It is not a good idea to use this function in Lisp programs, because it
5229 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5237 "Change whether this buffer is read-only."
5245 "Insert contents of file FILENAME into buffer after point.
5246 Set mark after the inserted text.
5248 This function is meant for the user to run interactively.
5249 Don't call it from programs! Use `insert-file-contents' instead.
5250 \(Its calling sequence is different; see its documentation)."
5256 "Append the contents of the region to the end of file FILENAME.
5257 When called from a function, expects three arguments,
5258 START, END and FILENAME. START and END are normally buffer positions
5259 specifying the part of the buffer to write.
5260 If START is nil, that means to use the entire buffer contents.
5261 If START is a string, then output that string to the file
5262 instead of any buffer contents; END is ignored.
5264 This does character code conversion and applies annotations
5265 like `write-region' does."
5271 "Return most recent backup file for FILENAME or nil if no backups exist."
5272 ;; `make-backup-file-name' will get us the right directory for
5273 ;; ordinary or numeric backups. It might create a directory for
5274 ;; backups as a side-effect, according to `backup-directory-alist'.
5281 tem)
5290 newest))
5293 "Rename current buffer to a similar name not already taken.
5294 This function is useful for creating multiple shell process buffers
5295 or multiple mail buffers, etc.
5297 Note that some commands, in particular those based on `compilation-mode'
5298 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5299 appropriate mode even if it has been renamed. So as well as renaming
5300 the buffer, you also need to switch buffers before running another
5301 instance of such commands."
5309 ;; If the existing buffer name has a <NNN>,
5310 ;; which isn't part of the file name (if any),
5311 ;; then get rid of that.
5317 "Create the directory DIR and optionally any nonexistent parent dirs.
5318 If DIR already exists as a directory, signal an error, unless
5319 PARENTS is non-nil.
5321 Interactively, the default choice of directory to create is the
5322 current buffer's default directory. That is useful when you have
5323 visited a file in a nonexistent directory.
5325 Noninteractively, the second (optional) argument PARENTS, if
5326 non-nil, says whether to create parent directories that don't
5327 exist. Interactively, this happens by default.
5329 If creating the directory or directories fail, an error will be
5330 raised."
5333 nil nil)
5334 t))
5335 ;; If default-directory is a remote directory,
5336 ;; make sure we find its make-directory handler.
5344 create-list)
5346 ;; If directory is its own parent, then we can't
5347 ;; keep looping forever
5362 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5363 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5364 non-nil and if FN fails due to a missing file or directory."
5370 "Delete the directory named DIRECTORY. Does not follow symlinks.
5371 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5372 no error if something else is simultaneously deleting them.
5373 TRASH non-nil means to trash the directory instead, provided
5374 `delete-by-moving-to-trash' is non-nil.
5376 When called interactively, TRASH is nil if and only if a prefix
5377 argument is given, and a further prompt asks the user for
5378 RECURSIVE if DIRECTORY is nonempty."
5385 "Move directory to trash: "
5387 default-directory default-directory nil nil))))
5393 nil)
5395 ;; If default-directory is a remote directory, make sure we find its
5396 ;; delete-directory handler.
5403 ;; Only move non-empty dir to trash if recursive deletion was
5404 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5405 ;; case, where the operation fails in delete-directory-internal.
5406 ;; As `move-file-to-trash' trashes directories (empty or
5407 ;; otherwise) as a unit, we do not need to recurse here.
5409 ;; Check if directory is empty apart from "." and "..".
5414 ;; Otherwise, call ourselves recursively if needed.
5419 directory-files-no-dot-files-regexp))
5423 ;; This test is equivalent to but more efficient
5424 ;; than (and (file-directory-p fn)
5425 ;; (not (file-symlink-p fn))).
5429 files))
5430 directory-exists))
5434 "Return non-nil if files FILE1 and FILE2 name the same file.
5435 If FILE1 or FILE2 does not exist, the return value is unspecified."
5446 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5448 Return nil if DIR is not an existing directory."
5460 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5475 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5476 This function always sets the file modes of the output files to match
5477 the corresponding input file.
5479 The third arg KEEP-TIME non-nil means give the output files the same
5480 last-modified time as the old ones. (This works on only some systems.)
5482 A prefix arg makes KEEP-TIME non-nil.
5484 Noninteractively, the last argument PARENTS says whether to
5485 create parent directories if they don't exist. Interactively,
5486 this happens by default.
5488 If NEWNAME names an existing directory, copy DIRECTORY as a
5489 subdirectory there. However, if called from Lisp with a non-nil
5490 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5491 directly into NEWNAME instead."
5498 default-directory default-directory nil nil)
5499 current-prefix-arg t nil)))
5502 directory newname))
5503 ;; If default-directory is a remote directory, make sure we find its
5504 ;; copy-directory handler.
5509 newname keep-time parents copy-contents)
5511 ;; Compute target name.
5516 ;; If NEWNAME is not an existing directory, create it;
5517 ;; that is where we will copy the files of DIRECTORY.
5519 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5520 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5525 newname))
5529 newname))
5532 ;; Copy recursively.
5534 ;; We do not want to copy "." and "..".
5536 directory-files-no-dot-files-regexp))
5546 ;; Set directory attributes.
5552 \f
5553 ;; At time of writing, only info uses this.
5555 "Return a copy of DIRS with all non-existent directories removed.
5556 The optional argument KEEP is a list of directories to retain even if
5557 they don't exist, and REJECT is a list of directories to remove from
5558 DIRS, even if they exist; REJECT takes precedence over KEEP.
5560 Note that membership in REJECT and KEEP is checked using simple string
5561 comparison."
5567 dirs)))
5569 \f
5572 "Function to use to revert this buffer.
5573 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5574 which are the arguments that `revert-buffer' received.
5575 It also has access to the `preserve-modes' argument of `revert-buffer'
5576 via the `revert-buffer-preserve-modes' dynamic variable.
5578 For historical reasons, a value of nil means to use the default function.
5583 #'revert-buffer-insert-file-contents--default-function
5584 "Function to use to insert contents when reverting this buffer.
5585 The function receives two arguments: the first the nominal file name to use;
5586 the second is t if reading the auto-save file.
5588 The function is responsible for updating (or preserving) point.
5590 For historical reasons, a value of nil means to use the default function.
5594 "Default function to use for `buffer-stale-function'.
5595 This function ignores its argument.
5596 This returns non-nil if the current buffer is visiting a readable file
5597 whose modification time does not match that of the buffer.
5599 This function only handles buffers that are visiting files.
5600 Non-file buffers need a custom function"
5607 "Function to check whether a buffer needs reverting.
5608 This should be a function with one optional argument NOCONFIRM.
5609 Auto Revert Mode passes t for NOCONFIRM. The function should return
5610 non-nil if the buffer should be reverted. A return value of
5611 `fast' means that the need for reverting was not checked, but
5612 that reverting the buffer is fast. The buffer is current when
5613 this function is called.
5615 The idea behind the NOCONFIRM argument is that it should be
5616 non-nil if the buffer is going to be reverted without asking the
5617 user. In such situations, one has to be careful with potentially
5618 time consuming operations.
5620 For historical reasons, a value of nil means to use the default function.
5621 This should not be relied upon.
5623 For more information on how this variable is used by Auto Revert mode,
5627 "Normal hook for `revert-buffer' to run before reverting.
5628 The function `revert-buffer--default' runs this.
5632 "Normal hook for `revert-buffer' to run after reverting.
5633 Note that the hook value that it runs is the value that was in effect
5634 before reverting; that makes a difference if you have buffer-local
5635 hook functions.
5637 The function `revert-buffer--default' runs this.
5645 ;; `revert-buffer-function' was defined long ago to be a function of only
5646 ;; 2 arguments, so we have to use a dynbind variable to pass the
5647 ;; `preserve-modes' argument of `revert-buffer'.
5651 "Replace current buffer text with the text of the visited file on disk.
5652 This undoes all changes since the file was visited or saved.
5653 With a prefix argument, offer to revert from latest auto-save file, if
5654 that is more recent than the visited file.
5656 This command also implements an interface for special buffers
5657 that contain text which doesn't come from a file, but reflects
5658 some other data instead (e.g. Dired buffers, `buffer-list'
5659 buffers). This is done via the variable `revert-buffer-function'.
5660 In these cases, it should reconstruct the buffer contents from the
5661 appropriate data.
5663 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5664 to revert from the auto-save file when this is nil. Note that the
5665 sense of this argument is the reverse of the prefix argument, for the
5666 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5667 to nil.
5669 Optional second argument NOCONFIRM means don't ask for confirmation
5670 at all. (The variable `revert-without-query' offers another way to
5671 revert buffers without querying for confirmation.)
5673 Optional third argument PRESERVE-MODES non-nil means don't alter
5674 the files modes. Normally we reinitialize them using `normal-mode'.
5676 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5678 This function calls the function that `revert-buffer-function' specifies
5679 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5680 The default function runs the hooks `before-revert-hook' and
5681 `after-revert-hook'."
5682 ;; I admit it's odd to reverse the sense of the prefix argument, but
5683 ;; there is a lot of code out there which assumes that the first
5684 ;; argument should be t to avoid consulting the auto-save file, and
5685 ;; there's no straightforward way to encourage authors to notice a
5686 ;; reversal of the argument sense. So I'm just changing the user
5687 ;; interface, but leaving the programmatic interface the same.
5692 ignore-auto noconfirm)))
5695 "Default function for `revert-buffer'.
5696 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5697 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5698 start and end.
5700 Calls `revert-buffer-insert-file-contents-function' to reread the
5701 contents of the visited file, with two arguments: the first is the file
5702 name, the second is non-nil if reading an auto-save file.
5704 This function only handles buffers that are visiting files.
5705 Non-file buffers need a custom function."
5710 buffer-auto-save-file-name
5715 buffer-auto-save-file-name
5716 buffer-file-name)))
5726 file-name)))
5728 ;; If file was backed up but has changed since,
5729 ;; we should make another backup.
5733 ;; Effectively copy the after-revert-hook status,
5734 ;; since after-find-file will clobber it.
5737 after-revert-hook))
5739 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5743 file-name auto-save-p)
5744 ;; Recompute the truename in case changes in symlinks
5745 ;; have changed the truename.
5749 ;; Run after-revert-hook as it was before we reverted.
5753 local-hook)
5756 t)))))
5759 "Default function for `revert-buffer-insert-file-contents-function'.
5760 The function `revert-buffer--default' calls this.
5761 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5762 an auto-save file."
5766 "File %s no longer exists!"
5768 file-name))
5771 "File %s no longer readable!"
5773 file-name))
5775 ;; Bind buffer-file-name to nil
5776 ;; so that we don't try to lock the file.
5782 ;; Auto-saved file should be read by Emacs's
5783 ;; internal coding.
5787 buffer-file-coding-system-explicit
5790 coding-system-for-read
5792 coding-system-for-read)
5794 ;; As a coding system suitable for multibyte
5795 ;; buffer is specified, make the current
5796 ;; buffer multibyte.
5799 ;; This force after-insert-file-set-coding
5800 ;; (called from insert-file-contents) to set
5801 ;; buffer-file-coding-system to a proper value.
5804 ;; Note that this preserves point in an intelligent way.
5808 nil nil t))
5810 nil nil t))))))
5813 "Recover the visited file--get contents from its last auto-save file."
5818 "Visit file FILE, but get contents from its last auto-save file."
5819 ;; Actually putting the file name in the minibuffer should be used
5820 ;; only rarely.
5821 ;; Not just because users often use the default.
5834 "*Directory*" nil
5845 ;; Use insert-directory-safely, not insert-directory,
5846 ;; because these files might not exist. In particular,
5847 ;; FILE might not exist if the auto-save file was for
5848 ;; a buffer that didn't visit a file, such as "*mail*".
5849 ;; The code in v20.x called `ls' directly, so we need
5850 ;; to emulate what `ls' did in that case.
5855 ;; Keep the current buffer-file-coding-system.
5857 ;; Auto-saved file should be read with special coding.
5866 "Recover auto save files from a previous Emacs session.
5867 This command first displays a Dired buffer showing you the
5868 previous sessions that you could recover from.
5869 To choose one, move point to the proper line and then type C-c C-c.
5870 Then you'll be asked about a number of files to recover."
5880 directory-files-no-dot-files-regexp
5882 t)
5893 ;; Each line starts with a space
5894 ;; so that Font Lock mode won't highlight the first character.
5897 " To delete a session file, type \
5903 "Choose one saved session to recover auto-save files from.
5904 This command is used in the special Dired buffer created by
5907 ;; Get the name of the session file to recover from.
5909 files
5915 ;; Read in the auto-save-list file.
5918 ;; Loop thru the text of that file
5919 ;; and get out the names of the files to recover.
5923 ;; This is a pair of lines for a non-file-visiting buffer.
5924 ;; Get the auto-save file name and manufacture
5925 ;; a "visited file name" from that.
5928 ;; If there is no auto-save file name, the
5929 ;; auto-save-list file is probably corrupted.
5942 ;; This pair of lines is a file-visiting
5943 ;; buffer. Use the visited file name.
5953 ;; Ignore a file if its auto-save file does not exist now.
5957 ;; The file contains a pair of line for each auto-saved buffer.
5958 ;; The first line of the pair contains the visited file name
5959 ;; or is empty if the buffer was not visiting a file.
5960 ;; The second line is the auto-save file name.
5968 files
5974 "Kill BUFFER if confirmed."
5982 "Kill some buffers. Asks the user whether to kill each one of them.
5983 Non-interactively, if optional argument LIST is non-nil, it
5984 specifies the list of buffers to kill, asking for approval for each one."
5992 ; if we killed the base buffer.
5999 "Kill buffers whose name matches the specified REGEXP.
6000 The optional second argument indicates whether to kill internal buffers too."
6009 \f
6011 "Adjust current buffer's auto save file name for current conditions.
6012 Also rename any existing auto save file, if it was made in this session."
6024 "Return file name to use for auto-saves of current buffer.
6025 Does not consider `auto-save-visited-file-name' as that variable is checked
6026 before calling this function. You can redefine this for customization.
6027 See also `auto-save-file-name-p'."
6035 result uniq)
6036 ;; Apply user-specified translations
6037 ;; to the file name.
6041 filename)
6051 filename))))
6056 ;; We truncate the file name to DOS 8+3 limits
6057 ;; before doing anything else, because the regexp
6058 ;; passed to string-match below cannot handle
6059 ;; extensions longer than 3 characters, multiple
6060 ;; dots, and other atrocities.
6065 fn)
6070 "#"
6073 ;; Make sure auto-save file names don't contain characters
6074 ;; invalid for the underlying filesystem.
6076 ;; Don't modify remote (ange-ftp) filenames
6079 result))))
6081 ;; Deal with buffers that don't have any associated files. (Mail
6082 ;; mode tends to create a good number of these.)
6086 file-name)
6087 ;; Restrict the characters used in the file name to those which
6088 ;; are known to be safe on all filesystems, url-encoding the
6089 ;; rest.
6090 ;; We do this on all platforms, because even if we are not
6091 ;; running on DOS/Windows, the current directory may be on a
6092 ;; mounted VFAT filesystem, such as a USB memory stick.
6096 ;; For multibyte characters, this will produce more than
6097 ;; 2 hex digits, so is not true URL encoding.
6101 ;; Generate the file name.
6107 ;; Try a few alternative directories, to get one we can
6108 ;; write it.
6114 ;; Don't modify remote (ange-ftp) filenames
6116 ;; The call to convert-standard-filename is in case
6117 ;; buffer-name includes characters not allowed by the
6118 ;; DOS/Windows filesystems. make-temp-file writes to the
6119 ;; file it creates, so we must fix the file name _before_
6120 ;; make-temp-file is called.
6122 fname))
6124 ;; make-temp-file creates the file,
6125 ;; but we don't want it to exist until we do an auto-save.
6129 file-name)))
6132 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6133 FILENAME should lack slashes. You can redefine this for customization."
6135 \f
6137 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6138 The generated regexp will match a filename only if the filename
6139 matches that wildcard according to shell rules. Only wildcards known
6140 by `sh' are supported."
6142 ;; Copy the initial run of non-special characters.
6145 ;; If no special characters, we're almost done.
6149 j)
6151 result
6172 ;; Found "[^". Insert a `\0' character
6173 ;; (which cannot happen in a filename)
6174 ;; into the character class, so that `^'
6175 ;; is not the first character after `[',
6176 ;; and thus non-special in a regexp.
6181 ;; I don't think `]' can appear in a
6182 ;; character class in a wildcard, but
6183 ;; let's be general here.
6190 i
6203 ;; Shell wildcards should match the entire filename,
6204 ;; not its part. Make the regexp say so.
6206 \f
6209 "Switches for `list-directory' to pass to `ls' for brief listing."
6215 "Switches for `list-directory' to pass to `ls' for verbose listing."
6220 "Expand wildcard pattern PATTERN.
6221 This returns a list of file names which match the pattern.
6222 Files are sorted in `string<' order.
6224 If PATTERN is written as an absolute file name,
6225 the values are absolute also.
6227 If PATTERN is written as a relative file name, it is interpreted
6228 relative to the current default directory, `default-directory'.
6229 The file names returned are normally also relative to the current
6230 default directory. However, if FULL is non-nil, they are absolute."
6234 ;; A list of all dirs that DIRPART specifies.
6235 ;; This can be more than one dir
6236 ;; if DIRPART contains wildcards.
6242 contents)
6247 ;; Filter out "." and ".."
6252 name))
6259 this-dir-contents)
6260 this-dir-contents)
6261 contents)))))
6262 contents)))
6264 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6268 "Display a list of files in or matching DIRNAME, a la `ls'.
6269 DIRNAME is globbed by the shell if necessary.
6270 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6271 Actions controlled by variables `list-directory-brief-switches'
6272 and `list-directory-verbose-switches'."
6276 nil default-directory nil)
6277 pfx)))
6279 list-directory-brief-switches))
6280 buffer)
6292 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6300 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6302 PATTERN is assumed to represent a file-name wildcard suitable for the
6303 underlying filesystem. For Unix and GNU/Linux, each character from the
6305 the parts of the pattern which don't include wildcard characters are
6306 quoted with double quotes.
6309 on Windows), so PATTERN can use them to quote wildcard characters that
6310 need to be passed verbatim to shell commands."
6314 ;; DOS/Windows don't allow `"' in file names. So if the
6315 ;; argument has quotes, we can safely assume it is already
6316 ;; quoted by the caller.
6318 ;; We quote [&()#$`'] in case their shell is a port of a
6319 ;; Unixy shell. We quote [,=+] because stock DOS and
6320 ;; Windows shells require that in some cases, such as
6321 ;; passing arguments to batch files that use positional
6322 ;; arguments like %1.
6324 pattern
6327 end)
6344 pattern))))
6351 "Program to get the amount of free space on a file system.
6352 We assume the output has the format of `df'.
6353 The value of this variable must be just a command name or file name;
6354 if you want to specify options, use `directory-free-space-args'.
6356 A value of nil disables this feature.
6358 If the function `file-system-info' is defined, it is always used in
6359 preference to the program given by this variable."
6365 "Options to use when running `directory-free-space-program'."
6370 "Return the amount of free space on directory DIR's file system.
6371 The return value is a string describing the amount of free
6372 space (normally, the number of free 1KB blocks).
6374 This function calls `file-system-info' if it is available, or
6375 invokes the program specified by `directory-free-space-program'
6376 and `directory-free-space-args'. If the system call or program
6377 is unsuccessful, or if DIR is a remote directory, this function
6378 returns nil."
6380 ;; Try to find the number of free blocks. Non-Posix systems don't
6381 ;; always have df, but might have an equivalent system call.
6390 ;; Avoid failure if the default directory does
6391 ;; not exist (Bug#2631, Bug#3911).
6395 nil t nil
6396 directory-free-space-args
6399 ;; Assume that the "available" column is before the
6400 ;; "capacity" column. Find the "%" and scan backward.
6404 "[[:space:]]+[^[:space:]]+%[^%]*$"
6411 ;; The following expression replaces `dired-move-to-filename-regexp'.
6415 ;; In some locales, month abbreviations are as short as 2 letters,
6416 ;; and they can be followed by ".".
6417 ;; In Breton, a month name can include a quote character.
6430 s "+"
6433 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6434 ;; omits the Kanji characters after month and day-of-month.
6435 ;; On Mac OS X 10.3, the date format in East Asian locales is
6436 ;; day-of-month digits followed by month digits.
6442 ;; The "[0-9]" below requires the previous column to end in a digit.
6443 ;; This avoids recognizing `1 may 1997' as a date in the line:
6444 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6446 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6448 ;; For non-iso date formats, we add the ".*" in order to find
6449 ;; the last possible match. This avoids recognizing
6450 ;; `jservice 10 1024' as a date in the line:
6451 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6453 ;; vc dired listings provide the state or blanks between file
6454 ;; permissions and date. The state is always surrounded by
6455 ;; parentheses:
6456 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6457 ;; This is not supported yet.
6462 "Regular expression to match up to the file name in a directory listing.
6463 The default value is designed to recognize dates and times
6468 ;; insert-directory
6469 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6470 ;; FULL-DIRECTORY-P is nil.
6471 ;; The single line of output must display FILE's name as it was
6472 ;; given, namely, an absolute path name.
6473 ;; - must insert exactly one line for each file if WILDCARD or
6474 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6475 ;; before the file lines, plus optional text after the file lines.
6476 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6477 ;; allowed.
6478 ;; File lines should display the basename.
6479 ;; - must be consistent with
6480 ;; - functions dired-move-to-filename, (these two define what a file line is)
6481 ;; dired-move-to-end-of-filename,
6482 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6483 ;; dired-insert-headerline
6484 ;; dired-after-subdir-garbage (defines what a "total" line is)
6485 ;; - variable dired-subdir-regexp
6486 ;; - may be passed "--dired" as the first argument in SWITCHES.
6487 ;; Filename handlers might have to remove this switch if their
6488 ;; "ls" command does not support it.
6490 "Insert directory listing for FILE, formatted according to SWITCHES.
6491 Leaves point after the inserted text.
6492 SWITCHES may be a string of options, or a list of strings
6493 representing individual options.
6494 Optional third arg WILDCARD means treat FILE as shell wildcard.
6495 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6496 switches do not contain `d', so that a full listing is expected.
6498 This works by running a directory listing program
6499 whose name is in the variable `insert-directory-program'.
6500 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6502 When SWITCHES contains the long `--dired' option, this function
6503 treats it specially, for the sake of dired. However, the
6504 normally equivalent short `-D' option is just passed on to
6505 `insert-directory-program', as any other option."
6506 ;; We need the directory in order to find the right handler.
6511 wildcard full-directory-p)
6514 ;; Read the actual directory using `insert-directory-program'.
6515 ;; RESULT gets the status code.
6517 ;; putting text property `dired-filename, decode one
6518 ;; bunch by one to preserve that property.
6520 ;; This is to control encoding the arguments in call-process.
6524 default-file-name-coding-system))))
6527 ;; Run ls in the directory part of the file pattern
6528 ;; using the last component as argument.
6534 ;; NB since switches is passed to the shell, be
6535 ;; careful of malicious values, eg "-l;reboot".
6536 ;; See eg dired-safe-switches-p.
6538 shell-file-name nil t nil
6539 "-c"
6541 ""
6543 insert-directory-program
6544 " -d "
6546 switches
6548 " -- "
6549 ;; Quote some characters that have
6550 ;; special meanings in shells; but
6551 ;; don't quote the wildcards--we want
6552 ;; them to be special. We also
6553 ;; currently don't quote the quoting
6554 ;; characters in case people want to
6555 ;; use them explicitly to quote
6556 ;; wildcard characters.
6558 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6559 ;; directory if FILE is a symbolic link.
6567 insert-directory-program nil t nil
6571 ;; Split the switches at any spaces so we can
6572 ;; pass separate options as separate args.
6574 ;; Avoid lossage if FILE starts with `-'.
6582 file))))))))
6584 ;; If we got "//DIRED//" in the output, it means we got a real
6585 ;; directory listing, even if `ls' returned nonzero.
6586 ;; So ignore any errors.
6599 ;; The first time ls returns an error,
6600 ;; find the version numbers of ls,
6601 ;; and set insert-directory-ls-version
6602 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6603 ;; is equal or if the info cannot be obtained.
6604 ;; (That can mean it isn't GNU ls.)
6614 comparison)
6630 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6634 ;; If `insert-directory-program' failed, signal an error.
6636 ;; Delete the error message it may have output.
6638 ;; On non-Posix systems, we cannot open a directory, so
6639 ;; don't even try, because that will always result in
6640 ;; the ubiquitous "Access denied". Instead, show the
6641 ;; command line so the user can try to guess what went wrong.
6646 insert-directory-program
6648 file result)
6649 ;; Unix. Access the file to get a suitable error.
6656 ;; The following overshoots by one line for an empty
6657 ;; directory listed with "--dired", but without "-a"
6658 ;; switch, where the ls output contains a
6659 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6660 ;; We take care of that case later.
6668 error-lines)
6669 ;; Find all the lines that are error messages,
6670 ;; and record the bounds of each one.
6677 ;; Now read the numeric positions of file names.
6684 error-lines))
6687 error-lines)))
6689 ;; End is followed by \n or by " -> ".
6691 ;; It seems that we can't trust ls's output as to
6692 ;; byte positions of filenames.
6698 ;; Take care of the case where the ls output contains a
6699 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6700 ;; and we went one line too far back (see above).
6705 ;; Now decode what read if necessary.
6707 file-name-coding-system
6708 default-file-name-coding-system
6710 coding-no-eol
6711 val pos)
6715 ;; If no coding system is specified or detection is
6716 ;; requested, detect the coding.
6730 ;; Force no eol conversion on a file name, so
6731 ;; that CR is preserved.
6739 ;; Try to insert the amount of free space.
6742 ;; First find the line to put it on.
6746 ;; Replace "total" with "used", to avoid confusion.
6752 "Convert `ls --dired' file name position value POS to a buffer position.
6753 File name position values returned in ls --dired output
6754 count only stdout; they don't count the error messages sent to stderr.
6755 So this function converts to them to real buffer positions.
6756 ERROR-LINES is a list of buffer positions of error message lines,
6757 of the form (START END)."
6761 pos)
6765 "Insert directory listing for FILE, formatted according to SWITCHES.
6767 Like `insert-directory', but if FILE does not exist, it inserts a
6768 message to that effect instead of signaling an error."
6771 ;; Simulate the message printed by `ls'.
6775 "Functions to call with no arguments to query about killing Emacs.
6776 If any of these functions returns nil, killing Emacs is canceled.
6777 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6778 the low level primitive, does not. See also `kill-emacs-hook'."
6784 "How to ask for confirmation when leaving Emacs.
6785 If nil, the default, don't ask at all. If the value is non-nil, it should
6786 be a predicate function; for example `yes-or-no-p'."
6795 "Non-nil if Emacs should confirm killing processes on exit.
6796 If this variable is nil, the value of
6797 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6798 processes with a non-nil `process-query-on-exit-flag', Emacs will
6799 prompt the user before killing them."
6805 "Offer to save each buffer, then kill this Emacs process.
6806 With prefix ARG, silently save all file-visiting buffers without asking.
6807 If there are active processes where `process-query-on-exit-flag'
6808 returns non-nil and `confirm-kill-processes' is non-nil,
6809 asks whether processes should be killed.
6810 Runs the members of `kill-emacs-query-functions' in turn and stops
6811 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6823 ;; process-list is not defined on MSDOS.
6826 active)
6844 ;; Query the user for other things, perhaps.
6851 "Offer to save each buffer, then kill the current connection.
6852 If the current frame has no client, kill Emacs itself using
6853 `save-buffers-kill-emacs'.
6855 With prefix ARG, silently save all file-visiting buffers, then kill.
6857 If emacsclient was started with a list of filenames to edit, then
6858 only these files will be asked to be saved."
6863 \f
6864 ;; We use /: as a prefix to "quote" a file name
6865 ;; so that magic file name handlers will not apply to it.
6869 file-name-handler-alist))
6871 ;; We depend on being the last handler on the list,
6872 ;; so that anything else which does need handling
6873 ;; has been handled already.
6874 ;; So it is safe for us to inhibit *all* magic file name handlers.
6883 default-directory))
6884 ;; Get a list of the indices of the args which are file names.
6887 ;; The first six are special because they
6888 ;; return a file name. We want to include the /:
6889 ;; in the return value.
6890 ;; So just avoid stripping it in the first place.
6897 ;; `identity' means just return the first arg
6898 ;; not stripped of its quoting.
6900 ;; `add' means add "/:" to the result.
6903 ;; `unquote-then-quote' means set buffer-file-name
6904 ;; temporarily to unquoted filename.
6906 ;; List the arguments which are filenames.
6914 ;; For all other operations, treat the first argument only
6915 ;; as the file name.
6917 method
6918 ;; Copy ARGUMENTS so we can replace elements in it.
6922 ;; Strip off the /: from the file names that have it.
6930 "/"
6936 (`insert-file-contents
6942 (`unquote-then-quote
6950 If NAME is a remote file name, check the local part of NAME."
6955 If NAME is a remote file name, the local part of NAME is quoted.
6956 If NAME is already a quoted file name, NAME is returned unchanged."
6958 name
6963 If NAME is a remote file name, the local part of NAME is unquoted."
6969 \f
6970 ;; Symbolic modes and read-file-modes.
6973 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6974 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6975 Others, or All) for whom to produce the mask.
6976 The bit-mask that is returned extracts from mode bits the access rights
6977 for the specified category of users."
6985 "Convert CHAR to a numeric value of mode bits.
6986 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6987 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6994 ;; Rights relative to the previous file modes.
7005 "Convert a symbolic mode string specification to an equivalent number.
7007 WHO-MASK is the bit-mask specifying the category of users to which to
7008 apply the access permissions. See `file-modes-char-to-who'.
7009 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7010 RIGHTS request to add, remove, or set permissions based on existing ones,
7017 char-right)
7024 num-rights
7028 op char-right)))
7029 num-rights))
7032 "Convert symbolic file modes to numeric file modes.
7033 MODES is the string to convert, it should match
7035 See Info node `(coreutils)File permissions' for more information on this
7036 notation.
7037 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7038 MODES request to add, remove, or set permissions based on existing ones,
7052 num-who num-modes)
7055 num-modes)))
7058 "Read file modes in octal or symbolic notation and return its numeric value.
7060 ORIG-FILE is the name of a file on whose mode bits to base returned
7061 permissions if what user types requests to add, remove, or set permissions
7077 nil nil default)))
7086 ;; Trashcan handling.
7088 "Directory for `move-file-to-trash' to move files and directories to.
7089 This directory is only used when the function `system-move-file-to-trash'
7090 is not defined.
7091 Relative paths are interpreted relative to `default-directory'.
7092 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7102 "Move the file (or directory) named FILENAME to the trash.
7103 When `delete-by-moving-to-trash' is non-nil, this function is
7104 called by `delete-file' and `delete-directory' instead of
7105 deleting files outright.
7107 If the function `system-move-file-to-trash' is defined, call it
7108 with FILENAME as an argument.
7109 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7110 directory.
7111 Otherwise, trash FILENAME using the freedesktop.org conventions,
7112 like the GNOME, KDE and XFCE desktop environments. Emacs only
7116 ;; If `trash-directory' is non-nil, move the file there.
7120 trash-dir)))
7121 ;; We can't trash a parent directory of trash-directory.
7124 trash-dir filename))
7127 ;; Ensure that the trashed file-name is unique.
7134 ;; If `system-move-file-to-trash' is defined, use it.
7137 ;; Otherwise, use the freedesktop.org method, as specified at
7138 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7149 ;; Check if we have permissions to delete.
7153 ;; The trashed file cannot be the trash dir or its parent.
7156 trash-files-dir filename))
7159 trash-info-dir filename))
7161 ;; Ensure that the trash directory exists; otherwise, create it.
7168 ;; Try to move to trash with .trashinfo undo information
7173 ;; Perform url-encoding on FN. For compatibility with
7174 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7175 ;; for path separators.
7180 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7181 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7194 fn))
7199 ;; Attempt to make .trashinfo file, trying up to 5
7200 ;; times. The .trashinfo file is opened with O_EXCL,
7201 ;; as per trash-spec 0.7, even if that can be a problem
7202 ;; on old NFS versions...
7206 trash-files-dir))
7208 success info-fn)
7213 trash-info-dir))
7221 ;; Uniquify new-fn. (Some file managers do not
7222 ;; like Emacs-style backup file names---e.g. bug
7223 ;; 170956 in Konqueror bug tracker.)
7228 ;; Finally, try to move the file to the trashcan.
7233 "The type field in ATTRIBUTES returned by `file-attributes'.
7234 The value is either t for directory, string (name linked to) for
7235 symbolic link, or nil."
7239 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7243 "The UID field in ATTRIBUTES returned by `file-attributes'.
7244 This is either a string or a number. If a string value cannot be
7245 looked up, a numeric value, either an integer or a float, is
7246 returned."
7250 "The GID field in ATTRIBUTES returned by `file-attributes'.
7251 This is either a string or a number. If a string value cannot be
7252 looked up, a numeric value, either an integer or a float, is
7253 returned."
7257 "The last access time in ATTRIBUTES returned by `file-attributes'.
7258 This a list of integers (HIGH LOW USEC PSEC) in the same style
7259 as (current-time)."
7263 "The modification time in ATTRIBUTES returned by `file-attributes'.
7264 This is the time of the last change to the file's contents, and
7265 is a list of integers (HIGH LOW USEC PSEC) in the same style
7266 as (current-time)."
7270 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7271 This is the time of last change to the file's attributes: owner
7272 and group, access mode bits, etc, and is a list of integers (HIGH
7273 LOW USEC PSEC) in the same style as (current-time)."
7277 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7278 This is a floating point number if the size is too large for an integer."
7282 "The file modes in ATTRIBUTES returned by `file-attributes'.
7283 This is a string of ten letters or dashes as in ls -l."
7287 "The inode number in ATTRIBUTES returned by `file-attributes'.
7288 If it is larger than what an Emacs integer can hold, this is of
7289 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7290 If even HIGH is too large for an Emacs integer, this is instead
7291 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7292 middle 24 bits, and finally the low 16 bits."
7296 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7297 If it is larger than what an Emacs integer can hold, this is of
7298 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7299 If even HIGH is too large for an Emacs integer, this is instead
7300 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7301 middle 24 bits, and finally the low 16 bits."
7305 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7306 ATTR-NAMES are symbols with the selected attribute names.
7308 Valid attribute names are: type, link-number, user-id, group-id,
7309 access-time, modification-time, status-change-time, size, modes,
7310 inode-number and device-number."
7312 modification-time status-change-time
7313 size modes inode-number device-number))
7314 result)
7320 attributes)
7321 result)
7324 \f
7349 ;;; files.el ends here