| blob | 68894ca2ce01052989434ed76552169f30be4ada |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2021 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 that 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 that 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
138 user id and group id of the file are both greater than the value of
139 this variable. This is useful when low-numbered uid's and gid's are
140 used for special system users (such as root) that must maintain
141 ownership of certain files.
142 This variable is relevant only if `backup-by-copying' and
143 `backup-by-copying-when-mismatch' are nil."
148 "Predicate that looks at a file name and decides whether to make backups.
152 "Non-nil in a buffer means always offer to save buffer on exiting Emacs.
153 Do so even if the buffer is not visiting a file.
154 Automatically local in all buffers.
156 Set to the symbol `always' to offer to save buffer whenever
157 `save-some-buffers' is called.
159 Note that this option has no effect on `kill-buffer';
160 if you want to control what happens when a buffer is killed,
161 use `kill-buffer-query-functions'."
170 "Non-nil means find a file under alternative names, in existing buffers.
171 This means if any existing buffer is visiting the file you want
172 under another name, you get the existing buffer instead of a new buffer."
177 "Non-nil means visiting a file uses its truename as the visited-file name.
178 That is, the buffer visiting the file has the truename as the
179 value of `buffer-file-name'. The truename of a file is found by
180 chasing all links both at the file level and at the levels of the
181 containing directories."
186 "Specify which files should be reverted without query.
187 The value is a list of regular expressions.
188 If the file name matches one of these regular expressions,
189 then `revert-buffer' reverts the file without querying
190 if the file has changed on disk and you have not edited the buffer."
195 "The device number and file number of the file visited in the current buffer.
196 The value is a list of the form (FILENUM DEVNUM).
197 This pair of numbers uniquely identifies the file.
209 "The directory for writing small temporary files.
210 If non-nil, this directory is used instead of `temporary-file-directory'
211 by programs that create small temporary files. This is for systems that
212 have fast storage with limited space, such as a RAM disk."
217 ;; The system null device. (Should reference NULL_DEVICE from C.)
244 "Non-nil means protect against I/O errors while saving files.
245 Some modes set this non-nil in particular buffers.
247 This feature works by writing the new contents into a temporary file
248 and then renaming the temporary file to replace the original.
249 In this way, any I/O error in writing leaves the original untouched,
250 and there is never any instant where the file is nonexistent.
252 Note that this feature forces backups to be made by copying.
253 Yet, at the same time, saving a precious file
254 breaks any hard links between it and other files.
256 This feature is advisory: for example, if the directory in which the
257 file is being saved is not writable, Emacs may ignore a non-nil value
258 of `file-precious-flag' and write directly into the file.
260 See also: `break-hardlink-on-save'."
265 "Whether to allow breaking hardlinks when saving files.
266 If non-nil, then when saving a file that exists under several
267 names \(i.e., has multiple hardlinks), break the hardlink
268 associated with `buffer-file-name' and write to a new file, so
269 that the other instances of the file are not affected by the
270 save.
272 If `buffer-file-name' refers to a symlink, do not break the symlink.
274 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
275 For example, if the directory in which a file is being saved is not
276 itself writable, then error instead of saving in some
277 hardlink-nonbreaking way.
279 See also `backup-by-copying' and `backup-by-copying-when-linked'."
285 "Control use of version numbers for backup files.
286 When t, make numeric backup versions unconditionally.
287 When nil, make them for files that have some already.
288 The value `never' means do not make them."
295 "Return whether X is safe as local value for `version-control'."
302 "When cleaning directory, number of versions to keep."
308 "If t, delete excess backup versions silently.
309 If nil, ask confirmation. Any other value prevents any trimming."
316 "Number of oldest versions to keep when a new numbered backup is made."
322 "Number of newest versions to keep when a new numbered backup is made.
323 Includes the new backup. Must be greater than 0."
329 "Whether to add a newline automatically at the end of the file.
331 A value of t means do this only when the file is about to be saved.
332 A value of `visit' means do this right after the file is visited.
333 A value of `visit-save' means do it at both of those times.
334 Any other non-nil value means ask user whether to add a newline, when saving.
335 A value of nil means don't add newlines.
337 Certain major modes set this locally to the value obtained
338 from `mode-require-final-newline'.
340 This variable is heeded only when visiting files (or saving
341 buffers into files they visit). Writing data to the file system
342 with `write-region' and the like is not influenced by this variable."
352 "Whether to add a newline at end of file, in certain major modes.
353 Those modes set `require-final-newline' to this value when you enable them.
354 They do so because they are often used for files that are supposed
355 to end in newlines, and the question is how to arrange that.
357 A value of t means do this only when the file is about to be saved.
358 A value of `visit' means do this right after the file is visited.
359 A value of `visit-save' means do it at both of those times.
360 Any other non-nil value means ask user whether to add a newline, when saving.
362 A value of nil means do not add newlines. That is a risky choice in this
363 variable since this value is used for modes for files that ought to have
364 final newlines. So if you set this to nil, you must explicitly check and
365 add a final newline, whenever you save a file that really needs one."
375 "Non-nil says by default do auto-saving of every file-visiting buffer."
381 ;; Don't put "\\2" inside expand-file-name, since it will be
382 ;; transformed to "/2" on DOS/Windows.
384 "Transforms to apply to buffer file name before making auto-save file name.
385 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
386 REGEXP is a regular expression to match against the file name.
387 If it matches, `replace-match' is used to replace the
388 matching part with REPLACEMENT.
389 If the optional element UNIQUIFY is non-nil, the auto-save file name is
390 constructed by taking the directory part of the replaced file-name,
391 concatenated with the buffer file name with all directory separators
392 changed to `!' to prevent clashes. This will not work
393 correctly if your filesystem truncates the resulting name.
395 All the transforms in the list are tried, in the order they are listed.
396 When one transform applies, its result is final;
397 no further transforms are tried.
399 The default value is set up to put the auto-save file into the
400 temporary directory (see the variable `temporary-file-directory') for
401 editing a remote file.
403 On MS-DOS filesystems without long names this variable is always
404 ignored."
414 "Interval in seconds for `auto-save-visited-mode'.
415 If `auto-save-visited-mode' is enabled, Emacs will save all
416 buffers visiting a file to the visited file after it has been
417 idle for `auto-save-visited-interval' seconds."
427 "Toggle automatic saving to file-visiting buffers on or off.
429 Unlike `auto-save-mode', this mode will auto-save buffer contents
430 to the visited files directly and will also run all save-related
431 hooks. See Info node `Saving' for details of the save process.
433 You can also set the buffer-local value of the variable
434 `auto-save-visited-mode' to nil. A buffer where the buffer-local
435 value of this variable is nil is ignored for the purpose of
436 `auto-save-visited-mode', even if `auto-save-visited-mode' is
437 enabled."
439 :global t
444 auto-save-visited-interval :repeat
448 auto-save-visited-mode
450 auto-save-visited-file-name))))))))
452 ;; The 'set' part is so we don't get a warning for using this variable
453 ;; above, while still catching code that _sets_ the variable to get
454 ;; the same effect as the new auto-save-visited-mode.
459 "Non-nil means save word abbrevs too when files are saved.
460 If `silently', don't ask the user before saving."
465 "Non-nil means allow `find-file' to visit directories.
466 To visit the directory, `find-file' runs `find-directory-functions'."
471 "List of functions to try in sequence to visit a directory.
472 Each function is called with the directory name as the sole argument
473 and should return either a buffer or nil."
477 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
479 "List of functions to try in sequence to get a file name at point.
480 Each function should return either nil or a file name found at the
481 location of point in the current buffer."
485 ;;;It is not useful to make this a local variable.
486 ;;;(put 'find-file-not-found-functions 'permanent-local t)
490 "List of functions to be called for `find-file' on nonexistent file.
491 These functions are called as soon as the error is detected.
492 Variable `buffer-file-name' is already set up.
495 ;;;It is not useful to make this a local variable.
496 ;;;(put 'find-file-hook 'permanent-local t)
497 ;; I found some external files still using the obsolete form in 2018.
500 "List of functions to be called after a buffer is loaded from a file.
501 The buffer's local variables (if any) will have been processed before the
502 functions are called. This includes directory-local variables, if any,
503 for the file's directory."
509 ;; I found some external files still using the obsolete form in 2018.
512 "List of functions to be called before saving a buffer to a file.
513 Used only by `save-buffer'.
514 If one of them returns non-nil, the file is considered already written
515 and the rest are not called.
516 These hooks are considered to pertain to the visited file.
517 So any buffer-local binding of this variable is discarded if you change
519 change the major mode.
521 This hook is not run if any of the functions in
522 `write-contents-functions' returns non-nil. Both hooks pertain
523 to how to save a buffer to file, for instance, choosing a suitable
524 coding system and setting mode bits. (See Info
525 node `(elisp)Saving Buffers'.) To perform various checks or
529 ;; I found some files still using the obsolete form in 2018.
534 ;; I found some files still using the obsolete form in 2018.
538 "List of functions to be called before writing out a buffer to a file.
540 Used only by `save-buffer'. If one of them returns non-nil, the
541 file is considered already written and the rest are not called
542 and neither are the functions in `write-file-functions'. This
543 hook can thus be used to create save behavior for buffers that
544 are not visiting a file at all.
546 This variable is meant to be used for hooks that pertain to the
547 buffer's contents, not to the particular visited file; thus,
548 `set-visited-file-name' does not clear this variable; but changing the
549 major mode does clear it.
551 For hooks that _do_ pertain to the particular visited file, use
552 `write-file-functions'. Both this variable and
553 `write-file-functions' relate to how a buffer is saved to file.
554 To perform various checks or updates before the buffer is saved,
558 "Control use of local variables in files you visit.
559 The value can be t, nil, :safe, :all, or something else.
561 A value of t means file local variables specifications are obeyed
562 if all the specified variable values are safe; if any values are
563 not safe, Emacs queries you, once, whether to set them all.
564 \(When you say yes to certain values, they are remembered as safe.)
566 :safe means set the safe variables, and ignore the rest.
567 :all means set all variables, whether safe or not.
568 (Don't set it permanently to :all.)
569 A value of nil means always ignore the file local variables.
571 Any other value means always query you once whether to set them all.
572 \(When you say yes to certain values, they are remembered as safe, but
575 This variable also controls use of major modes specified in
576 a -*- line.
579 always obeys file local variable specifications and the -*- line,
580 and ignores this variable."
581 :risky t
590 "Non-nil means enable use of directory-local variables.
591 Some modes may wish to set this to nil to prevent directory-local
594 ;; This is an odd variable IMO.
595 ;; You might wonder why it is needed, when we could just do:
596 ;; (setq-local enable-local-variables nil)
597 ;; These two are not precisely the same.
598 ;; Setting this variable does not cause -*- mode settings to be
599 ;; ignored, whereas setting enable-local-variables does.
600 ;; Only three places in Emacs use this variable: tar and arc modes,
601 ;; and rmail. The first two don't need it. They already use
602 ;; inhibit-local-variables-regexps, which is probably enough, and
603 ;; could also just set enable-local-variables locally to nil.
604 ;; Them setting it has the side-effect that dir-locals cannot apply to
605 ;; eg tar files (?). FIXME Is this appropriate?
606 ;; AFAICS, rmail is the only thing that needs this, and the only
607 ;; reason it uses it is for BABYL files (which are obsolete).
608 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
609 ;; to respect, so that find-file on a BABYL file will switch to
610 ;; rmail-mode automatically (this is nice, but hardly essential,
611 ;; since most people are used to explicitly running a command to
612 ;; access their mail; M-x gnus etc). Rmail files may happen to
613 ;; contain Local Variables sections in messages, which Rmail wants to
614 ;; ignore. So AFAICS the only reason this variable exists is for a
615 ;; minor convenience feature for handling of an obsolete Rmail file format.
617 "Like `enable-local-variables', except for major mode in a -*- line.
618 The meaningful values are nil and non-nil. The default is non-nil.
619 It should be set in a buffer-local fashion.
621 Setting this to nil has the same effect as setting `enable-local-variables'
622 to nil, except that it does not ignore any mode: setting in a -*- line.
623 Unless this difference matters to you, you should set `enable-local-variables'
628 The value can be t, nil or something else.
629 A value of t means obey `eval' variables.
630 A value of nil means ignore them; anything else means query."
631 :risky t
638 "Non-nil means buffers visiting files read-only do so in view mode.
639 In fact, this means that all read-only buffers normally have
640 View mode enabled, including buffers that are read-only because
641 you visit a file you cannot alter, and buffers you make read-only
647 "History list of file names entered in the minibuffer.
649 Maximum length of the history list is determined by the value
653 "If non-nil, avoid messages when saving files.
654 Error-related messages will still be printed, but all other
657 \f
660 "Provides support for ange-ftp host name completion.
661 Runs the usual ange-ftp hook, but only for completion operations."
662 ;; Having this here avoids the need to load ange-ftp when it's not
663 ;; really in use.
669 inhibit-file-name-handlers)))
677 "Convert a standard file's name to something suitable for the OS.
678 This means to guarantee valid names and perhaps to canonicalize
679 certain patterns.
681 FILENAME should be an absolute file name since the conversion rules
682 sometimes vary depending on the position in the file name. E.g. c:/foo
683 is a valid DOS file name, but c:/bar/c:/foo is not.
685 This function's standard definition is trivial; it just returns
686 the argument. However, on Windows and DOS, replace invalid
687 characters. On DOS, make sure to obey the 8.3 limitations.
688 In the native Windows build, turn Cygwin names into native names.
690 See Info node `(elisp)Standard File Names' for more details."
695 ;; Replace invalid filename characters with !
699 name))
707 "Read directory name, prompting with PROMPT and completing in directory DIR.
708 Value is not expanded---you must call `expand-file-name' yourself.
709 Default name to DEFAULT-DIRNAME if user exits with the same
710 non-empty string that was inserted by this function.
711 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
712 or just DIR if INITIAL is nil.)
713 If the user exits with an empty minibuffer, this function returns
714 an empty string. (This can happen only if the user erased the
715 pre-inserted contents or if `insert-default-directory' is nil.)
716 Fourth arg MUSTMATCH non-nil means require existing directory's name.
717 Non-nil and non-t means also require confirmation after completion.
718 Fifth arg INITIAL specifies text to start with.
719 DIR should be an absolute directory name. It defaults to
720 the value of `default-directory'."
725 dir))
726 mustmatch initial
729 \f
731 "Show the current default directory.
732 With prefix argument INSERT, insert the current default directory
733 at point instead."
740 "Value of the CDPATH environment variable, as a list.
744 "Explode a search path into a list of directory names.
745 Directories are separated by `path-separator' (which is colon in
746 GNU and Unix systems). Substitute environment variables into the
747 resulting list of directory names. For an empty path element (i.e.,
748 a leading or trailing separator, or two adjacent separators), return
749 nil (meaning `default-directory') as the associated list element."
755 ;; Previous implementation used `substitute-in-file-name'
756 ;; which collapse multiple "/" in front. Do the same for
757 ;; backward compatibility.
763 "Change current directory to given absolute file name DIR."
764 ;; Put the name into directory syntax now,
765 ;; because otherwise expand-file-name may give some bad results.
767 ;; We used to additionally call abbreviate-file-name here, for an
768 ;; unknown reason. Problem is that most buffers are setup
769 ;; without going through cd-absolute and don't call
770 ;; abbreviate-file-name on their default-directory, so the few that
771 ;; do end up using a superficially different directory.
775 "%s is not a directory"
777 dir)
784 "Make DIR become the current buffer's default directory.
785 If your environment includes a `CDPATH' variable, try each one of
786 that list of directories (separated by occurrences of
787 `path-separator') when resolving a relative directory name.
788 The path separator is colon in GNU and GNU-like systems."
791 ;; FIXME: There's a subtle bug in the completion below. Seems linked
792 ;; to a fundamental difficulty of implementing `predicate' correctly.
793 ;; The manifestation is that TAB may list non-directories in the case where
794 ;; those files also correspond to valid directories (if your cd-path is (A/
795 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
796 ;; will be listed as valid completions).
797 ;; This is because `a' (listed because of A/a) is indeed a valid choice
798 ;; (which will lead to the use of B/a).
803 cd-path nil))
812 default-directory default-directory
813 t))))
819 ;; locate-file doesn't support remote file names, so detect them
820 ;; and support them here by hand.
829 &optional include-directories predicate
830 follow-symlinks)
831 "Return list of all files under directory DIR whose names match REGEXP.
834 alphabetical order. Each file name appears in the returned list
835 in its absolute form.
837 By default, the returned list excludes directories, but if
838 optional argument INCLUDE-DIRECTORIES is non-nil, they are
839 included.
841 PREDICATE can be either nil (which means that all subdirectories
842 of DIR are descended into), t (which means that subdirectories that
843 can't be read are ignored), or a function (which is called with
844 the name of each subdirectory, and should return non-nil if the
845 subdirectory is to be descended into).
847 If FOLLOW-SYMLINKS is non-nil, symbolic links that point to
848 directories are followed. Note that this can lead to infinite
849 recursion."
853 ;; When DIR is "/", remote file names like "/method:" could
854 ;; also be offered. We shall suppress them.
862 ;; Don't follow symlinks to other directories.
865 follow-symlinks))
866 ;; Allow filtering subdirectories.
874 full-file regexp include-directories
875 predicate follow-symlinks))
877 full-file regexp include-directories
878 predicate follow-symlinks))))
888 "Return t if DIR names an existing directory containing no other files.
889 Return nil if DIR does not name a directory, or if there was
890 trouble determining whether DIR is a directory or empty.
892 Symbolic links to directories count as directories.
893 See `file-symlink-p' to distinguish symlinks."
900 "Load the Lisp file named FILE."
901 ;; This is a case where .elc and .so/.dll make a lot of sense.
905 completion-ignored-extensions))))
910 "Search for FILENAME through PATH.
911 If found, return the absolute file name of FILENAME; otherwise
912 return nil.
913 PATH should be a list of directories to look in, like the lists in
914 `exec-path' or `load-path'.
915 If SUFFIXES is non-nil, it should be a list of suffixes to append to
918 If non-nil, PREDICATE is used instead of `file-readable-p'.
920 This function will normally skip directories, so if you want it to find
921 directories, make sure the PREDICATE function returns `dir-ok' for them.
923 PREDICATE can also be an integer to pass to the `access' system call,
924 in which case file name handlers are ignored. This usage is deprecated.
925 For compatibility, PREDICATE can also be one of the symbols
926 `executable', `readable', `writable', or `exists', or a list of
927 one or more of those symbols."
938 "Do completion for file names passed to `locate-file'."
941 ;; FIXME: maybe we should use completion-file-name-table instead,
942 ;; tho at least for `load', the arg is passed through
943 ;; substitute-in-file-name for historical reasons.
953 ;; If we have files like "foo.el" and "foo.elc", we could load one of
954 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
955 ;; preferred way. So if we list all 3, that gives a lot of redundant
956 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
957 ;; the user does want to pay attention to the extension. We try to
958 ;; diffuse this tension by stripping the suffix, except when the
959 ;; result is a single element (i.e. usually we list only "foo" unless
960 ;; it's the only remaining element in the list, in which case we do
961 ;; list "foo", "foo.elc" and "foo.el").
972 string-file dir))
977 ;; Switching from names to names+fullnames creates a non-monotonicity
978 ;; which can cause problems with things like partial-completion.
979 ;; To minimize the problem, filter out completion-regexp-list, so that
980 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
981 ;; from `names' that matched `string' only when they still had
982 ;; their suffix.
984 ;; Remove duplicates of the first element, so that we can easily check
985 ;; if `names' really contains only a single element.
988 ;; There's no more than one matching non-suffixed element, so expand
989 ;; the list by adding the suffixed elements as well.
992 string-dir names string-file pred action)))))
996 "Regexp of directory names that stop the search in `locate-dominating-file'.
997 Any directory whose name matches this regexp will be treated like
998 a kind of root directory by `locate-dominating-file', which will stop its
999 search when it bumps into it.
1000 The default regexp prevents fruitless and time-consuming attempts to find
1001 special files in directories in which filenames are interpreted as hostnames,
1005 "Starting at FILE, look up directory hierarchy for directory containing NAME.
1006 FILE can be a file or a directory. If it's a file, its directory will
1007 serve as the starting point for searching the hierarchy of directories.
1008 Stop at the first parent directory containing a file NAME,
1009 and return the directory. Return nil if not found.
1010 Instead of a string, NAME can also be a predicate taking one argument
1011 \(a directory) and returning a non-nil value if that directory is the one for
1012 which we're looking. The predicate will be called with every file/directory
1013 the function needs to examine, starting with FILE."
1014 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
1015 ;; `name' in /home or in /.
1018 try)
1033 "Non-nil means warn if cannot access `user-emacs-directory'.
1034 Set this to nil at your own risk..."
1040 "Return an absolute per-user Emacs-specific file name.
1041 If NEW-NAME exists in `user-emacs-directory', return it.
1042 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
1043 Else return NEW-NAME in `user-emacs-directory', creating the
1044 directory if it does not exist."
1052 at-home
1053 ;; Make sure `user-emacs-directory' exists,
1054 ;; unless we're in batch mode or dumping Emacs.
1056 dump-mode
1066 user-emacs-directory-warning
1068 ;; Warn only once per Emacs session.
1072 Unable to %s `user-emacs-directory' (%s).
1073 Any data that would normally be written there may be lost!
1074 If you never want to see this message again,
1075 customize the variable `user-emacs-directory-warning'."
1076 errtype user-emacs-directory)))))
1077 bestname))))
1080 "Return list of directories to search programs to run in remote subprocesses.
1081 The remote host is identified by `default-directory'. For remote
1082 hosts that do not support subprocesses, this returns `nil'.
1083 If `default-directory' is a local directory, this function returns
1084 the value of the variable `exec-path'."
1088 exec-path)))
1091 "Search for COMMAND in `exec-path' and return the absolute file name.
1092 Return nil if COMMAND is not found anywhere in `exec-path'. If
1093 REMOTE is non-nil, search on the remote host indicated by
1094 `default-directory' instead."
1097 command
1103 ;; Use 1 rather than file-executable-p to better match the
1104 ;; behavior of call-process.
1111 "Load the Emacs Lisp library named LIBRARY.
1112 LIBRARY should be a string.
1113 This is an interface to the function `load'. LIBRARY is searched
1114 for in `load-path', both with and without `load-suffixes' (as
1115 well as `load-file-rep-suffixes').
1117 See Info node `(emacs)Lisp Libraries' for more details.
1118 See `load-file' for a different interface to `load'."
1123 "Test whether FILE specifies a location on a remote system.
1124 A file is considered remote if accessing it is likely to
1125 be slower or less reliable than accessing local files.
1127 `file-remote-p' never opens a new remote connection. It can
1128 reuse only a connection that is already open.
1130 Return nil or a string identifying the remote connection
1131 \(ideally a prefix of FILE). Return nil if FILE is a relative
1132 file name.
1134 When IDENTIFICATION is nil, the returned string is a complete
1135 remote identifier: with components method, user, and host. The
1136 components are those present in FILE, with defaults filled in for
1137 any that are missing.
1139 IDENTIFICATION can specify which part of the identification to
1140 return. IDENTIFICATION can be the symbol `method', `user',
1141 `host', or `localname'. Any other value is handled like nil and
1142 means to return the complete identification. The string returned
1143 for IDENTIFICATION `localname' can differ depending on whether
1144 there is an existing connection.
1146 If CONNECTED is non-nil, return an identification only if FILE is
1147 located on a remote system and a connection is established to
1148 that remote system.
1150 Tip: You can use this expansion of remote identifier components
1151 to derive a new remote file name from an existing one. For
1157 same remote identifier as FILE but expanded; a name such as
1162 nil)))
1164 ;; Probably this entire variable should be obsolete now, in favor of
1165 ;; something Tramp-related (?). It is not used in many places.
1166 ;; It's not clear what the best file for this to be in is, but given
1167 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1168 ;; rather than autoloaded.
1170 ;; This used to try various hard-coded places for remsh, rsh, and
1171 ;; rcmd, trying to guess based on location whether "rsh" was
1172 ;; "restricted shell" or "remote shell", but I don't see the point
1173 ;; in this day and age. Almost everyone will use ssh, and have
1174 ;; whatever command they want to use in PATH.
1181 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1188 "Whether to use the remote file-name cache for read access.
1189 When nil, never expire cached values (caution)
1190 When t, never use the cache (safe, but may be slow)
1191 A number means use cached values for that amount of seconds since caching.
1193 The attributes of remote files are cached for better performance.
1194 If they are changed outside of Emacs's control, the cached values
1195 become invalid, and must be reread. If you are sure that nothing
1196 other than Emacs changes the files, you can set this variable to nil.
1198 If a remote file is checked regularly, it might be a good idea to
1199 let-bind this variable to a value less than the interval between
1200 consecutive checks. For example:
1202 (defun display-time-file-nonempty-p (file)
1203 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1204 (and (file-exists-p file)
1205 (< 0 (file-attribute-size
1206 (file-attributes (file-chase-links file)))))))"
1217 "Return the local name component of FILE.
1218 This function removes from FILE the specification of the remote host
1219 and the method of accessing the host, leaving only the part that
1220 identifies FILE locally on the remote system.
1221 The returned file name can be used directly as argument of
1222 `process-file', `start-file-process', or `shell-command'."
1226 "Copy the file FILE into a temporary file on this machine.
1227 Returns the name of the local copy, or nil, if FILE is directly
1228 accessible."
1229 ;; This formerly had an optional BUFFER argument that wasn't used by
1230 ;; anything.
1234 nil)))
1237 "Return non-nil if FILE is an absolute name to the operating system.
1238 This is like `file-name-absolute-p', except that it returns nil for
1239 names beginning with `~'."
1244 "Splice DIRNAME to FILE like the operating system would.
1245 If FILE is relative, return DIRNAME concatenated to FILE.
1246 Otherwise return FILE, quoted as needed if DIRNAME and FILE have
1247 different file name handlers; although this quoting is dubious if
1248 DIRNAME is magic, it is not clear what would be better. This
1249 function differs from `expand-file-name' in that DIRNAME must be
1250 a directory name and leading `~' and `/:' are not special in
1251 FILE."
1253 file
1257 unquoted
1261 "Return the truename of FILENAME.
1262 If FILENAME is not absolute, first expands it against `default-directory'.
1263 The truename of a file name is found by chasing symbolic links
1264 both at the level of the file and at the level of the directories
1265 containing it, until no links are left at any level.
1268 ;; COUNTER and PREV-DIRS are used only in recursive calls.
1269 ;; COUNTER can be a cons cell whose car is the count of how many
1270 ;; more links to chase before getting an error.
1271 ;; PREV-DIRS can be a cons cell whose car is an alist
1272 ;; of truenames we've just recently computed.
1286 ;; For speed, remove the ange-ftp completion handler from the list.
1287 ;; We know it's not needed here.
1288 ;; For even more speed, do this only on the outermost call.
1295 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1296 ;; case differences being ignored by the OS, and short "8.3 DOS"
1297 ;; name aliases existing for all files. (The short names are not
1298 ;; reported by directory-files, but can be used to refer to files.)
1299 ;; It seems appropriate for file-truename to resolve these issues in
1300 ;; the most natural way, which on Windows is to call the function
1301 ;; `w32-long-file-name' - this returns the exact name of a file as
1302 ;; it is stored on disk (expanding short name aliases with the full
1303 ;; name in the process).
1306 ;; If filename exists, use its long name. If it doesn't
1307 ;; exist, the recursion below on the directory of filename
1308 ;; will drill down until we find a directory that exists,
1309 ;; and use the long name of that, with the extra
1310 ;; non-existent path components concatenated.
1315 ;; If this file directly leads to a link, process that iteratively
1316 ;; so that we don't use lots of stack.
1322 ;; For file name that has a special handler, call handler.
1323 ;; This is so that ange-ftp can save time by doing a no-op.
1326 done t)
1328 target dirfile)
1329 ;; Get the truename of the directory.
1331 ;; If these are equal, we have the (or a) root directory.
1335 ;; If this is the same dir we last got the truename for,
1336 ;; save time--don't recalculate.
1346 done t)
1349 done t)
1350 ;; Put it back on the file name.
1352 ;; Is the file name the name of a link?
1355 ;; Yes => chase that link, then start all over
1356 ;; since the link may point to a directory name that uses links.
1357 ;; We can't safely use expand-file-name here
1358 ;; since target might look like foo/../bar where foo
1359 ;; is itself a link. Instead, we handle . and .. above.
1361 done nil)
1362 ;; No, we are done!
1364 filename))
1367 "Chase links in FILENAME until a name that is not a link.
1368 Unlike `file-truename', this does not check whether a parent
1369 directory name is a symbolic link.
1370 If the optional argument LIMIT is a number,
1371 it means chase no more than that many links and then stop."
1379 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1382 ;; Handle `..' by hand, since it needs to work in the
1383 ;; target of any directory symlink.
1384 ;; This code is not quite complete; it does not handle
1385 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1389 ;; Chase links in the default dir of the symlink.
1393 ;; Now find the parent of that dir.
1396 tem))
1398 newname))
1400 ;; A handy function to display file sizes in human-readable form.
1401 ;; See https://en.wikipedia.org/wiki/Kibibyte for the reference.
1403 "Produce a string showing FILE-SIZE in human-readable form.
1405 Optional second argument FLAVOR controls the units and the display format:
1407 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1409 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1411 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1414 Optional third argument SPACE is a string put between the number and unit.
1415 It defaults to the empty string. We recommend a single space or
1416 non-breaking space, unless other constraints prohibit a space in that
1417 position.
1421 in all cases, since that is the standard symbol for byte."
1423 1024.0
1438 "%.1f%s%s"
1440 file-size
1442 prefixed-unit))))
1445 "Human-readable string for SIZE bytes, using IEC prefixes."
1449 "Function that turns a number of bytes into a human-readable string.
1450 It is for use when displaying file sizes and disk space where other
1451 constraints do not force a specific format."
1461 "^//[^/]+/"
1462 ;; regexp-opt.el is not dumped into emacs binary.
1463 ;;(concat
1464 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1466 "File systems that ought to be mounted."
1473 "The directory for writing temporary files.
1474 In case of a remote `default-directory', this is a directory for
1475 temporary files on that remote host. If such a directory does
1476 not exist, or `default-directory' ought to be located on a
1477 mounted file system (see `mounted-file-systems'), the function
1478 returns `default-directory'.
1479 For a non-remote and non-mounted `default-directory', the value of
1480 the variable `temporary-file-directory' is returned."
1486 default-directory
1487 temporary-file-directory))))
1490 "Create a temporary file.
1491 The returned file name (created by appending some random characters at the end
1492 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1493 is guaranteed to point to a newly created file.
1494 You can then use `write-region' to write new data into the file.
1496 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1498 If SUFFIX is non-nil, add that at the end of the file name.
1500 If TEXT is a string, insert it into the new file; DIR-FLAG should be nil.
1501 Otherwise the file will be empty."
1513 "Implement (make-temp-file ABSOLUTE-PREFIX DIR-FLAG SUFFIX TEXT).
1514 This implementation works on magic file names."
1515 ;; Create temp files with strict access rights. It's easy to
1516 ;; loosen them later, whereas it's impossible to close the
1517 ;; time-window of loose permissions otherwise.
1520 file)
1529 nil)
1531 ;; the file was somehow created by someone else between
1532 ;; `make-temp-name' and `write-region', let's try again.
1533 nil)
1534 file)))
1537 "Create a temporary file as close as possible to `default-directory'.
1538 If PREFIX is a relative file name, and `default-directory' is a
1539 remote file name or located on a mounted file systems, the
1540 temporary file is created in the directory returned by the
1541 function `temporary-file-directory'. Otherwise, the function
1542 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1543 same meaning as in `make-temp-file'."
1552 "Change the encoding of FILE's name from CODING to NEW-CODING.
1553 The value is a new name of FILE.
1554 Signals a `file-already-exists' error if a file of the new name
1555 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1556 is non-nil. A number as fourth arg means request confirmation if
1557 the new name already exists. This is what happens in interactive
1558 use with M-x."
1561 default-file-name-coding-system))
1563 from-coding to-coding)
1565 ;; We provide the default coding only when it seems that
1566 ;; the filename is correctly decoded by the default
1567 ;; coding.
1573 filename default-coding)
1574 default-coding))
1578 ;; We provide the default coding only when a user is going to
1579 ;; change the encoding not from the default coding.
1583 filename from-coding)))
1586 default-coding filename from-coding)
1587 default-coding)))
1591 default-file-name-coding-system))
1592 ;; FILE should have been decoded by DEFAULT-CODING.
1596 ;; Suppress further encoding.
1601 newname))
1602 \f
1604 "Whether confirmation is requested before visiting a new file or buffer.
1605 If nil, confirmation is not requested.
1606 If the value is `after-completion', confirmation is requested
1607 only if the user called `minibuffer-complete' right before
1608 `minibuffer-complete-and-exit'.
1609 Any other non-nil value means to request confirmation.
1611 This affects commands like `switch-to-buffer' and `find-file'."
1619 "Whether to request confirmation before visiting a new file or buffer.
1620 The variable `confirm-nonexistent-file-or-buffer' determines the
1621 return value, which may be passed as the REQUIRE-MATCH arg to
1622 `read-buffer' or `find-file-read-args'."
1630 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1632 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1633 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1634 instead of prepending it.
1636 BODY should use the minibuffer at most once.
1637 Recursive uses of the minibuffer are unaffected (FUN is not
1638 called additional times).
1640 This macro actually adds an auxiliary function that calls FUN,
1641 rather than FUN itself, to `minibuffer-setup-hook'."
1652 ;; Clear out this hook so it does not interfere
1653 ;; with any recursive minibuffer usage.
1664 t))
1667 "Edit file FILENAME.
1668 Switch to a buffer visiting file FILENAME,
1669 creating one if none already exists.
1670 Interactively, the default if you just type RET is the current directory,
1671 but the visited file name is available through the minibuffer history:
1675 the file name, the result is affected by `file-name-at-point-functions',
1676 which by default try to guess the file name by looking at point in the
1677 current buffer. Customize the value of `file-name-at-point-functions'
1678 or set it to nil, if you want only the visited file name and the
1680 request.
1682 You can visit files on remote machines by specifying something
1683 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1684 also visit local files as a different user by specifying
1685 /sudo::FILE for the file name.
1686 See the Info node `(tramp)File name Syntax' in the Tramp Info
1687 manual, for more about this.
1689 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1690 expand wildcards (if any) and visit multiple files. You can
1691 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1693 To visit a file without any kind of conversion and without
1704 "Edit file FILENAME, in another window.
1707 an existing one. See the function `display-buffer'.
1709 Interactively, the default if you just type RET is the current directory,
1710 but the visited file name is available through the minibuffer history:
1714 the file name, the result is affected by `file-name-at-point-functions',
1715 which by default try to guess the file name by looking at point in the
1716 current buffer. Customize the value of `file-name-at-point-functions'
1717 or set it to nil, if you want only the visited file name and the
1719 request.
1721 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1722 expand wildcards (if any) and visit multiple files."
1732 value)
1736 "Edit file FILENAME, in another frame.
1739 an existing one. See the function `display-buffer'.
1741 Interactively, the default if you just type RET is the current directory,
1742 but the visited file name is available through the minibuffer history:
1746 the file name, the result is affected by `file-name-at-point-functions',
1747 which by default try to guess the file name by looking at point in the
1748 current buffer. Customize the value of `file-name-at-point-functions'
1749 or set it to nil, if you want only the visited file name and the
1751 request.
1753 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1754 expand wildcards (if any) and visit multiple files."
1764 value)
1768 "Edit the existing file FILENAME.
1770 file names with wildcards."
1787 value))
1790 "Edit file FILENAME but don't allow changes.
1799 "Edit file FILENAME in another window but don't allow changes.
1808 "Edit file FILENAME in another frame but don't allow changes.
1817 "Find file FILENAME as a replacement for the file in the next window.
1818 This command does not select that window.
1822 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1823 expand wildcards (if any) and replace the file with multiple files."
1834 "Find alternate file: " file-dir nil
1836 t))))
1843 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1845 "Hook run when a buffer is killed.
1846 The buffer being killed is current while the hook is running.
1847 See `kill-buffer'.
1849 This hook is not run for internal or temporary buffers created by
1850 `get-buffer-create' or `generate-new-buffer' with argument
1851 INHIBIT-BUFFER-HOOKS non-nil.
1853 Note: Be careful with let-binding this hook considering it is
1857 "Find file FILENAME, select its buffer, kill previous buffer.
1858 If the current buffer now contains an empty file that you just visited
1859 \(presumably by mistake), use this command to visit the file you really want.
1863 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1864 expand wildcards (if any) and replace the file with multiple files.
1866 If the current buffer is an indirect buffer, or the base buffer
1867 for one or more indirect buffers, the other buffer(s) are not
1868 killed."
1877 "Find alternate file: " file-dir nil
1879 t)))
1893 ;; Run `kill-buffer-hook' here. It needs to happen before
1894 ;; variables like `buffer-file-name' etc are set to nil below,
1895 ;; because some of the hooks that could be invoked
1896 ;; (e.g., `save-place-to-alist') depend on those variables.
1897 ;;
1898 ;; Note that `kill-buffer-hook' is not what queries whether to
1899 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1900 ;; asks that itself. Thus, there's no need to temporarily do
1901 ;; `(set-buffer-modified-p nil)' before running this hook.
1903 ;; Okay, now we can end-of-life the old buffer.
1910 ;; This prevents us from finding the same buffer
1911 ;; if we specified the same file again.
1915 ;; Likewise for dired buffers.
1917 ;; Don't use `find-file' because it may end up using another window
1918 ;; in some corner cases, e.g. when the selected window is
1919 ;; softly-dedicated.
1923 ;; This executes if find-file gets an error
1924 ;; and does not really find anything.
1925 ;; We put things back as they were.
1926 ;; If find-file actually finds something, we kill obuf below.
1937 ;; We already ran these; don't run them again.
1940 \f
1941 ;; FIXME we really need to fold the uniquify stuff in here by default,
1942 ;; not using advice, and add it to the doc string.
1944 "Create a suitably named buffer for visiting FILENAME, and return it.
1945 FILENAME (sans directory) is used unchanged if that name is free;
1946 otherwise a string <2> or <3> or ... is appended to get an unused name.
1948 Emacs treats buffers whose names begin with a space as internal buffers.
1949 To avoid confusion when visiting a file whose name begins with a space,
1956 lastname))))
1959 "Regexp to match the automounter prefix in a directory name."
1965 "Regexp matching the user's homedir at the beginning of file name.
1969 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1971 home directory is a root directory) and removes automounter prefixes
1972 \(see the variable `automount-dir-prefix').
1974 When this function is first called, it caches the user's home
1975 directory as a regexp in `abbreviated-home-dir', and reuses it
1976 afterwards (so long as the home directory does not change;
1977 if you want to permanently change your home directory after having
1978 started Emacs, set `abbreviated-home-dir' to nil so it will be recalculated)."
1979 ;; Get rid of the prefixes added by the automounter.
1986 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1988 ;; If any elt of directory-abbrev-alist matches this name,
1989 ;; abbreviate accordingly.
1995 ;; Compute and save the abbreviated homedir name.
1996 ;; We defer computing this until the first time it's needed, to
1997 ;; give time for directory-abbrev-alist to be set properly.
1998 ;; We include a slash at the end, to avoid spurious matches
1999 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
2010 ;; Depending on whether default-directory does or
2011 ;; doesn't include non-ASCII characters, the value
2012 ;; of abbreviated-home-dir could be multibyte or
2013 ;; unibyte. In the latter case, we need to decode
2014 ;; it. Note that this function is called for the
2015 ;; first time (from startup.el) when
2016 ;; locale-coding-system is already set up.
2018 regexp
2021 'utf-8
2022 locale-coding-system))))))
2024 ;; If FILENAME starts with the abbreviated homedir,
2025 ;; and ~ hasn't changed since abbreviated-home-dir was set,
2026 ;; make it start with `~' instead.
2027 ;; If ~ has changed, we ignore abbreviated-home-dir rather than
2028 ;; invalidating it, on the assumption that a change in HOME
2029 ;; is likely temporary (eg for testing).
2030 ;; FIXME Is it even worth caching abbreviated-home-dir?
2031 ;; Ref: https://debbugs.gnu.org/19657#20
2035 ;; If the home dir is just /, don't change it.
2038 ;; MS-DOS root directories can come with a drive letter;
2039 ;; Novell Netware allows drive letters beyond `Z:'.
2047 filename))))
2050 "Return the buffer visiting file FILENAME (a string).
2051 This is like `get-file-buffer', except that it checks for any buffer
2052 visiting the same file, possibly under a different name.
2053 If PREDICATE is non-nil, only buffers satisfying it are eligible,
2054 and others are ignored.
2055 If there is no such live buffer, return nil."
2068 found)
2078 ;; Verify this buffer's file number
2079 ;; still belongs to its file.
2082 attributes)
2086 found))))
2087 \f
2089 "Non-nil means file-visiting commands should handle wildcards.
2090 For example, if you specify `*.c', that would visit all the files
2091 whose names match the pattern."
2097 "Non-nil means suppress warning messages for symlinked files.
2098 When nil, Emacs prints a warning when visiting a file that is already
2099 visited, but with a different name. Setting this option to t
2100 suppresses this warning."
2106 "Maximum size of file above which a confirmation is requested.
2107 When nil, never request confirmation."
2114 "Warn if file size exceeds this percentage of available free memory.
2115 When nil, never issue warning. Beware: This probably doesn't do what you
2131 last-input-event
2133 use-dialog-box))
2148 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
2149 OP-TYPE specifies the file operation being performed (for message
2150 to user). If OFFER-RAW is true, give user the additional option
2151 to open the file literally. If the user chooses this option,
2152 `abort-if-file-too-large' returns the symbol `raw'. Otherwise,
2153 it returns nil or exits non-locally."
2156 ;; No point in warning if we can't read it.
2159 size op-type filename offer-raw))))
2162 choice))
2165 "Warn if an attempt to open file of SIZE bytes may run out of memory."
2175 "You are trying to open a file whose size (%s)
2176 exceeds the %S%% of currently available free memory (%s).
2177 If that fails, try to open it with `find-file-literally'
2178 \(but note that some characters might be displayed incorrectly)."
2180 out-of-memory-warning-percentage
2185 "Like `message', except sometimes don't show the message text.
2186 If the variable `save-silently' is non-nil, the message will not
2187 be visible in the echo area."
2192 "Read file FILENAME into a buffer and return the buffer.
2193 If a buffer exists visiting FILENAME, return that one, but
2194 verify that the file has not changed since visited or saved.
2195 The buffer is not selected, just returned to the caller.
2196 Optional second arg NOWARN non-nil means suppress any warning messages.
2197 Optional third arg RAWFILE non-nil means the file is read literally.
2198 Optional fourth arg WILDCARDS non-nil means do wildcard processing
2199 and visit all the matching files. When wildcards are actually
2200 used and expanded, return a list of buffers that are visiting
2201 the various files."
2208 'find-directory-functions
2211 filename)))
2214 find-file-wildcards
2228 ;; Find any buffer for a file that has same truename.
2230 ;; Let user know if there is a buffer with the same truename.
2234 find-file-suppress-same-file-warnings
2238 ;; Optionally also find that buffer.
2241 ;; Check to see if the file looks uncommonly large.
2249 ;; We are using an existing buffer.
2256 ;; Certain files should be reverted automatically
2257 ;; if they have changed on disk and not in the buffer.
2265 found))
2275 "File %s changed on disk. Discard your edits? "
2280 "File %s changed on disk. Discard your edits in %s? "
2288 ;; Check if a formerly read-only file has become
2289 ;; writable and vice versa, but if the buffer agrees
2290 ;; with the new state of the file, that is ok too.
2300 buffer-file-name
2301 new-status new-status)))
2307 nonexistent
2308 ;; It is confusing to ask whether to visit
2309 ;; non-literally if they have the file in
2310 ;; hexl-mode or image-mode.
2316 The file %s is already visited normally,
2317 and you have edited the buffer. Now you have asked to visit it literally,
2318 meaning no coding system handling, format conversion, or local variables.
2319 Emacs can visit a file in only one way at a time."
2320 "\
2321 The file %s is already visited literally,
2322 meaning no coding system handling, format conversion, or local variables.
2323 You have edited the buffer. Now you have asked to visit the file normally,
2333 rawfile truename number))
2339 rawfile truename number)
2345 The file %s is already visited normally.
2346 You have asked to visit it literally,
2347 meaning no coding system decoding, format conversion, or local variables.
2348 But Emacs can visit a file in only one way at a time."
2349 "\
2350 The file %s is already visited literally,
2351 meaning no coding system decoding, format conversion, or local variables.
2352 You have asked to visit it normally,
2360 rawfile truename number)
2363 ;; Return the buffer we are using.
2364 buf)
2365 ;; Create a new buffer.
2367 ;; find-file-noselect-1 may use a different buffer.
2369 rawfile truename number))))))
2375 ;; Needed in case we are re-visiting the file with a different
2376 ;; text representation.
2392 filename)))
2393 ;; Unconditionally set error
2403 filename)))
2404 ;; Run find-file-not-found-functions until one returns non-nil.
2406 ;; If they fail too, set error.
2408 ;; Record the file's truename, and maybe use that as visited name.
2411 truename
2416 ;; Set buffer's default directory to that of the file.
2418 ;; Turn off backup files for certain file names. Since
2419 ;; this is a permanent local, the major mode won't eliminate it.
2431 \f
2433 "Like `insert-file-contents', but only reads in the file literally.
2434 See `insert-file-contents' for an explanation of the parameters.
2435 A buffer may be modified in several ways after reading into the buffer,
2436 due to Emacs features such as format decoding, character code
2437 conversion, `find-file-hook', automatic uncompression, etc.
2439 This function ensures that none of these modifications will take place."
2445 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2446 ;; into a file operation instead!
2449 inhibit-file-name-handlers)))
2456 filename)))
2457 ;; Check whether the file is uncommonly large
2469 "Insert contents of file FILENAME into buffer after point with no conversion.
2471 This function is meant for the user to run interactively.
2472 Don't call it from programs! Use `insert-file-contents-literally' instead.
2473 \(Its calling sequence is different; see its documentation)."
2479 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2480 This has the `permanent-local' property, which takes effect if you
2485 "Visit file FILENAME with no conversion of any kind.
2486 Format conversion and character code conversion are both disabled,
2487 and multibyte characters are disabled in the resulting buffer.
2488 The major mode used is Fundamental mode regardless of the file name,
2489 and local variable specifications in the file are ignored.
2490 Automatic uncompression and adding a newline at the end of the
2491 file due to `require-final-newline' is also disabled.
2493 If Emacs already has a buffer that is visiting the file,
2494 this command asks you whether to visit it literally instead.
2496 In non-interactive use, the value is the buffer where the file is
2497 visited literally. If the file was visited in a buffer before
2498 this command was invoked, it will reuse the existing buffer,
2499 regardless of whether it was created literally or not; however,
2500 the contents of that buffer will be the literal text of the file
2501 without any conversions.
2503 In a Lisp program, if you want to be sure of accessing a file's
2504 contents literally, you should create a temporary buffer and then read
2505 the file contents into it using `insert-file-contents-literally'."
2508 "Find file literally: " nil default-directory
2511 \f
2513 _after-find-file-from-revert-buffer
2514 nomodes)
2515 "Called after finding a file and by the default revert function.
2516 Sets buffer mode, parses file-local and directory-local variables.
2517 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2518 error in reading the file. WARN non-nil means warn if there
2519 exists an auto-save file more recent than the visited file.
2520 NOAUTO means don't mess with auto-save mode.
2521 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2522 \(see `revert-buffer-in-progress-p' for similar functionality).
2523 Fifth arg NOMODES non-nil means don't alter the file's modes.
2524 Finishes by calling the functions in `find-file-hook'
2525 unless NOMODES is non-nil."
2528 nil
2540 ;; No need to warn if buffer is auto-saved
2541 ;; under the name of the visited file.
2543 auto-save-visited-file-name))
2546 buffer-file-name))
2565 ;; Make people do a little extra work (C-x C-q)
2566 ;; before altering a backup file.
2567 ;; When a file is marked read-only,
2568 ;; make the buffer read-only even if root is looking at it.
2578 ;; If requested, add a newline at the end of the file.
2589 view-read-only
2597 "Choose the major mode for this buffer automatically.
2598 Also sets up any specified local variables of the file or its directory.
2599 Uses the visited file name, the -*- line, and the local variables spec.
2601 This function is called automatically from `find-file'. In that case,
2602 we may set up the file-specified mode and local variables,
2603 depending on the value of `enable-local-variables'.
2604 In addition, if `local-enable-local-variables' is nil, we do
2605 not set local variables (though we do notice a mode specified with -*-.)
2607 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2608 or from Lisp without specifying the optional argument FIND-FILE;
2609 in that case, this function acts as if `enable-local-variables' were t."
2616 ;; FIXME this is less efficient than it could be, since both
2617 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2620 ;; `delay-mode-hooks' being non-nil will have prevented the major
2621 ;; mode's call to `run-mode-hooks' from calling
2622 ;; `hack-local-variables'. In that case, call it now.
2626 ;; Turn font lock off and on, to make sure it takes account of
2627 ;; whatever file local variables are relevant to it.
2629 ;; Font-lock-mode (now in font-core.el) can be ON when
2630 ;; font-lock.el still hasn't been loaded.
2637 "Non-nil means to try second pass through `auto-mode-alist'.
2638 This means that if the first case-sensitive search through the alist fails
2639 to find a matching major mode, a second case-insensitive search is made.
2640 On systems with case-insensitive file names, this variable is ignored,
2641 since only a single case-insensitive search through the alist is made."
2647 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2648 ;; c++-mode, java-mode and more) are added through autoload
2649 ;; directives in that file. That way is discouraged since it
2650 ;; spreads out the definition of the initial value.
2671 ;; .dir-locals.el is not really Elisp. Could use the
2672 ;; `dir-locals-file' constant if it weren't defined below.
2702 ;; Less common extensions come here
2703 ;; so more common ones above are found faster.
2711 ;; Besides .gdbinit, gdb documents other names to be usable for init
2712 ;; files, cross-debuggers can use something like
2713 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2714 ;; don't interfere with each other.
2716 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2717 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2718 ;; loaded when GDB reads an objfile called 'emacs'.
2727 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2739 ;; These .m4 files are Autoconf files.
2753 ;; The Fortran standard does not say anything about file extensions.
2754 ;; .f90 was widely used for F90, now we seem to be trapped into
2755 ;; using a different extension for each language revision.
2756 ;; Anyway, the following extensions are supported by gfortran.
2764 ;; The list of archive file extensions should be in sync with
2765 ;; `auto-coding-alist' with `no-conversion' coding system.
2771 ;; Mailer puts message to be edited in
2772 ;; /tmp/Re.... or Message
2775 ;; some news reader is reported to use this
2784 ;; https://en.wikipedia.org/wiki/.har
2790 ;; .emacs or .gnus or .viper following a directory delimiter in
2791 ;; Unix or MS-DOS syntax.
2794 ;; _emacs following a directory delimiter in MS-DOS syntax
2798 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2799 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2800 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2803 ;; .xs is also used for ld scripts, but seems to be more commonly
2804 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2806 ;; Explained in binutils ld/genscripts.sh. Eg:
2807 ;; A .x script file is the default script.
2808 ;; A .xr script is for linking without relocation (-r flag). Etc.
2812 ;; Common Lisp ASDF package system.
2819 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2832 ;; Windows candidates may be opened case sensitively on Unix
2841 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2842 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2843 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2844 ;; this has lower priority to avoid matching changelog.sgml etc.
2846 ;; either user's dot-files or under /etc or some such
2848 ;; alas not all ~/.*rc files are like this
2849 ("/\\.\\(?:asound\\|enigma\\|fetchmail\\|gltron\\|gtk\\|hxplayer\\|mairix\\|mbsync\\|msmtp\\|net\\|neverball\\|nvidia-settings-\\|offlineimap\\|qt/.+\\|realplayer\\|reportbug\\|rtorrent\\.\\|screen\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2850 ("/\\.\\(?:gdbtkinit\\|grip\\|mpdconf\\|notmuch-config\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2854 ;; this contains everything twice, with space and with colon :-(
2856 ;; Get rid of any trailing .n.m and try again.
2857 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2858 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2859 ;; Using mode nil rather than `ignore' would let the search continue
2860 ;; through this list (with the shortened name) rather than start over.
2863 ;; This should come after "in" stripping (e.g. config.h.in).
2864 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2866 ;; The following should come after the ChangeLog pattern
2867 ;; for the sake of ChangeLog.1, etc.
2868 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2870 ;; Image file types probably supported by `image-convert'.
2914 "Alist of filename patterns vs corresponding major mode functions.
2915 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2916 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2917 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2918 mode function to use. FUNCTION will be called, unless it is nil.
2920 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2921 calling FUNCTION (if it's not nil), we delete the suffix that matched
2922 REGEXP and search the list again for another match.
2924 The extensions whose FUNCTION is `archive-mode' should also
2925 appear in `auto-coding-alist' with `no-conversion' coding system.
2927 See also `interpreter-mode-alist', which detects executable script modes
2928 based on the interpreters they specify to run,
2933 "Select Conf mode or XML mode according to start of file."
2943 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2944 ;; and pike-mode) are added through autoload directives in that
2945 ;; file. That way is discouraged since it spreads out the
2946 ;; definition of the initial value.
2975 "Alist mapping interpreter names to major modes.
2976 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2977 Each element looks like (REGEXP . MODE).
2978 If REGEXP matches the entire name (minus any directory part) of
2979 the interpreter specified in the first line of a script, enable
2980 major mode MODE.
2987 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2988 ;; because we are duplicating info from auto-mode-alist.
2989 ;; TODO many elements of this list are also in auto-coding-alist.
2998 "List of regexps matching file names in which to ignore local variables.
3000 Files matching this list are typically binary file formats.
3001 They may happen to contain sequences that look like local variable
3002 specifications, but are not really, or they may be containers for
3003 member files with their own local variable sections, which are
3004 not appropriate for the containing file.
3011 "List of regexps matching suffixes to remove from file names.
3012 The function `inhibit-local-variables-p' uses this: when checking
3013 a file name, it first discards from the end of the name anything that
3016 ;; Can't think of any situation in which you'd want this to be nil...
3021 "Return non-nil if file local variables should be ignored.
3022 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
3023 and `inhibit-local-variables-suffixes'. If
3024 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
3033 sufs)
3038 temp))
3043 "Regexp matching interpreters, for file mode determination.
3044 This regular expression is matched against the first line of a file
3045 to determine the file's mode in `set-auto-mode'. If it matches, the file
3046 is assumed to be interpreted by the interpreter matched by the second group
3047 of the regular expression. The mode is then determined as the mode
3051 "Alist of buffer beginnings vs. corresponding major mode functions.
3052 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
3053 After visiting a file, if REGEXP matches the text at the beginning of the
3054 buffer (case-sensitively), or calling MATCH-FUNCTION returns non-nil,
3055 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist' to
3056 decide the buffer's major mode.
3058 If FUNCTION is nil, then it is not called. (That is a way of saying
3066 ;; The < comes before the groups (but the first) to reduce backtracking.
3067 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
3068 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
3072 comment-re "*"
3075 . mhtml-mode)
3077 ;; These two must come after html, because they are more general:
3082 . sgml-mode)
3086 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
3087 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
3088 After visiting a file, if REGEXP matches the text at the beginning of the
3089 buffer (case-sensitively), or calling MATCH-FUNCTION returns non-nil,
3090 `normal-mode' will call FUNCTION, provided that `magic-mode-alist' and
3091 `auto-mode-alist' have not specified a mode for this file.
3097 "Upper limit on `magic-mode-alist' regexp matches.
3101 "Select major mode appropriate for current buffer.
3103 To find the right major mode, this function checks for a -*- mode tag
3104 checks for a `mode:' entry in the Local Variables section of the file,
3105 checks if it uses an interpreter listed in `interpreter-mode-alist',
3106 matches the buffer beginning against `magic-mode-alist',
3107 compares the filename against the entries in `auto-mode-alist',
3108 then matches the buffer beginning against `magic-fallback-mode-alist'.
3110 If `enable-local-variables' is nil, or if the file name matches
3111 `inhibit-local-variables-regexps', this function does not check
3112 for any mode: tag anywhere in the file. If `local-enable-local-variables'
3113 is nil, then the only mode: tag that can be relevant is a -*- one.
3115 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
3116 set the major mode only if that would change it. In other words
3117 we don't actually set it to the same mode the buffer already has."
3118 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
3120 end done mode modes)
3121 ;; Once we drop the deprecated feature where mode: is also allowed to
3122 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
3123 ;; remove this section and just let (hack-local-variables t) handle it.
3124 ;; Find a -*- mode tag.
3128 ;; Note by design local-enable-local-variables does not matter here.
3130 try-locals
3133 ;; Find all specifications for the `mode:' variable
3134 ;; and execute them left to right.
3146 modes)))
3147 ;; Simple -*-MODE-*- case.
3150 modes))))
3151 ;; If we found modes to use, invoke them now, outside the save-excursion.
3159 ;; continuing would call minor modes again, toggling them off
3161 ;; hack-local-variables checks local-enable-local-variables etc, but
3162 ;; we might as well be explicit here for the sake of clarity.
3164 enable-local-variables
3165 local-enable-local-variables
3166 try-locals
3173 ;; If we didn't, look for an interpreter specified in the first line.
3174 ;; As a special case, allow for things like "#!/bin/env perl", which
3175 ;; finds the interpreter anywhere in $PATH.
3181 ;; Map interpreter name to a mode, signaling we're done at the
3182 ;; same time.
3189 interpreter-mode-alist)
3191 ;; If we found an interpreter mode to use, invoke it now.
3193 ;; Next try matching the buffer beginning against magic-mode-alist.
3202 nil magic-mode-alist
3212 "Problem in magic-mode-alist with element %s"
3213 re))))))))
3215 ;; Next compare the filename against the entries in auto-mode-alist.
3221 buffer-file-name)))
3222 ;; Remove backup-suffixes from file name.
3224 ;; Remove remote file name identification.
3229 ;; Find first matching alist entry.
3232 ;; Filesystem is case-insensitive.
3236 ;; Filesystem is case-sensitive.
3238 ;; First match case-sensitively.
3242 ;; Fallback to case-insensitive match.
3256 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
3274 "Problem with magic-fallback-mode-alist element: %s"
3275 re))))))))
3280 ;; When `keep-mode-if-same' is set, we are working on behalf of
3281 ;; set-visited-file-name. In that case, if the major mode specified is the
3282 ;; same one we already have, don't actually reset it. We don't want to lose
3283 ;; minor modes such as Font Lock.
3285 "Apply MODE and return it.
3286 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
3287 any aliases and compared to current major mode. If they are the
3288 same, do nothing and return nil."
3294 mode)))
3297 "Regexp of lines to skip when looking for file-local settings.
3298 If the first line matches this regular expression, then the -*-...-*- file-
3302 "Find the -*- spec in the buffer.
3303 Call with point at the place to start searching from.
3304 If one is found, set point to the beginning and return the position
3305 of the end. Otherwise, return nil; may change point.
3306 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3307 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3308 have no effect."
3311 ;; Don't look for -*- if this file name matches any
3312 ;; of the regexps in inhibit-local-variables-regexps.
3315 ;; If the file begins with "#!" (exec
3316 ;; interpreter magic), look for mode frobs
3317 ;; in the first two lines. You cannot
3318 ;; necessarily put them in the first line
3319 ;; of such a file without screwing up the
3320 ;; interpreter invocation. The same holds
3321 ;; for '\" in man pages (preprocessor
3322 ;; magic for the `man' program).
3333 end))))
3334 \f
3335 ;;; Handling file local variables
3339 file-local-variables-alist dir-local-variables-alist)
3344 "Normal hook run after processing a file's local variables specs.
3345 Major modes can use this to examine user-specified local variables
3349 "List variable-value pairs that are considered safe.
3350 Each element is a cons cell (VAR . VAL), where VAR is a variable
3351 symbol and VAL is a value that is considered safe."
3352 :risky t
3357 ;; This should be here at least as long as Emacs supports write-file-hooks.
3362 "Expressions that are considered safe in an `eval:' local variable.
3363 Add expressions to this list if you want Emacs to evaluate them, when
3364 they appear in an `eval' local variable specification, without first
3365 asking you for confirmation."
3366 :risky t
3371 ;; Risky local variables:
3374 buffer-auto-save-file-name
3375 buffer-file-name
3376 buffer-file-truename
3377 buffer-undo-list
3378 debugger
3379 default-text-properties
3380 eval
3381 exec-directory
3382 exec-path
3383 file-name-handler-alist
3384 frame-title-format
3385 global-mode-string
3386 header-line-format
3387 icon-title-format
3388 inhibit-quit
3389 load-path
3390 max-lisp-eval-depth
3391 max-specpdl-size
3392 minor-mode-map-alist
3393 minor-mode-overriding-map-alist
3394 mode-line-format
3395 mode-name
3396 overriding-local-map
3397 overriding-terminal-local-map
3398 process-environment
3399 standard-input
3400 standard-output
3401 unread-command-events))
3403 ;; Safe local variables:
3404 ;;
3405 ;; For variables defined by major modes, the safety declarations can go into
3406 ;; the major mode's file, since that will be loaded before file variables are
3407 ;; processed.
3408 ;;
3409 ;; For variables defined by minor modes, put the safety declarations in the
3410 ;; file defining the minor mode after the defcustom/defvar using an autoload
3411 ;; cookie, e.g.:
3412 ;;
3413 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3414 ;;
3415 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3416 ;; minor mode file may not be loaded yet.
3417 ;;
3418 ;; For variables defined in the C source code the declaration should go here:
3441 "Alist of file-local variable settings in the current buffer.
3442 Each element in this list has the form (VAR . VALUE), where VAR
3443 is a file-local variable (a symbol) and VALUE is the value
3444 specified. The actual value in the buffer may differ from VALUE,
3449 "Alist of directory-local variable settings in the current buffer.
3450 Each element in this list has the form (VAR . VALUE), where VAR
3451 is a directory-local variable (a symbol) and VALUE is the value
3452 specified in .dir-locals.el. The actual value in the buffer
3453 may differ from VALUE, if it is changed by the major or minor modes,
3457 "Normal hook run before setting file-local variables.
3458 It is called after checking for unsafe/risky variables and
3459 setting `file-local-variables-alist', and before applying the
3460 variables stored in `file-local-variables-alist'. A hook
3461 function is allowed to change the contents of this alist.
3463 This hook is called only if there is at least one file-local
3467 "Get confirmation before setting up local variable values.
3468 ALL-VARS is the list of all variables to be set up.
3469 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3470 RISKY-VARS is the list of those that are marked as risky.
3471 If these settings come from directory-local variables, then
3472 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3479 unsafe-vars))
3481 ;; Set up the contents of the *Local Variables* buffer.
3489 ", and variables that are risky (**)."
3497 y -- to apply the local variables list.
3501 ! -- to apply the local variables list, and permanently mark these
3513 ;; Make strings with embedded whitespace easier to read.
3521 ;; Display the buffer and read a choice.
3529 ""
3531 char)
3543 "Return local variables specified in the -*- line.
3544 Usually returns an alist of elements (VAR . VAL), where VAR is a
3545 variable and VAL is the specified value. Ignores any
3546 specification for `coding:', and sometimes for `mode' (which
3547 should have already been handled by `set-auto-coding' and
3548 `set-auto-mode', respectively). Return nil if the -*- line is
3549 malformed.
3551 If HANDLE-MODE is nil, we return the alist of all the local
3552 variables in the line except `coding' as described above. If it
3553 is neither nil nor t, we do the same, except that any settings of
3554 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3555 all settings in the line except for `mode', which \(if present) we
3556 return as the symbol specifying the mode."
3561 result)
3563 nil)
3565 ;; Simple form: "-*- MODENAME -*-".
3569 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3570 ;; (last ";" is optional).
3571 ;; If HANDLE-MODE is t, just check for `mode'.
3572 ;; Otherwise, parse the -*- line into the RESULT alist.
3580 ;; There used to be a downcase here,
3581 ;; but the manual didn't say so,
3582 ;; and people want to set var names that aren't all lc.
3586 ;; As a defensive measure, we do not allow
3587 ;; circular data in the file-local data.
3590 ;; It is traditional to ignore
3591 ;; case when checking for `mode' in set-auto-mode,
3592 ;; so we must do that here as well.
3593 ;; That is inconsistent, but we're stuck with it.
3594 ;; The same can be said for `coding' in set-auto-coding.
3608 ;; Downcase "Mode:".
3611 val)
3612 result)
3615 result))))))
3618 "Filter local variable settings, querying the user if necessary.
3619 VARIABLES is the alist of variable-value settings. This alist is
3620 filtered based on the values of `ignored-local-variables',
3621 `enable-local-eval', `enable-local-variables', and (if necessary)
3622 user interaction. The results are added to
3623 `file-local-variables-alist', without applying them.
3624 If these settings come from directory-local variables, then
3625 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3626 ;; Find those variables that we may want to save to
3627 ;; `safe-local-variable-values'.
3633 ;; Ignore any variable in `ignored-local-variables'.
3634 nil)
3635 ;; Obey `enable-local-eval'.
3639 ;; In case previously marked safe (bug#5636).
3641 ;; If not safe and e-l-v = :safe, ignore totally.
3645 safe
3647 ;; Ignore duplicates (except `mode') in the present list.
3649 ;; Accept known-safe variables.
3653 ;; The variable is either risky or unsafe:
3660 ;; Query, unless all vars are safe or user wants no querying.
3666 risky-vars dir-name))
3676 ;; TODO? Warn once per file rather than once per session?
3680 "Parse and put into effect this buffer's local variables spec.
3681 For buffers visiting files, also puts into effect directory-local
3682 variables.
3683 Uses `hack-local-variables-apply' to apply the variables.
3685 If HANDLE-MODE is nil, we apply all the specified local
3686 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3687 except that any settings of `mode' are ignored.
3690 is specified, and return the corresponding mode symbol, or nil.
3691 In this case, we try to ignore minor-modes, and return only a
3692 major-mode.
3694 If `enable-local-variables' or `local-enable-local-variables' is nil,
3695 this function does nothing. If `inhibit-local-variables-regexps'
3696 applies to the file in question, the file is not scanned for
3697 local variables, but directory-local variables may still be applied."
3698 ;; We don't let inhibit-local-variables-p influence the value of
3699 ;; enable-local-variables, because then it would affect dir-local
3700 ;; variables. We don't want to search eg tar files for file local
3701 ;; variable sections, but there is no reason dir-locals cannot apply
3702 ;; to them. The real meaning of inhibit-local-variables-p is "do
3703 ;; not scan this file for local variables".
3706 result)
3713 ;; Note this is a no-op if enable-local-variables is nil.
3717 ;; Note this is a no-op if enable-local-variables is nil.
3719 ;; This entire function is basically a no-op if enable-local-variables
3720 ;; is nil. All it does is set file-local-variables-alist to nil.
3722 ;; This part used to ignore enable-local-variables when handle-mode
3723 ;; was t. That was inappropriate, eg consider the
3724 ;; (artificial) example of:
3725 ;; (setq local-enable-local-variables nil)
3726 ;; Open a file foo.txt that contains "mode: sh".
3727 ;; It correctly opens in text-mode.
3728 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3730 ;; If HANDLE-MODE is t, and the prop line specifies a
3731 ;; mode, then we're done, and have no need to scan further.
3733 handle-mode))
3735 ;; Look for "Local variables:" line in last page.
3743 ;; suffix is what comes after "local variables:" in its line.
3744 ;; prefix is what comes before "local variables:" in its line.
3757 endpos
3763 nil t))
3764 ;; This used to be an error, but really all it means is
3765 ;; that this may simply not be a local-variables section,
3766 ;; so just ignore it.
3776 ;; Discard the prefix.
3781 ;; Discard the suffix.
3790 ;; Find the variable name;
3798 val val2)
3801 ;; Read the variable value.
3804 ;; As a defensive measure, we do not allow
3805 ;; circular data in the file-local data.
3810 ;; Specifying minor-modes via mode: is
3811 ;; deprecated, but try to reject them anyway.
3821 'files
3823 "%s: `lexical-binding' at end of file unreliable"
3825 ;; We are called from
3826 ;; 'with-temp-buffer', so we need
3827 ;; to use 'thisbuf's name in the
3828 ;; warning message.
3834 'eval
3836 val)
3837 result))))))
3839 ;; Now we've read all the local variables.
3840 ;; If HANDLE-MODE is t, return whether the mode was specified.
3842 ;; Otherwise, set the variables.
3847 "Apply the elements of `file-local-variables-alist'.
3848 If there are any elements, runs `before-hack-local-variables-hook',
3849 then calls `hack-one-local-variable' to apply the alist elements one by one.
3850 Finishes by running `hack-local-variables-hook', regardless of whether
3851 the alist is empty or not.
3853 Note that this function ignores a `mode' entry if it specifies the same
3854 major mode as the buffer already has."
3856 ;; Any 'evals must run in the Right sequence.
3865 "Non-nil if SYM is safe as a file-local variable with value VAL.
3866 It is safe if any of these conditions are met:
3868 * There is a matching entry (SYM . VAL) in the
3869 `safe-local-variable-values' user option.
3871 * The `safe-local-variable' property of SYM is a function that
3872 evaluates to a non-nil value with VAL as an argument."
3876 ;; If the function signals an error, that means it
3877 ;; can't assure us that the value is safe.
3881 "Non-nil if SYM could be dangerous as a file-local variable.
3882 It is dangerous if either of these conditions are met:
3884 * Its `risky-local-variable' property is non-nil.
3890 ;; If this is an alias, check the base name.
3910 "Return non-nil if it is safe to eval EXP when it is found in a file."
3912 ;; Detect certain `put' expressions.
3919 lisp-indent-function
3920 scheme-indent-function))
3921 ;; Allow only safe values (not functions).
3926 ;; Allow only indirect form specs.
3927 ;; During bootstrapping, edebug-basic-spec might not be
3928 ;; defined yet.
3932 ;; Allow expressions that the user requested.
3934 ;; Certain functions can be allowed with safe arguments
3935 ;; or can specify verification functions to try.
3937 ;; Allow (minor)-modes calls with no arguments.
3938 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3947 ok))
3955 ok))))))))
3969 "Set local variable VAR with value VAL.
3970 If VAR is `mode', call `VAL-mode' as a function unless it's
3971 already the major mode."
3973 ('mode
3979 ('eval
3985 ;; Make sure the string has no text properties.
3986 ;; Some text properties can get evaluated in various ways,
3987 ;; so it is risky to put them on with a local variable list.
3991 \f
3992 ;;; Handling directory-local variables, aka project settings.
3998 "List of cached directory roots for directory-local variable classes.
3999 Each element in this list has the form (DIR CLASS MTIME).
4000 DIR is the name of the directory.
4001 CLASS is the name of a variable class (a symbol).
4002 MTIME is the recorded modification time of the directory-local
4003 variables file associated with this entry. This time is a Lisp
4004 timestamp (the same format as `current-time'), and is
4005 used to test whether the cache entry is still valid.
4006 Alternatively, MTIME can be nil, which means the entry is always
4010 "Return the variable list for CLASS."
4014 "Collect directory-local variables from MODE-VARIABLES.
4015 VARIABLES is the initial list of variables.
4016 Returns the new list."
4021 ;; If variables are specified more than once, use only the last. (Why?)
4022 ;; The pseudo-variables mode and eval are different (bug#3430).
4025 ;; Need a new cons in case we setcdr later.
4029 "Collect entries from CLASS-VARIABLES into VARIABLES.
4030 ROOT is the root directory of the project.
4031 Return the new variables list."
4033 ;; Handle non-file buffers, too.
4037 ;; FIXME: Why not use file-relative-name?
4044 ;; Don't include this in the previous condition, because we
4045 ;; want to filter all strings before the next condition.
4059 ;; TODO someone might want to extend this to allow
4060 ;; integer values for subdir, where N means
4061 ;; variables apply to this directory and N levels
4062 ;; below it (0 == nil).
4065 alist variables))))))))
4067 ;; The file's content might be invalid (e.g. have a merge conflict), but
4068 ;; that shouldn't prevent the user from opening the file.
4070 nil))))
4073 "Declare that the DIRECTORY root is an instance of CLASS.
4074 DIRECTORY is the name of a directory, a string.
4075 CLASS is the name of a project class, a symbol.
4076 MTIME is either the modification time of the directory-local
4077 variables file that defined this class, or nil.
4079 When a file beneath DIRECTORY is visited, the mode-specific
4080 variables from CLASS are applied to the buffer. The variables
4081 for a class are defined using `dir-locals-set-class-variables'."
4088 "Map the type CLASS to a list of variable settings.
4089 CLASS is the project class, a symbol. VARIABLES is a list
4090 that declares directory-local variables for the class.
4091 An element in VARIABLES is either of the form:
4092 (MAJOR-MODE . ALIST)
4093 or
4094 (DIRECTORY . LIST)
4096 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
4097 whose elements are of the form (VARIABLE . VALUE).
4099 In the second form, DIRECTORY is a directory name (a string), and
4100 LIST is a list of the form accepted by the function.
4102 When a file is visited, the file's class is found. A directory
4103 may be assigned a class using `dir-locals-set-directory-class'.
4104 Then variables are set in the file's buffer according to the
4105 VARIABLES list of the class. The list is processed in order.
4107 * If the element is of the form (MAJOR-MODE . ALIST), and the
4108 buffer's major mode is derived from MAJOR-MODE (as determined
4109 by `derived-mode-p'), then all the variables in ALIST are
4110 applied. A MAJOR-MODE of nil may be used to match any buffer.
4111 `make-local-variable' is called for each variable before it is
4112 set.
4114 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
4115 is an initial substring of the file's directory, then LIST is
4116 applied by recursively following these rules."
4120 "File that contains directory-local variables.
4121 It has to be constant to enforce uniform values across different
4122 environments and users.
4124 A second dir-locals file can be used by a user to specify their
4125 personal dir-local variables even if the current directory
4126 already has a `dir-locals-file' that is shared with other
4127 users (such as in a git repository). The name of this second
4129 `dir-locals-file'. With the default value of `dir-locals-file',
4136 "Return a list of all readable dir-locals files in DIRECTORY.
4137 The returned list is sorted by increasing priority. That is,
4138 values specified in the last file should take precedence over
4139 those in the first."
4143 dir-locals-file)
4144 directory))
4148 ;; The order here is important.
4152 ;; FIXME: Aren't file-regular-p and
4153 ;; file-directory-p mutually exclusive?
4157 out)))
4160 "Find the directory-local variables for FILE.
4161 This searches upward in the directory tree from FILE.
4162 It stops at the first directory that has been registered in
4163 `dir-locals-directory-cache' or contains a `dir-locals-file'.
4164 If it finds an entry in the cache, it checks that it is valid.
4165 A cache entry with no modification time element (normally, one that
4166 has been assigned directly using `dir-locals-set-directory-class', not
4167 set from a file) is always valid.
4168 A cache entry based on a `dir-locals-file' is valid if the modification
4169 time stored in the cache matches the current file modification time.
4170 If not, the cache entry is cleared so that the file will be re-read.
4172 This function returns either:
4173 - nil (no directory local variables found),
4174 - the matching entry from `dir-locals-directory-cache' (a list),
4175 - or the full path to the directory (a string) containing at
4176 least one `dir-locals-file' in the case of no valid cache
4177 entry."
4181 dir-elt)
4182 ;; `locate-dominating-file' may have abbreviated the name.
4185 ;; Find the best cached value in `dir-locals-directory-cache'.
4196 ;; Found a potential cache entry. Check validity.
4197 ;; A cache entry with no MTIME is assumed to always be valid
4198 ;; (ie, set directly, not from a dir-locals file).
4199 ;; Note, we don't bother to check that there is a matching class
4200 ;; element in dir-locals-class-alist, since that's done by
4201 ;; dir-locals-set-directory-class.
4204 ;; The entry MTIME should match the most recent
4205 ;; MTIME among matching files.
4215 ;; This cache entry is OK.
4216 dir-elt
4217 ;; This cache entry is invalid; clear it.
4220 ;; Return the first existing dir-locals file. Might be the same
4221 ;; as dir-elt's, might not (eg latter might have been deleted).
4222 locals-dir)
4223 ;; No cache entry.
4224 locals-dir)))
4230 "Return a number used for sorting the definitions of dir locals.
4231 NODE is assumed to be a cons cell where the car is either a
4232 string or a symbol representing a mode name.
4234 If it is a mode then the depth of the mode (ie, how many parents
4235 that mode has) will be returned.
4237 If it is a string then the length of the string plus 1000 will be
4238 returned.
4240 Otherwise it returns -1.
4242 That way the value can be used to sort the list such that deeper
4243 modes will be after the other modes. This will be followed by
4244 directory entries in order of length. If the entries are all
4245 applied in order then that means the more specific modes will
4246 override the values specified by the earlier modes and directory
4247 variables will override modes."
4255 depth))
4261 "Sorts VARIABLES so that applying them in order has the right effect.
4262 The variables are compared by dir-locals--get-sort-score.
4263 Directory entries are then recursively sorted using the same
4264 criteria."
4273 variables)
4276 "Load all variables files in DIR and register a new class and instance.
4277 DIR is the absolute name of a directory, which must contain at
4278 least one dir-local file (which is a file holding variables to
4279 apply).
4280 Return the new class name, which is a symbol named DIR."
4283 ;; If there was a problem, use the values we could get but
4284 ;; don't let the cache prevent future reads.
4297 ;; As a defensive measure, we do not allow
4298 ;; circular data in the file/dir-local data.
4303 ;; Try and avoid loading `map' since that also loads cl-lib
4304 ;; which then might hamper bytecomp warnings (bug#30635).
4308 ;; We want to make the variable setting from
4309 ;; newvars (the second .dir-locals file) take
4310 ;; presedence over the old variables, but we also
4311 ;; want to preserve all `eval' elements as is from
4312 ;; both lists.
4314 'list
4327 variables
4328 newvars))))))
4333 class-name))
4339 "Non-nil means dir-local variables will be applied to remote files."
4347 "Read per-directory local variables for the current buffer.
4348 Store the directory-local variables in `dir-local-variables-alist'
4349 and `file-local-variables-alist', without applying them.
4351 This does nothing if either `enable-local-variables' or
4352 `enable-dir-local-variables' are nil."
4354 enable-dir-local-variables
4357 default-directory)))))
4358 ;; Find the variables file.
4388 "Apply directory-local variables to a non-file buffer.
4389 For non-file buffers, such as Dired buffers, directory-local
4390 variables are looked for in `default-directory' and its parent
4391 directories."
4395 \f
4398 However, the mode will not be changed if
4399 \(1) a local variables list or the `-*-' line specifies a major mode, or
4401 not suitable for ordinary files, or
4402 \(3) the new file name does not particularly specify any mode."
4410 "Change name of file visited in current buffer to FILENAME.
4411 This also renames the buffer to correspond to the new file.
4412 The next time the buffer is saved it will go in the newly specified file.
4413 FILENAME nil or an empty string means mark buffer as not visiting any file.
4414 Remember to delete the initial contents of the minibuffer
4415 if you wish to pass an empty string as the argument.
4417 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4418 confirmation in the case where another buffer is already visiting FILENAME.
4420 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4421 the old visited file has been renamed to the new name FILENAME."
4429 nil
4444 filename)))
4451 buffer-file-name filename)
4455 ;; If new-name == old-name, renaming would add a spurious <2>
4456 ;; and it's considered as a feature in rename-buffer.
4462 ;; Abbreviate the file names of the buffer.
4471 nil))
4472 ;; write-file-functions is normally used for things like ftp-find-file
4473 ;; that visit things that are not local files as if they were files.
4474 ;; Changing to visit an ordinary local file instead should flush the hook.
4479 ;; If buffer was read-only because of version control,
4480 ;; that reason is gone now, so make it writable.
4484 ;; Turn off backup files for certain file names.
4485 ;; Since this is a permanent local, the major mode won't eliminate it.
4487 backup-enable-predicate
4494 ;; If auto-save was not already on, turn it on if appropriate.
4497 ;; If auto save is on, start using a new name. We
4498 ;; deliberately don't rename or delete the old auto save
4499 ;; for the old visited file name. This is because
4500 ;; perhaps the user wants to save the new state and then
4501 ;; compare with the previous state from the auto save
4502 ;; file.
4504 ;; Rename the old auto save file if any.
4511 ;; Update the major mode, if the file name determines it.
4513 ;; Don't change the mode if it is special.
4516 ;; Don't change the mode if the local variable list specifies it.
4517 ;; The file name can influence whether the local variables apply.
4519 ;; h-l-v also checks it, but might as well be explicit.
4522 ;; TODO consider making normal-mode handle this case.
4531 "Write current buffer into file FILENAME.
4532 This makes the buffer visit that file, and marks it as not modified.
4534 Interactively, prompt for FILENAME.
4535 If you specify just a directory name as FILENAME, that means to write
4536 to a file in that directory. In this case, the base name of the file
4537 is the same as that of the file visited in the buffer, or the buffer
4538 name sans leading directories, if any, if the buffer is not already
4539 visiting a file.
4541 You can also yank the file name into the minibuffer to edit it,
4544 If optional second arg CONFIRM is non-nil, this function
4545 asks for confirmation before overwriting an existing file.
4546 Interactively, confirmation is required unless you supply a prefix argument."
4547 ;; (interactive "FWrite file: ")
4551 nil nil nil nil)
4555 default-directory)
4556 nil nil))
4560 ;; If arg is a directory name,
4561 ;; use the default file name, but in that directory.
4568 ;; NS does its own confirm dialog.
4571 use-dialog-box))
4577 ;; Make buffer writable if file is writable.
4582 ;; It's likely that the VC status at the new location is different from
4583 ;; the one at the old location.
4585 \f
4587 "Return an alist of extended attributes of file FILENAME.
4589 Extended attributes are platform-specific metadata about the file,
4590 such as SELinux context, list of ACL entries, etc."
4595 "Set extended attributes of file FILENAME to ATTRIBUTES.
4597 ATTRIBUTES must be an alist of file attributes as returned by
4598 `file-extended-attributes'.
4599 Value is t if the function succeeds in setting the attributes."
4610 result))
4611 \f
4613 "Make a backup of the disk file visited by the current buffer, if appropriate.
4614 This is normally done before saving the buffer the first time.
4616 A backup may be done by renaming or by copying; see documentation of
4617 variable `make-backup-files'. If it's done by renaming, then the file is
4618 no longer accessible under its old name.
4620 The value is non-nil after a backup was made by renaming.
4621 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4622 MODES is the result of `file-modes' on the original
4623 file; this means that the caller, after saving the buffer, should change
4624 the modes of the new file to agree with the old modes.
4625 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4626 on the original file; this means that the caller, after saving
4627 the buffer, should change the extended attributes of the new file
4628 to agree with the old attributes.
4629 BACKUPNAME is the backup file name, which is the old file renamed."
4633 ;; If specified name is a symbolic link, chase it to the target.
4634 ;; This makes backups in the directory where the real file is.
4641 ;; If have old versions to maybe delete,
4642 ;; ask the user to confirm now, before doing anything.
4643 ;; But don't actually delete til later.
4649 real-file-name)))
4650 targets))
4655 backup-by-copying-when-privileged-mismatch)
4658 ;; Don't rename a suid or sgid file.
4667 real-file-name
4670 copy-when-priv-mismatch)
4672 copy-when-priv-mismatch)))))
4674 t)))))
4675 setmodes)
4678 ;; Actually make the backup file.
4681 modes extended-attributes)
4682 ;; rename-file should delete old backup.
4685 backupname)))
4687 ;; Now delete the old versions, if desired.
4691 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4695 backupname)
4698 modes extended-attributes)
4700 setmodes)))))))
4703 ;; Create temp files with strict access rights. It's easy to
4704 ;; loosen them later, whereas it's impossible to close the
4705 ;; time-window of loose permissions otherwise.
4709 ;; Try to overwrite old backup first.
4718 nil)
4720 ;; The file was somehow created by someone else between
4721 ;; `delete-file' and `copy-file', so let's try again.
4722 ;; rms says "I think there is also a possible race
4723 ;; condition for making backup files" (emacs-devel 20070821).
4724 nil)))
4725 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4734 ;; The last ~[[:digit]]+ matches relative versions in git,
4735 ;; e.g. `foo.js.~HEAD~1~'.
4736 "Regular expression matching the backup/version part of a file name.
4740 "Return file NAME sans backup versions or strings.
4741 This is a separate procedure so your site-init or startup file can
4742 redefine it.
4743 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4744 we do not remove backup version numbers, only true file version numbers.
4745 See also `file-name-version-regexp'."
4752 name))))))
4755 "Return t if deleting FILE and rewriting it would preserve the owner.
4756 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4757 the group would be preserved too."
4762 ;; Return t if the file doesn't exist, since it's true that no
4763 ;; information would be lost by an (attempted) delete and create.
4766 ;; Files created on Windows by Administrator (RID=500)
4767 ;; have the Administrators group (RID=544) recorded as
4768 ;; their owner. Rewriting them will still preserve the
4769 ;; owner.
4774 ;; On BSD-derived systems files always inherit the parent
4775 ;; directory's group, so skip the group-gid test.
4781 ;; On some systems, a file created in a setuid directory
4782 ;; inherits that directory's owner.
4787 "^...[^sS]"
4789 ;; On many systems, a file created in a setgid directory
4790 ;; inherits that directory's group. On some systems
4791 ;; this happens even if the setgid bit is not set.
4798 The extension, in a file name, is the part that begins with the last `.',
4799 except that a leading `.' of the file name, if there is one, doesn't count."
4802 directory)
4806 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4807 ;; we don't want to expand it.
4810 filename))))
4814 The extension, in a file name, is the part that begins with the last `.',
4815 excluding version numbers and backup suffixes, except that a leading `.'
4816 of the file name, if there is one, doesn't count.
4817 Return nil for extensionless file names such as `foo'.
4818 Return the empty string for file names such as `foo.'.
4820 By default, the returned value excludes the period that starts the
4821 extension, but if the optional argument PERIOD is non-nil, the period
4822 is included in the value, and in that case, if FILENAME has no
4833 "Return the base name of the FILENAME: no directory, no extension."
4839 #'make-backup-file-name--default-function
4840 "A function that `make-backup-file-name' uses to create backup file names.
4841 The function receives a single argument, the original file name.
4843 If you change this, you may need to change `backup-file-name-p' and
4844 `file-name-sans-versions' too.
4846 You could make this buffer-local to do something special for specific files.
4848 For historical reasons, a value of nil means to use the default function.
4849 This should not be relied upon.
4851 See also `backup-directory-alist'."
4858 "Alist of filename patterns and backup directory names.
4859 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4860 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4861 relative or absolute. If it is absolute, so that all matching files
4862 are backed up into the same directory, the file names in this
4863 directory will be the full name of the file backed up with all
4864 directory separators changed to `!' to prevent clashes. This will not
4865 work correctly if your filesystem truncates the resulting name.
4867 For the common case of all backups going into one directory, the alist
4869 directory name.
4871 If this variable is nil, or it fails to match a filename, the backup
4872 is made in the original file's directory.
4874 On MS-DOS filesystems without long names this variable is always
4875 ignored."
4881 "Default `backup-enable-predicate' function.
4882 Checks for files in `temporary-file-directory',
4885 caseless)
4886 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4887 ;; their long file-name equivalents, so compare-strings does TRT.
4891 caseless t))
4894 ;; Directory is under temporary-file-directory.
4899 ;; Directory is under /tmp.
4904 0 nil
4906 ;; Directory is under small-temporary-file-directory.
4911 "Create the non-numeric backup file name for FILE.
4912 This calls the function that `make-backup-file-name-function' specifies,
4913 with a single argument FILE."
4916 file))
4919 "Default function for `make-backup-file-name'.
4920 Normally this just returns FILE's name with `~' appended.
4921 It searches for a match for FILE in `backup-directory-alist'.
4922 If the directory for the backup doesn't exist, it is created."
4934 "Subroutine of `make-backup-file-name--default-function'.
4935 The function `find-backup-file-name' also uses this."
4937 elt backup-directory abs-backup-directory)
4942 alist nil)))
4943 ;; If backup-directory is relative, it should be relative to the
4944 ;; file's directory. By expanding explicitly here, we avoid
4945 ;; depending on default-directory.
4954 abs-backup-directory nil))))
4956 file
4960 ;; Normalize DOSish file names: downcase the drive
4961 ;; letter, if any, and replace the leading "x:" with
4962 ;; "/drive_x".
4967 ;; Remove the leading slash, if any, to prevent
4968 ;; convert-standard-filename from converting that to a
4969 ;; backslash.
4972 ;; Replace any invalid file-name characters, then
4973 ;; prepend the leading slash back.
4976 ;; Replace any invalid file-name characters.
4980 "drive_"
4983 ""
4986 ;; Make the name unique by substituting directory
4987 ;; separators. It may not really be worth bothering about
4988 ;; doubling `!'s in the original name...
4993 backup-directory))
4998 "Return non-nil if FILE is a backup file name (numeric or not).
4999 This is a separate function so you can redefine it for customization.
5000 You may need to redefine `file-name-sans-versions' as well."
5005 ;; This is used in various files.
5006 ;; The usage of backup-extract-version-start is not very clean,
5007 ;; but I can't see a good alternative, so as of now I am leaving it alone.
5009 "Given the name of a numeric backup file, FN, return the backup number.
5010 Uses the free variable `backup-extract-version-start', whose value should be
5011 the index in the name where the version number begins."
5018 "Find a file name for a backup file FN, and suggestions for deletions.
5019 Value is a list whose car is the name for the backup file
5020 and whose cdr is a list of old versions to consider deleting now.
5021 If the value is nil, don't make a backup.
5022 Uses `backup-directory-alist' in the same way as
5023 `make-backup-file-name--default-function' does."
5025 ;; Run a handler for this function so that ange-ftp can refuse to do it.
5029 ;; We don't support numbered backups on plain MS-DOS
5030 ;; when long file names are unavailable.
5040 possibilities deserve-versions-p versions)
5043 base-versions
5046 possibilities)
5047 #'<)
5052 kept-old-versions
5053 kept-new-versions
5060 ;; Delete nothing if kept-new-versions and
5061 ;; kept-old-versions combine to an outlandish value.
5067 v))))))))))
5070 "Return number of names file FILENAME has."
5074 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
5075 This function returns a relative file name that is equivalent to FILENAME
5076 when used with that default directory as the default.
5077 If FILENAME is a relative file name, it will be interpreted as existing in
5078 `default-directory'.
5079 If FILENAME and DIRECTORY lie on different machines or on different drives
5080 on a DOS/Windows machine, it returns FILENAME in expanded form."
5084 default-directory))))
5089 read-file-name-completion-ignore-case)))
5092 ;; Test for different filesystems on DOS/Windows
5094 ;; Should `cygwin' really be included here? --stef
5097 ;; Test for different drive letters
5099 ;; Test for UNCs on different servers
5104 ;; Windows file names cannot have ? in
5105 ;; them, so use that to detect when
5106 ;; neither FILENAME nor DIRECTORY is a
5107 ;; UNC.
5109 0 nil
5115 ;; Test for different remote file system identification
5117 filename
5125 ".."
5127 ;; Now ancestor is empty, or .., or ../.., etc.
5129 ;; We matched within FILENAME's directory part.
5130 ;; Add the rest of FILENAME onto ANCESTOR.
5133 ;; But don't bother with ANCESTOR if it would give us `./'.
5134 rest
5136 ;; We matched FILENAME's directory equivalent.
5137 ancestor))))))
5138 \f
5140 "Save current buffer in visited file if modified.
5141 Variations are described below.
5143 By default, makes the previous version into a backup file
5144 if previously requested or if this is the first save.
5146 to become a backup when the next save is done.
5148 makes the previous version into a backup file.
5150 to become a backup when the next save is done,
5151 and makes the previous version into a backup file.
5153 With a numeric prefix argument of 0, never make the previous version
5154 into a backup file.
5156 Note that the various variables that control backups, such
5157 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
5158 and `backup-inhibited', to name just the more popular ones, still
5159 control whether a backup will actually be produced, even when you
5162 If a file's name is FOO, the names of its numbered backup versions are
5163 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
5164 Numeric backups (rather than FOO~) will be made if value of
5165 `version-control' is not the atom `never' and either there are already
5166 numeric versions of the file being backed up, or `version-control' is
5167 non-nil.
5168 We don't want excessive versions piling up, so there are variables
5169 `kept-old-versions', which tells Emacs how many oldest versions to keep,
5170 and `kept-new-versions', which tells how many newest versions to keep.
5171 Defaults are 2 old versions and 2 new.
5172 `dired-kept-versions' controls dired's clean-directory (.) command.
5173 If `delete-old-versions' is nil, system will query user
5174 before trimming versions. Otherwise it does it silently.
5176 If `vc-make-backup-files' is nil, which is the default,
5177 no backup files are made for files managed by version control.
5178 (This is because the version control system itself records previous versions.)
5180 See the subroutine `basic-save-buffer' for more information."
5186 ;; We used to display the message below only for files > 50KB, but
5187 ;; then Rmail-mbox never displays it due to buffer swapping. If
5188 ;; the test is ever re-introduced, be sure to handle saving of
5189 ;; Rmail files.
5199 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
5200 Normally delete only if the file was written by this Emacs since
5201 the last real save, but optional arg FORCE non-nil means delete anyway."
5215 "Normal hook that is run before a buffer is saved to its file.
5216 Used only by `save-buffer'."
5222 "Normal hook that is run after a buffer is saved to its file.
5223 Used only by `save-buffer'."
5229 "If non-nil, use this coding system for saving the buffer.
5230 More precisely, use this coding system in place of the
5231 value of `buffer-file-coding-system', when saving the buffer.
5232 Calling `write-region' for any purpose other than saving the buffer
5233 will still use `buffer-file-coding-system'; this variable has no effect
5239 "Save the current buffer in its visited file, if it has been modified.
5241 The hooks `write-contents-functions', `local-write-file-hooks'
5242 and `write-file-functions' get a chance to do the job of saving;
5243 if they do not, then the buffer is saved in the visited file in
5244 the usual way.
5246 Before and after saving the buffer, this function runs
5247 `before-save-hook' and `after-save-hook', respectively."
5250 ;; In an indirect buffer, save its base buffer instead.
5254 ;; Handle the case when no modification has been made but
5255 ;; the file disappeared since visited.
5259 setmodes)
5265 "%s has changed since visited or saved. Save anyway? "
5286 ;; Don't let errors prevent saving the buffer.
5288 ;; Give `write-contents-functions' a chance to
5289 ;; short-circuit the whole process.
5291 ;; If buffer has no file name, ask user for one.
5299 ;; Signal an error if the user specified the name of an
5300 ;; existing directory.
5303 "File `%s' exists; overwrite? "
5304 filename))
5307 ;; Support VC version backups.
5311 ;; If a hook returned t, file is already "written".
5312 ;; Otherwise, write it the usual way now.
5322 ;; Now we have saved the current buffer. Let's make sure
5323 ;; that buffer-file-coding-system is fixed to what
5324 ;; actually used for saving by binding it locally.
5340 ;; Support VC `implicit' locking.
5342 ;; If the auto-save file was recent before this command,
5343 ;; delete it now.
5350 ;; This does the "real job" of writing a buffer into its visited file
5351 ;; and making a backup file. This is what is normally done
5352 ;; but inhibited if one of write-file-functions returns non-nil.
5353 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5354 ;; backup-buffer.
5364 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5365 ;; backup-buffer.
5378 "File %s is write-protected; try to save anyway? "
5380 buffer-file-name)))
5394 dir))))
5395 ;; Write temp name, then rename it.
5396 ;; This requires write access to the containing dir,
5397 ;; which is why we don't try it if we don't have that access.
5399 tempname
5401 ;; Create temp files with strict access rights. It's easy to
5402 ;; loosen them later, whereas it's impossible to close the
5403 ;; time-window of loose permissions otherwise.
5407 ;; Call write-region in the appropriate way
5408 ;; for saving the buffer.
5412 ;; Pass in nil&nil rather than point-min&max
5413 ;; cause we're saving the whole buffer.
5414 ;; write-region-annotate-functions may use it.
5416 buffer-file-truename)
5418 ;; If we failed, restore the buffer's modtime.
5421 ;; Since we have created an entirely new file,
5422 ;; make sure it gets the right permission bits set.
5427 buffer-file-name)))
5428 ;; We succeeded in writing the temp file,
5429 ;; so rename it.
5431 ;; If file not writable, see if we can make it writable
5432 ;; temporarily while we write it.
5433 ;; But no need to do so if we have just backed it up
5434 ;; (setmodes is set) because that says we're superseding.
5436 ;; Change the mode back, after writing.
5439 buffer-file-name))
5440 ;; If set-file-extended-attributes fails, fall back on
5441 ;; set-file-modes.
5451 ;; Pass in nil&nil rather than point-min&max to indicate
5452 ;; we're saving the buffer rather than just a region.
5453 ;; write-region-annotate-functions may make use of it.
5455 buffer-file-name nil t buffer-file-truename)
5458 ;; If we get an error writing the new file, and we made
5459 ;; the backup by renaming, undo the backing-up.
5464 setmodes))
5472 `((?\C-r
5479 ;; Return nil to ask about BUF again.
5480 nil)
5482 (?\C-f
5498 ;; Return nil to ask about BUF again.
5499 nil)
5508 "Default predicate for `save-some-buffers'.
5510 This allows you to stop `save-some-buffers' from asking
5511 about certain files that you'd usually rather not save.
5513 This function is called (with no parameters) from the buffer to
5514 be saved."
5516 ;; FIXME nil should not be a valid option, let alone the default,
5517 ;; eg so that add-function can be used.
5522 "Save some modified file-visiting buffers. Asks user about each one.
5523 You can answer `y' or SPC to save, `n' or DEL not to save, `C-r'
5524 to look at the buffer in question with `view-buffer' before
5525 deciding, `d' to view the differences using
5526 `diff-buffer-with-file', `!' to save the buffer and all remaining
5527 buffers without any further querying, `.' to save only the
5528 current buffer and skip the remaining ones and `q' or RET to exit
5529 the function without saving any more buffers. `C-h' displays a
5530 help message describing these options.
5532 This command first saves any buffers where `buffer-save-without-query' is
5533 non-nil, without asking.
5535 Optional argument ARG (interactively, prefix argument) non-nil means save
5536 all with no questions.
5537 Optional second argument PRED determines which buffers are considered:
5538 If PRED is nil, all the file-visiting buffers are considered.
5539 If PRED is t, then certain non-file buffers will also be considered.
5540 If PRED is a zero-argument function, it indicates for each buffer whether
5541 to consider it or not when called with that buffer current.
5542 PRED defaults to the value of `save-some-buffers-default-predicate'.
5544 See `save-some-buffers-action-alist' if you want to
5545 change the additional actions you can take on files."
5553 queried autosaved-buffers
5554 files-done abbrevs-done)
5558 ;; First save any buffers that we're supposed to save
5559 ;; unconditionally. That way the following code won't ask
5560 ;; about them.
5565 ;; Ask about those buffers that merit it,
5566 ;; and record the number thus saved.
5570 ;; Note that killing some buffers may kill others via
5571 ;; hooks (e.g. Rmail and its viewing buffer).
5584 t
5598 ;; The buffer name is similar to the
5599 ;; file name.
5602 ;; The buffer and file names are
5603 ;; dissimilar; display both.
5607 ;; No file name
5614 save-some-buffers-action-alist))
5615 ;; Maybe to save abbrevs, and record whether
5616 ;; we either saved them or asked to.
5622 abbrev-file-name)))
5624 ;; Don't keep bothering user if he says no.
5640 \f
5642 "Clear out records of last mod time of visited file.
5643 Next attempt to save will not complain of a discrepancy."
5647 "Mark current buffer as unmodified, not needing to be saved.
5650 It is not a good idea to use this function in Lisp programs, because it
5651 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5659 "Change whether this buffer is read-only."
5667 "Insert contents of file FILENAME into buffer after point.
5668 Set mark after the inserted text.
5670 This function is meant for the user to run interactively.
5671 Don't call it from programs! Use `insert-file-contents' instead.
5672 \(Its calling sequence is different; see its documentation)."
5678 "Append the contents of the region to the end of file FILENAME.
5679 When called from a function, expects three arguments,
5680 START, END and FILENAME. START and END are normally buffer positions
5681 specifying the part of the buffer to write.
5682 If START is nil, that means to use the entire buffer contents.
5683 If START is a string, then output that string to the file
5684 instead of any buffer contents; END is ignored.
5686 This does character code conversion and applies annotations
5687 like `write-region' does."
5693 "Return most recent backup file for FILENAME or nil if no backups exist."
5697 "Return a list of backup files for FILENAME.
5698 The list will be sorted by modification time so that the most
5699 recent files are first."
5700 ;; `make-backup-file-name' will get us the right directory for
5701 ;; ordinary or numeric backups. It might create a directory for
5702 ;; backups as a side-effect, according to `backup-directory-alist'.
5718 "Rename current buffer to a similar name not already taken.
5719 This function is useful for creating multiple shell process buffers
5720 or multiple mail buffers, etc.
5722 Note that some commands, in particular those based on `compilation-mode'
5723 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5724 appropriate mode even if it has been renamed. So as well as renaming
5725 the buffer, you also need to switch buffers before running another
5726 instance of such commands."
5734 ;; If the existing buffer name has a <NNN>,
5735 ;; which isn't part of the file name (if any),
5736 ;; then get rid of that.
5742 "Make directory DIR if it is not already a directory. Return nil."
5750 "Create the directory DIR and optionally any nonexistent parent dirs.
5751 If DIR already exists as a directory, signal an error, unless
5752 PARENTS is non-nil.
5754 Interactively, the default choice of directory to create is the
5755 current buffer's default directory. That is useful when you have
5756 visited a file in a nonexistent directory.
5758 Noninteractively, the second (optional) argument PARENTS, if
5759 non-nil, says whether to create parent directories that don't
5760 exist. Interactively, this happens by default.
5762 If creating the directory or directories fail, an error will be
5763 raised."
5766 nil nil)
5767 t))
5768 ;; If default-directory is a remote directory,
5769 ;; make sure we find its make-directory handler.
5777 create-list parent)
5784 ;; Do not loop if root does not exist (Bug#2309).
5787 dir parent))
5792 "Create an empty file FILENAME.
5793 Optional arg PARENTS, if non-nil then creates parent dirs as needed.
5795 If called interactively, then PARENTS is non-nil."
5809 More precisely, it matches parts of any nonempty string except those two.
5810 It is useful as the regexp argument to `directory-files' and
5814 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5815 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5816 non-nil and if FN fails due to a missing file or directory."
5822 "Delete the directory named DIRECTORY. Does not follow symlinks.
5823 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5824 no error if something else is simultaneously deleting them.
5825 TRASH non-nil means to trash the directory instead, provided
5826 `delete-by-moving-to-trash' is non-nil.
5828 When called interactively, TRASH is nil if and only if a prefix
5829 argument is given, and a further prompt asks the user for
5830 RECURSIVE if DIRECTORY is nonempty."
5837 "Move directory to trash: "
5839 default-directory default-directory nil nil))))
5845 nil)
5847 ;; If default-directory is a remote directory, make sure we find its
5848 ;; delete-directory handler.
5855 ;; Move non-empty dir to trash only if recursive deletion was
5856 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5857 ;; case, where the operation fails in delete-directory-internal.
5858 ;; As `move-file-to-trash' trashes directories (empty or
5859 ;; otherwise) as a unit, we do not need to recurse here.
5863 ;; Otherwise, call ourselves recursively if needed.
5868 directory-files-no-dot-files-regexp))
5872 ;; This test is equivalent to but more efficient
5873 ;; than (and (file-directory-p fn)
5874 ;; (not (file-symlink-p fn))).
5878 files))
5879 directory-exists))
5883 "Return non-nil if files FILE1 and FILE2 name the same file.
5884 If FILE1 or FILE2 does not exist, the return value is unspecified."
5895 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5897 Return nil if DIR is not an existing directory."
5909 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5924 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5925 This function always sets the file modes of the output files to match
5926 the corresponding input file.
5928 The third arg KEEP-TIME non-nil means give the output files the same
5929 last-modified time as the old ones. (This works on only some systems.)
5931 A prefix arg makes KEEP-TIME non-nil.
5933 Noninteractively, the PARENTS argument says whether to create
5934 parent directories if they don't exist. Interactively, this
5935 happens by default.
5937 If NEWNAME is a directory name, copy DIRECTORY as a subdirectory
5938 there. However, if called from Lisp with a non-nil optional
5939 argument COPY-CONTENTS, copy the contents of DIRECTORY directly
5940 into NEWNAME instead."
5947 default-directory default-directory nil nil)
5948 current-prefix-arg t nil)))
5951 directory newname))
5952 ;; If default-directory is a remote directory, make sure we find its
5953 ;; copy-directory handler.
5959 newname keep-time parents copy-contents)
5961 ;; Compute target name.
5966 ;; If NEWNAME is not a directory name, create it;
5967 ;; that is where we will copy the files of DIRECTORY.
5969 ;; NEWNAME is a directory name. If COPY-CONTENTS is non-nil,
5970 ;; create NEWNAME if it is not already a directory;
5971 ;; otherwise, create NEWNAME/[DIRECTORY-BASENAME].
5979 ;; Copy recursively.
5981 ;; We do not want to copy "." and "..".
5983 directory-files-no-dot-files-regexp))
5994 ;; Set directory attributes.
6002 \f
6003 ;; At time of writing, only info uses this.
6005 "Return a copy of DIRS with all non-existent directories removed.
6006 The optional argument KEEP is a list of directories to retain even if
6007 they don't exist, and REJECT is a list of directories to remove from
6008 DIRS, even if they exist; REJECT takes precedence over KEEP.
6010 Note that membership in REJECT and KEEP is checked using simple string
6011 comparison."
6017 dirs)))
6019 \f
6022 "Function to use to revert this buffer.
6023 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
6024 which are the arguments that `revert-buffer' received.
6025 It also has access to the `preserve-modes' argument of `revert-buffer'
6026 via the `revert-buffer-preserve-modes' dynamic variable.
6028 For historical reasons, a value of nil means to use the default function.
6033 #'revert-buffer-insert-file-contents--default-function
6034 "Function to use to insert contents when reverting this buffer.
6035 The function receives two arguments: the first the nominal file name to use;
6036 the second is t if reading the auto-save file.
6038 The function is responsible for updating (or preserving) point.
6040 For historical reasons, a value of nil means to use the default function.
6044 "Default function to use for `buffer-stale-function'.
6045 This function ignores its argument.
6046 This returns non-nil if the current buffer is visiting a readable file
6047 whose modification time does not match that of the buffer.
6049 This function handles only buffers that are visiting files.
6050 Non-file buffers need a custom function."
6057 "Function to check whether a buffer needs reverting.
6058 This should be a function with one optional argument NOCONFIRM.
6059 Auto Revert Mode passes t for NOCONFIRM. The function should return
6060 non-nil if the buffer should be reverted. A return value of
6061 `fast' means that the need for reverting was not checked, but
6062 that reverting the buffer is fast. The buffer is current when
6063 this function is called.
6065 The idea behind the NOCONFIRM argument is that it should be
6066 non-nil if the buffer is going to be reverted without asking the
6067 user. In such situations, one has to be careful with potentially
6068 time consuming operations.
6070 For historical reasons, a value of nil means to use the default function.
6071 This should not be relied upon.
6073 For more information on how this variable is used by Auto Revert mode,
6077 "Whether a buffer can rely on notification in Auto-Revert mode.
6078 If non-nil, monitoring changes to the directory of the current
6079 buffer is sufficient for knowing when that buffer needs to be
6080 updated in Auto Revert Mode. Such notification does not include
6081 changes to files in that directory, only to the directory itself.
6083 This variable applies only to buffers where `buffer-file-name' is
6087 "Normal hook for `revert-buffer' to run before reverting.
6088 The function `revert-buffer--default' runs this.
6092 "Normal hook for `revert-buffer' to run after reverting.
6093 Note that the hook value that it runs is the value that was in effect
6094 before reverting; that makes a difference if you have buffer-local
6095 hook functions.
6097 The function `revert-buffer--default' runs this.
6105 ;; `revert-buffer-function' was defined long ago to be a function of only
6106 ;; 2 arguments, so we have to use a dynbind variable to pass the
6107 ;; `preserve-modes' argument of `revert-buffer'.
6111 "Replace current buffer text with the text of the visited file on disk.
6112 This undoes all changes since the file was visited or saved.
6113 With a prefix argument, offer to revert from latest auto-save file, if
6114 that is more recent than the visited file.
6116 Reverting a buffer will try to preserve markers in the buffer;
6117 see the Info node `(elisp)Reverting' for details.
6119 This command also implements an interface for special buffers
6120 that contain text that doesn't come from a file, but reflects
6121 some other data instead (e.g. Dired buffers, `buffer-list'
6122 buffers). This is done via the variable `revert-buffer-function'.
6123 In these cases, it should reconstruct the buffer contents from the
6124 appropriate data.
6126 When called from Lisp, the first argument is IGNORE-AUTO; offer to
6127 revert from the auto-save file only when this is nil. Note that the
6128 sense of this argument is the reverse of the prefix argument, for the
6129 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
6130 to nil.
6132 Optional second argument NOCONFIRM means don't ask for confirmation
6133 at all. (The variable `revert-without-query' offers another way to
6134 revert buffers without querying for confirmation.)
6136 Optional third argument PRESERVE-MODES non-nil means don't alter
6137 the files modes. Normally we reinitialize them using `normal-mode'.
6139 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
6141 This function calls the function that `revert-buffer-function' specifies
6142 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
6143 The default function runs the hooks `before-revert-hook' and
6144 `after-revert-hook'."
6145 ;; I admit it's odd to reverse the sense of the prefix argument, but
6146 ;; there is a lot of code out there that assumes that the first
6147 ;; argument should be t to avoid consulting the auto-save file, and
6148 ;; there's no straightforward way to encourage authors to notice a
6149 ;; reversal of the argument sense. So I'm just changing the user
6150 ;; interface, but leaving the programmatic interface the same.
6155 ignore-auto noconfirm)))
6158 "Default function for `revert-buffer'.
6159 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
6160 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
6161 start and end.
6163 Calls `revert-buffer-insert-file-contents-function' to reread the
6164 contents of the visited file, with two arguments: the first is the file
6165 name, the second is non-nil if reading an auto-save file.
6167 This function handles only buffers that are visiting files.
6168 Non-file buffers need a custom function."
6173 buffer-auto-save-file-name
6178 buffer-auto-save-file-name
6179 buffer-file-name)))
6189 file-name)))
6191 ;; If file was backed up but has changed since,
6192 ;; we should make another backup.
6196 ;; Effectively copy the after-revert-hook status,
6197 ;; since after-find-file will clobber it.
6200 after-revert-hook))
6202 ;; FIXME: Throw away undo-log when preserve-modes is nil?
6206 file-name auto-save-p)
6207 ;; Recompute the truename in case changes in symlinks
6208 ;; have changed the truename.
6212 ;; Run after-revert-hook as it was before we reverted.
6216 local-hook)
6219 t)))))
6222 "Default function for `revert-buffer-insert-file-contents-function'.
6223 The function `revert-buffer--default' calls this.
6224 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
6225 an auto-save file."
6229 "File %s no longer exists!"
6231 file-name))
6234 "File %s no longer readable!"
6236 file-name))
6238 ;; Bind buffer-file-name to nil
6239 ;; so that we don't try to lock the file.
6245 ;; Auto-saved file should be read by Emacs's
6246 ;; internal coding.
6250 buffer-file-coding-system-explicit
6253 coding-system-for-read
6255 coding-system-for-read)
6257 ;; As a coding system suitable for multibyte
6258 ;; buffer is specified, make the current
6259 ;; buffer multibyte.
6262 ;; This force after-insert-file-set-coding
6263 ;; (called from insert-file-contents) to set
6264 ;; buffer-file-coding-system to a proper value.
6267 ;; Note that this preserves point in an intelligent way.
6271 nil nil t))
6273 nil nil t))))))
6276 "Maximum time that `revert-buffer-with-fine-grain' should use.
6277 The command tries to preserve markers, properties and overlays.
6278 If the operation takes more than this time, a single
6279 delete+insert is performed. Actually, this value is passed as
6280 the MAX-SECS argument to the function `replace-buffer-contents',
6281 so it is not ensured that the whole execution won't take longer.
6285 "Optional function for `revert-buffer-insert-file-contents-function'.
6286 The function `revert-buffer-with-fine-grain' uses this function by binding
6287 `revert-buffer-insert-file-contents-function' to it.
6289 As with `revert-buffer-insert-file-contents--default-function', FILE-NAME is
6290 the name of the file and AUTO-SAVE-P is non-nil if this is an auto-save file.
6291 Since calling `replace-buffer-contents' can take a long time, depending of
6292 the number of changes made to the buffer, it uses the value of the variable
6293 `revert-buffer-with-fine-grain-max-seconds' as a maximum time to try delicately
6294 reverting the buffer. If it fails, it does a delete+insert. For more details,
6295 see `replace-buffer-contents'."
6299 "File %s no longer exists"
6301 file-name))
6304 "File %s no longer readable"
6306 file-name))
6319 temp-buf
6320 revert-buffer-with-fine-grain-max-seconds))))))))
6321 ;; See comments in revert-buffer-with-fine-grain for an explanation.
6323 success))
6327 "Revert buffer preserving markers, overlays, etc.
6328 This command is an alternative to `revert-buffer' because it tries to be as
6329 non-destructive as possible, preserving markers, properties and overlays.
6330 Binds `revert-buffer-insert-file-contents-function' to the function
6331 `revert-buffer-insert-file-contents-delicately'.
6333 With a prefix argument, offer to revert from latest auto-save file. For more
6334 details on the arguments, see `revert-buffer'."
6335 ;; See revert-buffer for an explanation of this.
6337 ;; Simply bind revert-buffer-insert-file-contents-function to the specialized
6338 ;; function, and call revert-buffer.
6342 ;; This closure is defined in revert-buffer-insert-file-contents-function.
6343 ;; It is needed because revert-buffer--default always returns t after
6344 ;; reverting, and it might be needed to report the success/failure of
6345 ;; reverting delicately.
6352 "Recover the visited file--get contents from its last auto-save file."
6359 "Visit file FILE, but get contents from its last auto-save file."
6360 ;; Actually putting the file name in the minibuffer should be used
6361 ;; only rarely.
6362 ;; Not just because users often use the default.
6379 "*Directory*" nil
6390 ;; Use insert-directory-safely, not insert-directory,
6391 ;; because these files might not exist. In particular,
6392 ;; FILE might not exist if the auto-save file was for
6393 ;; a buffer that didn't visit a file, such as "*mail*".
6394 ;; The code in v20.x called `ls' directly, so we need
6395 ;; to emulate what `ls' did in that case.
6400 ;; Keep the current buffer-file-coding-system.
6402 ;; Auto-saved file should be read with special coding.
6413 "Recover auto save files from a previous Emacs session.
6414 This command first displays a Dired buffer showing you the
6415 previous sessions that you could recover from.
6416 To choose one, move point to the proper line and then type C-c C-c.
6417 Then you'll be asked about a number of files to recover."
6427 directory-files-no-dot-files-regexp
6429 t)
6433 ;; Ensure that we don't omit the session files as the user may
6434 ;; have (as suggested by the manual) `dired-omit-mode' in the
6435 ;; hook.
6445 ;; Each line starts with a space
6446 ;; so that Font Lock mode won't highlight the first character.
6449 " To delete a session file, type \
6455 "Choose one saved session to recover auto-save files from.
6456 This command is used in the special Dired buffer created by
6459 ;; Get the name of the session file to recover from.
6461 files
6467 ;; Read in the auto-save-list file.
6470 ;; Loop thru the text of that file
6471 ;; and get out the names of the files to recover.
6475 ;; This is a pair of lines for a non-file-visiting buffer.
6476 ;; Get the auto-save file name and manufacture
6477 ;; a "visited file name" from that.
6480 ;; If there is no auto-save file name, the
6481 ;; auto-save-list file is probably corrupted.
6494 ;; This pair of lines is a file-visiting
6495 ;; buffer. Use the visited file name.
6505 ;; Ignore a file if its auto-save file does not exist now.
6509 ;; The file contains a pair of line for each auto-saved buffer.
6510 ;; The first line of the pair contains the visited file name
6511 ;; or is empty if the buffer was not visiting a file.
6512 ;; The second line is the auto-save file name.
6520 files
6526 "Kill BUFFER if confirmed."
6534 "Kill some buffers. Asks the user whether to kill each one of them.
6535 Non-interactively, if optional argument LIST is non-nil, it
6536 specifies the list of buffers to kill, asking for approval for each one."
6544 ; if we killed the base buffer.
6551 "Kill buffers whose name matches the specified REGEXP.
6552 Ignores buffers whose name starts with a space, unless optional
6553 prefix argument INTERNAL-TOO is non-nil. Asks before killing
6554 each buffer, unless NO-ASK is non-nil."
6563 \f
6565 "Adjust current buffer's auto save file name for current conditions.
6566 Also rename any existing auto save file, if it was made in this session."
6578 "Return file name to use for auto-saves of current buffer.
6579 Does not consider `auto-save-visited-file-name' as that variable is checked
6580 before calling this function.
6581 See also `auto-save-file-name-p'."
6589 result uniq)
6590 ;; Apply user-specified translations
6591 ;; to the file name.
6595 filename)
6605 filename))))
6610 ;; We truncate the file name to DOS 8+3 limits
6611 ;; before doing anything else, because the regexp
6612 ;; passed to string-match below cannot handle
6613 ;; extensions longer than 3 characters, multiple
6614 ;; dots, and other atrocities.
6619 fn)
6624 "#"
6627 ;; Make sure auto-save file names don't contain characters
6628 ;; invalid for the underlying filesystem.
6630 ;; Don't modify remote filenames
6633 result))))
6635 ;; Deal with buffers that don't have any associated files. (Mail
6636 ;; mode tends to create a good number of these.)
6640 file-name)
6641 ;; Restrict the characters used in the file name to those that
6642 ;; are known to be safe on all filesystems, url-encoding the
6643 ;; rest.
6644 ;; We do this on all platforms, because even if we are not
6645 ;; running on DOS/Windows, the current directory may be on a
6646 ;; mounted VFAT filesystem, such as a USB memory stick.
6650 ;; For multibyte characters, this will produce more than
6651 ;; 2 hex digits, so is not true URL encoding.
6655 ;; Generate the file name.
6661 ;; Try a few alternative directories, to get one we can
6662 ;; write it.
6668 ;; Don't modify remote filenames
6670 ;; The call to convert-standard-filename is in case
6671 ;; buffer-name includes characters not allowed by the
6672 ;; DOS/Windows filesystems. make-temp-file writes to the
6673 ;; file it creates, so we must fix the file name _before_
6674 ;; make-temp-file is called.
6676 fname))
6678 ;; make-temp-file creates the file,
6679 ;; but we don't want it to exist until we do an auto-save.
6683 file-name)))
6686 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6687 FILENAME should lack slashes.
6688 See also `make-auto-save-file-name'."
6690 \f
6692 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6693 The generated regexp will match a filename only if the filename
6694 matches that wildcard according to shell rules. Only wildcards known
6695 by `sh' are supported."
6697 ;; Copy the initial run of non-special characters.
6700 ;; If no special characters, we're almost done.
6704 j)
6706 result
6727 ;; Found "[^". Insert a `\0' character
6728 ;; (which cannot happen in a filename)
6729 ;; into the character class, so that `^'
6730 ;; is not the first character after `[',
6731 ;; and thus non-special in a regexp.
6736 ;; I don't think `]' can appear in a
6737 ;; character class in a wildcard, but
6738 ;; let's be general here.
6745 i
6758 ;; Shell wildcards should match the entire filename,
6759 ;; not its part. Make the regexp say so.
6761 \f
6764 "Switches for `list-directory' to pass to `ls' for brief listing."
6770 "Switches for `list-directory' to pass to `ls' for verbose listing."
6775 "Expand wildcard pattern PATTERN.
6776 This returns a list of file names that match the pattern.
6777 Files are sorted in `string<' order.
6779 If PATTERN is written as an absolute file name,
6780 the values are absolute also.
6782 If PATTERN is written as a relative file name, it is interpreted
6783 relative to the current default directory, `default-directory'.
6784 The file names returned are normally also relative to the current
6785 default directory. However, if FULL is non-nil, they are absolute."
6789 ;; A list of all dirs that DIRPART specifies.
6790 ;; This can be more than one dir
6791 ;; if DIRPART contains wildcards.
6797 contents)
6802 ;; Filter out "." and ".."
6807 name))
6814 this-dir-contents)
6815 this-dir-contents)
6816 contents)))))
6817 contents)))
6819 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6823 "Display a list of files in or matching DIRNAME, a la `ls'.
6824 DIRNAME is globbed by the shell if necessary.
6825 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6826 Actions controlled by variables `list-directory-brief-switches'
6827 and `list-directory-verbose-switches'."
6831 nil default-directory nil)
6832 pfx)))
6834 list-directory-brief-switches))
6835 buffer)
6847 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6855 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6857 PATTERN is assumed to represent a file-name wildcard suitable for the
6858 underlying filesystem. For Unix and GNU/Linux, each character from the
6860 the parts of the pattern that don't include wildcard characters are
6861 quoted with double quotes.
6864 on Windows), so PATTERN can use them to quote wildcard characters that
6865 need to be passed verbatim to shell commands."
6869 ;; DOS/Windows don't allow `"' in file names. So if the
6870 ;; argument has quotes, we can safely assume it is already
6871 ;; quoted by the caller.
6873 ;; We quote [&()#$`'] in case their shell is a port of a
6874 ;; Unixy shell. We quote [,=+] because stock DOS and
6875 ;; Windows shells require that in some cases, such as
6876 ;; passing arguments to batch files that use positional
6877 ;; arguments like %1.
6879 pattern
6882 end)
6899 pattern))))
6906 "Program to get the amount of free space on a file system.
6907 We assume the output has the format of `df'.
6908 The value of this variable must be just a command name or file name;
6909 if you want to specify options, use `directory-free-space-args'.
6911 A value of nil disables this feature."
6915 "ignored, as Emacs uses `file-system-info' instead"
6920 "Options to use when running `directory-free-space-program'."
6924 "ignored, as Emacs uses `file-system-info' instead"
6928 "String describing the amount of free space on DIR's file system.
6929 If DIR's free space cannot be obtained, this function returns nil."
6935 ;; The following expression replaces `dired-move-to-filename-regexp'.
6939 ;; In some locales, month abbreviations are as short as 2 letters,
6940 ;; and they can be followed by ".".
6941 ;; In Breton, a month name can include a quote character.
6954 s "+"
6957 ;; This represents the date in strftime(3) format "%e-%b-%Y"
6958 ;; (aka "%v"), as it is the default for many ls incarnations.
6960 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6961 ;; omits the Kanji characters after month and day-of-month.
6962 ;; On Mac OS X 10.3, the date format in East Asian locales is
6963 ;; day-of-month digits followed by month digits.
6969 ;; The "[0-9]" below requires the previous column to end in a digit.
6970 ;; This avoids recognizing `1 may 1997' as a date in the line:
6971 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6973 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6975 ;; For non-iso date formats, we add the ".*" in order to find
6976 ;; the last possible match. This avoids recognizing
6977 ;; `jservice 10 1024' as a date in the line:
6978 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6980 ;; vc dired listings provide the state or blanks between file
6981 ;; permissions and date. The state is always surrounded by
6982 ;; parentheses:
6983 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6984 ;; This is not supported yet.
6990 "Regular expression to match up to the file name in a directory listing.
6991 The default value is designed to recognize dates and times
6997 "Return non-nil if DIR contents a shell wildcard in the directory part.
6998 The return value is a cons (DIR . WILDCARDS); DIR is the
6999 `default-directory' in the Dired buffer, and WILDCARDS are the wildcards.
7001 Valid wildcards are `*', `?', `[abc]' and `[a-z]'."
7004 ls-lisp-support-shell-wildcards)
7008 wildcards wildcards wildcards)))
7016 ;; The following overshoots by one line for an empty
7017 ;; directory listed with "--dired", but without "-a"
7018 ;; switch, where the ls output contains a
7019 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
7020 ;; We take care of that case later.
7028 error-lines)
7029 ;; Find all the lines that are error messages,
7030 ;; and record the bounds of each one.
7037 ;; Now read the numeric positions of file names.
7044 error-lines))
7047 error-lines)))
7049 ;; End is followed by \n or by " -> ".
7051 ;; It seems that we can't trust ls's output as to
7052 ;; byte positions of filenames.
7058 ;; Take care of the case where the ls output contains a
7059 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
7060 ;; and we went one line too far back (see above).
7065 ;; insert-directory
7066 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
7067 ;; FULL-DIRECTORY-P is nil.
7068 ;; The single line of output must display FILE's name as it was
7069 ;; given, namely, an absolute path name.
7070 ;; - must insert exactly one line for each file if WILDCARD or
7071 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
7072 ;; before the file lines, plus optional text after the file lines.
7073 ;; Lines are delimited by "\n", so filenames containing "\n" are not
7074 ;; allowed.
7075 ;; File lines should display the basename.
7076 ;; - must be consistent with
7077 ;; - functions dired-move-to-filename, (these two define what a file line is)
7078 ;; dired-move-to-end-of-filename,
7079 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
7080 ;; dired-insert-headerline
7081 ;; dired-after-subdir-garbage (defines what a "total" line is)
7082 ;; - variable dired-subdir-regexp
7083 ;; - may be passed "--dired" as the first argument in SWITCHES.
7084 ;; File name handlers might have to remove this switch if their
7085 ;; "ls" command does not support it.
7087 "Insert directory listing for FILE, formatted according to SWITCHES.
7088 Leaves point after the inserted text.
7089 SWITCHES may be a string of options, or a list of strings
7090 representing individual options.
7091 Optional third arg WILDCARD means treat FILE as shell wildcard.
7092 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
7093 switches do not contain `d', so that a full listing is expected.
7095 This works by running a directory listing program
7096 whose name is in the variable `insert-directory-program'.
7097 If WILDCARD, it also runs the shell specified by `shell-file-name'.
7099 When SWITCHES contains the long `--dired' option, this function
7100 treats it specially, for the sake of dired. However, the
7101 normally equivalent short `-D' option is just passed on to
7102 `insert-directory-program', as any other option."
7103 ;; We need the directory in order to find the right handler.
7108 wildcard full-directory-p)
7111 ;; Read the actual directory using `insert-directory-program'.
7112 ;; RESULT gets the status code.
7114 ;; putting text property `dired-filename, decode one
7115 ;; bunch by one to preserve that property.
7117 ;; This is to control encoding the arguments in call-process.
7121 default-file-name-coding-system))))
7124 ;; If the wildcard is just in the file part, then run ls in
7125 ;; the directory part of the file pattern using the last
7126 ;; component as argument. Otherwise, run ls in the longest
7127 ;; subdirectory of the directory part free of wildcards; use
7128 ;; the remaining of the file pattern as argument.
7137 ;; NB since switches is passed to the shell, be
7138 ;; careful of malicious values, eg "-l;reboot".
7139 ;; See eg dired-safe-switches-p.
7141 shell-file-name nil t nil
7142 shell-command-switch
7144 ""
7146 insert-directory-program
7147 " -d "
7149 switches
7151 " -- "
7152 ;; Quote some characters that have
7153 ;; special meanings in shells; but
7154 ;; don't quote the wildcards--we want
7155 ;; them to be special. We also
7156 ;; currently don't quote the quoting
7157 ;; characters in case people want to
7158 ;; use them explicitly to quote
7159 ;; wildcard characters.
7161 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
7162 ;; directory if FILE is a symbolic link.
7172 insert-directory-program nil t nil
7176 ;; Split the switches at any spaces so we can
7177 ;; pass separate options as separate args.
7179 ;; Avoid lossage if FILE starts with `-'.
7183 ;; If we got "//DIRED//" in the output, it means we got a real
7184 ;; directory listing, even if `ls' returned nonzero.
7185 ;; So ignore any errors.
7198 ;; The first time ls returns an error,
7199 ;; find the version numbers of ls,
7200 ;; and set insert-directory-ls-version
7201 ;; to > if it is more than 5.2.1, < if it is less, nil if it
7202 ;; is equal or if the info cannot be obtained.
7203 ;; (That can mean it isn't GNU ls.)
7213 comparison)
7229 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
7233 ;; If `insert-directory-program' failed, signal an error.
7235 ;; Delete the error message it may have output.
7237 ;; On non-Posix systems, we cannot open a directory, so
7238 ;; don't even try, because that will always result in
7239 ;; the ubiquitous "Access denied". Instead, show the
7240 ;; command line so the user can try to guess what went wrong.
7245 insert-directory-program
7247 file result)
7248 ;; Unix. Access the file to get a suitable error.
7252 ;; Now decode what read if necessary.
7254 file-name-coding-system
7255 default-file-name-coding-system
7257 coding-no-eol
7258 val pos)
7262 ;; If no coding system is specified or detection is
7263 ;; requested, detect the coding.
7277 ;; Force no eol conversion on a file name, so
7278 ;; that CR is preserved.
7286 ;; Try to insert the amount of free space.
7289 ;; First find the line to put it on.
7291 ;; Replace "total" with "total used in directory" to
7292 ;; avoid confusion.
7300 "Convert `ls --dired' file name position value POS to a buffer position.
7301 File name position values returned in ls --dired output
7302 count only stdout; they don't count the error messages sent to stderr.
7303 So this function converts to them to real buffer positions.
7304 ERROR-LINES is a list of buffer positions of error message lines,
7305 of the form (START END)."
7309 pos)
7313 "Insert directory listing for FILE, formatted according to SWITCHES.
7315 Like `insert-directory', but if FILE does not exist, it inserts a
7316 message to that effect instead of signaling an error."
7319 ;; Simulate the message printed by `ls'.
7323 "Functions to call with no arguments to query about killing Emacs.
7324 If any of these functions returns nil, killing Emacs is canceled.
7325 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
7326 the low level primitive, does not. See also `kill-emacs-hook'."
7332 "How to ask for confirmation when leaving Emacs.
7333 If nil, the default, don't ask at all. If the value is non-nil, it should
7334 be a predicate function; for example `yes-or-no-p'."
7343 "Non-nil if Emacs should confirm killing processes on exit.
7344 If this variable is nil, the value of
7345 `process-query-on-exit-flag' is ignored. Otherwise, if there are
7346 processes with a non-nil `process-query-on-exit-flag', Emacs will
7347 prompt the user before killing them."
7353 "Offer to save each buffer, then kill this Emacs process.
7354 With prefix ARG, silently save all file-visiting buffers without asking.
7355 If there are active processes where `process-query-on-exit-flag'
7356 returns non-nil and `confirm-kill-processes' is non-nil,
7357 asks whether processes should be killed.
7358 Runs the members of `kill-emacs-query-functions' in turn and stops
7359 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
7361 ;; Don't use save-some-buffers-default-predicate, because we want
7362 ;; to ask about all the buffers before killing Emacs.
7373 ;; process-list is not defined on MSDOS.
7376 active)
7400 ;; Query the user for other things, perhaps.
7407 "Offer to save each buffer, then kill the current connection.
7408 If the current frame has no client, kill Emacs itself using
7409 `save-buffers-kill-emacs'.
7411 With prefix ARG, silently save all file-visiting buffers, then kill.
7413 If emacsclient was started with a list of filenames to edit, then
7414 only these files will be asked to be saved."
7419 \f
7420 ;; We use /: as a prefix to "quote" a file name
7421 ;; so that magic file name handlers will not apply to it.
7425 file-name-handler-alist))
7427 ;; We depend on being the last handler on the list,
7428 ;; so that anything else that does need handling
7429 ;; has been handled already.
7430 ;; So it is safe for us to inhibit *all* magic file name handlers for
7431 ;; operations, which return a file name. See Bug#29579.
7435 ;; few cases, operations with two file name arguments which
7436 ;; might be bound to different file name handlers, we still
7437 ;; need this.
7439 file-name-handler-alist
7440 ;; Some operations respect file name handlers in
7441 ;; `default-directory'. Because core function like
7442 ;; `call-process' don't care about file name handlers in
7443 ;; `default-directory', we here have to resolve the directory
7444 ;; into a local one. For `process-file',
7445 ;; `start-file-process', and `shell-command', this fixes
7446 ;; Bug#25949.
7450 make-process shell-command
7451 temporary-file-directory))
7455 default-directory))
7456 ;; Get a list of the indices of the args that are file names.
7460 ;; return a file name. We want to include
7461 ;; the /: in the return value. So just
7462 ;; avoid stripping it in the first place.
7470 ;; `identity' means just return the first
7471 ;; arg not stripped of its quoting.
7473 ;; `add' means add "/:" to the result.
7475 ;;`insert-file-contents' needs special handling.
7477 ;; `unquote-then-quote' means set buffer-file-name
7478 ;; temporarily to unquoted filename.
7480 ;; Unquote `buffer-file-name' temporarily.
7483 ;; Use a temporary local copy.
7487 ;; List the arguments that are filenames.
7496 ;; These file-notify-* operations take a
7497 ;; descriptor.
7500 ;; `make-process' uses keyword arguments and
7501 ;; doesn't mangle its filenames in any way.
7502 ;; It already strips /: from the binary
7503 ;; filename, so we don't have to do this
7504 ;; here.
7506 ;; For all other operations, treat the first
7507 ;; argument only as the file name.
7509 method
7510 ;; Copy ARGUMENTS so we can replace elements in it.
7514 ;; Strip off the /: from the file names that have it.
7524 ('buffer-file-name
7527 ('insert-file-contents
7533 ('unquote-then-quote
7534 ;; We can't use `cl-letf' with `(buffer-local-value)' here
7535 ;; because it wouldn't work during bootstrapping.
7537 ;; `unquote-then-quote' is used only for the
7538 ;; `verify-visited-file-modtime' action, which takes a buffer
7539 ;; as only optional argument.
7542 ;; Make sure to hide the temporary buffer change from the
7543 ;; underlying operation.
7546 ('local-copy
7552 tmpfile)
7554 ;; If source is remote, we must create a local copy.
7559 ;; If source is quoted, and the unquoted source looks
7560 ;; remote, we must create a local copy.
7568 ;; If target is quoted, and the unquoted target looks remote,
7569 ;; we must disable the file name handler.
7574 ;; Do it.
7578 ;; Cleanup.
7587 If NAME is a remote file name and TOP is nil, check the local part of NAME."
7593 If NAME is a remote file name and TOP is nil, the local part of
7594 NAME is quoted. If NAME is already a quoted file name, NAME is
7595 returned unchanged."
7598 name
7603 If NAME is a remote file name and TOP is nil, the local part of
7604 NAME is unquoted."
7611 \f
7612 ;; Symbolic modes and read-file-modes.
7615 "Convert CHAR to a numeric bit-mask for extracting mode bits.
7616 CHAR is in [ugoa] and represents the category of users (Owner, Group,
7617 Others, or All) for whom to produce the mask.
7618 The bit-mask that is returned extracts from mode bits the access rights
7619 for the specified category of users."
7627 "Convert CHAR to a numeric value of mode bits.
7628 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7629 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7636 ;; Rights relative to the previous file modes.
7647 "Convert a symbolic mode string specification to an equivalent number.
7649 WHO-MASK is the bit-mask specifying the category of users to which to
7650 apply the access permissions. See `file-modes-char-to-who'.
7651 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7652 RIGHTS request to add, remove, or set permissions based on existing ones,
7659 char-right)
7666 num-rights
7670 op char-right)))
7671 num-rights))
7695 "Convert symbolic file modes to numeric file modes.
7696 MODES is the string to convert, it should match
7698 See Info node `(coreutils)File permissions' for more information on this
7699 notation.
7700 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7701 MODES request to add, remove, or set permissions based on existing ones,
7715 num-who num-modes)
7718 num-modes)))
7721 "Read file modes in octal or symbolic notation and return its numeric value.
7723 ORIG-FILE is the name of a file on whose mode bits to base returned
7724 permissions if what user types requests to add, remove, or set permissions
7740 nil nil default)))
7749 ;; Trashcan handling.
7751 "Directory for `move-file-to-trash' to move files and directories to.
7752 This directory is used only when the function `system-move-file-to-trash'
7753 is not defined.
7754 Relative paths are interpreted relative to `default-directory'.
7755 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7765 "Move the file (or directory) named FILENAME to the trash.
7766 When `delete-by-moving-to-trash' is non-nil, this function is
7767 called by `delete-file' and `delete-directory' instead of
7768 deleting files outright.
7770 If the function `system-move-file-to-trash' is defined, call it
7771 with FILENAME as an argument.
7772 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7773 directory.
7774 Otherwise, trash FILENAME using the freedesktop.org conventions,
7775 like the GNOME, KDE and XFCE desktop environments. Emacs moves
7778 ;; If `system-move-file-to-trash' is defined, use it.
7782 ;; If `trash-directory' is non-nil, move the file there.
7787 ;; We can't trash a parent directory of trash-directory.
7790 trash-dir filename))
7793 ;; Ensure that the trashed file-name is unique.
7800 ;; Otherwise, use the freedesktop.org method, as specified at
7801 ;; https://freedesktop.org/wiki/Specifications/trash-spec
7812 ;; Check if we have permissions to delete.
7816 ;; The trashed file cannot be the trash dir or its parent.
7819 trash-files-dir filename))
7822 trash-info-dir filename))
7824 ;; Ensure that the trash directory exists; otherwise, create it.
7831 ;; Try to move to trash with .trashinfo undo information
7836 ;; Perform url-encoding on FN. For compatibility with
7837 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7838 ;; for path separators.
7843 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7844 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7857 fn))
7862 ;; Make a .trashinfo file. Use O_EXCL, as per trash-spec 1.0.
7866 trash-info-dir)))
7870 ;; Uniquify new-fn. Some file managers do not
7871 ;; like Emacs-style backup file names. E.g.:
7872 ;; https://bugs.kde.org/170956
7879 ;; Finally, try to move the file to the trashcan.
7885 "The type field in ATTRIBUTES returned by `file-attributes'.
7886 The value is either t for directory, string (name linked to) for
7887 symbolic link, or nil."
7891 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7895 "The UID field in ATTRIBUTES returned by `file-attributes'.
7896 This is either a string or a number. If a string value cannot be
7897 looked up, a numeric value, either an integer or a float, is
7898 returned."
7902 "The GID field in ATTRIBUTES returned by `file-attributes'.
7903 This is either a string or a number. If a string value cannot be
7904 looked up, a numeric value, either an integer or a float, is
7905 returned."
7909 "The last access time in ATTRIBUTES returned by `file-attributes'.
7910 This a Lisp timestamp in the style of `current-time'."
7914 "The modification time in ATTRIBUTES returned by `file-attributes'.
7915 This is the time of the last change to the file's contents, and
7916 is a Lisp timestamp in the style of `current-time'."
7920 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7921 This is the time of last change to the file's attributes: owner
7922 and group, access mode bits, etc., and is a Lisp timestamp in the
7923 style of `current-time'."
7927 "The integer size (in bytes) in ATTRIBUTES returned by `file-attributes'."
7931 "The file modes in ATTRIBUTES returned by `file-attributes'.
7932 This is a string of ten letters or dashes as in ls -l."
7936 "The inode number in ATTRIBUTES returned by `file-attributes'.
7937 It is a nonnegative integer."
7941 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7942 It is an integer."
7946 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7947 ATTR-NAMES are symbols with the selected attribute names.
7949 Valid attribute names are: type, link-number, user-id, group-id,
7950 access-time, modification-time, status-change-time, size, modes,
7951 inode-number and device-number."
7953 modification-time status-change-time
7954 size modes inode-number device-number))
7955 result)
7961 attributes)
7962 result)
7965 \f
7990 ;;; files.el ends here