| blob | 4b67b02c386333f06e949cd740d18601650089c6 |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2018 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 <https://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 a match for FROM with TO when a directory name matches FROM. This
59 replacement is done when setting up the default directory of a
60 newly visited file buffer.
62 FROM is a regexp that is matched against directory names anchored at
66 FROM and TO should be equivalent names, which refer to the
67 same directory. TO should be an absolute directory name.
68 Do not use `~' in the TO strings.
70 Use this feature when you have directories which you normally refer to
71 via absolute symbolic links. Make TO the name of the link, and FROM
72 a regexp matching the name it is linked to."
81 "Non-nil means make a backup of a file the first time it is saved.
82 This can be done by renaming the file or by copying.
84 Renaming means that Emacs renames the existing file so that it is a
85 backup file, then writes the buffer into a new file. Any other names
86 that the old file had will now refer to the backup file. The new file
87 is owned by you and its group is defaulted.
89 Copying means that Emacs copies the existing file into the backup
90 file, then writes the buffer on top of the existing file. Any other
91 names that the old file had will now refer to the new (edited) file.
92 The file's owner and group are unchanged.
94 The choice of renaming or copying is controlled by the variables
95 `backup-by-copying', `backup-by-copying-when-linked',
96 `backup-by-copying-when-mismatch' and
97 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
101 ;; Do this so that local variables based on the file name
102 ;; are not overridden by the major mode.
104 "If non-nil, backups will be inhibited.
105 This variable is intended for use by making it local to a buffer,
110 "Non-nil means always use copying to create backup files.
111 See documentation of variable `make-backup-files'."
116 "Non-nil means use copying to create backups for files with multiple names.
117 This causes the alternate names to refer to the latest version as edited.
118 This variable is relevant only if `backup-by-copying' is nil."
123 "Non-nil means create backups by copying if this preserves owner or group.
124 Renaming may still be used (subject to control of other variables)
125 when it would not result in changing the owner or group of the file;
126 that is, for files which are owned by you and whose group matches
127 the default for a new file created there by you.
128 This variable is relevant only if `backup-by-copying' is nil."
135 "Non-nil means create backups by copying to preserve a privileged owner.
136 Renaming may still be used (subject to control of other variables)
137 when it would not result in changing the owner of the file or if the owner
138 has a user id greater than the value of this variable. This is useful
139 when low-numbered uid's are used for special system users (such as root)
140 that must maintain ownership of certain files.
141 This variable is relevant only if `backup-by-copying' and
142 `backup-by-copying-when-mismatch' are nil."
147 "Predicate that looks at a file name and decides whether to make backups.
151 "Non-nil in a buffer means always offer to save buffer on exit.
152 Do so even if the buffer is not visiting a file.
153 Automatically local in all buffers.
155 Set to the symbol `always' to offer to save buffer whenever
156 `save-some-buffers' is called."
165 "Non-nil means find a file under alternative names, in existing buffers.
166 This means if any existing buffer is visiting the file you want
167 under another name, you get the existing buffer instead of a new buffer."
172 "Non-nil means visiting a file uses its truename as the visited-file name.
173 That is, the buffer visiting the file has the truename as the
174 value of `buffer-file-name'. The truename of a file is found by
175 chasing all links both at the file level and at the levels of the
176 containing directories."
182 "Specify which files should be reverted without query.
183 The value is a list of regular expressions.
184 If the file name matches one of these regular expressions,
185 then `revert-buffer' reverts the file without querying
186 if the file has changed on disk and you have not edited the buffer."
191 "The device number and file number of the file visited in the current buffer.
192 The value is a list of the form (FILENUM DEVNUM).
193 This pair of numbers uniquely identifies the file.
207 "The directory for writing small temporary files.
208 If non-nil, this directory is used instead of `temporary-file-directory'
209 by programs that create small temporary files. This is for systems that
210 have fast storage with limited space, such as a RAM disk."
215 ;; The system null device. (Should reference NULL_DEVICE from C.)
242 "Non-nil means protect against I/O errors while saving files.
243 Some modes set this non-nil in particular buffers.
245 This feature works by writing the new contents into a temporary file
246 and then renaming the temporary file to replace the original.
247 In this way, any I/O error in writing leaves the original untouched,
248 and there is never any instant where the file is nonexistent.
250 Note that this feature forces backups to be made by copying.
251 Yet, at the same time, saving a precious file
252 breaks any hard links between it and other files.
254 This feature is advisory: for example, if the directory in which the
255 file is being saved is not writable, Emacs may ignore a non-nil value
256 of `file-precious-flag' and write directly into the file.
258 See also: `break-hardlink-on-save'."
263 "Whether to allow breaking hardlinks when saving files.
264 If non-nil, then when saving a file that exists under several
265 names \(i.e., has multiple hardlinks), break the hardlink
266 associated with `buffer-file-name' and write to a new file, so
267 that the other instances of the file are not affected by the
268 save.
270 If `buffer-file-name' refers to a symlink, do not break the symlink.
272 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
273 For example, if the directory in which a file is being saved is not
274 itself writable, then error instead of saving in some
275 hardlink-nonbreaking way.
277 See also `backup-by-copying' and `backup-by-copying-when-linked'."
283 "Control use of version numbers for backup files.
284 When t, make numeric backup versions unconditionally.
285 When nil, make them for files that have some already.
286 The value `never' means do not make them."
293 "Return whether X is safe as local value for `version-control'."
300 "When cleaning directory, number of versions to keep."
306 "If t, delete excess backup versions silently.
307 If nil, ask confirmation. Any other value prevents any trimming."
314 "Number of oldest versions to keep when a new numbered backup is made."
320 "Number of newest versions to keep when a new numbered backup is made.
321 Includes the new backup. Must be > 0"
327 "Whether to add a newline automatically at the end of the file.
329 A value of t means do this only when the file is about to be saved.
330 A value of `visit' means do this right after the file is visited.
331 A value of `visit-save' means do it at both of those times.
332 Any other non-nil value means ask user whether to add a newline, when saving.
333 A value of nil means don't add newlines.
335 Certain major modes set this locally to the value obtained
336 from `mode-require-final-newline'."
346 "Whether to add a newline at end of file, in certain major modes.
347 Those modes set `require-final-newline' to this value when you enable them.
348 They do so because they are often used for files that are supposed
349 to end in newlines, and the question is how to arrange that.
351 A value of t means do this only when the file is about to be saved.
352 A value of `visit' means do this right after the file is visited.
353 A value of `visit-save' means do it at both of those times.
354 Any other non-nil value means ask user whether to add a newline, when saving.
356 A value of nil means do not add newlines. That is a risky choice in this
357 variable since this value is used for modes for files that ought to have
358 final newlines. So if you set this to nil, you must explicitly check and
359 add a final newline, whenever you save a file that really needs one."
369 "Non-nil says by default do auto-saving of every file-visiting buffer."
375 ;; Don't put "\\2" inside expand-file-name, since it will be
376 ;; transformed to "/2" on DOS/Windows.
378 "Transforms to apply to buffer file name before making auto-save file name.
379 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
380 REGEXP is a regular expression to match against the file name.
381 If it matches, `replace-match' is used to replace the
382 matching part with REPLACEMENT.
383 If the optional element UNIQUIFY is non-nil, the auto-save file name is
384 constructed by taking the directory part of the replaced file-name,
385 concatenated with the buffer file name with all directory separators
386 changed to `!' to prevent clashes. This will not work
387 correctly if your filesystem truncates the resulting name.
389 All the transforms in the list are tried, in the order they are listed.
390 When one transform applies, its result is final;
391 no further transforms are tried.
393 The default value is set up to put the auto-save file into the
394 temporary directory (see the variable `temporary-file-directory') for
395 editing a remote file.
397 On MS-DOS filesystems without long names this variable is always
398 ignored."
408 "Interval in seconds for `auto-save-visited-mode'.
409 If `auto-save-visited-mode' is enabled, Emacs will save all
410 buffers visiting a file to the visited file after it has been
411 idle for `auto-save-visited-interval' seconds."
421 "Toggle automatic saving to file-visiting buffers on or off.
422 With a prefix argument ARG, enable regular saving of all buffers
423 visiting a file if ARG is positive, and disable it otherwise.
424 Unlike `auto-save-mode', this mode will auto-save buffer contents
425 to the visited files directly and will also run all save-related
426 hooks. See Info node `Saving' for details of the save process.
428 If called from Lisp, enable the mode if ARG is omitted or nil,
429 and toggle it if ARG is `toggle'."
431 :global t
436 auto-save-visited-interval :repeat
440 auto-save-visited-file-name)))))))
442 ;; The 'set' part is so we don't get a warning for using this variable
443 ;; above, while still catching code that _sets_ the variable to get
444 ;; the same effect as the new auto-save-visited-mode.
449 "Non-nil means save word abbrevs too when files are saved.
450 If `silently', don't ask the user before saving."
455 "Non-nil means allow `find-file' to visit directories.
456 To visit the directory, `find-file' runs `find-directory-functions'."
461 "List of functions to try in sequence to visit a directory.
462 Each function is called with the directory name as the sole argument
463 and should return either a buffer or nil."
467 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
469 "List of functions to try in sequence to get a file name at point.
470 Each function should return either nil or a file name found at the
471 location of point in the current buffer."
475 ;;;It is not useful to make this a local variable.
476 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
480 "List of functions to be called for `find-file' on nonexistent file.
481 These functions are called as soon as the error is detected.
482 Variable `buffer-file-name' is already set up.
485 ;;;It is not useful to make this a local variable.
486 ;;;(put 'find-file-hooks 'permanent-local t)
489 "List of functions to be called after a buffer is loaded from a file.
490 The buffer's local variables (if any) will have been processed before the
491 functions are called."
499 "List of functions to be called before saving a buffer to a file.
500 Only used by `save-buffer'.
501 If one of them returns non-nil, the file is considered already written
502 and the rest are not called.
503 These hooks are considered to pertain to the visited file.
504 So any buffer-local binding of this variable is discarded if you change
506 change the major mode.
508 This hook is not run if any of the functions in
509 `write-contents-functions' returns non-nil. Both hooks pertain
510 to how to save a buffer to file, for instance, choosing a suitable
511 coding system and setting mode bits. (See Info
512 node `(elisp)Saving Buffers'.) To perform various checks or
524 "List of functions to be called before writing out a buffer to a file.
526 Only used by `save-buffer'. If one of them returns non-nil, the
527 file is considered already written and the rest are not called
528 and neither are the functions in `write-file-functions'. This
529 hook can thus be used to create save behavior for buffers that
530 are not visiting a file at all.
532 This variable is meant to be used for hooks that pertain to the
533 buffer's contents, not to the particular visited file; thus,
534 `set-visited-file-name' does not clear this variable; but changing the
535 major mode does clear it.
537 For hooks that _do_ pertain to the particular visited file, use
538 `write-file-functions'. Both this variable and
539 `write-file-functions' relate to how a buffer is saved to file.
540 To perform various checks or updates before the buffer is saved,
545 "Control use of local variables in files you visit.
546 The value can be t, nil, :safe, :all, or something else.
548 A value of t means file local variables specifications are obeyed
549 if all the specified variable values are safe; if any values are
550 not safe, Emacs queries you, once, whether to set them all.
551 \(When you say yes to certain values, they are remembered as safe.)
553 :safe means set the safe variables, and ignore the rest.
554 :all means set all variables, whether safe or not.
555 (Don't set it permanently to :all.)
556 A value of nil means always ignore the file local variables.
558 Any other value means always query you once whether to set them all.
559 \(When you say yes to certain values, they are remembered as safe, but
562 This variable also controls use of major modes specified in
563 a -*- line.
566 always obeys file local variable specifications and the -*- line,
567 and ignores this variable."
568 :risky t
577 "Non-nil means enable use of directory-local variables.
578 Some modes may wish to set this to nil to prevent directory-local
581 ;; This is an odd variable IMO.
582 ;; You might wonder why it is needed, when we could just do:
583 ;; (set (make-local-variable 'enable-local-variables) nil)
584 ;; These two are not precisely the same.
585 ;; Setting this variable does not cause -*- mode settings to be
586 ;; ignored, whereas setting enable-local-variables does.
587 ;; Only three places in Emacs use this variable: tar and arc modes,
588 ;; and rmail. The first two don't need it. They already use
589 ;; inhibit-local-variables-regexps, which is probably enough, and
590 ;; could also just set enable-local-variables locally to nil.
591 ;; Them setting it has the side-effect that dir-locals cannot apply to
592 ;; eg tar files (?). FIXME Is this appropriate?
593 ;; AFAICS, rmail is the only thing that needs this, and the only
594 ;; reason it uses it is for BABYL files (which are obsolete).
595 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
596 ;; to respect, so that find-file on a BABYL file will switch to
597 ;; rmail-mode automatically (this is nice, but hardly essential,
598 ;; since most people are used to explicitly running a command to
599 ;; access their mail; M-x gnus etc). Rmail files may happen to
600 ;; contain Local Variables sections in messages, which Rmail wants to
601 ;; ignore. So AFAICS the only reason this variable exists is for a
602 ;; minor convenience feature for handling of an obsolete Rmail file format.
604 "Like `enable-local-variables', except for major mode in a -*- line.
605 The meaningful values are nil and non-nil. The default is non-nil.
606 It should be set in a buffer-local fashion.
608 Setting this to nil has the same effect as setting `enable-local-variables'
609 to nil, except that it does not ignore any mode: setting in a -*- line.
610 Unless this difference matters to you, you should set `enable-local-variables'
615 The value can be t, nil or something else.
616 A value of t means obey `eval' variables.
617 A value of nil means ignore them; anything else means query."
618 :risky t
625 "Non-nil means buffers visiting files read-only do so in view mode.
626 In fact, this means that all read-only buffers normally have
627 View mode enabled, including buffers that are read-only because
628 you visit a file you cannot alter, and buffers you make read-only
634 "History list of file names entered in the minibuffer.
636 Maximum length of the history list is determined by the value
640 "If non-nil, avoid messages when saving files.
641 Error-related messages will still be printed, but all other
644 \f
647 "Provides support for ange-ftp host name completion.
648 Runs the usual ange-ftp hook, but only for completion operations."
649 ;; Having this here avoids the need to load ange-ftp when it's not
650 ;; really in use.
656 inhibit-file-name-handlers)))
664 "Convert a standard file's name to something suitable for the OS.
665 This means to guarantee valid names and perhaps to canonicalize
666 certain patterns.
668 FILENAME should be an absolute file name since the conversion rules
669 sometimes vary depending on the position in the file name. E.g. c:/foo
670 is a valid DOS file name, but c:/bar/c:/foo is not.
672 This function's standard definition is trivial; it just returns
673 the argument. However, on Windows and DOS, replace invalid
674 characters. On DOS, make sure to obey the 8.3 limitations.
675 In the native Windows build, turn Cygwin names into native names.
677 See Info node `(elisp)Standard File Names' for more details."
682 ;; Replace invalid filename characters with !
686 name))
694 "Read directory name, prompting with PROMPT and completing in directory DIR.
695 Value is not expanded---you must call `expand-file-name' yourself.
696 Default name to DEFAULT-DIRNAME if user exits with the same
697 non-empty string that was inserted by this function.
698 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
699 or just DIR if INITIAL is nil.)
700 If the user exits with an empty minibuffer, this function returns
701 an empty string. (This can only happen if the user erased the
702 pre-inserted contents or if `insert-default-directory' is nil.)
703 Fourth arg MUSTMATCH non-nil means require existing directory's name.
704 Non-nil and non-t means also require confirmation after completion.
705 Fifth arg INITIAL specifies text to start with.
706 DIR should be an absolute directory name. It defaults to
707 the value of `default-directory'."
712 dir))
713 mustmatch initial
716 \f
718 "Show the current default directory.
719 With prefix argument INSERT, insert the current default directory
720 at point instead."
727 "Value of the CDPATH environment variable, as a list.
731 "Explode a search path into a list of directory names.
732 Directories are separated by `path-separator' (which is colon in
733 GNU and Unix systems). Substitute environment variables into the
734 resulting list of directory names. For an empty path element (i.e.,
735 a leading or trailing separator, or two adjacent separators), return
736 nil (meaning `default-directory') as the associated list element."
744 "Change current directory to given absolute file name DIR."
745 ;; Put the name into directory syntax now,
746 ;; because otherwise expand-file-name may give some bad results.
748 ;; We used to additionally call abbreviate-file-name here, for an
749 ;; unknown reason. Problem is that most buffers are setup
750 ;; without going through cd-absolute and don't call
751 ;; abbreviate-file-name on their default-directory, so the few that
752 ;; do end up using a superficially different directory.
764 "Make DIR become the current buffer's default directory.
765 If your environment includes a `CDPATH' variable, try each one of
766 that list of directories (separated by occurrences of
767 `path-separator') when resolving a relative directory name.
768 The path separator is colon in GNU and GNU-like systems."
771 ;; FIXME: There's a subtle bug in the completion below. Seems linked
772 ;; to a fundamental difficulty of implementing `predicate' correctly.
773 ;; The manifestation is that TAB may list non-directories in the case where
774 ;; those files also correspond to valid directories (if your cd-path is (A/
775 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
776 ;; will be listed as valid completions).
777 ;; This is because `a' (listed because of A/a) is indeed a valid choice
778 ;; (which will lead to the use of B/a).
783 cd-path nil))
792 default-directory default-directory
793 t))))
803 "Return list of all files under DIR that have file names matching REGEXP.
805 order, and files from each directory are sorted in alphabetical order.
806 Each file name appears in the returned list in its absolute form.
807 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
808 output directories whose names match REGEXP."
811 ;; When DIR is "/", remote file names like "/method:" could
812 ;; also be offered. We shall suppress them.
820 ;; Don't follow symlinks to other directories.
824 full-file regexp include-directories))))
835 "Load the Lisp file named FILE."
836 ;; This is a case where .elc and .so/.dll make a lot of sense.
840 completion-ignored-extensions))))
845 "Search for FILENAME through PATH.
846 If found, return the absolute file name of FILENAME; otherwise
847 return nil.
848 PATH should be a list of directories to look in, like the lists in
849 `exec-path' or `load-path'.
850 If SUFFIXES is non-nil, it should be a list of suffixes to append to
853 If non-nil, PREDICATE is used instead of `file-readable-p'.
855 This function will normally skip directories, so if you want it to find
856 directories, make sure the PREDICATE function returns `dir-ok' for them.
858 PREDICATE can also be an integer to pass to the `access' system call,
859 in which case file-name handlers are ignored. This usage is deprecated.
860 For compatibility, PREDICATE can also be one of the symbols
861 `executable', `readable', `writable', or `exists', or a list of
862 one or more of those symbols."
873 "Do completion for file names passed to `locate-file'."
876 ;; FIXME: maybe we should use completion-file-name-table instead,
877 ;; tho at least for `load', the arg is passed through
878 ;; substitute-in-file-name for historical reasons.
888 ;; If we have files like "foo.el" and "foo.elc", we could load one of
889 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
890 ;; preferred way. So if we list all 3, that gives a lot of redundant
891 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
892 ;; the user does want to pay attention to the extension. We try to
893 ;; diffuse this tension by stripping the suffix, except when the
894 ;; result is a single element (i.e. usually we only list "foo" unless
895 ;; it's the only remaining element in the list, in which case we do
896 ;; list "foo", "foo.elc" and "foo.el").
907 string-file dir))
912 ;; Switching from names to names+fullnames creates a non-monotonicity
913 ;; which can cause problems with things like partial-completion.
914 ;; To minimize the problem, filter out completion-regexp-list, so that
915 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
916 ;; from `names' which only matched `string' when they still had
917 ;; their suffix.
919 ;; Remove duplicates of the first element, so that we can easily check
920 ;; if `names' really only contains a single element.
923 ;; There's no more than one matching non-suffixed element, so expand
924 ;; the list by adding the suffixed elements as well.
927 string-dir names string-file pred action)))))
930 "Do completion for file names passed to `locate-file'.
931 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
935 string nil action))
939 "Regexp of directory names which stop the search in `locate-dominating-file'.
940 Any directory whose name matches this regexp will be treated like
941 a kind of root directory by `locate-dominating-file' which will stop its search
942 when it bumps into it.
943 The default regexp prevents fruitless and time-consuming attempts to find
944 special files in directories in which filenames are interpreted as hostnames,
948 "Starting at FILE, look up directory hierarchy for directory containing NAME.
949 FILE can be a file or a directory. If it's a file, its directory will
950 serve as the starting point for searching the hierarchy of directories.
951 Stop at the first parent directory containing a file NAME,
952 and return the directory. Return nil if not found.
953 Instead of a string, NAME can also be a predicate taking one argument
954 \(a directory) and returning a non-nil value if that directory is the one for
955 which we're looking. The predicate will be called with every file/directory
956 the function needs to examine, starting with FILE."
957 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
958 ;; `name' in /home or in /.
961 try)
976 "Non-nil means warn if cannot access `user-emacs-directory'.
977 Set this to nil at your own risk..."
983 "Return an absolute per-user Emacs-specific file name.
984 If NEW-NAME exists in `user-emacs-directory', return it.
985 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
986 Else return NEW-NAME in `user-emacs-directory', creating the
987 directory if it does not exist."
995 at-home
996 ;; Make sure `user-emacs-directory' exists,
997 ;; unless we're in batch mode or dumping Emacs.
999 purify-flag
1009 user-emacs-directory-warning
1011 ;; Only warn once per Emacs session.
1015 Unable to %s `user-emacs-directory' (%s).
1016 Any data that would normally be written there may be lost!
1017 If you never want to see this message again,
1018 customize the variable `user-emacs-directory-warning'."
1019 errtype user-emacs-directory)))))
1020 bestname))))
1024 "Search for COMMAND in `exec-path' and return the absolute file name.
1025 Return nil if COMMAND is not found anywhere in `exec-path'."
1026 ;; Use 1 rather than file-executable-p to better match the behavior of
1027 ;; call-process.
1031 "Load the Emacs Lisp library named LIBRARY.
1032 LIBRARY should be a string.
1033 This is an interface to the function `load'. LIBRARY is searched
1034 for in `load-path', both with and without `load-suffixes' (as
1035 well as `load-file-rep-suffixes').
1037 See Info node `(emacs)Lisp Libraries' for more details.
1038 See `load-file' for a different interface to `load'."
1043 load-path
1048 "Test whether FILE specifies a location on a remote system.
1049 A file is considered remote if accessing it is likely to
1050 be slower or less reliable than accessing local files.
1052 `file-remote-p' never opens a new remote connection. It can
1053 only reuse a connection that is already open.
1055 Return nil or a string identifying the remote connection
1056 \(ideally a prefix of FILE). Return nil if FILE is a relative
1057 file name.
1059 When IDENTIFICATION is nil, the returned string is a complete
1060 remote identifier: with components method, user, and host. The
1061 components are those present in FILE, with defaults filled in for
1062 any that are missing.
1064 IDENTIFICATION can specify which part of the identification to
1065 return. IDENTIFICATION can be the symbol `method', `user',
1066 `host', or `localname'. Any other value is handled like nil and
1067 means to return the complete identification. The string returned
1068 for IDENTIFICATION `localname' can differ depending on whether
1069 there is an existing connection.
1071 If CONNECTED is non-nil, return an identification only if FILE is
1072 located on a remote system and a connection is established to
1073 that remote system.
1075 Tip: You can use this expansion of remote identifier components
1076 to derive a new remote file name from an existing one. For
1082 same remote identifier as FILE but expanded; a name such as
1087 nil)))
1089 ;; Probably this entire variable should be obsolete now, in favor of
1090 ;; something Tramp-related (?). It is not used in many places.
1091 ;; It's not clear what the best file for this to be in is, but given
1092 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1093 ;; rather than autoloaded.
1095 ;; This used to try various hard-coded places for remsh, rsh, and
1096 ;; rcmd, trying to guess based on location whether "rsh" was
1097 ;; "restricted shell" or "remote shell", but I don't see the point
1098 ;; in this day and age. Almost everyone will use ssh, and have
1099 ;; whatever command they want to use in PATH.
1106 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1113 "Whether to use the remote file-name cache for read access.
1114 When nil, never expire cached values (caution)
1115 When t, never use the cache (safe, but may be slow)
1116 A number means use cached values for that amount of seconds since caching.
1118 The attributes of remote files are cached for better performance.
1119 If they are changed outside of Emacs's control, the cached values
1120 become invalid, and must be reread. If you are sure that nothing
1121 other than Emacs changes the files, you can set this variable to nil.
1123 If a remote file is checked regularly, it might be a good idea to
1124 let-bind this variable to a value less than the interval between
1125 consecutive checks. For example:
1127 (defun display-time-file-nonempty-p (file)
1128 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1129 (and (file-exists-p file)
1130 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1141 "Return the local name component of FILE.
1142 It returns a file name which can be used directly as argument of
1143 `process-file', `start-file-process', or `shell-command'."
1147 "Copy the file FILE into a temporary file on this machine.
1148 Returns the name of the local copy, or nil, if FILE is directly
1149 accessible."
1150 ;; This formerly had an optional BUFFER argument that wasn't used by
1151 ;; anything.
1155 nil)))
1158 "Return non-nil if FILE is an absolute name to the operating system.
1159 This is like `file-name-absolute-p', except that it returns nil for
1160 names beginning with `~'."
1165 "Splice DIRNAME to FILE like the operating system would.
1166 If FILE is relative, return DIRNAME concatenated to FILE.
1167 Otherwise return FILE, quoted as needed if DIRNAME and FILE have
1168 different handlers; although this quoting is dubious if DIRNAME
1169 is magic, it is not clear what would be better. This function
1170 differs from `expand-file-name' in that DIRNAME must be a
1171 directory name and leading `~' and `/:' are not special in FILE."
1173 file
1177 unquoted
1181 "Return the truename of FILENAME.
1182 If FILENAME is not absolute, first expands it against `default-directory'.
1183 The truename of a file name is found by chasing symbolic links
1184 both at the level of the file and at the level of the directories
1185 containing it, until no links are left at any level.
1188 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1189 ;; COUNTER can be a cons cell whose car is the count of how many
1190 ;; more links to chase before getting an error.
1191 ;; PREV-DIRS can be a cons cell whose car is an alist
1192 ;; of truenames we've just recently computed.
1206 ;; For speed, remove the ange-ftp completion handler from the list.
1207 ;; We know it's not needed here.
1208 ;; For even more speed, do this only on the outermost call.
1215 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1216 ;; case differences being ignored by the OS, and short "8.3 DOS"
1217 ;; name aliases existing for all files. (The short names are not
1218 ;; reported by directory-files, but can be used to refer to files.)
1219 ;; It seems appropriate for file-truename to resolve these issues in
1220 ;; the most natural way, which on Windows is to call the function
1221 ;; `w32-long-file-name' - this returns the exact name of a file as
1222 ;; it is stored on disk (expanding short name aliases with the full
1223 ;; name in the process).
1226 ;; If filename exists, use its long name. If it doesn't
1227 ;; exist, the recursion below on the directory of filename
1228 ;; will drill down until we find a directory that exists,
1229 ;; and use the long name of that, with the extra
1230 ;; non-existent path components concatenated.
1235 ;; If this file directly leads to a link, process that iteratively
1236 ;; so that we don't use lots of stack.
1242 ;; For file name that has a special handler, call handler.
1243 ;; This is so that ange-ftp can save time by doing a no-op.
1246 done t)
1248 target dirfile)
1249 ;; Get the truename of the directory.
1251 ;; If these are equal, we have the (or a) root directory.
1255 ;; If this is the same dir we last got the truename for,
1256 ;; save time--don't recalculate.
1266 done t)
1269 done t)
1270 ;; Put it back on the file name.
1272 ;; Is the file name the name of a link?
1275 ;; Yes => chase that link, then start all over
1276 ;; since the link may point to a directory name that uses links.
1277 ;; We can't safely use expand-file-name here
1278 ;; since target might look like foo/../bar where foo
1279 ;; is itself a link. Instead, we handle . and .. above.
1281 done nil)
1282 ;; No, we are done!
1284 filename))
1287 "Chase links in FILENAME until a name that is not a link.
1288 Unlike `file-truename', this does not check whether a parent
1289 directory name is a symbolic link.
1290 If the optional argument LIMIT is a number,
1291 it means chase no more than that many links and then stop."
1299 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1302 ;; Handle `..' by hand, since it needs to work in the
1303 ;; target of any directory symlink.
1304 ;; This code is not quite complete; it does not handle
1305 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1309 ;; Chase links in the default dir of the symlink.
1313 ;; Now find the parent of that dir.
1316 tem))
1318 newname))
1320 ;; A handy function to display file sizes in human-readable form.
1321 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1323 "Produce a string showing FILE-SIZE in human-readable form.
1325 Optional second argument FLAVOR controls the units and the display format:
1327 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1329 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1331 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1334 1024.0
1337 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1343 "%.1f%s%s"
1345 file-size
1347 "K"
1353 "^//[^/]+/"
1354 ;; regexp-opt.el is not dumped into emacs binary.
1355 ;;(concat
1356 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1358 "File systems which ought to be mounted."
1365 "The directory for writing temporary files.
1366 In case of a remote `default-directory', this is a directory for
1367 temporary files on that remote host. If such a directory does
1368 not exist, or `default-directory' ought to be located on a
1369 mounted file system (see `mounted-file-systems'), the function
1370 returns `default-directory'.
1371 For a non-remote and non-mounted `default-directory', the value of
1372 the variable `temporary-file-directory' is returned."
1378 default-directory
1379 temporary-file-directory))))
1382 "Create a temporary file.
1383 The returned file name (created by appending some random characters at the end
1384 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1385 is guaranteed to point to a newly created file.
1386 You can then use `write-region' to write new data into the file.
1388 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1390 If SUFFIX is non-nil, add that at the end of the file name.
1392 If TEXT is a string, insert it into the new file; DIR-FLAG should be nil.
1393 Otherwise the file will be empty."
1405 "Implement (make-temp-file ABSOLUTE-PREFIX DIR-FLAG SUFFIX TEXT).
1406 This implementation works on magic file names."
1407 ;; Create temp files with strict access rights. It's easy to
1408 ;; loosen them later, whereas it's impossible to close the
1409 ;; time-window of loose permissions otherwise.
1412 file)
1421 nil)
1423 ;; the file was somehow created by someone else between
1424 ;; `make-temp-name' and `write-region', let's try again.
1425 nil)
1426 file)))
1429 "Create a temporary file as close as possible to `default-directory'.
1430 If PREFIX is a relative file name, and `default-directory' is a
1431 remote file name or located on a mounted file systems, the
1432 temporary file is created in the directory returned by the
1433 function `temporary-file-directory'. Otherwise, the function
1434 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1435 same meaning as in `make-temp-file'."
1444 "Change the encoding of FILE's name from CODING to NEW-CODING.
1445 The value is a new name of FILE.
1446 Signals a `file-already-exists' error if a file of the new name
1447 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1448 is non-nil. A number as fourth arg means request confirmation if
1449 the new name already exists. This is what happens in interactive
1450 use with M-x."
1453 default-file-name-coding-system))
1455 from-coding to-coding)
1457 ;; We provide the default coding only when it seems that
1458 ;; the filename is correctly decoded by the default
1459 ;; coding.
1465 filename default-coding)
1466 default-coding))
1470 ;; We provide the default coding only when a user is going to
1471 ;; change the encoding not from the default coding.
1475 filename from-coding)))
1478 filename from-coding default-coding)
1479 default-coding)))
1483 default-file-name-coding-system))
1484 ;; FILE should have been decoded by DEFAULT-CODING.
1488 ;; Suppress further encoding.
1493 newname))
1494 \f
1496 "Whether confirmation is requested before visiting a new file or buffer.
1497 If nil, confirmation is not requested.
1498 If the value is `after-completion', confirmation is only
1499 requested if the user called `minibuffer-complete' right before
1500 `minibuffer-complete-and-exit'.
1501 Any other non-nil value means to request confirmation.
1503 This affects commands like `switch-to-buffer' and `find-file'."
1511 "Whether to request confirmation before visiting a new file or buffer.
1512 The variable `confirm-nonexistent-file-or-buffer' determines the
1513 return value, which may be passed as the REQUIRE-MATCH arg to
1514 `read-buffer' or `find-file-read-args'."
1522 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1524 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1525 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1526 instead of prepending it.
1528 BODY should use the minibuffer at most once.
1529 Recursive uses of the minibuffer are unaffected (FUN is not
1530 called additional times).
1532 This macro actually adds an auxiliary function that calls FUN,
1533 rather than FUN itself, to `minibuffer-setup-hook'."
1544 ;; Clear out this hook so it does not interfere
1545 ;; with any recursive minibuffer usage.
1556 t))
1559 "Edit file FILENAME.
1560 Switch to a buffer visiting file FILENAME,
1561 creating one if none already exists.
1562 Interactively, the default if you just type RET is the current directory,
1563 but the visited file name is available through the minibuffer history:
1567 the file name, the result is affected by `file-name-at-point-functions',
1568 which by default try to guess the file name by looking at point in the
1569 current buffer. Customize the value of `file-name-at-point-functions'
1570 or set it to nil, if you want only the visited file name and the
1572 request.
1574 You can visit files on remote machines by specifying something
1575 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1576 also visit local files as a different user by specifying
1577 /sudo::FILE for the file name.
1578 See the Info node `(tramp)File name Syntax' in the Tramp Info
1579 manual, for more about this.
1581 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1582 expand wildcards (if any) and visit multiple files. You can
1583 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1585 To visit a file without any kind of conversion and without
1596 "Edit file FILENAME, in another window.
1599 an existing one. See the function `display-buffer'.
1601 Interactively, the default if you just type RET is the current directory,
1602 but the visited file name is available through the minibuffer history:
1606 the file name, the result is affected by `file-name-at-point-functions',
1607 which by default try to guess the file name by looking at point in the
1608 current buffer. Customize the value of `file-name-at-point-functions'
1609 or set it to nil, if you want only the visited file name and the
1611 request.
1613 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1614 expand wildcards (if any) and visit multiple files."
1624 value)
1628 "Edit file FILENAME, in another frame.
1631 an existing one. See the function `display-buffer'.
1633 Interactively, the default if you just type RET is the current directory,
1634 but the visited file name is available through the minibuffer history:
1638 the file name, the result is affected by `file-name-at-point-functions',
1639 which by default try to guess the file name by looking at point in the
1640 current buffer. Customize the value of `file-name-at-point-functions'
1641 or set it to nil, if you want only the visited file name and the
1643 request.
1645 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1646 expand wildcards (if any) and visit multiple files."
1656 value)
1660 "Edit the existing file FILENAME.
1662 file names with wildcards."
1679 value))
1682 "Edit file FILENAME but don't allow changes.
1691 "Edit file FILENAME in another window but don't allow changes.
1700 "Edit file FILENAME in another frame but don't allow changes.
1709 "Find file FILENAME as a replacement for the file in the next window.
1710 This command does not select that window.
1714 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1715 expand wildcards (if any) and replace the file with multiple files."
1726 "Find alternate file: " file-dir nil
1728 t))))
1735 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1737 "Hook run when a buffer is killed.
1738 The buffer being killed is current while the hook is running.
1739 See `kill-buffer'.
1741 Note: Be careful with let-binding this hook considering it is
1745 "Find file FILENAME, select its buffer, kill previous buffer.
1746 If the current buffer now contains an empty file that you just visited
1747 \(presumably by mistake), use this command to visit the file you really want.
1751 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1752 expand wildcards (if any) and replace the file with multiple files.
1754 If the current buffer is an indirect buffer, or the base buffer
1755 for one or more indirect buffers, the other buffer(s) are not
1756 killed."
1765 "Find alternate file: " file-dir nil
1767 t)))
1781 ;; Run `kill-buffer-hook' here. It needs to happen before
1782 ;; variables like `buffer-file-name' etc are set to nil below,
1783 ;; because some of the hooks that could be invoked
1784 ;; (e.g., `save-place-to-alist') depend on those variables.
1785 ;;
1786 ;; Note that `kill-buffer-hook' is not what queries whether to
1787 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1788 ;; asks that itself. Thus, there's no need to temporarily do
1789 ;; `(set-buffer-modified-p nil)' before running this hook.
1791 ;; Okay, now we can end-of-life the old buffer.
1798 ;; This prevents us from finding the same buffer
1799 ;; if we specified the same file again.
1803 ;; Likewise for dired buffers.
1805 ;; Don't use `find-file' because it may end up using another window
1806 ;; in some corner cases, e.g. when the selected window is
1807 ;; softly-dedicated.
1811 ;; This executes if find-file gets an error
1812 ;; and does not really find anything.
1813 ;; We put things back as they were.
1814 ;; If find-file actually finds something, we kill obuf below.
1823 ;; We already ran these; don't run them again.
1826 \f
1827 ;; FIXME we really need to fold the uniquify stuff in here by default,
1828 ;; not using advice, and add it to the doc string.
1830 "Create a suitably named buffer for visiting FILENAME, and return it.
1831 FILENAME (sans directory) is used unchanged if that name is free;
1832 otherwise a string <2> or <3> or ... is appended to get an unused name.
1834 Emacs treats buffers whose names begin with a space as internal buffers.
1835 To avoid confusion when visiting a file whose name begins with a space,
1842 lastname))))
1845 "Create and return a buffer with a name based on NAME.
1846 Choose the buffer's name using `generate-new-buffer-name'."
1850 "Regexp to match the automounter prefix in a directory name."
1856 "Regexp matching the user's homedir at the beginning of file name.
1860 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1862 home directory is a root directory) and removes automounter prefixes
1863 \(see the variable `automount-dir-prefix').
1865 When this function is first called, it caches the user's home
1866 directory as a regexp in `abbreviated-home-dir', and reuses it
1867 afterwards (so long as the home directory does not change;
1868 if you want to permanently change your home directory after having
1869 started Emacs, set `abbreviated-home-dir' to nil so it will be recalculated)."
1870 ;; Get rid of the prefixes added by the automounter.
1877 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1879 ;; If any elt of directory-abbrev-alist matches this name,
1880 ;; abbreviate accordingly.
1886 ;; Compute and save the abbreviated homedir name.
1887 ;; We defer computing this until the first time it's needed, to
1888 ;; give time for directory-abbrev-alist to be set properly.
1889 ;; We include a slash at the end, to avoid spurious matches
1890 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1900 ;; Depending on whether default-directory does or
1901 ;; doesn't include non-ASCII characters, the value
1902 ;; of abbreviated-home-dir could be multibyte or
1903 ;; unibyte. In the latter case, we need to decode
1904 ;; it. Note that this function is called for the
1905 ;; first time (from startup.el) when
1906 ;; locale-coding-system is already set up.
1908 abbreviated-home-dir
1911 'utf-8
1912 locale-coding-system))))))
1914 ;; If FILENAME starts with the abbreviated homedir,
1915 ;; and ~ hasn't changed since abbreviated-home-dir was set,
1916 ;; make it start with `~' instead.
1917 ;; If ~ has changed, we ignore abbreviated-home-dir rather than
1918 ;; invalidating it, on the assumption that a change in HOME
1919 ;; is likely temporary (eg for testing).
1920 ;; FIXME Is it even worth caching abbreviated-home-dir?
1921 ;; Ref: https://debbugs.gnu.org/19657#20
1923 ;; If the home dir is just /, don't change it.
1926 ;; MS-DOS root directories can come with a drive letter;
1927 ;; Novell Netware allows drive letters beyond `Z:'.
1937 filename)))
1940 "Return the buffer visiting file FILENAME (a string).
1941 This is like `get-file-buffer', except that it checks for any buffer
1942 visiting the same file, possibly under a different name.
1943 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1944 and others are ignored.
1945 If there is no such live buffer, return nil."
1958 found)
1968 ;; Verify this buffer's file number
1969 ;; still belongs to its file.
1972 attributes)
1976 found))))
1977 \f
1979 "Non-nil means file-visiting commands should handle wildcards.
1980 For example, if you specify `*.c', that would visit all the files
1981 whose names match the pattern."
1987 "Non-nil means suppress warning messages for symlinked files.
1988 When nil, Emacs prints a warning when visiting a file that is already
1989 visited, but with a different name. Setting this option to t
1990 suppresses this warning."
1996 "Maximum size of file above which a confirmation is requested.
1997 When nil, never request confirmation."
2004 "Warn if file size exceeds this percentage of available free memory.
2005 When nil, never issue warning. Beware: This probably doesn't do what you
2013 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
2014 OP-TYPE specifies the file operation being performed (for message to user)."
2023 "Warn if an attempt to open file of SIZE bytes may run out of memory."
2033 "You are trying to open a file whose size (%s)
2034 exceeds the %S%% of currently available free memory (%s).
2035 If that fails, try to open it with `find-file-literally'
2036 \(but note that some characters might be displayed incorrectly)."
2038 out-of-memory-warning-percentage
2042 "Like `message', except sometimes don't print to minibuffer.
2043 If the variable `save-silently' is non-nil, the message is not
2044 displayed on the minibuffer."
2049 "Read file FILENAME into a buffer and return the buffer.
2050 If a buffer exists visiting FILENAME, return that one, but
2051 verify that the file has not changed since visited or saved.
2052 The buffer is not selected, just returned to the caller.
2053 Optional second arg NOWARN non-nil means suppress any warning messages.
2054 Optional third arg RAWFILE non-nil means the file is read literally.
2055 Optional fourth arg WILDCARDS non-nil means do wildcard processing
2056 and visit all the matching files. When wildcards are actually
2057 used and expanded, return a list of buffers that are visiting
2058 the various files."
2065 'find-directory-functions
2068 filename)))
2071 find-file-wildcards
2085 ;; Find any buffer for a file which has same truename.
2087 ;; Let user know if there is a buffer with the same truename.
2091 find-file-suppress-same-file-warnings
2095 ;; Optionally also find that buffer.
2098 ;; Check to see if the file looks uncommonly large.
2103 ;; We are using an existing buffer.
2110 ;; Certain files should be reverted automatically
2111 ;; if they have changed on disk and not in the buffer.
2119 found))
2129 "File %s changed on disk. Discard your edits? "
2134 "File %s changed on disk. Discard your edits in %s? "
2142 ;; Check if a formerly read-only file has become
2143 ;; writable and vice versa, but if the buffer agrees
2144 ;; with the new state of the file, that is ok too.
2154 buffer-file-name
2155 new-status new-status)))
2161 nonexistent
2162 ;; It is confusing to ask whether to visit
2163 ;; non-literally if they have the file in
2164 ;; hexl-mode or image-mode.
2170 "The file %s is already visited normally,
2171 and you have edited the buffer. Now you have asked to visit it literally,
2172 meaning no coding system handling, format conversion, or local variables.
2173 Emacs can only visit a file in one way at a time.
2175 Do you want to save the file, and visit it literally instead? "
2176 "The file %s is already visited literally,
2177 meaning no coding system handling, format conversion, or local variables.
2178 You have edited the buffer. Now you have asked to visit the file normally,
2179 but Emacs can only visit a file in one way at a time.
2186 rawfile truename number))
2190 "\
2191 Do you want to discard your changes, and visit the file literally now? "
2192 "\
2195 rawfile truename number)
2201 "The file %s is already visited normally.
2202 You have asked to visit it literally,
2203 meaning no coding system decoding, format conversion, or local variables.
2204 But Emacs can only visit a file in one way at a time.
2206 Do you want to revisit the file literally now? "
2207 "The file %s is already visited literally,
2208 meaning no coding system decoding, format conversion, or local variables.
2209 You have asked to visit it normally,
2210 but Emacs can only visit a file in one way at a time.
2215 rawfile truename number)
2218 ;; Return the buffer we are using.
2219 buf)
2220 ;; Create a new buffer.
2222 ;; find-file-noselect-1 may use a different buffer.
2224 rawfile truename number))))))
2230 ;; Needed in case we are re-visiting the file with a different
2231 ;; text representation.
2247 filename)))
2248 ;; Unconditionally set error
2258 filename)))
2259 ;; Run find-file-not-found-functions until one returns non-nil.
2261 ;; If they fail too, set error.
2263 ;; Record the file's truename, and maybe use that as visited name.
2271 ;; Set buffer's default directory to that of the file.
2273 ;; Turn off backup files for certain file names. Since
2274 ;; this is a permanent local, the major mode won't eliminate it.
2288 \f
2290 "Like `insert-file-contents', but only reads in the file literally.
2291 See `insert-file-contents' for an explanation of the parameters.
2292 A buffer may be modified in several ways after reading into the buffer,
2293 due to Emacs features such as format decoding, character code
2294 conversion, `find-file-hook', automatic uncompression, etc.
2296 This function ensures that none of these modifications will take place."
2302 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2303 ;; into a file operation instead!
2305 inhibit-file-name-handlers))
2312 filename)))
2313 ;; Check whether the file is uncommonly large
2324 "Insert contents of file FILENAME into buffer after point with no conversion.
2326 This function is meant for the user to run interactively.
2327 Don't call it from programs! Use `insert-file-contents-literally' instead.
2328 \(Its calling sequence is different; see its documentation)."
2334 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2335 This has the `permanent-local' property, which takes effect if you
2340 "Visit file FILENAME with no conversion of any kind.
2341 Format conversion and character code conversion are both disabled,
2342 and multibyte characters are disabled in the resulting buffer.
2343 The major mode used is Fundamental mode regardless of the file name,
2344 and local variable specifications in the file are ignored.
2345 Automatic uncompression and adding a newline at the end of the
2346 file due to `require-final-newline' is also disabled.
2348 You cannot absolutely rely on this function to result in
2349 visiting the file literally. If Emacs already has a buffer
2350 which is visiting the file, you get the existing buffer,
2351 regardless of whether it was created literally or not.
2353 In a Lisp program, if you want to be sure of accessing a file's
2354 contents literally, you should create a temporary buffer and then read
2355 the file contents into it using `insert-file-contents-literally'."
2358 "Find file literally: " nil default-directory
2361 \f
2363 _after-find-file-from-revert-buffer
2364 nomodes)
2365 "Called after finding a file and by the default revert function.
2366 Sets buffer mode, parses local variables.
2367 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2368 error in reading the file. WARN non-nil means warn if there
2369 exists an auto-save file more recent than the visited file.
2370 NOAUTO means don't mess with auto-save mode.
2371 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2372 \(see `revert-buffer-in-progress-p' for similar functionality).
2373 Fifth arg NOMODES non-nil means don't alter the file's modes.
2374 Finishes by calling the functions in `find-file-hook'
2375 unless NOMODES is non-nil."
2378 nil
2388 "Symbolic link that points to nonexistent file"
2392 ;; No need to warn if buffer is auto-saved
2393 ;; under the name of the visited file.
2395 auto-save-visited-file-name))
2398 buffer-file-name))
2418 ;; Make people do a little extra work (C-x C-q)
2419 ;; before altering a backup file.
2422 ;; When a file is marked read-only,
2423 ;; make the buffer read-only even if root is looking at it.
2431 ;; If requested, add a newline at the end of the file.
2442 view-read-only
2450 "Choose the major mode for this buffer automatically.
2451 Also sets up any specified local variables of the file.
2452 Uses the visited file name, the -*- line, and the local variables spec.
2454 This function is called automatically from `find-file'. In that case,
2455 we may set up the file-specified mode and local variables,
2456 depending on the value of `enable-local-variables'.
2457 In addition, if `local-enable-local-variables' is nil, we do
2458 not set local variables (though we do notice a mode specified with -*-.)
2460 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2461 or from Lisp without specifying the optional argument FIND-FILE;
2462 in that case, this function acts as if `enable-local-variables' were t."
2469 ;; FIXME this is less efficient than it could be, since both
2470 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2473 ;; `delay-mode-hooks' being non-nil will have prevented the major
2474 ;; mode's call to `run-mode-hooks' from calling
2475 ;; `hack-local-variables'. In that case, call it now.
2479 ;; Turn font lock off and on, to make sure it takes account of
2480 ;; whatever file local variables are relevant to it.
2482 ;; Font-lock-mode (now in font-core.el) can be ON when
2483 ;; font-lock.el still hasn't been loaded.
2490 "Non-nil means to try second pass through `auto-mode-alist'.
2491 This means that if the first case-sensitive search through the alist fails
2492 to find a matching major mode, a second case-insensitive search is made.
2493 On systems with case-insensitive file names, this variable is ignored,
2494 since only a single case-insensitive search through the alist is made."
2500 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2501 ;; c++-mode, java-mode and more) are added through autoload
2502 ;; directives in that file. That way is discouraged since it
2503 ;; spreads out the definition of the initial value.
2549 ;; Less common extensions come here
2550 ;; so more common ones above are found faster.
2558 ;; Besides .gdbinit, gdb documents other names to be usable for init
2559 ;; files, cross-debuggers can use something like
2560 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2561 ;; don't interfere with each other.
2563 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2564 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2565 ;; loaded when GDB reads an objfile called 'emacs'.
2573 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2597 ;; The Fortran standard does not say anything about file extensions.
2598 ;; .f90 was widely used for F90, now we seem to be trapped into
2599 ;; using a different extension for each language revision.
2600 ;; Anyway, the following extensions are supported by gfortran.
2608 ;; The list of archive file extensions should be in sync with
2609 ;; `auto-coding-alist' with `no-conversion' coding system.
2615 ;; Mailer puts message to be edited in
2616 ;; /tmp/Re.... or Message
2619 ;; some news reader is reported to use this
2633 ;; .emacs or .gnus or .viper following a directory delimiter in
2634 ;; Unix or MS-DOS syntax.
2637 ;; _emacs following a directory delimiter in MS-DOS syntax
2641 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2642 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2643 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2646 ;; .xs is also used for ld scripts, but seems to be more commonly
2647 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2649 ;; Explained in binutils ld/genscripts.sh. Eg:
2650 ;; A .x script file is the default script.
2651 ;; A .xr script is for linking without relocation (-r flag). Etc.
2655 ;; Common Lisp ASDF package system.
2662 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2674 ;; Windows candidates may be opened case sensitively on Unix
2682 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2683 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2684 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2685 ;; this has lower priority to avoid matching changelog.sgml etc.
2687 ;; either user's dot-files or under /etc or some such
2689 ;; alas not all ~/.*rc files are like this
2690 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2695 ;; this contains everything twice, with space and with colon :-(
2697 ;; Get rid of any trailing .n.m and try again.
2698 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2699 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2700 ;; Using mode nil rather than `ignore' would let the search continue
2701 ;; through this list (with the shortened name) rather than start over.
2704 ;; This should come after "in" stripping (e.g. config.h.in).
2705 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2707 ;; The following should come after the ChangeLog pattern
2708 ;; for the sake of ChangeLog.1, etc.
2709 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2711 "Alist of filename patterns vs corresponding major mode functions.
2712 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2713 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2714 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2715 mode function to use. FUNCTION will be called, unless it is nil.
2717 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2718 calling FUNCTION (if it's not nil), we delete the suffix that matched
2719 REGEXP and search the list again for another match.
2721 The extensions whose FUNCTION is `archive-mode' should also
2722 appear in `auto-coding-alist' with `no-conversion' coding system.
2724 See also `interpreter-mode-alist', which detects executable script modes
2725 based on the interpreters they specify to run,
2730 "Select Conf mode or XML mode according to start of file."
2740 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2741 ;; and pike-mode) are added through autoload directives in that
2742 ;; file. That way is discouraged since it spreads out the
2743 ;; definition of the initial value.
2772 "Alist mapping interpreter names to major modes.
2773 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2774 Each element looks like (REGEXP . MODE).
2775 If REGEXP matches the entire name (minus any directory part) of
2776 the interpreter specified in the first line of a script, enable
2777 major mode MODE.
2784 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2785 ;; because we are duplicating info from auto-mode-alist.
2786 ;; TODO many elements of this list are also in auto-coding-alist.
2795 "List of regexps matching file names in which to ignore local variables.
2797 Files matching this list are typically binary file formats.
2798 They may happen to contain sequences that look like local variable
2799 specifications, but are not really, or they may be containers for
2800 member files with their own local variable sections, which are
2801 not appropriate for the containing file.
2808 "List of regexps matching suffixes to remove from file names.
2809 The function `inhibit-local-variables-p' uses this: when checking
2810 a file name, it first discards from the end of the name anything that
2813 ;; Can't think of any situation in which you'd want this to be nil...
2818 "Return non-nil if file local variables should be ignored.
2819 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2820 and `inhibit-local-variables-suffixes'. If
2821 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2830 sufs)
2835 temp))
2840 "Regexp matching interpreters, for file mode determination.
2841 This regular expression is matched against the first line of a file
2842 to determine the file's mode in `set-auto-mode'. If it matches, the file
2843 is assumed to be interpreted by the interpreter matched by the second group
2844 of the regular expression. The mode is then determined as the mode
2848 "Alist of buffer beginnings vs. corresponding major mode functions.
2849 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2850 After visiting a file, if REGEXP matches the text at the beginning of the
2851 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2852 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2853 major mode.
2855 If FUNCTION is nil, then it is not called. (That is a way of saying
2863 ;; The < comes before the groups (but the first) to reduce backtracking.
2864 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2865 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2869 comment-re "*"
2872 . mhtml-mode)
2874 ;; These two must come after html, because they are more general:
2879 . sgml-mode)
2882 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2883 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2884 After visiting a file, if REGEXP matches the text at the beginning of the
2885 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2886 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2887 have not specified a mode for this file.
2893 "Upper limit on `magic-mode-alist' regexp matches.
2897 "Select major mode appropriate for current buffer.
2899 To find the right major mode, this function checks for a -*- mode tag
2900 checks for a `mode:' entry in the Local Variables section of the file,
2901 checks if it uses an interpreter listed in `interpreter-mode-alist',
2902 matches the buffer beginning against `magic-mode-alist',
2903 compares the filename against the entries in `auto-mode-alist',
2904 then matches the buffer beginning against `magic-fallback-mode-alist'.
2906 If `enable-local-variables' is nil, or if the file name matches
2907 `inhibit-local-variables-regexps', this function does not check
2908 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2909 is nil, then the only mode: tag that can be relevant is a -*- one.
2911 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2912 set the major mode only if that would change it. In other words
2913 we don't actually set it to the same mode the buffer already has."
2914 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2916 end done mode modes)
2917 ;; Once we drop the deprecated feature where mode: is also allowed to
2918 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2919 ;; remove this section and just let (hack-local-variables t) handle it.
2920 ;; Find a -*- mode tag.
2924 ;; Note by design local-enable-local-variables does not matter here.
2926 try-locals
2929 ;; Find all specifications for the `mode:' variable
2930 ;; and execute them left to right.
2942 modes)))
2943 ;; Simple -*-MODE-*- case.
2946 modes))))
2947 ;; If we found modes to use, invoke them now, outside the save-excursion.
2955 ;; continuing would call minor modes again, toggling them off
2957 ;; hack-local-variables checks local-enable-local-variables etc, but
2958 ;; we might as well be explicit here for the sake of clarity.
2960 enable-local-variables
2961 local-enable-local-variables
2962 try-locals
2969 ;; If we didn't, look for an interpreter specified in the first line.
2970 ;; As a special case, allow for things like "#!/bin/env perl", which
2971 ;; finds the interpreter anywhere in $PATH.
2977 ;; Map interpreter name to a mode, signaling we're done at the
2978 ;; same time.
2985 interpreter-mode-alist)
2987 ;; If we found an interpreter mode to use, invoke it now.
2989 ;; Next try matching the buffer beginning against magic-mode-alist.
2998 nil magic-mode-alist
3007 "Problem in magic-mode-alist with element %s"
3008 re))))))))
3010 ;; Next compare the filename against the entries in auto-mode-alist.
3016 buffer-file-name)))
3017 ;; Remove backup-suffixes from file name.
3019 ;; Remove remote file name identification.
3024 ;; Find first matching alist entry.
3027 ;; Filesystem is case-insensitive.
3031 ;; Filesystem is case-sensitive.
3033 ;; First match case-sensitively.
3037 ;; Fallback to case-insensitive match.
3051 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
3068 "Problem with magic-fallback-mode-alist element: %s"
3069 re))))))))
3074 ;; When `keep-mode-if-same' is set, we are working on behalf of
3075 ;; set-visited-file-name. In that case, if the major mode specified is the
3076 ;; same one we already have, don't actually reset it. We don't want to lose
3077 ;; minor modes such as Font Lock.
3079 "Apply MODE and return it.
3080 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
3081 any aliases and compared to current major mode. If they are the
3082 same, do nothing and return nil."
3088 mode)))
3091 "Regexp of lines to skip when looking for file-local settings.
3092 If the first line matches this regular expression, then the -*-...-*- file-
3096 "Find the -*- spec in the buffer.
3097 Call with point at the place to start searching from.
3098 If one is found, set point to the beginning and return the position
3099 of the end. Otherwise, return nil; may change point.
3100 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3101 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3102 have no effect."
3105 ;; Don't look for -*- if this file name matches any
3106 ;; of the regexps in inhibit-local-variables-regexps.
3109 ;; If the file begins with "#!" (exec
3110 ;; interpreter magic), look for mode frobs
3111 ;; in the first two lines. You cannot
3112 ;; necessarily put them in the first line
3113 ;; of such a file without screwing up the
3114 ;; interpreter invocation. The same holds
3115 ;; for '\" in man pages (preprocessor
3116 ;; magic for the `man' program).
3127 end))))
3128 \f
3129 ;;; Handling file local variables
3133 file-local-variables-alist dir-local-variables-alist)
3138 "Normal hook run after processing a file's local variables specs.
3139 Major modes can use this to examine user-specified local variables
3143 "List variable-value pairs that are considered safe.
3144 Each element is a cons cell (VAR . VAL), where VAR is a variable
3145 symbol and VAL is a value that is considered safe."
3146 :risky t
3151 ;; This should be here at least as long as Emacs supports write-file-hooks.
3156 "Expressions that are considered safe in an `eval:' local variable.
3157 Add expressions to this list if you want Emacs to evaluate them, when
3158 they appear in an `eval' local variable specification, without first
3159 asking you for confirmation."
3160 :risky t
3165 ;; Risky local variables:
3168 buffer-auto-save-file-name
3169 buffer-file-name
3170 buffer-file-truename
3171 buffer-undo-list
3172 debugger
3173 default-text-properties
3174 eval
3175 exec-directory
3176 exec-path
3177 file-name-handler-alist
3178 frame-title-format
3179 global-mode-string
3180 header-line-format
3181 icon-title-format
3182 inhibit-quit
3183 load-path
3184 max-lisp-eval-depth
3185 max-specpdl-size
3186 minor-mode-map-alist
3187 minor-mode-overriding-map-alist
3188 mode-line-format
3189 mode-name
3190 overriding-local-map
3191 overriding-terminal-local-map
3192 process-environment
3193 standard-input
3194 standard-output
3195 unread-command-events))
3197 ;; Safe local variables:
3198 ;;
3199 ;; For variables defined by major modes, the safety declarations can go into
3200 ;; the major mode's file, since that will be loaded before file variables are
3201 ;; processed.
3202 ;;
3203 ;; For variables defined by minor modes, put the safety declarations in the
3204 ;; file defining the minor mode after the defcustom/defvar using an autoload
3205 ;; cookie, e.g.:
3206 ;;
3207 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3208 ;;
3209 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3210 ;; minor mode file may not be loaded yet.
3211 ;;
3212 ;; For variables defined in the C source code the declaration should go here:
3234 "Alist of file-local variable settings in the current buffer.
3235 Each element in this list has the form (VAR . VALUE), where VAR
3236 is a file-local variable (a symbol) and VALUE is the value
3237 specified. The actual value in the buffer may differ from VALUE,
3243 "Alist of directory-local variable settings in the current buffer.
3244 Each element in this list has the form (VAR . VALUE), where VAR
3245 is a directory-local variable (a symbol) and VALUE is the value
3246 specified in .dir-locals.el. The actual value in the buffer
3247 may differ from VALUE, if it is changed by the major or minor modes,
3252 "Normal hook run before setting file-local variables.
3253 It is called after checking for unsafe/risky variables and
3254 setting `file-local-variables-alist', and before applying the
3255 variables stored in `file-local-variables-alist'. A hook
3256 function is allowed to change the contents of this alist.
3258 This hook is called only if there is at least one file-local
3262 "Get confirmation before setting up local variable values.
3263 ALL-VARS is the list of all variables to be set up.
3264 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3265 RISKY-VARS is the list of those that are marked as risky.
3266 If these settings come from directory-local variables, then
3267 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3274 unsafe-vars))
3276 ;; Set up the contents of the *Local Variables* buffer.
3284 ", and variables that are risky (**)."
3292 y -- to apply the local variables list.
3296 ! -- to apply the local variables list, and permanently mark these
3308 ;; Make strings with embedded whitespace easier to read.
3316 ;; Display the buffer and read a choice.
3324 ""
3327 char)
3346 "Return local variables specified in the -*- line.
3347 Usually returns an alist of elements (VAR . VAL), where VAR is a
3348 variable and VAL is the specified value. Ignores any
3349 specification for `coding:', and sometimes for `mode' (which
3350 should have already been handled by `set-auto-coding' and
3351 `set-auto-mode', respectively). Return nil if the -*- line is
3352 malformed.
3354 If HANDLE-MODE is nil, we return the alist of all the local
3355 variables in the line except `coding' as described above. If it
3356 is neither nil nor t, we do the same, except that any settings of
3357 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3358 all settings in the line except for `mode', which \(if present) we
3359 return as the symbol specifying the mode."
3364 result)
3366 nil)
3368 ;; Simple form: "-*- MODENAME -*-".
3372 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3373 ;; (last ";" is optional).
3374 ;; If HANDLE-MODE is t, just check for `mode'.
3375 ;; Otherwise, parse the -*- line into the RESULT alist.
3383 ;; There used to be a downcase here,
3384 ;; but the manual didn't say so,
3385 ;; and people want to set var names that aren't all lc.
3391 ;; It is traditional to ignore
3392 ;; case when checking for `mode' in set-auto-mode,
3393 ;; so we must do that here as well.
3394 ;; That is inconsistent, but we're stuck with it.
3395 ;; The same can be said for `coding' in set-auto-coding.
3409 ;; Downcase "Mode:".
3412 val)
3413 result)
3416 result))))))
3419 "Filter local variable settings, querying the user if necessary.
3420 VARIABLES is the alist of variable-value settings. This alist is
3421 filtered based on the values of `ignored-local-variables',
3422 `enable-local-eval', `enable-local-variables', and (if necessary)
3423 user interaction. The results are added to
3424 `file-local-variables-alist', without applying them.
3425 If these settings come from directory-local variables, then
3426 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3427 ;; Find those variables that we may want to save to
3428 ;; `safe-local-variable-values'.
3434 ;; Ignore any variable in `ignored-local-variables'.
3435 nil)
3436 ;; Obey `enable-local-eval'.
3440 ;; In case previously marked safe (bug#5636).
3442 ;; If not safe and e-l-v = :safe, ignore totally.
3446 safe
3448 ;; Ignore duplicates (except `mode') in the present list.
3450 ;; Accept known-safe variables.
3454 ;; The variable is either risky or unsafe:
3461 ;; Query, unless all vars are safe or user wants no querying.
3467 risky-vars dir-name))
3477 ;; TODO? Warn once per file rather than once per session?
3481 "Parse and put into effect this buffer's local variables spec.
3482 Uses `hack-local-variables-apply' to apply the variables.
3484 If HANDLE-MODE is nil, we apply all the specified local
3485 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3486 except that any settings of `mode' are ignored.
3489 is specified, and return the corresponding mode symbol, or nil.
3490 In this case, we try to ignore minor-modes, and only return a
3491 major-mode.
3493 If `enable-local-variables' or `local-enable-local-variables' is nil,
3494 this function does nothing. If `inhibit-local-variables-regexps'
3495 applies to the file in question, the file is not scanned for
3496 local variables, but directory-local variables may still be applied."
3497 ;; We don't let inhibit-local-variables-p influence the value of
3498 ;; enable-local-variables, because then it would affect dir-local
3499 ;; variables. We don't want to search eg tar files for file local
3500 ;; variable sections, but there is no reason dir-locals cannot apply
3501 ;; to them. The real meaning of inhibit-local-variables-p is "do
3502 ;; not scan this file for local variables".
3505 result)
3509 ;; Note this is a no-op if enable-local-variables is nil.
3511 ;; This entire function is basically a no-op if enable-local-variables
3512 ;; is nil. All it does is set file-local-variables-alist to nil.
3514 ;; This part used to ignore enable-local-variables when handle-mode
3515 ;; was t. That was inappropriate, eg consider the
3516 ;; (artificial) example of:
3517 ;; (setq local-enable-local-variables nil)
3518 ;; Open a file foo.txt that contains "mode: sh".
3519 ;; It correctly opens in text-mode.
3520 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3522 ;; If HANDLE-MODE is t, and the prop line specifies a
3523 ;; mode, then we're done, and have no need to scan further.
3525 handle-mode))
3527 ;; Look for "Local variables:" line in last page.
3535 ;; suffix is what comes after "local variables:" in its line.
3536 ;; prefix is what comes before "local variables:" in its line.
3549 endpos
3555 nil t))
3556 ;; This used to be an error, but really all it means is
3557 ;; that this may simply not be a local-variables section,
3558 ;; so just ignore it.
3568 ;; Discard the prefix.
3573 ;; Discard the suffix.
3582 ;; Find the variable name;
3590 val val2)
3593 ;; Read the variable value.
3600 ;; Specifying minor-modes via mode: is
3601 ;; deprecated, but try to reject them anyway.
3611 'files
3613 "%s: `lexical-binding' at end of file unreliable"
3615 ;; We are called from
3616 ;; 'with-temp-buffer', so we need
3617 ;; to use 'thisbuf's name in the
3618 ;; warning message.
3624 'eval
3628 ;; Now we've read all the local variables.
3629 ;; If HANDLE-MODE is t, return whether the mode was specified.
3631 ;; Otherwise, set the variables.
3636 "Apply the elements of `file-local-variables-alist'.
3637 If there are any elements, runs `before-hack-local-variables-hook',
3638 then calls `hack-one-local-variable' to apply the alist elements one by one.
3639 Finishes by running `hack-local-variables-hook', regardless of whether
3640 the alist is empty or not.
3642 Note that this function ignores a `mode' entry if it specifies the same
3643 major mode as the buffer already has."
3645 ;; Any 'evals must run in the Right sequence.
3654 "Non-nil if SYM is safe as a file-local variable with value VAL.
3655 It is safe if any of these conditions are met:
3657 * There is a matching entry (SYM . VAL) in the
3658 `safe-local-variable-values' user option.
3660 * The `safe-local-variable' property of SYM is a function that
3661 evaluates to a non-nil value with VAL as an argument."
3665 ;; If the function signals an error, that means it
3666 ;; can't assure us that the value is safe.
3670 "Non-nil if SYM could be dangerous as a file-local variable.
3671 It is dangerous if either of these conditions are met:
3673 * Its `risky-local-variable' property is non-nil.
3679 ;; If this is an alias, check the base name.
3699 "Return t if it is safe to eval EXP when it is found in a file."
3701 ;; Detect certain `put' expressions.
3708 lisp-indent-function
3709 scheme-indent-function))
3710 ;; Only allow safe values (not functions).
3715 ;; Only allow indirect form specs.
3716 ;; During bootstrapping, edebug-basic-spec might not be
3717 ;; defined yet.
3721 ;; Allow expressions that the user requested.
3723 ;; Certain functions can be allowed with safe arguments
3724 ;; or can specify verification functions to try.
3726 ;; Allow (minor)-modes calls with no arguments.
3727 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3736 ok))
3744 ok))))))))
3758 "Set local variable VAR with value VAL.
3759 If VAR is `mode', call `VAL-mode' as a function unless it's
3760 already the major mode."
3762 (`mode
3768 (`eval
3774 ;; Make sure the string has no text properties.
3775 ;; Some text properties can get evaluated in various ways,
3776 ;; so it is risky to put them on with a local variable list.
3780 \f
3781 ;;; Handling directory-local variables, aka project settings.
3787 "List of cached directory roots for directory-local variable classes.
3788 Each element in this list has the form (DIR CLASS MTIME).
3789 DIR is the name of the directory.
3790 CLASS is the name of a variable class (a symbol).
3791 MTIME is the recorded modification time of the directory-local
3792 variables file associated with this entry. This time is a list
3793 of integers (the same format as `file-attributes'), and is
3794 used to test whether the cache entry is still valid.
3795 Alternatively, MTIME can be nil, which means the entry is always
3799 "Return the variable list for CLASS."
3803 "Collect directory-local variables from MODE-VARIABLES.
3804 VARIABLES is the initial list of variables.
3805 Returns the new list."
3810 ;; If variables are specified more than once, only use the last. (Why?)
3811 ;; The pseudo-variables mode and eval are different (bug#3430).
3814 ;; Need a new cons in case we setcdr later.
3818 "Collect entries from CLASS-VARIABLES into VARIABLES.
3819 ROOT is the root directory of the project.
3820 Return the new variables list."
3822 ;; Handle non-file buffers, too.
3826 ;; FIXME: Why not use file-relative-name?
3833 ;; Don't include this in the previous condition, because we
3834 ;; want to filter all strings before the next condition.
3848 ;; TODO someone might want to extend this to allow
3849 ;; integer values for subdir, where N means
3850 ;; variables apply to this directory and N levels
3851 ;; below it (0 == nil).
3854 alist variables))))))))
3856 ;; The file's content might be invalid (e.g. have a merge conflict), but
3857 ;; that shouldn't prevent the user from opening the file.
3859 nil))))
3862 "Declare that the DIRECTORY root is an instance of CLASS.
3863 DIRECTORY is the name of a directory, a string.
3864 CLASS is the name of a project class, a symbol.
3865 MTIME is either the modification time of the directory-local
3866 variables file that defined this class, or nil.
3868 When a file beneath DIRECTORY is visited, the mode-specific
3869 variables from CLASS are applied to the buffer. The variables
3870 for a class are defined using `dir-locals-set-class-variables'."
3877 "Map the type CLASS to a list of variable settings.
3878 CLASS is the project class, a symbol. VARIABLES is a list
3879 that declares directory-local variables for the class.
3880 An element in VARIABLES is either of the form:
3881 (MAJOR-MODE . ALIST)
3882 or
3883 (DIRECTORY . LIST)
3885 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3886 whose elements are of the form (VARIABLE . VALUE).
3888 In the second form, DIRECTORY is a directory name (a string), and
3889 LIST is a list of the form accepted by the function.
3891 When a file is visited, the file's class is found. A directory
3892 may be assigned a class using `dir-locals-set-directory-class'.
3893 Then variables are set in the file's buffer according to the
3894 VARIABLES list of the class. The list is processed in order.
3896 * If the element is of the form (MAJOR-MODE . ALIST), and the
3897 buffer's major mode is derived from MAJOR-MODE (as determined
3898 by `derived-mode-p'), then all the variables in ALIST are
3899 applied. A MAJOR-MODE of nil may be used to match any buffer.
3900 `make-local-variable' is called for each variable before it is
3901 set.
3903 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3904 is an initial substring of the file's directory, then LIST is
3905 applied by recursively following these rules."
3909 "File that contains directory-local variables.
3910 It has to be constant to enforce uniform values across different
3911 environments and users.
3913 A second dir-locals file can be used by a user to specify their
3914 personal dir-local variables even if the current directory
3915 already has a `dir-locals-file' that is shared with other
3916 users (such as in a git repository). The name of this second
3918 `dir-locals-file'. With the default value of `dir-locals-file',
3925 "Return a list of all readable dir-locals files in DIRECTORY.
3926 The returned list is sorted by increasing priority. That is,
3927 values specified in the last file should take precedence over
3928 those in the first."
3932 dir-locals-file)
3933 directory))
3937 ;; The order here is important.
3944 out)))
3947 "Find the directory-local variables for FILE.
3948 This searches upward in the directory tree from FILE.
3949 It stops at the first directory that has been registered in
3950 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3951 If it finds an entry in the cache, it checks that it is valid.
3952 A cache entry with no modification time element (normally, one that
3953 has been assigned directly using `dir-locals-set-directory-class', not
3954 set from a file) is always valid.
3955 A cache entry based on a `dir-locals-file' is valid if the modification
3956 time stored in the cache matches the current file modification time.
3957 If not, the cache entry is cleared so that the file will be re-read.
3959 This function returns either:
3960 - nil (no directory local variables found),
3961 - the matching entry from `dir-locals-directory-cache' (a list),
3962 - or the full path to the directory (a string) containing at
3963 least one `dir-locals-file' in the case of no valid cache
3964 entry."
3968 dir-elt)
3969 ;; `locate-dominating-file' may have abbreviated the name.
3972 ;; Find the best cached value in `dir-locals-directory-cache'.
3983 ;; Found a potential cache entry. Check validity.
3984 ;; A cache entry with no MTIME is assumed to always be valid
3985 ;; (ie, set directly, not from a dir-locals file).
3986 ;; Note, we don't bother to check that there is a matching class
3987 ;; element in dir-locals-class-alist, since that's done by
3988 ;; dir-locals-set-directory-class.
3991 ;; The entry MTIME should match the most recent
3992 ;; MTIME among matching files.
4000 ;; This cache entry is OK.
4001 dir-elt
4002 ;; This cache entry is invalid; clear it.
4005 ;; Return the first existing dir-locals file. Might be the same
4006 ;; as dir-elt's, might not (eg latter might have been deleted).
4007 locals-dir)
4008 ;; No cache entry.
4009 locals-dir)))
4012 "Load all variables files in DIR and register a new class and instance.
4013 DIR is the absolute name of a directory which must contain at
4014 least one dir-local file (which is a file holding variables to
4015 apply).
4016 Return the new class name, which is a symbol named DIR."
4021 ;; If there was a problem, use the values we could get but
4022 ;; don't let the cache prevent future reads.
4035 variables
4041 class-name))
4047 "Non-nil means dir-local variables will be applied to remote files."
4055 "Read per-directory local variables for the current buffer.
4056 Store the directory-local variables in `dir-local-variables-alist'
4057 and `file-local-variables-alist', without applying them.
4059 This does nothing if either `enable-local-variables' or
4060 `enable-dir-local-variables' are nil."
4062 enable-dir-local-variables
4065 default-directory)))))
4066 ;; Find the variables file.
4096 "Apply directory-local variables to a non-file buffer.
4097 For non-file buffers, such as Dired buffers, directory-local
4098 variables are looked for in `default-directory' and its parent
4099 directories."
4103 \f
4106 However, the mode will not be changed if
4107 \(1) a local variables list or the `-*-' line specifies a major mode, or
4109 not suitable for ordinary files, or
4110 \(3) the new file name does not particularly specify any mode."
4115 "Change name of file visited in current buffer to FILENAME.
4116 This also renames the buffer to correspond to the new file.
4117 The next time the buffer is saved it will go in the newly specified file.
4118 FILENAME nil or an empty string means mark buffer as not visiting any file.
4119 Remember to delete the initial contents of the minibuffer
4120 if you wish to pass an empty string as the argument.
4122 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4123 confirmation in the case where another buffer is already visiting FILENAME.
4125 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4126 the old visited file has been renamed to the new name FILENAME."
4134 nil
4149 filename)))
4156 buffer-file-name filename)
4160 ;; If new-name == old-name, renaming would add a spurious <2>
4161 ;; and it's considered as a feature in rename-buffer.
4167 ;; Abbreviate the file names of the buffer.
4176 nil))
4177 ;; write-file-functions is normally used for things like ftp-find-file
4178 ;; that visit things that are not local files as if they were files.
4179 ;; Changing to visit an ordinary local file instead should flush the hook.
4184 ;; If buffer was read-only because of version control,
4185 ;; that reason is gone now, so make it writable.
4189 ;; Turn off backup files for certain file names.
4190 ;; Since this is a permanent local, the major mode won't eliminate it.
4192 backup-enable-predicate
4201 ;; If auto-save was not already on, turn it on if appropriate.
4204 ;; If auto save is on, start using a new name. We
4205 ;; deliberately don't rename or delete the old auto save
4206 ;; for the old visited file name. This is because
4207 ;; perhaps the user wants to save the new state and then
4208 ;; compare with the previous state from the auto save
4209 ;; file.
4211 ;; Rename the old auto save file if any.
4218 ;; Update the major mode, if the file name determines it.
4220 ;; Don't change the mode if it is special.
4223 ;; Don't change the mode if the local variable list specifies it.
4224 ;; The file name can influence whether the local variables apply.
4226 ;; h-l-v also checks it, but might as well be explicit.
4229 ;; TODO consider making normal-mode handle this case.
4237 "Write current buffer into file FILENAME.
4238 This makes the buffer visit that file, and marks it as not modified.
4240 If you specify just a directory name as FILENAME, that means to use
4241 the default file name but in that directory. You can also yank
4242 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4244 If the buffer is not already visiting a file, the default file name
4245 for the output file is the buffer name.
4247 If optional second arg CONFIRM is non-nil, this function
4248 asks for confirmation before overwriting an existing file.
4249 Interactively, confirmation is required unless you supply a prefix argument."
4250 ;; (interactive "FWrite file: ")
4254 nil nil nil nil)
4258 default-directory)
4259 nil nil))
4263 ;; If arg is a directory name,
4264 ;; use the default file name, but in that directory.
4271 ;; NS does its own confirm dialog.
4274 use-dialog-box))
4280 ;; Make buffer writable if file is writable.
4285 ;; It's likely that the VC status at the new location is different from
4286 ;; the one at the old location.
4288 \f
4290 "Return an alist of extended attributes of file FILENAME.
4292 Extended attributes are platform-specific metadata about the file,
4293 such as SELinux context, list of ACL entries, etc."
4298 "Set extended attributes of file FILENAME to ATTRIBUTES.
4300 ATTRIBUTES must be an alist of file attributes as returned by
4301 `file-extended-attributes'.
4302 Value is t if the function succeeds in setting the attributes."
4313 result))
4314 \f
4316 "Make a backup of the disk file visited by the current buffer, if appropriate.
4317 This is normally done before saving the buffer the first time.
4319 A backup may be done by renaming or by copying; see documentation of
4320 variable `make-backup-files'. If it's done by renaming, then the file is
4321 no longer accessible under its old name.
4323 The value is non-nil after a backup was made by renaming.
4324 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4325 MODES is the result of `file-modes' on the original
4326 file; this means that the caller, after saving the buffer, should change
4327 the modes of the new file to agree with the old modes.
4328 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4329 on the original file; this means that the caller, after saving
4330 the buffer, should change the extended attributes of the new file
4331 to agree with the old attributes.
4332 BACKUPNAME is the backup file name, which is the old file renamed."
4336 ;; If specified name is a symbolic link, chase it to the target.
4337 ;; This makes backups in the directory where the real file is.
4344 ;; If have old versions to maybe delete,
4345 ;; ask the user to confirm now, before doing anything.
4346 ;; But don't actually delete til later.
4352 real-file-name)))
4353 targets))
4358 backup-by-copying-when-privileged-mismatch)
4361 ;; Don't rename a suid or sgid file.
4370 real-file-name
4373 copy-when-priv-mismatch))))
4375 t)))))
4376 setmodes)
4379 ;; Actually make the backup file.
4382 modes extended-attributes)
4383 ;; rename-file should delete old backup.
4386 backupname)))
4388 ;; Now delete the old versions, if desired.
4392 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4396 backupname)
4399 modes extended-attributes)
4401 setmodes)))))))
4404 ;; Create temp files with strict access rights. It's easy to
4405 ;; loosen them later, whereas it's impossible to close the
4406 ;; time-window of loose permissions otherwise.
4409 ;; Try to overwrite old backup first.
4417 nil)
4419 ;; The file was somehow created by someone else between
4420 ;; `delete-file' and `copy-file', so let's try again.
4421 ;; rms says "I think there is also a possible race
4422 ;; condition for making backup files" (emacs-devel 20070821).
4423 nil)))
4424 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4433 ;; The last ~[[:digit]]+ matches relative versions in git,
4434 ;; e.g. `foo.js.~HEAD~1~'.
4435 "Regular expression matching the backup/version part of a file name.
4439 "Return file NAME sans backup versions or strings.
4440 This is a separate procedure so your site-init or startup file can
4441 redefine it.
4442 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4443 we do not remove backup version numbers, only true file version numbers.
4444 See also `file-name-version-regexp'."
4451 name))))))
4454 "Return t if deleting FILE and rewriting it would preserve the owner.
4455 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4456 the group would be preserved too."
4461 ;; Return t if the file doesn't exist, since it's true that no
4462 ;; information would be lost by an (attempted) delete and create.
4465 ;; Files created on Windows by Administrator (RID=500)
4466 ;; have the Administrators group (RID=544) recorded as
4467 ;; their owner. Rewriting them will still preserve the
4468 ;; owner.
4472 ;; On BSD-derived systems files always inherit the parent
4473 ;; directory's group, so skip the group-gid test.
4479 ;; On some systems, a file created in a setuid directory
4480 ;; inherits that directory's owner.
4484 ;; On many systems, a file created in a setgid directory
4485 ;; inherits that directory's group. On some systems
4486 ;; this happens even if the setgid bit is not set.
4493 The extension, in a file name, is the part that begins with the last `.',
4494 except that a leading `.' of the file name, if there is one, doesn't count."
4497 directory)
4501 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4502 ;; we don't want to expand it.
4505 filename))))
4509 The extension, in a file name, is the part that begins with the last `.',
4510 excluding version numbers and backup suffixes, except that a leading `.'
4511 of the file name, if there is one, doesn't count.
4512 Return nil for extensionless file names such as `foo'.
4513 Return the empty string for file names such as `foo.'.
4515 By default, the returned value excludes the period that starts the
4516 extension, but if the optional argument PERIOD is non-nil, the period
4517 is included in the value, and in that case, if FILENAME has no
4528 "Return the base name of the FILENAME: no directory, no extension."
4534 #'make-backup-file-name--default-function
4535 "A function that `make-backup-file-name' uses to create backup file names.
4536 The function receives a single argument, the original file name.
4538 If you change this, you may need to change `backup-file-name-p' and
4539 `file-name-sans-versions' too.
4541 You could make this buffer-local to do something special for specific files.
4543 For historical reasons, a value of nil means to use the default function.
4544 This should not be relied upon.
4546 See also `backup-directory-alist'."
4553 "Alist of filename patterns and backup directory names.
4554 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4555 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4556 relative or absolute. If it is absolute, so that all matching files
4557 are backed up into the same directory, the file names in this
4558 directory will be the full name of the file backed up with all
4559 directory separators changed to `!' to prevent clashes. This will not
4560 work correctly if your filesystem truncates the resulting name.
4562 For the common case of all backups going into one directory, the alist
4564 directory name.
4566 If this variable is nil, or it fails to match a filename, the backup
4567 is made in the original file's directory.
4569 On MS-DOS filesystems without long names this variable is always
4570 ignored."
4576 "Default `backup-enable-predicate' function.
4577 Checks for files in `temporary-file-directory',
4580 caseless)
4581 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4582 ;; their long file-name equivalents, so compare-strings does TRT.
4586 caseless t))
4589 ;; Directory is under temporary-file-directory.
4594 ;; Directory is under /tmp.
4599 0 nil
4601 ;; Directory is under small-temporary-file-directory.
4606 "Create the non-numeric backup file name for FILE.
4607 This calls the function that `make-backup-file-name-function' specifies,
4608 with a single argument FILE."
4611 file))
4614 "Default function for `make-backup-file-name'.
4615 Normally this just returns FILE's name with `~' appended.
4616 It searches for a match for FILE in `backup-directory-alist'.
4617 If the directory for the backup doesn't exist, it is created."
4629 "Subroutine of `make-backup-file-name--default-function'.
4630 The function `find-backup-file-name' also uses this."
4632 elt backup-directory abs-backup-directory)
4637 alist nil)))
4638 ;; If backup-directory is relative, it should be relative to the
4639 ;; file's directory. By expanding explicitly here, we avoid
4640 ;; depending on default-directory.
4649 abs-backup-directory nil))))
4651 file
4655 ;; Normalize DOSish file names: downcase the drive
4656 ;; letter, if any, and replace the leading "x:" with
4657 ;; "/drive_x".
4662 ;; Remove the leading slash, if any, to prevent
4663 ;; convert-standard-filename from converting that to a
4664 ;; backslash.
4667 ;; Replace any invalid file-name characters, then
4668 ;; prepend the leading slash back.
4671 ;; Replace any invalid file-name characters.
4675 "drive_"
4678 ""
4681 ;; Make the name unique by substituting directory
4682 ;; separators. It may not really be worth bothering about
4683 ;; doubling `!'s in the original name...
4688 backup-directory))
4693 "Return non-nil if FILE is a backup file name (numeric or not).
4694 This is a separate function so you can redefine it for customization.
4695 You may need to redefine `file-name-sans-versions' as well."
4700 ;; This is used in various files.
4701 ;; The usage of backup-extract-version-start is not very clean,
4702 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4704 "Given the name of a numeric backup file, FN, return the backup number.
4705 Uses the free variable `backup-extract-version-start', whose value should be
4706 the index in the name where the version number begins."
4713 "Find a file name for a backup file FN, and suggestions for deletions.
4714 Value is a list whose car is the name for the backup file
4715 and whose cdr is a list of old versions to consider deleting now.
4716 If the value is nil, don't make a backup.
4717 Uses `backup-directory-alist' in the same way as
4718 `make-backup-file-name--default-function' does."
4720 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4724 ;; We don't support numbered backups on plain MS-DOS
4725 ;; when long file names are unavailable.
4735 possibilities deserve-versions-p versions)
4738 base-versions
4741 possibilities)
4742 #'<)
4747 kept-old-versions
4748 kept-new-versions
4755 ;; Delete nothing if there is overflow
4756 ;; in the number of versions to keep.
4762 v))))))))))
4765 "Return number of names file FILENAME has."
4769 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4770 This function returns a relative file name which is equivalent to FILENAME
4771 when used with that default directory as the default.
4772 If FILENAME is a relative file name, it will be interpreted as existing in
4773 `default-directory'.
4774 If FILENAME and DIRECTORY lie on different machines or on different drives
4775 on a DOS/Windows machine, it returns FILENAME in expanded form."
4779 default-directory))))
4784 read-file-name-completion-ignore-case)))
4787 ;; Test for different filesystems on DOS/Windows
4789 ;; Should `cygwin' really be included here? --stef
4792 ;; Test for different drive letters
4794 ;; Test for UNCs on different servers
4799 ;; Windows file names cannot have ? in
4800 ;; them, so use that to detect when
4801 ;; neither FILENAME nor DIRECTORY is a
4802 ;; UNC.
4804 0 nil
4810 ;; Test for different remote file system identification
4812 filename
4820 ".."
4822 ;; Now ancestor is empty, or .., or ../.., etc.
4824 ;; We matched within FILENAME's directory part.
4825 ;; Add the rest of FILENAME onto ANCESTOR.
4828 ;; But don't bother with ANCESTOR if it would give us `./'.
4829 rest
4831 ;; We matched FILENAME's directory equivalent.
4832 ancestor))))))
4833 \f
4835 "Save current buffer in visited file if modified.
4836 Variations are described below.
4838 By default, makes the previous version into a backup file
4839 if previously requested or if this is the first save.
4841 to become a backup when the next save is done.
4843 makes the previous version into a backup file.
4845 to become a backup when the next save is done,
4846 and makes the previous version into a backup file.
4848 With a numeric prefix argument of 0, never make the previous version
4849 into a backup file.
4851 Note that the various variables that control backups, such
4852 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4853 and `backup-inhibited', to name just the more popular ones, still
4854 control whether a backup will actually be produced, even when you
4857 If a file's name is FOO, the names of its numbered backup versions are
4858 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4859 Numeric backups (rather than FOO~) will be made if value of
4860 `version-control' is not the atom `never' and either there are already
4861 numeric versions of the file being backed up, or `version-control' is
4862 non-nil.
4863 We don't want excessive versions piling up, so there are variables
4864 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4865 and `kept-new-versions', which tells how many newest versions to keep.
4866 Defaults are 2 old versions and 2 new.
4867 `dired-kept-versions' controls dired's clean-directory (.) command.
4868 If `delete-old-versions' is nil, system will query user
4869 before trimming versions. Otherwise it does it silently.
4871 If `vc-make-backup-files' is nil, which is the default,
4872 no backup files are made for files managed by version control.
4873 (This is because the version control system itself records previous versions.)
4875 See the subroutine `basic-save-buffer' for more information."
4881 ;; We used to display the message below only for files > 50KB, but
4882 ;; then Rmail-mbox never displays it due to buffer swapping. If
4883 ;; the test is ever re-introduced, be sure to handle saving of
4884 ;; Rmail files.
4894 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4895 Normally delete only if the file was written by this Emacs since
4896 the last real save, but optional arg FORCE non-nil means delete anyway."
4910 "Normal hook that is run before a buffer is saved to its file.
4911 Only used by `save-buffer'."
4917 "Normal hook that is run after a buffer is saved to its file.
4918 Only used by `save-buffer'."
4924 "If non-nil, use this coding system for saving the buffer.
4925 More precisely, use this coding system in place of the
4926 value of `buffer-file-coding-system', when saving the buffer.
4927 Calling `write-region' for any purpose other than saving the buffer
4928 will still use `buffer-file-coding-system'; this variable has no effect
4935 "Save the current buffer in its visited file, if it has been modified.
4937 The hooks `write-contents-functions', `local-write-file-hooks'
4938 and `write-file-functions' get a chance to do the job of saving;
4939 if they do not, then the buffer is saved in the visited file in
4940 the usual way.
4942 Before and after saving the buffer, this function runs
4943 `before-save-hook' and `after-save-hook', respectively."
4946 ;; In an indirect buffer, save its base buffer instead.
4950 ;; Handle the case when no modification has been made but
4951 ;; the file disappeared since visited.
4955 setmodes)
4961 "%s has changed since visited or saved. Save anyway? "
4982 ;; Don't let errors prevent saving the buffer.
4984 ;; Give `write-contents-functions' a chance to
4985 ;; short-circuit the whole process.
4987 ;; If buffer has no file name, ask user for one.
4995 ;; Signal an error if the user specified the name of an
4996 ;; existing directory.
4999 "File `%s' exists; overwrite? "
5000 filename))
5003 ;; Support VC version backups.
5007 ;; If a hook returned t, file is already "written".
5008 ;; Otherwise, write it the usual way now.
5018 ;; Now we have saved the current buffer. Let's make sure
5019 ;; that buffer-file-coding-system is fixed to what
5020 ;; actually used for saving by binding it locally.
5036 ;; Support VC `implicit' locking.
5038 ;; If the auto-save file was recent before this command,
5039 ;; delete it now.
5046 ;; This does the "real job" of writing a buffer into its visited file
5047 ;; and making a backup file. This is what is normally done
5048 ;; but inhibited if one of write-file-functions returns non-nil.
5049 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5050 ;; backup-buffer.
5060 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5061 ;; backup-buffer.
5074 "File %s is write-protected; try to save anyway? "
5076 buffer-file-name)))
5090 dir))))
5091 ;; Write temp name, then rename it.
5092 ;; This requires write access to the containing dir,
5093 ;; which is why we don't try it if we don't have that access.
5095 tempname
5097 ;; Create temp files with strict access rights. It's easy to
5098 ;; loosen them later, whereas it's impossible to close the
5099 ;; time-window of loose permissions otherwise.
5103 ;; Call write-region in the appropriate way
5104 ;; for saving the buffer.
5108 ;; Pass in nil&nil rather than point-min&max
5109 ;; cause we're saving the whole buffer.
5110 ;; write-region-annotate-functions may use it.
5112 buffer-file-truename)
5114 ;; If we failed, restore the buffer's modtime.
5117 ;; Since we have created an entirely new file,
5118 ;; make sure it gets the right permission bits set.
5123 buffer-file-name)))
5124 ;; We succeeded in writing the temp file,
5125 ;; so rename it.
5127 ;; If file not writable, see if we can make it writable
5128 ;; temporarily while we write it.
5129 ;; But no need to do so if we have just backed it up
5130 ;; (setmodes is set) because that says we're superseding.
5132 ;; Change the mode back, after writing.
5135 buffer-file-name))
5136 ;; If set-file-extended-attributes fails, fall back on
5137 ;; set-file-modes.
5147 ;; Pass in nil&nil rather than point-min&max to indicate
5148 ;; we're saving the buffer rather than just a region.
5149 ;; write-region-annotate-functions may make use of it.
5151 buffer-file-name nil t buffer-file-truename)
5154 ;; If we get an error writing the new file, and we made
5155 ;; the backup by renaming, undo the backing-up.
5160 setmodes))
5166 `((?\C-r
5173 ;; Return nil to ask about BUF again.
5174 nil)
5187 ;; Return nil to ask about BUF again.
5188 nil)
5198 "Default predicate for `save-some-buffers'.
5199 This allows you to stop `save-some-buffers' from asking
5200 about certain files that you'd usually rather not save."
5202 ;; FIXME nil should not be a valid option, let alone the default,
5203 ;; eg so that add-function can be used.
5208 "Save some modified file-visiting buffers. Asks user about each one.
5209 You can answer `y' to save, `n' not to save, `C-r' to look at the
5210 buffer in question with `view-buffer' before deciding or `d' to
5211 view the differences using `diff-buffer-with-file'.
5213 This command first saves any buffers where `buffer-save-without-query' is
5214 non-nil, without asking.
5216 Optional argument ARG (interactively, prefix argument) non-nil means save
5217 all with no questions.
5218 Optional second argument PRED determines which buffers are considered:
5219 If PRED is nil, all the file-visiting buffers are considered.
5220 If PRED is t, then certain non-file buffers will also be considered.
5221 If PRED is a zero-argument function, it indicates for each buffer whether
5222 to consider it or not when called with that buffer current.
5223 PRED defaults to the value of `save-some-buffers-default-predicate'.
5225 See `save-some-buffers-action-alist' if you want to
5226 change the additional actions you can take on files."
5232 files-done abbrevs-done)
5234 ;; First save any buffers that we're supposed to save unconditionally.
5235 ;; That way the following code won't ask about them.
5240 ;; Ask about those buffers that merit it,
5241 ;; and record the number thus saved.
5245 ;; Note that killing some buffers may kill others via
5246 ;; hooks (e.g. Rmail and its viewing buffer).
5258 t
5270 save-some-buffers-action-alist))
5271 ;; Maybe to save abbrevs, and record whether
5272 ;; we either saved them or asked to.
5279 ;; Don't keep bothering user if he says no.
5293 \f
5295 "Clear out records of last mod time of visited file.
5296 Next attempt to save will not complain of a discrepancy."
5300 "Mark current buffer as unmodified, not needing to be saved.
5303 It is not a good idea to use this function in Lisp programs, because it
5304 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5312 "Change whether this buffer is read-only."
5320 "Insert contents of file FILENAME into buffer after point.
5321 Set mark after the inserted text.
5323 This function is meant for the user to run interactively.
5324 Don't call it from programs! Use `insert-file-contents' instead.
5325 \(Its calling sequence is different; see its documentation)."
5331 "Append the contents of the region to the end of file FILENAME.
5332 When called from a function, expects three arguments,
5333 START, END and FILENAME. START and END are normally buffer positions
5334 specifying the part of the buffer to write.
5335 If START is nil, that means to use the entire buffer contents.
5336 If START is a string, then output that string to the file
5337 instead of any buffer contents; END is ignored.
5339 This does character code conversion and applies annotations
5340 like `write-region' does."
5346 "Return most recent backup file for FILENAME or nil if no backups exist."
5347 ;; `make-backup-file-name' will get us the right directory for
5348 ;; ordinary or numeric backups. It might create a directory for
5349 ;; backups as a side-effect, according to `backup-directory-alist'.
5356 tem)
5365 newest))
5368 "Rename current buffer to a similar name not already taken.
5369 This function is useful for creating multiple shell process buffers
5370 or multiple mail buffers, etc.
5372 Note that some commands, in particular those based on `compilation-mode'
5373 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5374 appropriate mode even if it has been renamed. So as well as renaming
5375 the buffer, you also need to switch buffers before running another
5376 instance of such commands."
5384 ;; If the existing buffer name has a <NNN>,
5385 ;; which isn't part of the file name (if any),
5386 ;; then get rid of that.
5392 "Make directory DIR if it is not already a directory. Return nil."
5400 "Create the directory DIR and optionally any nonexistent parent dirs.
5401 If DIR already exists as a directory, signal an error, unless
5402 PARENTS is non-nil.
5404 Interactively, the default choice of directory to create is the
5405 current buffer's default directory. That is useful when you have
5406 visited a file in a nonexistent directory.
5408 Noninteractively, the second (optional) argument PARENTS, if
5409 non-nil, says whether to create parent directories that don't
5410 exist. Interactively, this happens by default.
5412 If creating the directory or directories fail, an error will be
5413 raised."
5416 nil nil)
5417 t))
5418 ;; If default-directory is a remote directory,
5419 ;; make sure we find its make-directory handler.
5427 create-list parent)
5434 ;; Do not loop if root does not exist (Bug#2309).
5437 dir parent))
5446 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5447 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5448 non-nil and if FN fails due to a missing file or directory."
5454 "Delete the directory named DIRECTORY. Does not follow symlinks.
5455 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5456 no error if something else is simultaneously deleting them.
5457 TRASH non-nil means to trash the directory instead, provided
5458 `delete-by-moving-to-trash' is non-nil.
5460 When called interactively, TRASH is nil if and only if a prefix
5461 argument is given, and a further prompt asks the user for
5462 RECURSIVE if DIRECTORY is nonempty."
5469 "Move directory to trash: "
5471 default-directory default-directory nil nil))))
5477 nil)
5479 ;; If default-directory is a remote directory, make sure we find its
5480 ;; delete-directory handler.
5487 ;; Only move non-empty dir to trash if recursive deletion was
5488 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5489 ;; case, where the operation fails in delete-directory-internal.
5490 ;; As `move-file-to-trash' trashes directories (empty or
5491 ;; otherwise) as a unit, we do not need to recurse here.
5493 ;; Check if directory is empty apart from "." and "..".
5498 ;; Otherwise, call ourselves recursively if needed.
5503 directory-files-no-dot-files-regexp))
5507 ;; This test is equivalent to but more efficient
5508 ;; than (and (file-directory-p fn)
5509 ;; (not (file-symlink-p fn))).
5513 files))
5514 directory-exists))
5518 "Return non-nil if files FILE1 and FILE2 name the same file.
5519 If FILE1 or FILE2 does not exist, the return value is unspecified."
5530 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5532 Return nil if DIR is not an existing directory."
5544 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5559 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5560 This function always sets the file modes of the output files to match
5561 the corresponding input file.
5563 The third arg KEEP-TIME non-nil means give the output files the same
5564 last-modified time as the old ones. (This works on only some systems.)
5566 A prefix arg makes KEEP-TIME non-nil.
5568 Noninteractively, the last argument PARENTS says whether to
5569 create parent directories if they don't exist. Interactively,
5570 this happens by default.
5572 If NEWNAME is a directory name, copy DIRECTORY as a subdirectory
5573 there. However, if called from Lisp with a non-nil optional
5574 argument COPY-CONTENTS, copy the contents of DIRECTORY directly
5575 into NEWNAME instead."
5582 default-directory default-directory nil nil)
5583 current-prefix-arg t nil)))
5586 directory newname))
5587 ;; If default-directory is a remote directory, make sure we find its
5588 ;; copy-directory handler.
5593 newname keep-time parents copy-contents)
5595 ;; Compute target name.
5600 ;; If NEWNAME is not a directory name, create it;
5601 ;; that is where we will copy the files of DIRECTORY.
5603 ;; NEWNAME is a directory name. If COPY-CONTENTS is non-nil,
5604 ;; create NEWNAME if it is not already a directory;
5605 ;; otherwise, create NEWNAME/[DIRECTORY-BASENAME].
5612 ;; Copy recursively.
5614 ;; We do not want to copy "." and "..".
5616 directory-files-no-dot-files-regexp))
5627 ;; Set directory attributes.
5633 \f
5634 ;; At time of writing, only info uses this.
5636 "Return a copy of DIRS with all non-existent directories removed.
5637 The optional argument KEEP is a list of directories to retain even if
5638 they don't exist, and REJECT is a list of directories to remove from
5639 DIRS, even if they exist; REJECT takes precedence over KEEP.
5641 Note that membership in REJECT and KEEP is checked using simple string
5642 comparison."
5648 dirs)))
5650 \f
5653 "Function to use to revert this buffer.
5654 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5655 which are the arguments that `revert-buffer' received.
5656 It also has access to the `preserve-modes' argument of `revert-buffer'
5657 via the `revert-buffer-preserve-modes' dynamic variable.
5659 For historical reasons, a value of nil means to use the default function.
5664 #'revert-buffer-insert-file-contents--default-function
5665 "Function to use to insert contents when reverting this buffer.
5666 The function receives two arguments: the first the nominal file name to use;
5667 the second is t if reading the auto-save file.
5669 The function is responsible for updating (or preserving) point.
5671 For historical reasons, a value of nil means to use the default function.
5675 "Default function to use for `buffer-stale-function'.
5676 This function ignores its argument.
5677 This returns non-nil if the current buffer is visiting a readable file
5678 whose modification time does not match that of the buffer.
5680 This function only handles buffers that are visiting files.
5681 Non-file buffers need a custom function"
5688 "Function to check whether a buffer needs reverting.
5689 This should be a function with one optional argument NOCONFIRM.
5690 Auto Revert Mode passes t for NOCONFIRM. The function should return
5691 non-nil if the buffer should be reverted. A return value of
5692 `fast' means that the need for reverting was not checked, but
5693 that reverting the buffer is fast. The buffer is current when
5694 this function is called.
5696 The idea behind the NOCONFIRM argument is that it should be
5697 non-nil if the buffer is going to be reverted without asking the
5698 user. In such situations, one has to be careful with potentially
5699 time consuming operations.
5701 For historical reasons, a value of nil means to use the default function.
5702 This should not be relied upon.
5704 For more information on how this variable is used by Auto Revert mode,
5708 "Normal hook for `revert-buffer' to run before reverting.
5709 The function `revert-buffer--default' runs this.
5713 "Normal hook for `revert-buffer' to run after reverting.
5714 Note that the hook value that it runs is the value that was in effect
5715 before reverting; that makes a difference if you have buffer-local
5716 hook functions.
5718 The function `revert-buffer--default' runs this.
5726 ;; `revert-buffer-function' was defined long ago to be a function of only
5727 ;; 2 arguments, so we have to use a dynbind variable to pass the
5728 ;; `preserve-modes' argument of `revert-buffer'.
5732 "Replace current buffer text with the text of the visited file on disk.
5733 This undoes all changes since the file was visited or saved.
5734 With a prefix argument, offer to revert from latest auto-save file, if
5735 that is more recent than the visited file.
5737 This command also implements an interface for special buffers
5738 that contain text which doesn't come from a file, but reflects
5739 some other data instead (e.g. Dired buffers, `buffer-list'
5740 buffers). This is done via the variable `revert-buffer-function'.
5741 In these cases, it should reconstruct the buffer contents from the
5742 appropriate data.
5744 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5745 to revert from the auto-save file when this is nil. Note that the
5746 sense of this argument is the reverse of the prefix argument, for the
5747 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5748 to nil.
5750 Optional second argument NOCONFIRM means don't ask for confirmation
5751 at all. (The variable `revert-without-query' offers another way to
5752 revert buffers without querying for confirmation.)
5754 Optional third argument PRESERVE-MODES non-nil means don't alter
5755 the files modes. Normally we reinitialize them using `normal-mode'.
5757 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5759 This function calls the function that `revert-buffer-function' specifies
5760 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5761 The default function runs the hooks `before-revert-hook' and
5762 `after-revert-hook'."
5763 ;; I admit it's odd to reverse the sense of the prefix argument, but
5764 ;; there is a lot of code out there which assumes that the first
5765 ;; argument should be t to avoid consulting the auto-save file, and
5766 ;; there's no straightforward way to encourage authors to notice a
5767 ;; reversal of the argument sense. So I'm just changing the user
5768 ;; interface, but leaving the programmatic interface the same.
5773 ignore-auto noconfirm)))
5776 "Default function for `revert-buffer'.
5777 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5778 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5779 start and end.
5781 Calls `revert-buffer-insert-file-contents-function' to reread the
5782 contents of the visited file, with two arguments: the first is the file
5783 name, the second is non-nil if reading an auto-save file.
5785 This function only handles buffers that are visiting files.
5786 Non-file buffers need a custom function."
5791 buffer-auto-save-file-name
5796 buffer-auto-save-file-name
5797 buffer-file-name)))
5807 file-name)))
5809 ;; If file was backed up but has changed since,
5810 ;; we should make another backup.
5814 ;; Effectively copy the after-revert-hook status,
5815 ;; since after-find-file will clobber it.
5818 after-revert-hook))
5820 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5824 file-name auto-save-p)
5825 ;; Recompute the truename in case changes in symlinks
5826 ;; have changed the truename.
5830 ;; Run after-revert-hook as it was before we reverted.
5834 local-hook)
5837 t)))))
5840 "Default function for `revert-buffer-insert-file-contents-function'.
5841 The function `revert-buffer--default' calls this.
5842 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5843 an auto-save file."
5847 "File %s no longer exists!"
5849 file-name))
5852 "File %s no longer readable!"
5854 file-name))
5856 ;; Bind buffer-file-name to nil
5857 ;; so that we don't try to lock the file.
5863 ;; Auto-saved file should be read by Emacs's
5864 ;; internal coding.
5868 buffer-file-coding-system-explicit
5871 coding-system-for-read
5873 coding-system-for-read)
5875 ;; As a coding system suitable for multibyte
5876 ;; buffer is specified, make the current
5877 ;; buffer multibyte.
5880 ;; This force after-insert-file-set-coding
5881 ;; (called from insert-file-contents) to set
5882 ;; buffer-file-coding-system to a proper value.
5885 ;; Note that this preserves point in an intelligent way.
5889 nil nil t))
5891 nil nil t))))))
5894 "Recover the visited file--get contents from its last auto-save file."
5901 "Visit file FILE, but get contents from its last auto-save file."
5902 ;; Actually putting the file name in the minibuffer should be used
5903 ;; only rarely.
5904 ;; Not just because users often use the default.
5921 "*Directory*" nil
5932 ;; Use insert-directory-safely, not insert-directory,
5933 ;; because these files might not exist. In particular,
5934 ;; FILE might not exist if the auto-save file was for
5935 ;; a buffer that didn't visit a file, such as "*mail*".
5936 ;; The code in v20.x called `ls' directly, so we need
5937 ;; to emulate what `ls' did in that case.
5942 ;; Keep the current buffer-file-coding-system.
5944 ;; Auto-saved file should be read with special coding.
5953 "Recover auto save files from a previous Emacs session.
5954 This command first displays a Dired buffer showing you the
5955 previous sessions that you could recover from.
5956 To choose one, move point to the proper line and then type C-c C-c.
5957 Then you'll be asked about a number of files to recover."
5967 directory-files-no-dot-files-regexp
5969 t)
5980 ;; Each line starts with a space
5981 ;; so that Font Lock mode won't highlight the first character.
5984 " To delete a session file, type \
5990 "Choose one saved session to recover auto-save files from.
5991 This command is used in the special Dired buffer created by
5994 ;; Get the name of the session file to recover from.
5996 files
6002 ;; Read in the auto-save-list file.
6005 ;; Loop thru the text of that file
6006 ;; and get out the names of the files to recover.
6010 ;; This is a pair of lines for a non-file-visiting buffer.
6011 ;; Get the auto-save file name and manufacture
6012 ;; a "visited file name" from that.
6015 ;; If there is no auto-save file name, the
6016 ;; auto-save-list file is probably corrupted.
6029 ;; This pair of lines is a file-visiting
6030 ;; buffer. Use the visited file name.
6040 ;; Ignore a file if its auto-save file does not exist now.
6044 ;; The file contains a pair of line for each auto-saved buffer.
6045 ;; The first line of the pair contains the visited file name
6046 ;; or is empty if the buffer was not visiting a file.
6047 ;; The second line is the auto-save file name.
6055 files
6061 "Kill BUFFER if confirmed."
6069 "Kill some buffers. Asks the user whether to kill each one of them.
6070 Non-interactively, if optional argument LIST is non-nil, it
6071 specifies the list of buffers to kill, asking for approval for each one."
6079 ; if we killed the base buffer.
6086 "Kill buffers whose name matches the specified REGEXP.
6087 Ignores buffers whose name starts with a space, unless optional
6088 prefix argument INTERNAL-TOO is non-nil. Asks before killing
6089 each buffer, unless NO-ASK is non-nil."
6098 \f
6100 "Adjust current buffer's auto save file name for current conditions.
6101 Also rename any existing auto save file, if it was made in this session."
6113 "Return file name to use for auto-saves of current buffer.
6114 Does not consider `auto-save-visited-file-name' as that variable is checked
6115 before calling this function. You can redefine this for customization.
6116 See also `auto-save-file-name-p'."
6124 result uniq)
6125 ;; Apply user-specified translations
6126 ;; to the file name.
6130 filename)
6140 filename))))
6145 ;; We truncate the file name to DOS 8+3 limits
6146 ;; before doing anything else, because the regexp
6147 ;; passed to string-match below cannot handle
6148 ;; extensions longer than 3 characters, multiple
6149 ;; dots, and other atrocities.
6154 fn)
6159 "#"
6162 ;; Make sure auto-save file names don't contain characters
6163 ;; invalid for the underlying filesystem.
6165 ;; Don't modify remote filenames
6168 result))))
6170 ;; Deal with buffers that don't have any associated files. (Mail
6171 ;; mode tends to create a good number of these.)
6175 file-name)
6176 ;; Restrict the characters used in the file name to those which
6177 ;; are known to be safe on all filesystems, url-encoding the
6178 ;; rest.
6179 ;; We do this on all platforms, because even if we are not
6180 ;; running on DOS/Windows, the current directory may be on a
6181 ;; mounted VFAT filesystem, such as a USB memory stick.
6185 ;; For multibyte characters, this will produce more than
6186 ;; 2 hex digits, so is not true URL encoding.
6190 ;; Generate the file name.
6196 ;; Try a few alternative directories, to get one we can
6197 ;; write it.
6203 ;; Don't modify remote filenames
6205 ;; The call to convert-standard-filename is in case
6206 ;; buffer-name includes characters not allowed by the
6207 ;; DOS/Windows filesystems. make-temp-file writes to the
6208 ;; file it creates, so we must fix the file name _before_
6209 ;; make-temp-file is called.
6211 fname))
6213 ;; make-temp-file creates the file,
6214 ;; but we don't want it to exist until we do an auto-save.
6218 file-name)))
6221 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6222 FILENAME should lack slashes. You can redefine this for customization."
6224 \f
6226 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6227 The generated regexp will match a filename only if the filename
6228 matches that wildcard according to shell rules. Only wildcards known
6229 by `sh' are supported."
6231 ;; Copy the initial run of non-special characters.
6234 ;; If no special characters, we're almost done.
6238 j)
6240 result
6261 ;; Found "[^". Insert a `\0' character
6262 ;; (which cannot happen in a filename)
6263 ;; into the character class, so that `^'
6264 ;; is not the first character after `[',
6265 ;; and thus non-special in a regexp.
6270 ;; I don't think `]' can appear in a
6271 ;; character class in a wildcard, but
6272 ;; let's be general here.
6279 i
6292 ;; Shell wildcards should match the entire filename,
6293 ;; not its part. Make the regexp say so.
6295 \f
6298 "Switches for `list-directory' to pass to `ls' for brief listing."
6304 "Switches for `list-directory' to pass to `ls' for verbose listing."
6309 "Expand wildcard pattern PATTERN.
6310 This returns a list of file names which match the pattern.
6311 Files are sorted in `string<' order.
6313 If PATTERN is written as an absolute file name,
6314 the values are absolute also.
6316 If PATTERN is written as a relative file name, it is interpreted
6317 relative to the current default directory, `default-directory'.
6318 The file names returned are normally also relative to the current
6319 default directory. However, if FULL is non-nil, they are absolute."
6323 ;; A list of all dirs that DIRPART specifies.
6324 ;; This can be more than one dir
6325 ;; if DIRPART contains wildcards.
6331 contents)
6336 ;; Filter out "." and ".."
6341 name))
6348 this-dir-contents)
6349 this-dir-contents)
6350 contents)))))
6351 contents)))
6353 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6357 "Display a list of files in or matching DIRNAME, a la `ls'.
6358 DIRNAME is globbed by the shell if necessary.
6359 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6360 Actions controlled by variables `list-directory-brief-switches'
6361 and `list-directory-verbose-switches'."
6365 nil default-directory nil)
6366 pfx)))
6368 list-directory-brief-switches))
6369 buffer)
6381 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6389 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6391 PATTERN is assumed to represent a file-name wildcard suitable for the
6392 underlying filesystem. For Unix and GNU/Linux, each character from the
6394 the parts of the pattern which don't include wildcard characters are
6395 quoted with double quotes.
6398 on Windows), so PATTERN can use them to quote wildcard characters that
6399 need to be passed verbatim to shell commands."
6403 ;; DOS/Windows don't allow `"' in file names. So if the
6404 ;; argument has quotes, we can safely assume it is already
6405 ;; quoted by the caller.
6407 ;; We quote [&()#$`'] in case their shell is a port of a
6408 ;; Unixy shell. We quote [,=+] because stock DOS and
6409 ;; Windows shells require that in some cases, such as
6410 ;; passing arguments to batch files that use positional
6411 ;; arguments like %1.
6413 pattern
6416 end)
6433 pattern))))
6440 "Program to get the amount of free space on a file system.
6441 We assume the output has the format of `df'.
6442 The value of this variable must be just a command name or file name;
6443 if you want to specify options, use `directory-free-space-args'.
6445 A value of nil disables this feature.
6447 This variable is obsolete; Emacs no longer uses it."
6451 "ignored, as Emacs uses `file-system-info' instead"
6456 "Options to use when running `directory-free-space-program'."
6460 "ignored, as Emacs uses `file-system-info' instead"
6464 "Return the amount of free space on directory DIR's file system.
6465 The return value is a string describing the amount of free
6466 space (normally, the number of free 1KB blocks).
6468 If DIR's free space cannot be obtained, this function returns nil."
6474 ;; The following expression replaces `dired-move-to-filename-regexp'.
6478 ;; In some locales, month abbreviations are as short as 2 letters,
6479 ;; and they can be followed by ".".
6480 ;; In Breton, a month name can include a quote character.
6493 s "+"
6496 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6497 ;; omits the Kanji characters after month and day-of-month.
6498 ;; On Mac OS X 10.3, the date format in East Asian locales is
6499 ;; day-of-month digits followed by month digits.
6505 ;; The "[0-9]" below requires the previous column to end in a digit.
6506 ;; This avoids recognizing `1 may 1997' as a date in the line:
6507 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6509 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6511 ;; For non-iso date formats, we add the ".*" in order to find
6512 ;; the last possible match. This avoids recognizing
6513 ;; `jservice 10 1024' as a date in the line:
6514 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6516 ;; vc dired listings provide the state or blanks between file
6517 ;; permissions and date. The state is always surrounded by
6518 ;; parentheses:
6519 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6520 ;; This is not supported yet.
6525 "Regular expression to match up to the file name in a directory listing.
6526 The default value is designed to recognize dates and times
6532 "Return non-nil if DIR contents a shell wildcard in the directory part.
6533 The return value is a cons (DIR . WILDCARDS); DIR is the
6534 `default-directory' in the Dired buffer, and WILDCARDS are the wildcards.
6536 Valid wildcards are '*', '?', '[abc]' and '[a-z]'."
6539 ls-lisp-support-shell-wildcards)
6543 wildcards wildcards wildcards)))
6551 ;; The following overshoots by one line for an empty
6552 ;; directory listed with "--dired", but without "-a"
6553 ;; switch, where the ls output contains a
6554 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6555 ;; We take care of that case later.
6563 error-lines)
6564 ;; Find all the lines that are error messages,
6565 ;; and record the bounds of each one.
6572 ;; Now read the numeric positions of file names.
6579 error-lines))
6582 error-lines)))
6584 ;; End is followed by \n or by " -> ".
6586 ;; It seems that we can't trust ls's output as to
6587 ;; byte positions of filenames.
6593 ;; Take care of the case where the ls output contains a
6594 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6595 ;; and we went one line too far back (see above).
6600 ;; insert-directory
6601 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6602 ;; FULL-DIRECTORY-P is nil.
6603 ;; The single line of output must display FILE's name as it was
6604 ;; given, namely, an absolute path name.
6605 ;; - must insert exactly one line for each file if WILDCARD or
6606 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6607 ;; before the file lines, plus optional text after the file lines.
6608 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6609 ;; allowed.
6610 ;; File lines should display the basename.
6611 ;; - must be consistent with
6612 ;; - functions dired-move-to-filename, (these two define what a file line is)
6613 ;; dired-move-to-end-of-filename,
6614 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6615 ;; dired-insert-headerline
6616 ;; dired-after-subdir-garbage (defines what a "total" line is)
6617 ;; - variable dired-subdir-regexp
6618 ;; - may be passed "--dired" as the first argument in SWITCHES.
6619 ;; Filename handlers might have to remove this switch if their
6620 ;; "ls" command does not support it.
6622 "Insert directory listing for FILE, formatted according to SWITCHES.
6623 Leaves point after the inserted text.
6624 SWITCHES may be a string of options, or a list of strings
6625 representing individual options.
6626 Optional third arg WILDCARD means treat FILE as shell wildcard.
6627 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6628 switches do not contain `d', so that a full listing is expected.
6630 This works by running a directory listing program
6631 whose name is in the variable `insert-directory-program'.
6632 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6634 When SWITCHES contains the long `--dired' option, this function
6635 treats it specially, for the sake of dired. However, the
6636 normally equivalent short `-D' option is just passed on to
6637 `insert-directory-program', as any other option."
6638 ;; We need the directory in order to find the right handler.
6643 wildcard full-directory-p)
6646 ;; Read the actual directory using `insert-directory-program'.
6647 ;; RESULT gets the status code.
6649 ;; putting text property `dired-filename, decode one
6650 ;; bunch by one to preserve that property.
6652 ;; This is to control encoding the arguments in call-process.
6656 default-file-name-coding-system))))
6659 ;; If the wildcard is just in the file part, then run ls in
6660 ;; the directory part of the file pattern using the last
6661 ;; component as argument. Otherwise, run ls in the longest
6662 ;; subdirectory of the directory part free of wildcards; use
6663 ;; the remaining of the file pattern as argument.
6672 ;; NB since switches is passed to the shell, be
6673 ;; careful of malicious values, eg "-l;reboot".
6674 ;; See eg dired-safe-switches-p.
6676 shell-file-name nil t nil
6677 shell-command-switch
6679 ""
6681 insert-directory-program
6682 " -d "
6684 switches
6686 " -- "
6687 ;; Quote some characters that have
6688 ;; special meanings in shells; but
6689 ;; don't quote the wildcards--we want
6690 ;; them to be special. We also
6691 ;; currently don't quote the quoting
6692 ;; characters in case people want to
6693 ;; use them explicitly to quote
6694 ;; wildcard characters.
6696 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6697 ;; directory if FILE is a symbolic link.
6705 insert-directory-program nil t nil
6709 ;; Split the switches at any spaces so we can
6710 ;; pass separate options as separate args.
6712 ;; Avoid lossage if FILE starts with `-'.
6719 ;; (concat (file-name-as-directory file) ".")
6720 file
6721 file))))))))
6723 ;; If we got "//DIRED//" in the output, it means we got a real
6724 ;; directory listing, even if `ls' returned nonzero.
6725 ;; So ignore any errors.
6738 ;; The first time ls returns an error,
6739 ;; find the version numbers of ls,
6740 ;; and set insert-directory-ls-version
6741 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6742 ;; is equal or if the info cannot be obtained.
6743 ;; (That can mean it isn't GNU ls.)
6753 comparison)
6769 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6773 ;; If `insert-directory-program' failed, signal an error.
6775 ;; Delete the error message it may have output.
6777 ;; On non-Posix systems, we cannot open a directory, so
6778 ;; don't even try, because that will always result in
6779 ;; the ubiquitous "Access denied". Instead, show the
6780 ;; command line so the user can try to guess what went wrong.
6785 insert-directory-program
6787 file result)
6788 ;; Unix. Access the file to get a suitable error.
6792 ;; Now decode what read if necessary.
6794 file-name-coding-system
6795 default-file-name-coding-system
6797 coding-no-eol
6798 val pos)
6802 ;; If no coding system is specified or detection is
6803 ;; requested, detect the coding.
6817 ;; Force no eol conversion on a file name, so
6818 ;; that CR is preserved.
6826 ;; Try to insert the amount of free space.
6829 ;; First find the line to put it on.
6833 ;; Replace "total" with "used", to avoid confusion.
6839 "Convert `ls --dired' file name position value POS to a buffer position.
6840 File name position values returned in ls --dired output
6841 count only stdout; they don't count the error messages sent to stderr.
6842 So this function converts to them to real buffer positions.
6843 ERROR-LINES is a list of buffer positions of error message lines,
6844 of the form (START END)."
6848 pos)
6852 "Insert directory listing for FILE, formatted according to SWITCHES.
6854 Like `insert-directory', but if FILE does not exist, it inserts a
6855 message to that effect instead of signaling an error."
6858 ;; Simulate the message printed by `ls'.
6862 "Functions to call with no arguments to query about killing Emacs.
6863 If any of these functions returns nil, killing Emacs is canceled.
6864 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6865 the low level primitive, does not. See also `kill-emacs-hook'."
6871 "How to ask for confirmation when leaving Emacs.
6872 If nil, the default, don't ask at all. If the value is non-nil, it should
6873 be a predicate function; for example `yes-or-no-p'."
6882 "Non-nil if Emacs should confirm killing processes on exit.
6883 If this variable is nil, the value of
6884 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6885 processes with a non-nil `process-query-on-exit-flag', Emacs will
6886 prompt the user before killing them."
6892 "Offer to save each buffer, then kill this Emacs process.
6893 With prefix ARG, silently save all file-visiting buffers without asking.
6894 If there are active processes where `process-query-on-exit-flag'
6895 returns non-nil and `confirm-kill-processes' is non-nil,
6896 asks whether processes should be killed.
6897 Runs the members of `kill-emacs-query-functions' in turn and stops
6898 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6900 ;; Don't use save-some-buffers-default-predicate, because we want
6901 ;; to ask about all the buffers before killing Emacs.
6912 ;; process-list is not defined on MSDOS.
6915 active)
6934 ;; Query the user for other things, perhaps.
6941 "Offer to save each buffer, then kill the current connection.
6942 If the current frame has no client, kill Emacs itself using
6943 `save-buffers-kill-emacs'.
6945 With prefix ARG, silently save all file-visiting buffers, then kill.
6947 If emacsclient was started with a list of filenames to edit, then
6948 only these files will be asked to be saved."
6953 \f
6954 ;; We use /: as a prefix to "quote" a file name
6955 ;; so that magic file name handlers will not apply to it.
6959 file-name-handler-alist))
6961 ;; We depend on being the last handler on the list,
6962 ;; so that anything else which does need handling
6963 ;; has been handled already.
6964 ;; So it is safe for us to inhibit *all* magic file name handlers for
6965 ;; operations, which return a file name. See Bug#29579.
6970 directory-file-name file-name-sans-versions
6971 find-backup-file-name file-remote-p))
6975 file-name-handler-alist))
6977 ;; Some operations respect file name handlers in
6978 ;; `default-directory'. Because core function like
6979 ;; `call-process' don't care about file name handlers in
6980 ;; `default-directory', we here have to resolve the
6981 ;; directory into a local one. For `process-file',
6982 ;; `start-file-process', and `shell-command', this fixes
6983 ;; Bug#25949.
6986 shell-command temporary-file-directory))
6990 default-directory))
6991 ;; Get a list of the indices of the args which are file names.
6994 ;; The first seven are special because they
6995 ;; return a file name. We want to include the /:
6996 ;; in the return value.
6997 ;; So just avoid stripping it in the first place.
7001 ;; not stripped of its quoting.
7003 ;; `add' means add "/:" to the result.
7006 ;; `unquote-then-quote' means set buffer-file-name
7007 ;; temporarily to unquoted filename.
7009 ;; List the arguments which are filenames.
7023 ;; These file-notify-* operations take a
7024 ;; descriptor.
7027 ;; For all other operations, treat the first argument only
7028 ;; as the file name.
7030 method
7031 ;; Copy ARGUMENTS so we can replace elements in it.
7035 ;; Strip off the /: from the file names that have it.
7043 "/"
7049 (`buffer-file-name
7053 buffer-file-name)))
7055 (`insert-file-contents
7061 (`unquote-then-quote
7062 ;; We can't use `cl-letf' with `(buffer-local-value)' here
7063 ;; because it wouldn't work during bootstrapping.
7065 ;; `unquote-then-quote' is only used for the
7066 ;; `verify-visited-file-modtime' action, which takes a buffer
7067 ;; as only optional argument.
7070 ;; Make sure to hide the temporary buffer change from the
7071 ;; underlying operation.
7079 If NAME is a remote file name, check the local part of NAME."
7084 If NAME is a remote file name, the local part of NAME is quoted.
7085 If NAME is already a quoted file name, NAME is returned unchanged."
7087 name
7092 If NAME is a remote file name, the local part of NAME is unquoted."
7098 \f
7099 ;; Symbolic modes and read-file-modes.
7102 "Convert CHAR to a numeric bit-mask for extracting mode bits.
7103 CHAR is in [ugoa] and represents the category of users (Owner, Group,
7104 Others, or All) for whom to produce the mask.
7105 The bit-mask that is returned extracts from mode bits the access rights
7106 for the specified category of users."
7114 "Convert CHAR to a numeric value of mode bits.
7115 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7116 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7123 ;; Rights relative to the previous file modes.
7134 "Convert a symbolic mode string specification to an equivalent number.
7136 WHO-MASK is the bit-mask specifying the category of users to which to
7137 apply the access permissions. See `file-modes-char-to-who'.
7138 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7139 RIGHTS request to add, remove, or set permissions based on existing ones,
7146 char-right)
7153 num-rights
7157 op char-right)))
7158 num-rights))
7161 "Convert symbolic file modes to numeric file modes.
7162 MODES is the string to convert, it should match
7164 See Info node `(coreutils)File permissions' for more information on this
7165 notation.
7166 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7167 MODES request to add, remove, or set permissions based on existing ones,
7181 num-who num-modes)
7184 num-modes)))
7187 "Read file modes in octal or symbolic notation and return its numeric value.
7189 ORIG-FILE is the name of a file on whose mode bits to base returned
7190 permissions if what user types requests to add, remove, or set permissions
7206 nil nil default)))
7215 ;; Trashcan handling.
7217 "Directory for `move-file-to-trash' to move files and directories to.
7218 This directory is only used when the function `system-move-file-to-trash'
7219 is not defined.
7220 Relative paths are interpreted relative to `default-directory'.
7221 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7231 "Move the file (or directory) named FILENAME to the trash.
7232 When `delete-by-moving-to-trash' is non-nil, this function is
7233 called by `delete-file' and `delete-directory' instead of
7234 deleting files outright.
7236 If the function `system-move-file-to-trash' is defined, call it
7237 with FILENAME as an argument.
7238 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7239 directory.
7240 Otherwise, trash FILENAME using the freedesktop.org conventions,
7241 like the GNOME, KDE and XFCE desktop environments. Emacs only
7245 ;; If `trash-directory' is non-nil, move the file there.
7250 ;; We can't trash a parent directory of trash-directory.
7253 trash-dir filename))
7256 ;; Ensure that the trashed file-name is unique.
7263 ;; If `system-move-file-to-trash' is defined, use it.
7266 ;; Otherwise, use the freedesktop.org method, as specified at
7267 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7278 ;; Check if we have permissions to delete.
7282 ;; The trashed file cannot be the trash dir or its parent.
7285 trash-files-dir filename))
7288 trash-info-dir filename))
7290 ;; Ensure that the trash directory exists; otherwise, create it.
7297 ;; Try to move to trash with .trashinfo undo information
7302 ;; Perform url-encoding on FN. For compatibility with
7303 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7304 ;; for path separators.
7309 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7310 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7323 fn))
7328 ;; Make a .trashinfo file. Use O_EXCL, as per trash-spec 1.0.
7332 trash-info-dir)))
7336 ;; Uniquify new-fn. Some file managers do not
7337 ;; like Emacs-style backup file names. E.g.:
7338 ;; https://bugs.kde.org/170956
7344 ;; Finally, try to move the file to the trashcan.
7350 "The type field in ATTRIBUTES returned by `file-attributes'.
7351 The value is either t for directory, string (name linked to) for
7352 symbolic link, or nil."
7356 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7360 "The UID field in ATTRIBUTES returned by `file-attributes'.
7361 This is either a string or a number. If a string value cannot be
7362 looked up, a numeric value, either an integer or a float, is
7363 returned."
7367 "The GID field in ATTRIBUTES returned by `file-attributes'.
7368 This is either a string or a number. If a string value cannot be
7369 looked up, a numeric value, either an integer or a float, is
7370 returned."
7374 "The last access time in ATTRIBUTES returned by `file-attributes'.
7375 This a list of integers (HIGH LOW USEC PSEC) in the same style
7376 as (current-time)."
7380 "The modification time in ATTRIBUTES returned by `file-attributes'.
7381 This is the time of the last change to the file's contents, and
7382 is a list of integers (HIGH LOW USEC PSEC) in the same style
7383 as (current-time)."
7387 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7388 This is the time of last change to the file's attributes: owner
7389 and group, access mode bits, etc, and is a list of integers (HIGH
7390 LOW USEC PSEC) in the same style as (current-time)."
7394 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7395 This is a floating point number if the size is too large for an integer."
7399 "The file modes in ATTRIBUTES returned by `file-attributes'.
7400 This is a string of ten letters or dashes as in ls -l."
7404 "The inode number in ATTRIBUTES returned by `file-attributes'.
7405 If it is larger than what an Emacs integer can hold, this is of
7406 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7407 If even HIGH is too large for an Emacs integer, this is instead
7408 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7409 middle 24 bits, and finally the low 16 bits."
7413 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7414 If it is larger than what an Emacs integer can hold, this is of
7415 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7416 If even HIGH is too large for an Emacs integer, this is instead
7417 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7418 middle 24 bits, and finally the low 16 bits."
7422 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7423 ATTR-NAMES are symbols with the selected attribute names.
7425 Valid attribute names are: type, link-number, user-id, group-id,
7426 access-time, modification-time, status-change-time, size, modes,
7427 inode-number and device-number."
7429 modification-time status-change-time
7430 size modes inode-number device-number))
7431 result)
7437 attributes)
7438 result)
7441 \f
7466 ;;; files.el ends here