| blob | b7d104853c3ccb78492402a211d97253b30d2bcd |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
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
2550 ;; .emacs or .gnus or .viper following a directory delimiter in
2551 ;; Unix or MS-DOS syntax.
2554 ;; _emacs following a directory delimiter in MS-DOS syntax
2558 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2559 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2560 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2563 ;; .xs is also used for ld scripts, but seems to be more commonly
2564 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2566 ;; Explained in binutils ld/genscripts.sh. Eg:
2567 ;; A .x script file is the default script.
2568 ;; A .xr script is for linking without relocation (-r flag). Etc.
2572 ;; Common Lisp ASDF package system.
2579 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2591 ;; Windows candidates may be opened case sensitively on Unix
2597 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2598 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2599 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2600 ;; this has lower priority to avoid matching changelog.sgml etc.
2602 ;; either user's dot-files or under /etc or some such
2604 ;; alas not all ~/.*rc files are like this
2605 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2610 ;; this contains everything twice, with space and with colon :-(
2612 ;; Get rid of any trailing .n.m and try again.
2613 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2614 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2615 ;; Using mode nil rather than `ignore' would let the search continue
2616 ;; through this list (with the shortened name) rather than start over.
2619 ;; This should come after "in" stripping (e.g. config.h.in).
2620 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2622 ;; The following should come after the ChangeLog pattern
2623 ;; for the sake of ChangeLog.1, etc.
2624 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2626 "Alist of filename patterns vs corresponding major mode functions.
2627 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2628 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2629 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2630 mode function to use. FUNCTION will be called, unless it is nil.
2632 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2633 calling FUNCTION (if it's not nil), we delete the suffix that matched
2634 REGEXP and search the list again for another match.
2636 The extensions whose FUNCTION is `archive-mode' should also
2637 appear in `auto-coding-alist' with `no-conversion' coding system.
2639 See also `interpreter-mode-alist', which detects executable script modes
2640 based on the interpreters they specify to run,
2645 "Select Conf mode or XML mode according to start of file."
2655 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2656 ;; and pike-mode) are added through autoload directives in that
2657 ;; file. That way is discouraged since it spreads out the
2658 ;; definition of the initial value.
2687 "Alist mapping interpreter names to major modes.
2688 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2689 Each element looks like (REGEXP . MODE).
2690 If REGEXP matches the entire name (minus any directory part) of
2691 the interpreter specified in the first line of a script, enable
2692 major mode MODE.
2699 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2700 ;; because we are duplicating info from auto-mode-alist.
2701 ;; TODO many elements of this list are also in auto-coding-alist.
2710 "List of regexps matching file names in which to ignore local variables.
2712 Files matching this list are typically binary file formats.
2713 They may happen to contain sequences that look like local variable
2714 specifications, but are not really, or they may be containers for
2715 member files with their own local variable sections, which are
2716 not appropriate for the containing file.
2723 "List of regexps matching suffixes to remove from file names.
2724 The function `inhibit-local-variables-p' uses this: when checking
2725 a file name, it first discards from the end of the name anything that
2728 ;; Can't think of any situation in which you'd want this to be nil...
2733 "Return non-nil if file local variables should be ignored.
2734 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2735 and `inhibit-local-variables-suffixes'. If
2736 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2745 sufs)
2750 temp))
2755 "Regexp matching interpreters, for file mode determination.
2756 This regular expression is matched against the first line of a file
2757 to determine the file's mode in `set-auto-mode'. If it matches, the file
2758 is assumed to be interpreted by the interpreter matched by the second group
2759 of the regular expression. The mode is then determined as the mode
2763 "Alist of buffer beginnings vs. corresponding major mode functions.
2764 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2765 After visiting a file, if REGEXP matches the text at the beginning of the
2766 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2767 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2768 major mode.
2770 If FUNCTION is nil, then it is not called. (That is a way of saying
2778 ;; The < comes before the groups (but the first) to reduce backtracking.
2779 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2780 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2784 comment-re "*"
2787 . html-mode)
2789 ;; These two must come after html, because they are more general:
2794 . sgml-mode)
2797 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2798 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2799 After visiting a file, if REGEXP matches the text at the beginning of the
2800 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2801 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2802 have not specified a mode for this file.
2808 "Upper limit on `magic-mode-alist' regexp matches.
2812 "Select major mode appropriate for current buffer.
2814 To find the right major mode, this function checks for a -*- mode tag
2815 checks for a `mode:' entry in the Local Variables section of the file,
2816 checks if it uses an interpreter listed in `interpreter-mode-alist',
2817 matches the buffer beginning against `magic-mode-alist',
2818 compares the filename against the entries in `auto-mode-alist',
2819 then matches the buffer beginning against `magic-fallback-mode-alist'.
2821 If `enable-local-variables' is nil, or if the file name matches
2822 `inhibit-local-variables-regexps', this function does not check
2823 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2824 is nil, then the only mode: tag that can be relevant is a -*- one.
2826 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2827 set the major mode only if that would change it. In other words
2828 we don't actually set it to the same mode the buffer already has."
2829 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2831 end done mode modes)
2832 ;; Once we drop the deprecated feature where mode: is also allowed to
2833 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2834 ;; remove this section and just let (hack-local-variables t) handle it.
2835 ;; Find a -*- mode tag.
2839 ;; Note by design local-enable-local-variables does not matter here.
2841 try-locals
2844 ;; Find all specifications for the `mode:' variable
2845 ;; and execute them left to right.
2857 modes)))
2858 ;; Simple -*-MODE-*- case.
2861 modes))))
2862 ;; If we found modes to use, invoke them now, outside the save-excursion.
2870 ;; continuing would call minor modes again, toggling them off
2872 ;; hack-local-variables checks local-enable-local-variables etc, but
2873 ;; we might as well be explicit here for the sake of clarity.
2875 enable-local-variables
2876 local-enable-local-variables
2877 try-locals
2884 ;; If we didn't, look for an interpreter specified in the first line.
2885 ;; As a special case, allow for things like "#!/bin/env perl", which
2886 ;; finds the interpreter anywhere in $PATH.
2892 ;; Map interpreter name to a mode, signaling we're done at the
2893 ;; same time.
2900 interpreter-mode-alist)
2902 ;; If we found an interpreter mode to use, invoke it now.
2904 ;; Next try matching the buffer beginning against magic-mode-alist.
2918 ;; Next compare the filename against the entries in auto-mode-alist.
2924 buffer-file-name)))
2925 ;; Remove backup-suffixes from file name.
2927 ;; Remove remote file name identification.
2932 ;; Find first matching alist entry.
2935 ;; Filesystem is case-insensitive.
2939 ;; Filesystem is case-sensitive.
2941 ;; First match case-sensitively.
2945 ;; Fallback to case-insensitive match.
2959 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2976 ;; When `keep-mode-if-same' is set, we are working on behalf of
2977 ;; set-visited-file-name. In that case, if the major mode specified is the
2978 ;; same one we already have, don't actually reset it. We don't want to lose
2979 ;; minor modes such as Font Lock.
2981 "Apply MODE and return it.
2982 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2983 any aliases and compared to current major mode. If they are the
2984 same, do nothing and return nil."
2990 mode)))
2993 "Regexp of lines to skip when looking for file-local settings.
2994 If the first line matches this regular expression, then the -*-...-*- file-
2998 "Find the -*- spec in the buffer.
2999 Call with point at the place to start searching from.
3000 If one is found, set point to the beginning and return the position
3001 of the end. Otherwise, return nil; may change point.
3002 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3003 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3004 have no effect."
3007 ;; Don't look for -*- if this file name matches any
3008 ;; of the regexps in inhibit-local-variables-regexps.
3011 ;; If the file begins with "#!" (exec
3012 ;; interpreter magic), look for mode frobs
3013 ;; in the first two lines. You cannot
3014 ;; necessarily put them in the first line
3015 ;; of such a file without screwing up the
3016 ;; interpreter invocation. The same holds
3017 ;; for '\" in man pages (preprocessor
3018 ;; magic for the `man' program).
3029 end))))
3030 \f
3031 ;;; Handling file local variables
3035 file-local-variables-alist dir-local-variables-alist)
3040 "Normal hook run after processing a file's local variables specs.
3041 Major modes can use this to examine user-specified local variables
3045 "List variable-value pairs that are considered safe.
3046 Each element is a cons cell (VAR . VAL), where VAR is a variable
3047 symbol and VAL is a value that is considered safe."
3048 :risky t
3053 ;; This should be here at least as long as Emacs supports write-file-hooks.
3058 "Expressions that are considered safe in an `eval:' local variable.
3059 Add expressions to this list if you want Emacs to evaluate them, when
3060 they appear in an `eval' local variable specification, without first
3061 asking you for confirmation."
3062 :risky t
3067 ;; Risky local variables:
3070 buffer-auto-save-file-name
3071 buffer-file-name
3072 buffer-file-truename
3073 buffer-undo-list
3074 debugger
3075 default-text-properties
3076 eval
3077 exec-directory
3078 exec-path
3079 file-name-handler-alist
3080 frame-title-format
3081 global-mode-string
3082 header-line-format
3083 icon-title-format
3084 inhibit-quit
3085 load-path
3086 max-lisp-eval-depth
3087 max-specpdl-size
3088 minor-mode-map-alist
3089 minor-mode-overriding-map-alist
3090 mode-line-format
3091 mode-name
3092 overriding-local-map
3093 overriding-terminal-local-map
3094 process-environment
3095 standard-input
3096 standard-output
3097 unread-command-events))
3099 ;; Safe local variables:
3100 ;;
3101 ;; For variables defined by major modes, the safety declarations can go into
3102 ;; the major mode's file, since that will be loaded before file variables are
3103 ;; processed.
3104 ;;
3105 ;; For variables defined by minor modes, put the safety declarations in the
3106 ;; file defining the minor mode after the defcustom/defvar using an autoload
3107 ;; cookie, e.g.:
3108 ;;
3109 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3110 ;;
3111 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3112 ;; minor mode file may not be loaded yet.
3113 ;;
3114 ;; For variables defined in the C source code the declaration should go here:
3136 "Alist of file-local variable settings in the current buffer.
3137 Each element in this list has the form (VAR . VALUE), where VAR
3138 is a file-local variable (a symbol) and VALUE is the value
3139 specified. The actual value in the buffer may differ from VALUE,
3145 "Alist of directory-local variable settings in the current buffer.
3146 Each element in this list has the form (VAR . VALUE), where VAR
3147 is a directory-local variable (a symbol) and VALUE is the value
3148 specified in .dir-locals.el. The actual value in the buffer
3149 may differ from VALUE, if it is changed by the major or minor modes,
3154 "Normal hook run before setting file-local variables.
3155 It is called after checking for unsafe/risky variables and
3156 setting `file-local-variables-alist', and before applying the
3157 variables stored in `file-local-variables-alist'. A hook
3158 function is allowed to change the contents of this alist.
3160 This hook is called only if there is at least one file-local
3164 "Get confirmation before setting up local variable values.
3165 ALL-VARS is the list of all variables to be set up.
3166 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3167 RISKY-VARS is the list of those that are marked as risky.
3168 If these settings come from directory-local variables, then
3169 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3176 unsafe-vars))
3178 ;; Set up the contents of the *Local Variables* buffer.
3186 ", and variables that are risky (**)."
3194 y -- to apply the local variables list.
3198 ! -- to apply the local variables list, and permanently mark these
3210 ;; Make strings with embedded whitespace easier to read.
3218 ;; Display the buffer and read a choice.
3226 ""
3229 char)
3248 "Return local variables specified in the -*- line.
3249 Usually returns an alist of elements (VAR . VAL), where VAR is a
3250 variable and VAL is the specified value. Ignores any
3251 specification for `coding:', and sometimes for `mode' (which
3252 should have already been handled by `set-auto-coding' and
3253 `set-auto-mode', respectively). Return nil if the -*- line is
3254 malformed.
3256 If HANDLE-MODE is nil, we return the alist of all the local
3257 variables in the line except `coding' as described above. If it
3258 is neither nil nor t, we do the same, except that any settings of
3259 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3260 all settings in the line except for `mode', which \(if present) we
3261 return as the symbol specifying the mode."
3266 result)
3268 nil)
3270 ;; Simple form: "-*- MODENAME -*-".
3274 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3275 ;; (last ";" is optional).
3276 ;; If HANDLE-MODE is t, just check for `mode'.
3277 ;; Otherwise, parse the -*- line into the RESULT alist.
3285 ;; There used to be a downcase here,
3286 ;; but the manual didn't say so,
3287 ;; and people want to set var names that aren't all lc.
3293 ;; It is traditional to ignore
3294 ;; case when checking for `mode' in set-auto-mode,
3295 ;; so we must do that here as well.
3296 ;; That is inconsistent, but we're stuck with it.
3297 ;; The same can be said for `coding' in set-auto-coding.
3311 ;; Downcase "Mode:".
3314 val)
3315 result)
3318 result))))))
3321 "Filter local variable settings, querying the user if necessary.
3322 VARIABLES is the alist of variable-value settings. This alist is
3323 filtered based on the values of `ignored-local-variables',
3324 `enable-local-eval', `enable-local-variables', and (if necessary)
3325 user interaction. The results are added to
3326 `file-local-variables-alist', without applying them.
3327 If these settings come from directory-local variables, then
3328 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3329 ;; Find those variables that we may want to save to
3330 ;; `safe-local-variable-values'.
3336 ;; Ignore any variable in `ignored-local-variables'.
3337 nil)
3338 ;; Obey `enable-local-eval'.
3342 ;; In case previously marked safe (bug#5636).
3344 ;; If not safe and e-l-v = :safe, ignore totally.
3348 safe
3350 ;; Ignore duplicates (except `mode') in the present list.
3352 ;; Accept known-safe variables.
3356 ;; The variable is either risky or unsafe:
3363 ;; Query, unless all vars are safe or user wants no querying.
3369 risky-vars dir-name))
3379 ;; TODO? Warn once per file rather than once per session?
3383 "Parse and put into effect this buffer's local variables spec.
3384 Uses `hack-local-variables-apply' to apply the variables.
3386 If HANDLE-MODE is nil, we apply all the specified local
3387 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3388 except that any settings of `mode' are ignored.
3391 is specified, and return the corresponding mode symbol, or nil.
3392 In this case, we try to ignore minor-modes, and only return a
3393 major-mode.
3395 If `enable-local-variables' or `local-enable-local-variables' is nil,
3396 this function does nothing. If `inhibit-local-variables-regexps'
3397 applies to the file in question, the file is not scanned for
3398 local variables, but directory-local variables may still be applied."
3399 ;; We don't let inhibit-local-variables-p influence the value of
3400 ;; enable-local-variables, because then it would affect dir-local
3401 ;; variables. We don't want to search eg tar files for file local
3402 ;; variable sections, but there is no reason dir-locals cannot apply
3403 ;; to them. The real meaning of inhibit-local-variables-p is "do
3404 ;; not scan this file for local variables".
3407 result)
3411 ;; Note this is a no-op if enable-local-variables is nil.
3413 ;; This entire function is basically a no-op if enable-local-variables
3414 ;; is nil. All it does is set file-local-variables-alist to nil.
3416 ;; This part used to ignore enable-local-variables when handle-mode
3417 ;; was t. That was inappropriate, eg consider the
3418 ;; (artificial) example of:
3419 ;; (setq local-enable-local-variables nil)
3420 ;; Open a file foo.txt that contains "mode: sh".
3421 ;; It correctly opens in text-mode.
3422 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3424 ;; If HANDLE-MODE is t, and the prop line specifies a
3425 ;; mode, then we're done, and have no need to scan further.
3427 handle-mode))
3429 ;; Look for "Local variables:" line in last page.
3437 ;; suffix is what comes after "local variables:" in its line.
3438 ;; prefix is what comes before "local variables:" in its line.
3451 endpos
3457 nil t))
3458 ;; This used to be an error, but really all it means is
3459 ;; that this may simply not be a local-variables section,
3460 ;; so just ignore it.
3470 ;; Discard the prefix.
3475 ;; Discard the suffix.
3484 ;; Find the variable name;
3492 val val2)
3495 ;; Read the variable value.
3502 ;; Specifying minor-modes via mode: is
3503 ;; deprecated, but try to reject them anyway.
3513 'files
3515 "%s: `lexical-binding' at end of file unreliable"
3517 ;; We are called from
3518 ;; 'with-temp-buffer', so we need
3519 ;; to use 'thisbuf's name in the
3520 ;; warning message.
3526 'eval
3530 ;; Now we've read all the local variables.
3531 ;; If HANDLE-MODE is t, return whether the mode was specified.
3533 ;; Otherwise, set the variables.
3538 "Apply the elements of `file-local-variables-alist'.
3539 If there are any elements, runs `before-hack-local-variables-hook',
3540 then calls `hack-one-local-variable' to apply the alist elements one by one.
3541 Finishes by running `hack-local-variables-hook', regardless of whether
3542 the alist is empty or not.
3544 Note that this function ignores a `mode' entry if it specifies the same
3545 major mode as the buffer already has."
3547 ;; Any 'evals must run in the Right sequence.
3556 "Non-nil if SYM is safe as a file-local variable with value VAL.
3557 It is safe if any of these conditions are met:
3559 * There is a matching entry (SYM . VAL) in the
3560 `safe-local-variable-values' user option.
3562 * The `safe-local-variable' property of SYM is a function that
3563 evaluates to a non-nil value with VAL as an argument."
3567 ;; If the function signals an error, that means it
3568 ;; can't assure us that the value is safe.
3572 "Non-nil if SYM could be dangerous as a file-local variable.
3573 It is dangerous if either of these conditions are met:
3575 * Its `risky-local-variable' property is non-nil.
3581 ;; If this is an alias, check the base name.
3601 "Return t if it is safe to eval EXP when it is found in a file."
3603 ;; Detect certain `put' expressions.
3610 lisp-indent-function
3611 scheme-indent-function))
3612 ;; Only allow safe values (not functions).
3617 ;; Only allow indirect form specs.
3618 ;; During bootstrapping, edebug-basic-spec might not be
3619 ;; defined yet.
3623 ;; Allow expressions that the user requested.
3625 ;; Certain functions can be allowed with safe arguments
3626 ;; or can specify verification functions to try.
3628 ;; Allow (minor)-modes calls with no arguments.
3629 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3638 ok))
3646 ok))))))))
3660 "Set local variable VAR with value VAL.
3661 If VAR is `mode', call `VAL-mode' as a function unless it's
3662 already the major mode."
3664 (`mode
3670 (`eval
3676 ;; Make sure the string has no text properties.
3677 ;; Some text properties can get evaluated in various ways,
3678 ;; so it is risky to put them on with a local variable list.
3682 \f
3683 ;;; Handling directory-local variables, aka project settings.
3689 "List of cached directory roots for directory-local variable classes.
3690 Each element in this list has the form (DIR CLASS MTIME).
3691 DIR is the name of the directory.
3692 CLASS is the name of a variable class (a symbol).
3693 MTIME is the recorded modification time of the directory-local
3694 variables file associated with this entry. This time is a list
3695 of integers (the same format as `file-attributes'), and is
3696 used to test whether the cache entry is still valid.
3697 Alternatively, MTIME can be nil, which means the entry is always
3701 "Return the variable list for CLASS."
3705 "Collect directory-local variables from MODE-VARIABLES.
3706 VARIABLES is the initial list of variables.
3707 Returns the new list."
3712 ;; If variables are specified more than once, only use the last. (Why?)
3713 ;; The pseudo-variables mode and eval are different (bug#3430).
3716 ;; Need a new cons in case we setcdr later.
3720 "Collect entries from CLASS-VARIABLES into VARIABLES.
3721 ROOT is the root directory of the project.
3722 Return the new variables list."
3724 ;; Handle non-file buffers, too.
3728 ;; FIXME: Why not use file-relative-name?
3735 ;; Don't include this in the previous condition, because we
3736 ;; want to filter all strings before the next condition.
3750 ;; TODO someone might want to extend this to allow
3751 ;; integer values for subdir, where N means
3752 ;; variables apply to this directory and N levels
3753 ;; below it (0 == nil).
3756 alist variables))))))))
3758 ;; The file's content might be invalid (e.g. have a merge conflict), but
3759 ;; that shouldn't prevent the user from opening the file.
3761 nil))))
3764 "Declare that the DIRECTORY root is an instance of CLASS.
3765 DIRECTORY is the name of a directory, a string.
3766 CLASS is the name of a project class, a symbol.
3767 MTIME is either the modification time of the directory-local
3768 variables file that defined this class, or nil.
3770 When a file beneath DIRECTORY is visited, the mode-specific
3771 variables from CLASS are applied to the buffer. The variables
3772 for a class are defined using `dir-locals-set-class-variables'."
3779 "Map the type CLASS to a list of variable settings.
3780 CLASS is the project class, a symbol. VARIABLES is a list
3781 that declares directory-local variables for the class.
3782 An element in VARIABLES is either of the form:
3783 (MAJOR-MODE . ALIST)
3784 or
3785 (DIRECTORY . LIST)
3787 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3788 whose elements are of the form (VARIABLE . VALUE).
3790 In the second form, DIRECTORY is a directory name (a string), and
3791 LIST is a list of the form accepted by the function.
3793 When a file is visited, the file's class is found. A directory
3794 may be assigned a class using `dir-locals-set-directory-class'.
3795 Then variables are set in the file's buffer according to the
3796 VARIABLES list of the class. The list is processed in order.
3798 * If the element is of the form (MAJOR-MODE . ALIST), and the
3799 buffer's major mode is derived from MAJOR-MODE (as determined
3800 by `derived-mode-p'), then all the variables in ALIST are
3801 applied. A MAJOR-MODE of nil may be used to match any buffer.
3802 `make-local-variable' is called for each variable before it is
3803 set.
3805 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3806 is an initial substring of the file's directory, then LIST is
3807 applied by recursively following these rules."
3811 "File that contains directory-local variables.
3812 It has to be constant to enforce uniform values across different
3813 environments and users.
3814 See also `dir-locals-file-2', whose values override this one's.
3818 "File that contains directory-local variables.
3819 This essentially a second file that can be used like
3820 `dir-locals-file', so that users can have specify their personal
3821 dir-local variables even if the current directory already has a
3822 `dir-locals-file' that is shared with other users (such as in a
3823 git repository).
3827 "Return a list of all readable dir-locals files in DIRECTORY.
3828 The returned list is sorted by increasing priority. That is,
3829 values specified in the last file should take precedence over
3830 those in the first."
3834 dir-locals-file)
3835 directory))
3839 ;; The order here is important.
3846 out)))
3849 "Find the directory-local variables for FILE.
3850 This searches upward in the directory tree from FILE.
3851 It stops at the first directory that has been registered in
3852 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3853 If it finds an entry in the cache, it checks that it is valid.
3854 A cache entry with no modification time element (normally, one that
3855 has been assigned directly using `dir-locals-set-directory-class', not
3856 set from a file) is always valid.
3857 A cache entry based on a `dir-locals-file' is valid if the modification
3858 time stored in the cache matches the current file modification time.
3859 If not, the cache entry is cleared so that the file will be re-read.
3861 This function returns either:
3862 - nil (no directory local variables found),
3863 - the matching entry from `dir-locals-directory-cache' (a list),
3864 - or the full path to the directory (a string) containing at
3865 least one `dir-locals-file' in the case of no valid cache
3866 entry."
3870 dir-elt)
3871 ;; `locate-dominating-file' may have abbreviated the name.
3874 ;; Find the best cached value in `dir-locals-directory-cache'.
3885 ;; Found a potential cache entry. Check validity.
3886 ;; A cache entry with no MTIME is assumed to always be valid
3887 ;; (ie, set directly, not from a dir-locals file).
3888 ;; Note, we don't bother to check that there is a matching class
3889 ;; element in dir-locals-class-alist, since that's done by
3890 ;; dir-locals-set-directory-class.
3893 ;; The entry MTIME should match the most recent
3894 ;; MTIME among matching files.
3900 cached-files))))))
3901 ;; This cache entry is OK.
3902 dir-elt
3903 ;; This cache entry is invalid; clear it.
3906 ;; Return the first existing dir-locals file. Might be the same
3907 ;; as dir-elt's, might not (eg latter might have been deleted).
3908 locals-dir)
3909 ;; No cache entry.
3910 locals-dir)))
3913 "Load all variables files in DIR and register a new class and instance.
3914 DIR is the absolute name of a directory which must contain at
3915 least one dir-local file (which is a file holding variables to
3916 apply).
3917 Return the new class name, which is a symbol named DIR."
3931 variables
3937 dir class-name
3942 files))
3943 ;; If there was a problem, use the values we could get but
3944 ;; don't let the cache prevent future reads.
3946 class-name))
3952 "Non-nil means dir-local variables will be applied to remote files."
3960 "Read per-directory local variables for the current buffer.
3961 Store the directory-local variables in `dir-local-variables-alist'
3962 and `file-local-variables-alist', without applying them.
3964 This does nothing if either `enable-local-variables' or
3965 `enable-dir-local-variables' are nil."
3967 enable-dir-local-variables
3970 default-directory)))))
3971 ;; Find the variables file.
4001 "Apply directory-local variables to a non-file buffer.
4002 For non-file buffers, such as Dired buffers, directory-local
4003 variables are looked for in `default-directory' and its parent
4004 directories."
4008 \f
4011 However, the mode will not be changed if
4012 \(1) a local variables list or the `-*-' line specifies a major mode, or
4014 not suitable for ordinary files, or
4015 \(3) the new file name does not particularly specify any mode."
4020 "Change name of file visited in current buffer to FILENAME.
4021 This also renames the buffer to correspond to the new file.
4022 The next time the buffer is saved it will go in the newly specified file.
4023 FILENAME nil or an empty string means mark buffer as not visiting any file.
4024 Remember to delete the initial contents of the minibuffer
4025 if you wish to pass an empty string as the argument.
4027 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4028 confirmation in the case where another buffer is already visiting FILENAME.
4030 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4031 the old visited file has been renamed to the new name FILENAME."
4039 nil
4054 filename)))
4061 buffer-file-name filename)
4065 ;; If new-name == old-name, renaming would add a spurious <2>
4066 ;; and it's considered as a feature in rename-buffer.
4072 ;; Abbreviate the file names of the buffer.
4081 nil))
4082 ;; write-file-functions is normally used for things like ftp-find-file
4083 ;; that visit things that are not local files as if they were files.
4084 ;; Changing to visit an ordinary local file instead should flush the hook.
4089 ;; If buffer was read-only because of version control,
4090 ;; that reason is gone now, so make it writable.
4094 ;; Turn off backup files for certain file names.
4095 ;; Since this is a permanent local, the major mode won't eliminate it.
4097 backup-enable-predicate
4106 ;; If auto-save was not already on, turn it on if appropriate.
4109 ;; If auto save is on, start using a new name. We
4110 ;; deliberately don't rename or delete the old auto save
4111 ;; for the old visited file name. This is because
4112 ;; perhaps the user wants to save the new state and then
4113 ;; compare with the previous state from the auto save
4114 ;; file.
4116 ;; Rename the old auto save file if any.
4123 ;; Update the major mode, if the file name determines it.
4125 ;; Don't change the mode if it is special.
4128 ;; Don't change the mode if the local variable list specifies it.
4129 ;; The file name can influence whether the local variables apply.
4131 ;; h-l-v also checks it, but might as well be explicit.
4134 ;; TODO consider making normal-mode handle this case.
4142 "Write current buffer into file FILENAME.
4143 This makes the buffer visit that file, and marks it as not modified.
4145 If you specify just a directory name as FILENAME, that means to use
4146 the default file name but in that directory. You can also yank
4147 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4149 If the buffer is not already visiting a file, the default file name
4150 for the output file is the buffer name.
4152 If optional second arg CONFIRM is non-nil, this function
4153 asks for confirmation before overwriting an existing file.
4154 Interactively, confirmation is required unless you supply a prefix argument."
4155 ;; (interactive "FWrite file: ")
4159 nil nil nil nil)
4163 default-directory)
4164 nil nil))
4168 ;; If arg is just a directory,
4169 ;; use the default file name, but in that directory.
4176 ;; NS does its own confirm dialog.
4179 use-dialog-box))
4185 ;; Make buffer writable if file is writable.
4190 ;; It's likely that the VC status at the new location is different from
4191 ;; the one at the old location.
4193 \f
4195 "Return an alist of extended attributes of file FILENAME.
4197 Extended attributes are platform-specific metadata about the file,
4198 such as SELinux context, list of ACL entries, etc."
4203 "Set extended attributes of file FILENAME to ATTRIBUTES.
4205 ATTRIBUTES must be an alist of file attributes as returned by
4206 `file-extended-attributes'.
4207 Value is t if the function succeeds in setting the attributes."
4218 result))
4219 \f
4221 "Make a backup of the disk file visited by the current buffer, if appropriate.
4222 This is normally done before saving the buffer the first time.
4224 A backup may be done by renaming or by copying; see documentation of
4225 variable `make-backup-files'. If it's done by renaming, then the file is
4226 no longer accessible under its old name.
4228 The value is non-nil after a backup was made by renaming.
4229 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4230 MODES is the result of `file-modes' on the original
4231 file; this means that the caller, after saving the buffer, should change
4232 the modes of the new file to agree with the old modes.
4233 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4234 on the original file; this means that the caller, after saving
4235 the buffer, should change the extended attributes of the new file
4236 to agree with the old attributes.
4237 BACKUPNAME is the backup file name, which is the old file renamed."
4241 ;; If specified name is a symbolic link, chase it to the target.
4242 ;; This makes backups in the directory where the real file is.
4249 ;; If have old versions to maybe delete,
4250 ;; ask the user to confirm now, before doing anything.
4251 ;; But don't actually delete til later.
4257 real-file-name)))
4258 targets))
4263 backup-by-copying-when-privileged-mismatch)
4266 ;; Don't rename a suid or sgid file.
4275 real-file-name
4278 copy-when-priv-mismatch))))
4280 t)))))
4281 setmodes)
4284 ;; Actually make the backup file.
4287 modes extended-attributes)
4288 ;; rename-file should delete old backup.
4291 backupname)))
4293 ;; Now delete the old versions, if desired.
4297 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4301 backupname)
4304 modes extended-attributes)
4306 setmodes)))))))
4309 ;; Create temp files with strict access rights. It's easy to
4310 ;; loosen them later, whereas it's impossible to close the
4311 ;; time-window of loose permissions otherwise.
4314 ;; Try to overwrite old backup first.
4322 nil)
4324 ;; The file was somehow created by someone else between
4325 ;; `delete-file' and `copy-file', so let's try again.
4326 ;; rms says "I think there is also a possible race
4327 ;; condition for making backup files" (emacs-devel 20070821).
4328 nil)))
4329 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4338 ;; The last ~[[:digit]]+ matches relative versions in git,
4339 ;; e.g. `foo.js.~HEAD~1~'.
4340 "Regular expression matching the backup/version part of a file name.
4344 "Return file NAME sans backup versions or strings.
4345 This is a separate procedure so your site-init or startup file can
4346 redefine it.
4347 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4348 we do not remove backup version numbers, only true file version numbers.
4349 See also `file-name-version-regexp'."
4356 name))))))
4359 "Return t if deleting FILE and rewriting it would preserve the owner.
4360 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4361 the group would be preserved too."
4366 ;; Return t if the file doesn't exist, since it's true that no
4367 ;; information would be lost by an (attempted) delete and create.
4370 ;; Files created on Windows by Administrator (RID=500)
4371 ;; have the Administrators group (RID=544) recorded as
4372 ;; their owner. Rewriting them will still preserve the
4373 ;; owner.
4377 ;; On BSD-derived systems files always inherit the parent
4378 ;; directory's group, so skip the group-gid test.
4384 ;; On some systems, a file created in a setuid directory
4385 ;; inherits that directory's owner.
4389 ;; On many systems, a file created in a setgid directory
4390 ;; inherits that directory's group. On some systems
4391 ;; this happens even if the setgid bit is not set.
4398 The extension, in a file name, is the part that begins with the last `.',
4399 except that a leading `.' of the file name, if there is one, doesn't count."
4402 directory)
4406 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4407 ;; we don't want to expand it.
4410 filename))))
4414 The extension, in a file name, is the part that begins with the last `.',
4415 excluding version numbers and backup suffixes, except that a leading `.'
4416 of the file name, if there is one, doesn't count.
4417 Return nil for extensionless file names such as `foo'.
4418 Return the empty string for file names such as `foo.'.
4420 By default, the returned value excludes the period that starts the
4421 extension, but if the optional argument PERIOD is non-nil, the period
4422 is included in the value, and in that case, if FILENAME has no
4433 "Return the base name of the FILENAME: no directory, no extension.
4434 FILENAME defaults to `buffer-file-name'."
4439 #'make-backup-file-name--default-function
4440 "A function that `make-backup-file-name' uses to create backup file names.
4441 The function receives a single argument, the original file name.
4443 If you change this, you may need to change `backup-file-name-p' and
4444 `file-name-sans-versions' too.
4446 You could make this buffer-local to do something special for specific files.
4448 For historical reasons, a value of nil means to use the default function.
4449 This should not be relied upon.
4451 See also `backup-directory-alist'."
4458 "Alist of filename patterns and backup directory names.
4459 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4460 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4461 relative or absolute. If it is absolute, so that all matching files
4462 are backed up into the same directory, the file names in this
4463 directory will be the full name of the file backed up with all
4464 directory separators changed to `!' to prevent clashes. This will not
4465 work correctly if your filesystem truncates the resulting name.
4467 For the common case of all backups going into one directory, the alist
4469 directory name.
4471 If this variable is nil, or it fails to match a filename, the backup
4472 is made in the original file's directory.
4474 On MS-DOS filesystems without long names this variable is always
4475 ignored."
4481 "Default `backup-enable-predicate' function.
4482 Checks for files in `temporary-file-directory',
4485 caseless)
4486 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4487 ;; their long file-name equivalents, so compare-strings does TRT.
4491 caseless t))
4494 ;; Directory is under temporary-file-directory.
4499 ;; Directory is under /tmp.
4504 0 nil
4506 ;; Directory is under small-temporary-file-directory.
4511 "Create the non-numeric backup file name for FILE.
4512 This calls the function that `make-backup-file-name-function' specifies,
4513 with a single argument FILE."
4516 file))
4519 "Default function for `make-backup-file-name'.
4520 Normally this just returns FILE's name with `~' appended.
4521 It searches for a match for FILE in `backup-directory-alist'.
4522 If the directory for the backup doesn't exist, it is created."
4534 "Subroutine of `make-backup-file-name--default-function'.
4535 The function `find-backup-file-name' also uses this."
4537 elt backup-directory abs-backup-directory)
4542 alist nil)))
4543 ;; If backup-directory is relative, it should be relative to the
4544 ;; file's directory. By expanding explicitly here, we avoid
4545 ;; depending on default-directory.
4554 abs-backup-directory nil))))
4556 file
4560 ;; Normalize DOSish file names: downcase the drive
4561 ;; letter, if any, and replace the leading "x:" with
4562 ;; "/drive_x".
4565 ;; Replace any invalid file-name characters (for the
4566 ;; case of backing up remote files).
4570 "drive_"
4573 ""
4576 ;; Make the name unique by substituting directory
4577 ;; separators. It may not really be worth bothering about
4578 ;; doubling `!'s in the original name...
4583 backup-directory))
4588 "Return non-nil if FILE is a backup file name (numeric or not).
4589 This is a separate function so you can redefine it for customization.
4590 You may need to redefine `file-name-sans-versions' as well."
4595 ;; This is used in various files.
4596 ;; The usage of backup-extract-version-start is not very clean,
4597 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4599 "Given the name of a numeric backup file, FN, return the backup number.
4600 Uses the free variable `backup-extract-version-start', whose value should be
4601 the index in the name where the version number begins."
4608 "Find a file name for a backup file FN, and suggestions for deletions.
4609 Value is a list whose car is the name for the backup file
4610 and whose cdr is a list of old versions to consider deleting now.
4611 If the value is nil, don't make a backup.
4612 Uses `backup-directory-alist' in the same way as
4613 `make-backup-file-name--default-function' does."
4615 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4619 ;; We don't support numbered backups on plain MS-DOS
4620 ;; when long file names are unavailable.
4630 possibilities deserve-versions-p versions)
4633 base-versions
4636 possibilities)
4637 #'<)
4642 kept-old-versions
4643 kept-new-versions
4650 ;; Delete nothing if there is overflow
4651 ;; in the number of versions to keep.
4657 v))))))))))
4660 "Return number of names file FILENAME has."
4663 ;; (defun file-relative-name (filename &optional directory)
4664 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4665 ;; This function returns a relative file name which is equivalent to FILENAME
4666 ;; when used with that default directory as the default.
4667 ;; If this is impossible (which can happen on MSDOS and Windows
4668 ;; when the file name and directory use different drive names)
4669 ;; then it returns FILENAME."
4670 ;; (save-match-data
4671 ;; (let ((fname (expand-file-name filename)))
4672 ;; (setq directory (file-name-as-directory
4673 ;; (expand-file-name (or directory default-directory))))
4674 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4675 ;; ;; drive names, they can't be relative, so return the absolute name.
4676 ;; (if (and (or (eq system-type 'ms-dos)
4677 ;; (eq system-type 'cygwin)
4678 ;; (eq system-type 'windows-nt))
4679 ;; (not (string-equal (substring fname 0 2)
4680 ;; (substring directory 0 2))))
4681 ;; filename
4682 ;; (let ((ancestor ".")
4683 ;; (fname-dir (file-name-as-directory fname)))
4684 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4685 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4686 ;; (setq directory (file-name-directory (substring directory 0 -1))
4687 ;; ancestor (if (equal ancestor ".")
4688 ;; ".."
4689 ;; (concat "../" ancestor))))
4690 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4691 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4692 ;; ;; We matched within FNAME's directory part.
4693 ;; ;; Add the rest of FNAME onto ANCESTOR.
4694 ;; (let ((rest (substring fname (match-end 0))))
4695 ;; (if (and (equal ancestor ".")
4696 ;; (not (equal rest "")))
4697 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4698 ;; rest
4699 ;; (concat (file-name-as-directory ancestor) rest)))
4700 ;; ;; We matched FNAME's directory equivalent.
4701 ;; ancestor))))))
4704 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4705 This function returns a relative file name which is equivalent to FILENAME
4706 when used with that default directory as the default.
4707 If FILENAME is a relative file name, it will be interpreted as existing in
4708 `default-directory'.
4709 If FILENAME and DIRECTORY lie on different machines or on different drives
4710 on a DOS/Windows machine, it returns FILENAME in expanded form."
4714 default-directory))))
4719 read-file-name-completion-ignore-case)))
4722 ;; Test for different filesystems on DOS/Windows
4724 ;; Should `cygwin' really be included here? --stef
4727 ;; Test for different drive letters
4729 ;; Test for UNCs on different servers
4734 ;; Windows file names cannot have ? in
4735 ;; them, so use that to detect when
4736 ;; neither FILENAME nor DIRECTORY is a
4737 ;; UNC.
4739 0 nil
4745 ;; Test for different remote file system identification
4747 filename
4755 ".."
4757 ;; Now ancestor is empty, or .., or ../.., etc.
4759 ;; We matched within FILENAME's directory part.
4760 ;; Add the rest of FILENAME onto ANCESTOR.
4763 ;; But don't bother with ANCESTOR if it would give us `./'.
4764 rest
4766 ;; We matched FILENAME's directory equivalent.
4767 ancestor))))))
4768 \f
4770 "Save current buffer in visited file if modified.
4771 Variations are described below.
4773 By default, makes the previous version into a backup file
4774 if previously requested or if this is the first save.
4776 to become a backup when the next save is done.
4778 makes the previous version into a backup file.
4780 to become a backup when the next save is done,
4781 and makes the previous version into a backup file.
4783 With a numeric prefix argument of 0, never make the previous version
4784 into a backup file.
4786 Note that the various variables that control backups, such
4787 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4788 and `backup-inhibited', to name just the more popular ones, still
4789 control whether a backup will actually be produced, even when you
4792 If a file's name is FOO, the names of its numbered backup versions are
4793 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4794 Numeric backups (rather than FOO~) will be made if value of
4795 `version-control' is not the atom `never' and either there are already
4796 numeric versions of the file being backed up, or `version-control' is
4797 non-nil.
4798 We don't want excessive versions piling up, so there are variables
4799 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4800 and `kept-new-versions', which tells how many newest versions to keep.
4801 Defaults are 2 old versions and 2 new.
4802 `dired-kept-versions' controls dired's clean-directory (.) command.
4803 If `delete-old-versions' is nil, system will query user
4804 before trimming versions. Otherwise it does it silently.
4806 If `vc-make-backup-files' is nil, which is the default,
4807 no backup files are made for files managed by version control.
4808 (This is because the version control system itself records previous versions.)
4810 See the subroutine `basic-save-buffer' for more information."
4816 ;; We used to display the message below only for files > 50KB, but
4817 ;; then Rmail-mbox never displays it due to buffer swapping. If
4818 ;; the test is ever re-introduced, be sure to handle saving of
4819 ;; Rmail files.
4829 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4830 Normally delete only if the file was written by this Emacs since
4831 the last real save, but optional arg FORCE non-nil means delete anyway."
4845 "Normal hook that is run before a buffer is saved to its file."
4851 "Normal hook that is run after a buffer is saved to its file."
4857 "If non-nil, use this coding system for saving the buffer.
4858 More precisely, use this coding system in place of the
4859 value of `buffer-file-coding-system', when saving the buffer.
4860 Calling `write-region' for any purpose other than saving the buffer
4861 will still use `buffer-file-coding-system'; this variable has no effect
4868 "Save the current buffer in its visited file, if it has been modified.
4869 The hooks `write-contents-functions' and `write-file-functions' get a chance
4870 to do the job of saving; if they do not, then the buffer is saved in
4871 the visited file in the usual way.
4872 Before and after saving the buffer, this function runs
4873 `before-save-hook' and `after-save-hook', respectively."
4876 ;; In an indirect buffer, save its base buffer instead.
4880 ;; handle the case when no modification has been made but
4881 ;; the file disappeared since visited
4885 setmodes)
4886 ;; If buffer has no file name, ask user for one.
4894 ;; Signal an error if the user specified the name of an
4895 ;; existing directory.
4898 "File `%s' exists; overwrite? "
4899 filename))
4906 "%s has changed since visited or saved. Save anyway? "
4926 ;; Support VC version backups.
4928 ;; Don't let errors prevent saving the buffer.
4933 ;; If a hook returned t, file is already "written".
4934 ;; Otherwise, write it the usual way now.
4944 ;; Now we have saved the current buffer. Let's make sure
4945 ;; that buffer-file-coding-system is fixed to what
4946 ;; actually used for saving by binding it locally.
4961 ;; If the auto-save file was recent before this command,
4962 ;; delete it now.
4964 ;; Support VC `implicit' locking.
4971 ;; This does the "real job" of writing a buffer into its visited file
4972 ;; and making a backup file. This is what is normally done
4973 ;; but inhibited if one of write-file-functions returns non-nil.
4974 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4975 ;; backup-buffer.
4985 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4986 ;; backup-buffer.
4999 "File %s is write-protected; try to save anyway? "
5001 buffer-file-name)))
5015 dir))))
5016 ;; Write temp name, then rename it.
5017 ;; This requires write access to the containing dir,
5018 ;; which is why we don't try it if we don't have that access.
5020 tempname succeed
5023 ;; Create temp files with strict access rights. It's easy to
5024 ;; loosen them later, whereas it's impossible to close the
5025 ;; time-window of loose permissions otherwise.
5030 ;; Try various temporary names.
5031 ;; This code follows the example of make-temp-file,
5032 ;; but it calls write-region in the appropriate way
5033 ;; for saving the buffer.
5039 ;; Pass in nil&nil rather than point-min&max
5040 ;; cause we're saving the whole buffer.
5041 ;; write-region-annotate-functions may use it.
5043 tempname nil realname
5046 nil)
5048 ;; The file was somehow created by someone else between
5049 ;; `make-temp-name' and `write-region', let's try again.
5050 nil)
5052 ;; Reset the umask.
5054 ;; If we failed, restore the buffer's modtime.
5057 ;; Since we have created an entirely new file,
5058 ;; make sure it gets the right permission bits set.
5063 buffer-file-name)))
5064 ;; We succeeded in writing the temp file,
5065 ;; so rename it.
5067 ;; If file not writable, see if we can make it writable
5068 ;; temporarily while we write it.
5069 ;; But no need to do so if we have just backed it up
5070 ;; (setmodes is set) because that says we're superseding.
5072 ;; Change the mode back, after writing.
5075 buffer-file-name))
5076 ;; If set-file-extended-attributes fails, fall back on
5077 ;; set-file-modes.
5087 ;; Pass in nil&nil rather than point-min&max to indicate
5088 ;; we're saving the buffer rather than just a region.
5089 ;; write-region-annotate-functions may make us of it.
5091 buffer-file-name nil t buffer-file-truename)
5094 ;; If we get an error writing the new file, and we made
5095 ;; the backup by renaming, undo the backing-up.
5100 setmodes))
5106 `((?\C-r
5113 ;; Return nil to ask about BUF again.
5114 nil)
5127 ;; Return nil to ask about BUF again.
5128 nil)
5138 "Default predicate for `save-some-buffers'.
5139 This allows you to stop `save-some-buffers' from asking
5140 about certain files that you'd usually rather not save."
5146 "Save some modified file-visiting buffers. Asks user about each one.
5147 You can answer `y' to save, `n' not to save, `C-r' to look at the
5148 buffer in question with `view-buffer' before deciding or `d' to
5149 view the differences using `diff-buffer-with-file'.
5151 This command first saves any buffers where `buffer-save-without-query' is
5152 non-nil, without asking.
5154 Optional argument (the prefix) non-nil means save all with no questions.
5155 Optional second argument PRED determines which buffers are considered:
5156 If PRED is nil, all the file-visiting buffers are considered.
5157 If PRED is t, then certain non-file buffers will also be considered.
5158 If PRED is a zero-argument function, it indicates for each buffer whether
5159 to consider it or not when called with that buffer current.
5160 PRED defaults to the value of `save-some-buffers-default-predicate'.
5162 See `save-some-buffers-action-alist' if you want to
5163 change the additional actions you can take on files."
5169 files-done abbrevs-done)
5171 ;; First save any buffers that we're supposed to save unconditionally.
5172 ;; That way the following code won't ask about them.
5177 ;; Ask about those buffers that merit it,
5178 ;; and record the number thus saved.
5182 ;; Note that killing some buffers may kill others via
5183 ;; hooks (e.g. Rmail and its viewing buffer).
5196 t
5208 save-some-buffers-action-alist))
5209 ;; Maybe to save abbrevs, and record whether
5210 ;; we either saved them or asked to.
5217 ;; Don't keep bothering user if he says no.
5231 \f
5233 "Clear out records of last mod time of visited file.
5234 Next attempt to save will not complain of a discrepancy."
5238 "Mark current buffer as unmodified, not needing to be saved.
5241 It is not a good idea to use this function in Lisp programs, because it
5242 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5250 "Change whether this buffer is read-only."
5258 "Insert contents of file FILENAME into buffer after point.
5259 Set mark after the inserted text.
5261 This function is meant for the user to run interactively.
5262 Don't call it from programs! Use `insert-file-contents' instead.
5263 \(Its calling sequence is different; see its documentation)."
5269 "Append the contents of the region to the end of file FILENAME.
5270 When called from a function, expects three arguments,
5271 START, END and FILENAME. START and END are normally buffer positions
5272 specifying the part of the buffer to write.
5273 If START is nil, that means to use the entire buffer contents.
5274 If START is a string, then output that string to the file
5275 instead of any buffer contents; END is ignored.
5277 This does character code conversion and applies annotations
5278 like `write-region' does."
5284 "Return most recent backup file for FILENAME or nil if no backups exist."
5285 ;; `make-backup-file-name' will get us the right directory for
5286 ;; ordinary or numeric backups. It might create a directory for
5287 ;; backups as a side-effect, according to `backup-directory-alist'.
5294 tem)
5303 newest))
5306 "Rename current buffer to a similar name not already taken.
5307 This function is useful for creating multiple shell process buffers
5308 or multiple mail buffers, etc.
5310 Note that some commands, in particular those based on `compilation-mode'
5311 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5312 appropriate mode even if it has been renamed. So as well as renaming
5313 the buffer, you also need to switch buffers before running another
5314 instance of such commands."
5322 ;; If the existing buffer name has a <NNN>,
5323 ;; which isn't part of the file name (if any),
5324 ;; then get rid of that.
5330 "Create the directory DIR and optionally any nonexistent parent dirs.
5331 If DIR already exists as a directory, signal an error, unless
5332 PARENTS is non-nil.
5334 Interactively, the default choice of directory to create is the
5335 current buffer's default directory. That is useful when you have
5336 visited a file in a nonexistent directory.
5338 Noninteractively, the second (optional) argument PARENTS, if
5339 non-nil, says whether to create parent directories that don't
5340 exist. Interactively, this happens by default.
5342 If creating the directory or directories fail, an error will be
5343 raised."
5346 nil nil)
5347 t))
5348 ;; If default-directory is a remote directory,
5349 ;; make sure we find its make-directory handler.
5357 create-list)
5359 ;; If directory is its own parent, then we can't
5360 ;; keep looping forever
5375 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5376 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5377 non-nil and if FN fails due to a missing file or directory."
5383 "Delete the directory named DIRECTORY. Does not follow symlinks.
5384 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5385 no error if something else is simultaneously deleting them.
5386 TRASH non-nil means to trash the directory instead, provided
5387 `delete-by-moving-to-trash' is non-nil.
5389 When called interactively, TRASH is nil if and only if a prefix
5390 argument is given, and a further prompt asks the user for
5391 RECURSIVE if DIRECTORY is nonempty."
5398 "Move directory to trash: "
5400 default-directory default-directory nil nil))))
5406 nil)
5408 ;; If default-directory is a remote directory, make sure we find its
5409 ;; delete-directory handler.
5416 ;; Only move non-empty dir to trash if recursive deletion was
5417 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5418 ;; case, where the operation fails in delete-directory-internal.
5419 ;; As `move-file-to-trash' trashes directories (empty or
5420 ;; otherwise) as a unit, we do not need to recurse here.
5422 ;; Check if directory is empty apart from "." and "..".
5427 ;; Otherwise, call ourselves recursively if needed.
5432 directory-files-no-dot-files-regexp))
5436 ;; This test is equivalent to but more efficient
5437 ;; than (and (file-directory-p fn)
5438 ;; (not (file-symlink-p fn))).
5442 files))
5443 directory-exists))
5447 "Return non-nil if files FILE1 and FILE2 name the same file.
5448 If FILE1 or FILE2 does not exist, the return value is unspecified."
5459 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5461 Return nil if DIR is not an existing directory."
5473 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5488 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5489 This function always sets the file modes of the output files to match
5490 the corresponding input file.
5492 The third arg KEEP-TIME non-nil means give the output files the same
5493 last-modified time as the old ones. (This works on only some systems.)
5495 A prefix arg makes KEEP-TIME non-nil.
5497 Noninteractively, the last argument PARENTS says whether to
5498 create parent directories if they don't exist. Interactively,
5499 this happens by default.
5501 If NEWNAME names an existing directory, copy DIRECTORY as a
5502 subdirectory there. However, if called from Lisp with a non-nil
5503 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5504 directly into NEWNAME instead."
5511 default-directory default-directory nil nil)
5512 current-prefix-arg t nil)))
5515 directory newname))
5516 ;; If default-directory is a remote directory, make sure we find its
5517 ;; copy-directory handler.
5522 newname keep-time parents copy-contents)
5524 ;; Compute target name.
5529 ;; If NEWNAME is not an existing directory, create it;
5530 ;; that is where we will copy the files of DIRECTORY.
5532 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5533 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5538 newname))
5542 newname))
5545 ;; Copy recursively.
5547 ;; We do not want to copy "." and "..".
5549 directory-files-no-dot-files-regexp))
5559 ;; Set directory attributes.
5565 \f
5566 ;; At time of writing, only info uses this.
5568 "Return a copy of DIRS with all non-existent directories removed.
5569 The optional argument KEEP is a list of directories to retain even if
5570 they don't exist, and REJECT is a list of directories to remove from
5571 DIRS, even if they exist; REJECT takes precedence over KEEP.
5573 Note that membership in REJECT and KEEP is checked using simple string
5574 comparison."
5580 dirs)))
5582 \f
5585 "Function to use to revert this buffer.
5586 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5587 which are the arguments that `revert-buffer' received.
5588 It also has access to the `preserve-modes' argument of `revert-buffer'
5589 via the `revert-buffer-preserve-modes' dynamic variable.
5591 For historical reasons, a value of nil means to use the default function.
5596 #'revert-buffer-insert-file-contents--default-function
5597 "Function to use to insert contents when reverting this buffer.
5598 The function receives two arguments: the first the nominal file name to use;
5599 the second is t if reading the auto-save file.
5601 The function is responsible for updating (or preserving) point.
5603 For historical reasons, a value of nil means to use the default function.
5607 "Default function to use for `buffer-stale-function'.
5608 This function ignores its argument.
5609 This returns non-nil if the current buffer is visiting a readable file
5610 whose modification time does not match that of the buffer.
5612 This function only handles buffers that are visiting files.
5613 Non-file buffers need a custom function"
5620 "Function to check whether a buffer needs reverting.
5621 This should be a function with one optional argument NOCONFIRM.
5622 Auto Revert Mode passes t for NOCONFIRM. The function should return
5623 non-nil if the buffer should be reverted. A return value of
5624 `fast' means that the need for reverting was not checked, but
5625 that reverting the buffer is fast. The buffer is current when
5626 this function is called.
5628 The idea behind the NOCONFIRM argument is that it should be
5629 non-nil if the buffer is going to be reverted without asking the
5630 user. In such situations, one has to be careful with potentially
5631 time consuming operations.
5633 For historical reasons, a value of nil means to use the default function.
5634 This should not be relied upon.
5636 For more information on how this variable is used by Auto Revert mode,
5640 "Normal hook for `revert-buffer' to run before reverting.
5641 The function `revert-buffer--default' runs this.
5645 "Normal hook for `revert-buffer' to run after reverting.
5646 Note that the hook value that it runs is the value that was in effect
5647 before reverting; that makes a difference if you have buffer-local
5648 hook functions.
5650 The function `revert-buffer--default' runs this.
5658 ;; `revert-buffer-function' was defined long ago to be a function of only
5659 ;; 2 arguments, so we have to use a dynbind variable to pass the
5660 ;; `preserve-modes' argument of `revert-buffer'.
5664 "Replace current buffer text with the text of the visited file on disk.
5665 This undoes all changes since the file was visited or saved.
5666 With a prefix argument, offer to revert from latest auto-save file, if
5667 that is more recent than the visited file.
5669 This command also implements an interface for special buffers
5670 that contain text which doesn't come from a file, but reflects
5671 some other data instead (e.g. Dired buffers, `buffer-list'
5672 buffers). This is done via the variable `revert-buffer-function'.
5673 In these cases, it should reconstruct the buffer contents from the
5674 appropriate data.
5676 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5677 to revert from the auto-save file when this is nil. Note that the
5678 sense of this argument is the reverse of the prefix argument, for the
5679 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5680 to nil.
5682 Optional second argument NOCONFIRM means don't ask for confirmation
5683 at all. (The variable `revert-without-query' offers another way to
5684 revert buffers without querying for confirmation.)
5686 Optional third argument PRESERVE-MODES non-nil means don't alter
5687 the files modes. Normally we reinitialize them using `normal-mode'.
5689 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5691 This function calls the function that `revert-buffer-function' specifies
5692 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5693 The default function runs the hooks `before-revert-hook' and
5694 `after-revert-hook'."
5695 ;; I admit it's odd to reverse the sense of the prefix argument, but
5696 ;; there is a lot of code out there which assumes that the first
5697 ;; argument should be t to avoid consulting the auto-save file, and
5698 ;; there's no straightforward way to encourage authors to notice a
5699 ;; reversal of the argument sense. So I'm just changing the user
5700 ;; interface, but leaving the programmatic interface the same.
5705 ignore-auto noconfirm)))
5708 "Default function for `revert-buffer'.
5709 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5710 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5711 start and end.
5713 Calls `revert-buffer-insert-file-contents-function' to reread the
5714 contents of the visited file, with two arguments: the first is the file
5715 name, the second is non-nil if reading an auto-save file.
5717 This function only handles buffers that are visiting files.
5718 Non-file buffers need a custom function."
5723 buffer-auto-save-file-name
5728 buffer-auto-save-file-name
5729 buffer-file-name)))
5739 file-name)))
5741 ;; If file was backed up but has changed since,
5742 ;; we should make another backup.
5746 ;; Effectively copy the after-revert-hook status,
5747 ;; since after-find-file will clobber it.
5750 after-revert-hook))
5752 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5756 file-name auto-save-p)
5757 ;; Recompute the truename in case changes in symlinks
5758 ;; have changed the truename.
5762 ;; Run after-revert-hook as it was before we reverted.
5766 local-hook)
5769 t)))))
5772 "Default function for `revert-buffer-insert-file-contents-function'.
5773 The function `revert-buffer--default' calls this.
5774 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5775 an auto-save file."
5779 "File %s no longer exists!"
5781 file-name))
5784 "File %s no longer readable!"
5786 file-name))
5788 ;; Bind buffer-file-name to nil
5789 ;; so that we don't try to lock the file.
5795 ;; Auto-saved file should be read by Emacs's
5796 ;; internal coding.
5800 buffer-file-coding-system-explicit
5803 coding-system-for-read
5805 coding-system-for-read)
5807 ;; As a coding system suitable for multibyte
5808 ;; buffer is specified, make the current
5809 ;; buffer multibyte.
5812 ;; This force after-insert-file-set-coding
5813 ;; (called from insert-file-contents) to set
5814 ;; buffer-file-coding-system to a proper value.
5817 ;; Note that this preserves point in an intelligent way.
5821 nil nil t))
5823 nil nil t))))))
5826 "Recover the visited file--get contents from its last auto-save file."
5831 "Visit file FILE, but get contents from its last auto-save file."
5832 ;; Actually putting the file name in the minibuffer should be used
5833 ;; only rarely.
5834 ;; Not just because users often use the default.
5847 "*Directory*" nil
5858 ;; Use insert-directory-safely, not insert-directory,
5859 ;; because these files might not exist. In particular,
5860 ;; FILE might not exist if the auto-save file was for
5861 ;; a buffer that didn't visit a file, such as "*mail*".
5862 ;; The code in v20.x called `ls' directly, so we need
5863 ;; to emulate what `ls' did in that case.
5868 ;; Keep the current buffer-file-coding-system.
5870 ;; Auto-saved file should be read with special coding.
5879 "Recover auto save files from a previous Emacs session.
5880 This command first displays a Dired buffer showing you the
5881 previous sessions that you could recover from.
5882 To choose one, move point to the proper line and then type C-c C-c.
5883 Then you'll be asked about a number of files to recover."
5893 directory-files-no-dot-files-regexp
5895 t)
5906 ;; Each line starts with a space
5907 ;; so that Font Lock mode won't highlight the first character.
5910 " To delete a session file, type \
5916 "Choose one saved session to recover auto-save files from.
5917 This command is used in the special Dired buffer created by
5920 ;; Get the name of the session file to recover from.
5922 files
5928 ;; Read in the auto-save-list file.
5931 ;; Loop thru the text of that file
5932 ;; and get out the names of the files to recover.
5936 ;; This is a pair of lines for a non-file-visiting buffer.
5937 ;; Get the auto-save file name and manufacture
5938 ;; a "visited file name" from that.
5941 ;; If there is no auto-save file name, the
5942 ;; auto-save-list file is probably corrupted.
5955 ;; This pair of lines is a file-visiting
5956 ;; buffer. Use the visited file name.
5966 ;; Ignore a file if its auto-save file does not exist now.
5970 ;; The file contains a pair of line for each auto-saved buffer.
5971 ;; The first line of the pair contains the visited file name
5972 ;; or is empty if the buffer was not visiting a file.
5973 ;; The second line is the auto-save file name.
5981 files
5987 "Kill BUFFER if confirmed."
5995 "Kill some buffers. Asks the user whether to kill each one of them.
5996 Non-interactively, if optional argument LIST is non-nil, it
5997 specifies the list of buffers to kill, asking for approval for each one."
6005 ; if we killed the base buffer.
6012 "Kill buffers whose name matches the specified REGEXP.
6013 The optional second argument indicates whether to kill internal buffers too."
6022 \f
6024 "Adjust current buffer's auto save file name for current conditions.
6025 Also rename any existing auto save file, if it was made in this session."
6037 "Return file name to use for auto-saves of current buffer.
6038 Does not consider `auto-save-visited-file-name' as that variable is checked
6039 before calling this function. You can redefine this for customization.
6040 See also `auto-save-file-name-p'."
6048 result uniq)
6049 ;; Apply user-specified translations
6050 ;; to the file name.
6054 filename)
6064 filename))))
6069 ;; We truncate the file name to DOS 8+3 limits
6070 ;; before doing anything else, because the regexp
6071 ;; passed to string-match below cannot handle
6072 ;; extensions longer than 3 characters, multiple
6073 ;; dots, and other atrocities.
6078 fn)
6083 "#"
6086 ;; Make sure auto-save file names don't contain characters
6087 ;; invalid for the underlying filesystem.
6089 ;; Don't modify remote filenames
6092 result))))
6094 ;; Deal with buffers that don't have any associated files. (Mail
6095 ;; mode tends to create a good number of these.)
6099 file-name)
6100 ;; Restrict the characters used in the file name to those which
6101 ;; are known to be safe on all filesystems, url-encoding the
6102 ;; rest.
6103 ;; We do this on all platforms, because even if we are not
6104 ;; running on DOS/Windows, the current directory may be on a
6105 ;; mounted VFAT filesystem, such as a USB memory stick.
6109 ;; For multibyte characters, this will produce more than
6110 ;; 2 hex digits, so is not true URL encoding.
6114 ;; Generate the file name.
6120 ;; Try a few alternative directories, to get one we can
6121 ;; write it.
6127 ;; Don't modify remote filenames
6129 ;; The call to convert-standard-filename is in case
6130 ;; buffer-name includes characters not allowed by the
6131 ;; DOS/Windows filesystems. make-temp-file writes to the
6132 ;; file it creates, so we must fix the file name _before_
6133 ;; make-temp-file is called.
6135 fname))
6137 ;; make-temp-file creates the file,
6138 ;; but we don't want it to exist until we do an auto-save.
6142 file-name)))
6145 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6146 FILENAME should lack slashes. You can redefine this for customization."
6148 \f
6150 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6151 The generated regexp will match a filename only if the filename
6152 matches that wildcard according to shell rules. Only wildcards known
6153 by `sh' are supported."
6155 ;; Copy the initial run of non-special characters.
6158 ;; If no special characters, we're almost done.
6162 j)
6164 result
6185 ;; Found "[^". Insert a `\0' character
6186 ;; (which cannot happen in a filename)
6187 ;; into the character class, so that `^'
6188 ;; is not the first character after `[',
6189 ;; and thus non-special in a regexp.
6194 ;; I don't think `]' can appear in a
6195 ;; character class in a wildcard, but
6196 ;; let's be general here.
6203 i
6216 ;; Shell wildcards should match the entire filename,
6217 ;; not its part. Make the regexp say so.
6219 \f
6222 "Switches for `list-directory' to pass to `ls' for brief listing."
6228 "Switches for `list-directory' to pass to `ls' for verbose listing."
6233 "Expand wildcard pattern PATTERN.
6234 This returns a list of file names which match the pattern.
6235 Files are sorted in `string<' order.
6237 If PATTERN is written as an absolute file name,
6238 the values are absolute also.
6240 If PATTERN is written as a relative file name, it is interpreted
6241 relative to the current default directory, `default-directory'.
6242 The file names returned are normally also relative to the current
6243 default directory. However, if FULL is non-nil, they are absolute."
6247 ;; A list of all dirs that DIRPART specifies.
6248 ;; This can be more than one dir
6249 ;; if DIRPART contains wildcards.
6255 contents)
6260 ;; Filter out "." and ".."
6265 name))
6272 this-dir-contents)
6273 this-dir-contents)
6274 contents)))))
6275 contents)))
6277 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6281 "Display a list of files in or matching DIRNAME, a la `ls'.
6282 DIRNAME is globbed by the shell if necessary.
6283 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6284 Actions controlled by variables `list-directory-brief-switches'
6285 and `list-directory-verbose-switches'."
6289 nil default-directory nil)
6290 pfx)))
6292 list-directory-brief-switches))
6293 buffer)
6305 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6313 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6315 PATTERN is assumed to represent a file-name wildcard suitable for the
6316 underlying filesystem. For Unix and GNU/Linux, each character from the
6318 the parts of the pattern which don't include wildcard characters are
6319 quoted with double quotes.
6322 on Windows), so PATTERN can use them to quote wildcard characters that
6323 need to be passed verbatim to shell commands."
6327 ;; DOS/Windows don't allow `"' in file names. So if the
6328 ;; argument has quotes, we can safely assume it is already
6329 ;; quoted by the caller.
6331 ;; We quote [&()#$`'] in case their shell is a port of a
6332 ;; Unixy shell. We quote [,=+] because stock DOS and
6333 ;; Windows shells require that in some cases, such as
6334 ;; passing arguments to batch files that use positional
6335 ;; arguments like %1.
6337 pattern
6340 end)
6357 pattern))))
6364 "Program to get the amount of free space on a file system.
6365 We assume the output has the format of `df'.
6366 The value of this variable must be just a command name or file name;
6367 if you want to specify options, use `directory-free-space-args'.
6369 A value of nil disables this feature.
6371 If the function `file-system-info' is defined, it is always used in
6372 preference to the program given by this variable."
6378 "Options to use when running `directory-free-space-program'."
6383 "Return the amount of free space on directory DIR's file system.
6384 The return value is a string describing the amount of free
6385 space (normally, the number of free 1KB blocks).
6387 This function calls `file-system-info' if it is available, or
6388 invokes the program specified by `directory-free-space-program'
6389 and `directory-free-space-args'. If the system call or program
6390 is unsuccessful, or if DIR is a remote directory, this function
6391 returns nil."
6393 ;; Try to find the number of free blocks. Non-Posix systems don't
6394 ;; always have df, but might have an equivalent system call.
6403 ;; Avoid failure if the default directory does
6404 ;; not exist (Bug#2631, Bug#3911).
6408 nil t nil
6409 directory-free-space-args
6412 ;; Assume that the "available" column is before the
6413 ;; "capacity" column. Find the "%" and scan backward.
6417 "[[:space:]]+[^[:space:]]+%[^%]*$"
6424 ;; The following expression replaces `dired-move-to-filename-regexp'.
6428 ;; In some locales, month abbreviations are as short as 2 letters,
6429 ;; and they can be followed by ".".
6430 ;; In Breton, a month name can include a quote character.
6443 s "+"
6446 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6447 ;; omits the Kanji characters after month and day-of-month.
6448 ;; On Mac OS X 10.3, the date format in East Asian locales is
6449 ;; day-of-month digits followed by month digits.
6455 ;; The "[0-9]" below requires the previous column to end in a digit.
6456 ;; This avoids recognizing `1 may 1997' as a date in the line:
6457 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6459 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6461 ;; For non-iso date formats, we add the ".*" in order to find
6462 ;; the last possible match. This avoids recognizing
6463 ;; `jservice 10 1024' as a date in the line:
6464 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6466 ;; vc dired listings provide the state or blanks between file
6467 ;; permissions and date. The state is always surrounded by
6468 ;; parentheses:
6469 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6470 ;; This is not supported yet.
6475 "Regular expression to match up to the file name in a directory listing.
6476 The default value is designed to recognize dates and times
6481 ;; insert-directory
6482 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6483 ;; FULL-DIRECTORY-P is nil.
6484 ;; The single line of output must display FILE's name as it was
6485 ;; given, namely, an absolute path name.
6486 ;; - must insert exactly one line for each file if WILDCARD or
6487 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6488 ;; before the file lines, plus optional text after the file lines.
6489 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6490 ;; allowed.
6491 ;; File lines should display the basename.
6492 ;; - must be consistent with
6493 ;; - functions dired-move-to-filename, (these two define what a file line is)
6494 ;; dired-move-to-end-of-filename,
6495 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6496 ;; dired-insert-headerline
6497 ;; dired-after-subdir-garbage (defines what a "total" line is)
6498 ;; - variable dired-subdir-regexp
6499 ;; - may be passed "--dired" as the first argument in SWITCHES.
6500 ;; Filename handlers might have to remove this switch if their
6501 ;; "ls" command does not support it.
6503 "Insert directory listing for FILE, formatted according to SWITCHES.
6504 Leaves point after the inserted text.
6505 SWITCHES may be a string of options, or a list of strings
6506 representing individual options.
6507 Optional third arg WILDCARD means treat FILE as shell wildcard.
6508 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6509 switches do not contain `d', so that a full listing is expected.
6511 This works by running a directory listing program
6512 whose name is in the variable `insert-directory-program'.
6513 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6515 When SWITCHES contains the long `--dired' option, this function
6516 treats it specially, for the sake of dired. However, the
6517 normally equivalent short `-D' option is just passed on to
6518 `insert-directory-program', as any other option."
6519 ;; We need the directory in order to find the right handler.
6524 wildcard full-directory-p)
6527 ;; Read the actual directory using `insert-directory-program'.
6528 ;; RESULT gets the status code.
6530 ;; putting text property `dired-filename, decode one
6531 ;; bunch by one to preserve that property.
6533 ;; This is to control encoding the arguments in call-process.
6537 default-file-name-coding-system))))
6540 ;; Run ls in the directory part of the file pattern
6541 ;; using the last component as argument.
6547 ;; NB since switches is passed to the shell, be
6548 ;; careful of malicious values, eg "-l;reboot".
6549 ;; See eg dired-safe-switches-p.
6551 shell-file-name nil t nil
6552 "-c"
6554 ""
6556 insert-directory-program
6557 " -d "
6559 switches
6561 " -- "
6562 ;; Quote some characters that have
6563 ;; special meanings in shells; but
6564 ;; don't quote the wildcards--we want
6565 ;; them to be special. We also
6566 ;; currently don't quote the quoting
6567 ;; characters in case people want to
6568 ;; use them explicitly to quote
6569 ;; wildcard characters.
6571 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6572 ;; directory if FILE is a symbolic link.
6580 insert-directory-program nil t nil
6584 ;; Split the switches at any spaces so we can
6585 ;; pass separate options as separate args.
6587 ;; Avoid lossage if FILE starts with `-'.
6595 file))))))))
6597 ;; If we got "//DIRED//" in the output, it means we got a real
6598 ;; directory listing, even if `ls' returned nonzero.
6599 ;; So ignore any errors.
6612 ;; The first time ls returns an error,
6613 ;; find the version numbers of ls,
6614 ;; and set insert-directory-ls-version
6615 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6616 ;; is equal or if the info cannot be obtained.
6617 ;; (That can mean it isn't GNU ls.)
6627 comparison)
6643 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6647 ;; If `insert-directory-program' failed, signal an error.
6649 ;; Delete the error message it may have output.
6651 ;; On non-Posix systems, we cannot open a directory, so
6652 ;; don't even try, because that will always result in
6653 ;; the ubiquitous "Access denied". Instead, show the
6654 ;; command line so the user can try to guess what went wrong.
6659 insert-directory-program
6661 file result)
6662 ;; Unix. Access the file to get a suitable error.
6669 ;; The following overshoots by one line for an empty
6670 ;; directory listed with "--dired", but without "-a"
6671 ;; switch, where the ls output contains a
6672 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6673 ;; We take care of that case later.
6681 error-lines)
6682 ;; Find all the lines that are error messages,
6683 ;; and record the bounds of each one.
6690 ;; Now read the numeric positions of file names.
6697 error-lines))
6700 error-lines)))
6702 ;; End is followed by \n or by " -> ".
6704 ;; It seems that we can't trust ls's output as to
6705 ;; byte positions of filenames.
6711 ;; Take care of the case where the ls output contains a
6712 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6713 ;; and we went one line too far back (see above).
6718 ;; Now decode what read if necessary.
6720 file-name-coding-system
6721 default-file-name-coding-system
6723 coding-no-eol
6724 val pos)
6728 ;; If no coding system is specified or detection is
6729 ;; requested, detect the coding.
6743 ;; Force no eol conversion on a file name, so
6744 ;; that CR is preserved.
6752 ;; Try to insert the amount of free space.
6755 ;; First find the line to put it on.
6759 ;; Replace "total" with "used", to avoid confusion.
6765 "Convert `ls --dired' file name position value POS to a buffer position.
6766 File name position values returned in ls --dired output
6767 count only stdout; they don't count the error messages sent to stderr.
6768 So this function converts to them to real buffer positions.
6769 ERROR-LINES is a list of buffer positions of error message lines,
6770 of the form (START END)."
6774 pos)
6778 "Insert directory listing for FILE, formatted according to SWITCHES.
6780 Like `insert-directory', but if FILE does not exist, it inserts a
6781 message to that effect instead of signaling an error."
6784 ;; Simulate the message printed by `ls'.
6788 "Functions to call with no arguments to query about killing Emacs.
6789 If any of these functions returns nil, killing Emacs is canceled.
6790 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6791 the low level primitive, does not. See also `kill-emacs-hook'."
6797 "How to ask for confirmation when leaving Emacs.
6798 If nil, the default, don't ask at all. If the value is non-nil, it should
6799 be a predicate function; for example `yes-or-no-p'."
6808 "Non-nil if Emacs should confirm killing processes on exit.
6809 If this variable is nil, the value of
6810 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6811 processes with a non-nil `process-query-on-exit-flag', Emacs will
6812 prompt the user before killing them."
6818 "Offer to save each buffer, then kill this Emacs process.
6819 With prefix ARG, silently save all file-visiting buffers without asking.
6820 If there are active processes where `process-query-on-exit-flag'
6821 returns non-nil and `confirm-kill-processes' is non-nil,
6822 asks whether processes should be killed.
6823 Runs the members of `kill-emacs-query-functions' in turn and stops
6824 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6826 ;; Don't use save-some-buffers-default-predicate, because we want
6827 ;; to ask about all the buffers before killing Emacs.
6838 ;; process-list is not defined on MSDOS.
6841 active)
6859 ;; Query the user for other things, perhaps.
6866 "Offer to save each buffer, then kill the current connection.
6867 If the current frame has no client, kill Emacs itself using
6868 `save-buffers-kill-emacs'.
6870 With prefix ARG, silently save all file-visiting buffers, then kill.
6872 If emacsclient was started with a list of filenames to edit, then
6873 only these files will be asked to be saved."
6878 \f
6879 ;; We use /: as a prefix to "quote" a file name
6880 ;; so that magic file name handlers will not apply to it.
6884 file-name-handler-alist))
6886 ;; We depend on being the last handler on the list,
6887 ;; so that anything else which does need handling
6888 ;; has been handled already.
6889 ;; So it is safe for us to inhibit *all* magic file name handlers.
6898 default-directory))
6899 ;; Get a list of the indices of the args which are file names.
6902 ;; The first six are special because they
6903 ;; return a file name. We want to include the /:
6904 ;; in the return value.
6905 ;; So just avoid stripping it in the first place.
6912 ;; `identity' means just return the first arg
6913 ;; not stripped of its quoting.
6915 ;; `add' means add "/:" to the result.
6918 ;; `unquote-then-quote' means set buffer-file-name
6919 ;; temporarily to unquoted filename.
6921 ;; List the arguments which are filenames.
6929 ;; For all other operations, treat the first argument only
6930 ;; as the file name.
6932 method
6933 ;; Copy ARGUMENTS so we can replace elements in it.
6937 ;; Strip off the /: from the file names that have it.
6945 "/"
6951 (`insert-file-contents
6957 (`unquote-then-quote
6965 If NAME is a remote file name, check the local part of NAME."
6970 If NAME is a remote file name, the local part of NAME is quoted.
6971 If NAME is already a quoted file name, NAME is returned unchanged."
6973 name
6978 If NAME is a remote file name, the local part of NAME is unquoted."
6984 \f
6985 ;; Symbolic modes and read-file-modes.
6988 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6989 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6990 Others, or All) for whom to produce the mask.
6991 The bit-mask that is returned extracts from mode bits the access rights
6992 for the specified category of users."
7000 "Convert CHAR to a numeric value of mode bits.
7001 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7002 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7009 ;; Rights relative to the previous file modes.
7020 "Convert a symbolic mode string specification to an equivalent number.
7022 WHO-MASK is the bit-mask specifying the category of users to which to
7023 apply the access permissions. See `file-modes-char-to-who'.
7024 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7025 RIGHTS request to add, remove, or set permissions based on existing ones,
7032 char-right)
7039 num-rights
7043 op char-right)))
7044 num-rights))
7047 "Convert symbolic file modes to numeric file modes.
7048 MODES is the string to convert, it should match
7050 See Info node `(coreutils)File permissions' for more information on this
7051 notation.
7052 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7053 MODES request to add, remove, or set permissions based on existing ones,
7067 num-who num-modes)
7070 num-modes)))
7073 "Read file modes in octal or symbolic notation and return its numeric value.
7075 ORIG-FILE is the name of a file on whose mode bits to base returned
7076 permissions if what user types requests to add, remove, or set permissions
7092 nil nil default)))
7101 ;; Trashcan handling.
7103 "Directory for `move-file-to-trash' to move files and directories to.
7104 This directory is only used when the function `system-move-file-to-trash'
7105 is not defined.
7106 Relative paths are interpreted relative to `default-directory'.
7107 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7117 "Move the file (or directory) named FILENAME to the trash.
7118 When `delete-by-moving-to-trash' is non-nil, this function is
7119 called by `delete-file' and `delete-directory' instead of
7120 deleting files outright.
7122 If the function `system-move-file-to-trash' is defined, call it
7123 with FILENAME as an argument.
7124 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7125 directory.
7126 Otherwise, trash FILENAME using the freedesktop.org conventions,
7127 like the GNOME, KDE and XFCE desktop environments. Emacs only
7131 ;; If `trash-directory' is non-nil, move the file there.
7135 trash-dir)))
7136 ;; We can't trash a parent directory of trash-directory.
7139 trash-dir filename))
7142 ;; Ensure that the trashed file-name is unique.
7149 ;; If `system-move-file-to-trash' is defined, use it.
7152 ;; Otherwise, use the freedesktop.org method, as specified at
7153 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7164 ;; Check if we have permissions to delete.
7168 ;; The trashed file cannot be the trash dir or its parent.
7171 trash-files-dir filename))
7174 trash-info-dir filename))
7176 ;; Ensure that the trash directory exists; otherwise, create it.
7183 ;; Try to move to trash with .trashinfo undo information
7188 ;; Perform url-encoding on FN. For compatibility with
7189 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7190 ;; for path separators.
7195 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7196 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7209 fn))
7214 ;; Attempt to make .trashinfo file, trying up to 5
7215 ;; times. The .trashinfo file is opened with O_EXCL,
7216 ;; as per trash-spec 0.7, even if that can be a problem
7217 ;; on old NFS versions...
7221 trash-files-dir))
7223 success info-fn)
7228 trash-info-dir))
7236 ;; Uniquify new-fn. (Some file managers do not
7237 ;; like Emacs-style backup file names---e.g. bug
7238 ;; 170956 in Konqueror bug tracker.)
7243 ;; Finally, try to move the file to the trashcan.
7248 "The type field in ATTRIBUTES returned by `file-attributes'.
7249 The value is either t for directory, string (name linked to) for
7250 symbolic link, or nil."
7254 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7258 "The UID field in ATTRIBUTES returned by `file-attributes'.
7259 This is either a string or a number. If a string value cannot be
7260 looked up, a numeric value, either an integer or a float, is
7261 returned."
7265 "The GID field in ATTRIBUTES returned by `file-attributes'.
7266 This is either a string or a number. If a string value cannot be
7267 looked up, a numeric value, either an integer or a float, is
7268 returned."
7272 "The last access time in ATTRIBUTES returned by `file-attributes'.
7273 This a list of integers (HIGH LOW USEC PSEC) in the same style
7274 as (current-time)."
7278 "The modification time in ATTRIBUTES returned by `file-attributes'.
7279 This is the time of the last change to the file's contents, and
7280 is a list of integers (HIGH LOW USEC PSEC) in the same style
7281 as (current-time)."
7285 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7286 This is the time of last change to the file's attributes: owner
7287 and group, access mode bits, etc, and is a list of integers (HIGH
7288 LOW USEC PSEC) in the same style as (current-time)."
7292 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7293 This is a floating point number if the size is too large for an integer."
7297 "The file modes in ATTRIBUTES returned by `file-attributes'.
7298 This is a string of ten letters or dashes as in ls -l."
7302 "The inode number in ATTRIBUTES returned by `file-attributes'.
7303 If it is larger than what an Emacs integer can hold, this is of
7304 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7305 If even HIGH is too large for an Emacs integer, this is instead
7306 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7307 middle 24 bits, and finally the low 16 bits."
7311 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7312 If it is larger than what an Emacs integer can hold, this is of
7313 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7314 If even HIGH is too large for an Emacs integer, this is instead
7315 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7316 middle 24 bits, and finally the low 16 bits."
7320 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7321 ATTR-NAMES are symbols with the selected attribute names.
7323 Valid attribute names are: type, link-number, user-id, group-id,
7324 access-time, modification-time, status-change-time, size, modes,
7325 inode-number and device-number."
7327 modification-time status-change-time
7328 size modes inode-number device-number))
7329 result)
7335 attributes)
7336 result)
7339 \f
7364 ;;; files.el ends here