| blob | d0b7285fdb00add17b9d03bdd2fbfcc7ed527b89 |
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 greater than 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
441 auto-save-visited-file-name))))))))
443 ;; The 'set' part is so we don't get a warning for using this variable
444 ;; above, while still catching code that _sets_ the variable to get
445 ;; the same effect as the new auto-save-visited-mode.
450 "Non-nil means save word abbrevs too when files are saved.
451 If `silently', don't ask the user before saving."
456 "Non-nil means allow `find-file' to visit directories.
457 To visit the directory, `find-file' runs `find-directory-functions'."
462 "List of functions to try in sequence to visit a directory.
463 Each function is called with the directory name as the sole argument
464 and should return either a buffer or nil."
468 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
470 "List of functions to try in sequence to get a file name at point.
471 Each function should return either nil or a file name found at the
472 location of point in the current buffer."
476 ;;;It is not useful to make this a local variable.
477 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
481 "List of functions to be called for `find-file' on nonexistent file.
482 These functions are called as soon as the error is detected.
483 Variable `buffer-file-name' is already set up.
486 ;;;It is not useful to make this a local variable.
487 ;;;(put 'find-file-hooks 'permanent-local t)
490 "List of functions to be called after a buffer is loaded from a file.
491 The buffer's local variables (if any) will have been processed before the
492 functions are called."
500 "List of functions to be called before saving a buffer to a file.
501 Only used by `save-buffer'.
502 If one of them returns non-nil, the file is considered already written
503 and the rest are not called.
504 These hooks are considered to pertain to the visited file.
505 So any buffer-local binding of this variable is discarded if you change
507 change the major mode.
509 This hook is not run if any of the functions in
510 `write-contents-functions' returns non-nil. Both hooks pertain
511 to how to save a buffer to file, for instance, choosing a suitable
512 coding system and setting mode bits. (See Info
513 node `(elisp)Saving Buffers'.) To perform various checks or
525 "List of functions to be called before writing out a buffer to a file.
527 Only used by `save-buffer'. If one of them returns non-nil, the
528 file is considered already written and the rest are not called
529 and neither are the functions in `write-file-functions'. This
530 hook can thus be used to create save behavior for buffers that
531 are not visiting a file at all.
533 This variable is meant to be used for hooks that pertain to the
534 buffer's contents, not to the particular visited file; thus,
535 `set-visited-file-name' does not clear this variable; but changing the
536 major mode does clear it.
538 For hooks that _do_ pertain to the particular visited file, use
539 `write-file-functions'. Both this variable and
540 `write-file-functions' relate to how a buffer is saved to file.
541 To perform various checks or updates before the buffer is saved,
546 "Control use of local variables in files you visit.
547 The value can be t, nil, :safe, :all, or something else.
549 A value of t means file local variables specifications are obeyed
550 if all the specified variable values are safe; if any values are
551 not safe, Emacs queries you, once, whether to set them all.
552 \(When you say yes to certain values, they are remembered as safe.)
554 :safe means set the safe variables, and ignore the rest.
555 :all means set all variables, whether safe or not.
556 (Don't set it permanently to :all.)
557 A value of nil means always ignore the file local variables.
559 Any other value means always query you once whether to set them all.
560 \(When you say yes to certain values, they are remembered as safe, but
563 This variable also controls use of major modes specified in
564 a -*- line.
567 always obeys file local variable specifications and the -*- line,
568 and ignores this variable."
569 :risky t
578 "Non-nil means enable use of directory-local variables.
579 Some modes may wish to set this to nil to prevent directory-local
582 ;; This is an odd variable IMO.
583 ;; You might wonder why it is needed, when we could just do:
584 ;; (set (make-local-variable 'enable-local-variables) nil)
585 ;; These two are not precisely the same.
586 ;; Setting this variable does not cause -*- mode settings to be
587 ;; ignored, whereas setting enable-local-variables does.
588 ;; Only three places in Emacs use this variable: tar and arc modes,
589 ;; and rmail. The first two don't need it. They already use
590 ;; inhibit-local-variables-regexps, which is probably enough, and
591 ;; could also just set enable-local-variables locally to nil.
592 ;; Them setting it has the side-effect that dir-locals cannot apply to
593 ;; eg tar files (?). FIXME Is this appropriate?
594 ;; AFAICS, rmail is the only thing that needs this, and the only
595 ;; reason it uses it is for BABYL files (which are obsolete).
596 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
597 ;; to respect, so that find-file on a BABYL file will switch to
598 ;; rmail-mode automatically (this is nice, but hardly essential,
599 ;; since most people are used to explicitly running a command to
600 ;; access their mail; M-x gnus etc). Rmail files may happen to
601 ;; contain Local Variables sections in messages, which Rmail wants to
602 ;; ignore. So AFAICS the only reason this variable exists is for a
603 ;; minor convenience feature for handling of an obsolete Rmail file format.
605 "Like `enable-local-variables', except for major mode in a -*- line.
606 The meaningful values are nil and non-nil. The default is non-nil.
607 It should be set in a buffer-local fashion.
609 Setting this to nil has the same effect as setting `enable-local-variables'
610 to nil, except that it does not ignore any mode: setting in a -*- line.
611 Unless this difference matters to you, you should set `enable-local-variables'
616 The value can be t, nil or something else.
617 A value of t means obey `eval' variables.
618 A value of nil means ignore them; anything else means query."
619 :risky t
626 "Non-nil means buffers visiting files read-only do so in view mode.
627 In fact, this means that all read-only buffers normally have
628 View mode enabled, including buffers that are read-only because
629 you visit a file you cannot alter, and buffers you make read-only
635 "History list of file names entered in the minibuffer.
637 Maximum length of the history list is determined by the value
641 "If non-nil, avoid messages when saving files.
642 Error-related messages will still be printed, but all other
645 \f
648 "Provides support for ange-ftp host name completion.
649 Runs the usual ange-ftp hook, but only for completion operations."
650 ;; Having this here avoids the need to load ange-ftp when it's not
651 ;; really in use.
657 inhibit-file-name-handlers)))
665 "Convert a standard file's name to something suitable for the OS.
666 This means to guarantee valid names and perhaps to canonicalize
667 certain patterns.
669 FILENAME should be an absolute file name since the conversion rules
670 sometimes vary depending on the position in the file name. E.g. c:/foo
671 is a valid DOS file name, but c:/bar/c:/foo is not.
673 This function's standard definition is trivial; it just returns
674 the argument. However, on Windows and DOS, replace invalid
675 characters. On DOS, make sure to obey the 8.3 limitations.
676 In the native Windows build, turn Cygwin names into native names.
678 See Info node `(elisp)Standard File Names' for more details."
683 ;; Replace invalid filename characters with !
687 name))
695 "Read directory name, prompting with PROMPT and completing in directory DIR.
696 Value is not expanded---you must call `expand-file-name' yourself.
697 Default name to DEFAULT-DIRNAME if user exits with the same
698 non-empty string that was inserted by this function.
699 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
700 or just DIR if INITIAL is nil.)
701 If the user exits with an empty minibuffer, this function returns
702 an empty string. (This can only happen if the user erased the
703 pre-inserted contents or if `insert-default-directory' is nil.)
704 Fourth arg MUSTMATCH non-nil means require existing directory's name.
705 Non-nil and non-t means also require confirmation after completion.
706 Fifth arg INITIAL specifies text to start with.
707 DIR should be an absolute directory name. It defaults to
708 the value of `default-directory'."
713 dir))
714 mustmatch initial
717 \f
719 "Show the current default directory.
720 With prefix argument INSERT, insert the current default directory
721 at point instead."
728 "Value of the CDPATH environment variable, as a list.
732 "Explode a search path into a list of directory names.
733 Directories are separated by `path-separator' (which is colon in
734 GNU and Unix systems). Substitute environment variables into the
735 resulting list of directory names. For an empty path element (i.e.,
736 a leading or trailing separator, or two adjacent separators), return
737 nil (meaning `default-directory') as the associated list element."
745 "Change current directory to given absolute file name DIR."
746 ;; Put the name into directory syntax now,
747 ;; because otherwise expand-file-name may give some bad results.
749 ;; We used to additionally call abbreviate-file-name here, for an
750 ;; unknown reason. Problem is that most buffers are setup
751 ;; without going through cd-absolute and don't call
752 ;; abbreviate-file-name on their default-directory, so the few that
753 ;; do end up using a superficially different directory.
765 "Make DIR become the current buffer's default directory.
766 If your environment includes a `CDPATH' variable, try each one of
767 that list of directories (separated by occurrences of
768 `path-separator') when resolving a relative directory name.
769 The path separator is colon in GNU and GNU-like systems."
772 ;; FIXME: There's a subtle bug in the completion below. Seems linked
773 ;; to a fundamental difficulty of implementing `predicate' correctly.
774 ;; The manifestation is that TAB may list non-directories in the case where
775 ;; those files also correspond to valid directories (if your cd-path is (A/
776 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
777 ;; will be listed as valid completions).
778 ;; This is because `a' (listed because of A/a) is indeed a valid choice
779 ;; (which will lead to the use of B/a).
784 cd-path nil))
793 default-directory default-directory
794 t))))
804 "Return list of all files under DIR that have file names matching REGEXP.
806 order, and files from each directory are sorted in alphabetical order.
807 Each file name appears in the returned list in its absolute form.
808 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
809 output directories whose names match REGEXP."
812 ;; When DIR is "/", remote file names like "/method:" could
813 ;; also be offered. We shall suppress them.
821 ;; Don't follow symlinks to other directories.
825 full-file regexp include-directories))))
836 "Load the Lisp file named FILE."
837 ;; This is a case where .elc and .so/.dll make a lot of sense.
841 completion-ignored-extensions))))
846 "Search for FILENAME through PATH.
847 If found, return the absolute file name of FILENAME; otherwise
848 return nil.
849 PATH should be a list of directories to look in, like the lists in
850 `exec-path' or `load-path'.
851 If SUFFIXES is non-nil, it should be a list of suffixes to append to
854 If non-nil, PREDICATE is used instead of `file-readable-p'.
856 This function will normally skip directories, so if you want it to find
857 directories, make sure the PREDICATE function returns `dir-ok' for them.
859 PREDICATE can also be an integer to pass to the `access' system call,
860 in which case file-name handlers are ignored. This usage is deprecated.
861 For compatibility, PREDICATE can also be one of the symbols
862 `executable', `readable', `writable', or `exists', or a list of
863 one or more of those symbols."
874 "Do completion for file names passed to `locate-file'."
877 ;; FIXME: maybe we should use completion-file-name-table instead,
878 ;; tho at least for `load', the arg is passed through
879 ;; substitute-in-file-name for historical reasons.
889 ;; If we have files like "foo.el" and "foo.elc", we could load one of
890 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
891 ;; preferred way. So if we list all 3, that gives a lot of redundant
892 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
893 ;; the user does want to pay attention to the extension. We try to
894 ;; diffuse this tension by stripping the suffix, except when the
895 ;; result is a single element (i.e. usually we only list "foo" unless
896 ;; it's the only remaining element in the list, in which case we do
897 ;; list "foo", "foo.elc" and "foo.el").
908 string-file dir))
913 ;; Switching from names to names+fullnames creates a non-monotonicity
914 ;; which can cause problems with things like partial-completion.
915 ;; To minimize the problem, filter out completion-regexp-list, so that
916 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
917 ;; from `names' which only matched `string' when they still had
918 ;; their suffix.
920 ;; Remove duplicates of the first element, so that we can easily check
921 ;; if `names' really only contains a single element.
924 ;; There's no more than one matching non-suffixed element, so expand
925 ;; the list by adding the suffixed elements as well.
928 string-dir names string-file pred action)))))
931 "Do completion for file names passed to `locate-file'.
932 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
936 string nil action))
940 "Regexp of directory names which stop the search in `locate-dominating-file'.
941 Any directory whose name matches this regexp will be treated like
942 a kind of root directory by `locate-dominating-file' which will stop its search
943 when it bumps into it.
944 The default regexp prevents fruitless and time-consuming attempts to find
945 special files in directories in which filenames are interpreted as hostnames,
949 "Starting at FILE, look up directory hierarchy for directory containing NAME.
950 FILE can be a file or a directory. If it's a file, its directory will
951 serve as the starting point for searching the hierarchy of directories.
952 Stop at the first parent directory containing a file NAME,
953 and return the directory. Return nil if not found.
954 Instead of a string, NAME can also be a predicate taking one argument
955 \(a directory) and returning a non-nil value if that directory is the one for
956 which we're looking. The predicate will be called with every file/directory
957 the function needs to examine, starting with FILE."
958 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
959 ;; `name' in /home or in /.
962 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.
1807 ;; This executes if find-file gets an error
1808 ;; and does not really find anything.
1809 ;; We put things back as they were.
1810 ;; If find-file actually finds something, we kill obuf below.
1819 ;; We already ran these; don't run them again.
1822 \f
1823 ;; FIXME we really need to fold the uniquify stuff in here by default,
1824 ;; not using advice, and add it to the doc string.
1826 "Create a suitably named buffer for visiting FILENAME, and return it.
1827 FILENAME (sans directory) is used unchanged if that name is free;
1828 otherwise a string <2> or <3> or ... is appended to get an unused name.
1830 Emacs treats buffers whose names begin with a space as internal buffers.
1831 To avoid confusion when visiting a file whose name begins with a space,
1838 lastname))))
1841 "Create and return a buffer with a name based on NAME.
1842 Choose the buffer's name using `generate-new-buffer-name'."
1846 "Regexp to match the automounter prefix in a directory name."
1852 "Regexp matching the user's homedir at the beginning of file name.
1856 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1858 home directory is a root directory) and removes automounter prefixes
1859 \(see the variable `automount-dir-prefix').
1861 When this function is first called, it caches the user's home
1862 directory as a regexp in `abbreviated-home-dir', and reuses it
1863 afterwards (so long as the home directory does not change;
1864 if you want to permanently change your home directory after having
1865 started Emacs, set `abbreviated-home-dir' to nil so it will be recalculated)."
1866 ;; Get rid of the prefixes added by the automounter.
1873 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1875 ;; If any elt of directory-abbrev-alist matches this name,
1876 ;; abbreviate accordingly.
1882 ;; Compute and save the abbreviated homedir name.
1883 ;; We defer computing this until the first time it's needed, to
1884 ;; give time for directory-abbrev-alist to be set properly.
1885 ;; We include a slash at the end, to avoid spurious matches
1886 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1896 ;; Depending on whether default-directory does or
1897 ;; doesn't include non-ASCII characters, the value
1898 ;; of abbreviated-home-dir could be multibyte or
1899 ;; unibyte. In the latter case, we need to decode
1900 ;; it. Note that this function is called for the
1901 ;; first time (from startup.el) when
1902 ;; locale-coding-system is already set up.
1904 abbreviated-home-dir
1907 'utf-8
1908 locale-coding-system))))))
1910 ;; If FILENAME starts with the abbreviated homedir,
1911 ;; and ~ hasn't changed since abbreviated-home-dir was set,
1912 ;; make it start with `~' instead.
1913 ;; If ~ has changed, we ignore abbreviated-home-dir rather than
1914 ;; invalidating it, on the assumption that a change in HOME
1915 ;; is likely temporary (eg for testing).
1916 ;; FIXME Is it even worth caching abbreviated-home-dir?
1917 ;; Ref: https://debbugs.gnu.org/19657#20
1919 ;; If the home dir is just /, don't change it.
1922 ;; MS-DOS root directories can come with a drive letter;
1923 ;; Novell Netware allows drive letters beyond `Z:'.
1933 filename)))
1936 "Return the buffer visiting file FILENAME (a string).
1937 This is like `get-file-buffer', except that it checks for any buffer
1938 visiting the same file, possibly under a different name.
1939 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1940 and others are ignored.
1941 If there is no such live buffer, return nil."
1954 found)
1964 ;; Verify this buffer's file number
1965 ;; still belongs to its file.
1968 attributes)
1972 found))))
1973 \f
1975 "Non-nil means file-visiting commands should handle wildcards.
1976 For example, if you specify `*.c', that would visit all the files
1977 whose names match the pattern."
1983 "Non-nil means suppress warning messages for symlinked files.
1984 When nil, Emacs prints a warning when visiting a file that is already
1985 visited, but with a different name. Setting this option to t
1986 suppresses this warning."
1992 "Maximum size of file above which a confirmation is requested.
1993 When nil, never request confirmation."
2000 "Warn if file size exceeds this percentage of available free memory.
2001 When nil, never issue warning. Beware: This probably doesn't do what you
2009 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
2010 OP-TYPE specifies the file operation being performed (for message to user)."
2019 "Warn if an attempt to open file of SIZE bytes may run out of memory."
2029 "You are trying to open a file whose size (%s)
2030 exceeds the %S%% of currently available free memory (%s).
2031 If that fails, try to open it with `find-file-literally'
2032 \(but note that some characters might be displayed incorrectly)."
2034 out-of-memory-warning-percentage
2038 "Like `message', except sometimes don't print to minibuffer.
2039 If the variable `save-silently' is non-nil, the message is not
2040 displayed on the minibuffer."
2045 "Read file FILENAME into a buffer and return the buffer.
2046 If a buffer exists visiting FILENAME, return that one, but
2047 verify that the file has not changed since visited or saved.
2048 The buffer is not selected, just returned to the caller.
2049 Optional second arg NOWARN non-nil means suppress any warning messages.
2050 Optional third arg RAWFILE non-nil means the file is read literally.
2051 Optional fourth arg WILDCARDS non-nil means do wildcard processing
2052 and visit all the matching files. When wildcards are actually
2053 used and expanded, return a list of buffers that are visiting
2054 the various files."
2061 'find-directory-functions
2064 filename)))
2067 find-file-wildcards
2081 ;; Find any buffer for a file which has same truename.
2083 ;; Let user know if there is a buffer with the same truename.
2087 find-file-suppress-same-file-warnings
2091 ;; Optionally also find that buffer.
2094 ;; Check to see if the file looks uncommonly large.
2099 ;; We are using an existing buffer.
2106 ;; Certain files should be reverted automatically
2107 ;; if they have changed on disk and not in the buffer.
2115 found))
2125 "File %s changed on disk. Discard your edits? "
2130 "File %s changed on disk. Discard your edits in %s? "
2138 ;; Check if a formerly read-only file has become
2139 ;; writable and vice versa, but if the buffer agrees
2140 ;; with the new state of the file, that is ok too.
2150 buffer-file-name
2151 new-status new-status)))
2157 nonexistent
2158 ;; It is confusing to ask whether to visit
2159 ;; non-literally if they have the file in
2160 ;; hexl-mode or image-mode.
2166 "The file %s is already visited normally,
2167 and you have edited the buffer. Now you have asked to visit it literally,
2168 meaning no coding system handling, format conversion, or local variables.
2169 Emacs can only visit a file in one way at a time.
2171 Do you want to save the file, and visit it literally instead? "
2172 "The file %s is already visited literally,
2173 meaning no coding system handling, format conversion, or local variables.
2174 You have edited the buffer. Now you have asked to visit the file normally,
2175 but Emacs can only visit a file in one way at a time.
2182 rawfile truename number))
2186 "\
2187 Do you want to discard your changes, and visit the file literally now? "
2188 "\
2191 rawfile truename number)
2197 "The file %s is already visited normally.
2198 You have asked to visit it literally,
2199 meaning no coding system decoding, format conversion, or local variables.
2200 But Emacs can only visit a file in one way at a time.
2202 Do you want to revisit the file literally now? "
2203 "The file %s is already visited literally,
2204 meaning no coding system decoding, format conversion, or local variables.
2205 You have asked to visit it normally,
2206 but Emacs can only visit a file in one way at a time.
2211 rawfile truename number)
2214 ;; Return the buffer we are using.
2215 buf)
2216 ;; Create a new buffer.
2218 ;; find-file-noselect-1 may use a different buffer.
2220 rawfile truename number))))))
2226 ;; Needed in case we are re-visiting the file with a different
2227 ;; text representation.
2244 filename)))
2245 ;; Unconditionally set error
2255 filename)))
2256 ;; Run find-file-not-found-functions until one returns non-nil.
2258 ;; If they fail too, set error.
2260 ;; Record the file's truename, and maybe use that as visited name.
2268 ;; Set buffer's default directory to that of the file.
2270 ;; Turn off backup files for certain file names. Since
2271 ;; this is a permanent local, the major mode won't eliminate it.
2285 \f
2287 "Like `insert-file-contents', but only reads in the file literally.
2288 See `insert-file-contents' for an explanation of the parameters.
2289 A buffer may be modified in several ways after reading into the buffer,
2290 due to Emacs features such as format decoding, character code
2291 conversion, `find-file-hook', automatic uncompression, etc.
2293 This function ensures that none of these modifications will take place."
2299 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2300 ;; into a file operation instead!
2302 inhibit-file-name-handlers))
2309 filename)))
2310 ;; Check whether the file is uncommonly large
2321 "Insert contents of file FILENAME into buffer after point with no conversion.
2323 This function is meant for the user to run interactively.
2324 Don't call it from programs! Use `insert-file-contents-literally' instead.
2325 \(Its calling sequence is different; see its documentation)."
2331 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2332 This has the `permanent-local' property, which takes effect if you
2337 "Visit file FILENAME with no conversion of any kind.
2338 Format conversion and character code conversion are both disabled,
2339 and multibyte characters are disabled in the resulting buffer.
2340 The major mode used is Fundamental mode regardless of the file name,
2341 and local variable specifications in the file are ignored.
2342 Automatic uncompression and adding a newline at the end of the
2343 file due to `require-final-newline' is also disabled.
2345 If Emacs already has a buffer which is visiting the file,
2346 this command asks you whether to visit it literally instead.
2348 In non-interactive use, the value is the buffer where the file is
2349 visited literally. If the file was visited in a buffer before
2350 this command was invoked, it will reuse the existing buffer,
2351 regardless of whether it was created literally or not; however,
2352 the contents of that buffer will be the literal text of the file
2353 without any conversions.
2355 In a Lisp program, if you want to be sure of accessing a file's
2356 contents literally, you should create a temporary buffer and then read
2357 the file contents into it using `insert-file-contents-literally'."
2360 "Find file literally: " nil default-directory
2363 \f
2365 _after-find-file-from-revert-buffer
2366 nomodes)
2367 "Called after finding a file and by the default revert function.
2368 Sets buffer mode, parses local variables.
2369 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2370 error in reading the file. WARN non-nil means warn if there
2371 exists an auto-save file more recent than the visited file.
2372 NOAUTO means don't mess with auto-save mode.
2373 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2374 \(see `revert-buffer-in-progress-p' for similar functionality).
2375 Fifth arg NOMODES non-nil means don't alter the file's modes.
2376 Finishes by calling the functions in `find-file-hook'
2377 unless NOMODES is non-nil."
2380 nil
2390 "Symbolic link that points to nonexistent file"
2394 ;; No need to warn if buffer is auto-saved
2395 ;; under the name of the visited file.
2397 auto-save-visited-file-name))
2400 buffer-file-name))
2420 ;; Make people do a little extra work (C-x C-q)
2421 ;; before altering a backup file.
2424 ;; When a file is marked read-only,
2425 ;; make the buffer read-only even if root is looking at it.
2433 ;; If requested, add a newline at the end of the file.
2444 view-read-only
2452 "Choose the major mode for this buffer automatically.
2453 Also sets up any specified local variables of the file.
2454 Uses the visited file name, the -*- line, and the local variables spec.
2456 This function is called automatically from `find-file'. In that case,
2457 we may set up the file-specified mode and local variables,
2458 depending on the value of `enable-local-variables'.
2459 In addition, if `local-enable-local-variables' is nil, we do
2460 not set local variables (though we do notice a mode specified with -*-.)
2462 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2463 or from Lisp without specifying the optional argument FIND-FILE;
2464 in that case, this function acts as if `enable-local-variables' were t."
2471 ;; FIXME this is less efficient than it could be, since both
2472 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2475 ;; `delay-mode-hooks' being non-nil will have prevented the major
2476 ;; mode's call to `run-mode-hooks' from calling
2477 ;; `hack-local-variables'. In that case, call it now.
2481 ;; Turn font lock off and on, to make sure it takes account of
2482 ;; whatever file local variables are relevant to it.
2484 ;; Font-lock-mode (now in font-core.el) can be ON when
2485 ;; font-lock.el still hasn't been loaded.
2492 "Non-nil means to try second pass through `auto-mode-alist'.
2493 This means that if the first case-sensitive search through the alist fails
2494 to find a matching major mode, a second case-insensitive search is made.
2495 On systems with case-insensitive file names, this variable is ignored,
2496 since only a single case-insensitive search through the alist is made."
2502 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2503 ;; c++-mode, java-mode and more) are added through autoload
2504 ;; directives in that file. That way is discouraged since it
2505 ;; spreads out the definition of the initial value.
2551 ;; Less common extensions come here
2552 ;; so more common ones above are found faster.
2560 ;; Besides .gdbinit, gdb documents other names to be usable for init
2561 ;; files, cross-debuggers can use something like
2562 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2563 ;; don't interfere with each other.
2565 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2566 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2567 ;; loaded when GDB reads an objfile called 'emacs'.
2575 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2599 ;; The Fortran standard does not say anything about file extensions.
2600 ;; .f90 was widely used for F90, now we seem to be trapped into
2601 ;; using a different extension for each language revision.
2602 ;; Anyway, the following extensions are supported by gfortran.
2610 ;; The list of archive file extensions should be in sync with
2611 ;; `auto-coding-alist' with `no-conversion' coding system.
2617 ;; Mailer puts message to be edited in
2618 ;; /tmp/Re.... or Message
2621 ;; some news reader is reported to use this
2635 ;; .emacs or .gnus or .viper following a directory delimiter in
2636 ;; Unix or MS-DOS syntax.
2639 ;; _emacs following a directory delimiter in MS-DOS syntax
2643 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2644 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2645 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2648 ;; .xs is also used for ld scripts, but seems to be more commonly
2649 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2651 ;; Explained in binutils ld/genscripts.sh. Eg:
2652 ;; A .x script file is the default script.
2653 ;; A .xr script is for linking without relocation (-r flag). Etc.
2657 ;; Common Lisp ASDF package system.
2664 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2676 ;; Windows candidates may be opened case sensitively on Unix
2684 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2685 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2686 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2687 ;; this has lower priority to avoid matching changelog.sgml etc.
2689 ;; either user's dot-files or under /etc or some such
2691 ;; alas not all ~/.*rc files are like this
2692 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2697 ;; this contains everything twice, with space and with colon :-(
2699 ;; Get rid of any trailing .n.m and try again.
2700 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2701 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2702 ;; Using mode nil rather than `ignore' would let the search continue
2703 ;; through this list (with the shortened name) rather than start over.
2706 ;; This should come after "in" stripping (e.g. config.h.in).
2707 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2709 ;; The following should come after the ChangeLog pattern
2710 ;; for the sake of ChangeLog.1, etc.
2711 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2713 "Alist of filename patterns vs corresponding major mode functions.
2714 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2715 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2716 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2717 mode function to use. FUNCTION will be called, unless it is nil.
2719 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2720 calling FUNCTION (if it's not nil), we delete the suffix that matched
2721 REGEXP and search the list again for another match.
2723 The extensions whose FUNCTION is `archive-mode' should also
2724 appear in `auto-coding-alist' with `no-conversion' coding system.
2726 See also `interpreter-mode-alist', which detects executable script modes
2727 based on the interpreters they specify to run,
2732 "Select Conf mode or XML mode according to start of file."
2742 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2743 ;; and pike-mode) are added through autoload directives in that
2744 ;; file. That way is discouraged since it spreads out the
2745 ;; definition of the initial value.
2774 "Alist mapping interpreter names to major modes.
2775 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2776 Each element looks like (REGEXP . MODE).
2777 If REGEXP matches the entire name (minus any directory part) of
2778 the interpreter specified in the first line of a script, enable
2779 major mode MODE.
2786 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2787 ;; because we are duplicating info from auto-mode-alist.
2788 ;; TODO many elements of this list are also in auto-coding-alist.
2797 "List of regexps matching file names in which to ignore local variables.
2799 Files matching this list are typically binary file formats.
2800 They may happen to contain sequences that look like local variable
2801 specifications, but are not really, or they may be containers for
2802 member files with their own local variable sections, which are
2803 not appropriate for the containing file.
2810 "List of regexps matching suffixes to remove from file names.
2811 The function `inhibit-local-variables-p' uses this: when checking
2812 a file name, it first discards from the end of the name anything that
2815 ;; Can't think of any situation in which you'd want this to be nil...
2820 "Return non-nil if file local variables should be ignored.
2821 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2822 and `inhibit-local-variables-suffixes'. If
2823 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2832 sufs)
2837 temp))
2842 "Regexp matching interpreters, for file mode determination.
2843 This regular expression is matched against the first line of a file
2844 to determine the file's mode in `set-auto-mode'. If it matches, the file
2845 is assumed to be interpreted by the interpreter matched by the second group
2846 of the regular expression. The mode is then determined as the mode
2850 "Alist of buffer beginnings vs. corresponding major mode functions.
2851 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2852 After visiting a file, if REGEXP matches the text at the beginning of the
2853 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2854 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2855 major mode.
2857 If FUNCTION is nil, then it is not called. (That is a way of saying
2865 ;; The < comes before the groups (but the first) to reduce backtracking.
2866 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2867 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2871 comment-re "*"
2874 . mhtml-mode)
2876 ;; These two must come after html, because they are more general:
2881 . sgml-mode)
2884 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2885 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2886 After visiting a file, if REGEXP matches the text at the beginning of the
2887 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2888 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2889 have not specified a mode for this file.
2895 "Upper limit on `magic-mode-alist' regexp matches.
2899 "Select major mode appropriate for current buffer.
2901 To find the right major mode, this function checks for a -*- mode tag
2902 checks for a `mode:' entry in the Local Variables section of the file,
2903 checks if it uses an interpreter listed in `interpreter-mode-alist',
2904 matches the buffer beginning against `magic-mode-alist',
2905 compares the filename against the entries in `auto-mode-alist',
2906 then matches the buffer beginning against `magic-fallback-mode-alist'.
2908 If `enable-local-variables' is nil, or if the file name matches
2909 `inhibit-local-variables-regexps', this function does not check
2910 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2911 is nil, then the only mode: tag that can be relevant is a -*- one.
2913 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2914 set the major mode only if that would change it. In other words
2915 we don't actually set it to the same mode the buffer already has."
2916 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2918 end done mode modes)
2919 ;; Once we drop the deprecated feature where mode: is also allowed to
2920 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2921 ;; remove this section and just let (hack-local-variables t) handle it.
2922 ;; Find a -*- mode tag.
2926 ;; Note by design local-enable-local-variables does not matter here.
2928 try-locals
2931 ;; Find all specifications for the `mode:' variable
2932 ;; and execute them left to right.
2944 modes)))
2945 ;; Simple -*-MODE-*- case.
2948 modes))))
2949 ;; If we found modes to use, invoke them now, outside the save-excursion.
2957 ;; continuing would call minor modes again, toggling them off
2959 ;; hack-local-variables checks local-enable-local-variables etc, but
2960 ;; we might as well be explicit here for the sake of clarity.
2962 enable-local-variables
2963 local-enable-local-variables
2964 try-locals
2971 ;; If we didn't, look for an interpreter specified in the first line.
2972 ;; As a special case, allow for things like "#!/bin/env perl", which
2973 ;; finds the interpreter anywhere in $PATH.
2979 ;; Map interpreter name to a mode, signaling we're done at the
2980 ;; same time.
2987 interpreter-mode-alist)
2989 ;; If we found an interpreter mode to use, invoke it now.
2991 ;; Next try matching the buffer beginning against magic-mode-alist.
3000 nil magic-mode-alist
3009 "Problem in magic-mode-alist with element %s"
3010 re))))))))
3012 ;; Next compare the filename against the entries in auto-mode-alist.
3018 buffer-file-name)))
3019 ;; Remove backup-suffixes from file name.
3021 ;; Remove remote file name identification.
3026 ;; Find first matching alist entry.
3029 ;; Filesystem is case-insensitive.
3033 ;; Filesystem is case-sensitive.
3035 ;; First match case-sensitively.
3039 ;; Fallback to case-insensitive match.
3053 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
3070 "Problem with magic-fallback-mode-alist element: %s"
3071 re))))))))
3076 ;; When `keep-mode-if-same' is set, we are working on behalf of
3077 ;; set-visited-file-name. In that case, if the major mode specified is the
3078 ;; same one we already have, don't actually reset it. We don't want to lose
3079 ;; minor modes such as Font Lock.
3081 "Apply MODE and return it.
3082 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
3083 any aliases and compared to current major mode. If they are the
3084 same, do nothing and return nil."
3090 mode)))
3093 "Regexp of lines to skip when looking for file-local settings.
3094 If the first line matches this regular expression, then the -*-...-*- file-
3098 "Find the -*- spec in the buffer.
3099 Call with point at the place to start searching from.
3100 If one is found, set point to the beginning and return the position
3101 of the end. Otherwise, return nil; may change point.
3102 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3103 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3104 have no effect."
3107 ;; Don't look for -*- if this file name matches any
3108 ;; of the regexps in inhibit-local-variables-regexps.
3111 ;; If the file begins with "#!" (exec
3112 ;; interpreter magic), look for mode frobs
3113 ;; in the first two lines. You cannot
3114 ;; necessarily put them in the first line
3115 ;; of such a file without screwing up the
3116 ;; interpreter invocation. The same holds
3117 ;; for '\" in man pages (preprocessor
3118 ;; magic for the `man' program).
3129 end))))
3130 \f
3131 ;;; Handling file local variables
3135 file-local-variables-alist dir-local-variables-alist)
3140 "Normal hook run after processing a file's local variables specs.
3141 Major modes can use this to examine user-specified local variables
3145 "List variable-value pairs that are considered safe.
3146 Each element is a cons cell (VAR . VAL), where VAR is a variable
3147 symbol and VAL is a value that is considered safe."
3148 :risky t
3153 ;; This should be here at least as long as Emacs supports write-file-hooks.
3158 "Expressions that are considered safe in an `eval:' local variable.
3159 Add expressions to this list if you want Emacs to evaluate them, when
3160 they appear in an `eval' local variable specification, without first
3161 asking you for confirmation."
3162 :risky t
3167 ;; Risky local variables:
3170 buffer-auto-save-file-name
3171 buffer-file-name
3172 buffer-file-truename
3173 buffer-undo-list
3174 debugger
3175 default-text-properties
3176 eval
3177 exec-directory
3178 exec-path
3179 file-name-handler-alist
3180 frame-title-format
3181 global-mode-string
3182 header-line-format
3183 icon-title-format
3184 inhibit-quit
3185 load-path
3186 max-lisp-eval-depth
3187 max-specpdl-size
3188 minor-mode-map-alist
3189 minor-mode-overriding-map-alist
3190 mode-line-format
3191 mode-name
3192 overriding-local-map
3193 overriding-terminal-local-map
3194 process-environment
3195 standard-input
3196 standard-output
3197 unread-command-events))
3199 ;; Safe local variables:
3200 ;;
3201 ;; For variables defined by major modes, the safety declarations can go into
3202 ;; the major mode's file, since that will be loaded before file variables are
3203 ;; processed.
3204 ;;
3205 ;; For variables defined by minor modes, put the safety declarations in the
3206 ;; file defining the minor mode after the defcustom/defvar using an autoload
3207 ;; cookie, e.g.:
3208 ;;
3209 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3210 ;;
3211 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3212 ;; minor mode file may not be loaded yet.
3213 ;;
3214 ;; For variables defined in the C source code the declaration should go here:
3236 "Alist of file-local variable settings in the current buffer.
3237 Each element in this list has the form (VAR . VALUE), where VAR
3238 is a file-local variable (a symbol) and VALUE is the value
3239 specified. The actual value in the buffer may differ from VALUE,
3245 "Alist of directory-local variable settings in the current buffer.
3246 Each element in this list has the form (VAR . VALUE), where VAR
3247 is a directory-local variable (a symbol) and VALUE is the value
3248 specified in .dir-locals.el. The actual value in the buffer
3249 may differ from VALUE, if it is changed by the major or minor modes,
3254 "Normal hook run before setting file-local variables.
3255 It is called after checking for unsafe/risky variables and
3256 setting `file-local-variables-alist', and before applying the
3257 variables stored in `file-local-variables-alist'. A hook
3258 function is allowed to change the contents of this alist.
3260 This hook is called only if there is at least one file-local
3264 "Get confirmation before setting up local variable values.
3265 ALL-VARS is the list of all variables to be set up.
3266 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3267 RISKY-VARS is the list of those that are marked as risky.
3268 If these settings come from directory-local variables, then
3269 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3276 unsafe-vars))
3278 ;; Set up the contents of the *Local Variables* buffer.
3286 ", and variables that are risky (**)."
3294 y -- to apply the local variables list.
3298 ! -- to apply the local variables list, and permanently mark these
3310 ;; Make strings with embedded whitespace easier to read.
3318 ;; Display the buffer and read a choice.
3326 ""
3329 char)
3348 "Return local variables specified in the -*- line.
3349 Usually returns an alist of elements (VAR . VAL), where VAR is a
3350 variable and VAL is the specified value. Ignores any
3351 specification for `coding:', and sometimes for `mode' (which
3352 should have already been handled by `set-auto-coding' and
3353 `set-auto-mode', respectively). Return nil if the -*- line is
3354 malformed.
3356 If HANDLE-MODE is nil, we return the alist of all the local
3357 variables in the line except `coding' as described above. If it
3358 is neither nil nor t, we do the same, except that any settings of
3359 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3360 all settings in the line except for `mode', which \(if present) we
3361 return as the symbol specifying the mode."
3366 result)
3368 nil)
3370 ;; Simple form: "-*- MODENAME -*-".
3374 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3375 ;; (last ";" is optional).
3376 ;; If HANDLE-MODE is t, just check for `mode'.
3377 ;; Otherwise, parse the -*- line into the RESULT alist.
3385 ;; There used to be a downcase here,
3386 ;; but the manual didn't say so,
3387 ;; and people want to set var names that aren't all lc.
3393 ;; It is traditional to ignore
3394 ;; case when checking for `mode' in set-auto-mode,
3395 ;; so we must do that here as well.
3396 ;; That is inconsistent, but we're stuck with it.
3397 ;; The same can be said for `coding' in set-auto-coding.
3411 ;; Downcase "Mode:".
3414 val)
3415 result)
3418 result))))))
3421 "Filter local variable settings, querying the user if necessary.
3422 VARIABLES is the alist of variable-value settings. This alist is
3423 filtered based on the values of `ignored-local-variables',
3424 `enable-local-eval', `enable-local-variables', and (if necessary)
3425 user interaction. The results are added to
3426 `file-local-variables-alist', without applying them.
3427 If these settings come from directory-local variables, then
3428 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3429 ;; Find those variables that we may want to save to
3430 ;; `safe-local-variable-values'.
3436 ;; Ignore any variable in `ignored-local-variables'.
3437 nil)
3438 ;; Obey `enable-local-eval'.
3442 ;; In case previously marked safe (bug#5636).
3444 ;; If not safe and e-l-v = :safe, ignore totally.
3448 safe
3450 ;; Ignore duplicates (except `mode') in the present list.
3452 ;; Accept known-safe variables.
3456 ;; The variable is either risky or unsafe:
3463 ;; Query, unless all vars are safe or user wants no querying.
3469 risky-vars dir-name))
3479 ;; TODO? Warn once per file rather than once per session?
3483 "Parse and put into effect this buffer's local variables spec.
3484 Uses `hack-local-variables-apply' to apply the variables.
3486 If HANDLE-MODE is nil, we apply all the specified local
3487 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3488 except that any settings of `mode' are ignored.
3491 is specified, and return the corresponding mode symbol, or nil.
3492 In this case, we try to ignore minor-modes, and only return a
3493 major-mode.
3495 If `enable-local-variables' or `local-enable-local-variables' is nil,
3496 this function does nothing. If `inhibit-local-variables-regexps'
3497 applies to the file in question, the file is not scanned for
3498 local variables, but directory-local variables may still be applied."
3499 ;; We don't let inhibit-local-variables-p influence the value of
3500 ;; enable-local-variables, because then it would affect dir-local
3501 ;; variables. We don't want to search eg tar files for file local
3502 ;; variable sections, but there is no reason dir-locals cannot apply
3503 ;; to them. The real meaning of inhibit-local-variables-p is "do
3504 ;; not scan this file for local variables".
3507 result)
3511 ;; Note this is a no-op if enable-local-variables is nil.
3513 ;; This entire function is basically a no-op if enable-local-variables
3514 ;; is nil. All it does is set file-local-variables-alist to nil.
3516 ;; This part used to ignore enable-local-variables when handle-mode
3517 ;; was t. That was inappropriate, eg consider the
3518 ;; (artificial) example of:
3519 ;; (setq local-enable-local-variables nil)
3520 ;; Open a file foo.txt that contains "mode: sh".
3521 ;; It correctly opens in text-mode.
3522 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3524 ;; If HANDLE-MODE is t, and the prop line specifies a
3525 ;; mode, then we're done, and have no need to scan further.
3527 handle-mode))
3529 ;; Look for "Local variables:" line in last page.
3537 ;; suffix is what comes after "local variables:" in its line.
3538 ;; prefix is what comes before "local variables:" in its line.
3551 endpos
3557 nil t))
3558 ;; This used to be an error, but really all it means is
3559 ;; that this may simply not be a local-variables section,
3560 ;; so just ignore it.
3570 ;; Discard the prefix.
3575 ;; Discard the suffix.
3584 ;; Find the variable name;
3592 val val2)
3595 ;; Read the variable value.
3602 ;; Specifying minor-modes via mode: is
3603 ;; deprecated, but try to reject them anyway.
3613 'files
3615 "%s: `lexical-binding' at end of file unreliable"
3617 ;; We are called from
3618 ;; 'with-temp-buffer', so we need
3619 ;; to use 'thisbuf's name in the
3620 ;; warning message.
3626 'eval
3630 ;; Now we've read all the local variables.
3631 ;; If HANDLE-MODE is t, return whether the mode was specified.
3633 ;; Otherwise, set the variables.
3638 "Apply the elements of `file-local-variables-alist'.
3639 If there are any elements, runs `before-hack-local-variables-hook',
3640 then calls `hack-one-local-variable' to apply the alist elements one by one.
3641 Finishes by running `hack-local-variables-hook', regardless of whether
3642 the alist is empty or not.
3644 Note that this function ignores a `mode' entry if it specifies the same
3645 major mode as the buffer already has."
3647 ;; Any 'evals must run in the Right sequence.
3656 "Non-nil if SYM is safe as a file-local variable with value VAL.
3657 It is safe if any of these conditions are met:
3659 * There is a matching entry (SYM . VAL) in the
3660 `safe-local-variable-values' user option.
3662 * The `safe-local-variable' property of SYM is a function that
3663 evaluates to a non-nil value with VAL as an argument."
3667 ;; If the function signals an error, that means it
3668 ;; can't assure us that the value is safe.
3672 "Non-nil if SYM could be dangerous as a file-local variable.
3673 It is dangerous if either of these conditions are met:
3675 * Its `risky-local-variable' property is non-nil.
3681 ;; If this is an alias, check the base name.
3701 "Return t if it is safe to eval EXP when it is found in a file."
3703 ;; Detect certain `put' expressions.
3710 lisp-indent-function
3711 scheme-indent-function))
3712 ;; Only allow safe values (not functions).
3717 ;; Only allow indirect form specs.
3718 ;; During bootstrapping, edebug-basic-spec might not be
3719 ;; defined yet.
3723 ;; Allow expressions that the user requested.
3725 ;; Certain functions can be allowed with safe arguments
3726 ;; or can specify verification functions to try.
3728 ;; Allow (minor)-modes calls with no arguments.
3729 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3738 ok))
3746 ok))))))))
3760 "Set local variable VAR with value VAL.
3761 If VAR is `mode', call `VAL-mode' as a function unless it's
3762 already the major mode."
3764 (`mode
3770 (`eval
3776 ;; Make sure the string has no text properties.
3777 ;; Some text properties can get evaluated in various ways,
3778 ;; so it is risky to put them on with a local variable list.
3782 \f
3783 ;;; Handling directory-local variables, aka project settings.
3789 "List of cached directory roots for directory-local variable classes.
3790 Each element in this list has the form (DIR CLASS MTIME).
3791 DIR is the name of the directory.
3792 CLASS is the name of a variable class (a symbol).
3793 MTIME is the recorded modification time of the directory-local
3794 variables file associated with this entry. This time is a list
3795 of integers (the same format as `file-attributes'), and is
3796 used to test whether the cache entry is still valid.
3797 Alternatively, MTIME can be nil, which means the entry is always
3801 "Return the variable list for CLASS."
3805 "Collect directory-local variables from MODE-VARIABLES.
3806 VARIABLES is the initial list of variables.
3807 Returns the new list."
3812 ;; If variables are specified more than once, only use the last. (Why?)
3813 ;; The pseudo-variables mode and eval are different (bug#3430).
3816 ;; Need a new cons in case we setcdr later.
3820 "Collect entries from CLASS-VARIABLES into VARIABLES.
3821 ROOT is the root directory of the project.
3822 Return the new variables list."
3824 ;; Handle non-file buffers, too.
3828 ;; FIXME: Why not use file-relative-name?
3835 ;; Don't include this in the previous condition, because we
3836 ;; want to filter all strings before the next condition.
3850 ;; TODO someone might want to extend this to allow
3851 ;; integer values for subdir, where N means
3852 ;; variables apply to this directory and N levels
3853 ;; below it (0 == nil).
3856 alist variables))))))))
3858 ;; The file's content might be invalid (e.g. have a merge conflict), but
3859 ;; that shouldn't prevent the user from opening the file.
3861 nil))))
3864 "Declare that the DIRECTORY root is an instance of CLASS.
3865 DIRECTORY is the name of a directory, a string.
3866 CLASS is the name of a project class, a symbol.
3867 MTIME is either the modification time of the directory-local
3868 variables file that defined this class, or nil.
3870 When a file beneath DIRECTORY is visited, the mode-specific
3871 variables from CLASS are applied to the buffer. The variables
3872 for a class are defined using `dir-locals-set-class-variables'."
3879 "Map the type CLASS to a list of variable settings.
3880 CLASS is the project class, a symbol. VARIABLES is a list
3881 that declares directory-local variables for the class.
3882 An element in VARIABLES is either of the form:
3883 (MAJOR-MODE . ALIST)
3884 or
3885 (DIRECTORY . LIST)
3887 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3888 whose elements are of the form (VARIABLE . VALUE).
3890 In the second form, DIRECTORY is a directory name (a string), and
3891 LIST is a list of the form accepted by the function.
3893 When a file is visited, the file's class is found. A directory
3894 may be assigned a class using `dir-locals-set-directory-class'.
3895 Then variables are set in the file's buffer according to the
3896 VARIABLES list of the class. The list is processed in order.
3898 * If the element is of the form (MAJOR-MODE . ALIST), and the
3899 buffer's major mode is derived from MAJOR-MODE (as determined
3900 by `derived-mode-p'), then all the variables in ALIST are
3901 applied. A MAJOR-MODE of nil may be used to match any buffer.
3902 `make-local-variable' is called for each variable before it is
3903 set.
3905 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3906 is an initial substring of the file's directory, then LIST is
3907 applied by recursively following these rules."
3911 "File that contains directory-local variables.
3912 It has to be constant to enforce uniform values across different
3913 environments and users.
3915 A second dir-locals file can be used by a user to specify their
3916 personal dir-local variables even if the current directory
3917 already has a `dir-locals-file' that is shared with other
3918 users (such as in a git repository). The name of this second
3920 `dir-locals-file'. With the default value of `dir-locals-file',
3927 "Return a list of all readable dir-locals files in DIRECTORY.
3928 The returned list is sorted by increasing priority. That is,
3929 values specified in the last file should take precedence over
3930 those in the first."
3934 dir-locals-file)
3935 directory))
3939 ;; The order here is important.
3946 out)))
3949 "Find the directory-local variables for FILE.
3950 This searches upward in the directory tree from FILE.
3951 It stops at the first directory that has been registered in
3952 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3953 If it finds an entry in the cache, it checks that it is valid.
3954 A cache entry with no modification time element (normally, one that
3955 has been assigned directly using `dir-locals-set-directory-class', not
3956 set from a file) is always valid.
3957 A cache entry based on a `dir-locals-file' is valid if the modification
3958 time stored in the cache matches the current file modification time.
3959 If not, the cache entry is cleared so that the file will be re-read.
3961 This function returns either:
3962 - nil (no directory local variables found),
3963 - the matching entry from `dir-locals-directory-cache' (a list),
3964 - or the full path to the directory (a string) containing at
3965 least one `dir-locals-file' in the case of no valid cache
3966 entry."
3970 dir-elt)
3971 ;; `locate-dominating-file' may have abbreviated the name.
3974 ;; Find the best cached value in `dir-locals-directory-cache'.
3985 ;; Found a potential cache entry. Check validity.
3986 ;; A cache entry with no MTIME is assumed to always be valid
3987 ;; (ie, set directly, not from a dir-locals file).
3988 ;; Note, we don't bother to check that there is a matching class
3989 ;; element in dir-locals-class-alist, since that's done by
3990 ;; dir-locals-set-directory-class.
3993 ;; The entry MTIME should match the most recent
3994 ;; MTIME among matching files.
4002 ;; This cache entry is OK.
4003 dir-elt
4004 ;; This cache entry is invalid; clear it.
4007 ;; Return the first existing dir-locals file. Might be the same
4008 ;; as dir-elt's, might not (eg latter might have been deleted).
4009 locals-dir)
4010 ;; No cache entry.
4011 locals-dir)))
4014 "Load all variables files in DIR and register a new class and instance.
4015 DIR is the absolute name of a directory which must contain at
4016 least one dir-local file (which is a file holding variables to
4017 apply).
4018 Return the new class name, which is a symbol named DIR."
4023 ;; If there was a problem, use the values we could get but
4024 ;; don't let the cache prevent future reads.
4037 variables
4043 class-name))
4049 "Non-nil means dir-local variables will be applied to remote files."
4057 "Read per-directory local variables for the current buffer.
4058 Store the directory-local variables in `dir-local-variables-alist'
4059 and `file-local-variables-alist', without applying them.
4061 This does nothing if either `enable-local-variables' or
4062 `enable-dir-local-variables' are nil."
4064 enable-dir-local-variables
4067 default-directory)))))
4068 ;; Find the variables file.
4098 "Apply directory-local variables to a non-file buffer.
4099 For non-file buffers, such as Dired buffers, directory-local
4100 variables are looked for in `default-directory' and its parent
4101 directories."
4105 \f
4108 However, the mode will not be changed if
4109 \(1) a local variables list or the `-*-' line specifies a major mode, or
4111 not suitable for ordinary files, or
4112 \(3) the new file name does not particularly specify any mode."
4117 "Change name of file visited in current buffer to FILENAME.
4118 This also renames the buffer to correspond to the new file.
4119 The next time the buffer is saved it will go in the newly specified file.
4120 FILENAME nil or an empty string means mark buffer as not visiting any file.
4121 Remember to delete the initial contents of the minibuffer
4122 if you wish to pass an empty string as the argument.
4124 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4125 confirmation in the case where another buffer is already visiting FILENAME.
4127 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4128 the old visited file has been renamed to the new name FILENAME."
4136 nil
4151 filename)))
4158 buffer-file-name filename)
4162 ;; If new-name == old-name, renaming would add a spurious <2>
4163 ;; and it's considered as a feature in rename-buffer.
4169 ;; Abbreviate the file names of the buffer.
4178 nil))
4179 ;; write-file-functions is normally used for things like ftp-find-file
4180 ;; that visit things that are not local files as if they were files.
4181 ;; Changing to visit an ordinary local file instead should flush the hook.
4186 ;; If buffer was read-only because of version control,
4187 ;; that reason is gone now, so make it writable.
4191 ;; Turn off backup files for certain file names.
4192 ;; Since this is a permanent local, the major mode won't eliminate it.
4194 backup-enable-predicate
4203 ;; If auto-save was not already on, turn it on if appropriate.
4206 ;; If auto save is on, start using a new name. We
4207 ;; deliberately don't rename or delete the old auto save
4208 ;; for the old visited file name. This is because
4209 ;; perhaps the user wants to save the new state and then
4210 ;; compare with the previous state from the auto save
4211 ;; file.
4213 ;; Rename the old auto save file if any.
4220 ;; Update the major mode, if the file name determines it.
4222 ;; Don't change the mode if it is special.
4225 ;; Don't change the mode if the local variable list specifies it.
4226 ;; The file name can influence whether the local variables apply.
4228 ;; h-l-v also checks it, but might as well be explicit.
4231 ;; TODO consider making normal-mode handle this case.
4239 "Write current buffer into file FILENAME.
4240 This makes the buffer visit that file, and marks it as not modified.
4242 If you specify just a directory name as FILENAME, that means to use
4243 the default file name but in that directory. You can also yank
4244 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4246 If the buffer is not already visiting a file, the default file name
4247 for the output file is the buffer name.
4249 If optional second arg CONFIRM is non-nil, this function
4250 asks for confirmation before overwriting an existing file.
4251 Interactively, confirmation is required unless you supply a prefix argument."
4252 ;; (interactive "FWrite file: ")
4256 nil nil nil nil)
4260 default-directory)
4261 nil nil))
4265 ;; If arg is a directory name,
4266 ;; use the default file name, but in that directory.
4273 ;; NS does its own confirm dialog.
4276 use-dialog-box))
4282 ;; Make buffer writable if file is writable.
4287 ;; It's likely that the VC status at the new location is different from
4288 ;; the one at the old location.
4290 \f
4292 "Return an alist of extended attributes of file FILENAME.
4294 Extended attributes are platform-specific metadata about the file,
4295 such as SELinux context, list of ACL entries, etc."
4300 "Set extended attributes of file FILENAME to ATTRIBUTES.
4302 ATTRIBUTES must be an alist of file attributes as returned by
4303 `file-extended-attributes'.
4304 Value is t if the function succeeds in setting the attributes."
4315 result))
4316 \f
4318 "Make a backup of the disk file visited by the current buffer, if appropriate.
4319 This is normally done before saving the buffer the first time.
4321 A backup may be done by renaming or by copying; see documentation of
4322 variable `make-backup-files'. If it's done by renaming, then the file is
4323 no longer accessible under its old name.
4325 The value is non-nil after a backup was made by renaming.
4326 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4327 MODES is the result of `file-modes' on the original
4328 file; this means that the caller, after saving the buffer, should change
4329 the modes of the new file to agree with the old modes.
4330 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4331 on the original file; this means that the caller, after saving
4332 the buffer, should change the extended attributes of the new file
4333 to agree with the old attributes.
4334 BACKUPNAME is the backup file name, which is the old file renamed."
4338 ;; If specified name is a symbolic link, chase it to the target.
4339 ;; This makes backups in the directory where the real file is.
4346 ;; If have old versions to maybe delete,
4347 ;; ask the user to confirm now, before doing anything.
4348 ;; But don't actually delete til later.
4354 real-file-name)))
4355 targets))
4360 backup-by-copying-when-privileged-mismatch)
4363 ;; Don't rename a suid or sgid file.
4372 real-file-name
4375 copy-when-priv-mismatch))))
4377 t)))))
4378 setmodes)
4381 ;; Actually make the backup file.
4384 modes extended-attributes)
4385 ;; rename-file should delete old backup.
4388 backupname)))
4390 ;; Now delete the old versions, if desired.
4394 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4398 backupname)
4401 modes extended-attributes)
4403 setmodes)))))))
4406 ;; Create temp files with strict access rights. It's easy to
4407 ;; loosen them later, whereas it's impossible to close the
4408 ;; time-window of loose permissions otherwise.
4411 ;; Try to overwrite old backup first.
4419 nil)
4421 ;; The file was somehow created by someone else between
4422 ;; `delete-file' and `copy-file', so let's try again.
4423 ;; rms says "I think there is also a possible race
4424 ;; condition for making backup files" (emacs-devel 20070821).
4425 nil)))
4426 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4435 ;; The last ~[[:digit]]+ matches relative versions in git,
4436 ;; e.g. `foo.js.~HEAD~1~'.
4437 "Regular expression matching the backup/version part of a file name.
4441 "Return file NAME sans backup versions or strings.
4442 This is a separate procedure so your site-init or startup file can
4443 redefine it.
4444 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4445 we do not remove backup version numbers, only true file version numbers.
4446 See also `file-name-version-regexp'."
4453 name))))))
4456 "Return t if deleting FILE and rewriting it would preserve the owner.
4457 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4458 the group would be preserved too."
4463 ;; Return t if the file doesn't exist, since it's true that no
4464 ;; information would be lost by an (attempted) delete and create.
4467 ;; Files created on Windows by Administrator (RID=500)
4468 ;; have the Administrators group (RID=544) recorded as
4469 ;; their owner. Rewriting them will still preserve the
4470 ;; owner.
4474 ;; On BSD-derived systems files always inherit the parent
4475 ;; directory's group, so skip the group-gid test.
4481 ;; On some systems, a file created in a setuid directory
4482 ;; inherits that directory's owner.
4486 ;; On many systems, a file created in a setgid directory
4487 ;; inherits that directory's group. On some systems
4488 ;; this happens even if the setgid bit is not set.
4495 The extension, in a file name, is the part that begins with the last `.',
4496 except that a leading `.' of the file name, if there is one, doesn't count."
4499 directory)
4503 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4504 ;; we don't want to expand it.
4507 filename))))
4511 The extension, in a file name, is the part that begins with the last `.',
4512 excluding version numbers and backup suffixes, except that a leading `.'
4513 of the file name, if there is one, doesn't count.
4514 Return nil for extensionless file names such as `foo'.
4515 Return the empty string for file names such as `foo.'.
4517 By default, the returned value excludes the period that starts the
4518 extension, but if the optional argument PERIOD is non-nil, the period
4519 is included in the value, and in that case, if FILENAME has no
4530 "Return the base name of the FILENAME: no directory, no extension.
4531 FILENAME defaults to `buffer-file-name'."
4536 #'make-backup-file-name--default-function
4537 "A function that `make-backup-file-name' uses to create backup file names.
4538 The function receives a single argument, the original file name.
4540 If you change this, you may need to change `backup-file-name-p' and
4541 `file-name-sans-versions' too.
4543 You could make this buffer-local to do something special for specific files.
4545 For historical reasons, a value of nil means to use the default function.
4546 This should not be relied upon.
4548 See also `backup-directory-alist'."
4555 "Alist of filename patterns and backup directory names.
4556 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4557 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4558 relative or absolute. If it is absolute, so that all matching files
4559 are backed up into the same directory, the file names in this
4560 directory will be the full name of the file backed up with all
4561 directory separators changed to `!' to prevent clashes. This will not
4562 work correctly if your filesystem truncates the resulting name.
4564 For the common case of all backups going into one directory, the alist
4566 directory name.
4568 If this variable is nil, or it fails to match a filename, the backup
4569 is made in the original file's directory.
4571 On MS-DOS filesystems without long names this variable is always
4572 ignored."
4578 "Default `backup-enable-predicate' function.
4579 Checks for files in `temporary-file-directory',
4582 caseless)
4583 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4584 ;; their long file-name equivalents, so compare-strings does TRT.
4588 caseless t))
4591 ;; Directory is under temporary-file-directory.
4596 ;; Directory is under /tmp.
4601 0 nil
4603 ;; Directory is under small-temporary-file-directory.
4608 "Create the non-numeric backup file name for FILE.
4609 This calls the function that `make-backup-file-name-function' specifies,
4610 with a single argument FILE."
4613 file))
4616 "Default function for `make-backup-file-name'.
4617 Normally this just returns FILE's name with `~' appended.
4618 It searches for a match for FILE in `backup-directory-alist'.
4619 If the directory for the backup doesn't exist, it is created."
4631 "Subroutine of `make-backup-file-name--default-function'.
4632 The function `find-backup-file-name' also uses this."
4634 elt backup-directory abs-backup-directory)
4639 alist nil)))
4640 ;; If backup-directory is relative, it should be relative to the
4641 ;; file's directory. By expanding explicitly here, we avoid
4642 ;; depending on default-directory.
4651 abs-backup-directory nil))))
4653 file
4657 ;; Normalize DOSish file names: downcase the drive
4658 ;; letter, if any, and replace the leading "x:" with
4659 ;; "/drive_x".
4664 ;; Remove the leading slash, if any, to prevent
4665 ;; convert-standard-filename from converting that to a
4666 ;; backslash.
4669 ;; Replace any invalid file-name characters, then
4670 ;; prepend the leading slash back.
4673 ;; Replace any invalid file-name characters.
4677 "drive_"
4680 ""
4683 ;; Make the name unique by substituting directory
4684 ;; separators. It may not really be worth bothering about
4685 ;; doubling `!'s in the original name...
4690 backup-directory))
4695 "Return non-nil if FILE is a backup file name (numeric or not).
4696 This is a separate function so you can redefine it for customization.
4697 You may need to redefine `file-name-sans-versions' as well."
4702 ;; This is used in various files.
4703 ;; The usage of backup-extract-version-start is not very clean,
4704 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4706 "Given the name of a numeric backup file, FN, return the backup number.
4707 Uses the free variable `backup-extract-version-start', whose value should be
4708 the index in the name where the version number begins."
4715 "Find a file name for a backup file FN, and suggestions for deletions.
4716 Value is a list whose car is the name for the backup file
4717 and whose cdr is a list of old versions to consider deleting now.
4718 If the value is nil, don't make a backup.
4719 Uses `backup-directory-alist' in the same way as
4720 `make-backup-file-name--default-function' does."
4722 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4726 ;; We don't support numbered backups on plain MS-DOS
4727 ;; when long file names are unavailable.
4737 possibilities deserve-versions-p versions)
4740 base-versions
4743 possibilities)
4744 #'<)
4749 kept-old-versions
4750 kept-new-versions
4757 ;; Delete nothing if there is overflow
4758 ;; in the number of versions to keep.
4764 v))))))))))
4767 "Return number of names file FILENAME has."
4771 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4772 This function returns a relative file name which is equivalent to FILENAME
4773 when used with that default directory as the default.
4774 If FILENAME is a relative file name, it will be interpreted as existing in
4775 `default-directory'.
4776 If FILENAME and DIRECTORY lie on different machines or on different drives
4777 on a DOS/Windows machine, it returns FILENAME in expanded form."
4781 default-directory))))
4786 read-file-name-completion-ignore-case)))
4789 ;; Test for different filesystems on DOS/Windows
4791 ;; Should `cygwin' really be included here? --stef
4794 ;; Test for different drive letters
4796 ;; Test for UNCs on different servers
4801 ;; Windows file names cannot have ? in
4802 ;; them, so use that to detect when
4803 ;; neither FILENAME nor DIRECTORY is a
4804 ;; UNC.
4806 0 nil
4812 ;; Test for different remote file system identification
4814 filename
4822 ".."
4824 ;; Now ancestor is empty, or .., or ../.., etc.
4826 ;; We matched within FILENAME's directory part.
4827 ;; Add the rest of FILENAME onto ANCESTOR.
4830 ;; But don't bother with ANCESTOR if it would give us `./'.
4831 rest
4833 ;; We matched FILENAME's directory equivalent.
4834 ancestor))))))
4835 \f
4837 "Save current buffer in visited file if modified.
4838 Variations are described below.
4840 By default, makes the previous version into a backup file
4841 if previously requested or if this is the first save.
4843 to become a backup when the next save is done.
4845 makes the previous version into a backup file.
4847 to become a backup when the next save is done,
4848 and makes the previous version into a backup file.
4850 With a numeric prefix argument of 0, never make the previous version
4851 into a backup file.
4853 Note that the various variables that control backups, such
4854 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4855 and `backup-inhibited', to name just the more popular ones, still
4856 control whether a backup will actually be produced, even when you
4859 If a file's name is FOO, the names of its numbered backup versions are
4860 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4861 Numeric backups (rather than FOO~) will be made if value of
4862 `version-control' is not the atom `never' and either there are already
4863 numeric versions of the file being backed up, or `version-control' is
4864 non-nil.
4865 We don't want excessive versions piling up, so there are variables
4866 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4867 and `kept-new-versions', which tells how many newest versions to keep.
4868 Defaults are 2 old versions and 2 new.
4869 `dired-kept-versions' controls dired's clean-directory (.) command.
4870 If `delete-old-versions' is nil, system will query user
4871 before trimming versions. Otherwise it does it silently.
4873 If `vc-make-backup-files' is nil, which is the default,
4874 no backup files are made for files managed by version control.
4875 (This is because the version control system itself records previous versions.)
4877 See the subroutine `basic-save-buffer' for more information."
4883 ;; We used to display the message below only for files > 50KB, but
4884 ;; then Rmail-mbox never displays it due to buffer swapping. If
4885 ;; the test is ever re-introduced, be sure to handle saving of
4886 ;; Rmail files.
4896 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4897 Normally delete only if the file was written by this Emacs since
4898 the last real save, but optional arg FORCE non-nil means delete anyway."
4912 "Normal hook that is run before a buffer is saved to its file.
4913 Only used by `save-buffer'."
4919 "Normal hook that is run after a buffer is saved to its file.
4920 Only used by `save-buffer'."
4926 "If non-nil, use this coding system for saving the buffer.
4927 More precisely, use this coding system in place of the
4928 value of `buffer-file-coding-system', when saving the buffer.
4929 Calling `write-region' for any purpose other than saving the buffer
4930 will still use `buffer-file-coding-system'; this variable has no effect
4937 "Save the current buffer in its visited file, if it has been modified.
4939 The hooks `write-contents-functions', `local-write-file-hooks'
4940 and `write-file-functions' get a chance to do the job of saving;
4941 if they do not, then the buffer is saved in the visited file in
4942 the usual way.
4944 Before and after saving the buffer, this function runs
4945 `before-save-hook' and `after-save-hook', respectively."
4948 ;; In an indirect buffer, save its base buffer instead.
4952 ;; Handle the case when no modification has been made but
4953 ;; the file disappeared since visited.
4957 setmodes)
4963 "%s has changed since visited or saved. Save anyway? "
4984 ;; Don't let errors prevent saving the buffer.
4986 ;; Give `write-contents-functions' a chance to
4987 ;; short-circuit the whole process.
4989 ;; If buffer has no file name, ask user for one.
4997 ;; Signal an error if the user specified the name of an
4998 ;; existing directory.
5001 "File `%s' exists; overwrite? "
5002 filename))
5005 ;; Support VC version backups.
5009 ;; If a hook returned t, file is already "written".
5010 ;; Otherwise, write it the usual way now.
5020 ;; Now we have saved the current buffer. Let's make sure
5021 ;; that buffer-file-coding-system is fixed to what
5022 ;; actually used for saving by binding it locally.
5038 ;; Support VC `implicit' locking.
5040 ;; If the auto-save file was recent before this command,
5041 ;; delete it now.
5048 ;; This does the "real job" of writing a buffer into its visited file
5049 ;; and making a backup file. This is what is normally done
5050 ;; but inhibited if one of write-file-functions returns non-nil.
5051 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5052 ;; backup-buffer.
5062 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5063 ;; backup-buffer.
5076 "File %s is write-protected; try to save anyway? "
5078 buffer-file-name)))
5092 dir))))
5093 ;; Write temp name, then rename it.
5094 ;; This requires write access to the containing dir,
5095 ;; which is why we don't try it if we don't have that access.
5097 tempname
5099 ;; Create temp files with strict access rights. It's easy to
5100 ;; loosen them later, whereas it's impossible to close the
5101 ;; time-window of loose permissions otherwise.
5105 ;; Call write-region in the appropriate way
5106 ;; for saving the buffer.
5110 ;; Pass in nil&nil rather than point-min&max
5111 ;; cause we're saving the whole buffer.
5112 ;; write-region-annotate-functions may use it.
5114 buffer-file-truename)
5116 ;; If we failed, restore the buffer's modtime.
5119 ;; Since we have created an entirely new file,
5120 ;; make sure it gets the right permission bits set.
5125 buffer-file-name)))
5126 ;; We succeeded in writing the temp file,
5127 ;; so rename it.
5129 ;; If file not writable, see if we can make it writable
5130 ;; temporarily while we write it.
5131 ;; But no need to do so if we have just backed it up
5132 ;; (setmodes is set) because that says we're superseding.
5134 ;; Change the mode back, after writing.
5137 buffer-file-name))
5138 ;; If set-file-extended-attributes fails, fall back on
5139 ;; set-file-modes.
5149 ;; Pass in nil&nil rather than point-min&max to indicate
5150 ;; we're saving the buffer rather than just a region.
5151 ;; write-region-annotate-functions may make use of it.
5153 buffer-file-name nil t buffer-file-truename)
5156 ;; If we get an error writing the new file, and we made
5157 ;; the backup by renaming, undo the backing-up.
5162 setmodes))
5168 `((?\C-r
5175 ;; Return nil to ask about BUF again.
5176 nil)
5189 ;; Return nil to ask about BUF again.
5190 nil)
5200 "Default predicate for `save-some-buffers'.
5201 This allows you to stop `save-some-buffers' from asking
5202 about certain files that you'd usually rather not save."
5204 ;; FIXME nil should not be a valid option, let alone the default,
5205 ;; eg so that add-function can be used.
5210 "Save some modified file-visiting buffers. Asks user about each one.
5211 You can answer `y' to save, `n' not to save, `C-r' to look at the
5212 buffer in question with `view-buffer' before deciding or `d' to
5213 view the differences using `diff-buffer-with-file'.
5215 This command first saves any buffers where `buffer-save-without-query' is
5216 non-nil, without asking.
5218 Optional argument ARG (interactively, prefix argument) non-nil means save
5219 all with no questions.
5220 Optional second argument PRED determines which buffers are considered:
5221 If PRED is nil, all the file-visiting buffers are considered.
5222 If PRED is t, then certain non-file buffers will also be considered.
5223 If PRED is a zero-argument function, it indicates for each buffer whether
5224 to consider it or not when called with that buffer current.
5225 PRED defaults to the value of `save-some-buffers-default-predicate'.
5227 See `save-some-buffers-action-alist' if you want to
5228 change the additional actions you can take on files."
5234 files-done abbrevs-done)
5236 ;; First save any buffers that we're supposed to save unconditionally.
5237 ;; That way the following code won't ask about them.
5242 ;; Ask about those buffers that merit it,
5243 ;; and record the number thus saved.
5247 ;; Note that killing some buffers may kill others via
5248 ;; hooks (e.g. Rmail and its viewing buffer).
5260 t
5272 save-some-buffers-action-alist))
5273 ;; Maybe to save abbrevs, and record whether
5274 ;; we either saved them or asked to.
5281 ;; Don't keep bothering user if he says no.
5295 \f
5297 "Clear out records of last mod time of visited file.
5298 Next attempt to save will not complain of a discrepancy."
5302 "Mark current buffer as unmodified, not needing to be saved.
5305 It is not a good idea to use this function in Lisp programs, because it
5306 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5314 "Change whether this buffer is read-only."
5322 "Insert contents of file FILENAME into buffer after point.
5323 Set mark after the inserted text.
5325 This function is meant for the user to run interactively.
5326 Don't call it from programs! Use `insert-file-contents' instead.
5327 \(Its calling sequence is different; see its documentation)."
5333 "Append the contents of the region to the end of file FILENAME.
5334 When called from a function, expects three arguments,
5335 START, END and FILENAME. START and END are normally buffer positions
5336 specifying the part of the buffer to write.
5337 If START is nil, that means to use the entire buffer contents.
5338 If START is a string, then output that string to the file
5339 instead of any buffer contents; END is ignored.
5341 This does character code conversion and applies annotations
5342 like `write-region' does."
5348 "Return most recent backup file for FILENAME or nil if no backups exist."
5349 ;; `make-backup-file-name' will get us the right directory for
5350 ;; ordinary or numeric backups. It might create a directory for
5351 ;; backups as a side-effect, according to `backup-directory-alist'.
5358 tem)
5367 newest))
5370 "Rename current buffer to a similar name not already taken.
5371 This function is useful for creating multiple shell process buffers
5372 or multiple mail buffers, etc.
5374 Note that some commands, in particular those based on `compilation-mode'
5375 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5376 appropriate mode even if it has been renamed. So as well as renaming
5377 the buffer, you also need to switch buffers before running another
5378 instance of such commands."
5386 ;; If the existing buffer name has a <NNN>,
5387 ;; which isn't part of the file name (if any),
5388 ;; then get rid of that.
5394 "Make directory DIR if it is not already a directory. Return nil."
5402 "Create the directory DIR and optionally any nonexistent parent dirs.
5403 If DIR already exists as a directory, signal an error, unless
5404 PARENTS is non-nil.
5406 Interactively, the default choice of directory to create is the
5407 current buffer's default directory. That is useful when you have
5408 visited a file in a nonexistent directory.
5410 Noninteractively, the second (optional) argument PARENTS, if
5411 non-nil, says whether to create parent directories that don't
5412 exist. Interactively, this happens by default.
5414 If creating the directory or directories fail, an error will be
5415 raised."
5418 nil nil)
5419 t))
5420 ;; If default-directory is a remote directory,
5421 ;; make sure we find its make-directory handler.
5429 create-list parent)
5436 ;; Do not loop if root does not exist (Bug#2309).
5439 dir parent))
5448 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5449 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5450 non-nil and if FN fails due to a missing file or directory."
5456 "Delete the directory named DIRECTORY. Does not follow symlinks.
5457 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5458 no error if something else is simultaneously deleting them.
5459 TRASH non-nil means to trash the directory instead, provided
5460 `delete-by-moving-to-trash' is non-nil.
5462 When called interactively, TRASH is nil if and only if a prefix
5463 argument is given, and a further prompt asks the user for
5464 RECURSIVE if DIRECTORY is nonempty."
5471 "Move directory to trash: "
5473 default-directory default-directory nil nil))))
5479 nil)
5481 ;; If default-directory is a remote directory, make sure we find its
5482 ;; delete-directory handler.
5489 ;; Only move non-empty dir to trash if recursive deletion was
5490 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5491 ;; case, where the operation fails in delete-directory-internal.
5492 ;; As `move-file-to-trash' trashes directories (empty or
5493 ;; otherwise) as a unit, we do not need to recurse here.
5495 ;; Check if directory is empty apart from "." and "..".
5500 ;; Otherwise, call ourselves recursively if needed.
5505 directory-files-no-dot-files-regexp))
5509 ;; This test is equivalent to but more efficient
5510 ;; than (and (file-directory-p fn)
5511 ;; (not (file-symlink-p fn))).
5515 files))
5516 directory-exists))
5520 "Return non-nil if files FILE1 and FILE2 name the same file.
5521 If FILE1 or FILE2 does not exist, the return value is unspecified."
5532 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5534 Return nil if DIR is not an existing directory."
5546 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5561 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5562 This function always sets the file modes of the output files to match
5563 the corresponding input file.
5565 The third arg KEEP-TIME non-nil means give the output files the same
5566 last-modified time as the old ones. (This works on only some systems.)
5568 A prefix arg makes KEEP-TIME non-nil.
5570 Noninteractively, the last argument PARENTS says whether to
5571 create parent directories if they don't exist. Interactively,
5572 this happens by default.
5574 If NEWNAME is a directory name, copy DIRECTORY as a subdirectory
5575 there. However, if called from Lisp with a non-nil optional
5576 argument COPY-CONTENTS, copy the contents of DIRECTORY directly
5577 into NEWNAME instead."
5584 default-directory default-directory nil nil)
5585 current-prefix-arg t nil)))
5588 directory newname))
5589 ;; If default-directory is a remote directory, make sure we find its
5590 ;; copy-directory handler.
5595 newname keep-time parents copy-contents)
5597 ;; Compute target name.
5602 ;; If NEWNAME is not a directory name, create it;
5603 ;; that is where we will copy the files of DIRECTORY.
5605 ;; NEWNAME is a directory name. If COPY-CONTENTS is non-nil,
5606 ;; create NEWNAME if it is not already a directory;
5607 ;; otherwise, create NEWNAME/[DIRECTORY-BASENAME].
5614 ;; Copy recursively.
5616 ;; We do not want to copy "." and "..".
5618 directory-files-no-dot-files-regexp))
5629 ;; Set directory attributes.
5635 \f
5636 ;; At time of writing, only info uses this.
5638 "Return a copy of DIRS with all non-existent directories removed.
5639 The optional argument KEEP is a list of directories to retain even if
5640 they don't exist, and REJECT is a list of directories to remove from
5641 DIRS, even if they exist; REJECT takes precedence over KEEP.
5643 Note that membership in REJECT and KEEP is checked using simple string
5644 comparison."
5650 dirs)))
5652 \f
5655 "Function to use to revert this buffer.
5656 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5657 which are the arguments that `revert-buffer' received.
5658 It also has access to the `preserve-modes' argument of `revert-buffer'
5659 via the `revert-buffer-preserve-modes' dynamic variable.
5661 For historical reasons, a value of nil means to use the default function.
5666 #'revert-buffer-insert-file-contents--default-function
5667 "Function to use to insert contents when reverting this buffer.
5668 The function receives two arguments: the first the nominal file name to use;
5669 the second is t if reading the auto-save file.
5671 The function is responsible for updating (or preserving) point.
5673 For historical reasons, a value of nil means to use the default function.
5677 "Default function to use for `buffer-stale-function'.
5678 This function ignores its argument.
5679 This returns non-nil if the current buffer is visiting a readable file
5680 whose modification time does not match that of the buffer.
5682 This function only handles buffers that are visiting files.
5683 Non-file buffers need a custom function"
5690 "Function to check whether a buffer needs reverting.
5691 This should be a function with one optional argument NOCONFIRM.
5692 Auto Revert Mode passes t for NOCONFIRM. The function should return
5693 non-nil if the buffer should be reverted. A return value of
5694 `fast' means that the need for reverting was not checked, but
5695 that reverting the buffer is fast. The buffer is current when
5696 this function is called.
5698 The idea behind the NOCONFIRM argument is that it should be
5699 non-nil if the buffer is going to be reverted without asking the
5700 user. In such situations, one has to be careful with potentially
5701 time consuming operations.
5703 For historical reasons, a value of nil means to use the default function.
5704 This should not be relied upon.
5706 For more information on how this variable is used by Auto Revert mode,
5710 "Normal hook for `revert-buffer' to run before reverting.
5711 The function `revert-buffer--default' runs this.
5715 "Normal hook for `revert-buffer' to run after reverting.
5716 Note that the hook value that it runs is the value that was in effect
5717 before reverting; that makes a difference if you have buffer-local
5718 hook functions.
5720 The function `revert-buffer--default' runs this.
5728 ;; `revert-buffer-function' was defined long ago to be a function of only
5729 ;; 2 arguments, so we have to use a dynbind variable to pass the
5730 ;; `preserve-modes' argument of `revert-buffer'.
5734 "Replace current buffer text with the text of the visited file on disk.
5735 This undoes all changes since the file was visited or saved.
5736 With a prefix argument, offer to revert from latest auto-save file, if
5737 that is more recent than the visited file.
5739 This command also implements an interface for special buffers
5740 that contain text which doesn't come from a file, but reflects
5741 some other data instead (e.g. Dired buffers, `buffer-list'
5742 buffers). This is done via the variable `revert-buffer-function'.
5743 In these cases, it should reconstruct the buffer contents from the
5744 appropriate data.
5746 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5747 to revert from the auto-save file when this is nil. Note that the
5748 sense of this argument is the reverse of the prefix argument, for the
5749 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5750 to nil.
5752 Optional second argument NOCONFIRM means don't ask for confirmation
5753 at all. (The variable `revert-without-query' offers another way to
5754 revert buffers without querying for confirmation.)
5756 Optional third argument PRESERVE-MODES non-nil means don't alter
5757 the files modes. Normally we reinitialize them using `normal-mode'.
5759 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5761 This function calls the function that `revert-buffer-function' specifies
5762 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5763 The default function runs the hooks `before-revert-hook' and
5764 `after-revert-hook'."
5765 ;; I admit it's odd to reverse the sense of the prefix argument, but
5766 ;; there is a lot of code out there which assumes that the first
5767 ;; argument should be t to avoid consulting the auto-save file, and
5768 ;; there's no straightforward way to encourage authors to notice a
5769 ;; reversal of the argument sense. So I'm just changing the user
5770 ;; interface, but leaving the programmatic interface the same.
5775 ignore-auto noconfirm)))
5778 "Default function for `revert-buffer'.
5779 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5780 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5781 start and end.
5783 Calls `revert-buffer-insert-file-contents-function' to reread the
5784 contents of the visited file, with two arguments: the first is the file
5785 name, the second is non-nil if reading an auto-save file.
5787 This function only handles buffers that are visiting files.
5788 Non-file buffers need a custom function."
5793 buffer-auto-save-file-name
5798 buffer-auto-save-file-name
5799 buffer-file-name)))
5809 file-name)))
5811 ;; If file was backed up but has changed since,
5812 ;; we should make another backup.
5816 ;; Effectively copy the after-revert-hook status,
5817 ;; since after-find-file will clobber it.
5820 after-revert-hook))
5822 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5826 file-name auto-save-p)
5827 ;; Recompute the truename in case changes in symlinks
5828 ;; have changed the truename.
5832 ;; Run after-revert-hook as it was before we reverted.
5836 local-hook)
5839 t)))))
5842 "Default function for `revert-buffer-insert-file-contents-function'.
5843 The function `revert-buffer--default' calls this.
5844 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5845 an auto-save file."
5849 "File %s no longer exists!"
5851 file-name))
5854 "File %s no longer readable!"
5856 file-name))
5858 ;; Bind buffer-file-name to nil
5859 ;; so that we don't try to lock the file.
5865 ;; Auto-saved file should be read by Emacs's
5866 ;; internal coding.
5870 buffer-file-coding-system-explicit
5873 coding-system-for-read
5875 coding-system-for-read)
5877 ;; As a coding system suitable for multibyte
5878 ;; buffer is specified, make the current
5879 ;; buffer multibyte.
5882 ;; This force after-insert-file-set-coding
5883 ;; (called from insert-file-contents) to set
5884 ;; buffer-file-coding-system to a proper value.
5887 ;; Note that this preserves point in an intelligent way.
5891 nil nil t))
5893 nil nil t))))))
5896 "Recover the visited file--get contents from its last auto-save file."
5903 "Visit file FILE, but get contents from its last auto-save file."
5904 ;; Actually putting the file name in the minibuffer should be used
5905 ;; only rarely.
5906 ;; Not just because users often use the default.
5919 "*Directory*" nil
5930 ;; Use insert-directory-safely, not insert-directory,
5931 ;; because these files might not exist. In particular,
5932 ;; FILE might not exist if the auto-save file was for
5933 ;; a buffer that didn't visit a file, such as "*mail*".
5934 ;; The code in v20.x called `ls' directly, so we need
5935 ;; to emulate what `ls' did in that case.
5940 ;; Keep the current buffer-file-coding-system.
5942 ;; Auto-saved file should be read with special coding.
5951 "Recover auto save files from a previous Emacs session.
5952 This command first displays a Dired buffer showing you the
5953 previous sessions that you could recover from.
5954 To choose one, move point to the proper line and then type C-c C-c.
5955 Then you'll be asked about a number of files to recover."
5965 directory-files-no-dot-files-regexp
5967 t)
5978 ;; Each line starts with a space
5979 ;; so that Font Lock mode won't highlight the first character.
5982 " To delete a session file, type \
5988 "Choose one saved session to recover auto-save files from.
5989 This command is used in the special Dired buffer created by
5992 ;; Get the name of the session file to recover from.
5994 files
6000 ;; Read in the auto-save-list file.
6003 ;; Loop thru the text of that file
6004 ;; and get out the names of the files to recover.
6008 ;; This is a pair of lines for a non-file-visiting buffer.
6009 ;; Get the auto-save file name and manufacture
6010 ;; a "visited file name" from that.
6013 ;; If there is no auto-save file name, the
6014 ;; auto-save-list file is probably corrupted.
6027 ;; This pair of lines is a file-visiting
6028 ;; buffer. Use the visited file name.
6038 ;; Ignore a file if its auto-save file does not exist now.
6042 ;; The file contains a pair of line for each auto-saved buffer.
6043 ;; The first line of the pair contains the visited file name
6044 ;; or is empty if the buffer was not visiting a file.
6045 ;; The second line is the auto-save file name.
6053 files
6059 "Kill BUFFER if confirmed."
6067 "Kill some buffers. Asks the user whether to kill each one of them.
6068 Non-interactively, if optional argument LIST is non-nil, it
6069 specifies the list of buffers to kill, asking for approval for each one."
6077 ; if we killed the base buffer.
6084 "Kill buffers whose name matches the specified REGEXP.
6085 Ignores buffers whose name starts with a space, unless optional
6086 prefix argument INTERNAL-TOO is non-nil. Asks before killing
6087 each buffer, unless NO-ASK is non-nil."
6096 \f
6098 "Adjust current buffer's auto save file name for current conditions.
6099 Also rename any existing auto save file, if it was made in this session."
6111 "Return file name to use for auto-saves of current buffer.
6112 Does not consider `auto-save-visited-file-name' as that variable is checked
6113 before calling this function. You can redefine this for customization.
6114 See also `auto-save-file-name-p'."
6122 result uniq)
6123 ;; Apply user-specified translations
6124 ;; to the file name.
6128 filename)
6138 filename))))
6143 ;; We truncate the file name to DOS 8+3 limits
6144 ;; before doing anything else, because the regexp
6145 ;; passed to string-match below cannot handle
6146 ;; extensions longer than 3 characters, multiple
6147 ;; dots, and other atrocities.
6152 fn)
6157 "#"
6160 ;; Make sure auto-save file names don't contain characters
6161 ;; invalid for the underlying filesystem.
6163 ;; Don't modify remote filenames
6166 result))))
6168 ;; Deal with buffers that don't have any associated files. (Mail
6169 ;; mode tends to create a good number of these.)
6173 file-name)
6174 ;; Restrict the characters used in the file name to those which
6175 ;; are known to be safe on all filesystems, url-encoding the
6176 ;; rest.
6177 ;; We do this on all platforms, because even if we are not
6178 ;; running on DOS/Windows, the current directory may be on a
6179 ;; mounted VFAT filesystem, such as a USB memory stick.
6183 ;; For multibyte characters, this will produce more than
6184 ;; 2 hex digits, so is not true URL encoding.
6188 ;; Generate the file name.
6194 ;; Try a few alternative directories, to get one we can
6195 ;; write it.
6201 ;; Don't modify remote filenames
6203 ;; The call to convert-standard-filename is in case
6204 ;; buffer-name includes characters not allowed by the
6205 ;; DOS/Windows filesystems. make-temp-file writes to the
6206 ;; file it creates, so we must fix the file name _before_
6207 ;; make-temp-file is called.
6209 fname))
6211 ;; make-temp-file creates the file,
6212 ;; but we don't want it to exist until we do an auto-save.
6216 file-name)))
6219 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6220 FILENAME should lack slashes. You can redefine this for customization."
6222 \f
6224 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6225 The generated regexp will match a filename only if the filename
6226 matches that wildcard according to shell rules. Only wildcards known
6227 by `sh' are supported."
6229 ;; Copy the initial run of non-special characters.
6232 ;; If no special characters, we're almost done.
6236 j)
6238 result
6259 ;; Found "[^". Insert a `\0' character
6260 ;; (which cannot happen in a filename)
6261 ;; into the character class, so that `^'
6262 ;; is not the first character after `[',
6263 ;; and thus non-special in a regexp.
6268 ;; I don't think `]' can appear in a
6269 ;; character class in a wildcard, but
6270 ;; let's be general here.
6277 i
6290 ;; Shell wildcards should match the entire filename,
6291 ;; not its part. Make the regexp say so.
6293 \f
6296 "Switches for `list-directory' to pass to `ls' for brief listing."
6302 "Switches for `list-directory' to pass to `ls' for verbose listing."
6307 "Expand wildcard pattern PATTERN.
6308 This returns a list of file names which match the pattern.
6309 Files are sorted in `string<' order.
6311 If PATTERN is written as an absolute file name,
6312 the values are absolute also.
6314 If PATTERN is written as a relative file name, it is interpreted
6315 relative to the current default directory, `default-directory'.
6316 The file names returned are normally also relative to the current
6317 default directory. However, if FULL is non-nil, they are absolute."
6321 ;; A list of all dirs that DIRPART specifies.
6322 ;; This can be more than one dir
6323 ;; if DIRPART contains wildcards.
6329 contents)
6334 ;; Filter out "." and ".."
6339 name))
6346 this-dir-contents)
6347 this-dir-contents)
6348 contents)))))
6349 contents)))
6351 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6355 "Display a list of files in or matching DIRNAME, a la `ls'.
6356 DIRNAME is globbed by the shell if necessary.
6357 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6358 Actions controlled by variables `list-directory-brief-switches'
6359 and `list-directory-verbose-switches'."
6363 nil default-directory nil)
6364 pfx)))
6366 list-directory-brief-switches))
6367 buffer)
6379 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6387 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6389 PATTERN is assumed to represent a file-name wildcard suitable for the
6390 underlying filesystem. For Unix and GNU/Linux, each character from the
6392 the parts of the pattern which don't include wildcard characters are
6393 quoted with double quotes.
6396 on Windows), so PATTERN can use them to quote wildcard characters that
6397 need to be passed verbatim to shell commands."
6401 ;; DOS/Windows don't allow `"' in file names. So if the
6402 ;; argument has quotes, we can safely assume it is already
6403 ;; quoted by the caller.
6405 ;; We quote [&()#$`'] in case their shell is a port of a
6406 ;; Unixy shell. We quote [,=+] because stock DOS and
6407 ;; Windows shells require that in some cases, such as
6408 ;; passing arguments to batch files that use positional
6409 ;; arguments like %1.
6411 pattern
6414 end)
6431 pattern))))
6438 "Program to get the amount of free space on a file system.
6439 We assume the output has the format of `df'.
6440 The value of this variable must be just a command name or file name;
6441 if you want to specify options, use `directory-free-space-args'.
6443 A value of nil disables this feature.
6445 If the function `file-system-info' is defined, it is always used in
6446 preference to the program given by this variable."
6452 "Options to use when running `directory-free-space-program'."
6457 "Return the amount of free space on directory DIR's file system.
6458 The return value is a string describing the amount of free
6459 space (normally, the number of free 1KB blocks).
6461 This function calls `file-system-info' if it is available, or
6462 invokes the program specified by `directory-free-space-program'
6463 and `directory-free-space-args'. If the system call or program
6464 is unsuccessful, or if DIR is a remote directory, this function
6465 returns nil."
6467 ;; Try to find the number of free blocks. Non-Posix systems don't
6468 ;; always have df, but might have an equivalent system call.
6477 ;; Avoid failure if the default directory does
6478 ;; not exist (Bug#2631, Bug#3911).
6482 nil t nil
6483 directory-free-space-args
6486 ;; Assume that the "available" column is before the
6487 ;; "capacity" column. Find the "%" and scan backward.
6491 "[[:space:]]+[^[:space:]]+%[^%]*$"
6498 ;; The following expression replaces `dired-move-to-filename-regexp'.
6502 ;; In some locales, month abbreviations are as short as 2 letters,
6503 ;; and they can be followed by ".".
6504 ;; In Breton, a month name can include a quote character.
6517 s "+"
6520 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6521 ;; omits the Kanji characters after month and day-of-month.
6522 ;; On Mac OS X 10.3, the date format in East Asian locales is
6523 ;; day-of-month digits followed by month digits.
6529 ;; The "[0-9]" below requires the previous column to end in a digit.
6530 ;; This avoids recognizing `1 may 1997' as a date in the line:
6531 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6533 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6535 ;; For non-iso date formats, we add the ".*" in order to find
6536 ;; the last possible match. This avoids recognizing
6537 ;; `jservice 10 1024' as a date in the line:
6538 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6540 ;; vc dired listings provide the state or blanks between file
6541 ;; permissions and date. The state is always surrounded by
6542 ;; parentheses:
6543 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6544 ;; This is not supported yet.
6549 "Regular expression to match up to the file name in a directory listing.
6550 The default value is designed to recognize dates and times
6556 "Return non-nil if DIR contents a shell wildcard in the directory part.
6557 The return value is a cons (DIR . WILDCARDS); DIR is the
6558 `default-directory' in the Dired buffer, and WILDCARDS are the wildcards.
6560 Valid wildcards are '*', '?', '[abc]' and '[a-z]'."
6563 ls-lisp-support-shell-wildcards)
6567 wildcards wildcards wildcards)))
6575 ;; The following overshoots by one line for an empty
6576 ;; directory listed with "--dired", but without "-a"
6577 ;; switch, where the ls output contains a
6578 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6579 ;; We take care of that case later.
6587 error-lines)
6588 ;; Find all the lines that are error messages,
6589 ;; and record the bounds of each one.
6596 ;; Now read the numeric positions of file names.
6603 error-lines))
6606 error-lines)))
6608 ;; End is followed by \n or by " -> ".
6610 ;; It seems that we can't trust ls's output as to
6611 ;; byte positions of filenames.
6617 ;; Take care of the case where the ls output contains a
6618 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6619 ;; and we went one line too far back (see above).
6624 ;; insert-directory
6625 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6626 ;; FULL-DIRECTORY-P is nil.
6627 ;; The single line of output must display FILE's name as it was
6628 ;; given, namely, an absolute path name.
6629 ;; - must insert exactly one line for each file if WILDCARD or
6630 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6631 ;; before the file lines, plus optional text after the file lines.
6632 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6633 ;; allowed.
6634 ;; File lines should display the basename.
6635 ;; - must be consistent with
6636 ;; - functions dired-move-to-filename, (these two define what a file line is)
6637 ;; dired-move-to-end-of-filename,
6638 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6639 ;; dired-insert-headerline
6640 ;; dired-after-subdir-garbage (defines what a "total" line is)
6641 ;; - variable dired-subdir-regexp
6642 ;; - may be passed "--dired" as the first argument in SWITCHES.
6643 ;; Filename handlers might have to remove this switch if their
6644 ;; "ls" command does not support it.
6646 "Insert directory listing for FILE, formatted according to SWITCHES.
6647 Leaves point after the inserted text.
6648 SWITCHES may be a string of options, or a list of strings
6649 representing individual options.
6650 Optional third arg WILDCARD means treat FILE as shell wildcard.
6651 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6652 switches do not contain `d', so that a full listing is expected.
6654 This works by running a directory listing program
6655 whose name is in the variable `insert-directory-program'.
6656 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6658 When SWITCHES contains the long `--dired' option, this function
6659 treats it specially, for the sake of dired. However, the
6660 normally equivalent short `-D' option is just passed on to
6661 `insert-directory-program', as any other option."
6662 ;; We need the directory in order to find the right handler.
6667 wildcard full-directory-p)
6670 ;; Read the actual directory using `insert-directory-program'.
6671 ;; RESULT gets the status code.
6673 ;; putting text property `dired-filename, decode one
6674 ;; bunch by one to preserve that property.
6676 ;; This is to control encoding the arguments in call-process.
6680 default-file-name-coding-system))))
6683 ;; If the wildcard is just in the file part, then run ls in
6684 ;; the directory part of the file pattern using the last
6685 ;; component as argument. Otherwise, run ls in the longest
6686 ;; subdirectory of the directory part free of wildcards; use
6687 ;; the remaining of the file pattern as argument.
6696 ;; NB since switches is passed to the shell, be
6697 ;; careful of malicious values, eg "-l;reboot".
6698 ;; See eg dired-safe-switches-p.
6700 shell-file-name nil t nil
6701 shell-command-switch
6703 ""
6705 insert-directory-program
6706 " -d "
6708 switches
6710 " -- "
6711 ;; Quote some characters that have
6712 ;; special meanings in shells; but
6713 ;; don't quote the wildcards--we want
6714 ;; them to be special. We also
6715 ;; currently don't quote the quoting
6716 ;; characters in case people want to
6717 ;; use them explicitly to quote
6718 ;; wildcard characters.
6720 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6721 ;; directory if FILE is a symbolic link.
6729 insert-directory-program nil t nil
6733 ;; Split the switches at any spaces so we can
6734 ;; pass separate options as separate args.
6736 ;; Avoid lossage if FILE starts with `-'.
6743 ;; (concat (file-name-as-directory file) ".")
6744 file
6745 file))))))))
6747 ;; If we got "//DIRED//" in the output, it means we got a real
6748 ;; directory listing, even if `ls' returned nonzero.
6749 ;; So ignore any errors.
6762 ;; The first time ls returns an error,
6763 ;; find the version numbers of ls,
6764 ;; and set insert-directory-ls-version
6765 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6766 ;; is equal or if the info cannot be obtained.
6767 ;; (That can mean it isn't GNU ls.)
6777 comparison)
6793 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6797 ;; If `insert-directory-program' failed, signal an error.
6799 ;; Delete the error message it may have output.
6801 ;; On non-Posix systems, we cannot open a directory, so
6802 ;; don't even try, because that will always result in
6803 ;; the ubiquitous "Access denied". Instead, show the
6804 ;; command line so the user can try to guess what went wrong.
6809 insert-directory-program
6811 file result)
6812 ;; Unix. Access the file to get a suitable error.
6816 ;; Now decode what read if necessary.
6818 file-name-coding-system
6819 default-file-name-coding-system
6821 coding-no-eol
6822 val pos)
6826 ;; If no coding system is specified or detection is
6827 ;; requested, detect the coding.
6841 ;; Force no eol conversion on a file name, so
6842 ;; that CR is preserved.
6850 ;; Try to insert the amount of free space.
6853 ;; First find the line to put it on.
6857 ;; Replace "total" with "used", to avoid confusion.
6863 "Convert `ls --dired' file name position value POS to a buffer position.
6864 File name position values returned in ls --dired output
6865 count only stdout; they don't count the error messages sent to stderr.
6866 So this function converts to them to real buffer positions.
6867 ERROR-LINES is a list of buffer positions of error message lines,
6868 of the form (START END)."
6872 pos)
6876 "Insert directory listing for FILE, formatted according to SWITCHES.
6878 Like `insert-directory', but if FILE does not exist, it inserts a
6879 message to that effect instead of signaling an error."
6882 ;; Simulate the message printed by `ls'.
6886 "Functions to call with no arguments to query about killing Emacs.
6887 If any of these functions returns nil, killing Emacs is canceled.
6888 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6889 the low level primitive, does not. See also `kill-emacs-hook'."
6895 "How to ask for confirmation when leaving Emacs.
6896 If nil, the default, don't ask at all. If the value is non-nil, it should
6897 be a predicate function; for example `yes-or-no-p'."
6906 "Non-nil if Emacs should confirm killing processes on exit.
6907 If this variable is nil, the value of
6908 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6909 processes with a non-nil `process-query-on-exit-flag', Emacs will
6910 prompt the user before killing them."
6916 "Offer to save each buffer, then kill this Emacs process.
6917 With prefix ARG, silently save all file-visiting buffers without asking.
6918 If there are active processes where `process-query-on-exit-flag'
6919 returns non-nil and `confirm-kill-processes' is non-nil,
6920 asks whether processes should be killed.
6921 Runs the members of `kill-emacs-query-functions' in turn and stops
6922 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6924 ;; Don't use save-some-buffers-default-predicate, because we want
6925 ;; to ask about all the buffers before killing Emacs.
6936 ;; process-list is not defined on MSDOS.
6939 active)
6957 ;; Query the user for other things, perhaps.
6964 "Offer to save each buffer, then kill the current connection.
6965 If the current frame has no client, kill Emacs itself using
6966 `save-buffers-kill-emacs'.
6968 With prefix ARG, silently save all file-visiting buffers, then kill.
6970 If emacsclient was started with a list of filenames to edit, then
6971 only these files will be asked to be saved."
6976 \f
6977 ;; We use /: as a prefix to "quote" a file name
6978 ;; so that magic file name handlers will not apply to it.
6982 file-name-handler-alist))
6984 ;; We depend on being the last handler on the list,
6985 ;; so that anything else which does need handling
6986 ;; has been handled already.
6987 ;; So it is safe for us to inhibit *all* magic file name handlers.
6992 ;; Some operations respect file name handlers in
6993 ;; `default-directory'. Because core function like
6994 ;; `call-process' don't care about file name handlers in
6995 ;; `default-directory', we here have to resolve the
6996 ;; directory into a local one. For `process-file',
6997 ;; `start-file-process', and `shell-command', this fixes
6998 ;; Bug#25949.
7000 shell-command))
7004 default-directory))
7005 ;; Get a list of the indices of the args which are file names.
7008 ;; The first six are special because they
7009 ;; return a file name. We want to include the /:
7010 ;; in the return value.
7011 ;; So just avoid stripping it in the first place.
7018 ;; `identity' means just return the first arg
7019 ;; not stripped of its quoting.
7021 ;; `add' means add "/:" to the result.
7024 ;; `unquote-then-quote' means set buffer-file-name
7025 ;; temporarily to unquoted filename.
7027 ;; List the arguments which are filenames.
7035 ;; For all other operations, treat the first argument only
7036 ;; as the file name.
7038 method
7039 ;; Copy ARGUMENTS so we can replace elements in it.
7043 ;; Strip off the /: from the file names that have it.
7051 "/"
7057 (`insert-file-contents
7063 (`unquote-then-quote
7064 ;; We can't use `cl-letf' with `(buffer-local-value)' here
7065 ;; because it wouldn't work during bootstrapping.
7067 ;; `unquote-then-quote' is only used for the
7068 ;; `verify-visited-file-modtime' action, which takes a buffer
7069 ;; as only optional argument.
7072 ;; Make sure to hide the temporary buffer change from the
7073 ;; underlying operation.
7081 If NAME is a remote file name, check the local part of NAME."
7086 If NAME is a remote file name, the local part of NAME is quoted.
7087 If NAME is already a quoted file name, NAME is returned unchanged."
7089 name
7094 If NAME is a remote file name, the local part of NAME is unquoted."
7100 \f
7101 ;; Symbolic modes and read-file-modes.
7104 "Convert CHAR to a numeric bit-mask for extracting mode bits.
7105 CHAR is in [ugoa] and represents the category of users (Owner, Group,
7106 Others, or All) for whom to produce the mask.
7107 The bit-mask that is returned extracts from mode bits the access rights
7108 for the specified category of users."
7116 "Convert CHAR to a numeric value of mode bits.
7117 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7118 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7125 ;; Rights relative to the previous file modes.
7136 "Convert a symbolic mode string specification to an equivalent number.
7138 WHO-MASK is the bit-mask specifying the category of users to which to
7139 apply the access permissions. See `file-modes-char-to-who'.
7140 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7141 RIGHTS request to add, remove, or set permissions based on existing ones,
7148 char-right)
7155 num-rights
7159 op char-right)))
7160 num-rights))
7163 "Convert symbolic file modes to numeric file modes.
7164 MODES is the string to convert, it should match
7166 See Info node `(coreutils)File permissions' for more information on this
7167 notation.
7168 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7169 MODES request to add, remove, or set permissions based on existing ones,
7183 num-who num-modes)
7186 num-modes)))
7189 "Read file modes in octal or symbolic notation and return its numeric value.
7191 ORIG-FILE is the name of a file on whose mode bits to base returned
7192 permissions if what user types requests to add, remove, or set permissions
7208 nil nil default)))
7217 ;; Trashcan handling.
7219 "Directory for `move-file-to-trash' to move files and directories to.
7220 This directory is only used when the function `system-move-file-to-trash'
7221 is not defined.
7222 Relative paths are interpreted relative to `default-directory'.
7223 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7233 "Move the file (or directory) named FILENAME to the trash.
7234 When `delete-by-moving-to-trash' is non-nil, this function is
7235 called by `delete-file' and `delete-directory' instead of
7236 deleting files outright.
7238 If the function `system-move-file-to-trash' is defined, call it
7239 with FILENAME as an argument.
7240 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7241 directory.
7242 Otherwise, trash FILENAME using the freedesktop.org conventions,
7243 like the GNOME, KDE and XFCE desktop environments. Emacs only
7247 ;; If `trash-directory' is non-nil, move the file there.
7252 ;; We can't trash a parent directory of trash-directory.
7255 trash-dir filename))
7258 ;; Ensure that the trashed file-name is unique.
7265 ;; If `system-move-file-to-trash' is defined, use it.
7268 ;; Otherwise, use the freedesktop.org method, as specified at
7269 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7280 ;; Check if we have permissions to delete.
7284 ;; The trashed file cannot be the trash dir or its parent.
7287 trash-files-dir filename))
7290 trash-info-dir filename))
7292 ;; Ensure that the trash directory exists; otherwise, create it.
7299 ;; Try to move to trash with .trashinfo undo information
7304 ;; Perform url-encoding on FN. For compatibility with
7305 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7306 ;; for path separators.
7311 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7312 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7325 fn))
7330 ;; Make a .trashinfo file. Use O_EXCL, as per trash-spec 1.0.
7334 trash-info-dir)))
7338 ;; Uniquify new-fn. Some file managers do not
7339 ;; like Emacs-style backup file names. E.g.:
7340 ;; https://bugs.kde.org/170956
7346 ;; Finally, try to move the file to the trashcan.
7352 "The type field in ATTRIBUTES returned by `file-attributes'.
7353 The value is either t for directory, string (name linked to) for
7354 symbolic link, or nil."
7358 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7362 "The UID field in ATTRIBUTES returned by `file-attributes'.
7363 This is either a string or a number. If a string value cannot be
7364 looked up, a numeric value, either an integer or a float, is
7365 returned."
7369 "The GID field in ATTRIBUTES returned by `file-attributes'.
7370 This is either a string or a number. If a string value cannot be
7371 looked up, a numeric value, either an integer or a float, is
7372 returned."
7376 "The last access time in ATTRIBUTES returned by `file-attributes'.
7377 This a list of integers (HIGH LOW USEC PSEC) in the same style
7378 as (current-time)."
7382 "The modification time in ATTRIBUTES returned by `file-attributes'.
7383 This is the time of the last change to the file's contents, and
7384 is a list of integers (HIGH LOW USEC PSEC) in the same style
7385 as (current-time)."
7389 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7390 This is the time of last change to the file's attributes: owner
7391 and group, access mode bits, etc, and is a list of integers (HIGH
7392 LOW USEC PSEC) in the same style as (current-time)."
7396 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7397 This is a floating point number if the size is too large for an integer."
7401 "The file modes in ATTRIBUTES returned by `file-attributes'.
7402 This is a string of ten letters or dashes as in ls -l."
7406 "The inode number in ATTRIBUTES returned by `file-attributes'.
7407 If it is larger than what an Emacs integer can hold, this is of
7408 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7409 If even HIGH is too large for an Emacs integer, this is instead
7410 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7411 middle 24 bits, and finally the low 16 bits."
7415 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7416 If it is larger than what an Emacs integer can hold, this is of
7417 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7418 If even HIGH is too large for an Emacs integer, this is instead
7419 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7420 middle 24 bits, and finally the low 16 bits."
7424 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7425 ATTR-NAMES are symbols with the selected attribute names.
7427 Valid attribute names are: type, link-number, user-id, group-id,
7428 access-time, modification-time, status-change-time, size, modes,
7429 inode-number and device-number."
7431 modification-time status-change-time
7432 size modes inode-number device-number))
7433 result)
7439 attributes)
7440 result)
7443 \f
7468 ;;; files.el ends here