| blob | 205001e5d5a81d9e57b766a76e94a5b3207457ca |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 a match for FROM with TO when a directory name matches FROM. This
59 replacement is done when setting up the default directory of a
60 newly visited file buffer.
62 FROM is a regexp that is matched against directory names anchored at
66 FROM and TO should be equivalent names, which refer to the
67 same directory. TO should be an absolute directory name.
68 Do not use `~' in the TO strings.
70 Use this feature when you have directories which you normally refer to
71 via absolute symbolic links. Make TO the name of the link, and FROM
72 a regexp matching the name it is linked to."
81 "Non-nil means make a backup of a file the first time it is saved.
82 This can be done by renaming the file or by copying.
84 Renaming means that Emacs renames the existing file so that it is a
85 backup file, then writes the buffer into a new file. Any other names
86 that the old file had will now refer to the backup file. The new file
87 is owned by you and its group is defaulted.
89 Copying means that Emacs copies the existing file into the backup
90 file, then writes the buffer on top of the existing file. Any other
91 names that the old file had will now refer to the new (edited) file.
92 The file's owner and group are unchanged.
94 The choice of renaming or copying is controlled by the variables
95 `backup-by-copying', `backup-by-copying-when-linked',
96 `backup-by-copying-when-mismatch' and
97 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
101 ;; Do this so that local variables based on the file name
102 ;; are not overridden by the major mode.
104 "If non-nil, backups will be inhibited.
105 This variable is intended for use by making it local to a buffer,
110 "Non-nil means always use copying to create backup files.
111 See documentation of variable `make-backup-files'."
116 "Non-nil means use copying to create backups for files with multiple names.
117 This causes the alternate names to refer to the latest version as edited.
118 This variable is relevant only if `backup-by-copying' is nil."
123 "Non-nil means create backups by copying if this preserves owner or group.
124 Renaming may still be used (subject to control of other variables)
125 when it would not result in changing the owner or group of the file;
126 that is, for files which are owned by you and whose group matches
127 the default for a new file created there by you.
128 This variable is relevant only if `backup-by-copying' is nil."
135 "Non-nil means create backups by copying to preserve a privileged owner.
136 Renaming may still be used (subject to control of other variables)
137 when it would not result in changing the owner of the file or if the owner
138 has a user id greater than the value of this variable. This is useful
139 when low-numbered uid's are used for special system users (such as root)
140 that must maintain ownership of certain files.
141 This variable is relevant only if `backup-by-copying' and
142 `backup-by-copying-when-mismatch' are nil."
147 "Predicate that looks at a file name and decides whether to make backups.
151 "Non-nil in a buffer means always offer to save buffer on exit.
152 Do so even if the buffer is not visiting a file.
153 Automatically local in all buffers.
155 Set to the symbol `always' to offer to save buffer whenever
156 `save-some-buffers' is called."
165 "Non-nil means find a file under alternative names, in existing buffers.
166 This means if any existing buffer is visiting the file you want
167 under another name, you get the existing buffer instead of a new buffer."
172 "Non-nil means visiting a file uses its truename as the visited-file name.
173 That is, the buffer visiting the file has the truename as the
174 value of `buffer-file-name'. The truename of a file is found by
175 chasing all links both at the file level and at the levels of the
176 containing directories."
182 "Specify which files should be reverted without query.
183 The value is a list of regular expressions.
184 If the file name matches one of these regular expressions,
185 then `revert-buffer' reverts the file without querying
186 if the file has changed on disk and you have not edited the buffer."
191 "The device number and file number of the file visited in the current buffer.
192 The value is a list of the form (FILENUM DEVNUM).
193 This pair of numbers uniquely identifies the file.
207 "The directory for writing small temporary files.
208 If non-nil, this directory is used instead of `temporary-file-directory'
209 by programs that create small temporary files. This is for systems that
210 have fast storage with limited space, such as a RAM disk."
215 ;; The system null device. (Should reference NULL_DEVICE from C.)
242 "Non-nil means protect against I/O errors while saving files.
243 Some modes set this non-nil in particular buffers.
245 This feature works by writing the new contents into a temporary file
246 and then renaming the temporary file to replace the original.
247 In this way, any I/O error in writing leaves the original untouched,
248 and there is never any instant where the file is nonexistent.
250 Note that this feature forces backups to be made by copying.
251 Yet, at the same time, saving a precious file
252 breaks any hard links between it and other files.
254 This feature is advisory: for example, if the directory in which the
255 file is being saved is not writable, Emacs may ignore a non-nil value
256 of `file-precious-flag' and write directly into the file.
258 See also: `break-hardlink-on-save'."
263 "Whether to allow breaking hardlinks when saving files.
264 If non-nil, then when saving a file that exists under several
265 names \(i.e., has multiple hardlinks), break the hardlink
266 associated with `buffer-file-name' and write to a new file, so
267 that the other instances of the file are not affected by the
268 save.
270 If `buffer-file-name' refers to a symlink, do not break the symlink.
272 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
273 For example, if the directory in which a file is being saved is not
274 itself writable, then error instead of saving in some
275 hardlink-nonbreaking way.
277 See also `backup-by-copying' and `backup-by-copying-when-linked'."
283 "Control use of version numbers for backup files.
284 When t, make numeric backup versions unconditionally.
285 When nil, make them for files that have some already.
286 The value `never' means do not make them."
293 "Return whether X is safe as local value for `version-control'."
300 "When cleaning directory, number of versions to keep."
306 "If t, delete excess backup versions silently.
307 If nil, ask confirmation. Any other value prevents any trimming."
314 "Number of oldest versions to keep when a new numbered backup is made."
320 "Number of newest versions to keep when a new numbered backup is made.
321 Includes the new backup. Must be > 0"
327 "Whether to add a newline automatically at the end of the file.
329 A value of t means do this only when the file is about to be saved.
330 A value of `visit' means do this right after the file is visited.
331 A value of `visit-save' means do it at both of those times.
332 Any other non-nil value means ask user whether to add a newline, when saving.
333 A value of nil means don't add newlines.
335 Certain major modes set this locally to the value obtained
336 from `mode-require-final-newline'."
346 "Whether to add a newline at end of file, in certain major modes.
347 Those modes set `require-final-newline' to this value when you enable them.
348 They do so because they are often used for files that are supposed
349 to end in newlines, and the question is how to arrange that.
351 A value of t means do this only when the file is about to be saved.
352 A value of `visit' means do this right after the file is visited.
353 A value of `visit-save' means do it at both of those times.
354 Any other non-nil value means ask user whether to add a newline, when saving.
356 A value of nil means do not add newlines. That is a risky choice in this
357 variable since this value is used for modes for files that ought to have
358 final newlines. So if you set this to nil, you must explicitly check and
359 add a final newline, whenever you save a file that really needs one."
369 "Non-nil says by default do auto-saving of every file-visiting buffer."
375 ;; Don't put "\\2" inside expand-file-name, since it will be
376 ;; transformed to "/2" on DOS/Windows.
378 "Transforms to apply to buffer file name before making auto-save file name.
379 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
380 REGEXP is a regular expression to match against the file name.
381 If it matches, `replace-match' is used to replace the
382 matching part with REPLACEMENT.
383 If the optional element UNIQUIFY is non-nil, the auto-save file name is
384 constructed by taking the directory part of the replaced file-name,
385 concatenated with the buffer file name with all directory separators
386 changed to `!' to prevent clashes. This will not work
387 correctly if your filesystem truncates the resulting name.
389 All the transforms in the list are tried, in the order they are listed.
390 When one transform applies, its result is final;
391 no further transforms are tried.
393 The default value is set up to put the auto-save file into the
394 temporary directory (see the variable `temporary-file-directory') for
395 editing a remote file.
397 On MS-DOS filesystems without long names this variable is always
398 ignored."
408 "Interval in seconds for `auto-save-visited-mode'.
409 If `auto-save-visited-mode' is enabled, Emacs will save all
410 buffers visiting a file to the visited file after it has been
411 idle for `auto-save-visited-interval' seconds."
421 "Toggle automatic saving to file-visiting buffers on or off.
422 With a prefix argument ARG, enable regular saving of all buffers
423 visiting a file if ARG is positive, and disable it otherwise.
424 Unlike `auto-save-mode', this mode will auto-save buffer contents
425 to the visited files directly and will also run all save-related
426 hooks. See Info node `Saving' for details of the save process.
428 If called from Lisp, enable the mode if ARG is omitted or nil,
429 and toggle it if ARG is `toggle'."
431 :global t
436 auto-save-visited-interval :repeat
440 auto-save-visited-file-name)))))))
442 ;; The 'set' part is so we don't get a warning for using this variable
443 ;; above, while still catching code that _sets_ the variable to get
444 ;; the same effect as the new auto-save-visited-mode.
449 "Non-nil means save word abbrevs too when files are saved.
450 If `silently', don't ask the user before saving."
455 "Non-nil means allow `find-file' to visit directories.
456 To visit the directory, `find-file' runs `find-directory-functions'."
461 "List of functions to try in sequence to visit a directory.
462 Each function is called with the directory name as the sole argument
463 and should return either a buffer or nil."
467 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
469 "List of functions to try in sequence to get a file name at point.
470 Each function should return either nil or a file name found at the
471 location of point in the current buffer."
475 ;;;It is not useful to make this a local variable.
476 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
480 "List of functions to be called for `find-file' on nonexistent file.
481 These functions are called as soon as the error is detected.
482 Variable `buffer-file-name' is already set up.
485 ;;;It is not useful to make this a local variable.
486 ;;;(put 'find-file-hooks 'permanent-local t)
489 "List of functions to be called after a buffer is loaded from a file.
490 The buffer's local variables (if any) will have been processed before the
491 functions are called."
499 "List of functions to be called before saving a buffer to a file.
500 Only used by `save-buffer'.
501 If one of them returns non-nil, the file is considered already written
502 and the rest are not called.
503 These hooks are considered to pertain to the visited file.
504 So any buffer-local binding of this variable is discarded if you change
506 change the major mode.
508 This hook is not run if any of the functions in
509 `write-contents-functions' returns non-nil. Both hooks pertain
510 to how to save a buffer to file, for instance, choosing a suitable
511 coding system and setting mode bits. (See Info
512 node `(elisp)Saving Buffers'.) To perform various checks or
524 "List of functions to be called before writing out a buffer to a file.
526 Only used by `save-buffer'. If one of them returns non-nil, the
527 file is considered already written and the rest are not called
528 and neither are the functions in `write-file-functions'. This
529 hook can thus be used to create save behavior for buffers that
530 are not visiting a file at all.
532 This variable is meant to be used for hooks that pertain to the
533 buffer's contents, not to the particular visited file; thus,
534 `set-visited-file-name' does not clear this variable; but changing the
535 major mode does clear it.
537 For hooks that _do_ pertain to the particular visited file, use
538 `write-file-functions'. Both this variable and
539 `write-file-functions' relate to how a buffer is saved to file.
540 To perform various checks or updates before the buffer is saved,
545 "Control use of local variables in files you visit.
546 The value can be t, nil, :safe, :all, or something else.
548 A value of t means file local variables specifications are obeyed
549 if all the specified variable values are safe; if any values are
550 not safe, Emacs queries you, once, whether to set them all.
551 \(When you say yes to certain values, they are remembered as safe.)
553 :safe means set the safe variables, and ignore the rest.
554 :all means set all variables, whether safe or not.
555 (Don't set it permanently to :all.)
556 A value of nil means always ignore the file local variables.
558 Any other value means always query you once whether to set them all.
559 \(When you say yes to certain values, they are remembered as safe, but
562 This variable also controls use of major modes specified in
563 a -*- line.
566 always obeys file local variable specifications and the -*- line,
567 and ignores this variable."
568 :risky t
577 "Non-nil means enable use of directory-local variables.
578 Some modes may wish to set this to nil to prevent directory-local
581 ;; This is an odd variable IMO.
582 ;; You might wonder why it is needed, when we could just do:
583 ;; (set (make-local-variable 'enable-local-variables) nil)
584 ;; These two are not precisely the same.
585 ;; Setting this variable does not cause -*- mode settings to be
586 ;; ignored, whereas setting enable-local-variables does.
587 ;; Only three places in Emacs use this variable: tar and arc modes,
588 ;; and rmail. The first two don't need it. They already use
589 ;; inhibit-local-variables-regexps, which is probably enough, and
590 ;; could also just set enable-local-variables locally to nil.
591 ;; Them setting it has the side-effect that dir-locals cannot apply to
592 ;; eg tar files (?). FIXME Is this appropriate?
593 ;; AFAICS, rmail is the only thing that needs this, and the only
594 ;; reason it uses it is for BABYL files (which are obsolete).
595 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
596 ;; to respect, so that find-file on a BABYL file will switch to
597 ;; rmail-mode automatically (this is nice, but hardly essential,
598 ;; since most people are used to explicitly running a command to
599 ;; access their mail; M-x gnus etc). Rmail files may happen to
600 ;; contain Local Variables sections in messages, which Rmail wants to
601 ;; ignore. So AFAICS the only reason this variable exists is for a
602 ;; minor convenience feature for handling of an obsolete Rmail file format.
604 "Like `enable-local-variables', except for major mode in a -*- line.
605 The meaningful values are nil and non-nil. The default is non-nil.
606 It should be set in a buffer-local fashion.
608 Setting this to nil has the same effect as setting `enable-local-variables'
609 to nil, except that it does not ignore any mode: setting in a -*- line.
610 Unless this difference matters to you, you should set `enable-local-variables'
615 The value can be t, nil or something else.
616 A value of t means obey `eval' variables.
617 A value of nil means ignore them; anything else means query."
618 :risky t
625 "Non-nil means buffers visiting files read-only do so in view mode.
626 In fact, this means that all read-only buffers normally have
627 View mode enabled, including buffers that are read-only because
628 you visit a file you cannot alter, and buffers you make read-only
634 "History list of file names entered in the minibuffer.
636 Maximum length of the history list is determined by the value
640 "If non-nil, avoid messages when saving files.
641 Error-related messages will still be printed, but all other
644 \f
647 "Provides support for ange-ftp host name completion.
648 Runs the usual ange-ftp hook, but only for completion operations."
649 ;; Having this here avoids the need to load ange-ftp when it's not
650 ;; really in use.
656 inhibit-file-name-handlers)))
664 "Convert a standard file's name to something suitable for the OS.
665 This means to guarantee valid names and perhaps to canonicalize
666 certain patterns.
668 FILENAME should be an absolute file name since the conversion rules
669 sometimes vary depending on the position in the file name. E.g. c:/foo
670 is a valid DOS file name, but c:/bar/c:/foo is not.
672 This function's standard definition is trivial; it just returns
673 the argument. However, on Windows and DOS, replace invalid
674 characters. On DOS, make sure to obey the 8.3 limitations.
675 In the native Windows build, turn Cygwin names into native names.
677 See Info node `(elisp)Standard File Names' for more details."
682 ;; Replace invalid filename characters with !
686 name))
694 "Read directory name, prompting with PROMPT and completing in directory DIR.
695 Value is not expanded---you must call `expand-file-name' yourself.
696 Default name to DEFAULT-DIRNAME if user exits with the same
697 non-empty string that was inserted by this function.
698 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
699 or just DIR if INITIAL is nil.)
700 If the user exits with an empty minibuffer, this function returns
701 an empty string. (This can only happen if the user erased the
702 pre-inserted contents or if `insert-default-directory' is nil.)
703 Fourth arg MUSTMATCH non-nil means require existing directory's name.
704 Non-nil and non-t means also require confirmation after completion.
705 Fifth arg INITIAL specifies text to start with.
706 DIR should be an absolute directory name. It defaults to
707 the value of `default-directory'."
712 dir))
713 mustmatch initial
716 \f
718 "Show the current default directory.
719 With prefix argument INSERT, insert the current default directory
720 at point instead."
727 "Value of the CDPATH environment variable, as a list.
731 "Explode a search path into a list of directory names.
732 Directories are separated by `path-separator' (which is colon in
733 GNU and Unix systems). Substitute environment variables into the
734 resulting list of directory names. For an empty path element (i.e.,
735 a leading or trailing separator, or two adjacent separators), return
736 nil (meaning `default-directory') as the associated list element."
744 "Change current directory to given absolute file name DIR."
745 ;; Put the name into directory syntax now,
746 ;; because otherwise expand-file-name may give some bad results.
748 ;; We used to additionally call abbreviate-file-name here, for an
749 ;; unknown reason. Problem is that most buffers are setup
750 ;; without going through cd-absolute and don't call
751 ;; abbreviate-file-name on their default-directory, so the few that
752 ;; do end up using a superficially different directory.
764 "Make DIR become the current buffer's default directory.
765 If your environment includes a `CDPATH' variable, try each one of
766 that list of directories (separated by occurrences of
767 `path-separator') when resolving a relative directory name.
768 The path separator is colon in GNU and GNU-like systems."
771 ;; FIXME: There's a subtle bug in the completion below. Seems linked
772 ;; to a fundamental difficulty of implementing `predicate' correctly.
773 ;; The manifestation is that TAB may list non-directories in the case where
774 ;; those files also correspond to valid directories (if your cd-path is (A/
775 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
776 ;; will be listed as valid completions).
777 ;; This is because `a' (listed because of A/a) is indeed a valid choice
778 ;; (which will lead to the use of B/a).
783 cd-path nil))
792 default-directory default-directory
793 t))))
803 "Return list of all files under DIR that have file names matching REGEXP.
805 order, and files from each directory are sorted in alphabetical order.
806 Each file name appears in the returned list in its absolute form.
807 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
808 output directories whose names match REGEXP."
811 ;; When DIR is "/", remote file names like "/method:" could
812 ;; also be offered. We shall suppress them.
820 ;; Don't follow symlinks to other directories.
824 full-file regexp include-directories))))
835 "Load the Lisp file named FILE."
836 ;; This is a case where .elc and .so/.dll make a lot of sense.
840 completion-ignored-extensions))))
845 "Search for FILENAME through PATH.
846 If found, return the absolute file name of FILENAME; otherwise
847 return nil.
848 PATH should be a list of directories to look in, like the lists in
849 `exec-path' or `load-path'.
850 If SUFFIXES is non-nil, it should be a list of suffixes to append to
853 If non-nil, PREDICATE is used instead of `file-readable-p'.
855 This function will normally skip directories, so if you want it to find
856 directories, make sure the PREDICATE function returns `dir-ok' for them.
858 PREDICATE can also be an integer to pass to the `access' system call,
859 in which case file-name handlers are ignored. This usage is deprecated.
860 For compatibility, PREDICATE can also be one of the symbols
861 `executable', `readable', `writable', or `exists', or a list of
862 one or more of those symbols."
873 "Do completion for file names passed to `locate-file'."
876 ;; FIXME: maybe we should use completion-file-name-table instead,
877 ;; tho at least for `load', the arg is passed through
878 ;; substitute-in-file-name for historical reasons.
888 ;; If we have files like "foo.el" and "foo.elc", we could load one of
889 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
890 ;; preferred way. So if we list all 3, that gives a lot of redundant
891 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
892 ;; the user does want to pay attention to the extension. We try to
893 ;; diffuse this tension by stripping the suffix, except when the
894 ;; result is a single element (i.e. usually we only list "foo" unless
895 ;; it's the only remaining element in the list, in which case we do
896 ;; list "foo", "foo.elc" and "foo.el").
907 string-file dir))
912 ;; Switching from names to names+fullnames creates a non-monotonicity
913 ;; which can cause problems with things like partial-completion.
914 ;; To minimize the problem, filter out completion-regexp-list, so that
915 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
916 ;; from `names' which only matched `string' when they still had
917 ;; their suffix.
919 ;; Remove duplicates of the first element, so that we can easily check
920 ;; if `names' really only contains a single element.
923 ;; There's no more than one matching non-suffixed element, so expand
924 ;; the list by adding the suffixed elements as well.
927 string-dir names string-file pred action)))))
930 "Do completion for file names passed to `locate-file'.
931 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
935 string nil action))
939 "Regexp of directory names which stop the search in `locate-dominating-file'.
940 Any directory whose name matches this regexp will be treated like
941 a kind of root directory by `locate-dominating-file' which will stop its search
942 when it bumps into it.
943 The default regexp prevents fruitless and time-consuming attempts to find
944 special files in directories in which filenames are interpreted as hostnames,
948 "Starting at FILE, look up directory hierarchy for directory containing NAME.
949 FILE can be a file or a directory. If it's a file, its directory will
950 serve as the starting point for searching the hierarchy of directories.
951 Stop at the first parent directory containing a file NAME,
952 and return the directory. Return nil if not found.
953 Instead of a string, NAME can also be a predicate taking one argument
954 \(a directory) and returning a non-nil value if that directory is the one for
955 which we're looking. The predicate will be called with every file/directory
956 the function needs to examine, starting with FILE."
957 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
958 ;; `name' in /home or in /.
961 try)
975 "Non-nil means warn if cannot access `user-emacs-directory'.
976 Set this to nil at your own risk..."
982 "Return an absolute per-user Emacs-specific file name.
983 If NEW-NAME exists in `user-emacs-directory', return it.
984 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
985 Else return NEW-NAME in `user-emacs-directory', creating the
986 directory if it does not exist."
994 at-home
995 ;; Make sure `user-emacs-directory' exists,
996 ;; unless we're in batch mode or dumping Emacs.
998 purify-flag
1008 user-emacs-directory-warning
1010 ;; Only warn once per Emacs session.
1014 Unable to %s `user-emacs-directory' (%s).
1015 Any data that would normally be written there may be lost!
1016 If you never want to see this message again,
1017 customize the variable `user-emacs-directory-warning'."
1018 errtype user-emacs-directory)))))
1019 bestname))))
1023 "Search for COMMAND in `exec-path' and return the absolute file name.
1024 Return nil if COMMAND is not found anywhere in `exec-path'."
1025 ;; Use 1 rather than file-executable-p to better match the behavior of
1026 ;; call-process.
1030 "Load the Emacs Lisp library named LIBRARY.
1031 LIBRARY should be a string.
1032 This is an interface to the function `load'. LIBRARY is searched
1033 for in `load-path', both with and without `load-suffixes' (as
1034 well as `load-file-rep-suffixes').
1036 See Info node `(emacs)Lisp Libraries' for more details.
1037 See `load-file' for a different interface to `load'."
1042 load-path
1047 "Test whether FILE specifies a location on a remote system.
1048 A file is considered remote if accessing it is likely to
1049 be slower or less reliable than accessing local files.
1051 `file-remote-p' never opens a new remote connection. It can
1052 only reuse a connection that is already open.
1054 Return nil or a string identifying the remote connection
1055 \(ideally a prefix of FILE). Return nil if FILE is a relative
1056 file name.
1058 When IDENTIFICATION is nil, the returned string is a complete
1059 remote identifier: with components method, user, and host. The
1060 components are those present in FILE, with defaults filled in for
1061 any that are missing.
1063 IDENTIFICATION can specify which part of the identification to
1064 return. IDENTIFICATION can be the symbol `method', `user',
1065 `host', or `localname'. Any other value is handled like nil and
1066 means to return the complete identification. The string returned
1067 for IDENTIFICATION `localname' can differ depending on whether
1068 there is an existing connection.
1070 If CONNECTED is non-nil, return an identification only if FILE is
1071 located on a remote system and a connection is established to
1072 that remote system.
1074 Tip: You can use this expansion of remote identifier components
1075 to derive a new remote file name from an existing one. For
1081 same remote identifier as FILE but expanded; a name such as
1086 nil)))
1088 ;; Probably this entire variable should be obsolete now, in favor of
1089 ;; something Tramp-related (?). It is not used in many places.
1090 ;; It's not clear what the best file for this to be in is, but given
1091 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1092 ;; rather than autoloaded.
1094 ;; This used to try various hard-coded places for remsh, rsh, and
1095 ;; rcmd, trying to guess based on location whether "rsh" was
1096 ;; "restricted shell" or "remote shell", but I don't see the point
1097 ;; in this day and age. Almost everyone will use ssh, and have
1098 ;; whatever command they want to use in PATH.
1105 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1112 "Whether to use the remote file-name cache for read access.
1113 When nil, never expire cached values (caution)
1114 When t, never use the cache (safe, but may be slow)
1115 A number means use cached values for that amount of seconds since caching.
1117 The attributes of remote files are cached for better performance.
1118 If they are changed outside of Emacs's control, the cached values
1119 become invalid, and must be reread. If you are sure that nothing
1120 other than Emacs changes the files, you can set this variable to nil.
1122 If a remote file is checked regularly, it might be a good idea to
1123 let-bind this variable to a value less than the interval between
1124 consecutive checks. For example:
1126 (defun display-time-file-nonempty-p (file)
1127 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1128 (and (file-exists-p file)
1129 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1140 "Return the local name component of FILE.
1141 It returns a file name which can be used directly as argument of
1142 `process-file', `start-file-process', or `shell-command'."
1146 "Copy the file FILE into a temporary file on this machine.
1147 Returns the name of the local copy, or nil, if FILE is directly
1148 accessible."
1149 ;; This formerly had an optional BUFFER argument that wasn't used by
1150 ;; anything.
1154 nil)))
1157 "Return non-nil if FILE is an absolute name to the operating system.
1158 This is like `file-name-absolute-p', except that it returns nil for
1159 names beginning with `~'."
1164 "Splice DIRNAME to FILE like the operating system would.
1165 If FILE is relative, return DIRNAME concatenated to FILE.
1166 Otherwise return FILE, quoted as needed if DIRNAME and FILE have
1167 different handlers; although this quoting is dubious if DIRNAME
1168 is magic, it is not clear what would be better. This function
1169 differs from `expand-file-name' in that DIRNAME must be a
1170 directory name and leading `~' and `/:' are not special in FILE."
1172 file
1176 unquoted
1180 "Return the truename of FILENAME.
1181 If FILENAME is not absolute, first expands it against `default-directory'.
1182 The truename of a file name is found by chasing symbolic links
1183 both at the level of the file and at the level of the directories
1184 containing it, until no links are left at any level.
1187 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1188 ;; COUNTER can be a cons cell whose car is the count of how many
1189 ;; more links to chase before getting an error.
1190 ;; PREV-DIRS can be a cons cell whose car is an alist
1191 ;; of truenames we've just recently computed.
1205 ;; For speed, remove the ange-ftp completion handler from the list.
1206 ;; We know it's not needed here.
1207 ;; For even more speed, do this only on the outermost call.
1214 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1215 ;; case differences being ignored by the OS, and short "8.3 DOS"
1216 ;; name aliases existing for all files. (The short names are not
1217 ;; reported by directory-files, but can be used to refer to files.)
1218 ;; It seems appropriate for file-truename to resolve these issues in
1219 ;; the most natural way, which on Windows is to call the function
1220 ;; `w32-long-file-name' - this returns the exact name of a file as
1221 ;; it is stored on disk (expanding short name aliases with the full
1222 ;; name in the process).
1225 ;; If filename exists, use its long name. If it doesn't
1226 ;; exist, the recursion below on the directory of filename
1227 ;; will drill down until we find a directory that exists,
1228 ;; and use the long name of that, with the extra
1229 ;; non-existent path components concatenated.
1234 ;; If this file directly leads to a link, process that iteratively
1235 ;; so that we don't use lots of stack.
1241 ;; For file name that has a special handler, call handler.
1242 ;; This is so that ange-ftp can save time by doing a no-op.
1245 done t)
1247 target dirfile)
1248 ;; Get the truename of the directory.
1250 ;; If these are equal, we have the (or a) root directory.
1254 ;; If this is the same dir we last got the truename for,
1255 ;; save time--don't recalculate.
1265 done t)
1268 done t)
1269 ;; Put it back on the file name.
1271 ;; Is the file name the name of a link?
1274 ;; Yes => chase that link, then start all over
1275 ;; since the link may point to a directory name that uses links.
1276 ;; We can't safely use expand-file-name here
1277 ;; since target might look like foo/../bar where foo
1278 ;; is itself a link. Instead, we handle . and .. above.
1280 done nil)
1281 ;; No, we are done!
1283 filename))
1286 "Chase links in FILENAME until a name that is not a link.
1287 Unlike `file-truename', this does not check whether a parent
1288 directory name is a symbolic link.
1289 If the optional argument LIMIT is a number,
1290 it means chase no more than that many links and then stop."
1298 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1301 ;; Handle `..' by hand, since it needs to work in the
1302 ;; target of any directory symlink.
1303 ;; This code is not quite complete; it does not handle
1304 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1308 ;; Chase links in the default dir of the symlink.
1312 ;; Now find the parent of that dir.
1315 tem))
1317 newname))
1319 ;; A handy function to display file sizes in human-readable form.
1320 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1322 "Produce a string showing FILE-SIZE in human-readable form.
1324 Optional second argument FLAVOR controls the units and the display format:
1326 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1328 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1330 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1333 1024.0
1336 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1342 "%.1f%s%s"
1344 file-size
1346 "K"
1352 "^//[^/]+/"
1353 ;; regexp-opt.el is not dumped into emacs binary.
1354 ;;(concat
1355 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1357 "File systems which ought to be mounted."
1364 "The directory for writing temporary files.
1365 In case of a remote `default-directory', this is a directory for
1366 temporary files on that remote host. If such a directory does
1367 not exist, or `default-directory' ought to be located on a
1368 mounted file system (see `mounted-file-systems'), the function
1369 returns `default-directory'.
1370 For a non-remote and non-mounted `default-directory', the value of
1371 the variable `temporary-file-directory' is returned."
1377 default-directory
1378 temporary-file-directory))))
1381 "Create a temporary file.
1382 The returned file name (created by appending some random characters at the end
1383 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1384 is guaranteed to point to a newly created file.
1385 You can then use `write-region' to write new data into the file.
1387 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1389 If SUFFIX is non-nil, add that at the end of the file name.
1391 If TEXT is a string, insert it into the new file; DIR-FLAG should be nil.
1392 Otherwise the file will be empty."
1404 "Implement (make-temp-file ABSOLUTE-PREFIX DIR-FLAG SUFFIX TEXT).
1405 This implementation works on magic file names."
1406 ;; Create temp files with strict access rights. It's easy to
1407 ;; loosen them later, whereas it's impossible to close the
1408 ;; time-window of loose permissions otherwise.
1411 file)
1420 nil)
1422 ;; the file was somehow created by someone else between
1423 ;; `make-temp-name' and `write-region', let's try again.
1424 nil)
1425 file)))
1428 "Create a temporary file as close as possible to `default-directory'.
1429 If PREFIX is a relative file name, and `default-directory' is a
1430 remote file name or located on a mounted file systems, the
1431 temporary file is created in the directory returned by the
1432 function `temporary-file-directory'. Otherwise, the function
1433 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1434 same meaning as in `make-temp-file'."
1443 "Change the encoding of FILE's name from CODING to NEW-CODING.
1444 The value is a new name of FILE.
1445 Signals a `file-already-exists' error if a file of the new name
1446 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1447 is non-nil. A number as fourth arg means request confirmation if
1448 the new name already exists. This is what happens in interactive
1449 use with M-x."
1452 default-file-name-coding-system))
1454 from-coding to-coding)
1456 ;; We provide the default coding only when it seems that
1457 ;; the filename is correctly decoded by the default
1458 ;; coding.
1464 filename default-coding)
1465 default-coding))
1469 ;; We provide the default coding only when a user is going to
1470 ;; change the encoding not from the default coding.
1474 filename from-coding)))
1477 filename from-coding default-coding)
1478 default-coding)))
1482 default-file-name-coding-system))
1483 ;; FILE should have been decoded by DEFAULT-CODING.
1487 ;; Suppress further encoding.
1492 newname))
1493 \f
1495 "Whether confirmation is requested before visiting a new file or buffer.
1496 If nil, confirmation is not requested.
1497 If the value is `after-completion', confirmation is only
1498 requested if the user called `minibuffer-complete' right before
1499 `minibuffer-complete-and-exit'.
1500 Any other non-nil value means to request confirmation.
1502 This affects commands like `switch-to-buffer' and `find-file'."
1510 "Whether to request confirmation before visiting a new file or buffer.
1511 The variable `confirm-nonexistent-file-or-buffer' determines the
1512 return value, which may be passed as the REQUIRE-MATCH arg to
1513 `read-buffer' or `find-file-read-args'."
1521 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1523 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1524 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1525 instead of prepending it.
1527 BODY should use the minibuffer at most once.
1528 Recursive uses of the minibuffer are unaffected (FUN is not
1529 called additional times).
1531 This macro actually adds an auxiliary function that calls FUN,
1532 rather than FUN itself, to `minibuffer-setup-hook'."
1543 ;; Clear out this hook so it does not interfere
1544 ;; with any recursive minibuffer usage.
1555 t))
1558 "Edit file FILENAME.
1559 Switch to a buffer visiting file FILENAME,
1560 creating one if none already exists.
1561 Interactively, the default if you just type RET is the current directory,
1562 but the visited file name is available through the minibuffer history:
1566 the file name, the result is affected by `file-name-at-point-functions',
1567 which by default try to guess the file name by looking at point in the
1568 current buffer. Customize the value of `file-name-at-point-functions'
1569 or set it to nil, if you want only the visited file name and the
1571 request.
1573 You can visit files on remote machines by specifying something
1574 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1575 also visit local files as a different user by specifying
1576 /sudo::FILE for the file name.
1577 See the Info node `(tramp)File name Syntax' in the Tramp Info
1578 manual, for more about this.
1580 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1581 expand wildcards (if any) and visit multiple files. You can
1582 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1584 To visit a file without any kind of conversion and without
1595 "Edit file FILENAME, in another window.
1598 an existing one. See the function `display-buffer'.
1600 Interactively, the default if you just type RET is the current directory,
1601 but the visited file name is available through the minibuffer history:
1605 the file name, the result is affected by `file-name-at-point-functions',
1606 which by default try to guess the file name by looking at point in the
1607 current buffer. Customize the value of `file-name-at-point-functions'
1608 or set it to nil, if you want only the visited file name and the
1610 request.
1612 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1613 expand wildcards (if any) and visit multiple files."
1623 value)
1627 "Edit file FILENAME, in another frame.
1630 an existing one. See the function `display-buffer'.
1632 Interactively, the default if you just type RET is the current directory,
1633 but the visited file name is available through the minibuffer history:
1637 the file name, the result is affected by `file-name-at-point-functions',
1638 which by default try to guess the file name by looking at point in the
1639 current buffer. Customize the value of `file-name-at-point-functions'
1640 or set it to nil, if you want only the visited file name and the
1642 request.
1644 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1645 expand wildcards (if any) and visit multiple files."
1655 value)
1659 "Edit the existing file FILENAME.
1661 file names with wildcards."
1678 value))
1681 "Edit file FILENAME but don't allow changes.
1690 "Edit file FILENAME in another window but don't allow changes.
1699 "Edit file FILENAME in another frame but don't allow changes.
1708 "Find file FILENAME as a replacement for the file in the next window.
1709 This command does not select that window.
1713 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1714 expand wildcards (if any) and replace the file with multiple files."
1725 "Find alternate file: " file-dir nil
1727 t))))
1734 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1736 "Hook run when a buffer is killed.
1737 The buffer being killed is current while the hook is running.
1738 See `kill-buffer'.
1740 Note: Be careful with let-binding this hook considering it is
1744 "Find file FILENAME, select its buffer, kill previous buffer.
1745 If the current buffer now contains an empty file that you just visited
1746 \(presumably by mistake), use this command to visit the file you really want.
1750 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1751 expand wildcards (if any) and replace the file with multiple files.
1753 If the current buffer is an indirect buffer, or the base buffer
1754 for one or more indirect buffers, the other buffer(s) are not
1755 killed."
1764 "Find alternate file: " file-dir nil
1766 t)))
1780 ;; Run `kill-buffer-hook' here. It needs to happen before
1781 ;; variables like `buffer-file-name' etc are set to nil below,
1782 ;; because some of the hooks that could be invoked
1783 ;; (e.g., `save-place-to-alist') depend on those variables.
1784 ;;
1785 ;; Note that `kill-buffer-hook' is not what queries whether to
1786 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1787 ;; asks that itself. Thus, there's no need to temporarily do
1788 ;; `(set-buffer-modified-p nil)' before running this hook.
1790 ;; Okay, now we can end-of-life the old buffer.
1797 ;; This prevents us from finding the same buffer
1798 ;; if we specified the same file again.
1802 ;; Likewise for dired buffers.
1806 ;; This executes if find-file gets an error
1807 ;; and does not really find anything.
1808 ;; We put things back as they were.
1809 ;; If find-file actually finds something, we kill obuf below.
1818 ;; We already ran these; don't run them again.
1821 \f
1822 ;; FIXME we really need to fold the uniquify stuff in here by default,
1823 ;; not using advice, and add it to the doc string.
1825 "Create a suitably named buffer for visiting FILENAME, and return it.
1826 FILENAME (sans directory) is used unchanged if that name is free;
1827 otherwise a string <2> or <3> or ... is appended to get an unused name.
1829 Emacs treats buffers whose names begin with a space as internal buffers.
1830 To avoid confusion when visiting a file whose name begins with a space,
1837 lastname))))
1840 "Create and return a buffer with a name based on NAME.
1841 Choose the buffer's name using `generate-new-buffer-name'."
1845 "Regexp to match the automounter prefix in a directory name."
1851 "Regexp matching the user's homedir at the beginning of file name.
1855 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1857 home directory is a root directory) and removes automounter prefixes
1858 \(see the variable `automount-dir-prefix').
1860 When this function is first called, it caches the user's home
1861 directory as a regexp in `abbreviated-home-dir', and reuses it
1862 afterwards (so long as the home directory does not change;
1863 if you want to permanently change your home directory after having
1864 started Emacs, set `abbreviated-home-dir' to nil so it will be recalculated)."
1865 ;; Get rid of the prefixes added by the automounter.
1872 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1874 ;; If any elt of directory-abbrev-alist matches this name,
1875 ;; abbreviate accordingly.
1881 ;; Compute and save the abbreviated homedir name.
1882 ;; We defer computing this until the first time it's needed, to
1883 ;; give time for directory-abbrev-alist to be set properly.
1884 ;; We include a slash at the end, to avoid spurious matches
1885 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1895 ;; Depending on whether default-directory does or
1896 ;; doesn't include non-ASCII characters, the value
1897 ;; of abbreviated-home-dir could be multibyte or
1898 ;; unibyte. In the latter case, we need to decode
1899 ;; it. Note that this function is called for the
1900 ;; first time (from startup.el) when
1901 ;; locale-coding-system is already set up.
1903 abbreviated-home-dir
1906 'utf-8
1907 locale-coding-system))))))
1909 ;; If FILENAME starts with the abbreviated homedir,
1910 ;; and ~ hasn't changed since abbreviated-home-dir was set,
1911 ;; make it start with `~' instead.
1912 ;; If ~ has changed, we ignore abbreviated-home-dir rather than
1913 ;; invalidating it, on the assumption that a change in HOME
1914 ;; is likely temporary (eg for testing).
1915 ;; FIXME Is it even worth caching abbreviated-home-dir?
1916 ;; Ref: https://debbugs.gnu.org/19657#20
1918 ;; If the home dir is just /, don't change it.
1921 ;; MS-DOS root directories can come with a drive letter;
1922 ;; Novell Netware allows drive letters beyond `Z:'.
1932 filename)))
1935 "Return the buffer visiting file FILENAME (a string).
1936 This is like `get-file-buffer', except that it checks for any buffer
1937 visiting the same file, possibly under a different name.
1938 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1939 and others are ignored.
1940 If there is no such live buffer, return nil."
1953 found)
1963 ;; Verify this buffer's file number
1964 ;; still belongs to its file.
1967 attributes)
1971 found))))
1972 \f
1974 "Non-nil means file-visiting commands should handle wildcards.
1975 For example, if you specify `*.c', that would visit all the files
1976 whose names match the pattern."
1982 "Non-nil means suppress warning messages for symlinked files.
1983 When nil, Emacs prints a warning when visiting a file that is already
1984 visited, but with a different name. Setting this option to t
1985 suppresses this warning."
1991 "Maximum size of file above which a confirmation is requested.
1992 When nil, never request confirmation."
1999 "Warn if file size exceeds this percentage of available free memory.
2000 When nil, never issue warning. Beware: This probably doesn't do what you
2008 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
2009 OP-TYPE specifies the file operation being performed (for message to user)."
2018 "Warn if an attempt to open file of SIZE bytes may run out of memory."
2028 "You are trying to open a file whose size (%s)
2029 exceeds the %S%% of currently available free memory (%s).
2030 If that fails, try to open it with `find-file-literally'
2031 \(but note that some characters might be displayed incorrectly)."
2033 out-of-memory-warning-percentage
2037 "Like `message', except sometimes don't print to minibuffer.
2038 If the variable `save-silently' is non-nil, the message is not
2039 displayed on the minibuffer."
2044 "Read file FILENAME into a buffer and return the buffer.
2045 If a buffer exists visiting FILENAME, return that one, but
2046 verify that the file has not changed since visited or saved.
2047 The buffer is not selected, just returned to the caller.
2048 Optional second arg NOWARN non-nil means suppress any warning messages.
2049 Optional third arg RAWFILE non-nil means the file is read literally.
2050 Optional fourth arg WILDCARDS non-nil means do wildcard processing
2051 and visit all the matching files. When wildcards are actually
2052 used and expanded, return a list of buffers that are visiting
2053 the various files."
2060 'find-directory-functions
2063 filename)))
2066 find-file-wildcards
2080 ;; Find any buffer for a file which has same truename.
2082 ;; Let user know if there is a buffer with the same truename.
2086 find-file-suppress-same-file-warnings
2090 ;; Optionally also find that buffer.
2093 ;; Check to see if the file looks uncommonly large.
2098 ;; We are using an existing buffer.
2105 ;; Certain files should be reverted automatically
2106 ;; if they have changed on disk and not in the buffer.
2114 found))
2124 "File %s changed on disk. Discard your edits? "
2129 "File %s changed on disk. Discard your edits in %s? "
2137 ;; Check if a formerly read-only file has become
2138 ;; writable and vice versa, but if the buffer agrees
2139 ;; with the new state of the file, that is ok too.
2149 buffer-file-name
2150 new-status new-status)))
2156 nonexistent
2157 ;; It is confusing to ask whether to visit
2158 ;; non-literally if they have the file in
2159 ;; hexl-mode or image-mode.
2165 "The file %s is already visited normally,
2166 and you have edited the buffer. Now you have asked to visit it literally,
2167 meaning no coding system handling, format conversion, or local variables.
2168 Emacs can only visit a file in one way at a time.
2170 Do you want to save the file, and visit it literally instead? "
2171 "The file %s is already visited literally,
2172 meaning no coding system handling, format conversion, or local variables.
2173 You have edited the buffer. Now you have asked to visit the file normally,
2174 but Emacs can only visit a file in one way at a time.
2181 rawfile truename number))
2185 "\
2186 Do you want to discard your changes, and visit the file literally now? "
2187 "\
2190 rawfile truename number)
2196 "The file %s is already visited normally.
2197 You have asked to visit it literally,
2198 meaning no coding system decoding, format conversion, or local variables.
2199 But Emacs can only visit a file in one way at a time.
2201 Do you want to revisit the file literally now? "
2202 "The file %s is already visited literally,
2203 meaning no coding system decoding, format conversion, or local variables.
2204 You have asked to visit it normally,
2205 but Emacs can only visit a file in one way at a time.
2210 rawfile truename number)
2213 ;; Return the buffer we are using.
2214 buf)
2215 ;; Create a new buffer.
2217 ;; find-file-noselect-1 may use a different buffer.
2219 rawfile truename number))))))
2225 ;; Needed in case we are re-visiting the file with a different
2226 ;; text representation.
2243 filename)))
2244 ;; Unconditionally set error
2254 filename)))
2255 ;; Run find-file-not-found-functions until one returns non-nil.
2257 ;; If they fail too, set error.
2259 ;; Record the file's truename, and maybe use that as visited name.
2267 ;; Set buffer's default directory to that of the file.
2269 ;; Turn off backup files for certain file names. Since
2270 ;; this is a permanent local, the major mode won't eliminate it.
2284 \f
2286 "Like `insert-file-contents', but only reads in the file literally.
2287 See `insert-file-contents' for an explanation of the parameters.
2288 A buffer may be modified in several ways after reading into the buffer,
2289 due to Emacs features such as format decoding, character code
2290 conversion, `find-file-hook', automatic uncompression, etc.
2292 This function ensures that none of these modifications will take place."
2298 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2299 ;; into a file operation instead!
2301 inhibit-file-name-handlers))
2308 filename)))
2309 ;; Check whether the file is uncommonly large
2320 "Insert contents of file FILENAME into buffer after point with no conversion.
2322 This function is meant for the user to run interactively.
2323 Don't call it from programs! Use `insert-file-contents-literally' instead.
2324 \(Its calling sequence is different; see its documentation)."
2330 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2331 This has the `permanent-local' property, which takes effect if you
2336 "Visit file FILENAME with no conversion of any kind.
2337 Format conversion and character code conversion are both disabled,
2338 and multibyte characters are disabled in the resulting buffer.
2339 The major mode used is Fundamental mode regardless of the file name,
2340 and local variable specifications in the file are ignored.
2341 Automatic uncompression and adding a newline at the end of the
2342 file due to `require-final-newline' is also disabled.
2344 You cannot absolutely rely on this function to result in
2345 visiting the file literally. If Emacs already has a buffer
2346 which is visiting the file, you get the existing buffer,
2347 regardless of whether it was created literally or not.
2349 In a Lisp program, if you want to be sure of accessing a file's
2350 contents literally, you should create a temporary buffer and then read
2351 the file contents into it using `insert-file-contents-literally'."
2354 "Find file literally: " nil default-directory
2357 \f
2359 _after-find-file-from-revert-buffer
2360 nomodes)
2361 "Called after finding a file and by the default revert function.
2362 Sets buffer mode, parses local variables.
2363 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2364 error in reading the file. WARN non-nil means warn if there
2365 exists an auto-save file more recent than the visited file.
2366 NOAUTO means don't mess with auto-save mode.
2367 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2368 \(see `revert-buffer-in-progress-p' for similar functionality).
2369 Fifth arg NOMODES non-nil means don't alter the file's modes.
2370 Finishes by calling the functions in `find-file-hook'
2371 unless NOMODES is non-nil."
2374 nil
2384 "Symbolic link that points to nonexistent file"
2388 ;; No need to warn if buffer is auto-saved
2389 ;; under the name of the visited file.
2391 auto-save-visited-file-name))
2394 buffer-file-name))
2414 ;; Make people do a little extra work (C-x C-q)
2415 ;; before altering a backup file.
2418 ;; When a file is marked read-only,
2419 ;; make the buffer read-only even if root is looking at it.
2427 ;; If requested, add a newline at the end of the file.
2438 view-read-only
2446 "Choose the major mode for this buffer automatically.
2447 Also sets up any specified local variables of the file.
2448 Uses the visited file name, the -*- line, and the local variables spec.
2450 This function is called automatically from `find-file'. In that case,
2451 we may set up the file-specified mode and local variables,
2452 depending on the value of `enable-local-variables'.
2453 In addition, if `local-enable-local-variables' is nil, we do
2454 not set local variables (though we do notice a mode specified with -*-.)
2456 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2457 or from Lisp without specifying the optional argument FIND-FILE;
2458 in that case, this function acts as if `enable-local-variables' were t."
2465 ;; FIXME this is less efficient than it could be, since both
2466 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2469 ;; `delay-mode-hooks' being non-nil will have prevented the major
2470 ;; mode's call to `run-mode-hooks' from calling
2471 ;; `hack-local-variables'. In that case, call it now.
2475 ;; Turn font lock off and on, to make sure it takes account of
2476 ;; whatever file local variables are relevant to it.
2478 ;; Font-lock-mode (now in font-core.el) can be ON when
2479 ;; font-lock.el still hasn't been loaded.
2486 "Non-nil means to try second pass through `auto-mode-alist'.
2487 This means that if the first case-sensitive search through the alist fails
2488 to find a matching major mode, a second case-insensitive search is made.
2489 On systems with case-insensitive file names, this variable is ignored,
2490 since only a single case-insensitive search through the alist is made."
2496 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2497 ;; c++-mode, java-mode and more) are added through autoload
2498 ;; directives in that file. That way is discouraged since it
2499 ;; spreads out the definition of the initial value.
2545 ;; Less common extensions come here
2546 ;; so more common ones above are found faster.
2554 ;; Besides .gdbinit, gdb documents other names to be usable for init
2555 ;; files, cross-debuggers can use something like
2556 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2557 ;; don't interfere with each other.
2559 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2560 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2561 ;; loaded when GDB reads an objfile called 'emacs'.
2569 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2593 ;; The Fortran standard does not say anything about file extensions.
2594 ;; .f90 was widely used for F90, now we seem to be trapped into
2595 ;; using a different extension for each language revision.
2596 ;; Anyway, the following extensions are supported by gfortran.
2604 ;; The list of archive file extensions should be in sync with
2605 ;; `auto-coding-alist' with `no-conversion' coding system.
2611 ;; Mailer puts message to be edited in
2612 ;; /tmp/Re.... or Message
2615 ;; some news reader is reported to use this
2629 ;; .emacs or .gnus or .viper following a directory delimiter in
2630 ;; Unix or MS-DOS syntax.
2633 ;; _emacs following a directory delimiter in MS-DOS syntax
2637 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2638 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2639 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2642 ;; .xs is also used for ld scripts, but seems to be more commonly
2643 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2645 ;; Explained in binutils ld/genscripts.sh. Eg:
2646 ;; A .x script file is the default script.
2647 ;; A .xr script is for linking without relocation (-r flag). Etc.
2651 ;; Common Lisp ASDF package system.
2658 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2670 ;; Windows candidates may be opened case sensitively on Unix
2678 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2679 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2680 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2681 ;; this has lower priority to avoid matching changelog.sgml etc.
2683 ;; either user's dot-files or under /etc or some such
2685 ;; alas not all ~/.*rc files are like this
2686 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2691 ;; this contains everything twice, with space and with colon :-(
2693 ;; Get rid of any trailing .n.m and try again.
2694 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2695 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2696 ;; Using mode nil rather than `ignore' would let the search continue
2697 ;; through this list (with the shortened name) rather than start over.
2700 ;; This should come after "in" stripping (e.g. config.h.in).
2701 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2703 ;; The following should come after the ChangeLog pattern
2704 ;; for the sake of ChangeLog.1, etc.
2705 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2707 "Alist of filename patterns vs corresponding major mode functions.
2708 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2709 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2710 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2711 mode function to use. FUNCTION will be called, unless it is nil.
2713 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2714 calling FUNCTION (if it's not nil), we delete the suffix that matched
2715 REGEXP and search the list again for another match.
2717 The extensions whose FUNCTION is `archive-mode' should also
2718 appear in `auto-coding-alist' with `no-conversion' coding system.
2720 See also `interpreter-mode-alist', which detects executable script modes
2721 based on the interpreters they specify to run,
2726 "Select Conf mode or XML mode according to start of file."
2736 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2737 ;; and pike-mode) are added through autoload directives in that
2738 ;; file. That way is discouraged since it spreads out the
2739 ;; definition of the initial value.
2768 "Alist mapping interpreter names to major modes.
2769 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2770 Each element looks like (REGEXP . MODE).
2771 If REGEXP matches the entire name (minus any directory part) of
2772 the interpreter specified in the first line of a script, enable
2773 major mode MODE.
2780 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2781 ;; because we are duplicating info from auto-mode-alist.
2782 ;; TODO many elements of this list are also in auto-coding-alist.
2791 "List of regexps matching file names in which to ignore local variables.
2793 Files matching this list are typically binary file formats.
2794 They may happen to contain sequences that look like local variable
2795 specifications, but are not really, or they may be containers for
2796 member files with their own local variable sections, which are
2797 not appropriate for the containing file.
2804 "List of regexps matching suffixes to remove from file names.
2805 The function `inhibit-local-variables-p' uses this: when checking
2806 a file name, it first discards from the end of the name anything that
2809 ;; Can't think of any situation in which you'd want this to be nil...
2814 "Return non-nil if file local variables should be ignored.
2815 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2816 and `inhibit-local-variables-suffixes'. If
2817 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2826 sufs)
2831 temp))
2836 "Regexp matching interpreters, for file mode determination.
2837 This regular expression is matched against the first line of a file
2838 to determine the file's mode in `set-auto-mode'. If it matches, the file
2839 is assumed to be interpreted by the interpreter matched by the second group
2840 of the regular expression. The mode is then determined as the mode
2844 "Alist of buffer beginnings vs. corresponding major mode functions.
2845 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2846 After visiting a file, if REGEXP matches the text at the beginning of the
2847 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2848 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2849 major mode.
2851 If FUNCTION is nil, then it is not called. (That is a way of saying
2859 ;; The < comes before the groups (but the first) to reduce backtracking.
2860 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2861 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2865 comment-re "*"
2868 . mhtml-mode)
2870 ;; These two must come after html, because they are more general:
2875 . sgml-mode)
2878 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2879 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2880 After visiting a file, if REGEXP matches the text at the beginning of the
2881 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2882 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2883 have not specified a mode for this file.
2889 "Upper limit on `magic-mode-alist' regexp matches.
2893 "Select major mode appropriate for current buffer.
2895 To find the right major mode, this function checks for a -*- mode tag
2896 checks for a `mode:' entry in the Local Variables section of the file,
2897 checks if it uses an interpreter listed in `interpreter-mode-alist',
2898 matches the buffer beginning against `magic-mode-alist',
2899 compares the filename against the entries in `auto-mode-alist',
2900 then matches the buffer beginning against `magic-fallback-mode-alist'.
2902 If `enable-local-variables' is nil, or if the file name matches
2903 `inhibit-local-variables-regexps', this function does not check
2904 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2905 is nil, then the only mode: tag that can be relevant is a -*- one.
2907 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2908 set the major mode only if that would change it. In other words
2909 we don't actually set it to the same mode the buffer already has."
2910 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2912 end done mode modes)
2913 ;; Once we drop the deprecated feature where mode: is also allowed to
2914 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2915 ;; remove this section and just let (hack-local-variables t) handle it.
2916 ;; Find a -*- mode tag.
2920 ;; Note by design local-enable-local-variables does not matter here.
2922 try-locals
2925 ;; Find all specifications for the `mode:' variable
2926 ;; and execute them left to right.
2938 modes)))
2939 ;; Simple -*-MODE-*- case.
2942 modes))))
2943 ;; If we found modes to use, invoke them now, outside the save-excursion.
2951 ;; continuing would call minor modes again, toggling them off
2953 ;; hack-local-variables checks local-enable-local-variables etc, but
2954 ;; we might as well be explicit here for the sake of clarity.
2956 enable-local-variables
2957 local-enable-local-variables
2958 try-locals
2965 ;; If we didn't, look for an interpreter specified in the first line.
2966 ;; As a special case, allow for things like "#!/bin/env perl", which
2967 ;; finds the interpreter anywhere in $PATH.
2973 ;; Map interpreter name to a mode, signaling we're done at the
2974 ;; same time.
2981 interpreter-mode-alist)
2983 ;; If we found an interpreter mode to use, invoke it now.
2985 ;; Next try matching the buffer beginning against magic-mode-alist.
2994 nil magic-mode-alist
3003 "Problem in magic-mode-alist with element %s"
3004 re))))))))
3006 ;; Next compare the filename against the entries in auto-mode-alist.
3012 buffer-file-name)))
3013 ;; Remove backup-suffixes from file name.
3015 ;; Remove remote file name identification.
3020 ;; Find first matching alist entry.
3023 ;; Filesystem is case-insensitive.
3027 ;; Filesystem is case-sensitive.
3029 ;; First match case-sensitively.
3033 ;; Fallback to case-insensitive match.
3047 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
3064 "Problem with magic-fallback-mode-alist element: %s"
3065 re))))))))
3070 ;; When `keep-mode-if-same' is set, we are working on behalf of
3071 ;; set-visited-file-name. In that case, if the major mode specified is the
3072 ;; same one we already have, don't actually reset it. We don't want to lose
3073 ;; minor modes such as Font Lock.
3075 "Apply MODE and return it.
3076 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
3077 any aliases and compared to current major mode. If they are the
3078 same, do nothing and return nil."
3084 mode)))
3087 "Regexp of lines to skip when looking for file-local settings.
3088 If the first line matches this regular expression, then the -*-...-*- file-
3092 "Find the -*- spec in the buffer.
3093 Call with point at the place to start searching from.
3094 If one is found, set point to the beginning and return the position
3095 of the end. Otherwise, return nil; may change point.
3096 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3097 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3098 have no effect."
3101 ;; Don't look for -*- if this file name matches any
3102 ;; of the regexps in inhibit-local-variables-regexps.
3105 ;; If the file begins with "#!" (exec
3106 ;; interpreter magic), look for mode frobs
3107 ;; in the first two lines. You cannot
3108 ;; necessarily put them in the first line
3109 ;; of such a file without screwing up the
3110 ;; interpreter invocation. The same holds
3111 ;; for '\" in man pages (preprocessor
3112 ;; magic for the `man' program).
3123 end))))
3124 \f
3125 ;;; Handling file local variables
3129 file-local-variables-alist dir-local-variables-alist)
3134 "Normal hook run after processing a file's local variables specs.
3135 Major modes can use this to examine user-specified local variables
3139 "List variable-value pairs that are considered safe.
3140 Each element is a cons cell (VAR . VAL), where VAR is a variable
3141 symbol and VAL is a value that is considered safe."
3142 :risky t
3147 ;; This should be here at least as long as Emacs supports write-file-hooks.
3152 "Expressions that are considered safe in an `eval:' local variable.
3153 Add expressions to this list if you want Emacs to evaluate them, when
3154 they appear in an `eval' local variable specification, without first
3155 asking you for confirmation."
3156 :risky t
3161 ;; Risky local variables:
3164 buffer-auto-save-file-name
3165 buffer-file-name
3166 buffer-file-truename
3167 buffer-undo-list
3168 debugger
3169 default-text-properties
3170 eval
3171 exec-directory
3172 exec-path
3173 file-name-handler-alist
3174 frame-title-format
3175 global-mode-string
3176 header-line-format
3177 icon-title-format
3178 inhibit-quit
3179 load-path
3180 max-lisp-eval-depth
3181 max-specpdl-size
3182 minor-mode-map-alist
3183 minor-mode-overriding-map-alist
3184 mode-line-format
3185 mode-name
3186 overriding-local-map
3187 overriding-terminal-local-map
3188 process-environment
3189 standard-input
3190 standard-output
3191 unread-command-events))
3193 ;; Safe local variables:
3194 ;;
3195 ;; For variables defined by major modes, the safety declarations can go into
3196 ;; the major mode's file, since that will be loaded before file variables are
3197 ;; processed.
3198 ;;
3199 ;; For variables defined by minor modes, put the safety declarations in the
3200 ;; file defining the minor mode after the defcustom/defvar using an autoload
3201 ;; cookie, e.g.:
3202 ;;
3203 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3204 ;;
3205 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3206 ;; minor mode file may not be loaded yet.
3207 ;;
3208 ;; For variables defined in the C source code the declaration should go here:
3230 "Alist of file-local variable settings in the current buffer.
3231 Each element in this list has the form (VAR . VALUE), where VAR
3232 is a file-local variable (a symbol) and VALUE is the value
3233 specified. The actual value in the buffer may differ from VALUE,
3239 "Alist of directory-local variable settings in the current buffer.
3240 Each element in this list has the form (VAR . VALUE), where VAR
3241 is a directory-local variable (a symbol) and VALUE is the value
3242 specified in .dir-locals.el. The actual value in the buffer
3243 may differ from VALUE, if it is changed by the major or minor modes,
3248 "Normal hook run before setting file-local variables.
3249 It is called after checking for unsafe/risky variables and
3250 setting `file-local-variables-alist', and before applying the
3251 variables stored in `file-local-variables-alist'. A hook
3252 function is allowed to change the contents of this alist.
3254 This hook is called only if there is at least one file-local
3258 "Get confirmation before setting up local variable values.
3259 ALL-VARS is the list of all variables to be set up.
3260 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3261 RISKY-VARS is the list of those that are marked as risky.
3262 If these settings come from directory-local variables, then
3263 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3270 unsafe-vars))
3272 ;; Set up the contents of the *Local Variables* buffer.
3280 ", and variables that are risky (**)."
3288 y -- to apply the local variables list.
3292 ! -- to apply the local variables list, and permanently mark these
3304 ;; Make strings with embedded whitespace easier to read.
3312 ;; Display the buffer and read a choice.
3320 ""
3323 char)
3342 "Return local variables specified in the -*- line.
3343 Usually returns an alist of elements (VAR . VAL), where VAR is a
3344 variable and VAL is the specified value. Ignores any
3345 specification for `coding:', and sometimes for `mode' (which
3346 should have already been handled by `set-auto-coding' and
3347 `set-auto-mode', respectively). Return nil if the -*- line is
3348 malformed.
3350 If HANDLE-MODE is nil, we return the alist of all the local
3351 variables in the line except `coding' as described above. If it
3352 is neither nil nor t, we do the same, except that any settings of
3353 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3354 all settings in the line except for `mode', which \(if present) we
3355 return as the symbol specifying the mode."
3360 result)
3362 nil)
3364 ;; Simple form: "-*- MODENAME -*-".
3368 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3369 ;; (last ";" is optional).
3370 ;; If HANDLE-MODE is t, just check for `mode'.
3371 ;; Otherwise, parse the -*- line into the RESULT alist.
3379 ;; There used to be a downcase here,
3380 ;; but the manual didn't say so,
3381 ;; and people want to set var names that aren't all lc.
3387 ;; It is traditional to ignore
3388 ;; case when checking for `mode' in set-auto-mode,
3389 ;; so we must do that here as well.
3390 ;; That is inconsistent, but we're stuck with it.
3391 ;; The same can be said for `coding' in set-auto-coding.
3405 ;; Downcase "Mode:".
3408 val)
3409 result)
3412 result))))))
3415 "Filter local variable settings, querying the user if necessary.
3416 VARIABLES is the alist of variable-value settings. This alist is
3417 filtered based on the values of `ignored-local-variables',
3418 `enable-local-eval', `enable-local-variables', and (if necessary)
3419 user interaction. The results are added to
3420 `file-local-variables-alist', without applying them.
3421 If these settings come from directory-local variables, then
3422 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3423 ;; Find those variables that we may want to save to
3424 ;; `safe-local-variable-values'.
3430 ;; Ignore any variable in `ignored-local-variables'.
3431 nil)
3432 ;; Obey `enable-local-eval'.
3436 ;; In case previously marked safe (bug#5636).
3438 ;; If not safe and e-l-v = :safe, ignore totally.
3442 safe
3444 ;; Ignore duplicates (except `mode') in the present list.
3446 ;; Accept known-safe variables.
3450 ;; The variable is either risky or unsafe:
3457 ;; Query, unless all vars are safe or user wants no querying.
3463 risky-vars dir-name))
3473 ;; TODO? Warn once per file rather than once per session?
3477 "Parse and put into effect this buffer's local variables spec.
3478 Uses `hack-local-variables-apply' to apply the variables.
3480 If HANDLE-MODE is nil, we apply all the specified local
3481 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3482 except that any settings of `mode' are ignored.
3485 is specified, and return the corresponding mode symbol, or nil.
3486 In this case, we try to ignore minor-modes, and only return a
3487 major-mode.
3489 If `enable-local-variables' or `local-enable-local-variables' is nil,
3490 this function does nothing. If `inhibit-local-variables-regexps'
3491 applies to the file in question, the file is not scanned for
3492 local variables, but directory-local variables may still be applied."
3493 ;; We don't let inhibit-local-variables-p influence the value of
3494 ;; enable-local-variables, because then it would affect dir-local
3495 ;; variables. We don't want to search eg tar files for file local
3496 ;; variable sections, but there is no reason dir-locals cannot apply
3497 ;; to them. The real meaning of inhibit-local-variables-p is "do
3498 ;; not scan this file for local variables".
3501 result)
3505 ;; Note this is a no-op if enable-local-variables is nil.
3507 ;; This entire function is basically a no-op if enable-local-variables
3508 ;; is nil. All it does is set file-local-variables-alist to nil.
3510 ;; This part used to ignore enable-local-variables when handle-mode
3511 ;; was t. That was inappropriate, eg consider the
3512 ;; (artificial) example of:
3513 ;; (setq local-enable-local-variables nil)
3514 ;; Open a file foo.txt that contains "mode: sh".
3515 ;; It correctly opens in text-mode.
3516 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3518 ;; If HANDLE-MODE is t, and the prop line specifies a
3519 ;; mode, then we're done, and have no need to scan further.
3521 handle-mode))
3523 ;; Look for "Local variables:" line in last page.
3531 ;; suffix is what comes after "local variables:" in its line.
3532 ;; prefix is what comes before "local variables:" in its line.
3545 endpos
3551 nil t))
3552 ;; This used to be an error, but really all it means is
3553 ;; that this may simply not be a local-variables section,
3554 ;; so just ignore it.
3564 ;; Discard the prefix.
3569 ;; Discard the suffix.
3578 ;; Find the variable name;
3586 val val2)
3589 ;; Read the variable value.
3596 ;; Specifying minor-modes via mode: is
3597 ;; deprecated, but try to reject them anyway.
3607 'files
3609 "%s: `lexical-binding' at end of file unreliable"
3611 ;; We are called from
3612 ;; 'with-temp-buffer', so we need
3613 ;; to use 'thisbuf's name in the
3614 ;; warning message.
3620 'eval
3624 ;; Now we've read all the local variables.
3625 ;; If HANDLE-MODE is t, return whether the mode was specified.
3627 ;; Otherwise, set the variables.
3632 "Apply the elements of `file-local-variables-alist'.
3633 If there are any elements, runs `before-hack-local-variables-hook',
3634 then calls `hack-one-local-variable' to apply the alist elements one by one.
3635 Finishes by running `hack-local-variables-hook', regardless of whether
3636 the alist is empty or not.
3638 Note that this function ignores a `mode' entry if it specifies the same
3639 major mode as the buffer already has."
3641 ;; Any 'evals must run in the Right sequence.
3650 "Non-nil if SYM is safe as a file-local variable with value VAL.
3651 It is safe if any of these conditions are met:
3653 * There is a matching entry (SYM . VAL) in the
3654 `safe-local-variable-values' user option.
3656 * The `safe-local-variable' property of SYM is a function that
3657 evaluates to a non-nil value with VAL as an argument."
3661 ;; If the function signals an error, that means it
3662 ;; can't assure us that the value is safe.
3666 "Non-nil if SYM could be dangerous as a file-local variable.
3667 It is dangerous if either of these conditions are met:
3669 * Its `risky-local-variable' property is non-nil.
3675 ;; If this is an alias, check the base name.
3695 "Return t if it is safe to eval EXP when it is found in a file."
3697 ;; Detect certain `put' expressions.
3704 lisp-indent-function
3705 scheme-indent-function))
3706 ;; Only allow safe values (not functions).
3711 ;; Only allow indirect form specs.
3712 ;; During bootstrapping, edebug-basic-spec might not be
3713 ;; defined yet.
3717 ;; Allow expressions that the user requested.
3719 ;; Certain functions can be allowed with safe arguments
3720 ;; or can specify verification functions to try.
3722 ;; Allow (minor)-modes calls with no arguments.
3723 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3732 ok))
3740 ok))))))))
3754 "Set local variable VAR with value VAL.
3755 If VAR is `mode', call `VAL-mode' as a function unless it's
3756 already the major mode."
3758 (`mode
3764 (`eval
3770 ;; Make sure the string has no text properties.
3771 ;; Some text properties can get evaluated in various ways,
3772 ;; so it is risky to put them on with a local variable list.
3776 \f
3777 ;;; Handling directory-local variables, aka project settings.
3783 "List of cached directory roots for directory-local variable classes.
3784 Each element in this list has the form (DIR CLASS MTIME).
3785 DIR is the name of the directory.
3786 CLASS is the name of a variable class (a symbol).
3787 MTIME is the recorded modification time of the directory-local
3788 variables file associated with this entry. This time is a list
3789 of integers (the same format as `file-attributes'), and is
3790 used to test whether the cache entry is still valid.
3791 Alternatively, MTIME can be nil, which means the entry is always
3795 "Return the variable list for CLASS."
3799 "Collect directory-local variables from MODE-VARIABLES.
3800 VARIABLES is the initial list of variables.
3801 Returns the new list."
3806 ;; If variables are specified more than once, only use the last. (Why?)
3807 ;; The pseudo-variables mode and eval are different (bug#3430).
3810 ;; Need a new cons in case we setcdr later.
3814 "Collect entries from CLASS-VARIABLES into VARIABLES.
3815 ROOT is the root directory of the project.
3816 Return the new variables list."
3818 ;; Handle non-file buffers, too.
3822 ;; FIXME: Why not use file-relative-name?
3829 ;; Don't include this in the previous condition, because we
3830 ;; want to filter all strings before the next condition.
3844 ;; TODO someone might want to extend this to allow
3845 ;; integer values for subdir, where N means
3846 ;; variables apply to this directory and N levels
3847 ;; below it (0 == nil).
3850 alist variables))))))))
3852 ;; The file's content might be invalid (e.g. have a merge conflict), but
3853 ;; that shouldn't prevent the user from opening the file.
3855 nil))))
3858 "Declare that the DIRECTORY root is an instance of CLASS.
3859 DIRECTORY is the name of a directory, a string.
3860 CLASS is the name of a project class, a symbol.
3861 MTIME is either the modification time of the directory-local
3862 variables file that defined this class, or nil.
3864 When a file beneath DIRECTORY is visited, the mode-specific
3865 variables from CLASS are applied to the buffer. The variables
3866 for a class are defined using `dir-locals-set-class-variables'."
3873 "Map the type CLASS to a list of variable settings.
3874 CLASS is the project class, a symbol. VARIABLES is a list
3875 that declares directory-local variables for the class.
3876 An element in VARIABLES is either of the form:
3877 (MAJOR-MODE . ALIST)
3878 or
3879 (DIRECTORY . LIST)
3881 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3882 whose elements are of the form (VARIABLE . VALUE).
3884 In the second form, DIRECTORY is a directory name (a string), and
3885 LIST is a list of the form accepted by the function.
3887 When a file is visited, the file's class is found. A directory
3888 may be assigned a class using `dir-locals-set-directory-class'.
3889 Then variables are set in the file's buffer according to the
3890 VARIABLES list of the class. The list is processed in order.
3892 * If the element is of the form (MAJOR-MODE . ALIST), and the
3893 buffer's major mode is derived from MAJOR-MODE (as determined
3894 by `derived-mode-p'), then all the variables in ALIST are
3895 applied. A MAJOR-MODE of nil may be used to match any buffer.
3896 `make-local-variable' is called for each variable before it is
3897 set.
3899 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3900 is an initial substring of the file's directory, then LIST is
3901 applied by recursively following these rules."
3905 "File that contains directory-local variables.
3906 It has to be constant to enforce uniform values across different
3907 environments and users.
3909 A second dir-locals file can be used by a user to specify their
3910 personal dir-local variables even if the current directory
3911 already has a `dir-locals-file' that is shared with other
3912 users (such as in a git repository). The name of this second
3914 `dir-locals-file'. With the default value of `dir-locals-file',
3921 "Return a list of all readable dir-locals files in DIRECTORY.
3922 The returned list is sorted by increasing priority. That is,
3923 values specified in the last file should take precedence over
3924 those in the first."
3928 dir-locals-file)
3929 directory))
3933 ;; The order here is important.
3940 out)))
3943 "Find the directory-local variables for FILE.
3944 This searches upward in the directory tree from FILE.
3945 It stops at the first directory that has been registered in
3946 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3947 If it finds an entry in the cache, it checks that it is valid.
3948 A cache entry with no modification time element (normally, one that
3949 has been assigned directly using `dir-locals-set-directory-class', not
3950 set from a file) is always valid.
3951 A cache entry based on a `dir-locals-file' is valid if the modification
3952 time stored in the cache matches the current file modification time.
3953 If not, the cache entry is cleared so that the file will be re-read.
3955 This function returns either:
3956 - nil (no directory local variables found),
3957 - the matching entry from `dir-locals-directory-cache' (a list),
3958 - or the full path to the directory (a string) containing at
3959 least one `dir-locals-file' in the case of no valid cache
3960 entry."
3964 dir-elt)
3965 ;; `locate-dominating-file' may have abbreviated the name.
3968 ;; Find the best cached value in `dir-locals-directory-cache'.
3979 ;; Found a potential cache entry. Check validity.
3980 ;; A cache entry with no MTIME is assumed to always be valid
3981 ;; (ie, set directly, not from a dir-locals file).
3982 ;; Note, we don't bother to check that there is a matching class
3983 ;; element in dir-locals-class-alist, since that's done by
3984 ;; dir-locals-set-directory-class.
3987 ;; The entry MTIME should match the most recent
3988 ;; MTIME among matching files.
3996 ;; This cache entry is OK.
3997 dir-elt
3998 ;; This cache entry is invalid; clear it.
4001 ;; Return the first existing dir-locals file. Might be the same
4002 ;; as dir-elt's, might not (eg latter might have been deleted).
4003 locals-dir)
4004 ;; No cache entry.
4005 locals-dir)))
4008 "Load all variables files in DIR and register a new class and instance.
4009 DIR is the absolute name of a directory which must contain at
4010 least one dir-local file (which is a file holding variables to
4011 apply).
4012 Return the new class name, which is a symbol named DIR."
4017 ;; If there was a problem, use the values we could get but
4018 ;; don't let the cache prevent future reads.
4031 variables
4037 class-name))
4043 "Non-nil means dir-local variables will be applied to remote files."
4051 "Read per-directory local variables for the current buffer.
4052 Store the directory-local variables in `dir-local-variables-alist'
4053 and `file-local-variables-alist', without applying them.
4055 This does nothing if either `enable-local-variables' or
4056 `enable-dir-local-variables' are nil."
4058 enable-dir-local-variables
4061 default-directory)))))
4062 ;; Find the variables file.
4092 "Apply directory-local variables to a non-file buffer.
4093 For non-file buffers, such as Dired buffers, directory-local
4094 variables are looked for in `default-directory' and its parent
4095 directories."
4099 \f
4102 However, the mode will not be changed if
4103 \(1) a local variables list or the `-*-' line specifies a major mode, or
4105 not suitable for ordinary files, or
4106 \(3) the new file name does not particularly specify any mode."
4111 "Change name of file visited in current buffer to FILENAME.
4112 This also renames the buffer to correspond to the new file.
4113 The next time the buffer is saved it will go in the newly specified file.
4114 FILENAME nil or an empty string means mark buffer as not visiting any file.
4115 Remember to delete the initial contents of the minibuffer
4116 if you wish to pass an empty string as the argument.
4118 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4119 confirmation in the case where another buffer is already visiting FILENAME.
4121 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4122 the old visited file has been renamed to the new name FILENAME."
4130 nil
4145 filename)))
4152 buffer-file-name filename)
4156 ;; If new-name == old-name, renaming would add a spurious <2>
4157 ;; and it's considered as a feature in rename-buffer.
4163 ;; Abbreviate the file names of the buffer.
4172 nil))
4173 ;; write-file-functions is normally used for things like ftp-find-file
4174 ;; that visit things that are not local files as if they were files.
4175 ;; Changing to visit an ordinary local file instead should flush the hook.
4180 ;; If buffer was read-only because of version control,
4181 ;; that reason is gone now, so make it writable.
4185 ;; Turn off backup files for certain file names.
4186 ;; Since this is a permanent local, the major mode won't eliminate it.
4188 backup-enable-predicate
4197 ;; If auto-save was not already on, turn it on if appropriate.
4200 ;; If auto save is on, start using a new name. We
4201 ;; deliberately don't rename or delete the old auto save
4202 ;; for the old visited file name. This is because
4203 ;; perhaps the user wants to save the new state and then
4204 ;; compare with the previous state from the auto save
4205 ;; file.
4207 ;; Rename the old auto save file if any.
4214 ;; Update the major mode, if the file name determines it.
4216 ;; Don't change the mode if it is special.
4219 ;; Don't change the mode if the local variable list specifies it.
4220 ;; The file name can influence whether the local variables apply.
4222 ;; h-l-v also checks it, but might as well be explicit.
4225 ;; TODO consider making normal-mode handle this case.
4233 "Write current buffer into file FILENAME.
4234 This makes the buffer visit that file, and marks it as not modified.
4236 If you specify just a directory name as FILENAME, that means to use
4237 the default file name but in that directory. You can also yank
4238 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4240 If the buffer is not already visiting a file, the default file name
4241 for the output file is the buffer name.
4243 If optional second arg CONFIRM is non-nil, this function
4244 asks for confirmation before overwriting an existing file.
4245 Interactively, confirmation is required unless you supply a prefix argument."
4246 ;; (interactive "FWrite file: ")
4250 nil nil nil nil)
4254 default-directory)
4255 nil nil))
4259 ;; If arg is a directory name,
4260 ;; use the default file name, but in that directory.
4267 ;; NS does its own confirm dialog.
4270 use-dialog-box))
4276 ;; Make buffer writable if file is writable.
4281 ;; It's likely that the VC status at the new location is different from
4282 ;; the one at the old location.
4284 \f
4286 "Return an alist of extended attributes of file FILENAME.
4288 Extended attributes are platform-specific metadata about the file,
4289 such as SELinux context, list of ACL entries, etc."
4294 "Set extended attributes of file FILENAME to ATTRIBUTES.
4296 ATTRIBUTES must be an alist of file attributes as returned by
4297 `file-extended-attributes'.
4298 Value is t if the function succeeds in setting the attributes."
4309 result))
4310 \f
4312 "Make a backup of the disk file visited by the current buffer, if appropriate.
4313 This is normally done before saving the buffer the first time.
4315 A backup may be done by renaming or by copying; see documentation of
4316 variable `make-backup-files'. If it's done by renaming, then the file is
4317 no longer accessible under its old name.
4319 The value is non-nil after a backup was made by renaming.
4320 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4321 MODES is the result of `file-modes' on the original
4322 file; this means that the caller, after saving the buffer, should change
4323 the modes of the new file to agree with the old modes.
4324 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4325 on the original file; this means that the caller, after saving
4326 the buffer, should change the extended attributes of the new file
4327 to agree with the old attributes.
4328 BACKUPNAME is the backup file name, which is the old file renamed."
4332 ;; If specified name is a symbolic link, chase it to the target.
4333 ;; This makes backups in the directory where the real file is.
4340 ;; If have old versions to maybe delete,
4341 ;; ask the user to confirm now, before doing anything.
4342 ;; But don't actually delete til later.
4348 real-file-name)))
4349 targets))
4354 backup-by-copying-when-privileged-mismatch)
4357 ;; Don't rename a suid or sgid file.
4366 real-file-name
4369 copy-when-priv-mismatch))))
4371 t)))))
4372 setmodes)
4375 ;; Actually make the backup file.
4378 modes extended-attributes)
4379 ;; rename-file should delete old backup.
4382 backupname)))
4384 ;; Now delete the old versions, if desired.
4388 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4392 backupname)
4395 modes extended-attributes)
4397 setmodes)))))))
4400 ;; Create temp files with strict access rights. It's easy to
4401 ;; loosen them later, whereas it's impossible to close the
4402 ;; time-window of loose permissions otherwise.
4405 ;; Try to overwrite old backup first.
4413 nil)
4415 ;; The file was somehow created by someone else between
4416 ;; `delete-file' and `copy-file', so let's try again.
4417 ;; rms says "I think there is also a possible race
4418 ;; condition for making backup files" (emacs-devel 20070821).
4419 nil)))
4420 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4429 ;; The last ~[[:digit]]+ matches relative versions in git,
4430 ;; e.g. `foo.js.~HEAD~1~'.
4431 "Regular expression matching the backup/version part of a file name.
4435 "Return file NAME sans backup versions or strings.
4436 This is a separate procedure so your site-init or startup file can
4437 redefine it.
4438 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4439 we do not remove backup version numbers, only true file version numbers.
4440 See also `file-name-version-regexp'."
4447 name))))))
4450 "Return t if deleting FILE and rewriting it would preserve the owner.
4451 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4452 the group would be preserved too."
4457 ;; Return t if the file doesn't exist, since it's true that no
4458 ;; information would be lost by an (attempted) delete and create.
4461 ;; Files created on Windows by Administrator (RID=500)
4462 ;; have the Administrators group (RID=544) recorded as
4463 ;; their owner. Rewriting them will still preserve the
4464 ;; owner.
4468 ;; On BSD-derived systems files always inherit the parent
4469 ;; directory's group, so skip the group-gid test.
4475 ;; On some systems, a file created in a setuid directory
4476 ;; inherits that directory's owner.
4480 ;; On many systems, a file created in a setgid directory
4481 ;; inherits that directory's group. On some systems
4482 ;; this happens even if the setgid bit is not set.
4489 The extension, in a file name, is the part that begins with the last `.',
4490 except that a leading `.' of the file name, if there is one, doesn't count."
4493 directory)
4497 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4498 ;; we don't want to expand it.
4501 filename))))
4505 The extension, in a file name, is the part that begins with the last `.',
4506 excluding version numbers and backup suffixes, except that a leading `.'
4507 of the file name, if there is one, doesn't count.
4508 Return nil for extensionless file names such as `foo'.
4509 Return the empty string for file names such as `foo.'.
4511 By default, the returned value excludes the period that starts the
4512 extension, but if the optional argument PERIOD is non-nil, the period
4513 is included in the value, and in that case, if FILENAME has no
4524 "Return the base name of the FILENAME: no directory, no extension."
4530 #'make-backup-file-name--default-function
4531 "A function that `make-backup-file-name' uses to create backup file names.
4532 The function receives a single argument, the original file name.
4534 If you change this, you may need to change `backup-file-name-p' and
4535 `file-name-sans-versions' too.
4537 You could make this buffer-local to do something special for specific files.
4539 For historical reasons, a value of nil means to use the default function.
4540 This should not be relied upon.
4542 See also `backup-directory-alist'."
4549 "Alist of filename patterns and backup directory names.
4550 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4551 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4552 relative or absolute. If it is absolute, so that all matching files
4553 are backed up into the same directory, the file names in this
4554 directory will be the full name of the file backed up with all
4555 directory separators changed to `!' to prevent clashes. This will not
4556 work correctly if your filesystem truncates the resulting name.
4558 For the common case of all backups going into one directory, the alist
4560 directory name.
4562 If this variable is nil, or it fails to match a filename, the backup
4563 is made in the original file's directory.
4565 On MS-DOS filesystems without long names this variable is always
4566 ignored."
4572 "Default `backup-enable-predicate' function.
4573 Checks for files in `temporary-file-directory',
4576 caseless)
4577 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4578 ;; their long file-name equivalents, so compare-strings does TRT.
4582 caseless t))
4585 ;; Directory is under temporary-file-directory.
4590 ;; Directory is under /tmp.
4595 0 nil
4597 ;; Directory is under small-temporary-file-directory.
4602 "Create the non-numeric backup file name for FILE.
4603 This calls the function that `make-backup-file-name-function' specifies,
4604 with a single argument FILE."
4607 file))
4610 "Default function for `make-backup-file-name'.
4611 Normally this just returns FILE's name with `~' appended.
4612 It searches for a match for FILE in `backup-directory-alist'.
4613 If the directory for the backup doesn't exist, it is created."
4625 "Subroutine of `make-backup-file-name--default-function'.
4626 The function `find-backup-file-name' also uses this."
4628 elt backup-directory abs-backup-directory)
4633 alist nil)))
4634 ;; If backup-directory is relative, it should be relative to the
4635 ;; file's directory. By expanding explicitly here, we avoid
4636 ;; depending on default-directory.
4645 abs-backup-directory nil))))
4647 file
4651 ;; Normalize DOSish file names: downcase the drive
4652 ;; letter, if any, and replace the leading "x:" with
4653 ;; "/drive_x".
4658 ;; Remove the leading slash, if any, to prevent
4659 ;; convert-standard-filename from converting that to a
4660 ;; backslash.
4663 ;; Replace any invalid file-name characters, then
4664 ;; prepend the leading slash back.
4667 ;; Replace any invalid file-name characters.
4671 "drive_"
4674 ""
4677 ;; Make the name unique by substituting directory
4678 ;; separators. It may not really be worth bothering about
4679 ;; doubling `!'s in the original name...
4684 backup-directory))
4689 "Return non-nil if FILE is a backup file name (numeric or not).
4690 This is a separate function so you can redefine it for customization.
4691 You may need to redefine `file-name-sans-versions' as well."
4696 ;; This is used in various files.
4697 ;; The usage of backup-extract-version-start is not very clean,
4698 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4700 "Given the name of a numeric backup file, FN, return the backup number.
4701 Uses the free variable `backup-extract-version-start', whose value should be
4702 the index in the name where the version number begins."
4709 "Find a file name for a backup file FN, and suggestions for deletions.
4710 Value is a list whose car is the name for the backup file
4711 and whose cdr is a list of old versions to consider deleting now.
4712 If the value is nil, don't make a backup.
4713 Uses `backup-directory-alist' in the same way as
4714 `make-backup-file-name--default-function' does."
4716 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4720 ;; We don't support numbered backups on plain MS-DOS
4721 ;; when long file names are unavailable.
4731 possibilities deserve-versions-p versions)
4734 base-versions
4737 possibilities)
4738 #'<)
4743 kept-old-versions
4744 kept-new-versions
4751 ;; Delete nothing if there is overflow
4752 ;; in the number of versions to keep.
4758 v))))))))))
4761 "Return number of names file FILENAME has."
4765 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4766 This function returns a relative file name which is equivalent to FILENAME
4767 when used with that default directory as the default.
4768 If FILENAME is a relative file name, it will be interpreted as existing in
4769 `default-directory'.
4770 If FILENAME and DIRECTORY lie on different machines or on different drives
4771 on a DOS/Windows machine, it returns FILENAME in expanded form."
4775 default-directory))))
4780 read-file-name-completion-ignore-case)))
4783 ;; Test for different filesystems on DOS/Windows
4785 ;; Should `cygwin' really be included here? --stef
4788 ;; Test for different drive letters
4790 ;; Test for UNCs on different servers
4795 ;; Windows file names cannot have ? in
4796 ;; them, so use that to detect when
4797 ;; neither FILENAME nor DIRECTORY is a
4798 ;; UNC.
4800 0 nil
4806 ;; Test for different remote file system identification
4808 filename
4816 ".."
4818 ;; Now ancestor is empty, or .., or ../.., etc.
4820 ;; We matched within FILENAME's directory part.
4821 ;; Add the rest of FILENAME onto ANCESTOR.
4824 ;; But don't bother with ANCESTOR if it would give us `./'.
4825 rest
4827 ;; We matched FILENAME's directory equivalent.
4828 ancestor))))))
4829 \f
4831 "Save current buffer in visited file if modified.
4832 Variations are described below.
4834 By default, makes the previous version into a backup file
4835 if previously requested or if this is the first save.
4837 to become a backup when the next save is done.
4839 makes the previous version into a backup file.
4841 to become a backup when the next save is done,
4842 and makes the previous version into a backup file.
4844 With a numeric prefix argument of 0, never make the previous version
4845 into a backup file.
4847 Note that the various variables that control backups, such
4848 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4849 and `backup-inhibited', to name just the more popular ones, still
4850 control whether a backup will actually be produced, even when you
4853 If a file's name is FOO, the names of its numbered backup versions are
4854 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4855 Numeric backups (rather than FOO~) will be made if value of
4856 `version-control' is not the atom `never' and either there are already
4857 numeric versions of the file being backed up, or `version-control' is
4858 non-nil.
4859 We don't want excessive versions piling up, so there are variables
4860 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4861 and `kept-new-versions', which tells how many newest versions to keep.
4862 Defaults are 2 old versions and 2 new.
4863 `dired-kept-versions' controls dired's clean-directory (.) command.
4864 If `delete-old-versions' is nil, system will query user
4865 before trimming versions. Otherwise it does it silently.
4867 If `vc-make-backup-files' is nil, which is the default,
4868 no backup files are made for files managed by version control.
4869 (This is because the version control system itself records previous versions.)
4871 See the subroutine `basic-save-buffer' for more information."
4877 ;; We used to display the message below only for files > 50KB, but
4878 ;; then Rmail-mbox never displays it due to buffer swapping. If
4879 ;; the test is ever re-introduced, be sure to handle saving of
4880 ;; Rmail files.
4890 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4891 Normally delete only if the file was written by this Emacs since
4892 the last real save, but optional arg FORCE non-nil means delete anyway."
4906 "Normal hook that is run before a buffer is saved to its file.
4907 Only used by `save-buffer'."
4913 "Normal hook that is run after a buffer is saved to its file.
4914 Only used by `save-buffer'."
4920 "If non-nil, use this coding system for saving the buffer.
4921 More precisely, use this coding system in place of the
4922 value of `buffer-file-coding-system', when saving the buffer.
4923 Calling `write-region' for any purpose other than saving the buffer
4924 will still use `buffer-file-coding-system'; this variable has no effect
4931 "Save the current buffer in its visited file, if it has been modified.
4933 The hooks `write-contents-functions', `local-write-file-hooks'
4934 and `write-file-functions' get a chance to do the job of saving;
4935 if they do not, then the buffer is saved in the visited file in
4936 the usual way.
4938 Before and after saving the buffer, this function runs
4939 `before-save-hook' and `after-save-hook', respectively."
4942 ;; In an indirect buffer, save its base buffer instead.
4946 ;; Handle the case when no modification has been made but
4947 ;; the file disappeared since visited.
4951 setmodes)
4957 "%s has changed since visited or saved. Save anyway? "
4978 ;; Don't let errors prevent saving the buffer.
4980 ;; Give `write-contents-functions' a chance to
4981 ;; short-circuit the whole process.
4983 ;; If buffer has no file name, ask user for one.
4991 ;; Signal an error if the user specified the name of an
4992 ;; existing directory.
4995 "File `%s' exists; overwrite? "
4996 filename))
4999 ;; Support VC version backups.
5003 ;; If a hook returned t, file is already "written".
5004 ;; Otherwise, write it the usual way now.
5014 ;; Now we have saved the current buffer. Let's make sure
5015 ;; that buffer-file-coding-system is fixed to what
5016 ;; actually used for saving by binding it locally.
5032 ;; Support VC `implicit' locking.
5034 ;; If the auto-save file was recent before this command,
5035 ;; delete it now.
5042 ;; This does the "real job" of writing a buffer into its visited file
5043 ;; and making a backup file. This is what is normally done
5044 ;; but inhibited if one of write-file-functions returns non-nil.
5045 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5046 ;; backup-buffer.
5056 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
5057 ;; backup-buffer.
5070 "File %s is write-protected; try to save anyway? "
5072 buffer-file-name)))
5086 dir))))
5087 ;; Write temp name, then rename it.
5088 ;; This requires write access to the containing dir,
5089 ;; which is why we don't try it if we don't have that access.
5091 tempname
5093 ;; Create temp files with strict access rights. It's easy to
5094 ;; loosen them later, whereas it's impossible to close the
5095 ;; time-window of loose permissions otherwise.
5099 ;; Call write-region in the appropriate way
5100 ;; for saving the buffer.
5104 ;; Pass in nil&nil rather than point-min&max
5105 ;; cause we're saving the whole buffer.
5106 ;; write-region-annotate-functions may use it.
5108 buffer-file-truename)
5110 ;; If we failed, restore the buffer's modtime.
5113 ;; Since we have created an entirely new file,
5114 ;; make sure it gets the right permission bits set.
5119 buffer-file-name)))
5120 ;; We succeeded in writing the temp file,
5121 ;; so rename it.
5123 ;; If file not writable, see if we can make it writable
5124 ;; temporarily while we write it.
5125 ;; But no need to do so if we have just backed it up
5126 ;; (setmodes is set) because that says we're superseding.
5128 ;; Change the mode back, after writing.
5131 buffer-file-name))
5132 ;; If set-file-extended-attributes fails, fall back on
5133 ;; set-file-modes.
5143 ;; Pass in nil&nil rather than point-min&max to indicate
5144 ;; we're saving the buffer rather than just a region.
5145 ;; write-region-annotate-functions may make use of it.
5147 buffer-file-name nil t buffer-file-truename)
5150 ;; If we get an error writing the new file, and we made
5151 ;; the backup by renaming, undo the backing-up.
5156 setmodes))
5162 `((?\C-r
5169 ;; Return nil to ask about BUF again.
5170 nil)
5183 ;; Return nil to ask about BUF again.
5184 nil)
5194 "Default predicate for `save-some-buffers'.
5195 This allows you to stop `save-some-buffers' from asking
5196 about certain files that you'd usually rather not save."
5202 "Save some modified file-visiting buffers. Asks user about each one.
5203 You can answer `y' to save, `n' not to save, `C-r' to look at the
5204 buffer in question with `view-buffer' before deciding or `d' to
5205 view the differences using `diff-buffer-with-file'.
5207 This command first saves any buffers where `buffer-save-without-query' is
5208 non-nil, without asking.
5210 Optional argument (the prefix) non-nil means save all with no questions.
5211 Optional second argument PRED determines which buffers are considered:
5212 If PRED is nil, all the file-visiting buffers are considered.
5213 If PRED is t, then certain non-file buffers will also be considered.
5214 If PRED is a zero-argument function, it indicates for each buffer whether
5215 to consider it or not when called with that buffer current.
5216 PRED defaults to the value of `save-some-buffers-default-predicate'.
5218 See `save-some-buffers-action-alist' if you want to
5219 change the additional actions you can take on files."
5225 files-done abbrevs-done)
5227 ;; First save any buffers that we're supposed to save unconditionally.
5228 ;; That way the following code won't ask about them.
5233 ;; Ask about those buffers that merit it,
5234 ;; and record the number thus saved.
5238 ;; Note that killing some buffers may kill others via
5239 ;; hooks (e.g. Rmail and its viewing buffer).
5251 t
5263 save-some-buffers-action-alist))
5264 ;; Maybe to save abbrevs, and record whether
5265 ;; we either saved them or asked to.
5272 ;; Don't keep bothering user if he says no.
5286 \f
5288 "Clear out records of last mod time of visited file.
5289 Next attempt to save will not complain of a discrepancy."
5293 "Mark current buffer as unmodified, not needing to be saved.
5296 It is not a good idea to use this function in Lisp programs, because it
5297 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5305 "Change whether this buffer is read-only."
5313 "Insert contents of file FILENAME into buffer after point.
5314 Set mark after the inserted text.
5316 This function is meant for the user to run interactively.
5317 Don't call it from programs! Use `insert-file-contents' instead.
5318 \(Its calling sequence is different; see its documentation)."
5324 "Append the contents of the region to the end of file FILENAME.
5325 When called from a function, expects three arguments,
5326 START, END and FILENAME. START and END are normally buffer positions
5327 specifying the part of the buffer to write.
5328 If START is nil, that means to use the entire buffer contents.
5329 If START is a string, then output that string to the file
5330 instead of any buffer contents; END is ignored.
5332 This does character code conversion and applies annotations
5333 like `write-region' does."
5339 "Return most recent backup file for FILENAME or nil if no backups exist."
5340 ;; `make-backup-file-name' will get us the right directory for
5341 ;; ordinary or numeric backups. It might create a directory for
5342 ;; backups as a side-effect, according to `backup-directory-alist'.
5349 tem)
5358 newest))
5361 "Rename current buffer to a similar name not already taken.
5362 This function is useful for creating multiple shell process buffers
5363 or multiple mail buffers, etc.
5365 Note that some commands, in particular those based on `compilation-mode'
5366 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5367 appropriate mode even if it has been renamed. So as well as renaming
5368 the buffer, you also need to switch buffers before running another
5369 instance of such commands."
5377 ;; If the existing buffer name has a <NNN>,
5378 ;; which isn't part of the file name (if any),
5379 ;; then get rid of that.
5385 "Make directory DIR if it is not already a directory. Return nil."
5393 "Create the directory DIR and optionally any nonexistent parent dirs.
5394 If DIR already exists as a directory, signal an error, unless
5395 PARENTS is non-nil.
5397 Interactively, the default choice of directory to create is the
5398 current buffer's default directory. That is useful when you have
5399 visited a file in a nonexistent directory.
5401 Noninteractively, the second (optional) argument PARENTS, if
5402 non-nil, says whether to create parent directories that don't
5403 exist. Interactively, this happens by default.
5405 If creating the directory or directories fail, an error will be
5406 raised."
5409 nil nil)
5410 t))
5411 ;; If default-directory is a remote directory,
5412 ;; make sure we find its make-directory handler.
5420 create-list parent)
5427 ;; Do not loop if root does not exist (Bug#2309).
5430 dir parent))
5439 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5440 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5441 non-nil and if FN fails due to a missing file or directory."
5447 "Delete the directory named DIRECTORY. Does not follow symlinks.
5448 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5449 no error if something else is simultaneously deleting them.
5450 TRASH non-nil means to trash the directory instead, provided
5451 `delete-by-moving-to-trash' is non-nil.
5453 When called interactively, TRASH is nil if and only if a prefix
5454 argument is given, and a further prompt asks the user for
5455 RECURSIVE if DIRECTORY is nonempty."
5462 "Move directory to trash: "
5464 default-directory default-directory nil nil))))
5470 nil)
5472 ;; If default-directory is a remote directory, make sure we find its
5473 ;; delete-directory handler.
5480 ;; Only move non-empty dir to trash if recursive deletion was
5481 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5482 ;; case, where the operation fails in delete-directory-internal.
5483 ;; As `move-file-to-trash' trashes directories (empty or
5484 ;; otherwise) as a unit, we do not need to recurse here.
5486 ;; Check if directory is empty apart from "." and "..".
5491 ;; Otherwise, call ourselves recursively if needed.
5496 directory-files-no-dot-files-regexp))
5500 ;; This test is equivalent to but more efficient
5501 ;; than (and (file-directory-p fn)
5502 ;; (not (file-symlink-p fn))).
5506 files))
5507 directory-exists))
5511 "Return non-nil if files FILE1 and FILE2 name the same file.
5512 If FILE1 or FILE2 does not exist, the return value is unspecified."
5523 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5525 Return nil if DIR is not an existing directory."
5537 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5552 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5553 This function always sets the file modes of the output files to match
5554 the corresponding input file.
5556 The third arg KEEP-TIME non-nil means give the output files the same
5557 last-modified time as the old ones. (This works on only some systems.)
5559 A prefix arg makes KEEP-TIME non-nil.
5561 Noninteractively, the last argument PARENTS says whether to
5562 create parent directories if they don't exist. Interactively,
5563 this happens by default.
5565 If NEWNAME is a directory name, copy DIRECTORY as a subdirectory
5566 there. However, if called from Lisp with a non-nil optional
5567 argument COPY-CONTENTS, copy the contents of DIRECTORY directly
5568 into NEWNAME instead."
5575 default-directory default-directory nil nil)
5576 current-prefix-arg t nil)))
5579 directory newname))
5580 ;; If default-directory is a remote directory, make sure we find its
5581 ;; copy-directory handler.
5586 newname keep-time parents copy-contents)
5588 ;; Compute target name.
5593 ;; If NEWNAME is not a directory name, create it;
5594 ;; that is where we will copy the files of DIRECTORY.
5596 ;; NEWNAME is a directory name. If COPY-CONTENTS is non-nil,
5597 ;; create NEWNAME if it is not already a directory;
5598 ;; otherwise, create NEWNAME/[DIRECTORY-BASENAME].
5605 ;; Copy recursively.
5607 ;; We do not want to copy "." and "..".
5609 directory-files-no-dot-files-regexp))
5620 ;; Set directory attributes.
5626 \f
5627 ;; At time of writing, only info uses this.
5629 "Return a copy of DIRS with all non-existent directories removed.
5630 The optional argument KEEP is a list of directories to retain even if
5631 they don't exist, and REJECT is a list of directories to remove from
5632 DIRS, even if they exist; REJECT takes precedence over KEEP.
5634 Note that membership in REJECT and KEEP is checked using simple string
5635 comparison."
5641 dirs)))
5643 \f
5646 "Function to use to revert this buffer.
5647 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5648 which are the arguments that `revert-buffer' received.
5649 It also has access to the `preserve-modes' argument of `revert-buffer'
5650 via the `revert-buffer-preserve-modes' dynamic variable.
5652 For historical reasons, a value of nil means to use the default function.
5657 #'revert-buffer-insert-file-contents--default-function
5658 "Function to use to insert contents when reverting this buffer.
5659 The function receives two arguments: the first the nominal file name to use;
5660 the second is t if reading the auto-save file.
5662 The function is responsible for updating (or preserving) point.
5664 For historical reasons, a value of nil means to use the default function.
5668 "Default function to use for `buffer-stale-function'.
5669 This function ignores its argument.
5670 This returns non-nil if the current buffer is visiting a readable file
5671 whose modification time does not match that of the buffer.
5673 This function only handles buffers that are visiting files.
5674 Non-file buffers need a custom function"
5681 "Function to check whether a buffer needs reverting.
5682 This should be a function with one optional argument NOCONFIRM.
5683 Auto Revert Mode passes t for NOCONFIRM. The function should return
5684 non-nil if the buffer should be reverted. A return value of
5685 `fast' means that the need for reverting was not checked, but
5686 that reverting the buffer is fast. The buffer is current when
5687 this function is called.
5689 The idea behind the NOCONFIRM argument is that it should be
5690 non-nil if the buffer is going to be reverted without asking the
5691 user. In such situations, one has to be careful with potentially
5692 time consuming operations.
5694 For historical reasons, a value of nil means to use the default function.
5695 This should not be relied upon.
5697 For more information on how this variable is used by Auto Revert mode,
5701 "Normal hook for `revert-buffer' to run before reverting.
5702 The function `revert-buffer--default' runs this.
5706 "Normal hook for `revert-buffer' to run after reverting.
5707 Note that the hook value that it runs is the value that was in effect
5708 before reverting; that makes a difference if you have buffer-local
5709 hook functions.
5711 The function `revert-buffer--default' runs this.
5719 ;; `revert-buffer-function' was defined long ago to be a function of only
5720 ;; 2 arguments, so we have to use a dynbind variable to pass the
5721 ;; `preserve-modes' argument of `revert-buffer'.
5725 "Replace current buffer text with the text of the visited file on disk.
5726 This undoes all changes since the file was visited or saved.
5727 With a prefix argument, offer to revert from latest auto-save file, if
5728 that is more recent than the visited file.
5730 This command also implements an interface for special buffers
5731 that contain text which doesn't come from a file, but reflects
5732 some other data instead (e.g. Dired buffers, `buffer-list'
5733 buffers). This is done via the variable `revert-buffer-function'.
5734 In these cases, it should reconstruct the buffer contents from the
5735 appropriate data.
5737 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5738 to revert from the auto-save file when this is nil. Note that the
5739 sense of this argument is the reverse of the prefix argument, for the
5740 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5741 to nil.
5743 Optional second argument NOCONFIRM means don't ask for confirmation
5744 at all. (The variable `revert-without-query' offers another way to
5745 revert buffers without querying for confirmation.)
5747 Optional third argument PRESERVE-MODES non-nil means don't alter
5748 the files modes. Normally we reinitialize them using `normal-mode'.
5750 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5752 This function calls the function that `revert-buffer-function' specifies
5753 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5754 The default function runs the hooks `before-revert-hook' and
5755 `after-revert-hook'."
5756 ;; I admit it's odd to reverse the sense of the prefix argument, but
5757 ;; there is a lot of code out there which assumes that the first
5758 ;; argument should be t to avoid consulting the auto-save file, and
5759 ;; there's no straightforward way to encourage authors to notice a
5760 ;; reversal of the argument sense. So I'm just changing the user
5761 ;; interface, but leaving the programmatic interface the same.
5766 ignore-auto noconfirm)))
5769 "Default function for `revert-buffer'.
5770 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5771 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5772 start and end.
5774 Calls `revert-buffer-insert-file-contents-function' to reread the
5775 contents of the visited file, with two arguments: the first is the file
5776 name, the second is non-nil if reading an auto-save file.
5778 This function only handles buffers that are visiting files.
5779 Non-file buffers need a custom function."
5784 buffer-auto-save-file-name
5789 buffer-auto-save-file-name
5790 buffer-file-name)))
5800 file-name)))
5802 ;; If file was backed up but has changed since,
5803 ;; we should make another backup.
5807 ;; Effectively copy the after-revert-hook status,
5808 ;; since after-find-file will clobber it.
5811 after-revert-hook))
5813 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5817 file-name auto-save-p)
5818 ;; Recompute the truename in case changes in symlinks
5819 ;; have changed the truename.
5823 ;; Run after-revert-hook as it was before we reverted.
5827 local-hook)
5830 t)))))
5833 "Default function for `revert-buffer-insert-file-contents-function'.
5834 The function `revert-buffer--default' calls this.
5835 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5836 an auto-save file."
5840 "File %s no longer exists!"
5842 file-name))
5845 "File %s no longer readable!"
5847 file-name))
5849 ;; Bind buffer-file-name to nil
5850 ;; so that we don't try to lock the file.
5856 ;; Auto-saved file should be read by Emacs's
5857 ;; internal coding.
5861 buffer-file-coding-system-explicit
5864 coding-system-for-read
5866 coding-system-for-read)
5868 ;; As a coding system suitable for multibyte
5869 ;; buffer is specified, make the current
5870 ;; buffer multibyte.
5873 ;; This force after-insert-file-set-coding
5874 ;; (called from insert-file-contents) to set
5875 ;; buffer-file-coding-system to a proper value.
5878 ;; Note that this preserves point in an intelligent way.
5882 nil nil t))
5884 nil nil t))))))
5887 "Recover the visited file--get contents from its last auto-save file."
5894 "Visit file FILE, but get contents from its last auto-save file."
5895 ;; Actually putting the file name in the minibuffer should be used
5896 ;; only rarely.
5897 ;; Not just because users often use the default.
5914 "*Directory*" nil
5925 ;; Use insert-directory-safely, not insert-directory,
5926 ;; because these files might not exist. In particular,
5927 ;; FILE might not exist if the auto-save file was for
5928 ;; a buffer that didn't visit a file, such as "*mail*".
5929 ;; The code in v20.x called `ls' directly, so we need
5930 ;; to emulate what `ls' did in that case.
5935 ;; Keep the current buffer-file-coding-system.
5937 ;; Auto-saved file should be read with special coding.
5946 "Recover auto save files from a previous Emacs session.
5947 This command first displays a Dired buffer showing you the
5948 previous sessions that you could recover from.
5949 To choose one, move point to the proper line and then type C-c C-c.
5950 Then you'll be asked about a number of files to recover."
5960 directory-files-no-dot-files-regexp
5962 t)
5973 ;; Each line starts with a space
5974 ;; so that Font Lock mode won't highlight the first character.
5977 " To delete a session file, type \
5983 "Choose one saved session to recover auto-save files from.
5984 This command is used in the special Dired buffer created by
5987 ;; Get the name of the session file to recover from.
5989 files
5995 ;; Read in the auto-save-list file.
5998 ;; Loop thru the text of that file
5999 ;; and get out the names of the files to recover.
6003 ;; This is a pair of lines for a non-file-visiting buffer.
6004 ;; Get the auto-save file name and manufacture
6005 ;; a "visited file name" from that.
6008 ;; If there is no auto-save file name, the
6009 ;; auto-save-list file is probably corrupted.
6022 ;; This pair of lines is a file-visiting
6023 ;; buffer. Use the visited file name.
6033 ;; Ignore a file if its auto-save file does not exist now.
6037 ;; The file contains a pair of line for each auto-saved buffer.
6038 ;; The first line of the pair contains the visited file name
6039 ;; or is empty if the buffer was not visiting a file.
6040 ;; The second line is the auto-save file name.
6048 files
6054 "Kill BUFFER if confirmed."
6062 "Kill some buffers. Asks the user whether to kill each one of them.
6063 Non-interactively, if optional argument LIST is non-nil, it
6064 specifies the list of buffers to kill, asking for approval for each one."
6072 ; if we killed the base buffer.
6079 "Kill buffers whose name matches the specified REGEXP.
6080 Ignores buffers whose name starts with a space, unless optional
6081 prefix argument INTERNAL-TOO is non-nil. Asks before killing
6082 each buffer, unless NO-ASK is non-nil."
6091 \f
6093 "Adjust current buffer's auto save file name for current conditions.
6094 Also rename any existing auto save file, if it was made in this session."
6106 "Return file name to use for auto-saves of current buffer.
6107 Does not consider `auto-save-visited-file-name' as that variable is checked
6108 before calling this function. You can redefine this for customization.
6109 See also `auto-save-file-name-p'."
6117 result uniq)
6118 ;; Apply user-specified translations
6119 ;; to the file name.
6123 filename)
6133 filename))))
6138 ;; We truncate the file name to DOS 8+3 limits
6139 ;; before doing anything else, because the regexp
6140 ;; passed to string-match below cannot handle
6141 ;; extensions longer than 3 characters, multiple
6142 ;; dots, and other atrocities.
6147 fn)
6152 "#"
6155 ;; Make sure auto-save file names don't contain characters
6156 ;; invalid for the underlying filesystem.
6158 ;; Don't modify remote filenames
6161 result))))
6163 ;; Deal with buffers that don't have any associated files. (Mail
6164 ;; mode tends to create a good number of these.)
6168 file-name)
6169 ;; Restrict the characters used in the file name to those which
6170 ;; are known to be safe on all filesystems, url-encoding the
6171 ;; rest.
6172 ;; We do this on all platforms, because even if we are not
6173 ;; running on DOS/Windows, the current directory may be on a
6174 ;; mounted VFAT filesystem, such as a USB memory stick.
6178 ;; For multibyte characters, this will produce more than
6179 ;; 2 hex digits, so is not true URL encoding.
6183 ;; Generate the file name.
6189 ;; Try a few alternative directories, to get one we can
6190 ;; write it.
6196 ;; Don't modify remote filenames
6198 ;; The call to convert-standard-filename is in case
6199 ;; buffer-name includes characters not allowed by the
6200 ;; DOS/Windows filesystems. make-temp-file writes to the
6201 ;; file it creates, so we must fix the file name _before_
6202 ;; make-temp-file is called.
6204 fname))
6206 ;; make-temp-file creates the file,
6207 ;; but we don't want it to exist until we do an auto-save.
6211 file-name)))
6214 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6215 FILENAME should lack slashes. You can redefine this for customization."
6217 \f
6219 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6220 The generated regexp will match a filename only if the filename
6221 matches that wildcard according to shell rules. Only wildcards known
6222 by `sh' are supported."
6224 ;; Copy the initial run of non-special characters.
6227 ;; If no special characters, we're almost done.
6231 j)
6233 result
6254 ;; Found "[^". Insert a `\0' character
6255 ;; (which cannot happen in a filename)
6256 ;; into the character class, so that `^'
6257 ;; is not the first character after `[',
6258 ;; and thus non-special in a regexp.
6263 ;; I don't think `]' can appear in a
6264 ;; character class in a wildcard, but
6265 ;; let's be general here.
6272 i
6285 ;; Shell wildcards should match the entire filename,
6286 ;; not its part. Make the regexp say so.
6288 \f
6291 "Switches for `list-directory' to pass to `ls' for brief listing."
6297 "Switches for `list-directory' to pass to `ls' for verbose listing."
6302 "Expand wildcard pattern PATTERN.
6303 This returns a list of file names which match the pattern.
6304 Files are sorted in `string<' order.
6306 If PATTERN is written as an absolute file name,
6307 the values are absolute also.
6309 If PATTERN is written as a relative file name, it is interpreted
6310 relative to the current default directory, `default-directory'.
6311 The file names returned are normally also relative to the current
6312 default directory. However, if FULL is non-nil, they are absolute."
6316 ;; A list of all dirs that DIRPART specifies.
6317 ;; This can be more than one dir
6318 ;; if DIRPART contains wildcards.
6324 contents)
6329 ;; Filter out "." and ".."
6334 name))
6341 this-dir-contents)
6342 this-dir-contents)
6343 contents)))))
6344 contents)))
6346 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6350 "Display a list of files in or matching DIRNAME, a la `ls'.
6351 DIRNAME is globbed by the shell if necessary.
6352 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6353 Actions controlled by variables `list-directory-brief-switches'
6354 and `list-directory-verbose-switches'."
6358 nil default-directory nil)
6359 pfx)))
6361 list-directory-brief-switches))
6362 buffer)
6374 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6382 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6384 PATTERN is assumed to represent a file-name wildcard suitable for the
6385 underlying filesystem. For Unix and GNU/Linux, each character from the
6387 the parts of the pattern which don't include wildcard characters are
6388 quoted with double quotes.
6391 on Windows), so PATTERN can use them to quote wildcard characters that
6392 need to be passed verbatim to shell commands."
6396 ;; DOS/Windows don't allow `"' in file names. So if the
6397 ;; argument has quotes, we can safely assume it is already
6398 ;; quoted by the caller.
6400 ;; We quote [&()#$`'] in case their shell is a port of a
6401 ;; Unixy shell. We quote [,=+] because stock DOS and
6402 ;; Windows shells require that in some cases, such as
6403 ;; passing arguments to batch files that use positional
6404 ;; arguments like %1.
6406 pattern
6409 end)
6426 pattern))))
6433 "Program to get the amount of free space on a file system.
6434 We assume the output has the format of `df'.
6435 The value of this variable must be just a command name or file name;
6436 if you want to specify options, use `directory-free-space-args'.
6438 A value of nil disables this feature.
6440 This variable is obsolete; Emacs no longer uses it."
6444 "ignored, as Emacs uses `file-system-info' instead"
6449 "Options to use when running `directory-free-space-program'."
6453 "ignored, as Emacs uses `file-system-info' instead"
6457 "Return the amount of free space on directory DIR's file system.
6458 The return value is a string describing the amount of free
6459 space (normally, the number of free 1KB blocks).
6461 If DIR's free space cannot be obtained, this function returns nil."
6466 ;; The following expression replaces `dired-move-to-filename-regexp'.
6470 ;; In some locales, month abbreviations are as short as 2 letters,
6471 ;; and they can be followed by ".".
6472 ;; In Breton, a month name can include a quote character.
6485 s "+"
6488 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6489 ;; omits the Kanji characters after month and day-of-month.
6490 ;; On Mac OS X 10.3, the date format in East Asian locales is
6491 ;; day-of-month digits followed by month digits.
6497 ;; The "[0-9]" below requires the previous column to end in a digit.
6498 ;; This avoids recognizing `1 may 1997' as a date in the line:
6499 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6501 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6503 ;; For non-iso date formats, we add the ".*" in order to find
6504 ;; the last possible match. This avoids recognizing
6505 ;; `jservice 10 1024' as a date in the line:
6506 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6508 ;; vc dired listings provide the state or blanks between file
6509 ;; permissions and date. The state is always surrounded by
6510 ;; parentheses:
6511 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6512 ;; This is not supported yet.
6517 "Regular expression to match up to the file name in a directory listing.
6518 The default value is designed to recognize dates and times
6524 "Return non-nil if DIR contents a shell wildcard in the directory part.
6525 The return value is a cons (DIR . WILDCARDS); DIR is the
6526 `default-directory' in the Dired buffer, and WILDCARDS are the wildcards.
6528 Valid wildcards are '*', '?', '[abc]' and '[a-z]'."
6531 ls-lisp-support-shell-wildcards)
6535 wildcards wildcards wildcards)))
6543 ;; The following overshoots by one line for an empty
6544 ;; directory listed with "--dired", but without "-a"
6545 ;; switch, where the ls output contains a
6546 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6547 ;; We take care of that case later.
6555 error-lines)
6556 ;; Find all the lines that are error messages,
6557 ;; and record the bounds of each one.
6564 ;; Now read the numeric positions of file names.
6571 error-lines))
6574 error-lines)))
6576 ;; End is followed by \n or by " -> ".
6578 ;; It seems that we can't trust ls's output as to
6579 ;; byte positions of filenames.
6585 ;; Take care of the case where the ls output contains a
6586 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6587 ;; and we went one line too far back (see above).
6592 ;; insert-directory
6593 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6594 ;; FULL-DIRECTORY-P is nil.
6595 ;; The single line of output must display FILE's name as it was
6596 ;; given, namely, an absolute path name.
6597 ;; - must insert exactly one line for each file if WILDCARD or
6598 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6599 ;; before the file lines, plus optional text after the file lines.
6600 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6601 ;; allowed.
6602 ;; File lines should display the basename.
6603 ;; - must be consistent with
6604 ;; - functions dired-move-to-filename, (these two define what a file line is)
6605 ;; dired-move-to-end-of-filename,
6606 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6607 ;; dired-insert-headerline
6608 ;; dired-after-subdir-garbage (defines what a "total" line is)
6609 ;; - variable dired-subdir-regexp
6610 ;; - may be passed "--dired" as the first argument in SWITCHES.
6611 ;; Filename handlers might have to remove this switch if their
6612 ;; "ls" command does not support it.
6614 "Insert directory listing for FILE, formatted according to SWITCHES.
6615 Leaves point after the inserted text.
6616 SWITCHES may be a string of options, or a list of strings
6617 representing individual options.
6618 Optional third arg WILDCARD means treat FILE as shell wildcard.
6619 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6620 switches do not contain `d', so that a full listing is expected.
6622 This works by running a directory listing program
6623 whose name is in the variable `insert-directory-program'.
6624 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6626 When SWITCHES contains the long `--dired' option, this function
6627 treats it specially, for the sake of dired. However, the
6628 normally equivalent short `-D' option is just passed on to
6629 `insert-directory-program', as any other option."
6630 ;; We need the directory in order to find the right handler.
6635 wildcard full-directory-p)
6638 ;; Read the actual directory using `insert-directory-program'.
6639 ;; RESULT gets the status code.
6641 ;; putting text property `dired-filename, decode one
6642 ;; bunch by one to preserve that property.
6644 ;; This is to control encoding the arguments in call-process.
6648 default-file-name-coding-system))))
6651 ;; If the wildcard is just in the file part, then run ls in
6652 ;; the directory part of the file pattern using the last
6653 ;; component as argument. Otherwise, run ls in the longest
6654 ;; subdirectory of the directory part free of wildcards; use
6655 ;; the remaining of the file pattern as argument.
6664 ;; NB since switches is passed to the shell, be
6665 ;; careful of malicious values, eg "-l;reboot".
6666 ;; See eg dired-safe-switches-p.
6668 shell-file-name nil t nil
6669 shell-command-switch
6671 ""
6673 insert-directory-program
6674 " -d "
6676 switches
6678 " -- "
6679 ;; Quote some characters that have
6680 ;; special meanings in shells; but
6681 ;; don't quote the wildcards--we want
6682 ;; them to be special. We also
6683 ;; currently don't quote the quoting
6684 ;; characters in case people want to
6685 ;; use them explicitly to quote
6686 ;; wildcard characters.
6688 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6689 ;; directory if FILE is a symbolic link.
6697 insert-directory-program nil t nil
6701 ;; Split the switches at any spaces so we can
6702 ;; pass separate options as separate args.
6704 ;; Avoid lossage if FILE starts with `-'.
6711 ;; (concat (file-name-as-directory file) ".")
6712 file
6713 file))))))))
6715 ;; If we got "//DIRED//" in the output, it means we got a real
6716 ;; directory listing, even if `ls' returned nonzero.
6717 ;; So ignore any errors.
6730 ;; The first time ls returns an error,
6731 ;; find the version numbers of ls,
6732 ;; and set insert-directory-ls-version
6733 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6734 ;; is equal or if the info cannot be obtained.
6735 ;; (That can mean it isn't GNU ls.)
6745 comparison)
6761 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6765 ;; If `insert-directory-program' failed, signal an error.
6767 ;; Delete the error message it may have output.
6769 ;; On non-Posix systems, we cannot open a directory, so
6770 ;; don't even try, because that will always result in
6771 ;; the ubiquitous "Access denied". Instead, show the
6772 ;; command line so the user can try to guess what went wrong.
6777 insert-directory-program
6779 file result)
6780 ;; Unix. Access the file to get a suitable error.
6784 ;; Now decode what read if necessary.
6786 file-name-coding-system
6787 default-file-name-coding-system
6789 coding-no-eol
6790 val pos)
6794 ;; If no coding system is specified or detection is
6795 ;; requested, detect the coding.
6809 ;; Force no eol conversion on a file name, so
6810 ;; that CR is preserved.
6818 ;; Try to insert the amount of free space.
6821 ;; First find the line to put it on.
6825 ;; Replace "total" with "used", to avoid confusion.
6831 "Convert `ls --dired' file name position value POS to a buffer position.
6832 File name position values returned in ls --dired output
6833 count only stdout; they don't count the error messages sent to stderr.
6834 So this function converts to them to real buffer positions.
6835 ERROR-LINES is a list of buffer positions of error message lines,
6836 of the form (START END)."
6840 pos)
6844 "Insert directory listing for FILE, formatted according to SWITCHES.
6846 Like `insert-directory', but if FILE does not exist, it inserts a
6847 message to that effect instead of signaling an error."
6850 ;; Simulate the message printed by `ls'.
6854 "Functions to call with no arguments to query about killing Emacs.
6855 If any of these functions returns nil, killing Emacs is canceled.
6856 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6857 the low level primitive, does not. See also `kill-emacs-hook'."
6863 "How to ask for confirmation when leaving Emacs.
6864 If nil, the default, don't ask at all. If the value is non-nil, it should
6865 be a predicate function; for example `yes-or-no-p'."
6874 "Non-nil if Emacs should confirm killing processes on exit.
6875 If this variable is nil, the value of
6876 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6877 processes with a non-nil `process-query-on-exit-flag', Emacs will
6878 prompt the user before killing them."
6884 "Offer to save each buffer, then kill this Emacs process.
6885 With prefix ARG, silently save all file-visiting buffers without asking.
6886 If there are active processes where `process-query-on-exit-flag'
6887 returns non-nil and `confirm-kill-processes' is non-nil,
6888 asks whether processes should be killed.
6889 Runs the members of `kill-emacs-query-functions' in turn and stops
6890 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6892 ;; Don't use save-some-buffers-default-predicate, because we want
6893 ;; to ask about all the buffers before killing Emacs.
6904 ;; process-list is not defined on MSDOS.
6907 active)
6925 ;; Query the user for other things, perhaps.
6932 "Offer to save each buffer, then kill the current connection.
6933 If the current frame has no client, kill Emacs itself using
6934 `save-buffers-kill-emacs'.
6936 With prefix ARG, silently save all file-visiting buffers, then kill.
6938 If emacsclient was started with a list of filenames to edit, then
6939 only these files will be asked to be saved."
6944 \f
6945 ;; We use /: as a prefix to "quote" a file name
6946 ;; so that magic file name handlers will not apply to it.
6950 file-name-handler-alist))
6952 ;; We depend on being the last handler on the list,
6953 ;; so that anything else which does need handling
6954 ;; has been handled already.
6955 ;; So it is safe for us to inhibit *all* magic file name handlers.
6960 ;; Some operations respect file name handlers in
6961 ;; `default-directory'. Because core function like
6962 ;; `call-process' don't care about file name handlers in
6963 ;; `default-directory', we here have to resolve the
6964 ;; directory into a local one. For `process-file',
6965 ;; `start-file-process', and `shell-command', this fixes
6966 ;; Bug#25949.
6968 shell-command))
6972 default-directory))
6973 ;; Get a list of the indices of the args which are file names.
6976 ;; The first six are special because they
6977 ;; return a file name. We want to include the /:
6978 ;; in the return value.
6979 ;; So just avoid stripping it in the first place.
6986 ;; `identity' means just return the first arg
6987 ;; not stripped of its quoting.
6989 ;; `add' means add "/:" to the result.
6992 ;; `unquote-then-quote' means set buffer-file-name
6993 ;; temporarily to unquoted filename.
6995 ;; List the arguments which are filenames.
7003 ;; For all other operations, treat the first argument only
7004 ;; as the file name.
7006 method
7007 ;; Copy ARGUMENTS so we can replace elements in it.
7011 ;; Strip off the /: from the file names that have it.
7019 "/"
7025 (`insert-file-contents
7031 (`unquote-then-quote
7032 ;; We can't use `cl-letf' with `(buffer-local-value)' here
7033 ;; because it wouldn't work during bootstrapping.
7035 ;; `unquote-then-quote' is only used for the
7036 ;; `verify-visited-file-modtime' action, which takes a buffer
7037 ;; as only optional argument.
7040 ;; Make sure to hide the temporary buffer change from the
7041 ;; underlying operation.
7049 If NAME is a remote file name, check the local part of NAME."
7054 If NAME is a remote file name, the local part of NAME is quoted.
7055 If NAME is already a quoted file name, NAME is returned unchanged."
7057 name
7062 If NAME is a remote file name, the local part of NAME is unquoted."
7068 \f
7069 ;; Symbolic modes and read-file-modes.
7072 "Convert CHAR to a numeric bit-mask for extracting mode bits.
7073 CHAR is in [ugoa] and represents the category of users (Owner, Group,
7074 Others, or All) for whom to produce the mask.
7075 The bit-mask that is returned extracts from mode bits the access rights
7076 for the specified category of users."
7084 "Convert CHAR to a numeric value of mode bits.
7085 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7086 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7093 ;; Rights relative to the previous file modes.
7104 "Convert a symbolic mode string specification to an equivalent number.
7106 WHO-MASK is the bit-mask specifying the category of users to which to
7107 apply the access permissions. See `file-modes-char-to-who'.
7108 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7109 RIGHTS request to add, remove, or set permissions based on existing ones,
7116 char-right)
7123 num-rights
7127 op char-right)))
7128 num-rights))
7131 "Convert symbolic file modes to numeric file modes.
7132 MODES is the string to convert, it should match
7134 See Info node `(coreutils)File permissions' for more information on this
7135 notation.
7136 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7137 MODES request to add, remove, or set permissions based on existing ones,
7151 num-who num-modes)
7154 num-modes)))
7157 "Read file modes in octal or symbolic notation and return its numeric value.
7159 ORIG-FILE is the name of a file on whose mode bits to base returned
7160 permissions if what user types requests to add, remove, or set permissions
7176 nil nil default)))
7185 ;; Trashcan handling.
7187 "Directory for `move-file-to-trash' to move files and directories to.
7188 This directory is only used when the function `system-move-file-to-trash'
7189 is not defined.
7190 Relative paths are interpreted relative to `default-directory'.
7191 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7201 "Move the file (or directory) named FILENAME to the trash.
7202 When `delete-by-moving-to-trash' is non-nil, this function is
7203 called by `delete-file' and `delete-directory' instead of
7204 deleting files outright.
7206 If the function `system-move-file-to-trash' is defined, call it
7207 with FILENAME as an argument.
7208 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7209 directory.
7210 Otherwise, trash FILENAME using the freedesktop.org conventions,
7211 like the GNOME, KDE and XFCE desktop environments. Emacs only
7215 ;; If `trash-directory' is non-nil, move the file there.
7220 ;; We can't trash a parent directory of trash-directory.
7223 trash-dir filename))
7226 ;; Ensure that the trashed file-name is unique.
7233 ;; If `system-move-file-to-trash' is defined, use it.
7236 ;; Otherwise, use the freedesktop.org method, as specified at
7237 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7248 ;; Check if we have permissions to delete.
7252 ;; The trashed file cannot be the trash dir or its parent.
7255 trash-files-dir filename))
7258 trash-info-dir filename))
7260 ;; Ensure that the trash directory exists; otherwise, create it.
7267 ;; Try to move to trash with .trashinfo undo information
7272 ;; Perform url-encoding on FN. For compatibility with
7273 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7274 ;; for path separators.
7279 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7280 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7293 fn))
7298 ;; Make a .trashinfo file. Use O_EXCL, as per trash-spec 1.0.
7302 trash-info-dir)))
7306 ;; Uniquify new-fn. Some file managers do not
7307 ;; like Emacs-style backup file names. E.g.:
7308 ;; https://bugs.kde.org/170956
7314 ;; Finally, try to move the file to the trashcan.
7320 "The type field in ATTRIBUTES returned by `file-attributes'.
7321 The value is either t for directory, string (name linked to) for
7322 symbolic link, or nil."
7326 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7330 "The UID field in ATTRIBUTES returned by `file-attributes'.
7331 This is either a string or a number. If a string value cannot be
7332 looked up, a numeric value, either an integer or a float, is
7333 returned."
7337 "The GID field in ATTRIBUTES returned by `file-attributes'.
7338 This is either a string or a number. If a string value cannot be
7339 looked up, a numeric value, either an integer or a float, is
7340 returned."
7344 "The last access time in ATTRIBUTES returned by `file-attributes'.
7345 This a list of integers (HIGH LOW USEC PSEC) in the same style
7346 as (current-time)."
7350 "The modification time in ATTRIBUTES returned by `file-attributes'.
7351 This is the time of the last change to the file's contents, and
7352 is a list of integers (HIGH LOW USEC PSEC) in the same style
7353 as (current-time)."
7357 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7358 This is the time of last change to the file's attributes: owner
7359 and group, access mode bits, etc, and is a list of integers (HIGH
7360 LOW USEC PSEC) in the same style as (current-time)."
7364 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7365 This is a floating point number if the size is too large for an integer."
7369 "The file modes in ATTRIBUTES returned by `file-attributes'.
7370 This is a string of ten letters or dashes as in ls -l."
7374 "The inode number in ATTRIBUTES returned by `file-attributes'.
7375 If it is larger than what an Emacs integer can hold, this is of
7376 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7377 If even HIGH is too large for an Emacs integer, this is instead
7378 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7379 middle 24 bits, and finally the low 16 bits."
7383 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7384 If it is larger than what an Emacs integer can hold, this is of
7385 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7386 If even HIGH is too large for an Emacs integer, this is instead
7387 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7388 middle 24 bits, and finally the low 16 bits."
7392 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7393 ATTR-NAMES are symbols with the selected attribute names.
7395 Valid attribute names are: type, link-number, user-id, group-id,
7396 access-time, modification-time, status-change-time, size, modes,
7397 inode-number and device-number."
7399 modification-time status-change-time
7400 size modes inode-number device-number))
7401 result)
7407 attributes)
7408 result)
7411 \f
7436 ;;; files.el ends here