| blob | 7efbf05b1a65f03637317142f206a6819407250f |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2018 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 a match for FROM with TO when a directory name matches FROM. This
59 replacement is done when setting up the default directory of a
60 newly visited file buffer.
62 FROM is a regexp that is matched against directory names anchored at
66 FROM and TO should be equivalent names, which refer to the
67 same directory. TO should be an absolute directory name.
68 Do not use `~' in the TO strings.
70 Use this feature when you have directories which you normally refer to
71 via absolute symbolic links. Make TO the name of the link, and FROM
72 a regexp matching the name it is linked to."
81 "Non-nil means make a backup of a file the first time it is saved.
82 This can be done by renaming the file or by copying.
84 Renaming means that Emacs renames the existing file so that it is a
85 backup file, then writes the buffer into a new file. Any other names
86 that the old file had will now refer to the backup file. The new file
87 is owned by you and its group is defaulted.
89 Copying means that Emacs copies the existing file into the backup
90 file, then writes the buffer on top of the existing file. Any other
91 names that the old file had will now refer to the new (edited) file.
92 The file's owner and group are unchanged.
94 The choice of renaming or copying is controlled by the variables
95 `backup-by-copying', `backup-by-copying-when-linked',
96 `backup-by-copying-when-mismatch' and
97 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
101 ;; Do this so that local variables based on the file name
102 ;; are not overridden by the major mode.
104 "If non-nil, backups will be inhibited.
105 This variable is intended for use by making it local to a buffer,
110 "Non-nil means always use copying to create backup files.
111 See documentation of variable `make-backup-files'."
116 "Non-nil means use copying to create backups for files with multiple names.
117 This causes the alternate names to refer to the latest version as edited.
118 This variable is relevant only if `backup-by-copying' is nil."
123 "Non-nil means create backups by copying if this preserves owner or group.
124 Renaming may still be used (subject to control of other variables)
125 when it would not result in changing the owner or group of the file;
126 that is, for files which are owned by you and whose group matches
127 the default for a new file created there by you.
128 This variable is relevant only if `backup-by-copying' is nil."
135 "Non-nil means create backups by copying to preserve a privileged owner.
136 Renaming may still be used (subject to control of other variables)
137 when it would not result in changing the owner of the file or if the owner
138 has a user id greater than the value of this variable. This is useful
139 when low-numbered uid's are used for special system users (such as root)
140 that must maintain ownership of certain files.
141 This variable is relevant only if `backup-by-copying' and
142 `backup-by-copying-when-mismatch' are nil."
147 "Predicate that looks at a file name and decides whether to make backups.
151 "Non-nil in a buffer means always offer to save buffer on exiting Emacs.
152 Do so even if the buffer is not visiting a file.
153 Automatically local in all buffers.
155 Set to the symbol `always' to offer to save buffer whenever
156 `save-some-buffers' is called.
158 Note that this option has no effect on `kill-buffer';
159 if you want to control what happens when a buffer is killed,
160 use `kill-buffer-query-functions'."
169 "Non-nil means find a file under alternative names, in existing buffers.
170 This means if any existing buffer is visiting the file you want
171 under another name, you get the existing buffer instead of a new buffer."
176 "Non-nil means visiting a file uses its truename as the visited-file name.
177 That is, the buffer visiting the file has the truename as the
178 value of `buffer-file-name'. The truename of a file is found by
179 chasing all links both at the file level and at the levels of the
180 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.
211 "The directory for writing small temporary files.
212 If non-nil, this directory is used instead of `temporary-file-directory'
213 by programs that create small temporary files. This is for systems that
214 have fast storage with limited space, such as a RAM disk."
219 ;; The system null device. (Should reference NULL_DEVICE from C.)
246 "Non-nil means protect against I/O errors while saving files.
247 Some modes set this non-nil in particular buffers.
249 This feature works by writing the new contents into a temporary file
250 and then renaming the temporary file to replace the original.
251 In this way, any I/O error in writing leaves the original untouched,
252 and there is never any instant where the file is nonexistent.
254 Note that this feature forces backups to be made by copying.
255 Yet, at the same time, saving a precious file
256 breaks any hard links between it and other files.
258 This feature is advisory: for example, if the directory in which the
259 file is being saved is not writable, Emacs may ignore a non-nil value
260 of `file-precious-flag' and write directly into the file.
262 See also: `break-hardlink-on-save'."
267 "Whether to allow breaking hardlinks when saving files.
268 If non-nil, then when saving a file that exists under several
269 names \(i.e., has multiple hardlinks), break the hardlink
270 associated with `buffer-file-name' and write to a new file, so
271 that the other instances of the file are not affected by the
272 save.
274 If `buffer-file-name' refers to a symlink, do not break the symlink.
276 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
277 For example, if the directory in which a file is being saved is not
278 itself writable, then error instead of saving in some
279 hardlink-nonbreaking way.
281 See also `backup-by-copying' and `backup-by-copying-when-linked'."
287 "Control use of version numbers for backup files.
288 When t, make numeric backup versions unconditionally.
289 When nil, make them for files that have some already.
290 The value `never' means do not make them."
297 "Return whether X is safe as local value for `version-control'."
304 "When cleaning directory, number of versions to keep."
310 "If t, delete excess backup versions silently.
311 If nil, ask confirmation. Any other value prevents any trimming."
318 "Number of oldest versions to keep when a new numbered backup is made."
324 "Number of newest versions to keep when a new numbered backup is made.
325 Includes the new backup. Must be greater than 0."
331 "Whether to add a newline automatically at the end of the file.
333 A value of t means do this only when the file is about to be saved.
334 A value of `visit' means do this right after the file is visited.
335 A value of `visit-save' means do it at both of those times.
336 Any other non-nil value means ask user whether to add a newline, when saving.
337 A value of nil means don't add newlines.
339 Certain major modes set this locally to the value obtained
340 from `mode-require-final-newline'."
350 "Whether to add a newline at end of file, in certain major modes.
351 Those modes set `require-final-newline' to this value when you enable them.
352 They do so because they are often used for files that are supposed
353 to end in newlines, and the question is how to arrange that.
355 A value of t means do this only when the file is about to be saved.
356 A value of `visit' means do this right after the file is visited.
357 A value of `visit-save' means do it at both of those times.
358 Any other non-nil value means ask user whether to add a newline, when saving.
360 A value of nil means do not add newlines. That is a risky choice in this
361 variable since this value is used for modes for files that ought to have
362 final newlines. So if you set this to nil, you must explicitly check and
363 add a final newline, whenever you save a file that really needs one."
373 "Non-nil says by default do auto-saving of every file-visiting buffer."
379 ;; Don't put "\\2" inside expand-file-name, since it will be
380 ;; transformed to "/2" on DOS/Windows.
382 "Transforms to apply to buffer file name before making auto-save file name.
383 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
384 REGEXP is a regular expression to match against the file name.
385 If it matches, `replace-match' is used to replace the
386 matching part with REPLACEMENT.
387 If the optional element UNIQUIFY is non-nil, the auto-save file name is
388 constructed by taking the directory part of the replaced file-name,
389 concatenated with the buffer file name with all directory separators
390 changed to `!' to prevent clashes. This will not work
391 correctly if your filesystem truncates the resulting name.
393 All the transforms in the list are tried, in the order they are listed.
394 When one transform applies, its result is final;
395 no further transforms are tried.
397 The default value is set up to put the auto-save file into the
398 temporary directory (see the variable `temporary-file-directory') for
399 editing a remote file.
401 On MS-DOS filesystems without long names this variable is always
402 ignored."
412 "Interval in seconds for `auto-save-visited-mode'.
413 If `auto-save-visited-mode' is enabled, Emacs will save all
414 buffers visiting a file to the visited file after it has been
415 idle for `auto-save-visited-interval' seconds."
425 "Toggle automatic saving to file-visiting buffers on or off.
427 Unlike `auto-save-mode', this mode will auto-save buffer contents
428 to the visited files directly and will also run all save-related
429 hooks. See Info node `Saving' for details of the save process."
431 :global t
436 auto-save-visited-interval :repeat
441 auto-save-visited-file-name))))))))
443 ;; The 'set' part is so we don't get a warning for using this variable
444 ;; above, while still catching code that _sets_ the variable to get
445 ;; the same effect as the new auto-save-visited-mode.
450 "Non-nil means save word abbrevs too when files are saved.
451 If `silently', don't ask the user before saving."
456 "Non-nil means allow `find-file' to visit directories.
457 To visit the directory, `find-file' runs `find-directory-functions'."
462 "List of functions to try in sequence to visit a directory.
463 Each function is called with the directory name as the sole argument
464 and should return either a buffer or nil."
468 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
470 "List of functions to try in sequence to get a file name at point.
471 Each function should return either nil or a file name found at the
472 location of point in the current buffer."
476 ;;;It is not useful to make this a local variable.
477 ;;;(put 'find-file-not-found-functions 'permanent-local t)
481 "List of functions to be called for `find-file' on nonexistent file.
482 These functions are called as soon as the error is detected.
483 Variable `buffer-file-name' is already set up.
486 ;;;It is not useful to make this a local variable.
487 ;;;(put 'find-file-hook 'permanent-local t)
488 ;; I found some external files still using the obsolete form in 2018.
491 "List of functions to be called after a buffer is loaded from a file.
492 The buffer's local variables (if any) will have been processed before the
493 functions are called."
499 ;; I found some external files still using the obsolete form in 2018.
502 "List of functions to be called before saving a buffer to a file.
503 Only used by `save-buffer'.
504 If one of them returns non-nil, the file is considered already written
505 and the rest are not called.
506 These hooks are considered to pertain to the visited file.
507 So any buffer-local binding of this variable is discarded if you change
509 change the major mode.
511 This hook is not run if any of the functions in
512 `write-contents-functions' returns non-nil. Both hooks pertain
513 to how to save a buffer to file, for instance, choosing a suitable
514 coding system and setting mode bits. (See Info
515 node `(elisp)Saving Buffers'.) To perform various checks or
519 ;; I found some files still using the obsolete form in 2018.
525 ;; I found some files still using the obsolete form in 2018.
529 "List of functions to be called before writing out a buffer to a file.
531 Only used by `save-buffer'. If one of them returns non-nil, the
532 file is considered already written and the rest are not called
533 and neither are the functions in `write-file-functions'. This
534 hook can thus be used to create save behavior for buffers that
535 are not visiting a file at all.
537 This variable is meant to be used for hooks that pertain to the
538 buffer's contents, not to the particular visited file; thus,
539 `set-visited-file-name' does not clear this variable; but changing the
540 major mode does clear it.
542 For hooks that _do_ pertain to the particular visited file, use
543 `write-file-functions'. Both this variable and
544 `write-file-functions' relate to how a buffer is saved to file.
545 To perform various checks or updates before the buffer is saved,
550 "Control use of local variables in files you visit.
551 The value can be t, nil, :safe, :all, or something else.
553 A value of t means file local variables specifications are obeyed
554 if all the specified variable values are safe; if any values are
555 not safe, Emacs queries you, once, whether to set them all.
556 \(When you say yes to certain values, they are remembered as safe.)
558 :safe means set the safe variables, and ignore the rest.
559 :all means set all variables, whether safe or not.
560 (Don't set it permanently to :all.)
561 A value of nil means always ignore the file local variables.
563 Any other value means always query you once whether to set them all.
564 \(When you say yes to certain values, they are remembered as safe, but
567 This variable also controls use of major modes specified in
568 a -*- line.
571 always obeys file local variable specifications and the -*- line,
572 and ignores this variable."
573 :risky t
582 "Non-nil means enable use of directory-local variables.
583 Some modes may wish to set this to nil to prevent directory-local
586 ;; This is an odd variable IMO.
587 ;; You might wonder why it is needed, when we could just do:
588 ;; (set (make-local-variable 'enable-local-variables) nil)
589 ;; These two are not precisely the same.
590 ;; Setting this variable does not cause -*- mode settings to be
591 ;; ignored, whereas setting enable-local-variables does.
592 ;; Only three places in Emacs use this variable: tar and arc modes,
593 ;; and rmail. The first two don't need it. They already use
594 ;; inhibit-local-variables-regexps, which is probably enough, and
595 ;; could also just set enable-local-variables locally to nil.
596 ;; Them setting it has the side-effect that dir-locals cannot apply to
597 ;; eg tar files (?). FIXME Is this appropriate?
598 ;; AFAICS, rmail is the only thing that needs this, and the only
599 ;; reason it uses it is for BABYL files (which are obsolete).
600 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
601 ;; to respect, so that find-file on a BABYL file will switch to
602 ;; rmail-mode automatically (this is nice, but hardly essential,
603 ;; since most people are used to explicitly running a command to
604 ;; access their mail; M-x gnus etc). Rmail files may happen to
605 ;; contain Local Variables sections in messages, which Rmail wants to
606 ;; ignore. So AFAICS the only reason this variable exists is for a
607 ;; minor convenience feature for handling of an obsolete Rmail file format.
609 "Like `enable-local-variables', except for major mode in a -*- line.
610 The meaningful values are nil and non-nil. The default is non-nil.
611 It should be set in a buffer-local fashion.
613 Setting this to nil has the same effect as setting `enable-local-variables'
614 to nil, except that it does not ignore any mode: setting in a -*- line.
615 Unless this difference matters to you, you should set `enable-local-variables'
620 The value can be t, nil or something else.
621 A value of t means obey `eval' variables.
622 A value of nil means ignore them; anything else means query."
623 :risky t
630 "Non-nil means buffers visiting files read-only do so in view mode.
631 In fact, this means that all read-only buffers normally have
632 View mode enabled, including buffers that are read-only because
633 you visit a file you cannot alter, and buffers you make read-only
639 "History list of file names entered in the minibuffer.
641 Maximum length of the history list is determined by the value
645 "If non-nil, avoid messages when saving files.
646 Error-related messages will still be printed, but all other
649 \f
652 "Provides support for ange-ftp host name completion.
653 Runs the usual ange-ftp hook, but only for completion operations."
654 ;; Having this here avoids the need to load ange-ftp when it's not
655 ;; really in use.
661 inhibit-file-name-handlers)))
669 "Convert a standard file's name to something suitable for the OS.
670 This means to guarantee valid names and perhaps to canonicalize
671 certain patterns.
673 FILENAME should be an absolute file name since the conversion rules
674 sometimes vary depending on the position in the file name. E.g. c:/foo
675 is a valid DOS file name, but c:/bar/c:/foo is not.
677 This function's standard definition is trivial; it just returns
678 the argument. However, on Windows and DOS, replace invalid
679 characters. On DOS, make sure to obey the 8.3 limitations.
680 In the native Windows build, turn Cygwin names into native names.
682 See Info node `(elisp)Standard File Names' for more details."
687 ;; Replace invalid filename characters with !
691 name))
699 "Read directory name, prompting with PROMPT and completing in directory DIR.
700 Value is not expanded---you must call `expand-file-name' yourself.
701 Default name to DEFAULT-DIRNAME if user exits with the same
702 non-empty string that was inserted by this function.
703 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
704 or just DIR if INITIAL is nil.)
705 If the user exits with an empty minibuffer, this function returns
706 an empty string. (This can only happen if the user erased the
707 pre-inserted contents or if `insert-default-directory' is nil.)
708 Fourth arg MUSTMATCH non-nil means require existing directory's name.
709 Non-nil and non-t means also require confirmation after completion.
710 Fifth arg INITIAL specifies text to start with.
711 DIR should be an absolute directory name. It defaults to
712 the value of `default-directory'."
717 dir))
718 mustmatch initial
721 \f
723 "Show the current default directory.
724 With prefix argument INSERT, insert the current default directory
725 at point instead."
732 "Value of the CDPATH environment variable, as a list.
736 "Explode a search path into a list of directory names.
737 Directories are separated by `path-separator' (which is colon in
738 GNU and Unix systems). Substitute environment variables into the
739 resulting list of directory names. For an empty path element (i.e.,
740 a leading or trailing separator, or two adjacent separators), return
741 nil (meaning `default-directory') as the associated list element."
749 "Change current directory to given absolute file name DIR."
750 ;; Put the name into directory syntax now,
751 ;; because otherwise expand-file-name may give some bad results.
753 ;; We used to additionally call abbreviate-file-name here, for an
754 ;; unknown reason. Problem is that most buffers are setup
755 ;; without going through cd-absolute and don't call
756 ;; abbreviate-file-name on their default-directory, so the few that
757 ;; do end up using a superficially different directory.
769 "Make DIR become the current buffer's default directory.
770 If your environment includes a `CDPATH' variable, try each one of
771 that list of directories (separated by occurrences of
772 `path-separator') when resolving a relative directory name.
773 The path separator is colon in GNU and GNU-like systems."
776 ;; FIXME: There's a subtle bug in the completion below. Seems linked
777 ;; to a fundamental difficulty of implementing `predicate' correctly.
778 ;; The manifestation is that TAB may list non-directories in the case where
779 ;; those files also correspond to valid directories (if your cd-path is (A/
780 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
781 ;; will be listed as valid completions).
782 ;; This is because `a' (listed because of A/a) is indeed a valid choice
783 ;; (which will lead to the use of B/a).
788 cd-path nil))
797 default-directory default-directory
798 t))))
808 "Return list of all files under DIR that have file names matching REGEXP.
810 order, and files from each directory are sorted in alphabetical order.
811 Each file name appears in the returned list in its absolute form.
812 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
813 output directories whose names match REGEXP."
816 ;; When DIR is "/", remote file names like "/method:" could
817 ;; also be offered. We shall suppress them.
825 ;; Don't follow symlinks to other directories.
829 full-file regexp include-directories))))
840 "Load the Lisp file named FILE."
841 ;; This is a case where .elc and .so/.dll make a lot of sense.
845 completion-ignored-extensions))))
850 "Search for FILENAME through PATH.
851 If found, return the absolute file name of FILENAME; otherwise
852 return nil.
853 PATH should be a list of directories to look in, like the lists in
854 `exec-path' or `load-path'.
855 If SUFFIXES is non-nil, it should be a list of suffixes to append to
858 If non-nil, PREDICATE is used instead of `file-readable-p'.
860 This function will normally skip directories, so if you want it to find
861 directories, make sure the PREDICATE function returns `dir-ok' for them.
863 PREDICATE can also be an integer to pass to the `access' system call,
864 in which case file-name handlers are ignored. This usage is deprecated.
865 For compatibility, PREDICATE can also be one of the symbols
866 `executable', `readable', `writable', or `exists', or a list of
867 one or more of those symbols."
878 "Do completion for file names passed to `locate-file'."
881 ;; FIXME: maybe we should use completion-file-name-table instead,
882 ;; tho at least for `load', the arg is passed through
883 ;; substitute-in-file-name for historical reasons.
893 ;; If we have files like "foo.el" and "foo.elc", we could load one of
894 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
895 ;; preferred way. So if we list all 3, that gives a lot of redundant
896 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
897 ;; the user does want to pay attention to the extension. We try to
898 ;; diffuse this tension by stripping the suffix, except when the
899 ;; result is a single element (i.e. usually we only list "foo" unless
900 ;; it's the only remaining element in the list, in which case we do
901 ;; list "foo", "foo.elc" and "foo.el").
912 string-file dir))
917 ;; Switching from names to names+fullnames creates a non-monotonicity
918 ;; which can cause problems with things like partial-completion.
919 ;; To minimize the problem, filter out completion-regexp-list, so that
920 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
921 ;; from `names' which only matched `string' when they still had
922 ;; their suffix.
924 ;; Remove duplicates of the first element, so that we can easily check
925 ;; if `names' really only contains a single element.
928 ;; There's no more than one matching non-suffixed element, so expand
929 ;; the list by adding the suffixed elements as well.
932 string-dir names string-file pred action)))))
935 "Do completion for file names passed to `locate-file'.
936 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
940 string nil action))
944 "Regexp of directory names which stop the search in `locate-dominating-file'.
945 Any directory whose name matches this regexp will be treated like
946 a kind of root directory by `locate-dominating-file' which will stop its search
947 when it bumps into it.
948 The default regexp prevents fruitless and time-consuming attempts to find
949 special files in directories in which filenames are interpreted as hostnames,
953 "Starting at FILE, look up directory hierarchy for directory containing NAME.
954 FILE can be a file or a directory. If it's a file, its directory will
955 serve as the starting point for searching the hierarchy of directories.
956 Stop at the first parent directory containing a file NAME,
957 and return the directory. Return nil if not found.
958 Instead of a string, NAME can also be a predicate taking one argument
959 \(a directory) and returning a non-nil value if that directory is the one for
960 which we're looking. The predicate will be called with every file/directory
961 the function needs to examine, starting with FILE."
962 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
963 ;; `name' in /home or in /.
966 try)
981 "Non-nil means warn if cannot access `user-emacs-directory'.
982 Set this to nil at your own risk..."
988 "Return an absolute per-user Emacs-specific file name.
989 If NEW-NAME exists in `user-emacs-directory', return it.
990 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
991 Else return NEW-NAME in `user-emacs-directory', creating the
992 directory if it does not exist."
1000 at-home
1001 ;; Make sure `user-emacs-directory' exists,
1002 ;; unless we're in batch mode or dumping Emacs.
1004 purify-flag
1014 user-emacs-directory-warning
1016 ;; Only warn once per Emacs session.
1020 Unable to %s `user-emacs-directory' (%s).
1021 Any data that would normally be written there may be lost!
1022 If you never want to see this message again,
1023 customize the variable `user-emacs-directory-warning'."
1024 errtype user-emacs-directory)))))
1025 bestname))))
1028 "Return list of directories to search programs to run in remote subprocesses.
1029 The remote host is identified by `default-directory'. For remote
1030 hosts which do not support subprocesses, this returns `nil'.
1031 If `default-directory' is a local directory, this function returns
1032 the value of the variable `exec-path'."
1036 exec-path)))
1039 "Search for COMMAND in `exec-path' and return the absolute file name.
1040 Return nil if COMMAND is not found anywhere in `exec-path'. If
1041 REMOTE is non-nil, search on the remote host indicated by
1042 `default-directory' instead."
1045 command
1051 ;; Use 1 rather than file-executable-p to better match the
1052 ;; behavior of call-process.
1056 "Load the Emacs Lisp library named LIBRARY.
1057 LIBRARY should be a string.
1058 This is an interface to the function `load'. LIBRARY is searched
1059 for in `load-path', both with and without `load-suffixes' (as
1060 well as `load-file-rep-suffixes').
1062 See Info node `(emacs)Lisp Libraries' for more details.
1063 See `load-file' for a different interface to `load'."
1068 load-path
1073 "Test whether FILE specifies a location on a remote system.
1074 A file is considered remote if accessing it is likely to
1075 be slower or less reliable than accessing local files.
1077 `file-remote-p' never opens a new remote connection. It can
1078 only reuse a connection that is already open.
1080 Return nil or a string identifying the remote connection
1081 \(ideally a prefix of FILE). Return nil if FILE is a relative
1082 file name.
1084 When IDENTIFICATION is nil, the returned string is a complete
1085 remote identifier: with components method, user, and host. The
1086 components are those present in FILE, with defaults filled in for
1087 any that are missing.
1089 IDENTIFICATION can specify which part of the identification to
1090 return. IDENTIFICATION can be the symbol `method', `user',
1091 `host', or `localname'. Any other value is handled like nil and
1092 means to return the complete identification. The string returned
1093 for IDENTIFICATION `localname' can differ depending on whether
1094 there is an existing connection.
1096 If CONNECTED is non-nil, return an identification only if FILE is
1097 located on a remote system and a connection is established to
1098 that remote system.
1100 Tip: You can use this expansion of remote identifier components
1101 to derive a new remote file name from an existing one. For
1107 same remote identifier as FILE but expanded; a name such as
1112 nil)))
1114 ;; Probably this entire variable should be obsolete now, in favor of
1115 ;; something Tramp-related (?). It is not used in many places.
1116 ;; It's not clear what the best file for this to be in is, but given
1117 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1118 ;; rather than autoloaded.
1120 ;; This used to try various hard-coded places for remsh, rsh, and
1121 ;; rcmd, trying to guess based on location whether "rsh" was
1122 ;; "restricted shell" or "remote shell", but I don't see the point
1123 ;; in this day and age. Almost everyone will use ssh, and have
1124 ;; whatever command they want to use in PATH.
1131 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1138 "Whether to use the remote file-name cache for read access.
1139 When nil, never expire cached values (caution)
1140 When t, never use the cache (safe, but may be slow)
1141 A number means use cached values for that amount of seconds since caching.
1143 The attributes of remote files are cached for better performance.
1144 If they are changed outside of Emacs's control, the cached values
1145 become invalid, and must be reread. If you are sure that nothing
1146 other than Emacs changes the files, you can set this variable to nil.
1148 If a remote file is checked regularly, it might be a good idea to
1149 let-bind this variable to a value less than the interval between
1150 consecutive checks. For example:
1152 (defun display-time-file-nonempty-p (file)
1153 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1154 (and (file-exists-p file)
1155 (< 0 (file-attribute-size
1156 (file-attributes (file-chase-links file)))))))"
1167 "Return the local name component of FILE.
1168 It returns a file name which can be used directly as argument of
1169 `process-file', `start-file-process', or `shell-command'."
1173 "Copy the file FILE into a temporary file on this machine.
1174 Returns the name of the local copy, or nil, if FILE is directly
1175 accessible."
1176 ;; This formerly had an optional BUFFER argument that wasn't used by
1177 ;; anything.
1181 nil)))
1184 "Return non-nil if FILE is an absolute name to the operating system.
1185 This is like `file-name-absolute-p', except that it returns nil for
1186 names beginning with `~'."
1191 "Splice DIRNAME to FILE like the operating system would.
1192 If FILE is relative, return DIRNAME concatenated to FILE.
1193 Otherwise return FILE, quoted as needed if DIRNAME and FILE have
1194 different handlers; although this quoting is dubious if DIRNAME
1195 is magic, it is not clear what would be better. This function
1196 differs from `expand-file-name' in that DIRNAME must be a
1197 directory name and leading `~' and `/:' are not special in FILE."
1199 file
1203 unquoted
1207 "Return the truename of FILENAME.
1208 If FILENAME is not absolute, first expands it against `default-directory'.
1209 The truename of a file name is found by chasing symbolic links
1210 both at the level of the file and at the level of the directories
1211 containing it, until no links are left at any level.
1214 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1215 ;; COUNTER can be a cons cell whose car is the count of how many
1216 ;; more links to chase before getting an error.
1217 ;; PREV-DIRS can be a cons cell whose car is an alist
1218 ;; of truenames we've just recently computed.
1232 ;; For speed, remove the ange-ftp completion handler from the list.
1233 ;; We know it's not needed here.
1234 ;; For even more speed, do this only on the outermost call.
1241 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1242 ;; case differences being ignored by the OS, and short "8.3 DOS"
1243 ;; name aliases existing for all files. (The short names are not
1244 ;; reported by directory-files, but can be used to refer to files.)
1245 ;; It seems appropriate for file-truename to resolve these issues in
1246 ;; the most natural way, which on Windows is to call the function
1247 ;; `w32-long-file-name' - this returns the exact name of a file as
1248 ;; it is stored on disk (expanding short name aliases with the full
1249 ;; name in the process).
1252 ;; If filename exists, use its long name. If it doesn't
1253 ;; exist, the recursion below on the directory of filename
1254 ;; will drill down until we find a directory that exists,
1255 ;; and use the long name of that, with the extra
1256 ;; non-existent path components concatenated.
1261 ;; If this file directly leads to a link, process that iteratively
1262 ;; so that we don't use lots of stack.
1268 ;; For file name that has a special handler, call handler.
1269 ;; This is so that ange-ftp can save time by doing a no-op.
1272 done t)
1274 target dirfile)
1275 ;; Get the truename of the directory.
1277 ;; If these are equal, we have the (or a) root directory.
1281 ;; If this is the same dir we last got the truename for,
1282 ;; save time--don't recalculate.
1292 done t)
1295 done t)
1296 ;; Put it back on the file name.
1298 ;; Is the file name the name of a link?
1301 ;; Yes => chase that link, then start all over
1302 ;; since the link may point to a directory name that uses links.
1303 ;; We can't safely use expand-file-name here
1304 ;; since target might look like foo/../bar where foo
1305 ;; is itself a link. Instead, we handle . and .. above.
1307 done nil)
1308 ;; No, we are done!
1310 filename))
1313 "Chase links in FILENAME until a name that is not a link.
1314 Unlike `file-truename', this does not check whether a parent
1315 directory name is a symbolic link.
1316 If the optional argument LIMIT is a number,
1317 it means chase no more than that many links and then stop."
1325 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1328 ;; Handle `..' by hand, since it needs to work in the
1329 ;; target of any directory symlink.
1330 ;; This code is not quite complete; it does not handle
1331 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1335 ;; Chase links in the default dir of the symlink.
1339 ;; Now find the parent of that dir.
1342 tem))
1344 newname))
1346 ;; A handy function to display file sizes in human-readable form.
1347 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1349 "Produce a string showing FILE-SIZE in human-readable form.
1351 Optional second argument FLAVOR controls the units and the display format:
1353 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1355 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1357 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1360 1024.0
1363 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1369 "%.1f%s%s"
1371 file-size
1373 "K"
1379 "^//[^/]+/"
1380 ;; regexp-opt.el is not dumped into emacs binary.
1381 ;;(concat
1382 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1384 "File systems which ought to be mounted."
1391 "The directory for writing temporary files.
1392 In case of a remote `default-directory', this is a directory for
1393 temporary files on that remote host. If such a directory does
1394 not exist, or `default-directory' ought to be located on a
1395 mounted file system (see `mounted-file-systems'), the function
1396 returns `default-directory'.
1397 For a non-remote and non-mounted `default-directory', the value of
1398 the variable `temporary-file-directory' is returned."
1404 default-directory
1405 temporary-file-directory))))
1408 "Create a temporary file.
1409 The returned file name (created by appending some random characters at the end
1410 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1411 is guaranteed to point to a newly created file.
1412 You can then use `write-region' to write new data into the file.
1414 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1416 If SUFFIX is non-nil, add that at the end of the file name.
1418 If TEXT is a string, insert it into the new file; DIR-FLAG should be nil.
1419 Otherwise the file will be empty."
1431 "Implement (make-temp-file ABSOLUTE-PREFIX DIR-FLAG SUFFIX TEXT).
1432 This implementation works on magic file names."
1433 ;; Create temp files with strict access rights. It's easy to
1434 ;; loosen them later, whereas it's impossible to close the
1435 ;; time-window of loose permissions otherwise.
1438 file)
1447 nil)
1449 ;; the file was somehow created by someone else between
1450 ;; `make-temp-name' and `write-region', let's try again.
1451 nil)
1452 file)))
1455 "Create a temporary file as close as possible to `default-directory'.
1456 If PREFIX is a relative file name, and `default-directory' is a
1457 remote file name or located on a mounted file systems, the
1458 temporary file is created in the directory returned by the
1459 function `temporary-file-directory'. Otherwise, the function
1460 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1461 same meaning as in `make-temp-file'."
1470 "Change the encoding of FILE's name from CODING to NEW-CODING.
1471 The value is a new name of FILE.
1472 Signals a `file-already-exists' error if a file of the new name
1473 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1474 is non-nil. A number as fourth arg means request confirmation if
1475 the new name already exists. This is what happens in interactive
1476 use with M-x."
1479 default-file-name-coding-system))
1481 from-coding to-coding)
1483 ;; We provide the default coding only when it seems that
1484 ;; the filename is correctly decoded by the default
1485 ;; coding.
1491 filename default-coding)
1492 default-coding))
1496 ;; We provide the default coding only when a user is going to
1497 ;; change the encoding not from the default coding.
1501 filename from-coding)))
1504 filename from-coding default-coding)
1505 default-coding)))
1509 default-file-name-coding-system))
1510 ;; FILE should have been decoded by DEFAULT-CODING.
1514 ;; Suppress further encoding.
1519 newname))
1520 \f
1522 "Whether confirmation is requested before visiting a new file or buffer.
1523 If nil, confirmation is not requested.
1524 If the value is `after-completion', confirmation is only
1525 requested if the user called `minibuffer-complete' right before
1526 `minibuffer-complete-and-exit'.
1527 Any other non-nil value means to request confirmation.
1529 This affects commands like `switch-to-buffer' and `find-file'."
1537 "Whether to request confirmation before visiting a new file or buffer.
1538 The variable `confirm-nonexistent-file-or-buffer' determines the
1539 return value, which may be passed as the REQUIRE-MATCH arg to
1540 `read-buffer' or `find-file-read-args'."
1548 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1550 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1551 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1552 instead of prepending it.
1554 BODY should use the minibuffer at most once.
1555 Recursive uses of the minibuffer are unaffected (FUN is not
1556 called additional times).
1558 This macro actually adds an auxiliary function that calls FUN,
1559 rather than FUN itself, to `minibuffer-setup-hook'."
1570 ;; Clear out this hook so it does not interfere
1571 ;; with any recursive minibuffer usage.
1582 t))
1585 "Edit file FILENAME.
1586 Switch to a buffer visiting file FILENAME,
1587 creating one if none already exists.
1588 Interactively, the default if you just type RET is the current directory,
1589 but the visited file name is available through the minibuffer history:
1593 the file name, the result is affected by `file-name-at-point-functions',
1594 which by default try to guess the file name by looking at point in the
1595 current buffer. Customize the value of `file-name-at-point-functions'
1596 or set it to nil, if you want only the visited file name and the
1598 request.
1600 You can visit files on remote machines by specifying something
1601 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1602 also visit local files as a different user by specifying
1603 /sudo::FILE for the file name.
1604 See the Info node `(tramp)File name Syntax' in the Tramp Info
1605 manual, for more about this.
1607 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1608 expand wildcards (if any) and visit multiple files. You can
1609 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1611 To visit a file without any kind of conversion and without
1622 "Edit file FILENAME, in another window.
1625 an existing one. See the function `display-buffer'.
1627 Interactively, the default if you just type RET is the current directory,
1628 but the visited file name is available through the minibuffer history:
1632 the file name, the result is affected by `file-name-at-point-functions',
1633 which by default try to guess the file name by looking at point in the
1634 current buffer. Customize the value of `file-name-at-point-functions'
1635 or set it to nil, if you want only the visited file name and the
1637 request.
1639 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1640 expand wildcards (if any) and visit multiple files."
1650 value)
1654 "Edit file FILENAME, in another frame.
1657 an existing one. See the function `display-buffer'.
1659 Interactively, the default if you just type RET is the current directory,
1660 but the visited file name is available through the minibuffer history:
1664 the file name, the result is affected by `file-name-at-point-functions',
1665 which by default try to guess the file name by looking at point in the
1666 current buffer. Customize the value of `file-name-at-point-functions'
1667 or set it to nil, if you want only the visited file name and the
1669 request.
1671 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1672 expand wildcards (if any) and visit multiple files."
1682 value)
1686 "Edit the existing file FILENAME.
1688 file names with wildcards."
1705 value))
1708 "Edit file FILENAME but don't allow changes.
1717 "Edit file FILENAME in another window but don't allow changes.
1726 "Edit file FILENAME in another frame but don't allow changes.
1735 "Find file FILENAME as a replacement for the file in the next window.
1736 This command does not select that window.
1740 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1741 expand wildcards (if any) and replace the file with multiple files."
1752 "Find alternate file: " file-dir nil
1754 t))))
1761 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1763 "Hook run when a buffer is killed.
1764 The buffer being killed is current while the hook is running.
1765 See `kill-buffer'.
1767 Note: Be careful with let-binding this hook considering it is
1771 "Find file FILENAME, select its buffer, kill previous buffer.
1772 If the current buffer now contains an empty file that you just visited
1773 \(presumably by mistake), use this command to visit the file you really want.
1777 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1778 expand wildcards (if any) and replace the file with multiple files.
1780 If the current buffer is an indirect buffer, or the base buffer
1781 for one or more indirect buffers, the other buffer(s) are not
1782 killed."
1791 "Find alternate file: " file-dir nil
1793 t)))
1807 ;; Run `kill-buffer-hook' here. It needs to happen before
1808 ;; variables like `buffer-file-name' etc are set to nil below,
1809 ;; because some of the hooks that could be invoked
1810 ;; (e.g., `save-place-to-alist') depend on those variables.
1811 ;;
1812 ;; Note that `kill-buffer-hook' is not what queries whether to
1813 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1814 ;; asks that itself. Thus, there's no need to temporarily do
1815 ;; `(set-buffer-modified-p nil)' before running this hook.
1817 ;; Okay, now we can end-of-life the old buffer.
1824 ;; This prevents us from finding the same buffer
1825 ;; if we specified the same file again.
1829 ;; Likewise for dired buffers.
1831 ;; Don't use `find-file' because it may end up using another window
1832 ;; in some corner cases, e.g. when the selected window is
1833 ;; softly-dedicated.
1837 ;; This executes if find-file gets an error
1838 ;; and does not really find anything.
1839 ;; We put things back as they were.
1840 ;; If find-file actually finds something, we kill obuf below.
1849 ;; We already ran these; don't run them again.
1852 \f
1853 ;; FIXME we really need to fold the uniquify stuff in here by default,
1854 ;; not using advice, and add it to the doc string.
1856 "Create a suitably named buffer for visiting FILENAME, and return it.
1857 FILENAME (sans directory) is used unchanged if that name is free;
1858 otherwise a string <2> or <3> or ... is appended to get an unused name.
1860 Emacs treats buffers whose names begin with a space as internal buffers.
1861 To avoid confusion when visiting a file whose name begins with a space,
1868 lastname))))
1871 "Create and return a buffer with a name based on NAME.
1872 Choose the buffer's name using `generate-new-buffer-name'."
1876 "Regexp to match the automounter prefix in a directory name."
1882 "Regexp matching the user's homedir at the beginning of file name.
1886 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1888 home directory is a root directory) and removes automounter prefixes
1889 \(see the variable `automount-dir-prefix').
1891 When this function is first called, it caches the user's home
1892 directory as a regexp in `abbreviated-home-dir', and reuses it
1893 afterwards (so long as the home directory does not change;
1894 if you want to permanently change your home directory after having
1895 started Emacs, set `abbreviated-home-dir' to nil so it will be recalculated)."
1896 ;; Get rid of the prefixes added by the automounter.
1903 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1905 ;; If any elt of directory-abbrev-alist matches this name,
1906 ;; abbreviate accordingly.
1912 ;; Compute and save the abbreviated homedir name.
1913 ;; We defer computing this until the first time it's needed, to
1914 ;; give time for directory-abbrev-alist to be set properly.
1915 ;; We include a slash at the end, to avoid spurious matches
1916 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1926 ;; Depending on whether default-directory does or
1927 ;; doesn't include non-ASCII characters, the value
1928 ;; of abbreviated-home-dir could be multibyte or
1929 ;; unibyte. In the latter case, we need to decode
1930 ;; it. Note that this function is called for the
1931 ;; first time (from startup.el) when
1932 ;; locale-coding-system is already set up.
1934 abbreviated-home-dir
1937 'utf-8
1938 locale-coding-system))))))
1940 ;; If FILENAME starts with the abbreviated homedir,
1941 ;; and ~ hasn't changed since abbreviated-home-dir was set,
1942 ;; make it start with `~' instead.
1943 ;; If ~ has changed, we ignore abbreviated-home-dir rather than
1944 ;; invalidating it, on the assumption that a change in HOME
1945 ;; is likely temporary (eg for testing).
1946 ;; FIXME Is it even worth caching abbreviated-home-dir?
1947 ;; Ref: https://debbugs.gnu.org/19657#20
1949 ;; If the home dir is just /, don't change it.
1952 ;; MS-DOS root directories can come with a drive letter;
1953 ;; Novell Netware allows drive letters beyond `Z:'.
1963 filename)))
1966 "Return the buffer visiting file FILENAME (a string).
1967 This is like `get-file-buffer', except that it checks for any buffer
1968 visiting the same file, possibly under a different name.
1969 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1970 and others are ignored.
1971 If there is no such live buffer, return nil."
1984 found)
1994 ;; Verify this buffer's file number
1995 ;; still belongs to its file.
1998 attributes)
2002 found))))
2003 \f
2005 "Non-nil means file-visiting commands should handle wildcards.
2006 For example, if you specify `*.c', that would visit all the files
2007 whose names match the pattern."
2013 "Non-nil means suppress warning messages for symlinked files.
2014 When nil, Emacs prints a warning when visiting a file that is already
2015 visited, but with a different name. Setting this option to t
2016 suppresses this warning."
2022 "Maximum size of file above which a confirmation is requested.
2023 When nil, never request confirmation."
2030 "Warn if file size exceeds this percentage of available free memory.
2031 When nil, never issue warning. Beware: This probably doesn't do what you
2047 last-input-event
2049 use-dialog-box))
2064 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
2065 OP-TYPE specifies the file operation being performed (for message
2066 to user). If OFFER-RAW is true, give user the additional option
2067 to open the file literally. If the user chooses this option,
2068 `abort-if-file-too-large' returns the symbol `raw'. Otherwise, it
2069 returns nil or exits non-locally."
2072 ;; No point in warning if we can't read it.
2075 size op-type filename offer-raw))))
2078 choice))
2081 "Warn if an attempt to open file of SIZE bytes may run out of memory."
2091 "You are trying to open a file whose size (%s)
2092 exceeds the %S%% of currently available free memory (%s).
2093 If that fails, try to open it with `find-file-literally'
2094 \(but note that some characters might be displayed incorrectly)."
2096 out-of-memory-warning-percentage
2100 "Like `message', except sometimes don't print to minibuffer.
2101 If the variable `save-silently' is non-nil, the message is not
2102 displayed on the minibuffer."
2107 "Read file FILENAME into a buffer and return the buffer.
2108 If a buffer exists visiting FILENAME, return that one, but
2109 verify that the file has not changed since visited or saved.
2110 The buffer is not selected, just returned to the caller.
2111 Optional second arg NOWARN non-nil means suppress any warning messages.
2112 Optional third arg RAWFILE non-nil means the file is read literally.
2113 Optional fourth arg WILDCARDS non-nil means do wildcard processing
2114 and visit all the matching files. When wildcards are actually
2115 used and expanded, return a list of buffers that are visiting
2116 the various files."
2123 'find-directory-functions
2126 filename)))
2129 find-file-wildcards
2143 ;; Find any buffer for a file which has same truename.
2145 ;; Let user know if there is a buffer with the same truename.
2149 find-file-suppress-same-file-warnings
2153 ;; Optionally also find that buffer.
2156 ;; Check to see if the file looks uncommonly large.
2164 ;; We are using an existing buffer.
2171 ;; Certain files should be reverted automatically
2172 ;; if they have changed on disk and not in the buffer.
2180 found))
2190 "File %s changed on disk. Discard your edits? "
2195 "File %s changed on disk. Discard your edits in %s? "
2203 ;; Check if a formerly read-only file has become
2204 ;; writable and vice versa, but if the buffer agrees
2205 ;; with the new state of the file, that is ok too.
2215 buffer-file-name
2216 new-status new-status)))
2222 nonexistent
2223 ;; It is confusing to ask whether to visit
2224 ;; non-literally if they have the file in
2225 ;; hexl-mode or image-mode.
2231 "The file %s is already visited normally,
2232 and you have edited the buffer. Now you have asked to visit it literally,
2233 meaning no coding system handling, format conversion, or local variables.
2234 Emacs can only visit a file in one way at a time.
2236 Do you want to save the file, and visit it literally instead? "
2237 "The file %s is already visited literally,
2238 meaning no coding system handling, format conversion, or local variables.
2239 You have edited the buffer. Now you have asked to visit the file normally,
2240 but Emacs can only visit a file in one way at a time.
2247 rawfile truename number))
2251 "\
2252 Do you want to discard your changes, and visit the file literally now? "
2253 "\
2256 rawfile truename number)
2262 "The file %s is already visited normally.
2263 You have asked to visit it literally,
2264 meaning no coding system decoding, format conversion, or local variables.
2265 But Emacs can only visit a file in one way at a time.
2267 Do you want to revisit the file literally now? "
2268 "The file %s is already visited literally,
2269 meaning no coding system decoding, format conversion, or local variables.
2270 You have asked to visit it normally,
2271 but Emacs can only visit a file in one way at a time.
2276 rawfile truename number)
2279 ;; Return the buffer we are using.
2280 buf)
2281 ;; Create a new buffer.
2283 ;; find-file-noselect-1 may use a different buffer.
2285 rawfile truename number))))))
2291 ;; Needed in case we are re-visiting the file with a different
2292 ;; text representation.
2308 filename)))
2309 ;; Unconditionally set error
2319 filename)))
2320 ;; Run find-file-not-found-functions until one returns non-nil.
2322 ;; If they fail too, set error.
2324 ;; Record the file's truename, and maybe use that as visited name.
2332 ;; Set buffer's default directory to that of the file.
2334 ;; Turn off backup files for certain file names. Since
2335 ;; this is a permanent local, the major mode won't eliminate it.
2349 \f
2351 "Like `insert-file-contents', but only reads in the file literally.
2352 See `insert-file-contents' for an explanation of the parameters.
2353 A buffer may be modified in several ways after reading into the buffer,
2354 due to Emacs features such as format decoding, character code
2355 conversion, `find-file-hook', automatic uncompression, etc.
2357 This function ensures that none of these modifications will take place."
2363 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2364 ;; into a file operation instead!
2367 inhibit-file-name-handlers)))
2374 filename)))
2375 ;; Check whether the file is uncommonly large
2387 "Insert contents of file FILENAME into buffer after point with no conversion.
2389 This function is meant for the user to run interactively.
2390 Don't call it from programs! Use `insert-file-contents-literally' instead.
2391 \(Its calling sequence is different; see its documentation)."
2397 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2398 This has the `permanent-local' property, which takes effect if you
2403 "Visit file FILENAME with no conversion of any kind.
2404 Format conversion and character code conversion are both disabled,
2405 and multibyte characters are disabled in the resulting buffer.
2406 The major mode used is Fundamental mode regardless of the file name,
2407 and local variable specifications in the file are ignored.
2408 Automatic uncompression and adding a newline at the end of the
2409 file due to `require-final-newline' is also disabled.
2411 If Emacs already has a buffer which is visiting the file,
2412 this command asks you whether to visit it literally instead.
2414 In non-interactive use, the value is the buffer where the file is
2415 visited literally. If the file was visited in a buffer before
2416 this command was invoked, it will reuse the existing buffer,
2417 regardless of whether it was created literally or not; however,
2418 the contents of that buffer will be the literal text of the file
2419 without any conversions.
2421 In a Lisp program, if you want to be sure of accessing a file's
2422 contents literally, you should create a temporary buffer and then read
2423 the file contents into it using `insert-file-contents-literally'."
2426 "Find file literally: " nil default-directory
2429 \f
2431 _after-find-file-from-revert-buffer
2432 nomodes)
2433 "Called after finding a file and by the default revert function.
2434 Sets buffer mode, parses local variables.
2435 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2436 error in reading the file. WARN non-nil means warn if there
2437 exists an auto-save file more recent than the visited file.
2438 NOAUTO means don't mess with auto-save mode.
2439 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2440 \(see `revert-buffer-in-progress-p' for similar functionality).
2441 Fifth arg NOMODES non-nil means don't alter the file's modes.
2442 Finishes by calling the functions in `find-file-hook'
2443 unless NOMODES is non-nil."
2446 nil
2456 "Symbolic link that points to nonexistent file"
2460 ;; No need to warn if buffer is auto-saved
2461 ;; under the name of the visited file.
2463 auto-save-visited-file-name))
2466 buffer-file-name))
2486 ;; Make people do a little extra work (C-x C-q)
2487 ;; before altering a backup file.
2490 ;; When a file is marked read-only,
2491 ;; make the buffer read-only even if root is looking at it.
2499 ;; If requested, add a newline at the end of the file.
2510 view-read-only
2518 "Choose the major mode for this buffer automatically.
2519 Also sets up any specified local variables of the file.
2520 Uses the visited file name, the -*- line, and the local variables spec.
2522 This function is called automatically from `find-file'. In that case,
2523 we may set up the file-specified mode and local variables,
2524 depending on the value of `enable-local-variables'.
2525 In addition, if `local-enable-local-variables' is nil, we do
2526 not set local variables (though we do notice a mode specified with -*-.)
2528 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2529 or from Lisp without specifying the optional argument FIND-FILE;
2530 in that case, this function acts as if `enable-local-variables' were t."
2537 ;; FIXME this is less efficient than it could be, since both
2538 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2541 ;; `delay-mode-hooks' being non-nil will have prevented the major
2542 ;; mode's call to `run-mode-hooks' from calling
2543 ;; `hack-local-variables'. In that case, call it now.
2547 ;; Turn font lock off and on, to make sure it takes account of
2548 ;; whatever file local variables are relevant to it.
2550 ;; Font-lock-mode (now in font-core.el) can be ON when
2551 ;; font-lock.el still hasn't been loaded.
2558 "Non-nil means to try second pass through `auto-mode-alist'.
2559 This means that if the first case-sensitive search through the alist fails
2560 to find a matching major mode, a second case-insensitive search is made.
2561 On systems with case-insensitive file names, this variable is ignored,
2562 since only a single case-insensitive search through the alist is made."
2568 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2569 ;; c++-mode, java-mode and more) are added through autoload
2570 ;; directives in that file. That way is discouraged since it
2571 ;; spreads out the definition of the initial value.
2617 ;; Less common extensions come here
2618 ;; so more common ones above are found faster.
2626 ;; Besides .gdbinit, gdb documents other names to be usable for init
2627 ;; files, cross-debuggers can use something like
2628 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2629 ;; don't interfere with each other.
2631 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2632 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2633 ;; loaded when GDB reads an objfile called 'emacs'.
2641 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2665 ;; The Fortran standard does not say anything about file extensions.
2666 ;; .f90 was widely used for F90, now we seem to be trapped into
2667 ;; using a different extension for each language revision.
2668 ;; Anyway, the following extensions are supported by gfortran.
2676 ;; The list of archive file extensions should be in sync with
2677 ;; `auto-coding-alist' with `no-conversion' coding system.
2683 ;; Mailer puts message to be edited in
2684 ;; /tmp/Re.... or Message
2687 ;; some news reader is reported to use this
2701 ;; .emacs or .gnus or .viper following a directory delimiter in
2702 ;; Unix or MS-DOS syntax.
2705 ;; _emacs following a directory delimiter in MS-DOS syntax
2709 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2710 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2711 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2714 ;; .xs is also used for ld scripts, but seems to be more commonly
2715 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2717 ;; Explained in binutils ld/genscripts.sh. Eg:
2718 ;; A .x script file is the default script.
2719 ;; A .xr script is for linking without relocation (-r flag). Etc.
2723 ;; Common Lisp ASDF package system.
2730 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2742 ;; Windows candidates may be opened case sensitively on Unix
2750 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2751 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2752 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2753 ;; this has lower priority to avoid matching changelog.sgml etc.
2755 ;; either user's dot-files or under /etc or some such
2757 ;; alas not all ~/.*rc files are like this
2758 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2763 ;; this contains everything twice, with space and with colon :-(
2765 ;; Get rid of any trailing .n.m and try again.
2766 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2767 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2768 ;; Using mode nil rather than `ignore' would let the search continue
2769 ;; through this list (with the shortened name) rather than start over.
2772 ;; This should come after "in" stripping (e.g. config.h.in).
2773 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2775 ;; The following should come after the ChangeLog pattern
2776 ;; for the sake of ChangeLog.1, etc.
2777 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2779 "Alist of filename patterns vs corresponding major mode functions.
2780 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2781 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2782 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2783 mode function to use. FUNCTION will be called, unless it is nil.
2785 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2786 calling FUNCTION (if it's not nil), we delete the suffix that matched
2787 REGEXP and search the list again for another match.
2789 The extensions whose FUNCTION is `archive-mode' should also
2790 appear in `auto-coding-alist' with `no-conversion' coding system.
2792 See also `interpreter-mode-alist', which detects executable script modes
2793 based on the interpreters they specify to run,
2798 "Select Conf mode or XML mode according to start of file."
2808 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2809 ;; and pike-mode) are added through autoload directives in that
2810 ;; file. That way is discouraged since it spreads out the
2811 ;; definition of the initial value.
2840 "Alist mapping interpreter names to major modes.
2841 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2842 Each element looks like (REGEXP . MODE).
2843 If REGEXP matches the entire name (minus any directory part) of
2844 the interpreter specified in the first line of a script, enable
2845 major mode MODE.
2852 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2853 ;; because we are duplicating info from auto-mode-alist.
2854 ;; TODO many elements of this list are also in auto-coding-alist.
2863 "List of regexps matching file names in which to ignore local variables.
2865 Files matching this list are typically binary file formats.
2866 They may happen to contain sequences that look like local variable
2867 specifications, but are not really, or they may be containers for
2868 member files with their own local variable sections, which are
2869 not appropriate for the containing file.
2876 "List of regexps matching suffixes to remove from file names.
2877 The function `inhibit-local-variables-p' uses this: when checking
2878 a file name, it first discards from the end of the name anything that
2881 ;; Can't think of any situation in which you'd want this to be nil...
2886 "Return non-nil if file local variables should be ignored.
2887 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2888 and `inhibit-local-variables-suffixes'. If
2889 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2898 sufs)
2903 temp))
2908 "Regexp matching interpreters, for file mode determination.
2909 This regular expression is matched against the first line of a file
2910 to determine the file's mode in `set-auto-mode'. If it matches, the file
2911 is assumed to be interpreted by the interpreter matched by the second group
2912 of the regular expression. The mode is then determined as the mode
2916 "Alist of buffer beginnings vs. corresponding major mode functions.
2917 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2918 After visiting a file, if REGEXP matches the text at the beginning of the
2919 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2920 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2921 major mode.
2923 If FUNCTION is nil, then it is not called. (That is a way of saying
2931 ;; The < comes before the groups (but the first) to reduce backtracking.
2932 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2933 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2937 comment-re "*"
2940 . mhtml-mode)
2942 ;; These two must come after html, because they are more general:
2947 . sgml-mode)
2950 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2951 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2952 After visiting a file, if REGEXP matches the text at the beginning of the
2953 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2954 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2955 have not specified a mode for this file.
2961 "Upper limit on `magic-mode-alist' regexp matches.
2965 "Select major mode appropriate for current buffer.
2967 To find the right major mode, this function checks for a -*- mode tag
2968 checks for a `mode:' entry in the Local Variables section of the file,
2969 checks if it uses an interpreter listed in `interpreter-mode-alist',
2970 matches the buffer beginning against `magic-mode-alist',
2971 compares the filename against the entries in `auto-mode-alist',
2972 then matches the buffer beginning against `magic-fallback-mode-alist'.
2974 If `enable-local-variables' is nil, or if the file name matches
2975 `inhibit-local-variables-regexps', this function does not check
2976 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2977 is nil, then the only mode: tag that can be relevant is a -*- one.
2979 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2980 set the major mode only if that would change it. In other words
2981 we don't actually set it to the same mode the buffer already has."
2982 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2984 end done mode modes)
2985 ;; Once we drop the deprecated feature where mode: is also allowed to
2986 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2987 ;; remove this section and just let (hack-local-variables t) handle it.
2988 ;; Find a -*- mode tag.
2992 ;; Note by design local-enable-local-variables does not matter here.
2994 try-locals
2997 ;; Find all specifications for the `mode:' variable
2998 ;; and execute them left to right.
3010 modes)))
3011 ;; Simple -*-MODE-*- case.
3014 modes))))
3015 ;; If we found modes to use, invoke them now, outside the save-excursion.
3023 ;; continuing would call minor modes again, toggling them off
3025 ;; hack-local-variables checks local-enable-local-variables etc, but
3026 ;; we might as well be explicit here for the sake of clarity.
3028 enable-local-variables
3029 local-enable-local-variables
3030 try-locals
3037 ;; If we didn't, look for an interpreter specified in the first line.
3038 ;; As a special case, allow for things like "#!/bin/env perl", which
3039 ;; finds the interpreter anywhere in $PATH.
3045 ;; Map interpreter name to a mode, signaling we're done at the
3046 ;; same time.
3053 interpreter-mode-alist)
3055 ;; If we found an interpreter mode to use, invoke it now.
3057 ;; Next try matching the buffer beginning against magic-mode-alist.
3066 nil magic-mode-alist
3075 "Problem in magic-mode-alist with element %s"
3076 re))))))))
3078 ;; Next compare the filename against the entries in auto-mode-alist.
3084 buffer-file-name)))
3085 ;; Remove backup-suffixes from file name.
3087 ;; Remove remote file name identification.
3092 ;; Find first matching alist entry.
3095 ;; Filesystem is case-insensitive.
3099 ;; Filesystem is case-sensitive.
3101 ;; First match case-sensitively.
3105 ;; Fallback to case-insensitive match.
3119 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
3136 "Problem with magic-fallback-mode-alist element: %s"
3137 re))))))))
3142 ;; When `keep-mode-if-same' is set, we are working on behalf of
3143 ;; set-visited-file-name. In that case, if the major mode specified is the
3144 ;; same one we already have, don't actually reset it. We don't want to lose
3145 ;; minor modes such as Font Lock.
3147 "Apply MODE and return it.
3148 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
3149 any aliases and compared to current major mode. If they are the
3150 same, do nothing and return nil."
3156 mode)))
3159 "Regexp of lines to skip when looking for file-local settings.
3160 If the first line matches this regular expression, then the -*-...-*- file-
3164 "Find the -*- spec in the buffer.
3165 Call with point at the place to start searching from.
3166 If one is found, set point to the beginning and return the position
3167 of the end. Otherwise, return nil; may change point.
3168 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3169 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3170 have no effect."
3173 ;; Don't look for -*- if this file name matches any
3174 ;; of the regexps in inhibit-local-variables-regexps.
3177 ;; If the file begins with "#!" (exec
3178 ;; interpreter magic), look for mode frobs
3179 ;; in the first two lines. You cannot
3180 ;; necessarily put them in the first line
3181 ;; of such a file without screwing up the
3182 ;; interpreter invocation. The same holds
3183 ;; for '\" in man pages (preprocessor
3184 ;; magic for the `man' program).
3195 end))))
3196 \f
3197 ;;; Handling file local variables
3201 file-local-variables-alist dir-local-variables-alist)
3206 "Normal hook run after processing a file's local variables specs.
3207 Major modes can use this to examine user-specified local variables
3211 "List variable-value pairs that are considered safe.
3212 Each element is a cons cell (VAR . VAL), where VAR is a variable
3213 symbol and VAL is a value that is considered safe."
3214 :risky t
3219 ;; This should be here at least as long as Emacs supports write-file-hooks.
3224 "Expressions that are considered safe in an `eval:' local variable.
3225 Add expressions to this list if you want Emacs to evaluate them, when
3226 they appear in an `eval' local variable specification, without first
3227 asking you for confirmation."
3228 :risky t
3233 ;; Risky local variables:
3236 buffer-auto-save-file-name
3237 buffer-file-name
3238 buffer-file-truename
3239 buffer-undo-list
3240 debugger
3241 default-text-properties
3242 eval
3243 exec-directory
3244 exec-path
3245 file-name-handler-alist
3246 frame-title-format
3247 global-mode-string
3248 header-line-format
3249 icon-title-format
3250 inhibit-quit
3251 load-path
3252 max-lisp-eval-depth
3253 max-specpdl-size
3254 minor-mode-map-alist
3255 minor-mode-overriding-map-alist
3256 mode-line-format
3257 mode-name
3258 overriding-local-map
3259 overriding-terminal-local-map
3260 process-environment
3261 standard-input
3262 standard-output
3263 unread-command-events))
3265 ;; Safe local variables:
3266 ;;
3267 ;; For variables defined by major modes, the safety declarations can go into
3268 ;; the major mode's file, since that will be loaded before file variables are
3269 ;; processed.
3270 ;;
3271 ;; For variables defined by minor modes, put the safety declarations in the
3272 ;; file defining the minor mode after the defcustom/defvar using an autoload
3273 ;; cookie, e.g.:
3274 ;;
3275 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3276 ;;
3277 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3278 ;; minor mode file may not be loaded yet.
3279 ;;
3280 ;; For variables defined in the C source code the declaration should go here:
3302 "Alist of file-local variable settings in the current buffer.
3303 Each element in this list has the form (VAR . VALUE), where VAR
3304 is a file-local variable (a symbol) and VALUE is the value
3305 specified. The actual value in the buffer may differ from VALUE,
3311 "Alist of directory-local variable settings in the current buffer.
3312 Each element in this list has the form (VAR . VALUE), where VAR
3313 is a directory-local variable (a symbol) and VALUE is the value
3314 specified in .dir-locals.el. The actual value in the buffer
3315 may differ from VALUE, if it is changed by the major or minor modes,
3320 "Normal hook run before setting file-local variables.
3321 It is called after checking for unsafe/risky variables and
3322 setting `file-local-variables-alist', and before applying the
3323 variables stored in `file-local-variables-alist'. A hook
3324 function is allowed to change the contents of this alist.
3326 This hook is called only if there is at least one file-local
3330 "Get confirmation before setting up local variable values.
3331 ALL-VARS is the list of all variables to be set up.
3332 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3333 RISKY-VARS is the list of those that are marked as risky.
3334 If these settings come from directory-local variables, then
3335 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3342 unsafe-vars))
3344 ;; Set up the contents of the *Local Variables* buffer.
3352 ", and variables that are risky (**)."
3360 y -- to apply the local variables list.
3364 ! -- to apply the local variables list, and permanently mark these
3376 ;; Make strings with embedded whitespace easier to read.
3384 ;; Display the buffer and read a choice.
3392 ""
3395 char)
3414 "Return local variables specified in the -*- line.
3415 Usually returns an alist of elements (VAR . VAL), where VAR is a
3416 variable and VAL is the specified value. Ignores any
3417 specification for `coding:', and sometimes for `mode' (which
3418 should have already been handled by `set-auto-coding' and
3419 `set-auto-mode', respectively). Return nil if the -*- line is
3420 malformed.
3422 If HANDLE-MODE is nil, we return the alist of all the local
3423 variables in the line except `coding' as described above. If it
3424 is neither nil nor t, we do the same, except that any settings of
3425 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3426 all settings in the line except for `mode', which \(if present) we
3427 return as the symbol specifying the mode."
3432 result)
3434 nil)
3436 ;; Simple form: "-*- MODENAME -*-".
3440 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3441 ;; (last ";" is optional).
3442 ;; If HANDLE-MODE is t, just check for `mode'.
3443 ;; Otherwise, parse the -*- line into the RESULT alist.
3451 ;; There used to be a downcase here,
3452 ;; but the manual didn't say so,
3453 ;; and people want to set var names that aren't all lc.
3459 ;; It is traditional to ignore
3460 ;; case when checking for `mode' in set-auto-mode,
3461 ;; so we must do that here as well.
3462 ;; That is inconsistent, but we're stuck with it.
3463 ;; The same can be said for `coding' in set-auto-coding.
3477 ;; Downcase "Mode:".
3480 val)
3481 result)
3484 result))))))
3487 "Filter local variable settings, querying the user if necessary.
3488 VARIABLES is the alist of variable-value settings. This alist is
3489 filtered based on the values of `ignored-local-variables',
3490 `enable-local-eval', `enable-local-variables', and (if necessary)
3491 user interaction. The results are added to
3492 `file-local-variables-alist', without applying them.
3493 If these settings come from directory-local variables, then
3494 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3495 ;; Find those variables that we may want to save to
3496 ;; `safe-local-variable-values'.
3502 ;; Ignore any variable in `ignored-local-variables'.
3503 nil)
3504 ;; Obey `enable-local-eval'.
3508 ;; In case previously marked safe (bug#5636).
3510 ;; If not safe and e-l-v = :safe, ignore totally.
3514 safe
3516 ;; Ignore duplicates (except `mode') in the present list.
3518 ;; Accept known-safe variables.
3522 ;; The variable is either risky or unsafe:
3529 ;; Query, unless all vars are safe or user wants no querying.
3535 risky-vars dir-name))
3545 ;; TODO? Warn once per file rather than once per session?
3549 "Parse and put into effect this buffer's local variables spec.
3550 Uses `hack-local-variables-apply' to apply the variables.
3552 If HANDLE-MODE is nil, we apply all the specified local
3553 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3554 except that any settings of `mode' are ignored.
3557 is specified, and return the corresponding mode symbol, or nil.
3558 In this case, we try to ignore minor-modes, and only return a
3559 major-mode.
3561 If `enable-local-variables' or `local-enable-local-variables' is nil,
3562 this function does nothing. If `inhibit-local-variables-regexps'
3563 applies to the file in question, the file is not scanned for
3564 local variables, but directory-local variables may still be applied."
3565 ;; We don't let inhibit-local-variables-p influence the value of
3566 ;; enable-local-variables, because then it would affect dir-local
3567 ;; variables. We don't want to search eg tar files for file local
3568 ;; variable sections, but there is no reason dir-locals cannot apply
3569 ;; to them. The real meaning of inhibit-local-variables-p is "do
3570 ;; not scan this file for local variables".
3573 result)
3577 ;; Note this is a no-op if enable-local-variables is nil.
3579 ;; This entire function is basically a no-op if enable-local-variables
3580 ;; is nil. All it does is set file-local-variables-alist to nil.
3582 ;; This part used to ignore enable-local-variables when handle-mode
3583 ;; was t. That was inappropriate, eg consider the
3584 ;; (artificial) example of:
3585 ;; (setq local-enable-local-variables nil)
3586 ;; Open a file foo.txt that contains "mode: sh".
3587 ;; It correctly opens in text-mode.
3588 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3590 ;; If HANDLE-MODE is t, and the prop line specifies a
3591 ;; mode, then we're done, and have no need to scan further.
3593 handle-mode))
3595 ;; Look for "Local variables:" line in last page.
3603 ;; suffix is what comes after "local variables:" in its line.
3604 ;; prefix is what comes before "local variables:" in its line.
3617 endpos
3623 nil t))
3624 ;; This used to be an error, but really all it means is
3625 ;; that this may simply not be a local-variables section,
3626 ;; so just ignore it.
3636 ;; Discard the prefix.
3641 ;; Discard the suffix.
3650 ;; Find the variable name;
3658 val val2)
3661 ;; Read the variable value.
3668 ;; Specifying minor-modes via mode: is
3669 ;; deprecated, but try to reject them anyway.
3679 'files
3681 "%s: `lexical-binding' at end of file unreliable"
3683 ;; We are called from
3684 ;; 'with-temp-buffer', so we need
3685 ;; to use 'thisbuf's name in the
3686 ;; warning message.
3692 'eval
3694 val)
3695 result))))))
3697 ;; Now we've read all the local variables.
3698 ;; If HANDLE-MODE is t, return whether the mode was specified.
3700 ;; Otherwise, set the variables.
3705 "Apply the elements of `file-local-variables-alist'.
3706 If there are any elements, runs `before-hack-local-variables-hook',
3707 then calls `hack-one-local-variable' to apply the alist elements one by one.
3708 Finishes by running `hack-local-variables-hook', regardless of whether
3709 the alist is empty or not.
3711 Note that this function ignores a `mode' entry if it specifies the same
3712 major mode as the buffer already has."
3714 ;; Any 'evals must run in the Right sequence.
3723 "Non-nil if SYM is safe as a file-local variable with value VAL.
3724 It is safe if any of these conditions are met:
3726 * There is a matching entry (SYM . VAL) in the
3727 `safe-local-variable-values' user option.
3729 * The `safe-local-variable' property of SYM is a function that
3730 evaluates to a non-nil value with VAL as an argument."
3734 ;; If the function signals an error, that means it
3735 ;; can't assure us that the value is safe.
3739 "Non-nil if SYM could be dangerous as a file-local variable.
3740 It is dangerous if either of these conditions are met:
3742 * Its `risky-local-variable' property is non-nil.
3748 ;; If this is an alias, check the base name.
3768 "Return t if it is safe to eval EXP when it is found in a file."
3770 ;; Detect certain `put' expressions.
3777 lisp-indent-function
3778 scheme-indent-function))
3779 ;; Only allow safe values (not functions).
3784 ;; Only allow indirect form specs.
3785 ;; During bootstrapping, edebug-basic-spec might not be
3786 ;; defined yet.
3790 ;; Allow expressions that the user requested.
3792 ;; Certain functions can be allowed with safe arguments
3793 ;; or can specify verification functions to try.
3795 ;; Allow (minor)-modes calls with no arguments.
3796 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3805 ok))
3813 ok))))))))
3827 "Set local variable VAR with value VAL.
3828 If VAR is `mode', call `VAL-mode' as a function unless it's
3829 already the major mode."
3831 (`mode
3837 (`eval
3843 ;; Make sure the string has no text properties.
3844 ;; Some text properties can get evaluated in various ways,
3845 ;; so it is risky to put them on with a local variable list.
3849 \f
3850 ;;; Handling directory-local variables, aka project settings.
3856 "List of cached directory roots for directory-local variable classes.
3857 Each element in this list has the form (DIR CLASS MTIME).
3858 DIR is the name of the directory.
3859 CLASS is the name of a variable class (a symbol).
3860 MTIME is the recorded modification time of the directory-local
3861 variables file associated with this entry. This time is a Lisp
3862 timestamp (the same format as `current-time'), and is
3863 used to test whether the cache entry is still valid.
3864 Alternatively, MTIME can be nil, which means the entry is always
3868 "Return the variable list for CLASS."
3872 "Collect directory-local variables from MODE-VARIABLES.
3873 VARIABLES is the initial list of variables.
3874 Returns the new list."
3879 ;; If variables are specified more than once, only use the last. (Why?)
3880 ;; The pseudo-variables mode and eval are different (bug#3430).
3883 ;; Need a new cons in case we setcdr later.
3887 "Collect entries from CLASS-VARIABLES into VARIABLES.
3888 ROOT is the root directory of the project.
3889 Return the new variables list."
3891 ;; Handle non-file buffers, too.
3895 ;; FIXME: Why not use file-relative-name?
3902 ;; Don't include this in the previous condition, because we
3903 ;; want to filter all strings before the next condition.
3917 ;; TODO someone might want to extend this to allow
3918 ;; integer values for subdir, where N means
3919 ;; variables apply to this directory and N levels
3920 ;; below it (0 == nil).
3923 alist variables))))))))
3925 ;; The file's content might be invalid (e.g. have a merge conflict), but
3926 ;; that shouldn't prevent the user from opening the file.
3928 nil))))
3931 "Declare that the DIRECTORY root is an instance of CLASS.
3932 DIRECTORY is the name of a directory, a string.
3933 CLASS is the name of a project class, a symbol.
3934 MTIME is either the modification time of the directory-local
3935 variables file that defined this class, or nil.
3937 When a file beneath DIRECTORY is visited, the mode-specific
3938 variables from CLASS are applied to the buffer. The variables
3939 for a class are defined using `dir-locals-set-class-variables'."
3946 "Map the type CLASS to a list of variable settings.
3947 CLASS is the project class, a symbol. VARIABLES is a list
3948 that declares directory-local variables for the class.
3949 An element in VARIABLES is either of the form:
3950 (MAJOR-MODE . ALIST)
3951 or
3952 (DIRECTORY . LIST)
3954 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3955 whose elements are of the form (VARIABLE . VALUE).
3957 In the second form, DIRECTORY is a directory name (a string), and
3958 LIST is a list of the form accepted by the function.
3960 When a file is visited, the file's class is found. A directory
3961 may be assigned a class using `dir-locals-set-directory-class'.
3962 Then variables are set in the file's buffer according to the
3963 VARIABLES list of the class. The list is processed in order.
3965 * If the element is of the form (MAJOR-MODE . ALIST), and the
3966 buffer's major mode is derived from MAJOR-MODE (as determined
3967 by `derived-mode-p'), then all the variables in ALIST are
3968 applied. A MAJOR-MODE of nil may be used to match any buffer.
3969 `make-local-variable' is called for each variable before it is
3970 set.
3972 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3973 is an initial substring of the file's directory, then LIST is
3974 applied by recursively following these rules."
3978 "File that contains directory-local variables.
3979 It has to be constant to enforce uniform values across different
3980 environments and users.
3982 A second dir-locals file can be used by a user to specify their
3983 personal dir-local variables even if the current directory
3984 already has a `dir-locals-file' that is shared with other
3985 users (such as in a git repository). The name of this second
3987 `dir-locals-file'. With the default value of `dir-locals-file',
3994 "Return a list of all readable dir-locals files in DIRECTORY.
3995 The returned list is sorted by increasing priority. That is,
3996 values specified in the last file should take precedence over
3997 those in the first."
4001 dir-locals-file)
4002 directory))
4006 ;; The order here is important.
4013 out)))
4016 "Find the directory-local variables for FILE.
4017 This searches upward in the directory tree from FILE.
4018 It stops at the first directory that has been registered in
4019 `dir-locals-directory-cache' or contains a `dir-locals-file'.
4020 If it finds an entry in the cache, it checks that it is valid.
4021 A cache entry with no modification time element (normally, one that
4022 has been assigned directly using `dir-locals-set-directory-class', not
4023 set from a file) is always valid.
4024 A cache entry based on a `dir-locals-file' is valid if the modification
4025 time stored in the cache matches the current file modification time.
4026 If not, the cache entry is cleared so that the file will be re-read.
4028 This function returns either:
4029 - nil (no directory local variables found),
4030 - the matching entry from `dir-locals-directory-cache' (a list),
4031 - or the full path to the directory (a string) containing at
4032 least one `dir-locals-file' in the case of no valid cache
4033 entry."
4037 dir-elt)
4038 ;; `locate-dominating-file' may have abbreviated the name.
4041 ;; Find the best cached value in `dir-locals-directory-cache'.
4052 ;; Found a potential cache entry. Check validity.
4053 ;; A cache entry with no MTIME is assumed to always be valid
4054 ;; (ie, set directly, not from a dir-locals file).
4055 ;; Note, we don't bother to check that there is a matching class
4056 ;; element in dir-locals-class-alist, since that's done by
4057 ;; dir-locals-set-directory-class.
4060 ;; The entry MTIME should match the most recent
4061 ;; MTIME among matching files.
4071 ;; This cache entry is OK.
4072 dir-elt
4073 ;; This cache entry is invalid; clear it.
4076 ;; Return the first existing dir-locals file. Might be the same
4077 ;; as dir-elt's, might not (eg latter might have been deleted).
4078 locals-dir)
4079 ;; No cache entry.
4080 locals-dir)))
4086 "Load all variables files in DIR and register a new class and instance.
4087 DIR is the absolute name of a directory which must contain at
4088 least one dir-local file (which is a file holding variables to
4089 apply).
4090 Return the new class name, which is a symbol named DIR."
4094 ;; If there was a problem, use the values we could get but
4095 ;; don't let the cache prevent future reads.
4111 ;; Try and avoid loading `map' since that also loads cl-lib
4112 ;; which then might hamper bytecomp warnings (bug#30635).
4117 variables
4118 newvars))))))
4122 class-name))
4128 "Non-nil means dir-local variables will be applied to remote files."
4136 "Read per-directory local variables for the current buffer.
4137 Store the directory-local variables in `dir-local-variables-alist'
4138 and `file-local-variables-alist', without applying them.
4140 This does nothing if either `enable-local-variables' or
4141 `enable-dir-local-variables' are nil."
4143 enable-dir-local-variables
4146 default-directory)))))
4147 ;; Find the variables file.
4177 "Apply directory-local variables to a non-file buffer.
4178 For non-file buffers, such as Dired buffers, directory-local
4179 variables are looked for in `default-directory' and its parent
4180 directories."
4184 \f
4187 However, the mode will not be changed if
4188 \(1) a local variables list or the `-*-' line specifies a major mode, or
4190 not suitable for ordinary files, or
4191 \(3) the new file name does not particularly specify any mode."
4196 "Change name of file visited in current buffer to FILENAME.
4197 This also renames the buffer to correspond to the new file.
4198 The next time the buffer is saved it will go in the newly specified file.
4199 FILENAME nil or an empty string means mark buffer as not visiting any file.
4200 Remember to delete the initial contents of the minibuffer
4201 if you wish to pass an empty string as the argument.
4203 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4204 confirmation in the case where another buffer is already visiting FILENAME.
4206 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4207 the old visited file has been renamed to the new name FILENAME."
4215 nil
4230 filename)))
4237 buffer-file-name filename)
4241 ;; If new-name == old-name, renaming would add a spurious <2>
4242 ;; and it's considered as a feature in rename-buffer.
4248 ;; Abbreviate the file names of the buffer.
4257 nil))
4258 ;; write-file-functions is normally used for things like ftp-find-file
4259 ;; that visit things that are not local files as if they were files.
4260 ;; Changing to visit an ordinary local file instead should flush the hook.
4265 ;; If buffer was read-only because of version control,
4266 ;; that reason is gone now, so make it writable.
4270 ;; Turn off backup files for certain file names.
4271 ;; Since this is a permanent local, the major mode won't eliminate it.
4273 backup-enable-predicate
4282 ;; If auto-save was not already on, turn it on if appropriate.
4285 ;; If auto save is on, start using a new name. We
4286 ;; deliberately don't rename or delete the old auto save
4287 ;; for the old visited file name. This is because
4288 ;; perhaps the user wants to save the new state and then
4289 ;; compare with the previous state from the auto save
4290 ;; file.
4292 ;; Rename the old auto save file if any.
4299 ;; Update the major mode, if the file name determines it.
4301 ;; Don't change the mode if it is special.
4304 ;; Don't change the mode if the local variable list specifies it.
4305 ;; The file name can influence whether the local variables apply.
4307 ;; h-l-v also checks it, but might as well be explicit.
4310 ;; TODO consider making normal-mode handle this case.
4318 "Write current buffer into file FILENAME.
4319 This makes the buffer visit that file, and marks it as not modified.
4321 If you specify just a directory name as FILENAME, that means to use
4322 the default file name but in that directory. You can also yank
4323 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4325 If the buffer is not already visiting a file, the default file name
4326 for the output file is the buffer name.
4328 If optional second arg CONFIRM is non-nil, this function
4329 asks for confirmation before overwriting an existing file.
4330 Interactively, confirmation is required unless you supply a prefix argument."
4331 ;; (interactive "FWrite file: ")
4335 nil nil nil nil)
4339 default-directory)
4340 nil nil))
4344 ;; If arg is a directory name,
4345 ;; use the default file name, but in that directory.
4352 ;; NS does its own confirm dialog.
4355 use-dialog-box))
4361 ;; Make buffer writable if file is writable.
4366 ;; It's likely that the VC status at the new location is different from
4367 ;; the one at the old location.
4369 \f
4371 "Return an alist of extended attributes of file FILENAME.
4373 Extended attributes are platform-specific metadata about the file,
4374 such as SELinux context, list of ACL entries, etc."
4379 "Set extended attributes of file FILENAME to ATTRIBUTES.
4381 ATTRIBUTES must be an alist of file attributes as returned by
4382 `file-extended-attributes'.
4383 Value is t if the function succeeds in setting the attributes."
4394 result))
4395 \f
4397 "Make a backup of the disk file visited by the current buffer, if appropriate.
4398 This is normally done before saving the buffer the first time.
4400 A backup may be done by renaming or by copying; see documentation of
4401 variable `make-backup-files'. If it's done by renaming, then the file is
4402 no longer accessible under its old name.
4404 The value is non-nil after a backup was made by renaming.
4405 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4406 MODES is the result of `file-modes' on the original
4407 file; this means that the caller, after saving the buffer, should change
4408 the modes of the new file to agree with the old modes.
4409 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4410 on the original file; this means that the caller, after saving
4411 the buffer, should change the extended attributes of the new file
4412 to agree with the old attributes.
4413 BACKUPNAME is the backup file name, which is the old file renamed."
4417 ;; If specified name is a symbolic link, chase it to the target.
4418 ;; This makes backups in the directory where the real file is.
4425 ;; If have old versions to maybe delete,
4426 ;; ask the user to confirm now, before doing anything.
4427 ;; But don't actually delete til later.
4433 real-file-name)))
4434 targets))
4439 backup-by-copying-when-privileged-mismatch)
4442 ;; Don't rename a suid or sgid file.
4451 real-file-name
4454 copy-when-priv-mismatch))))
4456 t)))))
4457 setmodes)
4460 ;; Actually make the backup file.
4463 modes extended-attributes)
4464 ;; rename-file should delete old backup.
4467 backupname)))
4469 ;; Now delete the old versions, if desired.
4473 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4477 backupname)
4480 modes extended-attributes)
4482 setmodes)))))))
4485 ;; Create temp files with strict access rights. It's easy to
4486 ;; loosen them later, whereas it's impossible to close the
4487 ;; time-window of loose permissions otherwise.
4490 ;; Try to overwrite old backup first.
4498 nil)
4500 ;; The file was somehow created by someone else between
4501 ;; `delete-file' and `copy-file', so let's try again.
4502 ;; rms says "I think there is also a possible race
4503 ;; condition for making backup files" (emacs-devel 20070821).
4504 nil)))
4505 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4514 ;; The last ~[[:digit]]+ matches relative versions in git,
4515 ;; e.g. `foo.js.~HEAD~1~'.
4516 "Regular expression matching the backup/version part of a file name.
4520 "Return file NAME sans backup versions or strings.
4521 This is a separate procedure so your site-init or startup file can
4522 redefine it.
4523 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4524 we do not remove backup version numbers, only true file version numbers.
4525 See also `file-name-version-regexp'."
4532 name))))))
4535 "Return t if deleting FILE and rewriting it would preserve the owner.
4536 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4537 the group would be preserved too."
4542 ;; Return t if the file doesn't exist, since it's true that no
4543 ;; information would be lost by an (attempted) delete and create.
4546 ;; Files created on Windows by Administrator (RID=500)
4547 ;; have the Administrators group (RID=544) recorded as
4548 ;; their owner. Rewriting them will still preserve the
4549 ;; owner.
4554 ;; On BSD-derived systems files always inherit the parent
4555 ;; directory's group, so skip the group-gid test.
4561 ;; On some systems, a file created in a setuid directory
4562 ;; inherits that directory's owner.
4567 "^...[^sS]"
4569 ;; On many systems, a file created in a setgid directory
4570 ;; inherits that directory's group. On some systems
4571 ;; this happens even if the setgid bit is not set.
4578 The extension, in a file name, is the part that begins with the last `.',
4579 except that a leading `.' of the file name, if there is one, doesn't count."
4582 directory)
4586 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4587 ;; we don't want to expand it.
4590 filename))))
4594 The extension, in a file name, is the part that begins with the last `.',
4595 excluding version numbers and backup suffixes, except that a leading `.'
4596 of the file name, if there is one, doesn't count.
4597 Return nil for extensionless file names such as `foo'.
4598 Return the empty string for file names such as `foo.'.
4600 By default, the returned value excludes the period that starts the
4601 extension, but if the optional argument PERIOD is non-nil, the period
4602 is included in the value, and in that case, if FILENAME has no
4613 "Return the base name of the FILENAME: no directory, no extension."
4619 #'make-backup-file-name--default-function
4620 "A function that `make-backup-file-name' uses to create backup file names.
4621 The function receives a single argument, the original file name.
4623 If you change this, you may need to change `backup-file-name-p' and
4624 `file-name-sans-versions' too.
4626 You could make this buffer-local to do something special for specific files.
4628 For historical reasons, a value of nil means to use the default function.
4629 This should not be relied upon.
4631 See also `backup-directory-alist'."
4638 "Alist of filename patterns and backup directory names.
4639 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4640 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4641 relative or absolute. If it is absolute, so that all matching files
4642 are backed up into the same directory, the file names in this
4643 directory will be the full name of the file backed up with all
4644 directory separators changed to `!' to prevent clashes. This will not
4645 work correctly if your filesystem truncates the resulting name.
4647 For the common case of all backups going into one directory, the alist
4649 directory name.
4651 If this variable is nil, or it fails to match a filename, the backup
4652 is made in the original file's directory.
4654 On MS-DOS filesystems without long names this variable is always
4655 ignored."
4661 "Default `backup-enable-predicate' function.
4662 Checks for files in `temporary-file-directory',
4665 caseless)
4666 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4667 ;; their long file-name equivalents, so compare-strings does TRT.
4671 caseless t))
4674 ;; Directory is under temporary-file-directory.
4679 ;; Directory is under /tmp.
4684 0 nil
4686 ;; Directory is under small-temporary-file-directory.
4691 "Create the non-numeric backup file name for FILE.
4692 This calls the function that `make-backup-file-name-function' specifies,
4693 with a single argument FILE."
4696 file))
4699 "Default function for `make-backup-file-name'.
4700 Normally this just returns FILE's name with `~' appended.
4701 It searches for a match for FILE in `backup-directory-alist'.
4702 If the directory for the backup doesn't exist, it is created."
4714 "Subroutine of `make-backup-file-name--default-function'.
4715 The function `find-backup-file-name' also uses this."
4717 elt backup-directory abs-backup-directory)
4722 alist nil)))
4723 ;; If backup-directory is relative, it should be relative to the
4724 ;; file's directory. By expanding explicitly here, we avoid
4725 ;; depending on default-directory.
4734 abs-backup-directory nil))))
4736 file
4740 ;; Normalize DOSish file names: downcase the drive
4741 ;; letter, if any, and replace the leading "x:" with
4742 ;; "/drive_x".
4747 ;; Remove the leading slash, if any, to prevent
4748 ;; convert-standard-filename from converting that to a
4749 ;; backslash.
4752 ;; Replace any invalid file-name characters, then
4753 ;; prepend the leading slash back.
4756 ;; Replace any invalid file-name characters.
4760 "drive_"
4763 ""
4766 ;; Make the name unique by substituting directory
4767 ;; separators. It may not really be worth bothering about
4768 ;; doubling `!'s in the original name...
4773 backup-directory))
4778 "Return non-nil if FILE is a backup file name (numeric or not).
4779 This is a separate function so you can redefine it for customization.
4780 You may need to redefine `file-name-sans-versions' as well."
4785 ;; This is used in various files.
4786 ;; The usage of backup-extract-version-start is not very clean,
4787 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4789 "Given the name of a numeric backup file, FN, return the backup number.
4790 Uses the free variable `backup-extract-version-start', whose value should be
4791 the index in the name where the version number begins."
4798 "Find a file name for a backup file FN, and suggestions for deletions.
4799 Value is a list whose car is the name for the backup file
4800 and whose cdr is a list of old versions to consider deleting now.
4801 If the value is nil, don't make a backup.
4802 Uses `backup-directory-alist' in the same way as
4803 `make-backup-file-name--default-function' does."
4805 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4809 ;; We don't support numbered backups on plain MS-DOS
4810 ;; when long file names are unavailable.
4820 possibilities deserve-versions-p versions)
4823 base-versions
4826 possibilities)
4827 #'<)
4832 kept-old-versions
4833 kept-new-versions
4840 ;; Delete nothing if there is overflow
4841 ;; in the number of versions to keep.
4847 v))))))))))
4850 "Return number of names file FILENAME has."
4854 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4855 This function returns a relative file name which is equivalent to FILENAME
4856 when used with that default directory as the default.
4857 If FILENAME is a relative file name, it will be interpreted as existing in
4858 `default-directory'.
4859 If FILENAME and DIRECTORY lie on different machines or on different drives
4860 on a DOS/Windows machine, it returns FILENAME in expanded form."
4864 default-directory))))
4869 read-file-name-completion-ignore-case)))
4872 ;; Test for different filesystems on DOS/Windows
4874 ;; Should `cygwin' really be included here? --stef
4877 ;; Test for different drive letters
4879 ;; Test for UNCs on different servers
4884 ;; Windows file names cannot have ? in
4885 ;; them, so use that to detect when
4886 ;; neither FILENAME nor DIRECTORY is a
4887 ;; UNC.
4889 0 nil
4895 ;; Test for different remote file system identification
4897 filename
4905 ".."
4907 ;; Now ancestor is empty, or .., or ../.., etc.
4909 ;; We matched within FILENAME's directory part.
4910 ;; Add the rest of FILENAME onto ANCESTOR.
4913 ;; But don't bother with ANCESTOR if it would give us `./'.
4914 rest
4916 ;; We matched FILENAME's directory equivalent.
4917 ancestor))))))
4918 \f
4920 "Save current buffer in visited file if modified.
4921 Variations are described below.
4923 By default, makes the previous version into a backup file
4924 if previously requested or if this is the first save.
4926 to become a backup when the next save is done.
4928 makes the previous version into a backup file.
4930 to become a backup when the next save is done,
4931 and makes the previous version into a backup file.
4933 With a numeric prefix argument of 0, never make the previous version
4934 into a backup file.
4936 Note that the various variables that control backups, such
4937 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4938 and `backup-inhibited', to name just the more popular ones, still
4939 control whether a backup will actually be produced, even when you
4942 If a file's name is FOO, the names of its numbered backup versions are
4943 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4944 Numeric backups (rather than FOO~) will be made if value of
4945 `version-control' is not the atom `never' and either there are already
4946 numeric versions of the file being backed up, or `version-control' is
4947 non-nil.
4948 We don't want excessive versions piling up, so there are variables
4949 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4950 and `kept-new-versions', which tells how many newest versions to keep.
4951 Defaults are 2 old versions and 2 new.
4952 `dired-kept-versions' controls dired's clean-directory (.) command.
4953 If `delete-old-versions' is nil, system will query user
4954 before trimming versions. Otherwise it does it silently.
4956 If `vc-make-backup-files' is nil, which is the default,
4957 no backup files are made for files managed by version control.
4958 (This is because the version control system itself records previous versions.)
4960 See the subroutine `basic-save-buffer' for more information."
4966 ;; We used to display the message below only for files > 50KB, but
4967 ;; then Rmail-mbox never displays it due to buffer swapping. If
4968 ;; the test is ever re-introduced, be sure to handle saving of
4969 ;; Rmail files.
4979 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4980 Normally delete only if the file was written by this Emacs since
4981 the last real save, but optional arg FORCE non-nil means delete anyway."
4995 "Normal hook that is run before a buffer is saved to its file.
4996 Only used by `save-buffer'."
5002 "Normal hook that is run after a buffer is saved to its file.
5003 Only used by `save-buffer'."
5009 "If non-nil, use this coding system for saving the buffer.
5010 More precisely, use this coding system in place of the
5011 value of `buffer-file-coding-system', when saving the buffer.
5012 Calling `write-region' for any purpose other than saving the buffer
5013 will still use `buffer-file-coding-system'; this variable has no effect
5020 "Save the current buffer in its visited file, if it has been modified.
5022 The hooks `write-contents-functions', `local-write-file-hooks'
5023 and `write-file-functions' get a chance to do the job of saving;
5024 if they do not, then the buffer is saved in the visited file in
5025 the usual way.
5027 Before and after saving the buffer, this function runs
5028 `before-save-hook' and `after-save-hook', respectively."
5031 ;; In an indirect buffer, save its base buffer instead.
5035 ;; Handle the case when no modification has been made but
5036 ;; the file disappeared since visited.
5040 setmodes)
5046 "%s has changed since visited or saved. Save anyway? "
5067 ;; Don't let errors prevent saving the buffer.
5069 ;; Give `write-contents-functions' a chance to
5070 ;; short-circuit the whole process.
5072 ;; If buffer has no file name, ask user for one.
5080 ;; Signal an error if the user specified the name of an
5081 ;; existing directory.
5084 "File `%s' exists; overwrite? "
5085 filename))
5088 ;; Support VC version backups.
5092 ;; If a hook returned t, file is already "written".
5093 ;; Otherwise, write it the usual way now.
5103 ;; Now we have saved the current buffer. Let's make sure
5104 ;; that buffer-file-coding-system is fixed to what
5105 ;; actually used for saving by binding it locally.
5121 ;; Support VC `implicit' locking.
5123 ;; If the auto-save file was recent before this command,
5124 ;; delete it now.
5131 ;; This does the "real job" of writing a buffer into its visited file
5132 ;; and making a backup file. This is what is normally done
5133 ;; but inhibited if one of write-file-functions returns non-nil.
5134 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5135 ;; backup-buffer.
5145 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5146 ;; backup-buffer.
5159 "File %s is write-protected; try to save anyway? "
5161 buffer-file-name)))
5175 dir))))
5176 ;; Write temp name, then rename it.
5177 ;; This requires write access to the containing dir,
5178 ;; which is why we don't try it if we don't have that access.
5180 tempname
5182 ;; Create temp files with strict access rights. It's easy to
5183 ;; loosen them later, whereas it's impossible to close the
5184 ;; time-window of loose permissions otherwise.
5188 ;; Call write-region in the appropriate way
5189 ;; for saving the buffer.
5193 ;; Pass in nil&nil rather than point-min&max
5194 ;; cause we're saving the whole buffer.
5195 ;; write-region-annotate-functions may use it.
5197 buffer-file-truename)
5199 ;; If we failed, restore the buffer's modtime.
5202 ;; Since we have created an entirely new file,
5203 ;; make sure it gets the right permission bits set.
5208 buffer-file-name)))
5209 ;; We succeeded in writing the temp file,
5210 ;; so rename it.
5212 ;; If file not writable, see if we can make it writable
5213 ;; temporarily while we write it.
5214 ;; But no need to do so if we have just backed it up
5215 ;; (setmodes is set) because that says we're superseding.
5217 ;; Change the mode back, after writing.
5220 buffer-file-name))
5221 ;; If set-file-extended-attributes fails, fall back on
5222 ;; set-file-modes.
5232 ;; Pass in nil&nil rather than point-min&max to indicate
5233 ;; we're saving the buffer rather than just a region.
5234 ;; write-region-annotate-functions may make use of it.
5236 buffer-file-name nil t buffer-file-truename)
5239 ;; If we get an error writing the new file, and we made
5240 ;; the backup by renaming, undo the backing-up.
5245 setmodes))
5251 `((?\C-r
5258 ;; Return nil to ask about BUF again.
5259 nil)
5272 ;; Return nil to ask about BUF again.
5273 nil)
5283 "Default predicate for `save-some-buffers'.
5284 This allows you to stop `save-some-buffers' from asking
5285 about certain files that you'd usually rather not save."
5287 ;; FIXME nil should not be a valid option, let alone the default,
5288 ;; eg so that add-function can be used.
5293 "Save some modified file-visiting buffers. Asks user about each one.
5294 You can answer `y' or SPC to save, `n' or DEL not to save, `C-r'
5295 to look at the buffer in question with `view-buffer' before
5296 deciding, `d' to view the differences using
5297 `diff-buffer-with-file', `!' to save the buffer and all remaining
5298 buffers without any further querying, `.' to save only the
5299 current buffer and skip the remaining ones and `q' or RET to exit
5300 the function without saving any more buffers. `C-h' displays a
5301 help message describing these options.
5303 This command first saves any buffers where `buffer-save-without-query' is
5304 non-nil, without asking.
5306 Optional argument ARG (interactively, prefix argument) non-nil means save
5307 all with no questions.
5308 Optional second argument PRED determines which buffers are considered:
5309 If PRED is nil, all the file-visiting buffers are considered.
5310 If PRED is t, then certain non-file buffers will also be considered.
5311 If PRED is a zero-argument function, it indicates for each buffer whether
5312 to consider it or not when called with that buffer current.
5313 PRED defaults to the value of `save-some-buffers-default-predicate'.
5315 See `save-some-buffers-action-alist' if you want to
5316 change the additional actions you can take on files."
5322 files-done abbrevs-done)
5324 ;; First save any buffers that we're supposed to save unconditionally.
5325 ;; That way the following code won't ask about them.
5330 ;; Ask about those buffers that merit it,
5331 ;; and record the number thus saved.
5335 ;; Note that killing some buffers may kill others via
5336 ;; hooks (e.g. Rmail and its viewing buffer).
5348 t
5360 save-some-buffers-action-alist))
5361 ;; Maybe to save abbrevs, and record whether
5362 ;; we either saved them or asked to.
5369 ;; Don't keep bothering user if he says no.
5383 \f
5385 "Clear out records of last mod time of visited file.
5386 Next attempt to save will not complain of a discrepancy."
5390 "Mark current buffer as unmodified, not needing to be saved.
5393 It is not a good idea to use this function in Lisp programs, because it
5394 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5402 "Change whether this buffer is read-only."
5410 "Insert contents of file FILENAME into buffer after point.
5411 Set mark after the inserted text.
5413 This function is meant for the user to run interactively.
5414 Don't call it from programs! Use `insert-file-contents' instead.
5415 \(Its calling sequence is different; see its documentation)."
5421 "Append the contents of the region to the end of file FILENAME.
5422 When called from a function, expects three arguments,
5423 START, END and FILENAME. START and END are normally buffer positions
5424 specifying the part of the buffer to write.
5425 If START is nil, that means to use the entire buffer contents.
5426 If START is a string, then output that string to the file
5427 instead of any buffer contents; END is ignored.
5429 This does character code conversion and applies annotations
5430 like `write-region' does."
5436 "Return most recent backup file for FILENAME or nil if no backups exist."
5437 ;; `make-backup-file-name' will get us the right directory for
5438 ;; ordinary or numeric backups. It might create a directory for
5439 ;; backups as a side-effect, according to `backup-directory-alist'.
5446 tem)
5455 newest))
5458 "Rename current buffer to a similar name not already taken.
5459 This function is useful for creating multiple shell process buffers
5460 or multiple mail buffers, etc.
5462 Note that some commands, in particular those based on `compilation-mode'
5463 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5464 appropriate mode even if it has been renamed. So as well as renaming
5465 the buffer, you also need to switch buffers before running another
5466 instance of such commands."
5474 ;; If the existing buffer name has a <NNN>,
5475 ;; which isn't part of the file name (if any),
5476 ;; then get rid of that.
5482 "Make directory DIR if it is not already a directory. Return nil."
5490 "Create the directory DIR and optionally any nonexistent parent dirs.
5491 If DIR already exists as a directory, signal an error, unless
5492 PARENTS is non-nil.
5494 Interactively, the default choice of directory to create is the
5495 current buffer's default directory. That is useful when you have
5496 visited a file in a nonexistent directory.
5498 Noninteractively, the second (optional) argument PARENTS, if
5499 non-nil, says whether to create parent directories that don't
5500 exist. Interactively, this happens by default.
5502 If creating the directory or directories fail, an error will be
5503 raised."
5506 nil nil)
5507 t))
5508 ;; If default-directory is a remote directory,
5509 ;; make sure we find its make-directory handler.
5517 create-list parent)
5524 ;; Do not loop if root does not exist (Bug#2309).
5527 dir parent))
5532 "Create an empty file FILENAME.
5533 Optional arg PARENTS, if non-nil then creates parent dirs as needed.
5535 If called interactively, then PARENTS is non-nil."
5551 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5552 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5553 non-nil and if FN fails due to a missing file or directory."
5559 "Delete the directory named DIRECTORY. Does not follow symlinks.
5560 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5561 no error if something else is simultaneously deleting them.
5562 TRASH non-nil means to trash the directory instead, provided
5563 `delete-by-moving-to-trash' is non-nil.
5565 When called interactively, TRASH is nil if and only if a prefix
5566 argument is given, and a further prompt asks the user for
5567 RECURSIVE if DIRECTORY is nonempty."
5574 "Move directory to trash: "
5576 default-directory default-directory nil nil))))
5582 nil)
5584 ;; If default-directory is a remote directory, make sure we find its
5585 ;; delete-directory handler.
5592 ;; Only move non-empty dir to trash if recursive deletion was
5593 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5594 ;; case, where the operation fails in delete-directory-internal.
5595 ;; As `move-file-to-trash' trashes directories (empty or
5596 ;; otherwise) as a unit, we do not need to recurse here.
5598 ;; Check if directory is empty apart from "." and "..".
5603 ;; Otherwise, call ourselves recursively if needed.
5608 directory-files-no-dot-files-regexp))
5612 ;; This test is equivalent to but more efficient
5613 ;; than (and (file-directory-p fn)
5614 ;; (not (file-symlink-p fn))).
5618 files))
5619 directory-exists))
5623 "Return non-nil if files FILE1 and FILE2 name the same file.
5624 If FILE1 or FILE2 does not exist, the return value is unspecified."
5635 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5637 Return nil if DIR is not an existing directory."
5649 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5664 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5665 This function always sets the file modes of the output files to match
5666 the corresponding input file.
5668 The third arg KEEP-TIME non-nil means give the output files the same
5669 last-modified time as the old ones. (This works on only some systems.)
5671 A prefix arg makes KEEP-TIME non-nil.
5673 Noninteractively, the last argument PARENTS says whether to
5674 create parent directories if they don't exist. Interactively,
5675 this happens by default.
5677 If NEWNAME is a directory name, copy DIRECTORY as a subdirectory
5678 there. However, if called from Lisp with a non-nil optional
5679 argument COPY-CONTENTS, copy the contents of DIRECTORY directly
5680 into NEWNAME instead."
5687 default-directory default-directory nil nil)
5688 current-prefix-arg t nil)))
5691 directory newname))
5692 ;; If default-directory is a remote directory, make sure we find its
5693 ;; copy-directory handler.
5698 newname keep-time parents copy-contents)
5700 ;; Compute target name.
5705 ;; If NEWNAME is not a directory name, create it;
5706 ;; that is where we will copy the files of DIRECTORY.
5708 ;; NEWNAME is a directory name. If COPY-CONTENTS is non-nil,
5709 ;; create NEWNAME if it is not already a directory;
5710 ;; otherwise, create NEWNAME/[DIRECTORY-BASENAME].
5717 ;; Copy recursively.
5719 ;; We do not want to copy "." and "..".
5721 directory-files-no-dot-files-regexp))
5732 ;; Set directory attributes.
5739 \f
5740 ;; At time of writing, only info uses this.
5742 "Return a copy of DIRS with all non-existent directories removed.
5743 The optional argument KEEP is a list of directories to retain even if
5744 they don't exist, and REJECT is a list of directories to remove from
5745 DIRS, even if they exist; REJECT takes precedence over KEEP.
5747 Note that membership in REJECT and KEEP is checked using simple string
5748 comparison."
5754 dirs)))
5756 \f
5759 "Function to use to revert this buffer.
5760 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5761 which are the arguments that `revert-buffer' received.
5762 It also has access to the `preserve-modes' argument of `revert-buffer'
5763 via the `revert-buffer-preserve-modes' dynamic variable.
5765 For historical reasons, a value of nil means to use the default function.
5770 #'revert-buffer-insert-file-contents--default-function
5771 "Function to use to insert contents when reverting this buffer.
5772 The function receives two arguments: the first the nominal file name to use;
5773 the second is t if reading the auto-save file.
5775 The function is responsible for updating (or preserving) point.
5777 For historical reasons, a value of nil means to use the default function.
5781 "Default function to use for `buffer-stale-function'.
5782 This function ignores its argument.
5783 This returns non-nil if the current buffer is visiting a readable file
5784 whose modification time does not match that of the buffer.
5786 This function only handles buffers that are visiting files.
5787 Non-file buffers need a custom function"
5794 "Function to check whether a buffer needs reverting.
5795 This should be a function with one optional argument NOCONFIRM.
5796 Auto Revert Mode passes t for NOCONFIRM. The function should return
5797 non-nil if the buffer should be reverted. A return value of
5798 `fast' means that the need for reverting was not checked, but
5799 that reverting the buffer is fast. The buffer is current when
5800 this function is called.
5802 The idea behind the NOCONFIRM argument is that it should be
5803 non-nil if the buffer is going to be reverted without asking the
5804 user. In such situations, one has to be careful with potentially
5805 time consuming operations.
5807 For historical reasons, a value of nil means to use the default function.
5808 This should not be relied upon.
5810 For more information on how this variable is used by Auto Revert mode,
5814 "Normal hook for `revert-buffer' to run before reverting.
5815 The function `revert-buffer--default' runs this.
5819 "Normal hook for `revert-buffer' to run after reverting.
5820 Note that the hook value that it runs is the value that was in effect
5821 before reverting; that makes a difference if you have buffer-local
5822 hook functions.
5824 The function `revert-buffer--default' runs this.
5832 ;; `revert-buffer-function' was defined long ago to be a function of only
5833 ;; 2 arguments, so we have to use a dynbind variable to pass the
5834 ;; `preserve-modes' argument of `revert-buffer'.
5838 "Replace current buffer text with the text of the visited file on disk.
5839 This undoes all changes since the file was visited or saved.
5840 With a prefix argument, offer to revert from latest auto-save file, if
5841 that is more recent than the visited file.
5843 This command also implements an interface for special buffers
5844 that contain text which doesn't come from a file, but reflects
5845 some other data instead (e.g. Dired buffers, `buffer-list'
5846 buffers). This is done via the variable `revert-buffer-function'.
5847 In these cases, it should reconstruct the buffer contents from the
5848 appropriate data.
5850 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5851 to revert from the auto-save file when this is nil. Note that the
5852 sense of this argument is the reverse of the prefix argument, for the
5853 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5854 to nil.
5856 Optional second argument NOCONFIRM means don't ask for confirmation
5857 at all. (The variable `revert-without-query' offers another way to
5858 revert buffers without querying for confirmation.)
5860 Optional third argument PRESERVE-MODES non-nil means don't alter
5861 the files modes. Normally we reinitialize them using `normal-mode'.
5863 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5865 This function calls the function that `revert-buffer-function' specifies
5866 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5867 The default function runs the hooks `before-revert-hook' and
5868 `after-revert-hook'."
5869 ;; I admit it's odd to reverse the sense of the prefix argument, but
5870 ;; there is a lot of code out there which assumes that the first
5871 ;; argument should be t to avoid consulting the auto-save file, and
5872 ;; there's no straightforward way to encourage authors to notice a
5873 ;; reversal of the argument sense. So I'm just changing the user
5874 ;; interface, but leaving the programmatic interface the same.
5879 ignore-auto noconfirm)))
5882 "Default function for `revert-buffer'.
5883 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5884 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5885 start and end.
5887 Calls `revert-buffer-insert-file-contents-function' to reread the
5888 contents of the visited file, with two arguments: the first is the file
5889 name, the second is non-nil if reading an auto-save file.
5891 This function only handles buffers that are visiting files.
5892 Non-file buffers need a custom function."
5897 buffer-auto-save-file-name
5902 buffer-auto-save-file-name
5903 buffer-file-name)))
5913 file-name)))
5915 ;; If file was backed up but has changed since,
5916 ;; we should make another backup.
5920 ;; Effectively copy the after-revert-hook status,
5921 ;; since after-find-file will clobber it.
5924 after-revert-hook))
5926 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5930 file-name auto-save-p)
5931 ;; Recompute the truename in case changes in symlinks
5932 ;; have changed the truename.
5936 ;; Run after-revert-hook as it was before we reverted.
5940 local-hook)
5943 t)))))
5946 "Default function for `revert-buffer-insert-file-contents-function'.
5947 The function `revert-buffer--default' calls this.
5948 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5949 an auto-save file."
5953 "File %s no longer exists!"
5955 file-name))
5958 "File %s no longer readable!"
5960 file-name))
5962 ;; Bind buffer-file-name to nil
5963 ;; so that we don't try to lock the file.
5969 ;; Auto-saved file should be read by Emacs's
5970 ;; internal coding.
5974 buffer-file-coding-system-explicit
5977 coding-system-for-read
5979 coding-system-for-read)
5981 ;; As a coding system suitable for multibyte
5982 ;; buffer is specified, make the current
5983 ;; buffer multibyte.
5986 ;; This force after-insert-file-set-coding
5987 ;; (called from insert-file-contents) to set
5988 ;; buffer-file-coding-system to a proper value.
5991 ;; Note that this preserves point in an intelligent way.
5995 nil nil t))
5997 nil nil t))))))
6000 "Recover the visited file--get contents from its last auto-save file."
6007 "Visit file FILE, but get contents from its last auto-save file."
6008 ;; Actually putting the file name in the minibuffer should be used
6009 ;; only rarely.
6010 ;; Not just because users often use the default.
6027 "*Directory*" nil
6038 ;; Use insert-directory-safely, not insert-directory,
6039 ;; because these files might not exist. In particular,
6040 ;; FILE might not exist if the auto-save file was for
6041 ;; a buffer that didn't visit a file, such as "*mail*".
6042 ;; The code in v20.x called `ls' directly, so we need
6043 ;; to emulate what `ls' did in that case.
6048 ;; Keep the current buffer-file-coding-system.
6050 ;; Auto-saved file should be read with special coding.
6059 "Recover auto save files from a previous Emacs session.
6060 This command first displays a Dired buffer showing you the
6061 previous sessions that you could recover from.
6062 To choose one, move point to the proper line and then type C-c C-c.
6063 Then you'll be asked about a number of files to recover."
6073 directory-files-no-dot-files-regexp
6075 t)
6086 ;; Each line starts with a space
6087 ;; so that Font Lock mode won't highlight the first character.
6090 " To delete a session file, type \
6096 "Choose one saved session to recover auto-save files from.
6097 This command is used in the special Dired buffer created by
6100 ;; Get the name of the session file to recover from.
6102 files
6108 ;; Read in the auto-save-list file.
6111 ;; Loop thru the text of that file
6112 ;; and get out the names of the files to recover.
6116 ;; This is a pair of lines for a non-file-visiting buffer.
6117 ;; Get the auto-save file name and manufacture
6118 ;; a "visited file name" from that.
6121 ;; If there is no auto-save file name, the
6122 ;; auto-save-list file is probably corrupted.
6135 ;; This pair of lines is a file-visiting
6136 ;; buffer. Use the visited file name.
6146 ;; Ignore a file if its auto-save file does not exist now.
6150 ;; The file contains a pair of line for each auto-saved buffer.
6151 ;; The first line of the pair contains the visited file name
6152 ;; or is empty if the buffer was not visiting a file.
6153 ;; The second line is the auto-save file name.
6161 files
6167 "Kill BUFFER if confirmed."
6175 "Kill some buffers. Asks the user whether to kill each one of them.
6176 Non-interactively, if optional argument LIST is non-nil, it
6177 specifies the list of buffers to kill, asking for approval for each one."
6185 ; if we killed the base buffer.
6192 "Kill buffers whose name matches the specified REGEXP.
6193 Ignores buffers whose name starts with a space, unless optional
6194 prefix argument INTERNAL-TOO is non-nil. Asks before killing
6195 each buffer, unless NO-ASK is non-nil."
6204 \f
6206 "Adjust current buffer's auto save file name for current conditions.
6207 Also rename any existing auto save file, if it was made in this session."
6219 "Return file name to use for auto-saves of current buffer.
6220 Does not consider `auto-save-visited-file-name' as that variable is checked
6221 before calling this function. You can redefine this for customization.
6222 See also `auto-save-file-name-p'."
6230 result uniq)
6231 ;; Apply user-specified translations
6232 ;; to the file name.
6236 filename)
6246 filename))))
6251 ;; We truncate the file name to DOS 8+3 limits
6252 ;; before doing anything else, because the regexp
6253 ;; passed to string-match below cannot handle
6254 ;; extensions longer than 3 characters, multiple
6255 ;; dots, and other atrocities.
6260 fn)
6265 "#"
6268 ;; Make sure auto-save file names don't contain characters
6269 ;; invalid for the underlying filesystem.
6271 ;; Don't modify remote filenames
6274 result))))
6276 ;; Deal with buffers that don't have any associated files. (Mail
6277 ;; mode tends to create a good number of these.)
6281 file-name)
6282 ;; Restrict the characters used in the file name to those which
6283 ;; are known to be safe on all filesystems, url-encoding the
6284 ;; rest.
6285 ;; We do this on all platforms, because even if we are not
6286 ;; running on DOS/Windows, the current directory may be on a
6287 ;; mounted VFAT filesystem, such as a USB memory stick.
6291 ;; For multibyte characters, this will produce more than
6292 ;; 2 hex digits, so is not true URL encoding.
6296 ;; Generate the file name.
6302 ;; Try a few alternative directories, to get one we can
6303 ;; write it.
6309 ;; Don't modify remote filenames
6311 ;; The call to convert-standard-filename is in case
6312 ;; buffer-name includes characters not allowed by the
6313 ;; DOS/Windows filesystems. make-temp-file writes to the
6314 ;; file it creates, so we must fix the file name _before_
6315 ;; make-temp-file is called.
6317 fname))
6319 ;; make-temp-file creates the file,
6320 ;; but we don't want it to exist until we do an auto-save.
6324 file-name)))
6327 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6328 FILENAME should lack slashes. You can redefine this for customization."
6330 \f
6332 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6333 The generated regexp will match a filename only if the filename
6334 matches that wildcard according to shell rules. Only wildcards known
6335 by `sh' are supported."
6337 ;; Copy the initial run of non-special characters.
6340 ;; If no special characters, we're almost done.
6344 j)
6346 result
6367 ;; Found "[^". Insert a `\0' character
6368 ;; (which cannot happen in a filename)
6369 ;; into the character class, so that `^'
6370 ;; is not the first character after `[',
6371 ;; and thus non-special in a regexp.
6376 ;; I don't think `]' can appear in a
6377 ;; character class in a wildcard, but
6378 ;; let's be general here.
6385 i
6398 ;; Shell wildcards should match the entire filename,
6399 ;; not its part. Make the regexp say so.
6401 \f
6404 "Switches for `list-directory' to pass to `ls' for brief listing."
6410 "Switches for `list-directory' to pass to `ls' for verbose listing."
6415 "Expand wildcard pattern PATTERN.
6416 This returns a list of file names which match the pattern.
6417 Files are sorted in `string<' order.
6419 If PATTERN is written as an absolute file name,
6420 the values are absolute also.
6422 If PATTERN is written as a relative file name, it is interpreted
6423 relative to the current default directory, `default-directory'.
6424 The file names returned are normally also relative to the current
6425 default directory. However, if FULL is non-nil, they are absolute."
6429 ;; A list of all dirs that DIRPART specifies.
6430 ;; This can be more than one dir
6431 ;; if DIRPART contains wildcards.
6437 contents)
6442 ;; Filter out "." and ".."
6447 name))
6454 this-dir-contents)
6455 this-dir-contents)
6456 contents)))))
6457 contents)))
6459 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6463 "Display a list of files in or matching DIRNAME, a la `ls'.
6464 DIRNAME is globbed by the shell if necessary.
6465 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6466 Actions controlled by variables `list-directory-brief-switches'
6467 and `list-directory-verbose-switches'."
6471 nil default-directory nil)
6472 pfx)))
6474 list-directory-brief-switches))
6475 buffer)
6487 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6495 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6497 PATTERN is assumed to represent a file-name wildcard suitable for the
6498 underlying filesystem. For Unix and GNU/Linux, each character from the
6500 the parts of the pattern which don't include wildcard characters are
6501 quoted with double quotes.
6504 on Windows), so PATTERN can use them to quote wildcard characters that
6505 need to be passed verbatim to shell commands."
6509 ;; DOS/Windows don't allow `"' in file names. So if the
6510 ;; argument has quotes, we can safely assume it is already
6511 ;; quoted by the caller.
6513 ;; We quote [&()#$`'] in case their shell is a port of a
6514 ;; Unixy shell. We quote [,=+] because stock DOS and
6515 ;; Windows shells require that in some cases, such as
6516 ;; passing arguments to batch files that use positional
6517 ;; arguments like %1.
6519 pattern
6522 end)
6539 pattern))))
6546 "Program to get the amount of free space on a file system.
6547 We assume the output has the format of `df'.
6548 The value of this variable must be just a command name or file name;
6549 if you want to specify options, use `directory-free-space-args'.
6551 A value of nil disables this feature.
6553 This variable is obsolete; Emacs no longer uses it."
6557 "ignored, as Emacs uses `file-system-info' instead"
6562 "Options to use when running `directory-free-space-program'."
6566 "ignored, as Emacs uses `file-system-info' instead"
6570 "Return the amount of free space on directory DIR's file system.
6571 The return value is a string describing the amount of free
6572 space (normally, the number of free 1KB blocks).
6574 If DIR's free space cannot be obtained, this function returns nil."
6580 ;; The following expression replaces `dired-move-to-filename-regexp'.
6584 ;; In some locales, month abbreviations are as short as 2 letters,
6585 ;; and they can be followed by ".".
6586 ;; In Breton, a month name can include a quote character.
6599 s "+"
6602 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6603 ;; omits the Kanji characters after month and day-of-month.
6604 ;; On Mac OS X 10.3, the date format in East Asian locales is
6605 ;; day-of-month digits followed by month digits.
6611 ;; The "[0-9]" below requires the previous column to end in a digit.
6612 ;; This avoids recognizing `1 may 1997' as a date in the line:
6613 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6615 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6617 ;; For non-iso date formats, we add the ".*" in order to find
6618 ;; the last possible match. This avoids recognizing
6619 ;; `jservice 10 1024' as a date in the line:
6620 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6622 ;; vc dired listings provide the state or blanks between file
6623 ;; permissions and date. The state is always surrounded by
6624 ;; parentheses:
6625 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6626 ;; This is not supported yet.
6631 "Regular expression to match up to the file name in a directory listing.
6632 The default value is designed to recognize dates and times
6638 "Return non-nil if DIR contents a shell wildcard in the directory part.
6639 The return value is a cons (DIR . WILDCARDS); DIR is the
6640 `default-directory' in the Dired buffer, and WILDCARDS are the wildcards.
6642 Valid wildcards are '*', '?', '[abc]' and '[a-z]'."
6645 ls-lisp-support-shell-wildcards)
6649 wildcards wildcards wildcards)))
6657 ;; The following overshoots by one line for an empty
6658 ;; directory listed with "--dired", but without "-a"
6659 ;; switch, where the ls output contains a
6660 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6661 ;; We take care of that case later.
6669 error-lines)
6670 ;; Find all the lines that are error messages,
6671 ;; and record the bounds of each one.
6678 ;; Now read the numeric positions of file names.
6685 error-lines))
6688 error-lines)))
6690 ;; End is followed by \n or by " -> ".
6692 ;; It seems that we can't trust ls's output as to
6693 ;; byte positions of filenames.
6699 ;; Take care of the case where the ls output contains a
6700 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6701 ;; and we went one line too far back (see above).
6706 ;; insert-directory
6707 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6708 ;; FULL-DIRECTORY-P is nil.
6709 ;; The single line of output must display FILE's name as it was
6710 ;; given, namely, an absolute path name.
6711 ;; - must insert exactly one line for each file if WILDCARD or
6712 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6713 ;; before the file lines, plus optional text after the file lines.
6714 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6715 ;; allowed.
6716 ;; File lines should display the basename.
6717 ;; - must be consistent with
6718 ;; - functions dired-move-to-filename, (these two define what a file line is)
6719 ;; dired-move-to-end-of-filename,
6720 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6721 ;; dired-insert-headerline
6722 ;; dired-after-subdir-garbage (defines what a "total" line is)
6723 ;; - variable dired-subdir-regexp
6724 ;; - may be passed "--dired" as the first argument in SWITCHES.
6725 ;; Filename handlers might have to remove this switch if their
6726 ;; "ls" command does not support it.
6728 "Insert directory listing for FILE, formatted according to SWITCHES.
6729 Leaves point after the inserted text.
6730 SWITCHES may be a string of options, or a list of strings
6731 representing individual options.
6732 Optional third arg WILDCARD means treat FILE as shell wildcard.
6733 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6734 switches do not contain `d', so that a full listing is expected.
6736 This works by running a directory listing program
6737 whose name is in the variable `insert-directory-program'.
6738 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6740 When SWITCHES contains the long `--dired' option, this function
6741 treats it specially, for the sake of dired. However, the
6742 normally equivalent short `-D' option is just passed on to
6743 `insert-directory-program', as any other option."
6744 ;; We need the directory in order to find the right handler.
6749 wildcard full-directory-p)
6752 ;; Read the actual directory using `insert-directory-program'.
6753 ;; RESULT gets the status code.
6755 ;; putting text property `dired-filename, decode one
6756 ;; bunch by one to preserve that property.
6758 ;; This is to control encoding the arguments in call-process.
6762 default-file-name-coding-system))))
6765 ;; If the wildcard is just in the file part, then run ls in
6766 ;; the directory part of the file pattern using the last
6767 ;; component as argument. Otherwise, run ls in the longest
6768 ;; subdirectory of the directory part free of wildcards; use
6769 ;; the remaining of the file pattern as argument.
6778 ;; NB since switches is passed to the shell, be
6779 ;; careful of malicious values, eg "-l;reboot".
6780 ;; See eg dired-safe-switches-p.
6782 shell-file-name nil t nil
6783 shell-command-switch
6785 ""
6787 insert-directory-program
6788 " -d "
6790 switches
6792 " -- "
6793 ;; Quote some characters that have
6794 ;; special meanings in shells; but
6795 ;; don't quote the wildcards--we want
6796 ;; them to be special. We also
6797 ;; currently don't quote the quoting
6798 ;; characters in case people want to
6799 ;; use them explicitly to quote
6800 ;; wildcard characters.
6802 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6803 ;; directory if FILE is a symbolic link.
6811 insert-directory-program nil t nil
6815 ;; Split the switches at any spaces so we can
6816 ;; pass separate options as separate args.
6818 ;; Avoid lossage if FILE starts with `-'.
6825 ;; (concat (file-name-as-directory file) ".")
6826 file
6827 file))))))))
6829 ;; If we got "//DIRED//" in the output, it means we got a real
6830 ;; directory listing, even if `ls' returned nonzero.
6831 ;; So ignore any errors.
6844 ;; The first time ls returns an error,
6845 ;; find the version numbers of ls,
6846 ;; and set insert-directory-ls-version
6847 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6848 ;; is equal or if the info cannot be obtained.
6849 ;; (That can mean it isn't GNU ls.)
6859 comparison)
6875 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6879 ;; If `insert-directory-program' failed, signal an error.
6881 ;; Delete the error message it may have output.
6883 ;; On non-Posix systems, we cannot open a directory, so
6884 ;; don't even try, because that will always result in
6885 ;; the ubiquitous "Access denied". Instead, show the
6886 ;; command line so the user can try to guess what went wrong.
6891 insert-directory-program
6893 file result)
6894 ;; Unix. Access the file to get a suitable error.
6898 ;; Now decode what read if necessary.
6900 file-name-coding-system
6901 default-file-name-coding-system
6903 coding-no-eol
6904 val pos)
6908 ;; If no coding system is specified or detection is
6909 ;; requested, detect the coding.
6923 ;; Force no eol conversion on a file name, so
6924 ;; that CR is preserved.
6932 ;; Try to insert the amount of free space.
6935 ;; First find the line to put it on.
6939 ;; Replace "total" with "used", to avoid confusion.
6945 "Convert `ls --dired' file name position value POS to a buffer position.
6946 File name position values returned in ls --dired output
6947 count only stdout; they don't count the error messages sent to stderr.
6948 So this function converts to them to real buffer positions.
6949 ERROR-LINES is a list of buffer positions of error message lines,
6950 of the form (START END)."
6954 pos)
6958 "Insert directory listing for FILE, formatted according to SWITCHES.
6960 Like `insert-directory', but if FILE does not exist, it inserts a
6961 message to that effect instead of signaling an error."
6964 ;; Simulate the message printed by `ls'.
6968 "Functions to call with no arguments to query about killing Emacs.
6969 If any of these functions returns nil, killing Emacs is canceled.
6970 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6971 the low level primitive, does not. See also `kill-emacs-hook'."
6977 "How to ask for confirmation when leaving Emacs.
6978 If nil, the default, don't ask at all. If the value is non-nil, it should
6979 be a predicate function; for example `yes-or-no-p'."
6988 "Non-nil if Emacs should confirm killing processes on exit.
6989 If this variable is nil, the value of
6990 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6991 processes with a non-nil `process-query-on-exit-flag', Emacs will
6992 prompt the user before killing them."
6998 "Offer to save each buffer, then kill this Emacs process.
6999 With prefix ARG, silently save all file-visiting buffers without asking.
7000 If there are active processes where `process-query-on-exit-flag'
7001 returns non-nil and `confirm-kill-processes' is non-nil,
7002 asks whether processes should be killed.
7003 Runs the members of `kill-emacs-query-functions' in turn and stops
7004 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
7006 ;; Don't use save-some-buffers-default-predicate, because we want
7007 ;; to ask about all the buffers before killing Emacs.
7018 ;; process-list is not defined on MSDOS.
7021 active)
7040 ;; Query the user for other things, perhaps.
7047 "Offer to save each buffer, then kill the current connection.
7048 If the current frame has no client, kill Emacs itself using
7049 `save-buffers-kill-emacs'.
7051 With prefix ARG, silently save all file-visiting buffers, then kill.
7053 If emacsclient was started with a list of filenames to edit, then
7054 only these files will be asked to be saved."
7059 \f
7060 ;; We use /: as a prefix to "quote" a file name
7061 ;; so that magic file name handlers will not apply to it.
7065 file-name-handler-alist))
7067 ;; We depend on being the last handler on the list,
7068 ;; so that anything else which does need handling
7069 ;; has been handled already.
7070 ;; So it is safe for us to inhibit *all* magic file name handlers for
7071 ;; operations, which return a file name. See Bug#29579.
7075 ;; few cases, operations with two file name arguments which
7076 ;; might be bound to different file name handlers, we still
7077 ;; need this.
7079 file-name-handler-alist
7080 ;; Some operations respect file name handlers in
7081 ;; `default-directory'. Because core function like
7082 ;; `call-process' don't care about file name handlers in
7083 ;; `default-directory', we here have to resolve the directory
7084 ;; into a local one. For `process-file',
7085 ;; `start-file-process', and `shell-command', this fixes
7086 ;; Bug#25949.
7090 shell-command temporary-file-directory))
7094 default-directory))
7095 ;; Get a list of the indices of the args which are file names.
7099 ;; return a file name. We want to include
7100 ;; the /: in the return value. So just
7101 ;; avoid stripping it in the first place.
7109 ;; `identity' means just return the first
7110 ;; arg not stripped of its quoting.
7112 ;; `add' means add "/:" to the result.
7114 ;;`insert-file-contents' needs special handling.
7116 ;; `unquote-then-quote' means set buffer-file-name
7117 ;; temporarily to unquoted filename.
7119 ;; Unquote `buffer-file-name' temporarily.
7122 ;; Use a temporary local copy.
7126 ;; List the arguments which are filenames.
7135 ;; These file-notify-* operations take a
7136 ;; descriptor.
7139 ;; For all other operations, treat the first
7140 ;; argument only as the file name.
7142 method
7143 ;; Copy ARGUMENTS so we can replace elements in it.
7147 ;; Strip off the /: from the file names that have it.
7157 (`buffer-file-name
7160 (`insert-file-contents
7166 (`unquote-then-quote
7167 ;; We can't use `cl-letf' with `(buffer-local-value)' here
7168 ;; because it wouldn't work during bootstrapping.
7170 ;; `unquote-then-quote' is only used for the
7171 ;; `verify-visited-file-modtime' action, which takes a buffer
7172 ;; as only optional argument.
7175 ;; Make sure to hide the temporary buffer change from the
7176 ;; underlying operation.
7179 (`local-copy
7185 tmpfile)
7187 ;; If source is remote, we must create a local copy.
7192 ;; If source is quoted, and the unquoted source looks
7193 ;; remote, we must create a local copy.
7201 ;; If target is quoted, and the unquoted target looks remote,
7202 ;; we must disable the file name handler.
7207 ;; Do it.
7211 ;; Cleanup.
7220 If NAME is a remote file name and TOP is nil, check the local part of NAME."
7226 If NAME is a remote file name and TOP is nil, the local part of
7227 NAME is quoted. If NAME is already a quoted file name, NAME is
7228 returned unchanged."
7231 name
7236 If NAME is a remote file name and TOP is nil, the local part of
7237 NAME is unquoted."
7244 \f
7245 ;; Symbolic modes and read-file-modes.
7248 "Convert CHAR to a numeric bit-mask for extracting mode bits.
7249 CHAR is in [ugoa] and represents the category of users (Owner, Group,
7250 Others, or All) for whom to produce the mask.
7251 The bit-mask that is returned extracts from mode bits the access rights
7252 for the specified category of users."
7260 "Convert CHAR to a numeric value of mode bits.
7261 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7262 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7269 ;; Rights relative to the previous file modes.
7280 "Convert a symbolic mode string specification to an equivalent number.
7282 WHO-MASK is the bit-mask specifying the category of users to which to
7283 apply the access permissions. See `file-modes-char-to-who'.
7284 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7285 RIGHTS request to add, remove, or set permissions based on existing ones,
7292 char-right)
7299 num-rights
7303 op char-right)))
7304 num-rights))
7307 "Convert symbolic file modes to numeric file modes.
7308 MODES is the string to convert, it should match
7310 See Info node `(coreutils)File permissions' for more information on this
7311 notation.
7312 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7313 MODES request to add, remove, or set permissions based on existing ones,
7327 num-who num-modes)
7330 num-modes)))
7333 "Read file modes in octal or symbolic notation and return its numeric value.
7335 ORIG-FILE is the name of a file on whose mode bits to base returned
7336 permissions if what user types requests to add, remove, or set permissions
7352 nil nil default)))
7361 ;; Trashcan handling.
7363 "Directory for `move-file-to-trash' to move files and directories to.
7364 This directory is only used when the function `system-move-file-to-trash'
7365 is not defined.
7366 Relative paths are interpreted relative to `default-directory'.
7367 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7377 "Move the file (or directory) named FILENAME to the trash.
7378 When `delete-by-moving-to-trash' is non-nil, this function is
7379 called by `delete-file' and `delete-directory' instead of
7380 deleting files outright.
7382 If the function `system-move-file-to-trash' is defined, call it
7383 with FILENAME as an argument.
7384 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7385 directory.
7386 Otherwise, trash FILENAME using the freedesktop.org conventions,
7387 like the GNOME, KDE and XFCE desktop environments. Emacs only
7391 ;; If `trash-directory' is non-nil, move the file there.
7396 ;; We can't trash a parent directory of trash-directory.
7399 trash-dir filename))
7402 ;; Ensure that the trashed file-name is unique.
7409 ;; If `system-move-file-to-trash' is defined, use it.
7412 ;; Otherwise, use the freedesktop.org method, as specified at
7413 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7424 ;; Check if we have permissions to delete.
7428 ;; The trashed file cannot be the trash dir or its parent.
7431 trash-files-dir filename))
7434 trash-info-dir filename))
7436 ;; Ensure that the trash directory exists; otherwise, create it.
7443 ;; Try to move to trash with .trashinfo undo information
7448 ;; Perform url-encoding on FN. For compatibility with
7449 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7450 ;; for path separators.
7455 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7456 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7469 fn))
7474 ;; Make a .trashinfo file. Use O_EXCL, as per trash-spec 1.0.
7478 trash-info-dir)))
7482 ;; Uniquify new-fn. Some file managers do not
7483 ;; like Emacs-style backup file names. E.g.:
7484 ;; https://bugs.kde.org/170956
7490 ;; Finally, try to move the file to the trashcan.
7496 "The type field in ATTRIBUTES returned by `file-attributes'.
7497 The value is either t for directory, string (name linked to) for
7498 symbolic link, or nil."
7502 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7506 "The UID field in ATTRIBUTES returned by `file-attributes'.
7507 This is either a string or a number. If a string value cannot be
7508 looked up, a numeric value, either an integer or a float, is
7509 returned."
7513 "The GID field in ATTRIBUTES returned by `file-attributes'.
7514 This is either a string or a number. If a string value cannot be
7515 looked up, a numeric value, either an integer or a float, is
7516 returned."
7520 "The last access time in ATTRIBUTES returned by `file-attributes'.
7521 This a Lisp timestamp in the style of `current-time'."
7525 "The modification time in ATTRIBUTES returned by `file-attributes'.
7526 This is the time of the last change to the file's contents, and
7527 is a Lisp timestamp in the style of `current-time'."
7531 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7532 This is the time of last change to the file's attributes: owner
7533 and group, access mode bits, etc., and is a Lisp timestamp in the
7534 style of `current-time'."
7538 "The integer size (in bytes) in ATTRIBUTES returned by `file-attributes'."
7542 "The file modes in ATTRIBUTES returned by `file-attributes'.
7543 This is a string of ten letters or dashes as in ls -l."
7547 "The inode number in ATTRIBUTES returned by `file-attributes'.
7548 It is a nonnegative integer."
7552 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7553 It is an integer."
7557 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7558 ATTR-NAMES are symbols with the selected attribute names.
7560 Valid attribute names are: type, link-number, user-id, group-id,
7561 access-time, modification-time, status-change-time, size, modes,
7562 inode-number and device-number."
7564 modification-time status-change-time
7565 size modes inode-number device-number))
7566 result)
7572 attributes)
7573 result)
7576 \f
7601 ;;; files.el ends here