| blob | 43aec8173d98494e3eb9dd078859161040e735aa |
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 <http://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."
160 "Non-nil means find a file under alternative names, in existing buffers.
161 This means if any existing buffer is visiting the file you want
162 under another name, you get the existing buffer instead of a new buffer."
167 "Non-nil means visiting a file uses its truename as the visited-file name.
168 That is, the buffer visiting the file has the truename as the
169 value of `buffer-file-name'. The truename of a file is found by
170 chasing all links both at the file level and at the levels of the
171 containing directories."
177 "Specify which files should be reverted without query.
178 The value is a list of regular expressions.
179 If the file name matches one of these regular expressions,
180 then `revert-buffer' reverts the file without querying
181 if the file has changed on disk and you have not edited the buffer."
186 "The device number and file number of the file visited in the current buffer.
187 The value is a list of the form (FILENUM DEVNUM).
188 This pair of numbers uniquely identifies the file.
202 "The directory for writing small temporary files.
203 If non-nil, this directory is used instead of `temporary-file-directory'
204 by programs that create small temporary files. This is for systems that
205 have fast storage with limited space, such as a RAM disk."
210 ;; The system null device. (Should reference NULL_DEVICE from C.)
237 "Non-nil means protect against I/O errors while saving files.
238 Some modes set this non-nil in particular buffers.
240 This feature works by writing the new contents into a temporary file
241 and then renaming the temporary file to replace the original.
242 In this way, any I/O error in writing leaves the original untouched,
243 and there is never any instant where the file is nonexistent.
245 Note that this feature forces backups to be made by copying.
246 Yet, at the same time, saving a precious file
247 breaks any hard links between it and other files.
249 This feature is advisory: for example, if the directory in which the
250 file is being saved is not writable, Emacs may ignore a non-nil value
251 of `file-precious-flag' and write directly into the file.
253 See also: `break-hardlink-on-save'."
258 "Whether to allow breaking hardlinks when saving files.
259 If non-nil, then when saving a file that exists under several
260 names \(i.e., has multiple hardlinks), break the hardlink
261 associated with `buffer-file-name' and write to a new file, so
262 that the other instances of the file are not affected by the
263 save.
265 If `buffer-file-name' refers to a symlink, do not break the symlink.
267 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
268 For example, if the directory in which a file is being saved is not
269 itself writable, then error instead of saving in some
270 hardlink-nonbreaking way.
272 See also `backup-by-copying' and `backup-by-copying-when-linked'."
278 "Control use of version numbers for backup files.
279 When t, make numeric backup versions unconditionally.
280 When nil, make them for files that have some already.
281 The value `never' means do not make them."
288 "Return whether X is safe as local value for `version-control'."
295 "When cleaning directory, number of versions to keep."
301 "If t, delete excess backup versions silently.
302 If nil, ask confirmation. Any other value prevents any trimming."
309 "Number of oldest versions to keep when a new numbered backup is made."
315 "Number of newest versions to keep when a new numbered backup is made.
316 Includes the new backup. Must be > 0"
322 "Whether to add a newline automatically at the end of the file.
324 A value of t means do this only when the file is about to be saved.
325 A value of `visit' means do this right after the file is visited.
326 A value of `visit-save' means do it at both of those times.
327 Any other non-nil value means ask user whether to add a newline, when saving.
328 A value of nil means don't add newlines.
330 Certain major modes set this locally to the value obtained
331 from `mode-require-final-newline'."
341 "Whether to add a newline at end of file, in certain major modes.
342 Those modes set `require-final-newline' to this value when you enable them.
343 They do so because they are often used for files that are supposed
344 to end in newlines, and the question is how to arrange that.
346 A value of t means do this only when the file is about to be saved.
347 A value of `visit' means do this right after the file is visited.
348 A value of `visit-save' means do it at both of those times.
349 Any other non-nil value means ask user whether to add a newline, when saving.
351 A value of nil means do not add newlines. That is a risky choice in this
352 variable since this value is used for modes for files that ought to have
353 final newlines. So if you set this to nil, you must explicitly check and
354 add a final newline, whenever you save a file that really needs one."
364 "Non-nil says by default do auto-saving of every file-visiting buffer."
370 ;; Don't put "\\2" inside expand-file-name, since it will be
371 ;; transformed to "/2" on DOS/Windows.
373 "Transforms to apply to buffer file name before making auto-save file name.
374 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
375 REGEXP is a regular expression to match against the file name.
376 If it matches, `replace-match' is used to replace the
377 matching part with REPLACEMENT.
378 If the optional element UNIQUIFY is non-nil, the auto-save file name is
379 constructed by taking the directory part of the replaced file-name,
380 concatenated with the buffer file name with all directory separators
381 changed to `!' to prevent clashes. This will not work
382 correctly if your filesystem truncates the resulting name.
384 All the transforms in the list are tried, in the order they are listed.
385 When one transform applies, its result is final;
386 no further transforms are tried.
388 The default value is set up to put the auto-save file into the
389 temporary directory (see the variable `temporary-file-directory') for
390 editing a remote file.
392 On MS-DOS filesystems without long names this variable is always
393 ignored."
403 "Interval in seconds for `auto-save-visited-mode'.
404 If `auto-save-visited-mode' is enabled, Emacs will save all
405 buffers visiting a file to the visited file after it has been
406 idle for `auto-save-visited-interval' seconds."
416 "Toggle automatic saving to file-visiting buffers on or off.
417 With a prefix argument ARG, enable regular saving of all buffers
418 visiting a file if ARG is positive, and disable it otherwise.
419 Unlike `auto-save-mode', this mode will auto-save buffer contents
420 to the visited files directly and will also run all save-related
421 hooks. See Info node `Saving' for details of the save process.
423 If called from Lisp, enable the mode if ARG is omitted or nil,
424 and toggle it if ARG is `toggle'."
426 :global t
431 auto-save-visited-interval :repeat
435 auto-save-visited-file-name)))))))
437 ;; The 'set' part is so we don't get a warning for using this variable
438 ;; above, while still catching code that _sets_ the variable to get
439 ;; the same effect as the new auto-save-visited-mode.
444 "Non-nil means save word abbrevs too when files are saved.
445 If `silently', don't ask the user before saving."
450 "Non-nil means allow `find-file' to visit directories.
451 To visit the directory, `find-file' runs `find-directory-functions'."
456 "List of functions to try in sequence to visit a directory.
457 Each function is called with the directory name as the sole argument
458 and should return either a buffer or nil."
462 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
464 "List of functions to try in sequence to get a file name at point.
465 Each function should return either nil or a file name found at the
466 location of point in the current buffer."
470 ;;;It is not useful to make this a local variable.
471 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
475 "List of functions to be called for `find-file' on nonexistent file.
476 These functions are called as soon as the error is detected.
477 Variable `buffer-file-name' is already set up.
480 ;;;It is not useful to make this a local variable.
481 ;;;(put 'find-file-hooks 'permanent-local t)
484 "List of functions to be called after a buffer is loaded from a file.
485 The buffer's local variables (if any) will have been processed before the
486 functions are called."
494 "List of functions to be called before saving a buffer to a file.
495 Only used by `save-buffer'.
496 If one of them returns non-nil, the file is considered already written
497 and the rest are not called.
498 These hooks are considered to pertain to the visited file.
499 So any buffer-local binding of this variable is discarded if you change
501 change the major mode.
503 This hook is not run if any of the functions in
504 `write-contents-functions' returns non-nil. Both hooks pertain
505 to how to save a buffer to file, for instance, choosing a suitable
506 coding system and setting mode bits. (See Info
507 node `(elisp)Saving Buffers'.) To perform various checks or
519 "List of functions to be called before writing out a buffer to a file.
520 Only used by `save-buffer'.
521 If one of them returns non-nil, the file is considered already written
522 and the rest are not called and neither are the functions in
523 `write-file-functions'.
525 This variable is meant to be used for hooks that pertain to the
526 buffer's contents, not to the particular visited file; thus,
527 `set-visited-file-name' does not clear this variable; but changing the
528 major mode does clear it.
530 For hooks that _do_ pertain to the particular visited file, use
531 `write-file-functions'. Both this variable and
532 `write-file-functions' relate to how a buffer is saved to file.
533 To perform various checks or updates before the buffer is saved,
538 "Control use of local variables in files you visit.
539 The value can be t, nil, :safe, :all, or something else.
541 A value of t means file local variables specifications are obeyed
542 if all the specified variable values are safe; if any values are
543 not safe, Emacs queries you, once, whether to set them all.
544 \(When you say yes to certain values, they are remembered as safe.)
546 :safe means set the safe variables, and ignore the rest.
547 :all means set all variables, whether safe or not.
548 (Don't set it permanently to :all.)
549 A value of nil means always ignore the file local variables.
551 Any other value means always query you once whether to set them all.
552 \(When you say yes to certain values, they are remembered as safe, but
555 This variable also controls use of major modes specified in
556 a -*- line.
559 always obeys file local variable specifications and the -*- line,
560 and ignores this variable."
561 :risky t
570 "Non-nil means enable use of directory-local variables.
571 Some modes may wish to set this to nil to prevent directory-local
574 ;; This is an odd variable IMO.
575 ;; You might wonder why it is needed, when we could just do:
576 ;; (set (make-local-variable 'enable-local-variables) nil)
577 ;; These two are not precisely the same.
578 ;; Setting this variable does not cause -*- mode settings to be
579 ;; ignored, whereas setting enable-local-variables does.
580 ;; Only three places in Emacs use this variable: tar and arc modes,
581 ;; and rmail. The first two don't need it. They already use
582 ;; inhibit-local-variables-regexps, which is probably enough, and
583 ;; could also just set enable-local-variables locally to nil.
584 ;; Them setting it has the side-effect that dir-locals cannot apply to
585 ;; eg tar files (?). FIXME Is this appropriate?
586 ;; AFAICS, rmail is the only thing that needs this, and the only
587 ;; reason it uses it is for BABYL files (which are obsolete).
588 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
589 ;; to respect, so that find-file on a BABYL file will switch to
590 ;; rmail-mode automatically (this is nice, but hardly essential,
591 ;; since most people are used to explicitly running a command to
592 ;; access their mail; M-x gnus etc). Rmail files may happen to
593 ;; contain Local Variables sections in messages, which Rmail wants to
594 ;; ignore. So AFAICS the only reason this variable exists is for a
595 ;; minor convenience feature for handling of an obsolete Rmail file format.
597 "Like `enable-local-variables', except for major mode in a -*- line.
598 The meaningful values are nil and non-nil. The default is non-nil.
599 It should be set in a buffer-local fashion.
601 Setting this to nil has the same effect as setting `enable-local-variables'
602 to nil, except that it does not ignore any mode: setting in a -*- line.
603 Unless this difference matters to you, you should set `enable-local-variables'
608 The value can be t, nil or something else.
609 A value of t means obey `eval' variables.
610 A value of nil means ignore them; anything else means query."
611 :risky t
618 "Non-nil means buffers visiting files read-only do so in view mode.
619 In fact, this means that all read-only buffers normally have
620 View mode enabled, including buffers that are read-only because
621 you visit a file you cannot alter, and buffers you make read-only
627 "History list of file names entered in the minibuffer.
629 Maximum length of the history list is determined by the value
633 "If non-nil, avoid messages when saving files.
634 Error-related messages will still be printed, but all other
637 \f
640 "Provides support for ange-ftp host name completion.
641 Runs the usual ange-ftp hook, but only for completion operations."
642 ;; Having this here avoids the need to load ange-ftp when it's not
643 ;; really in use.
649 inhibit-file-name-handlers)))
657 "Convert a standard file's name to something suitable for the OS.
658 This means to guarantee valid names and perhaps to canonicalize
659 certain patterns.
661 FILENAME should be an absolute file name since the conversion rules
662 sometimes vary depending on the position in the file name. E.g. c:/foo
663 is a valid DOS file name, but c:/bar/c:/foo is not.
665 This function's standard definition is trivial; it just returns
666 the argument. However, on Windows and DOS, replace invalid
667 characters. On DOS, make sure to obey the 8.3 limitations.
668 In the native Windows build, turn Cygwin names into native names.
670 See Info node `(elisp)Standard File Names' for more details."
675 ;; Replace invalid filename characters with !
679 name))
687 "Read directory name, prompting with PROMPT and completing in directory DIR.
688 Value is not expanded---you must call `expand-file-name' yourself.
689 Default name to DEFAULT-DIRNAME if user exits with the same
690 non-empty string that was inserted by this function.
691 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
692 or just DIR if INITIAL is nil.)
693 If the user exits with an empty minibuffer, this function returns
694 an empty string. (This can only happen if the user erased the
695 pre-inserted contents or if `insert-default-directory' is nil.)
696 Fourth arg MUSTMATCH non-nil means require existing directory's name.
697 Non-nil and non-t means also require confirmation after completion.
698 Fifth arg INITIAL specifies text to start with.
699 DIR should be an absolute directory name. It defaults to
700 the value of `default-directory'."
705 dir))
706 mustmatch initial
709 \f
711 "Show the current default directory.
712 With prefix argument INSERT, insert the current default directory
713 at point instead."
720 "Value of the CDPATH environment variable, as a list.
724 "Explode a search path into a list of directory names.
725 Directories are separated by `path-separator' (which is colon in
726 GNU and Unix systems). Substitute environment variables into the
727 resulting list of directory names. For an empty path element (i.e.,
728 a leading or trailing separator, or two adjacent separators), return
729 nil (meaning `default-directory') as the associated list element."
737 "Change current directory to given absolute file name DIR."
738 ;; Put the name into directory syntax now,
739 ;; because otherwise expand-file-name may give some bad results.
741 ;; We used to additionally call abbreviate-file-name here, for an
742 ;; unknown reason. Problem is that most buffers are setup
743 ;; without going through cd-absolute and don't call
744 ;; abbreviate-file-name on their default-directory, so the few that
745 ;; do end up using a superficially different directory.
757 "Make DIR become the current buffer's default directory.
758 If your environment includes a `CDPATH' variable, try each one of
759 that list of directories (separated by occurrences of
760 `path-separator') when resolving a relative directory name.
761 The path separator is colon in GNU and GNU-like systems."
764 ;; FIXME: There's a subtle bug in the completion below. Seems linked
765 ;; to a fundamental difficulty of implementing `predicate' correctly.
766 ;; The manifestation is that TAB may list non-directories in the case where
767 ;; those files also correspond to valid directories (if your cd-path is (A/
768 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
769 ;; will be listed as valid completions).
770 ;; This is because `a' (listed because of A/a) is indeed a valid choice
771 ;; (which will lead to the use of B/a).
776 cd-path nil))
785 default-directory default-directory
786 t))))
796 "Return list of all files under DIR that have file names matching REGEXP.
798 order, and files from each directory are sorted in alphabetical order.
799 Each file name appears in the returned list in its absolute form.
800 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
801 output directories whose names match REGEXP."
804 ;; When DIR is "/", remote file names like "/method:" could
805 ;; also be offered. We shall suppress them.
813 ;; Don't follow symlinks to other directories.
817 full-file regexp include-directories))))
828 "Load the Lisp file named FILE."
829 ;; This is a case where .elc and .so/.dll make a lot of sense.
833 completion-ignored-extensions))))
838 "Search for FILENAME through PATH.
839 If found, return the absolute file name of FILENAME; otherwise
840 return nil.
841 PATH should be a list of directories to look in, like the lists in
842 `exec-path' or `load-path'.
843 If SUFFIXES is non-nil, it should be a list of suffixes to append to
846 If non-nil, PREDICATE is used instead of `file-readable-p'.
848 This function will normally skip directories, so if you want it to find
849 directories, make sure the PREDICATE function returns `dir-ok' for them.
851 PREDICATE can also be an integer to pass to the `access' system call,
852 in which case file-name handlers are ignored. This usage is deprecated.
853 For compatibility, PREDICATE can also be one of the symbols
854 `executable', `readable', `writable', or `exists', or a list of
855 one or more of those symbols."
866 "Do completion for file names passed to `locate-file'."
869 ;; FIXME: maybe we should use completion-file-name-table instead,
870 ;; tho at least for `load', the arg is passed through
871 ;; substitute-in-file-name for historical reasons.
881 ;; If we have files like "foo.el" and "foo.elc", we could load one of
882 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
883 ;; preferred way. So if we list all 3, that gives a lot of redundant
884 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
885 ;; the user does want to pay attention to the extension. We try to
886 ;; diffuse this tension by stripping the suffix, except when the
887 ;; result is a single element (i.e. usually we only list "foo" unless
888 ;; it's the only remaining element in the list, in which case we do
889 ;; list "foo", "foo.elc" and "foo.el").
900 string-file dir))
905 ;; Switching from names to names+fullnames creates a non-monotonicity
906 ;; which can cause problems with things like partial-completion.
907 ;; To minimize the problem, filter out completion-regexp-list, so that
908 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
909 ;; from `names' which only matched `string' when they still had
910 ;; their suffix.
912 ;; Remove duplicates of the first element, so that we can easily check
913 ;; if `names' really only contains a single element.
916 ;; There's no more than one matching non-suffixed element, so expand
917 ;; the list by adding the suffixed elements as well.
920 string-dir names string-file pred action)))))
923 "Do completion for file names passed to `locate-file'.
924 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
928 string nil action))
932 "Regexp of directory names which stop the search in `locate-dominating-file'.
933 Any directory whose name matches this regexp will be treated like
934 a kind of root directory by `locate-dominating-file' which will stop its search
935 when it bumps into it.
936 The default regexp prevents fruitless and time-consuming attempts to find
937 special files in directories in which filenames are interpreted as hostnames,
941 "Starting at FILE, look up directory hierarchy for directory containing NAME.
942 FILE can be a file or a directory. If it's a file, its directory will
943 serve as the starting point for searching the hierarchy of directories.
944 Stop at the first parent directory containing a file NAME,
945 and return the directory. Return nil if not found.
946 Instead of a string, NAME can also be a predicate taking one argument
947 \(a directory) and returning a non-nil value if that directory is the one for
948 which we're looking. The predicate will be called with every file/directory
949 the function needs to examine, starting with FILE."
950 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
951 ;; `name' in /home or in /.
954 try)
968 "Non-nil means warn if cannot access `user-emacs-directory'.
969 Set this to nil at your own risk..."
975 "Return an absolute per-user Emacs-specific file name.
976 If NEW-NAME exists in `user-emacs-directory', return it.
977 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
978 Else return NEW-NAME in `user-emacs-directory', creating the
979 directory if it does not exist."
987 at-home
988 ;; Make sure `user-emacs-directory' exists,
989 ;; unless we're in batch mode or dumping Emacs.
991 purify-flag
1001 user-emacs-directory-warning
1003 ;; Only warn once per Emacs session.
1007 Unable to %s `user-emacs-directory' (%s).
1008 Any data that would normally be written there may be lost!
1009 If you never want to see this message again,
1010 customize the variable `user-emacs-directory-warning'."
1011 errtype user-emacs-directory)))))
1012 bestname))))
1016 "Search for COMMAND in `exec-path' and return the absolute file name.
1017 Return nil if COMMAND is not found anywhere in `exec-path'."
1018 ;; Use 1 rather than file-executable-p to better match the behavior of
1019 ;; call-process.
1023 "Load the Emacs Lisp library named LIBRARY.
1024 LIBRARY should be a string.
1025 This is an interface to the function `load'. LIBRARY is searched
1026 for in `load-path', both with and without `load-suffixes' (as
1027 well as `load-file-rep-suffixes').
1029 See Info node `(emacs)Lisp Libraries' for more details.
1030 See `load-file' for a different interface to `load'."
1035 load-path
1040 "Test whether FILE specifies a location on a remote system.
1041 A file is considered remote if accessing it is likely to
1042 be slower or less reliable than accessing local files.
1044 `file-remote-p' never opens a new remote connection. It can
1045 only reuse a connection that is already open.
1047 Return nil or a string identifying the remote connection
1048 \(ideally a prefix of FILE). Return nil if FILE is a relative
1049 file name.
1051 When IDENTIFICATION is nil, the returned string is a complete
1052 remote identifier: with components method, user, and host. The
1053 components are those present in FILE, with defaults filled in for
1054 any that are missing.
1056 IDENTIFICATION can specify which part of the identification to
1057 return. IDENTIFICATION can be the symbol `method', `user',
1058 `host', or `localname'. Any other value is handled like nil and
1059 means to return the complete identification. The string returned
1060 for IDENTIFICATION `localname' can differ depending on whether
1061 there is an existing connection.
1063 If CONNECTED is non-nil, return an identification only if FILE is
1064 located on a remote system and a connection is established to
1065 that remote system.
1067 Tip: You can use this expansion of remote identifier components
1068 to derive a new remote file name from an existing one. For
1074 same remote identifier as FILE but expanded; a name such as
1079 nil)))
1081 ;; Probably this entire variable should be obsolete now, in favor of
1082 ;; something Tramp-related (?). It is not used in many places.
1083 ;; It's not clear what the best file for this to be in is, but given
1084 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1085 ;; rather than autoloaded.
1087 ;; This used to try various hard-coded places for remsh, rsh, and
1088 ;; rcmd, trying to guess based on location whether "rsh" was
1089 ;; "restricted shell" or "remote shell", but I don't see the point
1090 ;; in this day and age. Almost everyone will use ssh, and have
1091 ;; whatever command they want to use in PATH.
1098 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1105 "Whether to use the remote file-name cache for read access.
1106 When nil, never expire cached values (caution)
1107 When t, never use the cache (safe, but may be slow)
1108 A number means use cached values for that amount of seconds since caching.
1110 The attributes of remote files are cached for better performance.
1111 If they are changed outside of Emacs's control, the cached values
1112 become invalid, and must be reread. If you are sure that nothing
1113 other than Emacs changes the files, you can set this variable to nil.
1115 If a remote file is checked regularly, it might be a good idea to
1116 let-bind this variable to a value less than the interval between
1117 consecutive checks. For example:
1119 (defun display-time-file-nonempty-p (file)
1120 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1121 (and (file-exists-p file)
1122 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1133 "Return the local name component of FILE.
1134 It returns a file name which can be used directly as argument of
1135 `process-file', `start-file-process', or `shell-command'."
1139 "Copy the file FILE into a temporary file on this machine.
1140 Returns the name of the local copy, or nil, if FILE is directly
1141 accessible."
1142 ;; This formerly had an optional BUFFER argument that wasn't used by
1143 ;; anything.
1147 nil)))
1150 "Return non-nil if FILE is an absolute name to the operating system.
1151 This is like `file-name-absolute-p', except that it returns nil for
1152 names beginning with `~'."
1157 "Splice DIRNAME to FILE like the operating system would.
1158 If FILE is relative, return DIRNAME concatenated to FILE.
1159 Otherwise return FILE, quoted as needed if DIRNAME and FILE have
1160 different handlers; although this quoting is dubious if DIRNAME
1161 is magic, it is not clear what would be better. This function
1162 differs from `expand-file-name' in that DIRNAME must be a
1163 directory name and leading `~' and `/:' are not special in FILE."
1165 file
1169 unquoted
1173 "Return the truename of FILENAME.
1174 If FILENAME is not absolute, first expands it against `default-directory'.
1175 The truename of a file name is found by chasing symbolic links
1176 both at the level of the file and at the level of the directories
1177 containing it, until no links are left at any level.
1180 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1181 ;; COUNTER can be a cons cell whose car is the count of how many
1182 ;; more links to chase before getting an error.
1183 ;; PREV-DIRS can be a cons cell whose car is an alist
1184 ;; of truenames we've just recently computed.
1198 ;; For speed, remove the ange-ftp completion handler from the list.
1199 ;; We know it's not needed here.
1200 ;; For even more speed, do this only on the outermost call.
1207 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1208 ;; case differences being ignored by the OS, and short "8.3 DOS"
1209 ;; name aliases existing for all files. (The short names are not
1210 ;; reported by directory-files, but can be used to refer to files.)
1211 ;; It seems appropriate for file-truename to resolve these issues in
1212 ;; the most natural way, which on Windows is to call the function
1213 ;; `w32-long-file-name' - this returns the exact name of a file as
1214 ;; it is stored on disk (expanding short name aliases with the full
1215 ;; name in the process).
1218 ;; If filename exists, use its long name. If it doesn't
1219 ;; exist, the recursion below on the directory of filename
1220 ;; will drill down until we find a directory that exists,
1221 ;; and use the long name of that, with the extra
1222 ;; non-existent path components concatenated.
1227 ;; If this file directly leads to a link, process that iteratively
1228 ;; so that we don't use lots of stack.
1234 ;; For file name that has a special handler, call handler.
1235 ;; This is so that ange-ftp can save time by doing a no-op.
1238 done t)
1240 target dirfile)
1241 ;; Get the truename of the directory.
1243 ;; If these are equal, we have the (or a) root directory.
1247 ;; If this is the same dir we last got the truename for,
1248 ;; save time--don't recalculate.
1258 done t)
1261 done t)
1262 ;; Put it back on the file name.
1264 ;; Is the file name the name of a link?
1267 ;; Yes => chase that link, then start all over
1268 ;; since the link may point to a directory name that uses links.
1269 ;; We can't safely use expand-file-name here
1270 ;; since target might look like foo/../bar where foo
1271 ;; is itself a link. Instead, we handle . and .. above.
1273 done nil)
1274 ;; No, we are done!
1276 filename))
1279 "Chase links in FILENAME until a name that is not a link.
1280 Unlike `file-truename', this does not check whether a parent
1281 directory name is a symbolic link.
1282 If the optional argument LIMIT is a number,
1283 it means chase no more than that many links and then stop."
1291 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1294 ;; Handle `..' by hand, since it needs to work in the
1295 ;; target of any directory symlink.
1296 ;; This code is not quite complete; it does not handle
1297 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1301 ;; Chase links in the default dir of the symlink.
1305 ;; Now find the parent of that dir.
1308 tem))
1310 newname))
1312 ;; A handy function to display file sizes in human-readable form.
1313 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1315 "Produce a string showing FILE-SIZE in human-readable form.
1317 Optional second argument FLAVOR controls the units and the display format:
1319 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1321 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1323 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1326 1024.0
1329 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1335 "%.1f%s%s"
1337 file-size
1339 "K"
1345 "^//[^/]+/"
1346 ;; regexp-opt.el is not dumped into emacs binary.
1347 ;;(concat
1348 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1350 "File systems which ought to be mounted."
1357 "The directory for writing temporary files.
1358 In case of a remote `default-directory', this is a directory for
1359 temporary files on that remote host. If such a directory does
1360 not exist, or `default-directory' ought to be located on a
1361 mounted file system (see `mounted-file-systems'), the function
1362 returns `default-directory'.
1363 For a non-remote and non-mounted `default-directory', the value of
1364 the variable `temporary-file-directory' is returned."
1370 default-directory
1371 temporary-file-directory))))
1374 "Create a temporary file.
1375 The returned file name (created by appending some random characters at the end
1376 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1377 is guaranteed to point to a newly created file.
1378 You can then use `write-region' to write new data into the file.
1380 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1382 If SUFFIX is non-nil, add that at the end of the file name.
1384 If TEXT is a string, insert it into the new file; DIR-FLAG should be nil.
1385 Otherwise the file will be empty."
1397 "Implement (make-temp-file ABSOLUTE-PREFIX DIR-FLAG SUFFIX TEXT).
1398 This implementation works on magic file names."
1399 ;; Create temp files with strict access rights. It's easy to
1400 ;; loosen them later, whereas it's impossible to close the
1401 ;; time-window of loose permissions otherwise.
1404 file)
1413 nil)
1415 ;; the file was somehow created by someone else between
1416 ;; `make-temp-name' and `write-region', let's try again.
1417 nil)
1418 file)))
1421 "Create a temporary file as close as possible to `default-directory'.
1422 If PREFIX is a relative file name, and `default-directory' is a
1423 remote file name or located on a mounted file systems, the
1424 temporary file is created in the directory returned by the
1425 function `temporary-file-directory'. Otherwise, the function
1426 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1427 same meaning as in `make-temp-file'."
1436 "Change the encoding of FILE's name from CODING to NEW-CODING.
1437 The value is a new name of FILE.
1438 Signals a `file-already-exists' error if a file of the new name
1439 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1440 is non-nil. A number as fourth arg means request confirmation if
1441 the new name already exists. This is what happens in interactive
1442 use with M-x."
1445 default-file-name-coding-system))
1447 from-coding to-coding)
1449 ;; We provide the default coding only when it seems that
1450 ;; the filename is correctly decoded by the default
1451 ;; coding.
1457 filename default-coding)
1458 default-coding))
1462 ;; We provide the default coding only when a user is going to
1463 ;; change the encoding not from the default coding.
1467 filename from-coding)))
1470 filename from-coding default-coding)
1471 default-coding)))
1475 default-file-name-coding-system))
1476 ;; FILE should have been decoded by DEFAULT-CODING.
1480 ;; Suppress further encoding.
1485 newname))
1486 \f
1488 "Whether confirmation is requested before visiting a new file or buffer.
1489 If nil, confirmation is not requested.
1490 If the value is `after-completion', confirmation is only
1491 requested if the user called `minibuffer-complete' right before
1492 `minibuffer-complete-and-exit'.
1493 Any other non-nil value means to request confirmation.
1495 This affects commands like `switch-to-buffer' and `find-file'."
1503 "Whether to request confirmation before visiting a new file or buffer.
1504 The variable `confirm-nonexistent-file-or-buffer' determines the
1505 return value, which may be passed as the REQUIRE-MATCH arg to
1506 `read-buffer' or `find-file-read-args'."
1514 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1516 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1517 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1518 instead of prepending it.
1520 BODY should use the minibuffer at most once.
1521 Recursive uses of the minibuffer are unaffected (FUN is not
1522 called additional times).
1524 This macro actually adds an auxiliary function that calls FUN,
1525 rather than FUN itself, to `minibuffer-setup-hook'."
1536 ;; Clear out this hook so it does not interfere
1537 ;; with any recursive minibuffer usage.
1548 t))
1551 "Edit file FILENAME.
1552 Switch to a buffer visiting file FILENAME,
1553 creating one if none already exists.
1554 Interactively, the default if you just type RET is the current directory,
1555 but the visited file name is available through the minibuffer history:
1556 type M-n to pull it into the minibuffer.
1558 You can visit files on remote machines by specifying something
1559 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1560 also visit local files as a different user by specifying
1561 /sudo::FILE for the file name.
1562 See the Info node `(tramp)File name Syntax' in the Tramp Info
1563 manual, for more about this.
1565 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1566 expand wildcards (if any) and visit multiple files. You can
1567 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1569 To visit a file without any kind of conversion and without
1580 "Edit file FILENAME, in another window.
1583 an existing one. See the function `display-buffer'.
1585 Interactively, the default if you just type RET is the current directory,
1586 but the visited file name is available through the minibuffer history:
1587 type M-n to pull it into the minibuffer.
1589 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1590 expand wildcards (if any) and visit multiple files."
1600 value)
1604 "Edit file FILENAME, in another frame.
1607 an existing one. See the function `display-buffer'.
1609 Interactively, the default if you just type RET is the current directory,
1610 but the visited file name is available through the minibuffer history:
1611 type M-n to pull it into the minibuffer.
1613 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1614 expand wildcards (if any) and visit multiple files."
1624 value)
1628 "Edit the existing file FILENAME.
1630 file names with wildcards."
1647 value))
1650 "Edit file FILENAME but don't allow changes.
1659 "Edit file FILENAME in another window but don't allow changes.
1668 "Edit file FILENAME in another frame but don't allow changes.
1677 "Find file FILENAME as a replacement for the file in the next window.
1678 This command does not select that window.
1682 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1683 expand wildcards (if any) and replace the file with multiple files."
1694 "Find alternate file: " file-dir nil
1696 t))))
1703 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1705 "Hook run when a buffer is killed.
1706 The buffer being killed is current while the hook is running.
1707 See `kill-buffer'.
1709 Note: Be careful with let-binding this hook considering it is
1713 "Find file FILENAME, select its buffer, kill previous buffer.
1714 If the current buffer now contains an empty file that you just visited
1715 \(presumably by mistake), use this command to visit the file you really want.
1719 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1720 expand wildcards (if any) and replace the file with multiple files.
1722 If the current buffer is an indirect buffer, or the base buffer
1723 for one or more indirect buffers, the other buffer(s) are not
1724 killed."
1733 "Find alternate file: " file-dir nil
1735 t)))
1749 ;; Run `kill-buffer-hook' here. It needs to happen before
1750 ;; variables like `buffer-file-name' etc are set to nil below,
1751 ;; because some of the hooks that could be invoked
1752 ;; (e.g., `save-place-to-alist') depend on those variables.
1753 ;;
1754 ;; Note that `kill-buffer-hook' is not what queries whether to
1755 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1756 ;; asks that itself. Thus, there's no need to temporarily do
1757 ;; `(set-buffer-modified-p nil)' before running this hook.
1759 ;; Okay, now we can end-of-life the old buffer.
1766 ;; This prevents us from finding the same buffer
1767 ;; if we specified the same file again.
1771 ;; Likewise for dired buffers.
1775 ;; This executes if find-file gets an error
1776 ;; and does not really find anything.
1777 ;; We put things back as they were.
1778 ;; If find-file actually finds something, we kill obuf below.
1787 ;; We already ran these; don't run them again.
1790 \f
1791 ;; FIXME we really need to fold the uniquify stuff in here by default,
1792 ;; not using advice, and add it to the doc string.
1794 "Create a suitably named buffer for visiting FILENAME, and return it.
1795 FILENAME (sans directory) is used unchanged if that name is free;
1796 otherwise a string <2> or <3> or ... is appended to get an unused name.
1798 Emacs treats buffers whose names begin with a space as internal buffers.
1799 To avoid confusion when visiting a file whose name begins with a space,
1806 lastname))))
1809 "Create and return a buffer with a name based on NAME.
1810 Choose the buffer's name using `generate-new-buffer-name'."
1814 "Regexp to match the automounter prefix in a directory name."
1820 "Regexp matching the user's homedir at the beginning of file name.
1824 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1826 home directory is a root directory) and removes automounter prefixes
1827 \(see the variable `automount-dir-prefix')."
1828 ;; Get rid of the prefixes added by the automounter.
1835 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1837 ;; If any elt of directory-abbrev-alist matches this name,
1838 ;; abbreviate accordingly.
1844 ;; Compute and save the abbreviated homedir name.
1845 ;; We defer computing this until the first time it's needed, to
1846 ;; give time for directory-abbrev-alist to be set properly.
1847 ;; We include a slash at the end, to avoid spurious matches
1848 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1856 ;; Depending on whether default-directory does or
1857 ;; doesn't include non-ASCII characters, the value
1858 ;; of abbreviated-home-dir could be multibyte or
1859 ;; unibyte. In the latter case, we need to decode
1860 ;; it. Note that this function is called for the
1861 ;; first time (from startup.el) when
1862 ;; locale-coding-system is already set up.
1864 abbreviated-home-dir
1867 'utf-8
1868 locale-coding-system))))))
1870 ;; If FILENAME starts with the abbreviated homedir,
1871 ;; make it start with `~' instead.
1873 ;; If the home dir is just /, don't change it.
1876 ;; MS-DOS root directories can come with a drive letter;
1877 ;; Novell Netware allows drive letters beyond `Z:'.
1885 filename)))
1888 "Return the buffer visiting file FILENAME (a string).
1889 This is like `get-file-buffer', except that it checks for any buffer
1890 visiting the same file, possibly under a different name.
1891 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1892 and others are ignored.
1893 If there is no such live buffer, return nil."
1906 found)
1916 ;; Verify this buffer's file number
1917 ;; still belongs to its file.
1920 attributes)
1924 found))))
1925 \f
1927 "Non-nil means file-visiting commands should handle wildcards.
1928 For example, if you specify `*.c', that would visit all the files
1929 whose names match the pattern."
1935 "Non-nil means suppress warning messages for symlinked files.
1936 When nil, Emacs prints a warning when visiting a file that is already
1937 visited, but with a different name. Setting this option to t
1938 suppresses this warning."
1944 "Maximum size of file above which a confirmation is requested.
1945 When nil, never request confirmation."
1952 "Warn if file size exceeds this percentage of available free memory.
1953 When nil, never issue warning. Beware: This probably doesn't do what you
1961 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1962 OP-TYPE specifies the file operation being performed (for message to user)."
1971 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1981 "You are trying to open a file whose size (%s)
1982 exceeds the %S%% of currently available free memory (%s).
1983 If that fails, try to open it with `find-file-literally'
1984 \(but note that some characters might be displayed incorrectly)."
1986 out-of-memory-warning-percentage
1990 "Like `message', except sometimes don't print to minibuffer.
1991 If the variable `save-silently' is non-nil, the message is not
1992 displayed on the minibuffer."
1997 "Read file FILENAME into a buffer and return the buffer.
1998 If a buffer exists visiting FILENAME, return that one, but
1999 verify that the file has not changed since visited or saved.
2000 The buffer is not selected, just returned to the caller.
2001 Optional second arg NOWARN non-nil means suppress any warning messages.
2002 Optional third arg RAWFILE non-nil means the file is read literally.
2003 Optional fourth arg WILDCARDS non-nil means do wildcard processing
2004 and visit all the matching files. When wildcards are actually
2005 used and expanded, return a list of buffers that are visiting
2006 the various files."
2013 'find-directory-functions
2016 filename)))
2019 find-file-wildcards
2033 ;; Find any buffer for a file which has same truename.
2035 ;; Let user know if there is a buffer with the same truename.
2039 find-file-suppress-same-file-warnings
2043 ;; Optionally also find that buffer.
2046 ;; Check to see if the file looks uncommonly large.
2051 ;; We are using an existing buffer.
2058 ;; Certain files should be reverted automatically
2059 ;; if they have changed on disk and not in the buffer.
2067 found))
2077 "File %s changed on disk. Discard your edits? "
2082 "File %s changed on disk. Discard your edits in %s? "
2090 ;; Check if a formerly read-only file has become
2091 ;; writable and vice versa, but if the buffer agrees
2092 ;; with the new state of the file, that is ok too.
2102 buffer-file-name
2103 new-status new-status)))
2109 nonexistent
2110 ;; It is confusing to ask whether to visit
2111 ;; non-literally if they have the file in
2112 ;; hexl-mode or image-mode.
2118 "The file %s is already visited normally,
2119 and you have edited the buffer. Now you have asked to visit it literally,
2120 meaning no coding system handling, format conversion, or local variables.
2121 Emacs can only visit a file in one way at a time.
2123 Do you want to save the file, and visit it literally instead? "
2124 "The file %s is already visited literally,
2125 meaning no coding system handling, format conversion, or local variables.
2126 You have edited the buffer. Now you have asked to visit the file normally,
2127 but Emacs can only visit a file in one way at a time.
2134 rawfile truename number))
2138 "\
2139 Do you want to discard your changes, and visit the file literally now? "
2140 "\
2143 rawfile truename number)
2149 "The file %s is already visited normally.
2150 You have asked to visit it literally,
2151 meaning no coding system decoding, format conversion, or local variables.
2152 But Emacs can only visit a file in one way at a time.
2154 Do you want to revisit the file literally now? "
2155 "The file %s is already visited literally,
2156 meaning no coding system decoding, format conversion, or local variables.
2157 You have asked to visit it normally,
2158 but Emacs can only visit a file in one way at a time.
2163 rawfile truename number)
2166 ;; Return the buffer we are using.
2167 buf)
2168 ;; Create a new buffer.
2170 ;; find-file-noselect-1 may use a different buffer.
2172 rawfile truename number))))))
2178 ;; Needed in case we are re-visiting the file with a different
2179 ;; text representation.
2196 filename)))
2197 ;; Unconditionally set error
2207 filename)))
2208 ;; Run find-file-not-found-functions until one returns non-nil.
2210 ;; If they fail too, set error.
2212 ;; Record the file's truename, and maybe use that as visited name.
2220 ;; Set buffer's default directory to that of the file.
2222 ;; Turn off backup files for certain file names. Since
2223 ;; this is a permanent local, the major mode won't eliminate it.
2237 \f
2239 "Like `insert-file-contents', but only reads in the file literally.
2240 See `insert-file-contents' for an explanation of the parameters.
2241 A buffer may be modified in several ways after reading into the buffer,
2242 due to Emacs features such as format decoding, character code
2243 conversion, `find-file-hook', automatic uncompression, etc.
2245 This function ensures that none of these modifications will take place."
2251 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2252 ;; into a file operation instead!
2254 inhibit-file-name-handlers))
2261 filename)))
2262 ;; Check whether the file is uncommonly large
2273 "Insert contents of file FILENAME into buffer after point with no conversion.
2275 This function is meant for the user to run interactively.
2276 Don't call it from programs! Use `insert-file-contents-literally' instead.
2277 \(Its calling sequence is different; see its documentation)."
2283 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2284 This has the `permanent-local' property, which takes effect if you
2289 "Visit file FILENAME with no conversion of any kind.
2290 Format conversion and character code conversion are both disabled,
2291 and multibyte characters are disabled in the resulting buffer.
2292 The major mode used is Fundamental mode regardless of the file name,
2293 and local variable specifications in the file are ignored.
2294 Automatic uncompression and adding a newline at the end of the
2295 file due to `require-final-newline' is also disabled.
2297 You cannot absolutely rely on this function to result in
2298 visiting the file literally. If Emacs already has a buffer
2299 which is visiting the file, you get the existing buffer,
2300 regardless of whether it was created literally or not.
2302 In a Lisp program, if you want to be sure of accessing a file's
2303 contents literally, you should create a temporary buffer and then read
2304 the file contents into it using `insert-file-contents-literally'."
2307 "Find file literally: " nil default-directory
2310 \f
2312 _after-find-file-from-revert-buffer
2313 nomodes)
2314 "Called after finding a file and by the default revert function.
2315 Sets buffer mode, parses local variables.
2316 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2317 error in reading the file. WARN non-nil means warn if there
2318 exists an auto-save file more recent than the visited file.
2319 NOAUTO means don't mess with auto-save mode.
2320 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2321 \(see `revert-buffer-in-progress-p' for similar functionality).
2322 Fifth arg NOMODES non-nil means don't alter the file's modes.
2323 Finishes by calling the functions in `find-file-hook'
2324 unless NOMODES is non-nil."
2327 nil
2337 "Symbolic link that points to nonexistent file"
2341 ;; No need to warn if buffer is auto-saved
2342 ;; under the name of the visited file.
2344 auto-save-visited-file-name))
2347 buffer-file-name))
2367 ;; Make people do a little extra work (C-x C-q)
2368 ;; before altering a backup file.
2371 ;; When a file is marked read-only,
2372 ;; make the buffer read-only even if root is looking at it.
2380 ;; If requested, add a newline at the end of the file.
2391 view-read-only
2399 "Choose the major mode for this buffer automatically.
2400 Also sets up any specified local variables of the file.
2401 Uses the visited file name, the -*- line, and the local variables spec.
2403 This function is called automatically from `find-file'. In that case,
2404 we may set up the file-specified mode and local variables,
2405 depending on the value of `enable-local-variables'.
2406 In addition, if `local-enable-local-variables' is nil, we do
2407 not set local variables (though we do notice a mode specified with -*-.)
2409 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2410 or from Lisp without specifying the optional argument FIND-FILE;
2411 in that case, this function acts as if `enable-local-variables' were t."
2418 ;; FIXME this is less efficient than it could be, since both
2419 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2422 ;; `delay-mode-hooks' being non-nil will have prevented the major
2423 ;; mode's call to `run-mode-hooks' from calling
2424 ;; `hack-local-variables'. In that case, call it now.
2428 ;; Turn font lock off and on, to make sure it takes account of
2429 ;; whatever file local variables are relevant to it.
2431 ;; Font-lock-mode (now in font-core.el) can be ON when
2432 ;; font-lock.el still hasn't been loaded.
2439 "Non-nil means to try second pass through `auto-mode-alist'.
2440 This means that if the first case-sensitive search through the alist fails
2441 to find a matching major mode, a second case-insensitive search is made.
2442 On systems with case-insensitive file names, this variable is ignored,
2443 since only a single case-insensitive search through the alist is made."
2449 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2450 ;; c++-mode, java-mode and more) are added through autoload
2451 ;; directives in that file. That way is discouraged since it
2452 ;; spreads out the definition of the initial value.
2498 ;; Less common extensions come here
2499 ;; so more common ones above are found faster.
2507 ;; Besides .gdbinit, gdb documents other names to be usable for init
2508 ;; files, cross-debuggers can use something like
2509 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2510 ;; don't interfere with each other.
2512 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2513 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2514 ;; loaded when GDB reads an objfile called 'emacs'.
2522 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2546 ;; The Fortran standard does not say anything about file extensions.
2547 ;; .f90 was widely used for F90, now we seem to be trapped into
2548 ;; using a different extension for each language revision.
2549 ;; Anyway, the following extensions are supported by gfortran.
2557 ;; The list of archive file extensions should be in sync with
2558 ;; `auto-coding-alist' with `no-conversion' coding system.
2564 ;; Mailer puts message to be edited in
2565 ;; /tmp/Re.... or Message
2568 ;; some news reader is reported to use this
2582 ;; .emacs or .gnus or .viper following a directory delimiter in
2583 ;; Unix or MS-DOS syntax.
2586 ;; _emacs following a directory delimiter in MS-DOS syntax
2590 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2591 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2592 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2595 ;; .xs is also used for ld scripts, but seems to be more commonly
2596 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2598 ;; Explained in binutils ld/genscripts.sh. Eg:
2599 ;; A .x script file is the default script.
2600 ;; A .xr script is for linking without relocation (-r flag). Etc.
2604 ;; Common Lisp ASDF package system.
2611 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2623 ;; Windows candidates may be opened case sensitively on Unix
2631 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2632 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2633 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2634 ;; this has lower priority to avoid matching changelog.sgml etc.
2636 ;; either user's dot-files or under /etc or some such
2638 ;; alas not all ~/.*rc files are like this
2639 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2644 ;; this contains everything twice, with space and with colon :-(
2646 ;; Get rid of any trailing .n.m and try again.
2647 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2648 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2649 ;; Using mode nil rather than `ignore' would let the search continue
2650 ;; through this list (with the shortened name) rather than start over.
2653 ;; This should come after "in" stripping (e.g. config.h.in).
2654 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2656 ;; The following should come after the ChangeLog pattern
2657 ;; for the sake of ChangeLog.1, etc.
2658 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2660 "Alist of filename patterns vs corresponding major mode functions.
2661 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2662 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2663 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2664 mode function to use. FUNCTION will be called, unless it is nil.
2666 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2667 calling FUNCTION (if it's not nil), we delete the suffix that matched
2668 REGEXP and search the list again for another match.
2670 The extensions whose FUNCTION is `archive-mode' should also
2671 appear in `auto-coding-alist' with `no-conversion' coding system.
2673 See also `interpreter-mode-alist', which detects executable script modes
2674 based on the interpreters they specify to run,
2679 "Select Conf mode or XML mode according to start of file."
2689 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2690 ;; and pike-mode) are added through autoload directives in that
2691 ;; file. That way is discouraged since it spreads out the
2692 ;; definition of the initial value.
2721 "Alist mapping interpreter names to major modes.
2722 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2723 Each element looks like (REGEXP . MODE).
2724 If REGEXP matches the entire name (minus any directory part) of
2725 the interpreter specified in the first line of a script, enable
2726 major mode MODE.
2733 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2734 ;; because we are duplicating info from auto-mode-alist.
2735 ;; TODO many elements of this list are also in auto-coding-alist.
2744 "List of regexps matching file names in which to ignore local variables.
2746 Files matching this list are typically binary file formats.
2747 They may happen to contain sequences that look like local variable
2748 specifications, but are not really, or they may be containers for
2749 member files with their own local variable sections, which are
2750 not appropriate for the containing file.
2757 "List of regexps matching suffixes to remove from file names.
2758 The function `inhibit-local-variables-p' uses this: when checking
2759 a file name, it first discards from the end of the name anything that
2762 ;; Can't think of any situation in which you'd want this to be nil...
2767 "Return non-nil if file local variables should be ignored.
2768 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2769 and `inhibit-local-variables-suffixes'. If
2770 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2779 sufs)
2784 temp))
2789 "Regexp matching interpreters, for file mode determination.
2790 This regular expression is matched against the first line of a file
2791 to determine the file's mode in `set-auto-mode'. If it matches, the file
2792 is assumed to be interpreted by the interpreter matched by the second group
2793 of the regular expression. The mode is then determined as the mode
2797 "Alist of buffer beginnings vs. corresponding major mode functions.
2798 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2799 After visiting a file, if REGEXP matches the text at the beginning of the
2800 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2801 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2802 major mode.
2804 If FUNCTION is nil, then it is not called. (That is a way of saying
2812 ;; The < comes before the groups (but the first) to reduce backtracking.
2813 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2814 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2818 comment-re "*"
2821 . mhtml-mode)
2823 ;; These two must come after html, because they are more general:
2828 . sgml-mode)
2831 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2832 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2833 After visiting a file, if REGEXP matches the text at the beginning of the
2834 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2835 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2836 have not specified a mode for this file.
2842 "Upper limit on `magic-mode-alist' regexp matches.
2846 "Select major mode appropriate for current buffer.
2848 To find the right major mode, this function checks for a -*- mode tag
2849 checks for a `mode:' entry in the Local Variables section of the file,
2850 checks if it uses an interpreter listed in `interpreter-mode-alist',
2851 matches the buffer beginning against `magic-mode-alist',
2852 compares the filename against the entries in `auto-mode-alist',
2853 then matches the buffer beginning against `magic-fallback-mode-alist'.
2855 If `enable-local-variables' is nil, or if the file name matches
2856 `inhibit-local-variables-regexps', this function does not check
2857 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2858 is nil, then the only mode: tag that can be relevant is a -*- one.
2860 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2861 set the major mode only if that would change it. In other words
2862 we don't actually set it to the same mode the buffer already has."
2863 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2865 end done mode modes)
2866 ;; Once we drop the deprecated feature where mode: is also allowed to
2867 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2868 ;; remove this section and just let (hack-local-variables t) handle it.
2869 ;; Find a -*- mode tag.
2873 ;; Note by design local-enable-local-variables does not matter here.
2875 try-locals
2878 ;; Find all specifications for the `mode:' variable
2879 ;; and execute them left to right.
2891 modes)))
2892 ;; Simple -*-MODE-*- case.
2895 modes))))
2896 ;; If we found modes to use, invoke them now, outside the save-excursion.
2904 ;; continuing would call minor modes again, toggling them off
2906 ;; hack-local-variables checks local-enable-local-variables etc, but
2907 ;; we might as well be explicit here for the sake of clarity.
2909 enable-local-variables
2910 local-enable-local-variables
2911 try-locals
2918 ;; If we didn't, look for an interpreter specified in the first line.
2919 ;; As a special case, allow for things like "#!/bin/env perl", which
2920 ;; finds the interpreter anywhere in $PATH.
2926 ;; Map interpreter name to a mode, signaling we're done at the
2927 ;; same time.
2934 interpreter-mode-alist)
2936 ;; If we found an interpreter mode to use, invoke it now.
2938 ;; Next try matching the buffer beginning against magic-mode-alist.
2947 nil magic-mode-alist
2956 "Problem in magic-mode-alist with element %s"
2957 re))))))))
2959 ;; Next compare the filename against the entries in auto-mode-alist.
2965 buffer-file-name)))
2966 ;; Remove backup-suffixes from file name.
2968 ;; Remove remote file name identification.
2973 ;; Find first matching alist entry.
2976 ;; Filesystem is case-insensitive.
2980 ;; Filesystem is case-sensitive.
2982 ;; First match case-sensitively.
2986 ;; Fallback to case-insensitive match.
3000 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
3017 "Problem with magic-fallback-mode-alist element: %s"
3018 re))))))))
3023 ;; When `keep-mode-if-same' is set, we are working on behalf of
3024 ;; set-visited-file-name. In that case, if the major mode specified is the
3025 ;; same one we already have, don't actually reset it. We don't want to lose
3026 ;; minor modes such as Font Lock.
3028 "Apply MODE and return it.
3029 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
3030 any aliases and compared to current major mode. If they are the
3031 same, do nothing and return nil."
3037 mode)))
3040 "Regexp of lines to skip when looking for file-local settings.
3041 If the first line matches this regular expression, then the -*-...-*- file-
3045 "Find the -*- spec in the buffer.
3046 Call with point at the place to start searching from.
3047 If one is found, set point to the beginning and return the position
3048 of the end. Otherwise, return nil; may change point.
3049 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3050 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3051 have no effect."
3054 ;; Don't look for -*- if this file name matches any
3055 ;; of the regexps in inhibit-local-variables-regexps.
3058 ;; If the file begins with "#!" (exec
3059 ;; interpreter magic), look for mode frobs
3060 ;; in the first two lines. You cannot
3061 ;; necessarily put them in the first line
3062 ;; of such a file without screwing up the
3063 ;; interpreter invocation. The same holds
3064 ;; for '\" in man pages (preprocessor
3065 ;; magic for the `man' program).
3076 end))))
3077 \f
3078 ;;; Handling file local variables
3082 file-local-variables-alist dir-local-variables-alist)
3087 "Normal hook run after processing a file's local variables specs.
3088 Major modes can use this to examine user-specified local variables
3092 "List variable-value pairs that are considered safe.
3093 Each element is a cons cell (VAR . VAL), where VAR is a variable
3094 symbol and VAL is a value that is considered safe."
3095 :risky t
3100 ;; This should be here at least as long as Emacs supports write-file-hooks.
3105 "Expressions that are considered safe in an `eval:' local variable.
3106 Add expressions to this list if you want Emacs to evaluate them, when
3107 they appear in an `eval' local variable specification, without first
3108 asking you for confirmation."
3109 :risky t
3114 ;; Risky local variables:
3117 buffer-auto-save-file-name
3118 buffer-file-name
3119 buffer-file-truename
3120 buffer-undo-list
3121 debugger
3122 default-text-properties
3123 eval
3124 exec-directory
3125 exec-path
3126 file-name-handler-alist
3127 frame-title-format
3128 global-mode-string
3129 header-line-format
3130 icon-title-format
3131 inhibit-quit
3132 load-path
3133 max-lisp-eval-depth
3134 max-specpdl-size
3135 minor-mode-map-alist
3136 minor-mode-overriding-map-alist
3137 mode-line-format
3138 mode-name
3139 overriding-local-map
3140 overriding-terminal-local-map
3141 process-environment
3142 standard-input
3143 standard-output
3144 unread-command-events))
3146 ;; Safe local variables:
3147 ;;
3148 ;; For variables defined by major modes, the safety declarations can go into
3149 ;; the major mode's file, since that will be loaded before file variables are
3150 ;; processed.
3151 ;;
3152 ;; For variables defined by minor modes, put the safety declarations in the
3153 ;; file defining the minor mode after the defcustom/defvar using an autoload
3154 ;; cookie, e.g.:
3155 ;;
3156 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3157 ;;
3158 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3159 ;; minor mode file may not be loaded yet.
3160 ;;
3161 ;; For variables defined in the C source code the declaration should go here:
3183 "Alist of file-local variable settings in the current buffer.
3184 Each element in this list has the form (VAR . VALUE), where VAR
3185 is a file-local variable (a symbol) and VALUE is the value
3186 specified. The actual value in the buffer may differ from VALUE,
3192 "Alist of directory-local variable settings in the current buffer.
3193 Each element in this list has the form (VAR . VALUE), where VAR
3194 is a directory-local variable (a symbol) and VALUE is the value
3195 specified in .dir-locals.el. The actual value in the buffer
3196 may differ from VALUE, if it is changed by the major or minor modes,
3201 "Normal hook run before setting file-local variables.
3202 It is called after checking for unsafe/risky variables and
3203 setting `file-local-variables-alist', and before applying the
3204 variables stored in `file-local-variables-alist'. A hook
3205 function is allowed to change the contents of this alist.
3207 This hook is called only if there is at least one file-local
3211 "Get confirmation before setting up local variable values.
3212 ALL-VARS is the list of all variables to be set up.
3213 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3214 RISKY-VARS is the list of those that are marked as risky.
3215 If these settings come from directory-local variables, then
3216 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3223 unsafe-vars))
3225 ;; Set up the contents of the *Local Variables* buffer.
3233 ", and variables that are risky (**)."
3241 y -- to apply the local variables list.
3245 ! -- to apply the local variables list, and permanently mark these
3257 ;; Make strings with embedded whitespace easier to read.
3265 ;; Display the buffer and read a choice.
3273 ""
3276 char)
3295 "Return local variables specified in the -*- line.
3296 Usually returns an alist of elements (VAR . VAL), where VAR is a
3297 variable and VAL is the specified value. Ignores any
3298 specification for `coding:', and sometimes for `mode' (which
3299 should have already been handled by `set-auto-coding' and
3300 `set-auto-mode', respectively). Return nil if the -*- line is
3301 malformed.
3303 If HANDLE-MODE is nil, we return the alist of all the local
3304 variables in the line except `coding' as described above. If it
3305 is neither nil nor t, we do the same, except that any settings of
3306 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3307 all settings in the line except for `mode', which \(if present) we
3308 return as the symbol specifying the mode."
3313 result)
3315 nil)
3317 ;; Simple form: "-*- MODENAME -*-".
3321 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3322 ;; (last ";" is optional).
3323 ;; If HANDLE-MODE is t, just check for `mode'.
3324 ;; Otherwise, parse the -*- line into the RESULT alist.
3332 ;; There used to be a downcase here,
3333 ;; but the manual didn't say so,
3334 ;; and people want to set var names that aren't all lc.
3340 ;; It is traditional to ignore
3341 ;; case when checking for `mode' in set-auto-mode,
3342 ;; so we must do that here as well.
3343 ;; That is inconsistent, but we're stuck with it.
3344 ;; The same can be said for `coding' in set-auto-coding.
3358 ;; Downcase "Mode:".
3361 val)
3362 result)
3365 result))))))
3368 "Filter local variable settings, querying the user if necessary.
3369 VARIABLES is the alist of variable-value settings. This alist is
3370 filtered based on the values of `ignored-local-variables',
3371 `enable-local-eval', `enable-local-variables', and (if necessary)
3372 user interaction. The results are added to
3373 `file-local-variables-alist', without applying them.
3374 If these settings come from directory-local variables, then
3375 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3376 ;; Find those variables that we may want to save to
3377 ;; `safe-local-variable-values'.
3383 ;; Ignore any variable in `ignored-local-variables'.
3384 nil)
3385 ;; Obey `enable-local-eval'.
3389 ;; In case previously marked safe (bug#5636).
3391 ;; If not safe and e-l-v = :safe, ignore totally.
3395 safe
3397 ;; Ignore duplicates (except `mode') in the present list.
3399 ;; Accept known-safe variables.
3403 ;; The variable is either risky or unsafe:
3410 ;; Query, unless all vars are safe or user wants no querying.
3416 risky-vars dir-name))
3426 ;; TODO? Warn once per file rather than once per session?
3430 "Parse and put into effect this buffer's local variables spec.
3431 Uses `hack-local-variables-apply' to apply the variables.
3433 If HANDLE-MODE is nil, we apply all the specified local
3434 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3435 except that any settings of `mode' are ignored.
3438 is specified, and return the corresponding mode symbol, or nil.
3439 In this case, we try to ignore minor-modes, and only return a
3440 major-mode.
3442 If `enable-local-variables' or `local-enable-local-variables' is nil,
3443 this function does nothing. If `inhibit-local-variables-regexps'
3444 applies to the file in question, the file is not scanned for
3445 local variables, but directory-local variables may still be applied."
3446 ;; We don't let inhibit-local-variables-p influence the value of
3447 ;; enable-local-variables, because then it would affect dir-local
3448 ;; variables. We don't want to search eg tar files for file local
3449 ;; variable sections, but there is no reason dir-locals cannot apply
3450 ;; to them. The real meaning of inhibit-local-variables-p is "do
3451 ;; not scan this file for local variables".
3454 result)
3458 ;; Note this is a no-op if enable-local-variables is nil.
3460 ;; This entire function is basically a no-op if enable-local-variables
3461 ;; is nil. All it does is set file-local-variables-alist to nil.
3463 ;; This part used to ignore enable-local-variables when handle-mode
3464 ;; was t. That was inappropriate, eg consider the
3465 ;; (artificial) example of:
3466 ;; (setq local-enable-local-variables nil)
3467 ;; Open a file foo.txt that contains "mode: sh".
3468 ;; It correctly opens in text-mode.
3469 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3471 ;; If HANDLE-MODE is t, and the prop line specifies a
3472 ;; mode, then we're done, and have no need to scan further.
3474 handle-mode))
3476 ;; Look for "Local variables:" line in last page.
3484 ;; suffix is what comes after "local variables:" in its line.
3485 ;; prefix is what comes before "local variables:" in its line.
3498 endpos
3504 nil t))
3505 ;; This used to be an error, but really all it means is
3506 ;; that this may simply not be a local-variables section,
3507 ;; so just ignore it.
3517 ;; Discard the prefix.
3522 ;; Discard the suffix.
3531 ;; Find the variable name;
3539 val val2)
3542 ;; Read the variable value.
3549 ;; Specifying minor-modes via mode: is
3550 ;; deprecated, but try to reject them anyway.
3560 'files
3562 "%s: `lexical-binding' at end of file unreliable"
3564 ;; We are called from
3565 ;; 'with-temp-buffer', so we need
3566 ;; to use 'thisbuf's name in the
3567 ;; warning message.
3573 'eval
3577 ;; Now we've read all the local variables.
3578 ;; If HANDLE-MODE is t, return whether the mode was specified.
3580 ;; Otherwise, set the variables.
3585 "Apply the elements of `file-local-variables-alist'.
3586 If there are any elements, runs `before-hack-local-variables-hook',
3587 then calls `hack-one-local-variable' to apply the alist elements one by one.
3588 Finishes by running `hack-local-variables-hook', regardless of whether
3589 the alist is empty or not.
3591 Note that this function ignores a `mode' entry if it specifies the same
3592 major mode as the buffer already has."
3594 ;; Any 'evals must run in the Right sequence.
3603 "Non-nil if SYM is safe as a file-local variable with value VAL.
3604 It is safe if any of these conditions are met:
3606 * There is a matching entry (SYM . VAL) in the
3607 `safe-local-variable-values' user option.
3609 * The `safe-local-variable' property of SYM is a function that
3610 evaluates to a non-nil value with VAL as an argument."
3614 ;; If the function signals an error, that means it
3615 ;; can't assure us that the value is safe.
3619 "Non-nil if SYM could be dangerous as a file-local variable.
3620 It is dangerous if either of these conditions are met:
3622 * Its `risky-local-variable' property is non-nil.
3628 ;; If this is an alias, check the base name.
3648 "Return t if it is safe to eval EXP when it is found in a file."
3650 ;; Detect certain `put' expressions.
3657 lisp-indent-function
3658 scheme-indent-function))
3659 ;; Only allow safe values (not functions).
3664 ;; Only allow indirect form specs.
3665 ;; During bootstrapping, edebug-basic-spec might not be
3666 ;; defined yet.
3670 ;; Allow expressions that the user requested.
3672 ;; Certain functions can be allowed with safe arguments
3673 ;; or can specify verification functions to try.
3675 ;; Allow (minor)-modes calls with no arguments.
3676 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3685 ok))
3693 ok))))))))
3707 "Set local variable VAR with value VAL.
3708 If VAR is `mode', call `VAL-mode' as a function unless it's
3709 already the major mode."
3711 (`mode
3717 (`eval
3723 ;; Make sure the string has no text properties.
3724 ;; Some text properties can get evaluated in various ways,
3725 ;; so it is risky to put them on with a local variable list.
3729 \f
3730 ;;; Handling directory-local variables, aka project settings.
3736 "List of cached directory roots for directory-local variable classes.
3737 Each element in this list has the form (DIR CLASS MTIME).
3738 DIR is the name of the directory.
3739 CLASS is the name of a variable class (a symbol).
3740 MTIME is the recorded modification time of the directory-local
3741 variables file associated with this entry. This time is a list
3742 of integers (the same format as `file-attributes'), and is
3743 used to test whether the cache entry is still valid.
3744 Alternatively, MTIME can be nil, which means the entry is always
3748 "Return the variable list for CLASS."
3752 "Collect directory-local variables from MODE-VARIABLES.
3753 VARIABLES is the initial list of variables.
3754 Returns the new list."
3759 ;; If variables are specified more than once, only use the last. (Why?)
3760 ;; The pseudo-variables mode and eval are different (bug#3430).
3763 ;; Need a new cons in case we setcdr later.
3767 "Collect entries from CLASS-VARIABLES into VARIABLES.
3768 ROOT is the root directory of the project.
3769 Return the new variables list."
3771 ;; Handle non-file buffers, too.
3775 ;; FIXME: Why not use file-relative-name?
3782 ;; Don't include this in the previous condition, because we
3783 ;; want to filter all strings before the next condition.
3797 ;; TODO someone might want to extend this to allow
3798 ;; integer values for subdir, where N means
3799 ;; variables apply to this directory and N levels
3800 ;; below it (0 == nil).
3803 alist variables))))))))
3805 ;; The file's content might be invalid (e.g. have a merge conflict), but
3806 ;; that shouldn't prevent the user from opening the file.
3808 nil))))
3811 "Declare that the DIRECTORY root is an instance of CLASS.
3812 DIRECTORY is the name of a directory, a string.
3813 CLASS is the name of a project class, a symbol.
3814 MTIME is either the modification time of the directory-local
3815 variables file that defined this class, or nil.
3817 When a file beneath DIRECTORY is visited, the mode-specific
3818 variables from CLASS are applied to the buffer. The variables
3819 for a class are defined using `dir-locals-set-class-variables'."
3826 "Map the type CLASS to a list of variable settings.
3827 CLASS is the project class, a symbol. VARIABLES is a list
3828 that declares directory-local variables for the class.
3829 An element in VARIABLES is either of the form:
3830 (MAJOR-MODE . ALIST)
3831 or
3832 (DIRECTORY . LIST)
3834 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3835 whose elements are of the form (VARIABLE . VALUE).
3837 In the second form, DIRECTORY is a directory name (a string), and
3838 LIST is a list of the form accepted by the function.
3840 When a file is visited, the file's class is found. A directory
3841 may be assigned a class using `dir-locals-set-directory-class'.
3842 Then variables are set in the file's buffer according to the
3843 VARIABLES list of the class. The list is processed in order.
3845 * If the element is of the form (MAJOR-MODE . ALIST), and the
3846 buffer's major mode is derived from MAJOR-MODE (as determined
3847 by `derived-mode-p'), then all the variables in ALIST are
3848 applied. A MAJOR-MODE of nil may be used to match any buffer.
3849 `make-local-variable' is called for each variable before it is
3850 set.
3852 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3853 is an initial substring of the file's directory, then LIST is
3854 applied by recursively following these rules."
3858 "File that contains directory-local variables.
3859 It has to be constant to enforce uniform values across different
3860 environments and users.
3861 See also `dir-locals-file-2', whose values override this one's.
3865 "File that contains directory-local variables.
3866 This essentially a second file that can be used like
3867 `dir-locals-file', so that users can have specify their personal
3868 dir-local variables even if the current directory already has a
3869 `dir-locals-file' that is shared with other users (such as in a
3870 git repository).
3874 "Return a list of all readable dir-locals files in DIRECTORY.
3875 The returned list is sorted by increasing priority. That is,
3876 values specified in the last file should take precedence over
3877 those in the first."
3881 dir-locals-file)
3882 directory))
3886 ;; The order here is important.
3893 out)))
3896 "Find the directory-local variables for FILE.
3897 This searches upward in the directory tree from FILE.
3898 It stops at the first directory that has been registered in
3899 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3900 If it finds an entry in the cache, it checks that it is valid.
3901 A cache entry with no modification time element (normally, one that
3902 has been assigned directly using `dir-locals-set-directory-class', not
3903 set from a file) is always valid.
3904 A cache entry based on a `dir-locals-file' is valid if the modification
3905 time stored in the cache matches the current file modification time.
3906 If not, the cache entry is cleared so that the file will be re-read.
3908 This function returns either:
3909 - nil (no directory local variables found),
3910 - the matching entry from `dir-locals-directory-cache' (a list),
3911 - or the full path to the directory (a string) containing at
3912 least one `dir-locals-file' in the case of no valid cache
3913 entry."
3917 dir-elt)
3918 ;; `locate-dominating-file' may have abbreviated the name.
3921 ;; Find the best cached value in `dir-locals-directory-cache'.
3932 ;; Found a potential cache entry. Check validity.
3933 ;; A cache entry with no MTIME is assumed to always be valid
3934 ;; (ie, set directly, not from a dir-locals file).
3935 ;; Note, we don't bother to check that there is a matching class
3936 ;; element in dir-locals-class-alist, since that's done by
3937 ;; dir-locals-set-directory-class.
3940 ;; The entry MTIME should match the most recent
3941 ;; MTIME among matching files.
3947 cached-files))))))
3948 ;; This cache entry is OK.
3949 dir-elt
3950 ;; This cache entry is invalid; clear it.
3953 ;; Return the first existing dir-locals file. Might be the same
3954 ;; as dir-elt's, might not (eg latter might have been deleted).
3955 locals-dir)
3956 ;; No cache entry.
3957 locals-dir)))
3960 "Load all variables files in DIR and register a new class and instance.
3961 DIR is the absolute name of a directory which must contain at
3962 least one dir-local file (which is a file holding variables to
3963 apply).
3964 Return the new class name, which is a symbol named DIR."
3978 variables
3984 dir class-name
3989 files))
3990 ;; If there was a problem, use the values we could get but
3991 ;; don't let the cache prevent future reads.
3993 class-name))
3999 "Non-nil means dir-local variables will be applied to remote files."
4007 "Read per-directory local variables for the current buffer.
4008 Store the directory-local variables in `dir-local-variables-alist'
4009 and `file-local-variables-alist', without applying them.
4011 This does nothing if either `enable-local-variables' or
4012 `enable-dir-local-variables' are nil."
4014 enable-dir-local-variables
4017 default-directory)))))
4018 ;; Find the variables file.
4048 "Apply directory-local variables to a non-file buffer.
4049 For non-file buffers, such as Dired buffers, directory-local
4050 variables are looked for in `default-directory' and its parent
4051 directories."
4055 \f
4058 However, the mode will not be changed if
4059 \(1) a local variables list or the `-*-' line specifies a major mode, or
4061 not suitable for ordinary files, or
4062 \(3) the new file name does not particularly specify any mode."
4067 "Change name of file visited in current buffer to FILENAME.
4068 This also renames the buffer to correspond to the new file.
4069 The next time the buffer is saved it will go in the newly specified file.
4070 FILENAME nil or an empty string means mark buffer as not visiting any file.
4071 Remember to delete the initial contents of the minibuffer
4072 if you wish to pass an empty string as the argument.
4074 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4075 confirmation in the case where another buffer is already visiting FILENAME.
4077 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4078 the old visited file has been renamed to the new name FILENAME."
4086 nil
4101 filename)))
4108 buffer-file-name filename)
4112 ;; If new-name == old-name, renaming would add a spurious <2>
4113 ;; and it's considered as a feature in rename-buffer.
4119 ;; Abbreviate the file names of the buffer.
4128 nil))
4129 ;; write-file-functions is normally used for things like ftp-find-file
4130 ;; that visit things that are not local files as if they were files.
4131 ;; Changing to visit an ordinary local file instead should flush the hook.
4136 ;; If buffer was read-only because of version control,
4137 ;; that reason is gone now, so make it writable.
4141 ;; Turn off backup files for certain file names.
4142 ;; Since this is a permanent local, the major mode won't eliminate it.
4144 backup-enable-predicate
4153 ;; If auto-save was not already on, turn it on if appropriate.
4156 ;; If auto save is on, start using a new name. We
4157 ;; deliberately don't rename or delete the old auto save
4158 ;; for the old visited file name. This is because
4159 ;; perhaps the user wants to save the new state and then
4160 ;; compare with the previous state from the auto save
4161 ;; file.
4163 ;; Rename the old auto save file if any.
4170 ;; Update the major mode, if the file name determines it.
4172 ;; Don't change the mode if it is special.
4175 ;; Don't change the mode if the local variable list specifies it.
4176 ;; The file name can influence whether the local variables apply.
4178 ;; h-l-v also checks it, but might as well be explicit.
4181 ;; TODO consider making normal-mode handle this case.
4189 "Write current buffer into file FILENAME.
4190 This makes the buffer visit that file, and marks it as not modified.
4192 If you specify just a directory name as FILENAME, that means to use
4193 the default file name but in that directory. You can also yank
4194 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4196 If the buffer is not already visiting a file, the default file name
4197 for the output file is the buffer name.
4199 If optional second arg CONFIRM is non-nil, this function
4200 asks for confirmation before overwriting an existing file.
4201 Interactively, confirmation is required unless you supply a prefix argument."
4202 ;; (interactive "FWrite file: ")
4206 nil nil nil nil)
4210 default-directory)
4211 nil nil))
4215 ;; If arg is just a directory,
4216 ;; use the default file name, but in that directory.
4223 ;; NS does its own confirm dialog.
4226 use-dialog-box))
4232 ;; Make buffer writable if file is writable.
4237 ;; It's likely that the VC status at the new location is different from
4238 ;; the one at the old location.
4240 \f
4242 "Return an alist of extended attributes of file FILENAME.
4244 Extended attributes are platform-specific metadata about the file,
4245 such as SELinux context, list of ACL entries, etc."
4250 "Set extended attributes of file FILENAME to ATTRIBUTES.
4252 ATTRIBUTES must be an alist of file attributes as returned by
4253 `file-extended-attributes'.
4254 Value is t if the function succeeds in setting the attributes."
4265 result))
4266 \f
4268 "Make a backup of the disk file visited by the current buffer, if appropriate.
4269 This is normally done before saving the buffer the first time.
4271 A backup may be done by renaming or by copying; see documentation of
4272 variable `make-backup-files'. If it's done by renaming, then the file is
4273 no longer accessible under its old name.
4275 The value is non-nil after a backup was made by renaming.
4276 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4277 MODES is the result of `file-modes' on the original
4278 file; this means that the caller, after saving the buffer, should change
4279 the modes of the new file to agree with the old modes.
4280 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4281 on the original file; this means that the caller, after saving
4282 the buffer, should change the extended attributes of the new file
4283 to agree with the old attributes.
4284 BACKUPNAME is the backup file name, which is the old file renamed."
4288 ;; If specified name is a symbolic link, chase it to the target.
4289 ;; This makes backups in the directory where the real file is.
4296 ;; If have old versions to maybe delete,
4297 ;; ask the user to confirm now, before doing anything.
4298 ;; But don't actually delete til later.
4304 real-file-name)))
4305 targets))
4310 backup-by-copying-when-privileged-mismatch)
4313 ;; Don't rename a suid or sgid file.
4322 real-file-name
4325 copy-when-priv-mismatch))))
4327 t)))))
4328 setmodes)
4331 ;; Actually make the backup file.
4334 modes extended-attributes)
4335 ;; rename-file should delete old backup.
4338 backupname)))
4340 ;; Now delete the old versions, if desired.
4344 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4348 backupname)
4351 modes extended-attributes)
4353 setmodes)))))))
4356 ;; Create temp files with strict access rights. It's easy to
4357 ;; loosen them later, whereas it's impossible to close the
4358 ;; time-window of loose permissions otherwise.
4361 ;; Try to overwrite old backup first.
4369 nil)
4371 ;; The file was somehow created by someone else between
4372 ;; `delete-file' and `copy-file', so let's try again.
4373 ;; rms says "I think there is also a possible race
4374 ;; condition for making backup files" (emacs-devel 20070821).
4375 nil)))
4376 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4385 ;; The last ~[[:digit]]+ matches relative versions in git,
4386 ;; e.g. `foo.js.~HEAD~1~'.
4387 "Regular expression matching the backup/version part of a file name.
4391 "Return file NAME sans backup versions or strings.
4392 This is a separate procedure so your site-init or startup file can
4393 redefine it.
4394 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4395 we do not remove backup version numbers, only true file version numbers.
4396 See also `file-name-version-regexp'."
4403 name))))))
4406 "Return t if deleting FILE and rewriting it would preserve the owner.
4407 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4408 the group would be preserved too."
4413 ;; Return t if the file doesn't exist, since it's true that no
4414 ;; information would be lost by an (attempted) delete and create.
4417 ;; Files created on Windows by Administrator (RID=500)
4418 ;; have the Administrators group (RID=544) recorded as
4419 ;; their owner. Rewriting them will still preserve the
4420 ;; owner.
4424 ;; On BSD-derived systems files always inherit the parent
4425 ;; directory's group, so skip the group-gid test.
4431 ;; On some systems, a file created in a setuid directory
4432 ;; inherits that directory's owner.
4436 ;; On many systems, a file created in a setgid directory
4437 ;; inherits that directory's group. On some systems
4438 ;; this happens even if the setgid bit is not set.
4445 The extension, in a file name, is the part that begins with the last `.',
4446 except that a leading `.' of the file name, if there is one, doesn't count."
4449 directory)
4453 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4454 ;; we don't want to expand it.
4457 filename))))
4461 The extension, in a file name, is the part that begins with the last `.',
4462 excluding version numbers and backup suffixes, except that a leading `.'
4463 of the file name, if there is one, doesn't count.
4464 Return nil for extensionless file names such as `foo'.
4465 Return the empty string for file names such as `foo.'.
4467 By default, the returned value excludes the period that starts the
4468 extension, but if the optional argument PERIOD is non-nil, the period
4469 is included in the value, and in that case, if FILENAME has no
4480 "Return the base name of the FILENAME: no directory, no extension.
4481 FILENAME defaults to `buffer-file-name'."
4486 #'make-backup-file-name--default-function
4487 "A function that `make-backup-file-name' uses to create backup file names.
4488 The function receives a single argument, the original file name.
4490 If you change this, you may need to change `backup-file-name-p' and
4491 `file-name-sans-versions' too.
4493 You could make this buffer-local to do something special for specific files.
4495 For historical reasons, a value of nil means to use the default function.
4496 This should not be relied upon.
4498 See also `backup-directory-alist'."
4505 "Alist of filename patterns and backup directory names.
4506 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4507 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4508 relative or absolute. If it is absolute, so that all matching files
4509 are backed up into the same directory, the file names in this
4510 directory will be the full name of the file backed up with all
4511 directory separators changed to `!' to prevent clashes. This will not
4512 work correctly if your filesystem truncates the resulting name.
4514 For the common case of all backups going into one directory, the alist
4516 directory name.
4518 If this variable is nil, or it fails to match a filename, the backup
4519 is made in the original file's directory.
4521 On MS-DOS filesystems without long names this variable is always
4522 ignored."
4528 "Default `backup-enable-predicate' function.
4529 Checks for files in `temporary-file-directory',
4532 caseless)
4533 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4534 ;; their long file-name equivalents, so compare-strings does TRT.
4538 caseless t))
4541 ;; Directory is under temporary-file-directory.
4546 ;; Directory is under /tmp.
4551 0 nil
4553 ;; Directory is under small-temporary-file-directory.
4558 "Create the non-numeric backup file name for FILE.
4559 This calls the function that `make-backup-file-name-function' specifies,
4560 with a single argument FILE."
4563 file))
4566 "Default function for `make-backup-file-name'.
4567 Normally this just returns FILE's name with `~' appended.
4568 It searches for a match for FILE in `backup-directory-alist'.
4569 If the directory for the backup doesn't exist, it is created."
4581 "Subroutine of `make-backup-file-name--default-function'.
4582 The function `find-backup-file-name' also uses this."
4584 elt backup-directory abs-backup-directory)
4589 alist nil)))
4590 ;; If backup-directory is relative, it should be relative to the
4591 ;; file's directory. By expanding explicitly here, we avoid
4592 ;; depending on default-directory.
4601 abs-backup-directory nil))))
4603 file
4607 ;; Normalize DOSish file names: downcase the drive
4608 ;; letter, if any, and replace the leading "x:" with
4609 ;; "/drive_x".
4612 ;; Replace any invalid file-name characters (for the
4613 ;; case of backing up remote files).
4617 "drive_"
4620 ""
4623 ;; Make the name unique by substituting directory
4624 ;; separators. It may not really be worth bothering about
4625 ;; doubling `!'s in the original name...
4630 backup-directory))
4635 "Return non-nil if FILE is a backup file name (numeric or not).
4636 This is a separate function so you can redefine it for customization.
4637 You may need to redefine `file-name-sans-versions' as well."
4642 ;; This is used in various files.
4643 ;; The usage of backup-extract-version-start is not very clean,
4644 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4646 "Given the name of a numeric backup file, FN, return the backup number.
4647 Uses the free variable `backup-extract-version-start', whose value should be
4648 the index in the name where the version number begins."
4655 "Find a file name for a backup file FN, and suggestions for deletions.
4656 Value is a list whose car is the name for the backup file
4657 and whose cdr is a list of old versions to consider deleting now.
4658 If the value is nil, don't make a backup.
4659 Uses `backup-directory-alist' in the same way as
4660 `make-backup-file-name--default-function' does."
4662 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4666 ;; We don't support numbered backups on plain MS-DOS
4667 ;; when long file names are unavailable.
4677 possibilities deserve-versions-p versions)
4680 base-versions
4683 possibilities)
4684 #'<)
4689 kept-old-versions
4690 kept-new-versions
4697 ;; Delete nothing if there is overflow
4698 ;; in the number of versions to keep.
4704 v))))))))))
4707 "Return number of names file FILENAME has."
4711 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4712 This function returns a relative file name which is equivalent to FILENAME
4713 when used with that default directory as the default.
4714 If FILENAME is a relative file name, it will be interpreted as existing in
4715 `default-directory'.
4716 If FILENAME and DIRECTORY lie on different machines or on different drives
4717 on a DOS/Windows machine, it returns FILENAME in expanded form."
4721 default-directory))))
4726 read-file-name-completion-ignore-case)))
4729 ;; Test for different filesystems on DOS/Windows
4731 ;; Should `cygwin' really be included here? --stef
4734 ;; Test for different drive letters
4736 ;; Test for UNCs on different servers
4741 ;; Windows file names cannot have ? in
4742 ;; them, so use that to detect when
4743 ;; neither FILENAME nor DIRECTORY is a
4744 ;; UNC.
4746 0 nil
4752 ;; Test for different remote file system identification
4754 filename
4762 ".."
4764 ;; Now ancestor is empty, or .., or ../.., etc.
4766 ;; We matched within FILENAME's directory part.
4767 ;; Add the rest of FILENAME onto ANCESTOR.
4770 ;; But don't bother with ANCESTOR if it would give us `./'.
4771 rest
4773 ;; We matched FILENAME's directory equivalent.
4774 ancestor))))))
4775 \f
4777 "Save current buffer in visited file if modified.
4778 Variations are described below.
4780 By default, makes the previous version into a backup file
4781 if previously requested or if this is the first save.
4783 to become a backup when the next save is done.
4785 makes the previous version into a backup file.
4787 to become a backup when the next save is done,
4788 and makes the previous version into a backup file.
4790 With a numeric prefix argument of 0, never make the previous version
4791 into a backup file.
4793 Note that the various variables that control backups, such
4794 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4795 and `backup-inhibited', to name just the more popular ones, still
4796 control whether a backup will actually be produced, even when you
4799 If a file's name is FOO, the names of its numbered backup versions are
4800 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4801 Numeric backups (rather than FOO~) will be made if value of
4802 `version-control' is not the atom `never' and either there are already
4803 numeric versions of the file being backed up, or `version-control' is
4804 non-nil.
4805 We don't want excessive versions piling up, so there are variables
4806 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4807 and `kept-new-versions', which tells how many newest versions to keep.
4808 Defaults are 2 old versions and 2 new.
4809 `dired-kept-versions' controls dired's clean-directory (.) command.
4810 If `delete-old-versions' is nil, system will query user
4811 before trimming versions. Otherwise it does it silently.
4813 If `vc-make-backup-files' is nil, which is the default,
4814 no backup files are made for files managed by version control.
4815 (This is because the version control system itself records previous versions.)
4817 See the subroutine `basic-save-buffer' for more information."
4823 ;; We used to display the message below only for files > 50KB, but
4824 ;; then Rmail-mbox never displays it due to buffer swapping. If
4825 ;; the test is ever re-introduced, be sure to handle saving of
4826 ;; Rmail files.
4836 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4837 Normally delete only if the file was written by this Emacs since
4838 the last real save, but optional arg FORCE non-nil means delete anyway."
4852 "Normal hook that is run before a buffer is saved to its file.
4853 Only used by `save-buffer'."
4859 "Normal hook that is run after a buffer is saved to its file.
4860 Only used by `save-buffer'."
4866 "If non-nil, use this coding system for saving the buffer.
4867 More precisely, use this coding system in place of the
4868 value of `buffer-file-coding-system', when saving the buffer.
4869 Calling `write-region' for any purpose other than saving the buffer
4870 will still use `buffer-file-coding-system'; this variable has no effect
4877 "Save the current buffer in its visited file, if it has been modified.
4878 The hooks `write-contents-functions' and `write-file-functions' get a chance
4879 to do the job of saving; if they do not, then the buffer is saved in
4880 the visited file in the usual way.
4881 Before and after saving the buffer, this function runs
4882 `before-save-hook' and `after-save-hook', respectively."
4885 ;; In an indirect buffer, save its base buffer instead.
4889 ;; handle the case when no modification has been made but
4890 ;; the file disappeared since visited
4894 setmodes)
4895 ;; If buffer has no file name, ask user for one.
4903 ;; Signal an error if the user specified the name of an
4904 ;; existing directory.
4907 "File `%s' exists; overwrite? "
4908 filename))
4915 "%s has changed since visited or saved. Save anyway? "
4935 ;; Support VC version backups.
4937 ;; Don't let errors prevent saving the buffer.
4942 ;; If a hook returned t, file is already "written".
4943 ;; Otherwise, write it the usual way now.
4953 ;; Now we have saved the current buffer. Let's make sure
4954 ;; that buffer-file-coding-system is fixed to what
4955 ;; actually used for saving by binding it locally.
4970 ;; If the auto-save file was recent before this command,
4971 ;; delete it now.
4973 ;; Support VC `implicit' locking.
4980 ;; This does the "real job" of writing a buffer into its visited file
4981 ;; and making a backup file. This is what is normally done
4982 ;; but inhibited if one of write-file-functions returns non-nil.
4983 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4984 ;; backup-buffer.
4994 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4995 ;; backup-buffer.
5008 "File %s is write-protected; try to save anyway? "
5010 buffer-file-name)))
5024 dir))))
5025 ;; Write temp name, then rename it.
5026 ;; This requires write access to the containing dir,
5027 ;; which is why we don't try it if we don't have that access.
5029 tempname
5031 ;; Create temp files with strict access rights. It's easy to
5032 ;; loosen them later, whereas it's impossible to close the
5033 ;; time-window of loose permissions otherwise.
5037 ;; Call write-region in the appropriate way
5038 ;; for saving the buffer.
5042 ;; Pass in nil&nil rather than point-min&max
5043 ;; cause we're saving the whole buffer.
5044 ;; write-region-annotate-functions may use it.
5046 buffer-file-truename)
5048 ;; If we failed, restore the buffer's modtime.
5051 ;; Since we have created an entirely new file,
5052 ;; make sure it gets the right permission bits set.
5057 buffer-file-name)))
5058 ;; We succeeded in writing the temp file,
5059 ;; so rename it.
5061 ;; If file not writable, see if we can make it writable
5062 ;; temporarily while we write it.
5063 ;; But no need to do so if we have just backed it up
5064 ;; (setmodes is set) because that says we're superseding.
5066 ;; Change the mode back, after writing.
5069 buffer-file-name))
5070 ;; If set-file-extended-attributes fails, fall back on
5071 ;; set-file-modes.
5081 ;; Pass in nil&nil rather than point-min&max to indicate
5082 ;; we're saving the buffer rather than just a region.
5083 ;; write-region-annotate-functions may make us of it.
5085 buffer-file-name nil t buffer-file-truename)
5088 ;; If we get an error writing the new file, and we made
5089 ;; the backup by renaming, undo the backing-up.
5094 setmodes))
5100 `((?\C-r
5107 ;; Return nil to ask about BUF again.
5108 nil)
5121 ;; Return nil to ask about BUF again.
5122 nil)
5132 "Default predicate for `save-some-buffers'.
5133 This allows you to stop `save-some-buffers' from asking
5134 about certain files that you'd usually rather not save."
5140 "Save some modified file-visiting buffers. Asks user about each one.
5141 You can answer `y' to save, `n' not to save, `C-r' to look at the
5142 buffer in question with `view-buffer' before deciding or `d' to
5143 view the differences using `diff-buffer-with-file'.
5145 This command first saves any buffers where `buffer-save-without-query' is
5146 non-nil, without asking.
5148 Optional argument (the prefix) non-nil means save all with no questions.
5149 Optional second argument PRED determines which buffers are considered:
5150 If PRED is nil, all the file-visiting buffers are considered.
5151 If PRED is t, then certain non-file buffers will also be considered.
5152 If PRED is a zero-argument function, it indicates for each buffer whether
5153 to consider it or not when called with that buffer current.
5154 PRED defaults to the value of `save-some-buffers-default-predicate'.
5156 See `save-some-buffers-action-alist' if you want to
5157 change the additional actions you can take on files."
5163 files-done abbrevs-done)
5165 ;; First save any buffers that we're supposed to save unconditionally.
5166 ;; That way the following code won't ask about them.
5171 ;; Ask about those buffers that merit it,
5172 ;; and record the number thus saved.
5176 ;; Note that killing some buffers may kill others via
5177 ;; hooks (e.g. Rmail and its viewing buffer).
5190 t
5202 save-some-buffers-action-alist))
5203 ;; Maybe to save abbrevs, and record whether
5204 ;; we either saved them or asked to.
5211 ;; Don't keep bothering user if he says no.
5225 \f
5227 "Clear out records of last mod time of visited file.
5228 Next attempt to save will not complain of a discrepancy."
5232 "Mark current buffer as unmodified, not needing to be saved.
5235 It is not a good idea to use this function in Lisp programs, because it
5236 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5244 "Change whether this buffer is read-only."
5252 "Insert contents of file FILENAME into buffer after point.
5253 Set mark after the inserted text.
5255 This function is meant for the user to run interactively.
5256 Don't call it from programs! Use `insert-file-contents' instead.
5257 \(Its calling sequence is different; see its documentation)."
5263 "Append the contents of the region to the end of file FILENAME.
5264 When called from a function, expects three arguments,
5265 START, END and FILENAME. START and END are normally buffer positions
5266 specifying the part of the buffer to write.
5267 If START is nil, that means to use the entire buffer contents.
5268 If START is a string, then output that string to the file
5269 instead of any buffer contents; END is ignored.
5271 This does character code conversion and applies annotations
5272 like `write-region' does."
5278 "Return most recent backup file for FILENAME or nil if no backups exist."
5279 ;; `make-backup-file-name' will get us the right directory for
5280 ;; ordinary or numeric backups. It might create a directory for
5281 ;; backups as a side-effect, according to `backup-directory-alist'.
5288 tem)
5297 newest))
5300 "Rename current buffer to a similar name not already taken.
5301 This function is useful for creating multiple shell process buffers
5302 or multiple mail buffers, etc.
5304 Note that some commands, in particular those based on `compilation-mode'
5305 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5306 appropriate mode even if it has been renamed. So as well as renaming
5307 the buffer, you also need to switch buffers before running another
5308 instance of such commands."
5316 ;; If the existing buffer name has a <NNN>,
5317 ;; which isn't part of the file name (if any),
5318 ;; then get rid of that.
5324 "Create the directory DIR and optionally any nonexistent parent dirs.
5325 If DIR already exists as a directory, signal an error, unless
5326 PARENTS is non-nil.
5328 Interactively, the default choice of directory to create is the
5329 current buffer's default directory. That is useful when you have
5330 visited a file in a nonexistent directory.
5332 Noninteractively, the second (optional) argument PARENTS, if
5333 non-nil, says whether to create parent directories that don't
5334 exist. Interactively, this happens by default.
5336 If creating the directory or directories fail, an error will be
5337 raised."
5340 nil nil)
5341 t))
5342 ;; If default-directory is a remote directory,
5343 ;; make sure we find its make-directory handler.
5351 create-list)
5353 ;; If directory is its own parent, then we can't
5354 ;; keep looping forever
5369 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5370 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5371 non-nil and if FN fails due to a missing file or directory."
5377 "Delete the directory named DIRECTORY. Does not follow symlinks.
5378 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5379 no error if something else is simultaneously deleting them.
5380 TRASH non-nil means to trash the directory instead, provided
5381 `delete-by-moving-to-trash' is non-nil.
5383 When called interactively, TRASH is nil if and only if a prefix
5384 argument is given, and a further prompt asks the user for
5385 RECURSIVE if DIRECTORY is nonempty."
5392 "Move directory to trash: "
5394 default-directory default-directory nil nil))))
5400 nil)
5402 ;; If default-directory is a remote directory, make sure we find its
5403 ;; delete-directory handler.
5410 ;; Only move non-empty dir to trash if recursive deletion was
5411 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5412 ;; case, where the operation fails in delete-directory-internal.
5413 ;; As `move-file-to-trash' trashes directories (empty or
5414 ;; otherwise) as a unit, we do not need to recurse here.
5416 ;; Check if directory is empty apart from "." and "..".
5421 ;; Otherwise, call ourselves recursively if needed.
5426 directory-files-no-dot-files-regexp))
5430 ;; This test is equivalent to but more efficient
5431 ;; than (and (file-directory-p fn)
5432 ;; (not (file-symlink-p fn))).
5436 files))
5437 directory-exists))
5441 "Return non-nil if files FILE1 and FILE2 name the same file.
5442 If FILE1 or FILE2 does not exist, the return value is unspecified."
5453 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5455 Return nil if DIR is not an existing directory."
5467 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5482 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5483 This function always sets the file modes of the output files to match
5484 the corresponding input file.
5486 The third arg KEEP-TIME non-nil means give the output files the same
5487 last-modified time as the old ones. (This works on only some systems.)
5489 A prefix arg makes KEEP-TIME non-nil.
5491 Noninteractively, the last argument PARENTS says whether to
5492 create parent directories if they don't exist. Interactively,
5493 this happens by default.
5495 If NEWNAME names an existing directory, copy DIRECTORY as a
5496 subdirectory there. However, if called from Lisp with a non-nil
5497 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5498 directly into NEWNAME instead."
5505 default-directory default-directory nil nil)
5506 current-prefix-arg t nil)))
5509 directory newname))
5510 ;; If default-directory is a remote directory, make sure we find its
5511 ;; copy-directory handler.
5516 newname keep-time parents copy-contents)
5518 ;; Compute target name.
5523 ;; If NEWNAME is not an existing directory, create it;
5524 ;; that is where we will copy the files of DIRECTORY.
5526 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5527 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5536 newname))
5539 ;; Copy recursively.
5541 ;; We do not want to copy "." and "..".
5543 directory-files-no-dot-files-regexp))
5554 ;; Set directory attributes.
5560 \f
5561 ;; At time of writing, only info uses this.
5563 "Return a copy of DIRS with all non-existent directories removed.
5564 The optional argument KEEP is a list of directories to retain even if
5565 they don't exist, and REJECT is a list of directories to remove from
5566 DIRS, even if they exist; REJECT takes precedence over KEEP.
5568 Note that membership in REJECT and KEEP is checked using simple string
5569 comparison."
5575 dirs)))
5577 \f
5580 "Function to use to revert this buffer.
5581 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5582 which are the arguments that `revert-buffer' received.
5583 It also has access to the `preserve-modes' argument of `revert-buffer'
5584 via the `revert-buffer-preserve-modes' dynamic variable.
5586 For historical reasons, a value of nil means to use the default function.
5591 #'revert-buffer-insert-file-contents--default-function
5592 "Function to use to insert contents when reverting this buffer.
5593 The function receives two arguments: the first the nominal file name to use;
5594 the second is t if reading the auto-save file.
5596 The function is responsible for updating (or preserving) point.
5598 For historical reasons, a value of nil means to use the default function.
5602 "Default function to use for `buffer-stale-function'.
5603 This function ignores its argument.
5604 This returns non-nil if the current buffer is visiting a readable file
5605 whose modification time does not match that of the buffer.
5607 This function only handles buffers that are visiting files.
5608 Non-file buffers need a custom function"
5615 "Function to check whether a buffer needs reverting.
5616 This should be a function with one optional argument NOCONFIRM.
5617 Auto Revert Mode passes t for NOCONFIRM. The function should return
5618 non-nil if the buffer should be reverted. A return value of
5619 `fast' means that the need for reverting was not checked, but
5620 that reverting the buffer is fast. The buffer is current when
5621 this function is called.
5623 The idea behind the NOCONFIRM argument is that it should be
5624 non-nil if the buffer is going to be reverted without asking the
5625 user. In such situations, one has to be careful with potentially
5626 time consuming operations.
5628 For historical reasons, a value of nil means to use the default function.
5629 This should not be relied upon.
5631 For more information on how this variable is used by Auto Revert mode,
5635 "Normal hook for `revert-buffer' to run before reverting.
5636 The function `revert-buffer--default' runs this.
5640 "Normal hook for `revert-buffer' to run after reverting.
5641 Note that the hook value that it runs is the value that was in effect
5642 before reverting; that makes a difference if you have buffer-local
5643 hook functions.
5645 The function `revert-buffer--default' runs this.
5653 ;; `revert-buffer-function' was defined long ago to be a function of only
5654 ;; 2 arguments, so we have to use a dynbind variable to pass the
5655 ;; `preserve-modes' argument of `revert-buffer'.
5659 "Replace current buffer text with the text of the visited file on disk.
5660 This undoes all changes since the file was visited or saved.
5661 With a prefix argument, offer to revert from latest auto-save file, if
5662 that is more recent than the visited file.
5664 This command also implements an interface for special buffers
5665 that contain text which doesn't come from a file, but reflects
5666 some other data instead (e.g. Dired buffers, `buffer-list'
5667 buffers). This is done via the variable `revert-buffer-function'.
5668 In these cases, it should reconstruct the buffer contents from the
5669 appropriate data.
5671 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5672 to revert from the auto-save file when this is nil. Note that the
5673 sense of this argument is the reverse of the prefix argument, for the
5674 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5675 to nil.
5677 Optional second argument NOCONFIRM means don't ask for confirmation
5678 at all. (The variable `revert-without-query' offers another way to
5679 revert buffers without querying for confirmation.)
5681 Optional third argument PRESERVE-MODES non-nil means don't alter
5682 the files modes. Normally we reinitialize them using `normal-mode'.
5684 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5686 This function calls the function that `revert-buffer-function' specifies
5687 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5688 The default function runs the hooks `before-revert-hook' and
5689 `after-revert-hook'."
5690 ;; I admit it's odd to reverse the sense of the prefix argument, but
5691 ;; there is a lot of code out there which assumes that the first
5692 ;; argument should be t to avoid consulting the auto-save file, and
5693 ;; there's no straightforward way to encourage authors to notice a
5694 ;; reversal of the argument sense. So I'm just changing the user
5695 ;; interface, but leaving the programmatic interface the same.
5700 ignore-auto noconfirm)))
5703 "Default function for `revert-buffer'.
5704 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5705 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5706 start and end.
5708 Calls `revert-buffer-insert-file-contents-function' to reread the
5709 contents of the visited file, with two arguments: the first is the file
5710 name, the second is non-nil if reading an auto-save file.
5712 This function only handles buffers that are visiting files.
5713 Non-file buffers need a custom function."
5718 buffer-auto-save-file-name
5723 buffer-auto-save-file-name
5724 buffer-file-name)))
5734 file-name)))
5736 ;; If file was backed up but has changed since,
5737 ;; we should make another backup.
5741 ;; Effectively copy the after-revert-hook status,
5742 ;; since after-find-file will clobber it.
5745 after-revert-hook))
5747 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5751 file-name auto-save-p)
5752 ;; Recompute the truename in case changes in symlinks
5753 ;; have changed the truename.
5757 ;; Run after-revert-hook as it was before we reverted.
5761 local-hook)
5764 t)))))
5767 "Default function for `revert-buffer-insert-file-contents-function'.
5768 The function `revert-buffer--default' calls this.
5769 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5770 an auto-save file."
5774 "File %s no longer exists!"
5776 file-name))
5779 "File %s no longer readable!"
5781 file-name))
5783 ;; Bind buffer-file-name to nil
5784 ;; so that we don't try to lock the file.
5790 ;; Auto-saved file should be read by Emacs's
5791 ;; internal coding.
5795 buffer-file-coding-system-explicit
5798 coding-system-for-read
5800 coding-system-for-read)
5802 ;; As a coding system suitable for multibyte
5803 ;; buffer is specified, make the current
5804 ;; buffer multibyte.
5807 ;; This force after-insert-file-set-coding
5808 ;; (called from insert-file-contents) to set
5809 ;; buffer-file-coding-system to a proper value.
5812 ;; Note that this preserves point in an intelligent way.
5816 nil nil t))
5818 nil nil t))))))
5821 "Recover the visited file--get contents from its last auto-save file."
5828 "Visit file FILE, but get contents from its last auto-save file."
5829 ;; Actually putting the file name in the minibuffer should be used
5830 ;; only rarely.
5831 ;; Not just because users often use the default.
5844 "*Directory*" nil
5855 ;; Use insert-directory-safely, not insert-directory,
5856 ;; because these files might not exist. In particular,
5857 ;; FILE might not exist if the auto-save file was for
5858 ;; a buffer that didn't visit a file, such as "*mail*".
5859 ;; The code in v20.x called `ls' directly, so we need
5860 ;; to emulate what `ls' did in that case.
5865 ;; Keep the current buffer-file-coding-system.
5867 ;; Auto-saved file should be read with special coding.
5876 "Recover auto save files from a previous Emacs session.
5877 This command first displays a Dired buffer showing you the
5878 previous sessions that you could recover from.
5879 To choose one, move point to the proper line and then type C-c C-c.
5880 Then you'll be asked about a number of files to recover."
5890 directory-files-no-dot-files-regexp
5892 t)
5903 ;; Each line starts with a space
5904 ;; so that Font Lock mode won't highlight the first character.
5907 " To delete a session file, type \
5913 "Choose one saved session to recover auto-save files from.
5914 This command is used in the special Dired buffer created by
5917 ;; Get the name of the session file to recover from.
5919 files
5925 ;; Read in the auto-save-list file.
5928 ;; Loop thru the text of that file
5929 ;; and get out the names of the files to recover.
5933 ;; This is a pair of lines for a non-file-visiting buffer.
5934 ;; Get the auto-save file name and manufacture
5935 ;; a "visited file name" from that.
5938 ;; If there is no auto-save file name, the
5939 ;; auto-save-list file is probably corrupted.
5952 ;; This pair of lines is a file-visiting
5953 ;; buffer. Use the visited file name.
5963 ;; Ignore a file if its auto-save file does not exist now.
5967 ;; The file contains a pair of line for each auto-saved buffer.
5968 ;; The first line of the pair contains the visited file name
5969 ;; or is empty if the buffer was not visiting a file.
5970 ;; The second line is the auto-save file name.
5978 files
5984 "Kill BUFFER if confirmed."
5992 "Kill some buffers. Asks the user whether to kill each one of them.
5993 Non-interactively, if optional argument LIST is non-nil, it
5994 specifies the list of buffers to kill, asking for approval for each one."
6002 ; if we killed the base buffer.
6009 "Kill buffers whose name matches the specified REGEXP.
6010 Ignores buffers whose name starts with a space, unless optional
6011 prefix argument INTERNAL-TOO is non-nil. Asks before killing
6012 each buffer, unless NO-ASK is non-nil."
6021 \f
6023 "Adjust current buffer's auto save file name for current conditions.
6024 Also rename any existing auto save file, if it was made in this session."
6036 "Return file name to use for auto-saves of current buffer.
6037 Does not consider `auto-save-visited-file-name' as that variable is checked
6038 before calling this function. You can redefine this for customization.
6039 See also `auto-save-file-name-p'."
6047 result uniq)
6048 ;; Apply user-specified translations
6049 ;; to the file name.
6053 filename)
6063 filename))))
6068 ;; We truncate the file name to DOS 8+3 limits
6069 ;; before doing anything else, because the regexp
6070 ;; passed to string-match below cannot handle
6071 ;; extensions longer than 3 characters, multiple
6072 ;; dots, and other atrocities.
6077 fn)
6082 "#"
6085 ;; Make sure auto-save file names don't contain characters
6086 ;; invalid for the underlying filesystem.
6088 ;; Don't modify remote filenames
6091 result))))
6093 ;; Deal with buffers that don't have any associated files. (Mail
6094 ;; mode tends to create a good number of these.)
6098 file-name)
6099 ;; Restrict the characters used in the file name to those which
6100 ;; are known to be safe on all filesystems, url-encoding the
6101 ;; rest.
6102 ;; We do this on all platforms, because even if we are not
6103 ;; running on DOS/Windows, the current directory may be on a
6104 ;; mounted VFAT filesystem, such as a USB memory stick.
6108 ;; For multibyte characters, this will produce more than
6109 ;; 2 hex digits, so is not true URL encoding.
6113 ;; Generate the file name.
6119 ;; Try a few alternative directories, to get one we can
6120 ;; write it.
6126 ;; Don't modify remote filenames
6128 ;; The call to convert-standard-filename is in case
6129 ;; buffer-name includes characters not allowed by the
6130 ;; DOS/Windows filesystems. make-temp-file writes to the
6131 ;; file it creates, so we must fix the file name _before_
6132 ;; make-temp-file is called.
6134 fname))
6136 ;; make-temp-file creates the file,
6137 ;; but we don't want it to exist until we do an auto-save.
6141 file-name)))
6144 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6145 FILENAME should lack slashes. You can redefine this for customization."
6147 \f
6149 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6150 The generated regexp will match a filename only if the filename
6151 matches that wildcard according to shell rules. Only wildcards known
6152 by `sh' are supported."
6154 ;; Copy the initial run of non-special characters.
6157 ;; If no special characters, we're almost done.
6161 j)
6163 result
6184 ;; Found "[^". Insert a `\0' character
6185 ;; (which cannot happen in a filename)
6186 ;; into the character class, so that `^'
6187 ;; is not the first character after `[',
6188 ;; and thus non-special in a regexp.
6193 ;; I don't think `]' can appear in a
6194 ;; character class in a wildcard, but
6195 ;; let's be general here.
6202 i
6215 ;; Shell wildcards should match the entire filename,
6216 ;; not its part. Make the regexp say so.
6218 \f
6221 "Switches for `list-directory' to pass to `ls' for brief listing."
6227 "Switches for `list-directory' to pass to `ls' for verbose listing."
6232 "Expand wildcard pattern PATTERN.
6233 This returns a list of file names which match the pattern.
6234 Files are sorted in `string<' order.
6236 If PATTERN is written as an absolute file name,
6237 the values are absolute also.
6239 If PATTERN is written as a relative file name, it is interpreted
6240 relative to the current default directory, `default-directory'.
6241 The file names returned are normally also relative to the current
6242 default directory. However, if FULL is non-nil, they are absolute."
6246 ;; A list of all dirs that DIRPART specifies.
6247 ;; This can be more than one dir
6248 ;; if DIRPART contains wildcards.
6254 contents)
6259 ;; Filter out "." and ".."
6264 name))
6271 this-dir-contents)
6272 this-dir-contents)
6273 contents)))))
6274 contents)))
6276 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6280 "Display a list of files in or matching DIRNAME, a la `ls'.
6281 DIRNAME is globbed by the shell if necessary.
6282 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6283 Actions controlled by variables `list-directory-brief-switches'
6284 and `list-directory-verbose-switches'."
6288 nil default-directory nil)
6289 pfx)))
6291 list-directory-brief-switches))
6292 buffer)
6304 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6312 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6314 PATTERN is assumed to represent a file-name wildcard suitable for the
6315 underlying filesystem. For Unix and GNU/Linux, each character from the
6317 the parts of the pattern which don't include wildcard characters are
6318 quoted with double quotes.
6321 on Windows), so PATTERN can use them to quote wildcard characters that
6322 need to be passed verbatim to shell commands."
6326 ;; DOS/Windows don't allow `"' in file names. So if the
6327 ;; argument has quotes, we can safely assume it is already
6328 ;; quoted by the caller.
6330 ;; We quote [&()#$`'] in case their shell is a port of a
6331 ;; Unixy shell. We quote [,=+] because stock DOS and
6332 ;; Windows shells require that in some cases, such as
6333 ;; passing arguments to batch files that use positional
6334 ;; arguments like %1.
6336 pattern
6339 end)
6356 pattern))))
6363 "Program to get the amount of free space on a file system.
6364 We assume the output has the format of `df'.
6365 The value of this variable must be just a command name or file name;
6366 if you want to specify options, use `directory-free-space-args'.
6368 A value of nil disables this feature.
6370 If the function `file-system-info' is defined, it is always used in
6371 preference to the program given by this variable."
6377 "Options to use when running `directory-free-space-program'."
6382 "Return the amount of free space on directory DIR's file system.
6383 The return value is a string describing the amount of free
6384 space (normally, the number of free 1KB blocks).
6386 This function calls `file-system-info' if it is available, or
6387 invokes the program specified by `directory-free-space-program'
6388 and `directory-free-space-args'. If the system call or program
6389 is unsuccessful, or if DIR is a remote directory, this function
6390 returns nil."
6392 ;; Try to find the number of free blocks. Non-Posix systems don't
6393 ;; always have df, but might have an equivalent system call.
6402 ;; Avoid failure if the default directory does
6403 ;; not exist (Bug#2631, Bug#3911).
6407 nil t nil
6408 directory-free-space-args
6411 ;; Assume that the "available" column is before the
6412 ;; "capacity" column. Find the "%" and scan backward.
6416 "[[:space:]]+[^[:space:]]+%[^%]*$"
6423 ;; The following expression replaces `dired-move-to-filename-regexp'.
6427 ;; In some locales, month abbreviations are as short as 2 letters,
6428 ;; and they can be followed by ".".
6429 ;; In Breton, a month name can include a quote character.
6442 s "+"
6445 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6446 ;; omits the Kanji characters after month and day-of-month.
6447 ;; On Mac OS X 10.3, the date format in East Asian locales is
6448 ;; day-of-month digits followed by month digits.
6454 ;; The "[0-9]" below requires the previous column to end in a digit.
6455 ;; This avoids recognizing `1 may 1997' as a date in the line:
6456 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6458 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6460 ;; For non-iso date formats, we add the ".*" in order to find
6461 ;; the last possible match. This avoids recognizing
6462 ;; `jservice 10 1024' as a date in the line:
6463 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6465 ;; vc dired listings provide the state or blanks between file
6466 ;; permissions and date. The state is always surrounded by
6467 ;; parentheses:
6468 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6469 ;; This is not supported yet.
6474 "Regular expression to match up to the file name in a directory listing.
6475 The default value is designed to recognize dates and times
6481 "Return non-nil if DIR contents a shell wildcard in the directory part.
6482 The return value is a cons (DIR . WILDCARDS); DIR is the
6483 `default-directory' in the Dired buffer, and WILDCARDS are the wildcards.
6485 Valid wildcards are '*', '?', '[abc]' and '[a-z]'."
6488 ls-lisp-support-shell-wildcards)
6492 wildcards wildcards wildcards)))
6500 ;; The following overshoots by one line for an empty
6501 ;; directory listed with "--dired", but without "-a"
6502 ;; switch, where the ls output contains a
6503 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6504 ;; We take care of that case later.
6512 error-lines)
6513 ;; Find all the lines that are error messages,
6514 ;; and record the bounds of each one.
6521 ;; Now read the numeric positions of file names.
6528 error-lines))
6531 error-lines)))
6533 ;; End is followed by \n or by " -> ".
6535 ;; It seems that we can't trust ls's output as to
6536 ;; byte positions of filenames.
6542 ;; Take care of the case where the ls output contains a
6543 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6544 ;; and we went one line too far back (see above).
6549 ;; insert-directory
6550 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6551 ;; FULL-DIRECTORY-P is nil.
6552 ;; The single line of output must display FILE's name as it was
6553 ;; given, namely, an absolute path name.
6554 ;; - must insert exactly one line for each file if WILDCARD or
6555 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6556 ;; before the file lines, plus optional text after the file lines.
6557 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6558 ;; allowed.
6559 ;; File lines should display the basename.
6560 ;; - must be consistent with
6561 ;; - functions dired-move-to-filename, (these two define what a file line is)
6562 ;; dired-move-to-end-of-filename,
6563 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6564 ;; dired-insert-headerline
6565 ;; dired-after-subdir-garbage (defines what a "total" line is)
6566 ;; - variable dired-subdir-regexp
6567 ;; - may be passed "--dired" as the first argument in SWITCHES.
6568 ;; Filename handlers might have to remove this switch if their
6569 ;; "ls" command does not support it.
6571 "Insert directory listing for FILE, formatted according to SWITCHES.
6572 Leaves point after the inserted text.
6573 SWITCHES may be a string of options, or a list of strings
6574 representing individual options.
6575 Optional third arg WILDCARD means treat FILE as shell wildcard.
6576 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6577 switches do not contain `d', so that a full listing is expected.
6579 This works by running a directory listing program
6580 whose name is in the variable `insert-directory-program'.
6581 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6583 When SWITCHES contains the long `--dired' option, this function
6584 treats it specially, for the sake of dired. However, the
6585 normally equivalent short `-D' option is just passed on to
6586 `insert-directory-program', as any other option."
6587 ;; We need the directory in order to find the right handler.
6592 wildcard full-directory-p)
6595 ;; Read the actual directory using `insert-directory-program'.
6596 ;; RESULT gets the status code.
6598 ;; putting text property `dired-filename, decode one
6599 ;; bunch by one to preserve that property.
6601 ;; This is to control encoding the arguments in call-process.
6605 default-file-name-coding-system))))
6608 ;; If the wildcard is just in the file part, then run ls in
6609 ;; the directory part of the file pattern using the last
6610 ;; component as argument. Otherwise, run ls in the longest
6611 ;; subdirectory of the directory part free of wildcards; use
6612 ;; the remaining of the file pattern as argument.
6621 ;; NB since switches is passed to the shell, be
6622 ;; careful of malicious values, eg "-l;reboot".
6623 ;; See eg dired-safe-switches-p.
6625 shell-file-name nil t nil
6626 shell-command-switch
6628 ""
6630 insert-directory-program
6631 " -d "
6633 switches
6635 " -- "
6636 ;; Quote some characters that have
6637 ;; special meanings in shells; but
6638 ;; don't quote the wildcards--we want
6639 ;; them to be special. We also
6640 ;; currently don't quote the quoting
6641 ;; characters in case people want to
6642 ;; use them explicitly to quote
6643 ;; wildcard characters.
6645 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6646 ;; directory if FILE is a symbolic link.
6654 insert-directory-program nil t nil
6658 ;; Split the switches at any spaces so we can
6659 ;; pass separate options as separate args.
6661 ;; Avoid lossage if FILE starts with `-'.
6668 ;; (concat (file-name-as-directory file) ".")
6669 file
6670 file))))))))
6672 ;; If we got "//DIRED//" in the output, it means we got a real
6673 ;; directory listing, even if `ls' returned nonzero.
6674 ;; So ignore any errors.
6687 ;; The first time ls returns an error,
6688 ;; find the version numbers of ls,
6689 ;; and set insert-directory-ls-version
6690 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6691 ;; is equal or if the info cannot be obtained.
6692 ;; (That can mean it isn't GNU ls.)
6702 comparison)
6718 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6722 ;; If `insert-directory-program' failed, signal an error.
6724 ;; Delete the error message it may have output.
6726 ;; On non-Posix systems, we cannot open a directory, so
6727 ;; don't even try, because that will always result in
6728 ;; the ubiquitous "Access denied". Instead, show the
6729 ;; command line so the user can try to guess what went wrong.
6734 insert-directory-program
6736 file result)
6737 ;; Unix. Access the file to get a suitable error.
6741 ;; Now decode what read if necessary.
6743 file-name-coding-system
6744 default-file-name-coding-system
6746 coding-no-eol
6747 val pos)
6751 ;; If no coding system is specified or detection is
6752 ;; requested, detect the coding.
6766 ;; Force no eol conversion on a file name, so
6767 ;; that CR is preserved.
6775 ;; Try to insert the amount of free space.
6778 ;; First find the line to put it on.
6782 ;; Replace "total" with "used", to avoid confusion.
6788 "Convert `ls --dired' file name position value POS to a buffer position.
6789 File name position values returned in ls --dired output
6790 count only stdout; they don't count the error messages sent to stderr.
6791 So this function converts to them to real buffer positions.
6792 ERROR-LINES is a list of buffer positions of error message lines,
6793 of the form (START END)."
6797 pos)
6801 "Insert directory listing for FILE, formatted according to SWITCHES.
6803 Like `insert-directory', but if FILE does not exist, it inserts a
6804 message to that effect instead of signaling an error."
6807 ;; Simulate the message printed by `ls'.
6811 "Functions to call with no arguments to query about killing Emacs.
6812 If any of these functions returns nil, killing Emacs is canceled.
6813 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6814 the low level primitive, does not. See also `kill-emacs-hook'."
6820 "How to ask for confirmation when leaving Emacs.
6821 If nil, the default, don't ask at all. If the value is non-nil, it should
6822 be a predicate function; for example `yes-or-no-p'."
6831 "Non-nil if Emacs should confirm killing processes on exit.
6832 If this variable is nil, the value of
6833 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6834 processes with a non-nil `process-query-on-exit-flag', Emacs will
6835 prompt the user before killing them."
6841 "Offer to save each buffer, then kill this Emacs process.
6842 With prefix ARG, silently save all file-visiting buffers without asking.
6843 If there are active processes where `process-query-on-exit-flag'
6844 returns non-nil and `confirm-kill-processes' is non-nil,
6845 asks whether processes should be killed.
6846 Runs the members of `kill-emacs-query-functions' in turn and stops
6847 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6849 ;; Don't use save-some-buffers-default-predicate, because we want
6850 ;; to ask about all the buffers before killing Emacs.
6861 ;; process-list is not defined on MSDOS.
6864 active)
6882 ;; Query the user for other things, perhaps.
6889 "Offer to save each buffer, then kill the current connection.
6890 If the current frame has no client, kill Emacs itself using
6891 `save-buffers-kill-emacs'.
6893 With prefix ARG, silently save all file-visiting buffers, then kill.
6895 If emacsclient was started with a list of filenames to edit, then
6896 only these files will be asked to be saved."
6901 \f
6902 ;; We use /: as a prefix to "quote" a file name
6903 ;; so that magic file name handlers will not apply to it.
6907 file-name-handler-alist))
6909 ;; We depend on being the last handler on the list,
6910 ;; so that anything else which does need handling
6911 ;; has been handled already.
6912 ;; So it is safe for us to inhibit *all* magic file name handlers.
6917 ;; Some operations respect file name handlers in
6918 ;; `default-directory'. Because core function like
6919 ;; `call-process' don't care about file name handlers in
6920 ;; `default-directory', we here have to resolve the
6921 ;; directory into a local one. For `process-file',
6922 ;; `start-file-process', and `shell-command', this fixes
6923 ;; Bug#25949.
6925 shell-command))
6929 default-directory))
6930 ;; Get a list of the indices of the args which are file names.
6933 ;; The first six are special because they
6934 ;; return a file name. We want to include the /:
6935 ;; in the return value.
6936 ;; So just avoid stripping it in the first place.
6943 ;; `identity' means just return the first arg
6944 ;; not stripped of its quoting.
6946 ;; `add' means add "/:" to the result.
6949 ;; `unquote-then-quote' means set buffer-file-name
6950 ;; temporarily to unquoted filename.
6952 ;; List the arguments which are filenames.
6960 ;; For all other operations, treat the first argument only
6961 ;; as the file name.
6963 method
6964 ;; Copy ARGUMENTS so we can replace elements in it.
6968 ;; Strip off the /: from the file names that have it.
6976 "/"
6982 (`insert-file-contents
6988 (`unquote-then-quote
6989 ;; We can't use `cl-letf' with `(buffer-local-value)' here
6990 ;; because it wouldn't work during bootstrapping.
6992 ;; `unquote-then-quote' is only used for the
6993 ;; `verify-visited-file-modtime' action, which takes a buffer
6994 ;; as only optional argument.
6997 ;; Make sure to hide the temporary buffer change from the
6998 ;; underlying operation.
7006 If NAME is a remote file name, check the local part of NAME."
7011 If NAME is a remote file name, the local part of NAME is quoted.
7012 If NAME is already a quoted file name, NAME is returned unchanged."
7014 name
7019 If NAME is a remote file name, the local part of NAME is unquoted."
7025 \f
7026 ;; Symbolic modes and read-file-modes.
7029 "Convert CHAR to a numeric bit-mask for extracting mode bits.
7030 CHAR is in [ugoa] and represents the category of users (Owner, Group,
7031 Others, or All) for whom to produce the mask.
7032 The bit-mask that is returned extracts from mode bits the access rights
7033 for the specified category of users."
7041 "Convert CHAR to a numeric value of mode bits.
7042 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7043 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7050 ;; Rights relative to the previous file modes.
7061 "Convert a symbolic mode string specification to an equivalent number.
7063 WHO-MASK is the bit-mask specifying the category of users to which to
7064 apply the access permissions. See `file-modes-char-to-who'.
7065 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7066 RIGHTS request to add, remove, or set permissions based on existing ones,
7073 char-right)
7080 num-rights
7084 op char-right)))
7085 num-rights))
7088 "Convert symbolic file modes to numeric file modes.
7089 MODES is the string to convert, it should match
7091 See Info node `(coreutils)File permissions' for more information on this
7092 notation.
7093 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7094 MODES request to add, remove, or set permissions based on existing ones,
7108 num-who num-modes)
7111 num-modes)))
7114 "Read file modes in octal or symbolic notation and return its numeric value.
7116 ORIG-FILE is the name of a file on whose mode bits to base returned
7117 permissions if what user types requests to add, remove, or set permissions
7133 nil nil default)))
7142 ;; Trashcan handling.
7144 "Directory for `move-file-to-trash' to move files and directories to.
7145 This directory is only used when the function `system-move-file-to-trash'
7146 is not defined.
7147 Relative paths are interpreted relative to `default-directory'.
7148 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7158 "Move the file (or directory) named FILENAME to the trash.
7159 When `delete-by-moving-to-trash' is non-nil, this function is
7160 called by `delete-file' and `delete-directory' instead of
7161 deleting files outright.
7163 If the function `system-move-file-to-trash' is defined, call it
7164 with FILENAME as an argument.
7165 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7166 directory.
7167 Otherwise, trash FILENAME using the freedesktop.org conventions,
7168 like the GNOME, KDE and XFCE desktop environments. Emacs only
7172 ;; If `trash-directory' is non-nil, move the file there.
7177 ;; We can't trash a parent directory of trash-directory.
7180 trash-dir filename))
7183 ;; Ensure that the trashed file-name is unique.
7190 ;; If `system-move-file-to-trash' is defined, use it.
7193 ;; Otherwise, use the freedesktop.org method, as specified at
7194 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7205 ;; Check if we have permissions to delete.
7209 ;; The trashed file cannot be the trash dir or its parent.
7212 trash-files-dir filename))
7215 trash-info-dir filename))
7217 ;; Ensure that the trash directory exists; otherwise, create it.
7224 ;; Try to move to trash with .trashinfo undo information
7229 ;; Perform url-encoding on FN. For compatibility with
7230 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7231 ;; for path separators.
7236 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7237 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7250 fn))
7255 ;; Make a .trashinfo file. Use O_EXCL, as per trash-spec 1.0.
7259 trash-info-dir)))
7263 ;; Uniquify new-fn. Some file managers do not
7264 ;; like Emacs-style backup file names. E.g.:
7265 ;; https://bugs.kde.org/170956
7271 ;; Finally, try to move the file to the trashcan.
7277 "The type field in ATTRIBUTES returned by `file-attributes'.
7278 The value is either t for directory, string (name linked to) for
7279 symbolic link, or nil."
7283 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7287 "The UID field in ATTRIBUTES returned by `file-attributes'.
7288 This is either a string or a number. If a string value cannot be
7289 looked up, a numeric value, either an integer or a float, is
7290 returned."
7294 "The GID field in ATTRIBUTES returned by `file-attributes'.
7295 This is either a string or a number. If a string value cannot be
7296 looked up, a numeric value, either an integer or a float, is
7297 returned."
7301 "The last access time in ATTRIBUTES returned by `file-attributes'.
7302 This a list of integers (HIGH LOW USEC PSEC) in the same style
7303 as (current-time)."
7307 "The modification time in ATTRIBUTES returned by `file-attributes'.
7308 This is the time of the last change to the file's contents, and
7309 is a list of integers (HIGH LOW USEC PSEC) in the same style
7310 as (current-time)."
7314 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7315 This is the time of last change to the file's attributes: owner
7316 and group, access mode bits, etc, and is a list of integers (HIGH
7317 LOW USEC PSEC) in the same style as (current-time)."
7321 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7322 This is a floating point number if the size is too large for an integer."
7326 "The file modes in ATTRIBUTES returned by `file-attributes'.
7327 This is a string of ten letters or dashes as in ls -l."
7331 "The inode number in ATTRIBUTES returned by `file-attributes'.
7332 If it is larger than what an Emacs integer can hold, this is of
7333 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7334 If even HIGH is too large for an Emacs integer, this is instead
7335 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7336 middle 24 bits, and finally the low 16 bits."
7340 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7341 If it is larger than what an Emacs integer can hold, this is of
7342 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7343 If even HIGH is too large for an Emacs integer, this is instead
7344 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7345 middle 24 bits, and finally the low 16 bits."
7349 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7350 ATTR-NAMES are symbols with the selected attribute names.
7352 Valid attribute names are: type, link-number, user-id, group-id,
7353 access-time, modification-time, status-change-time, size, modes,
7354 inode-number and device-number."
7356 modification-time status-change-time
7357 size modes inode-number device-number))
7358 result)
7364 attributes)
7365 result)
7368 \f
7393 ;;; files.el ends here