| blob | 77ebd94836ed8211cc2228fd8f5ec913e237dd47 |
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 the truename of FILENAME.
1151 If FILENAME is not absolute, first expands it against `default-directory'.
1152 The truename of a file name is found by chasing symbolic links
1153 both at the level of the file and at the level of the directories
1154 containing it, until no links are left at any level.
1157 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1158 ;; COUNTER can be a cons cell whose car is the count of how many
1159 ;; more links to chase before getting an error.
1160 ;; PREV-DIRS can be a cons cell whose car is an alist
1161 ;; of truenames we've just recently computed.
1175 ;; For speed, remove the ange-ftp completion handler from the list.
1176 ;; We know it's not needed here.
1177 ;; For even more speed, do this only on the outermost call.
1184 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1185 ;; case differences being ignored by the OS, and short "8.3 DOS"
1186 ;; name aliases existing for all files. (The short names are not
1187 ;; reported by directory-files, but can be used to refer to files.)
1188 ;; It seems appropriate for file-truename to resolve these issues in
1189 ;; the most natural way, which on Windows is to call the function
1190 ;; `w32-long-file-name' - this returns the exact name of a file as
1191 ;; it is stored on disk (expanding short name aliases with the full
1192 ;; name in the process).
1195 ;; If filename exists, use its long name. If it doesn't
1196 ;; exist, the recursion below on the directory of filename
1197 ;; will drill down until we find a directory that exists,
1198 ;; and use the long name of that, with the extra
1199 ;; non-existent path components concatenated.
1204 ;; If this file directly leads to a link, process that iteratively
1205 ;; so that we don't use lots of stack.
1211 ;; For file name that has a special handler, call handler.
1212 ;; This is so that ange-ftp can save time by doing a no-op.
1215 done t)
1217 target dirfile)
1218 ;; Get the truename of the directory.
1220 ;; If these are equal, we have the (or a) root directory.
1224 ;; If this is the same dir we last got the truename for,
1225 ;; save time--don't recalculate.
1235 done t)
1238 done t)
1239 ;; Put it back on the file name.
1241 ;; Is the file name the name of a link?
1244 ;; Yes => chase that link, then start all over
1245 ;; since the link may point to a directory name that uses links.
1246 ;; We can't safely use expand-file-name here
1247 ;; since target might look like foo/../bar where foo
1248 ;; is itself a link. Instead, we handle . and .. above.
1251 target
1253 done nil)
1254 ;; No, we are done!
1256 filename))
1259 "Chase links in FILENAME until a name that is not a link.
1260 Unlike `file-truename', this does not check whether a parent
1261 directory name is a symbolic link.
1262 If the optional argument LIMIT is a number,
1263 it means chase no more than that many links and then stop."
1271 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1274 ;; Handle `..' by hand, since it needs to work in the
1275 ;; target of any directory symlink.
1276 ;; This code is not quite complete; it does not handle
1277 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1281 ;; Chase links in the default dir of the symlink.
1285 ;; Now find the parent of that dir.
1289 newname))
1291 ;; A handy function to display file sizes in human-readable form.
1292 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1294 "Produce a string showing FILE-SIZE in human-readable form.
1296 Optional second argument FLAVOR controls the units and the display format:
1298 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1300 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1302 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1305 1024.0
1308 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1314 "%.1f%s%s"
1316 file-size
1318 "K"
1324 "^//[^/]+/"
1325 ;; regexp-opt.el is not dumped into emacs binary.
1326 ;;(concat
1327 ;; "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))))
1329 "File systems which ought to be mounted."
1336 "The directory for writing temporary files.
1337 In case of a remote `default-directory', this is a directory for
1338 temporary files on that remote host. If such a directory does
1339 not exist, or `default-directory' ought to be located on a
1340 mounted file system (see `mounted-file-systems'), the function
1341 returns `default-directory'.
1342 For a non-remote and non-mounted `default-directory', the value of
1343 the variable `temporary-file-directory' is returned."
1349 default-directory
1350 temporary-file-directory))))
1353 "Create a temporary file.
1354 The returned file name (created by appending some random characters at the end
1355 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1356 is guaranteed to point to a newly created file.
1357 You can then use `write-region' to write new data into the file.
1359 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1361 If SUFFIX is non-nil, add that at the end of the file name.
1363 If TEXT is a string, insert it into the new file; DIR-FLAG should be nil.
1364 Otherwise the file will be empty."
1376 "Implement (make-temp-file ABSOLUTE-PREFIX DIR-FLAG SUFFIX TEXT).
1377 This implementation works on magic file names."
1378 ;; Create temp files with strict access rights. It's easy to
1379 ;; loosen them later, whereas it's impossible to close the
1380 ;; time-window of loose permissions otherwise.
1383 file)
1392 nil)
1394 ;; the file was somehow created by someone else between
1395 ;; `make-temp-name' and `write-region', let's try again.
1396 nil)
1397 file)))
1400 "Create a temporary file as close as possible to `default-directory'.
1401 If PREFIX is a relative file name, and `default-directory' is a
1402 remote file name or located on a mounted file systems, the
1403 temporary file is created in the directory returned by the
1404 function `temporary-file-directory'. Otherwise, the function
1405 `make-temp-file' is used. PREFIX, DIR-FLAG and SUFFIX have the
1406 same meaning as in `make-temp-file'."
1415 "Change the encoding of FILE's name from CODING to NEW-CODING.
1416 The value is a new name of FILE.
1417 Signals a `file-already-exists' error if a file of the new name
1418 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1419 is non-nil. A number as fourth arg means request confirmation if
1420 the new name already exists. This is what happens in interactive
1421 use with M-x."
1424 default-file-name-coding-system))
1426 from-coding to-coding)
1428 ;; We provide the default coding only when it seems that
1429 ;; the filename is correctly decoded by the default
1430 ;; coding.
1436 filename default-coding)
1437 default-coding))
1441 ;; We provide the default coding only when a user is going to
1442 ;; change the encoding not from the default coding.
1446 filename from-coding)))
1449 filename from-coding default-coding)
1450 default-coding)))
1454 default-file-name-coding-system))
1455 ;; FILE should have been decoded by DEFAULT-CODING.
1459 ;; Suppress further encoding.
1464 newname))
1465 \f
1467 "Whether confirmation is requested before visiting a new file or buffer.
1468 If nil, confirmation is not requested.
1469 If the value is `after-completion', confirmation is only
1470 requested if the user called `minibuffer-complete' right before
1471 `minibuffer-complete-and-exit'.
1472 Any other non-nil value means to request confirmation.
1474 This affects commands like `switch-to-buffer' and `find-file'."
1482 "Whether to request confirmation before visiting a new file or buffer.
1483 The variable `confirm-nonexistent-file-or-buffer' determines the
1484 return value, which may be passed as the REQUIRE-MATCH arg to
1485 `read-buffer' or `find-file-read-args'."
1493 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1495 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1496 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1497 instead of prepending it.
1499 BODY should use the minibuffer at most once.
1500 Recursive uses of the minibuffer are unaffected (FUN is not
1501 called additional times).
1503 This macro actually adds an auxiliary function that calls FUN,
1504 rather than FUN itself, to `minibuffer-setup-hook'."
1515 ;; Clear out this hook so it does not interfere
1516 ;; with any recursive minibuffer usage.
1527 t))
1530 "Edit file FILENAME.
1531 Switch to a buffer visiting file FILENAME,
1532 creating one if none already exists.
1533 Interactively, the default if you just type RET is the current directory,
1534 but the visited file name is available through the minibuffer history:
1535 type M-n to pull it into the minibuffer.
1537 You can visit files on remote machines by specifying something
1538 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1539 also visit local files as a different user by specifying
1540 /sudo::FILE for the file name.
1541 See the Info node `(tramp)File name Syntax' in the Tramp Info
1542 manual, for more about this.
1544 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1545 expand wildcards (if any) and visit multiple files. You can
1546 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1548 To visit a file without any kind of conversion and without
1559 "Edit file FILENAME, in another window.
1562 an existing one. See the function `display-buffer'.
1564 Interactively, the default if you just type RET is the current directory,
1565 but the visited file name is available through the minibuffer history:
1566 type M-n to pull it into the minibuffer.
1568 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1569 expand wildcards (if any) and visit multiple files."
1579 value)
1583 "Edit file FILENAME, in another frame.
1586 an existing one. See the function `display-buffer'.
1588 Interactively, the default if you just type RET is the current directory,
1589 but the visited file name is available through the minibuffer history:
1590 type M-n to pull it into the minibuffer.
1592 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1593 expand wildcards (if any) and visit multiple files."
1603 value)
1607 "Edit the existing file FILENAME.
1609 file names with wildcards."
1626 value))
1629 "Edit file FILENAME but don't allow changes.
1638 "Edit file FILENAME in another window but don't allow changes.
1647 "Edit file FILENAME in another frame but don't allow changes.
1656 "Find file FILENAME as a replacement for the file in the next window.
1657 This command does not select that window.
1661 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1662 expand wildcards (if any) and replace the file with multiple files."
1673 "Find alternate file: " file-dir nil
1675 t))))
1682 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1684 "Hook run when a buffer is killed.
1685 The buffer being killed is current while the hook is running.
1686 See `kill-buffer'.
1688 Note: Be careful with let-binding this hook considering it is
1692 "Find file FILENAME, select its buffer, kill previous buffer.
1693 If the current buffer now contains an empty file that you just visited
1694 \(presumably by mistake), use this command to visit the file you really want.
1698 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1699 expand wildcards (if any) and replace the file with multiple files.
1701 If the current buffer is an indirect buffer, or the base buffer
1702 for one or more indirect buffers, the other buffer(s) are not
1703 killed."
1712 "Find alternate file: " file-dir nil
1714 t)))
1728 ;; Run `kill-buffer-hook' here. It needs to happen before
1729 ;; variables like `buffer-file-name' etc are set to nil below,
1730 ;; because some of the hooks that could be invoked
1731 ;; (e.g., `save-place-to-alist') depend on those variables.
1732 ;;
1733 ;; Note that `kill-buffer-hook' is not what queries whether to
1734 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1735 ;; asks that itself. Thus, there's no need to temporarily do
1736 ;; `(set-buffer-modified-p nil)' before running this hook.
1738 ;; Okay, now we can end-of-life the old buffer.
1745 ;; This prevents us from finding the same buffer
1746 ;; if we specified the same file again.
1750 ;; Likewise for dired buffers.
1754 ;; This executes if find-file gets an error
1755 ;; and does not really find anything.
1756 ;; We put things back as they were.
1757 ;; If find-file actually finds something, we kill obuf below.
1766 ;; We already ran these; don't run them again.
1769 \f
1770 ;; FIXME we really need to fold the uniquify stuff in here by default,
1771 ;; not using advice, and add it to the doc string.
1773 "Create a suitably named buffer for visiting FILENAME, and return it.
1774 FILENAME (sans directory) is used unchanged if that name is free;
1775 otherwise a string <2> or <3> or ... is appended to get an unused name.
1777 Emacs treats buffers whose names begin with a space as internal buffers.
1778 To avoid confusion when visiting a file whose name begins with a space,
1785 lastname))))
1788 "Create and return a buffer with a name based on NAME.
1789 Choose the buffer's name using `generate-new-buffer-name'."
1793 "Regexp to match the automounter prefix in a directory name."
1799 "Regexp matching the user's homedir at the beginning of file name.
1803 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1805 home directory is a root directory) and removes automounter prefixes
1806 \(see the variable `automount-dir-prefix')."
1807 ;; Get rid of the prefixes added by the automounter.
1814 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1816 ;; If any elt of directory-abbrev-alist matches this name,
1817 ;; abbreviate accordingly.
1823 ;; Compute and save the abbreviated homedir name.
1824 ;; We defer computing this until the first time it's needed, to
1825 ;; give time for directory-abbrev-alist to be set properly.
1826 ;; We include a slash at the end, to avoid spurious matches
1827 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1835 ;; Depending on whether default-directory does or
1836 ;; doesn't include non-ASCII characters, the value
1837 ;; of abbreviated-home-dir could be multibyte or
1838 ;; unibyte. In the latter case, we need to decode
1839 ;; it. Note that this function is called for the
1840 ;; first time (from startup.el) when
1841 ;; locale-coding-system is already set up.
1843 abbreviated-home-dir
1846 'utf-8
1847 locale-coding-system))))))
1849 ;; If FILENAME starts with the abbreviated homedir,
1850 ;; make it start with `~' instead.
1852 ;; If the home dir is just /, don't change it.
1855 ;; MS-DOS root directories can come with a drive letter;
1856 ;; Novell Netware allows drive letters beyond `Z:'.
1864 filename)))
1867 "Return the buffer visiting file FILENAME (a string).
1868 This is like `get-file-buffer', except that it checks for any buffer
1869 visiting the same file, possibly under a different name.
1870 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1871 and others are ignored.
1872 If there is no such live buffer, return nil."
1885 found)
1895 ;; Verify this buffer's file number
1896 ;; still belongs to its file.
1899 attributes)
1903 found))))
1904 \f
1906 "Non-nil means file-visiting commands should handle wildcards.
1907 For example, if you specify `*.c', that would visit all the files
1908 whose names match the pattern."
1914 "Non-nil means suppress warning messages for symlinked files.
1915 When nil, Emacs prints a warning when visiting a file that is already
1916 visited, but with a different name. Setting this option to t
1917 suppresses this warning."
1923 "Maximum size of file above which a confirmation is requested.
1924 When nil, never request confirmation."
1931 "Warn if file size exceeds this percentage of available free memory.
1932 When nil, never issue warning. Beware: This probably doesn't do what you
1940 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1941 OP-TYPE specifies the file operation being performed (for message to user)."
1950 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1960 "You are trying to open a file whose size (%s)
1961 exceeds the %S%% of currently available free memory (%s).
1962 If that fails, try to open it with `find-file-literally'
1963 \(but note that some characters might be displayed incorrectly)."
1965 out-of-memory-warning-percentage
1969 "Like `message', except sometimes don't print to minibuffer.
1970 If the variable `save-silently' is non-nil, the message is not
1971 displayed on the minibuffer."
1976 "Read file FILENAME into a buffer and return the buffer.
1977 If a buffer exists visiting FILENAME, return that one, but
1978 verify that the file has not changed since visited or saved.
1979 The buffer is not selected, just returned to the caller.
1980 Optional second arg NOWARN non-nil means suppress any warning messages.
1981 Optional third arg RAWFILE non-nil means the file is read literally.
1982 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1983 and visit all the matching files. When wildcards are actually
1984 used and expanded, return a list of buffers that are visiting
1985 the various files."
1992 'find-directory-functions
1995 filename)))
1998 find-file-wildcards
2012 ;; Find any buffer for a file which has same truename.
2014 ;; Let user know if there is a buffer with the same truename.
2018 find-file-suppress-same-file-warnings
2022 ;; Optionally also find that buffer.
2025 ;; Check to see if the file looks uncommonly large.
2030 ;; We are using an existing buffer.
2037 ;; Certain files should be reverted automatically
2038 ;; if they have changed on disk and not in the buffer.
2046 found))
2056 "File %s changed on disk. Discard your edits? "
2061 "File %s changed on disk. Discard your edits in %s? "
2069 ;; Check if a formerly read-only file has become
2070 ;; writable and vice versa, but if the buffer agrees
2071 ;; with the new state of the file, that is ok too.
2081 buffer-file-name
2082 new-status new-status)))
2088 nonexistent
2089 ;; It is confusing to ask whether to visit
2090 ;; non-literally if they have the file in
2091 ;; hexl-mode or image-mode.
2097 "The file %s is already visited normally,
2098 and you have edited the buffer. Now you have asked to visit it literally,
2099 meaning no coding system handling, format conversion, or local variables.
2100 Emacs can only visit a file in one way at a time.
2102 Do you want to save the file, and visit it literally instead? "
2103 "The file %s is already visited literally,
2104 meaning no coding system handling, format conversion, or local variables.
2105 You have edited the buffer. Now you have asked to visit the file normally,
2106 but Emacs can only visit a file in one way at a time.
2113 rawfile truename number))
2117 "\
2118 Do you want to discard your changes, and visit the file literally now? "
2119 "\
2122 rawfile truename number)
2128 "The file %s is already visited normally.
2129 You have asked to visit it literally,
2130 meaning no coding system decoding, format conversion, or local variables.
2131 But Emacs can only visit a file in one way at a time.
2133 Do you want to revisit the file literally now? "
2134 "The file %s is already visited literally,
2135 meaning no coding system decoding, format conversion, or local variables.
2136 You have asked to visit it normally,
2137 but Emacs can only visit a file in one way at a time.
2142 rawfile truename number)
2145 ;; Return the buffer we are using.
2146 buf)
2147 ;; Create a new buffer.
2149 ;; find-file-noselect-1 may use a different buffer.
2151 rawfile truename number))))))
2157 ;; Needed in case we are re-visiting the file with a different
2158 ;; text representation.
2175 filename)))
2176 ;; Unconditionally set error
2186 filename)))
2187 ;; Run find-file-not-found-functions until one returns non-nil.
2189 ;; If they fail too, set error.
2191 ;; Record the file's truename, and maybe use that as visited name.
2199 ;; Set buffer's default directory to that of the file.
2201 ;; Turn off backup files for certain file names. Since
2202 ;; this is a permanent local, the major mode won't eliminate it.
2216 \f
2218 "Like `insert-file-contents', but only reads in the file literally.
2219 See `insert-file-contents' for an explanation of the parameters.
2220 A buffer may be modified in several ways after reading into the buffer,
2221 due to Emacs features such as format decoding, character code
2222 conversion, `find-file-hook', automatic uncompression, etc.
2224 This function ensures that none of these modifications will take place."
2230 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2231 ;; into a file operation instead!
2233 inhibit-file-name-handlers))
2240 filename)))
2241 ;; Check whether the file is uncommonly large
2252 "Insert contents of file FILENAME into buffer after point with no conversion.
2254 This function is meant for the user to run interactively.
2255 Don't call it from programs! Use `insert-file-contents-literally' instead.
2256 \(Its calling sequence is different; see its documentation)."
2262 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2263 This has the `permanent-local' property, which takes effect if you
2268 "Visit file FILENAME with no conversion of any kind.
2269 Format conversion and character code conversion are both disabled,
2270 and multibyte characters are disabled in the resulting buffer.
2271 The major mode used is Fundamental mode regardless of the file name,
2272 and local variable specifications in the file are ignored.
2273 Automatic uncompression and adding a newline at the end of the
2274 file due to `require-final-newline' is also disabled.
2276 You cannot absolutely rely on this function to result in
2277 visiting the file literally. If Emacs already has a buffer
2278 which is visiting the file, you get the existing buffer,
2279 regardless of whether it was created literally or not.
2281 In a Lisp program, if you want to be sure of accessing a file's
2282 contents literally, you should create a temporary buffer and then read
2283 the file contents into it using `insert-file-contents-literally'."
2286 "Find file literally: " nil default-directory
2289 \f
2291 _after-find-file-from-revert-buffer
2292 nomodes)
2293 "Called after finding a file and by the default revert function.
2294 Sets buffer mode, parses local variables.
2295 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2296 error in reading the file. WARN non-nil means warn if there
2297 exists an auto-save file more recent than the visited file.
2298 NOAUTO means don't mess with auto-save mode.
2299 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2300 \(see `revert-buffer-in-progress-p' for similar functionality).
2301 Fifth arg NOMODES non-nil means don't alter the file's modes.
2302 Finishes by calling the functions in `find-file-hook'
2303 unless NOMODES is non-nil."
2306 nil
2316 "Symbolic link that points to nonexistent file"
2320 ;; No need to warn if buffer is auto-saved
2321 ;; under the name of the visited file.
2323 auto-save-visited-file-name))
2326 buffer-file-name))
2346 ;; Make people do a little extra work (C-x C-q)
2347 ;; before altering a backup file.
2350 ;; When a file is marked read-only,
2351 ;; make the buffer read-only even if root is looking at it.
2359 ;; If requested, add a newline at the end of the file.
2370 view-read-only
2378 "Choose the major mode for this buffer automatically.
2379 Also sets up any specified local variables of the file.
2380 Uses the visited file name, the -*- line, and the local variables spec.
2382 This function is called automatically from `find-file'. In that case,
2383 we may set up the file-specified mode and local variables,
2384 depending on the value of `enable-local-variables'.
2385 In addition, if `local-enable-local-variables' is nil, we do
2386 not set local variables (though we do notice a mode specified with -*-.)
2388 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2389 or from Lisp without specifying the optional argument FIND-FILE;
2390 in that case, this function acts as if `enable-local-variables' were t."
2397 ;; FIXME this is less efficient than it could be, since both
2398 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2401 ;; `delay-mode-hooks' being non-nil will have prevented the major
2402 ;; mode's call to `run-mode-hooks' from calling
2403 ;; `hack-local-variables'. In that case, call it now.
2407 ;; Turn font lock off and on, to make sure it takes account of
2408 ;; whatever file local variables are relevant to it.
2410 ;; Font-lock-mode (now in font-core.el) can be ON when
2411 ;; font-lock.el still hasn't been loaded.
2418 "Non-nil means to try second pass through `auto-mode-alist'.
2419 This means that if the first case-sensitive search through the alist fails
2420 to find a matching major mode, a second case-insensitive search is made.
2421 On systems with case-insensitive file names, this variable is ignored,
2422 since only a single case-insensitive search through the alist is made."
2428 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2429 ;; c++-mode, java-mode and more) are added through autoload
2430 ;; directives in that file. That way is discouraged since it
2431 ;; spreads out the definition of the initial value.
2477 ;; Less common extensions come here
2478 ;; so more common ones above are found faster.
2486 ;; Besides .gdbinit, gdb documents other names to be usable for init
2487 ;; files, cross-debuggers can use something like
2488 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2489 ;; don't interfere with each other.
2491 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2492 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2493 ;; loaded when GDB reads an objfile called 'emacs'.
2501 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2525 ;; The Fortran standard does not say anything about file extensions.
2526 ;; .f90 was widely used for F90, now we seem to be trapped into
2527 ;; using a different extension for each language revision.
2528 ;; Anyway, the following extensions are supported by gfortran.
2536 ;; The list of archive file extensions should be in sync with
2537 ;; `auto-coding-alist' with `no-conversion' coding system.
2543 ;; Mailer puts message to be edited in
2544 ;; /tmp/Re.... or Message
2547 ;; some news reader is reported to use this
2561 ;; .emacs or .gnus or .viper following a directory delimiter in
2562 ;; Unix or MS-DOS syntax.
2565 ;; _emacs following a directory delimiter in MS-DOS syntax
2569 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2570 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2571 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2574 ;; .xs is also used for ld scripts, but seems to be more commonly
2575 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2577 ;; Explained in binutils ld/genscripts.sh. Eg:
2578 ;; A .x script file is the default script.
2579 ;; A .xr script is for linking without relocation (-r flag). Etc.
2583 ;; Common Lisp ASDF package system.
2590 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2602 ;; Windows candidates may be opened case sensitively on Unix
2609 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2610 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2611 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2612 ;; this has lower priority to avoid matching changelog.sgml etc.
2614 ;; either user's dot-files or under /etc or some such
2616 ;; alas not all ~/.*rc files are like this
2617 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2622 ;; this contains everything twice, with space and with colon :-(
2624 ;; Get rid of any trailing .n.m and try again.
2625 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2626 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2627 ;; Using mode nil rather than `ignore' would let the search continue
2628 ;; through this list (with the shortened name) rather than start over.
2631 ;; This should come after "in" stripping (e.g. config.h.in).
2632 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2634 ;; The following should come after the ChangeLog pattern
2635 ;; for the sake of ChangeLog.1, etc.
2636 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2638 "Alist of filename patterns vs corresponding major mode functions.
2639 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2640 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2641 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2642 mode function to use. FUNCTION will be called, unless it is nil.
2644 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2645 calling FUNCTION (if it's not nil), we delete the suffix that matched
2646 REGEXP and search the list again for another match.
2648 The extensions whose FUNCTION is `archive-mode' should also
2649 appear in `auto-coding-alist' with `no-conversion' coding system.
2651 See also `interpreter-mode-alist', which detects executable script modes
2652 based on the interpreters they specify to run,
2657 "Select Conf mode or XML mode according to start of file."
2667 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2668 ;; and pike-mode) are added through autoload directives in that
2669 ;; file. That way is discouraged since it spreads out the
2670 ;; definition of the initial value.
2699 "Alist mapping interpreter names to major modes.
2700 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2701 Each element looks like (REGEXP . MODE).
2702 If REGEXP matches the entire name (minus any directory part) of
2703 the interpreter specified in the first line of a script, enable
2704 major mode MODE.
2711 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2712 ;; because we are duplicating info from auto-mode-alist.
2713 ;; TODO many elements of this list are also in auto-coding-alist.
2722 "List of regexps matching file names in which to ignore local variables.
2724 Files matching this list are typically binary file formats.
2725 They may happen to contain sequences that look like local variable
2726 specifications, but are not really, or they may be containers for
2727 member files with their own local variable sections, which are
2728 not appropriate for the containing file.
2735 "List of regexps matching suffixes to remove from file names.
2736 The function `inhibit-local-variables-p' uses this: when checking
2737 a file name, it first discards from the end of the name anything that
2740 ;; Can't think of any situation in which you'd want this to be nil...
2745 "Return non-nil if file local variables should be ignored.
2746 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2747 and `inhibit-local-variables-suffixes'. If
2748 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2757 sufs)
2762 temp))
2767 "Regexp matching interpreters, for file mode determination.
2768 This regular expression is matched against the first line of a file
2769 to determine the file's mode in `set-auto-mode'. If it matches, the file
2770 is assumed to be interpreted by the interpreter matched by the second group
2771 of the regular expression. The mode is then determined as the mode
2775 "Alist of buffer beginnings vs. corresponding major mode functions.
2776 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2777 After visiting a file, if REGEXP matches the text at the beginning of the
2778 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2779 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2780 major mode.
2782 If FUNCTION is nil, then it is not called. (That is a way of saying
2790 ;; The < comes before the groups (but the first) to reduce backtracking.
2791 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2792 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2796 comment-re "*"
2799 . mhtml-mode)
2801 ;; These two must come after html, because they are more general:
2806 . sgml-mode)
2809 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2810 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2811 After visiting a file, if REGEXP matches the text at the beginning of the
2812 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2813 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2814 have not specified a mode for this file.
2820 "Upper limit on `magic-mode-alist' regexp matches.
2824 "Select major mode appropriate for current buffer.
2826 To find the right major mode, this function checks for a -*- mode tag
2827 checks for a `mode:' entry in the Local Variables section of the file,
2828 checks if it uses an interpreter listed in `interpreter-mode-alist',
2829 matches the buffer beginning against `magic-mode-alist',
2830 compares the filename against the entries in `auto-mode-alist',
2831 then matches the buffer beginning against `magic-fallback-mode-alist'.
2833 If `enable-local-variables' is nil, or if the file name matches
2834 `inhibit-local-variables-regexps', this function does not check
2835 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2836 is nil, then the only mode: tag that can be relevant is a -*- one.
2838 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2839 set the major mode only if that would change it. In other words
2840 we don't actually set it to the same mode the buffer already has."
2841 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2843 end done mode modes)
2844 ;; Once we drop the deprecated feature where mode: is also allowed to
2845 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2846 ;; remove this section and just let (hack-local-variables t) handle it.
2847 ;; Find a -*- mode tag.
2851 ;; Note by design local-enable-local-variables does not matter here.
2853 try-locals
2856 ;; Find all specifications for the `mode:' variable
2857 ;; and execute them left to right.
2869 modes)))
2870 ;; Simple -*-MODE-*- case.
2873 modes))))
2874 ;; If we found modes to use, invoke them now, outside the save-excursion.
2882 ;; continuing would call minor modes again, toggling them off
2884 ;; hack-local-variables checks local-enable-local-variables etc, but
2885 ;; we might as well be explicit here for the sake of clarity.
2887 enable-local-variables
2888 local-enable-local-variables
2889 try-locals
2896 ;; If we didn't, look for an interpreter specified in the first line.
2897 ;; As a special case, allow for things like "#!/bin/env perl", which
2898 ;; finds the interpreter anywhere in $PATH.
2904 ;; Map interpreter name to a mode, signaling we're done at the
2905 ;; same time.
2912 interpreter-mode-alist)
2914 ;; If we found an interpreter mode to use, invoke it now.
2916 ;; Next try matching the buffer beginning against magic-mode-alist.
2925 nil magic-mode-alist
2934 "Problem in magic-mode-alist with element %s"
2935 re))))))))
2937 ;; Next compare the filename against the entries in auto-mode-alist.
2943 buffer-file-name)))
2944 ;; Remove backup-suffixes from file name.
2946 ;; Remove remote file name identification.
2951 ;; Find first matching alist entry.
2954 ;; Filesystem is case-insensitive.
2958 ;; Filesystem is case-sensitive.
2960 ;; First match case-sensitively.
2964 ;; Fallback to case-insensitive match.
2978 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2995 "Problem with magic-fallback-mode-alist element: %s"
2996 re))))))))
3001 ;; When `keep-mode-if-same' is set, we are working on behalf of
3002 ;; set-visited-file-name. In that case, if the major mode specified is the
3003 ;; same one we already have, don't actually reset it. We don't want to lose
3004 ;; minor modes such as Font Lock.
3006 "Apply MODE and return it.
3007 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
3008 any aliases and compared to current major mode. If they are the
3009 same, do nothing and return nil."
3015 mode)))
3018 "Regexp of lines to skip when looking for file-local settings.
3019 If the first line matches this regular expression, then the -*-...-*- file-
3023 "Find the -*- spec in the buffer.
3024 Call with point at the place to start searching from.
3025 If one is found, set point to the beginning and return the position
3026 of the end. Otherwise, return nil; may change point.
3027 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
3028 be ignored; but `enable-local-variables' and `local-enable-local-variables'
3029 have no effect."
3032 ;; Don't look for -*- if this file name matches any
3033 ;; of the regexps in inhibit-local-variables-regexps.
3036 ;; If the file begins with "#!" (exec
3037 ;; interpreter magic), look for mode frobs
3038 ;; in the first two lines. You cannot
3039 ;; necessarily put them in the first line
3040 ;; of such a file without screwing up the
3041 ;; interpreter invocation. The same holds
3042 ;; for '\" in man pages (preprocessor
3043 ;; magic for the `man' program).
3054 end))))
3055 \f
3056 ;;; Handling file local variables
3060 file-local-variables-alist dir-local-variables-alist)
3065 "Normal hook run after processing a file's local variables specs.
3066 Major modes can use this to examine user-specified local variables
3070 "List variable-value pairs that are considered safe.
3071 Each element is a cons cell (VAR . VAL), where VAR is a variable
3072 symbol and VAL is a value that is considered safe."
3073 :risky t
3078 ;; This should be here at least as long as Emacs supports write-file-hooks.
3083 "Expressions that are considered safe in an `eval:' local variable.
3084 Add expressions to this list if you want Emacs to evaluate them, when
3085 they appear in an `eval' local variable specification, without first
3086 asking you for confirmation."
3087 :risky t
3092 ;; Risky local variables:
3095 buffer-auto-save-file-name
3096 buffer-file-name
3097 buffer-file-truename
3098 buffer-undo-list
3099 debugger
3100 default-text-properties
3101 eval
3102 exec-directory
3103 exec-path
3104 file-name-handler-alist
3105 frame-title-format
3106 global-mode-string
3107 header-line-format
3108 icon-title-format
3109 inhibit-quit
3110 load-path
3111 max-lisp-eval-depth
3112 max-specpdl-size
3113 minor-mode-map-alist
3114 minor-mode-overriding-map-alist
3115 mode-line-format
3116 mode-name
3117 overriding-local-map
3118 overriding-terminal-local-map
3119 process-environment
3120 standard-input
3121 standard-output
3122 unread-command-events))
3124 ;; Safe local variables:
3125 ;;
3126 ;; For variables defined by major modes, the safety declarations can go into
3127 ;; the major mode's file, since that will be loaded before file variables are
3128 ;; processed.
3129 ;;
3130 ;; For variables defined by minor modes, put the safety declarations in the
3131 ;; file defining the minor mode after the defcustom/defvar using an autoload
3132 ;; cookie, e.g.:
3133 ;;
3134 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3135 ;;
3136 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3137 ;; minor mode file may not be loaded yet.
3138 ;;
3139 ;; For variables defined in the C source code the declaration should go here:
3161 "Alist of file-local variable settings in the current buffer.
3162 Each element in this list has the form (VAR . VALUE), where VAR
3163 is a file-local variable (a symbol) and VALUE is the value
3164 specified. The actual value in the buffer may differ from VALUE,
3170 "Alist of directory-local variable settings in the current buffer.
3171 Each element in this list has the form (VAR . VALUE), where VAR
3172 is a directory-local variable (a symbol) and VALUE is the value
3173 specified in .dir-locals.el. The actual value in the buffer
3174 may differ from VALUE, if it is changed by the major or minor modes,
3179 "Normal hook run before setting file-local variables.
3180 It is called after checking for unsafe/risky variables and
3181 setting `file-local-variables-alist', and before applying the
3182 variables stored in `file-local-variables-alist'. A hook
3183 function is allowed to change the contents of this alist.
3185 This hook is called only if there is at least one file-local
3189 "Get confirmation before setting up local variable values.
3190 ALL-VARS is the list of all variables to be set up.
3191 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3192 RISKY-VARS is the list of those that are marked as risky.
3193 If these settings come from directory-local variables, then
3194 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3201 unsafe-vars))
3203 ;; Set up the contents of the *Local Variables* buffer.
3211 ", and variables that are risky (**)."
3219 y -- to apply the local variables list.
3223 ! -- to apply the local variables list, and permanently mark these
3235 ;; Make strings with embedded whitespace easier to read.
3243 ;; Display the buffer and read a choice.
3251 ""
3254 char)
3273 "Return local variables specified in the -*- line.
3274 Usually returns an alist of elements (VAR . VAL), where VAR is a
3275 variable and VAL is the specified value. Ignores any
3276 specification for `coding:', and sometimes for `mode' (which
3277 should have already been handled by `set-auto-coding' and
3278 `set-auto-mode', respectively). Return nil if the -*- line is
3279 malformed.
3281 If HANDLE-MODE is nil, we return the alist of all the local
3282 variables in the line except `coding' as described above. If it
3283 is neither nil nor t, we do the same, except that any settings of
3284 `mode' and `coding' are ignored. If HANDLE-MODE is t, we ignore
3285 all settings in the line except for `mode', which \(if present) we
3286 return as the symbol specifying the mode."
3291 result)
3293 nil)
3295 ;; Simple form: "-*- MODENAME -*-".
3299 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3300 ;; (last ";" is optional).
3301 ;; If HANDLE-MODE is t, just check for `mode'.
3302 ;; Otherwise, parse the -*- line into the RESULT alist.
3310 ;; There used to be a downcase here,
3311 ;; but the manual didn't say so,
3312 ;; and people want to set var names that aren't all lc.
3318 ;; It is traditional to ignore
3319 ;; case when checking for `mode' in set-auto-mode,
3320 ;; so we must do that here as well.
3321 ;; That is inconsistent, but we're stuck with it.
3322 ;; The same can be said for `coding' in set-auto-coding.
3336 ;; Downcase "Mode:".
3339 val)
3340 result)
3343 result))))))
3346 "Filter local variable settings, querying the user if necessary.
3347 VARIABLES is the alist of variable-value settings. This alist is
3348 filtered based on the values of `ignored-local-variables',
3349 `enable-local-eval', `enable-local-variables', and (if necessary)
3350 user interaction. The results are added to
3351 `file-local-variables-alist', without applying them.
3352 If these settings come from directory-local variables, then
3353 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3354 ;; Find those variables that we may want to save to
3355 ;; `safe-local-variable-values'.
3361 ;; Ignore any variable in `ignored-local-variables'.
3362 nil)
3363 ;; Obey `enable-local-eval'.
3367 ;; In case previously marked safe (bug#5636).
3369 ;; If not safe and e-l-v = :safe, ignore totally.
3373 safe
3375 ;; Ignore duplicates (except `mode') in the present list.
3377 ;; Accept known-safe variables.
3381 ;; The variable is either risky or unsafe:
3388 ;; Query, unless all vars are safe or user wants no querying.
3394 risky-vars dir-name))
3404 ;; TODO? Warn once per file rather than once per session?
3408 "Parse and put into effect this buffer's local variables spec.
3409 Uses `hack-local-variables-apply' to apply the variables.
3411 If HANDLE-MODE is nil, we apply all the specified local
3412 variables. If HANDLE-MODE is neither nil nor t, we do the same,
3413 except that any settings of `mode' are ignored.
3416 is specified, and return the corresponding mode symbol, or nil.
3417 In this case, we try to ignore minor-modes, and only return a
3418 major-mode.
3420 If `enable-local-variables' or `local-enable-local-variables' is nil,
3421 this function does nothing. If `inhibit-local-variables-regexps'
3422 applies to the file in question, the file is not scanned for
3423 local variables, but directory-local variables may still be applied."
3424 ;; We don't let inhibit-local-variables-p influence the value of
3425 ;; enable-local-variables, because then it would affect dir-local
3426 ;; variables. We don't want to search eg tar files for file local
3427 ;; variable sections, but there is no reason dir-locals cannot apply
3428 ;; to them. The real meaning of inhibit-local-variables-p is "do
3429 ;; not scan this file for local variables".
3432 result)
3436 ;; Note this is a no-op if enable-local-variables is nil.
3438 ;; This entire function is basically a no-op if enable-local-variables
3439 ;; is nil. All it does is set file-local-variables-alist to nil.
3441 ;; This part used to ignore enable-local-variables when handle-mode
3442 ;; was t. That was inappropriate, eg consider the
3443 ;; (artificial) example of:
3444 ;; (setq local-enable-local-variables nil)
3445 ;; Open a file foo.txt that contains "mode: sh".
3446 ;; It correctly opens in text-mode.
3447 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3449 ;; If HANDLE-MODE is t, and the prop line specifies a
3450 ;; mode, then we're done, and have no need to scan further.
3452 handle-mode))
3454 ;; Look for "Local variables:" line in last page.
3462 ;; suffix is what comes after "local variables:" in its line.
3463 ;; prefix is what comes before "local variables:" in its line.
3476 endpos
3482 nil t))
3483 ;; This used to be an error, but really all it means is
3484 ;; that this may simply not be a local-variables section,
3485 ;; so just ignore it.
3495 ;; Discard the prefix.
3500 ;; Discard the suffix.
3509 ;; Find the variable name;
3517 val val2)
3520 ;; Read the variable value.
3527 ;; Specifying minor-modes via mode: is
3528 ;; deprecated, but try to reject them anyway.
3538 'files
3540 "%s: `lexical-binding' at end of file unreliable"
3542 ;; We are called from
3543 ;; 'with-temp-buffer', so we need
3544 ;; to use 'thisbuf's name in the
3545 ;; warning message.
3551 'eval
3555 ;; Now we've read all the local variables.
3556 ;; If HANDLE-MODE is t, return whether the mode was specified.
3558 ;; Otherwise, set the variables.
3563 "Apply the elements of `file-local-variables-alist'.
3564 If there are any elements, runs `before-hack-local-variables-hook',
3565 then calls `hack-one-local-variable' to apply the alist elements one by one.
3566 Finishes by running `hack-local-variables-hook', regardless of whether
3567 the alist is empty or not.
3569 Note that this function ignores a `mode' entry if it specifies the same
3570 major mode as the buffer already has."
3572 ;; Any 'evals must run in the Right sequence.
3581 "Non-nil if SYM is safe as a file-local variable with value VAL.
3582 It is safe if any of these conditions are met:
3584 * There is a matching entry (SYM . VAL) in the
3585 `safe-local-variable-values' user option.
3587 * The `safe-local-variable' property of SYM is a function that
3588 evaluates to a non-nil value with VAL as an argument."
3592 ;; If the function signals an error, that means it
3593 ;; can't assure us that the value is safe.
3597 "Non-nil if SYM could be dangerous as a file-local variable.
3598 It is dangerous if either of these conditions are met:
3600 * Its `risky-local-variable' property is non-nil.
3606 ;; If this is an alias, check the base name.
3626 "Return t if it is safe to eval EXP when it is found in a file."
3628 ;; Detect certain `put' expressions.
3635 lisp-indent-function
3636 scheme-indent-function))
3637 ;; Only allow safe values (not functions).
3642 ;; Only allow indirect form specs.
3643 ;; During bootstrapping, edebug-basic-spec might not be
3644 ;; defined yet.
3648 ;; Allow expressions that the user requested.
3650 ;; Certain functions can be allowed with safe arguments
3651 ;; or can specify verification functions to try.
3653 ;; Allow (minor)-modes calls with no arguments.
3654 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3663 ok))
3671 ok))))))))
3685 "Set local variable VAR with value VAL.
3686 If VAR is `mode', call `VAL-mode' as a function unless it's
3687 already the major mode."
3689 (`mode
3695 (`eval
3701 ;; Make sure the string has no text properties.
3702 ;; Some text properties can get evaluated in various ways,
3703 ;; so it is risky to put them on with a local variable list.
3707 \f
3708 ;;; Handling directory-local variables, aka project settings.
3714 "List of cached directory roots for directory-local variable classes.
3715 Each element in this list has the form (DIR CLASS MTIME).
3716 DIR is the name of the directory.
3717 CLASS is the name of a variable class (a symbol).
3718 MTIME is the recorded modification time of the directory-local
3719 variables file associated with this entry. This time is a list
3720 of integers (the same format as `file-attributes'), and is
3721 used to test whether the cache entry is still valid.
3722 Alternatively, MTIME can be nil, which means the entry is always
3726 "Return the variable list for CLASS."
3730 "Collect directory-local variables from MODE-VARIABLES.
3731 VARIABLES is the initial list of variables.
3732 Returns the new list."
3737 ;; If variables are specified more than once, only use the last. (Why?)
3738 ;; The pseudo-variables mode and eval are different (bug#3430).
3741 ;; Need a new cons in case we setcdr later.
3745 "Collect entries from CLASS-VARIABLES into VARIABLES.
3746 ROOT is the root directory of the project.
3747 Return the new variables list."
3749 ;; Handle non-file buffers, too.
3753 ;; FIXME: Why not use file-relative-name?
3760 ;; Don't include this in the previous condition, because we
3761 ;; want to filter all strings before the next condition.
3775 ;; TODO someone might want to extend this to allow
3776 ;; integer values for subdir, where N means
3777 ;; variables apply to this directory and N levels
3778 ;; below it (0 == nil).
3781 alist variables))))))))
3783 ;; The file's content might be invalid (e.g. have a merge conflict), but
3784 ;; that shouldn't prevent the user from opening the file.
3786 nil))))
3789 "Declare that the DIRECTORY root is an instance of CLASS.
3790 DIRECTORY is the name of a directory, a string.
3791 CLASS is the name of a project class, a symbol.
3792 MTIME is either the modification time of the directory-local
3793 variables file that defined this class, or nil.
3795 When a file beneath DIRECTORY is visited, the mode-specific
3796 variables from CLASS are applied to the buffer. The variables
3797 for a class are defined using `dir-locals-set-class-variables'."
3804 "Map the type CLASS to a list of variable settings.
3805 CLASS is the project class, a symbol. VARIABLES is a list
3806 that declares directory-local variables for the class.
3807 An element in VARIABLES is either of the form:
3808 (MAJOR-MODE . ALIST)
3809 or
3810 (DIRECTORY . LIST)
3812 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3813 whose elements are of the form (VARIABLE . VALUE).
3815 In the second form, DIRECTORY is a directory name (a string), and
3816 LIST is a list of the form accepted by the function.
3818 When a file is visited, the file's class is found. A directory
3819 may be assigned a class using `dir-locals-set-directory-class'.
3820 Then variables are set in the file's buffer according to the
3821 VARIABLES list of the class. The list is processed in order.
3823 * If the element is of the form (MAJOR-MODE . ALIST), and the
3824 buffer's major mode is derived from MAJOR-MODE (as determined
3825 by `derived-mode-p'), then all the variables in ALIST are
3826 applied. A MAJOR-MODE of nil may be used to match any buffer.
3827 `make-local-variable' is called for each variable before it is
3828 set.
3830 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3831 is an initial substring of the file's directory, then LIST is
3832 applied by recursively following these rules."
3836 "File that contains directory-local variables.
3837 It has to be constant to enforce uniform values across different
3838 environments and users.
3839 See also `dir-locals-file-2', whose values override this one's.
3843 "File that contains directory-local variables.
3844 This essentially a second file that can be used like
3845 `dir-locals-file', so that users can have specify their personal
3846 dir-local variables even if the current directory already has a
3847 `dir-locals-file' that is shared with other users (such as in a
3848 git repository).
3852 "Return a list of all readable dir-locals files in DIRECTORY.
3853 The returned list is sorted by increasing priority. That is,
3854 values specified in the last file should take precedence over
3855 those in the first."
3859 dir-locals-file)
3860 directory))
3864 ;; The order here is important.
3871 out)))
3874 "Find the directory-local variables for FILE.
3875 This searches upward in the directory tree from FILE.
3876 It stops at the first directory that has been registered in
3877 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3878 If it finds an entry in the cache, it checks that it is valid.
3879 A cache entry with no modification time element (normally, one that
3880 has been assigned directly using `dir-locals-set-directory-class', not
3881 set from a file) is always valid.
3882 A cache entry based on a `dir-locals-file' is valid if the modification
3883 time stored in the cache matches the current file modification time.
3884 If not, the cache entry is cleared so that the file will be re-read.
3886 This function returns either:
3887 - nil (no directory local variables found),
3888 - the matching entry from `dir-locals-directory-cache' (a list),
3889 - or the full path to the directory (a string) containing at
3890 least one `dir-locals-file' in the case of no valid cache
3891 entry."
3895 dir-elt)
3896 ;; `locate-dominating-file' may have abbreviated the name.
3899 ;; Find the best cached value in `dir-locals-directory-cache'.
3910 ;; Found a potential cache entry. Check validity.
3911 ;; A cache entry with no MTIME is assumed to always be valid
3912 ;; (ie, set directly, not from a dir-locals file).
3913 ;; Note, we don't bother to check that there is a matching class
3914 ;; element in dir-locals-class-alist, since that's done by
3915 ;; dir-locals-set-directory-class.
3918 ;; The entry MTIME should match the most recent
3919 ;; MTIME among matching files.
3925 cached-files))))))
3926 ;; This cache entry is OK.
3927 dir-elt
3928 ;; This cache entry is invalid; clear it.
3931 ;; Return the first existing dir-locals file. Might be the same
3932 ;; as dir-elt's, might not (eg latter might have been deleted).
3933 locals-dir)
3934 ;; No cache entry.
3935 locals-dir)))
3938 "Load all variables files in DIR and register a new class and instance.
3939 DIR is the absolute name of a directory which must contain at
3940 least one dir-local file (which is a file holding variables to
3941 apply).
3942 Return the new class name, which is a symbol named DIR."
3956 variables
3962 dir class-name
3967 files))
3968 ;; If there was a problem, use the values we could get but
3969 ;; don't let the cache prevent future reads.
3971 class-name))
3977 "Non-nil means dir-local variables will be applied to remote files."
3985 "Read per-directory local variables for the current buffer.
3986 Store the directory-local variables in `dir-local-variables-alist'
3987 and `file-local-variables-alist', without applying them.
3989 This does nothing if either `enable-local-variables' or
3990 `enable-dir-local-variables' are nil."
3992 enable-dir-local-variables
3995 default-directory)))))
3996 ;; Find the variables file.
4026 "Apply directory-local variables to a non-file buffer.
4027 For non-file buffers, such as Dired buffers, directory-local
4028 variables are looked for in `default-directory' and its parent
4029 directories."
4033 \f
4036 However, the mode will not be changed if
4037 \(1) a local variables list or the `-*-' line specifies a major mode, or
4039 not suitable for ordinary files, or
4040 \(3) the new file name does not particularly specify any mode."
4045 "Change name of file visited in current buffer to FILENAME.
4046 This also renames the buffer to correspond to the new file.
4047 The next time the buffer is saved it will go in the newly specified file.
4048 FILENAME nil or an empty string means mark buffer as not visiting any file.
4049 Remember to delete the initial contents of the minibuffer
4050 if you wish to pass an empty string as the argument.
4052 The optional second argument NO-QUERY, if non-nil, inhibits asking for
4053 confirmation in the case where another buffer is already visiting FILENAME.
4055 The optional third argument ALONG-WITH-FILE, if non-nil, means that
4056 the old visited file has been renamed to the new name FILENAME."
4064 nil
4079 filename)))
4086 buffer-file-name filename)
4090 ;; If new-name == old-name, renaming would add a spurious <2>
4091 ;; and it's considered as a feature in rename-buffer.
4097 ;; Abbreviate the file names of the buffer.
4106 nil))
4107 ;; write-file-functions is normally used for things like ftp-find-file
4108 ;; that visit things that are not local files as if they were files.
4109 ;; Changing to visit an ordinary local file instead should flush the hook.
4114 ;; If buffer was read-only because of version control,
4115 ;; that reason is gone now, so make it writable.
4119 ;; Turn off backup files for certain file names.
4120 ;; Since this is a permanent local, the major mode won't eliminate it.
4122 backup-enable-predicate
4131 ;; If auto-save was not already on, turn it on if appropriate.
4134 ;; If auto save is on, start using a new name. We
4135 ;; deliberately don't rename or delete the old auto save
4136 ;; for the old visited file name. This is because
4137 ;; perhaps the user wants to save the new state and then
4138 ;; compare with the previous state from the auto save
4139 ;; file.
4141 ;; Rename the old auto save file if any.
4148 ;; Update the major mode, if the file name determines it.
4150 ;; Don't change the mode if it is special.
4153 ;; Don't change the mode if the local variable list specifies it.
4154 ;; The file name can influence whether the local variables apply.
4156 ;; h-l-v also checks it, but might as well be explicit.
4159 ;; TODO consider making normal-mode handle this case.
4167 "Write current buffer into file FILENAME.
4168 This makes the buffer visit that file, and marks it as not modified.
4170 If you specify just a directory name as FILENAME, that means to use
4171 the default file name but in that directory. You can also yank
4172 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4174 If the buffer is not already visiting a file, the default file name
4175 for the output file is the buffer name.
4177 If optional second arg CONFIRM is non-nil, this function
4178 asks for confirmation before overwriting an existing file.
4179 Interactively, confirmation is required unless you supply a prefix argument."
4180 ;; (interactive "FWrite file: ")
4184 nil nil nil nil)
4188 default-directory)
4189 nil nil))
4193 ;; If arg is just a directory,
4194 ;; use the default file name, but in that directory.
4201 ;; NS does its own confirm dialog.
4204 use-dialog-box))
4210 ;; Make buffer writable if file is writable.
4215 ;; It's likely that the VC status at the new location is different from
4216 ;; the one at the old location.
4218 \f
4220 "Return an alist of extended attributes of file FILENAME.
4222 Extended attributes are platform-specific metadata about the file,
4223 such as SELinux context, list of ACL entries, etc."
4228 "Set extended attributes of file FILENAME to ATTRIBUTES.
4230 ATTRIBUTES must be an alist of file attributes as returned by
4231 `file-extended-attributes'.
4232 Value is t if the function succeeds in setting the attributes."
4243 result))
4244 \f
4246 "Make a backup of the disk file visited by the current buffer, if appropriate.
4247 This is normally done before saving the buffer the first time.
4249 A backup may be done by renaming or by copying; see documentation of
4250 variable `make-backup-files'. If it's done by renaming, then the file is
4251 no longer accessible under its old name.
4253 The value is non-nil after a backup was made by renaming.
4254 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4255 MODES is the result of `file-modes' on the original
4256 file; this means that the caller, after saving the buffer, should change
4257 the modes of the new file to agree with the old modes.
4258 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4259 on the original file; this means that the caller, after saving
4260 the buffer, should change the extended attributes of the new file
4261 to agree with the old attributes.
4262 BACKUPNAME is the backup file name, which is the old file renamed."
4266 ;; If specified name is a symbolic link, chase it to the target.
4267 ;; This makes backups in the directory where the real file is.
4274 ;; If have old versions to maybe delete,
4275 ;; ask the user to confirm now, before doing anything.
4276 ;; But don't actually delete til later.
4282 real-file-name)))
4283 targets))
4288 backup-by-copying-when-privileged-mismatch)
4291 ;; Don't rename a suid or sgid file.
4300 real-file-name
4303 copy-when-priv-mismatch))))
4305 t)))))
4306 setmodes)
4309 ;; Actually make the backup file.
4312 modes extended-attributes)
4313 ;; rename-file should delete old backup.
4316 backupname)))
4318 ;; Now delete the old versions, if desired.
4322 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4326 backupname)
4329 modes extended-attributes)
4331 setmodes)))))))
4334 ;; Create temp files with strict access rights. It's easy to
4335 ;; loosen them later, whereas it's impossible to close the
4336 ;; time-window of loose permissions otherwise.
4339 ;; Try to overwrite old backup first.
4347 nil)
4349 ;; The file was somehow created by someone else between
4350 ;; `delete-file' and `copy-file', so let's try again.
4351 ;; rms says "I think there is also a possible race
4352 ;; condition for making backup files" (emacs-devel 20070821).
4353 nil)))
4354 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4363 ;; The last ~[[:digit]]+ matches relative versions in git,
4364 ;; e.g. `foo.js.~HEAD~1~'.
4365 "Regular expression matching the backup/version part of a file name.
4369 "Return file NAME sans backup versions or strings.
4370 This is a separate procedure so your site-init or startup file can
4371 redefine it.
4372 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4373 we do not remove backup version numbers, only true file version numbers.
4374 See also `file-name-version-regexp'."
4381 name))))))
4384 "Return t if deleting FILE and rewriting it would preserve the owner.
4385 Return also t if FILE does not exist. If GROUP is non-nil, check whether
4386 the group would be preserved too."
4391 ;; Return t if the file doesn't exist, since it's true that no
4392 ;; information would be lost by an (attempted) delete and create.
4395 ;; Files created on Windows by Administrator (RID=500)
4396 ;; have the Administrators group (RID=544) recorded as
4397 ;; their owner. Rewriting them will still preserve the
4398 ;; owner.
4402 ;; On BSD-derived systems files always inherit the parent
4403 ;; directory's group, so skip the group-gid test.
4409 ;; On some systems, a file created in a setuid directory
4410 ;; inherits that directory's owner.
4414 ;; On many systems, a file created in a setgid directory
4415 ;; inherits that directory's group. On some systems
4416 ;; this happens even if the setgid bit is not set.
4423 The extension, in a file name, is the part that begins with the last `.',
4424 except that a leading `.' of the file name, if there is one, doesn't count."
4427 directory)
4431 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4432 ;; we don't want to expand it.
4435 filename))))
4439 The extension, in a file name, is the part that begins with the last `.',
4440 excluding version numbers and backup suffixes, except that a leading `.'
4441 of the file name, if there is one, doesn't count.
4442 Return nil for extensionless file names such as `foo'.
4443 Return the empty string for file names such as `foo.'.
4445 By default, the returned value excludes the period that starts the
4446 extension, but if the optional argument PERIOD is non-nil, the period
4447 is included in the value, and in that case, if FILENAME has no
4458 "Return the base name of the FILENAME: no directory, no extension.
4459 FILENAME defaults to `buffer-file-name'."
4464 #'make-backup-file-name--default-function
4465 "A function that `make-backup-file-name' uses to create backup file names.
4466 The function receives a single argument, the original file name.
4468 If you change this, you may need to change `backup-file-name-p' and
4469 `file-name-sans-versions' too.
4471 You could make this buffer-local to do something special for specific files.
4473 For historical reasons, a value of nil means to use the default function.
4474 This should not be relied upon.
4476 See also `backup-directory-alist'."
4483 "Alist of filename patterns and backup directory names.
4484 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4485 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4486 relative or absolute. If it is absolute, so that all matching files
4487 are backed up into the same directory, the file names in this
4488 directory will be the full name of the file backed up with all
4489 directory separators changed to `!' to prevent clashes. This will not
4490 work correctly if your filesystem truncates the resulting name.
4492 For the common case of all backups going into one directory, the alist
4494 directory name.
4496 If this variable is nil, or it fails to match a filename, the backup
4497 is made in the original file's directory.
4499 On MS-DOS filesystems without long names this variable is always
4500 ignored."
4506 "Default `backup-enable-predicate' function.
4507 Checks for files in `temporary-file-directory',
4510 caseless)
4511 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4512 ;; their long file-name equivalents, so compare-strings does TRT.
4516 caseless t))
4519 ;; Directory is under temporary-file-directory.
4524 ;; Directory is under /tmp.
4529 0 nil
4531 ;; Directory is under small-temporary-file-directory.
4536 "Create the non-numeric backup file name for FILE.
4537 This calls the function that `make-backup-file-name-function' specifies,
4538 with a single argument FILE."
4541 file))
4544 "Default function for `make-backup-file-name'.
4545 Normally this just returns FILE's name with `~' appended.
4546 It searches for a match for FILE in `backup-directory-alist'.
4547 If the directory for the backup doesn't exist, it is created."
4559 "Subroutine of `make-backup-file-name--default-function'.
4560 The function `find-backup-file-name' also uses this."
4562 elt backup-directory abs-backup-directory)
4567 alist nil)))
4568 ;; If backup-directory is relative, it should be relative to the
4569 ;; file's directory. By expanding explicitly here, we avoid
4570 ;; depending on default-directory.
4579 abs-backup-directory nil))))
4581 file
4585 ;; Normalize DOSish file names: downcase the drive
4586 ;; letter, if any, and replace the leading "x:" with
4587 ;; "/drive_x".
4590 ;; Replace any invalid file-name characters (for the
4591 ;; case of backing up remote files).
4595 "drive_"
4598 ""
4601 ;; Make the name unique by substituting directory
4602 ;; separators. It may not really be worth bothering about
4603 ;; doubling `!'s in the original name...
4608 backup-directory))
4613 "Return non-nil if FILE is a backup file name (numeric or not).
4614 This is a separate function so you can redefine it for customization.
4615 You may need to redefine `file-name-sans-versions' as well."
4620 ;; This is used in various files.
4621 ;; The usage of backup-extract-version-start is not very clean,
4622 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4624 "Given the name of a numeric backup file, FN, return the backup number.
4625 Uses the free variable `backup-extract-version-start', whose value should be
4626 the index in the name where the version number begins."
4633 "Find a file name for a backup file FN, and suggestions for deletions.
4634 Value is a list whose car is the name for the backup file
4635 and whose cdr is a list of old versions to consider deleting now.
4636 If the value is nil, don't make a backup.
4637 Uses `backup-directory-alist' in the same way as
4638 `make-backup-file-name--default-function' does."
4640 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4644 ;; We don't support numbered backups on plain MS-DOS
4645 ;; when long file names are unavailable.
4655 possibilities deserve-versions-p versions)
4658 base-versions
4661 possibilities)
4662 #'<)
4667 kept-old-versions
4668 kept-new-versions
4675 ;; Delete nothing if there is overflow
4676 ;; in the number of versions to keep.
4682 v))))))))))
4685 "Return number of names file FILENAME has."
4689 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4690 This function returns a relative file name which is equivalent to FILENAME
4691 when used with that default directory as the default.
4692 If FILENAME is a relative file name, it will be interpreted as existing in
4693 `default-directory'.
4694 If FILENAME and DIRECTORY lie on different machines or on different drives
4695 on a DOS/Windows machine, it returns FILENAME in expanded form."
4699 default-directory))))
4704 read-file-name-completion-ignore-case)))
4707 ;; Test for different filesystems on DOS/Windows
4709 ;; Should `cygwin' really be included here? --stef
4712 ;; Test for different drive letters
4714 ;; Test for UNCs on different servers
4719 ;; Windows file names cannot have ? in
4720 ;; them, so use that to detect when
4721 ;; neither FILENAME nor DIRECTORY is a
4722 ;; UNC.
4724 0 nil
4730 ;; Test for different remote file system identification
4732 filename
4740 ".."
4742 ;; Now ancestor is empty, or .., or ../.., etc.
4744 ;; We matched within FILENAME's directory part.
4745 ;; Add the rest of FILENAME onto ANCESTOR.
4748 ;; But don't bother with ANCESTOR if it would give us `./'.
4749 rest
4751 ;; We matched FILENAME's directory equivalent.
4752 ancestor))))))
4753 \f
4755 "Save current buffer in visited file if modified.
4756 Variations are described below.
4758 By default, makes the previous version into a backup file
4759 if previously requested or if this is the first save.
4761 to become a backup when the next save is done.
4763 makes the previous version into a backup file.
4765 to become a backup when the next save is done,
4766 and makes the previous version into a backup file.
4768 With a numeric prefix argument of 0, never make the previous version
4769 into a backup file.
4771 Note that the various variables that control backups, such
4772 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4773 and `backup-inhibited', to name just the more popular ones, still
4774 control whether a backup will actually be produced, even when you
4777 If a file's name is FOO, the names of its numbered backup versions are
4778 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4779 Numeric backups (rather than FOO~) will be made if value of
4780 `version-control' is not the atom `never' and either there are already
4781 numeric versions of the file being backed up, or `version-control' is
4782 non-nil.
4783 We don't want excessive versions piling up, so there are variables
4784 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4785 and `kept-new-versions', which tells how many newest versions to keep.
4786 Defaults are 2 old versions and 2 new.
4787 `dired-kept-versions' controls dired's clean-directory (.) command.
4788 If `delete-old-versions' is nil, system will query user
4789 before trimming versions. Otherwise it does it silently.
4791 If `vc-make-backup-files' is nil, which is the default,
4792 no backup files are made for files managed by version control.
4793 (This is because the version control system itself records previous versions.)
4795 See the subroutine `basic-save-buffer' for more information."
4801 ;; We used to display the message below only for files > 50KB, but
4802 ;; then Rmail-mbox never displays it due to buffer swapping. If
4803 ;; the test is ever re-introduced, be sure to handle saving of
4804 ;; Rmail files.
4814 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4815 Normally delete only if the file was written by this Emacs since
4816 the last real save, but optional arg FORCE non-nil means delete anyway."
4830 "Normal hook that is run before a buffer is saved to its file.
4831 Only used by `save-buffer'."
4837 "Normal hook that is run after a buffer is saved to its file.
4838 Only used by `save-buffer'."
4844 "If non-nil, use this coding system for saving the buffer.
4845 More precisely, use this coding system in place of the
4846 value of `buffer-file-coding-system', when saving the buffer.
4847 Calling `write-region' for any purpose other than saving the buffer
4848 will still use `buffer-file-coding-system'; this variable has no effect
4855 "Save the current buffer in its visited file, if it has been modified.
4856 The hooks `write-contents-functions' and `write-file-functions' get a chance
4857 to do the job of saving; if they do not, then the buffer is saved in
4858 the visited file in the usual way.
4859 Before and after saving the buffer, this function runs
4860 `before-save-hook' and `after-save-hook', respectively."
4863 ;; In an indirect buffer, save its base buffer instead.
4867 ;; handle the case when no modification has been made but
4868 ;; the file disappeared since visited
4872 setmodes)
4873 ;; If buffer has no file name, ask user for one.
4881 ;; Signal an error if the user specified the name of an
4882 ;; existing directory.
4885 "File `%s' exists; overwrite? "
4886 filename))
4893 "%s has changed since visited or saved. Save anyway? "
4913 ;; Support VC version backups.
4915 ;; Don't let errors prevent saving the buffer.
4920 ;; If a hook returned t, file is already "written".
4921 ;; Otherwise, write it the usual way now.
4931 ;; Now we have saved the current buffer. Let's make sure
4932 ;; that buffer-file-coding-system is fixed to what
4933 ;; actually used for saving by binding it locally.
4948 ;; If the auto-save file was recent before this command,
4949 ;; delete it now.
4951 ;; Support VC `implicit' locking.
4958 ;; This does the "real job" of writing a buffer into its visited file
4959 ;; and making a backup file. This is what is normally done
4960 ;; but inhibited if one of write-file-functions returns non-nil.
4961 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4962 ;; backup-buffer.
4972 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4973 ;; backup-buffer.
4986 "File %s is write-protected; try to save anyway? "
4988 buffer-file-name)))
5002 dir))))
5003 ;; Write temp name, then rename it.
5004 ;; This requires write access to the containing dir,
5005 ;; which is why we don't try it if we don't have that access.
5007 tempname
5009 ;; Create temp files with strict access rights. It's easy to
5010 ;; loosen them later, whereas it's impossible to close the
5011 ;; time-window of loose permissions otherwise.
5015 ;; Call write-region in the appropriate way
5016 ;; for saving the buffer.
5020 ;; Pass in nil&nil rather than point-min&max
5021 ;; cause we're saving the whole buffer.
5022 ;; write-region-annotate-functions may use it.
5024 buffer-file-truename)
5026 ;; If we failed, restore the buffer's modtime.
5029 ;; Since we have created an entirely new file,
5030 ;; make sure it gets the right permission bits set.
5035 buffer-file-name)))
5036 ;; We succeeded in writing the temp file,
5037 ;; so rename it.
5039 ;; If file not writable, see if we can make it writable
5040 ;; temporarily while we write it.
5041 ;; But no need to do so if we have just backed it up
5042 ;; (setmodes is set) because that says we're superseding.
5044 ;; Change the mode back, after writing.
5047 buffer-file-name))
5048 ;; If set-file-extended-attributes fails, fall back on
5049 ;; set-file-modes.
5059 ;; Pass in nil&nil rather than point-min&max to indicate
5060 ;; we're saving the buffer rather than just a region.
5061 ;; write-region-annotate-functions may make us of it.
5063 buffer-file-name nil t buffer-file-truename)
5066 ;; If we get an error writing the new file, and we made
5067 ;; the backup by renaming, undo the backing-up.
5072 setmodes))
5078 `((?\C-r
5085 ;; Return nil to ask about BUF again.
5086 nil)
5099 ;; Return nil to ask about BUF again.
5100 nil)
5110 "Default predicate for `save-some-buffers'.
5111 This allows you to stop `save-some-buffers' from asking
5112 about certain files that you'd usually rather not save."
5118 "Save some modified file-visiting buffers. Asks user about each one.
5119 You can answer `y' to save, `n' not to save, `C-r' to look at the
5120 buffer in question with `view-buffer' before deciding or `d' to
5121 view the differences using `diff-buffer-with-file'.
5123 This command first saves any buffers where `buffer-save-without-query' is
5124 non-nil, without asking.
5126 Optional argument (the prefix) non-nil means save all with no questions.
5127 Optional second argument PRED determines which buffers are considered:
5128 If PRED is nil, all the file-visiting buffers are considered.
5129 If PRED is t, then certain non-file buffers will also be considered.
5130 If PRED is a zero-argument function, it indicates for each buffer whether
5131 to consider it or not when called with that buffer current.
5132 PRED defaults to the value of `save-some-buffers-default-predicate'.
5134 See `save-some-buffers-action-alist' if you want to
5135 change the additional actions you can take on files."
5141 files-done abbrevs-done)
5143 ;; First save any buffers that we're supposed to save unconditionally.
5144 ;; That way the following code won't ask about them.
5149 ;; Ask about those buffers that merit it,
5150 ;; and record the number thus saved.
5154 ;; Note that killing some buffers may kill others via
5155 ;; hooks (e.g. Rmail and its viewing buffer).
5168 t
5180 save-some-buffers-action-alist))
5181 ;; Maybe to save abbrevs, and record whether
5182 ;; we either saved them or asked to.
5189 ;; Don't keep bothering user if he says no.
5203 \f
5205 "Clear out records of last mod time of visited file.
5206 Next attempt to save will not complain of a discrepancy."
5210 "Mark current buffer as unmodified, not needing to be saved.
5213 It is not a good idea to use this function in Lisp programs, because it
5214 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5222 "Change whether this buffer is read-only."
5230 "Insert contents of file FILENAME into buffer after point.
5231 Set mark after the inserted text.
5233 This function is meant for the user to run interactively.
5234 Don't call it from programs! Use `insert-file-contents' instead.
5235 \(Its calling sequence is different; see its documentation)."
5241 "Append the contents of the region to the end of file FILENAME.
5242 When called from a function, expects three arguments,
5243 START, END and FILENAME. START and END are normally buffer positions
5244 specifying the part of the buffer to write.
5245 If START is nil, that means to use the entire buffer contents.
5246 If START is a string, then output that string to the file
5247 instead of any buffer contents; END is ignored.
5249 This does character code conversion and applies annotations
5250 like `write-region' does."
5256 "Return most recent backup file for FILENAME or nil if no backups exist."
5257 ;; `make-backup-file-name' will get us the right directory for
5258 ;; ordinary or numeric backups. It might create a directory for
5259 ;; backups as a side-effect, according to `backup-directory-alist'.
5266 tem)
5275 newest))
5278 "Rename current buffer to a similar name not already taken.
5279 This function is useful for creating multiple shell process buffers
5280 or multiple mail buffers, etc.
5282 Note that some commands, in particular those based on `compilation-mode'
5283 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5284 appropriate mode even if it has been renamed. So as well as renaming
5285 the buffer, you also need to switch buffers before running another
5286 instance of such commands."
5294 ;; If the existing buffer name has a <NNN>,
5295 ;; which isn't part of the file name (if any),
5296 ;; then get rid of that.
5302 "Create the directory DIR and optionally any nonexistent parent dirs.
5303 If DIR already exists as a directory, signal an error, unless
5304 PARENTS is non-nil.
5306 Interactively, the default choice of directory to create is the
5307 current buffer's default directory. That is useful when you have
5308 visited a file in a nonexistent directory.
5310 Noninteractively, the second (optional) argument PARENTS, if
5311 non-nil, says whether to create parent directories that don't
5312 exist. Interactively, this happens by default.
5314 If creating the directory or directories fail, an error will be
5315 raised."
5318 nil nil)
5319 t))
5320 ;; If default-directory is a remote directory,
5321 ;; make sure we find its make-directory handler.
5329 create-list)
5331 ;; If directory is its own parent, then we can't
5332 ;; keep looping forever
5347 "Use NO-SUCH to affect behavior of function FN applied to list ARGS.
5348 This acts like (apply FN ARGS) except it returns NO-SUCH if it is
5349 non-nil and if FN fails due to a missing file or directory."
5355 "Delete the directory named DIRECTORY. Does not follow symlinks.
5356 If RECURSIVE is non-nil, delete files in DIRECTORY as well, with
5357 no error if something else is simultaneously deleting them.
5358 TRASH non-nil means to trash the directory instead, provided
5359 `delete-by-moving-to-trash' is non-nil.
5361 When called interactively, TRASH is nil if and only if a prefix
5362 argument is given, and a further prompt asks the user for
5363 RECURSIVE if DIRECTORY is nonempty."
5370 "Move directory to trash: "
5372 default-directory default-directory nil nil))))
5378 nil)
5380 ;; If default-directory is a remote directory, make sure we find its
5381 ;; delete-directory handler.
5388 ;; Only move non-empty dir to trash if recursive deletion was
5389 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5390 ;; case, where the operation fails in delete-directory-internal.
5391 ;; As `move-file-to-trash' trashes directories (empty or
5392 ;; otherwise) as a unit, we do not need to recurse here.
5394 ;; Check if directory is empty apart from "." and "..".
5399 ;; Otherwise, call ourselves recursively if needed.
5404 directory-files-no-dot-files-regexp))
5408 ;; This test is equivalent to but more efficient
5409 ;; than (and (file-directory-p fn)
5410 ;; (not (file-symlink-p fn))).
5414 files))
5415 directory-exists))
5419 "Return non-nil if files FILE1 and FILE2 name the same file.
5420 If FILE1 or FILE2 does not exist, the return value is unspecified."
5431 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5433 Return nil if DIR is not an existing directory."
5445 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5460 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5461 This function always sets the file modes of the output files to match
5462 the corresponding input file.
5464 The third arg KEEP-TIME non-nil means give the output files the same
5465 last-modified time as the old ones. (This works on only some systems.)
5467 A prefix arg makes KEEP-TIME non-nil.
5469 Noninteractively, the last argument PARENTS says whether to
5470 create parent directories if they don't exist. Interactively,
5471 this happens by default.
5473 If NEWNAME names an existing directory, copy DIRECTORY as a
5474 subdirectory there. However, if called from Lisp with a non-nil
5475 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5476 directly into NEWNAME instead."
5483 default-directory default-directory nil nil)
5484 current-prefix-arg t nil)))
5487 directory newname))
5488 ;; If default-directory is a remote directory, make sure we find its
5489 ;; copy-directory handler.
5494 newname keep-time parents copy-contents)
5496 ;; Compute target name.
5501 ;; If NEWNAME is not an existing directory, create it;
5502 ;; that is where we will copy the files of DIRECTORY.
5504 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5505 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5510 newname))
5514 newname))
5517 ;; Copy recursively.
5519 ;; We do not want to copy "." and "..".
5521 directory-files-no-dot-files-regexp))
5531 ;; Set directory attributes.
5537 \f
5538 ;; At time of writing, only info uses this.
5540 "Return a copy of DIRS with all non-existent directories removed.
5541 The optional argument KEEP is a list of directories to retain even if
5542 they don't exist, and REJECT is a list of directories to remove from
5543 DIRS, even if they exist; REJECT takes precedence over KEEP.
5545 Note that membership in REJECT and KEEP is checked using simple string
5546 comparison."
5552 dirs)))
5554 \f
5557 "Function to use to revert this buffer.
5558 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5559 which are the arguments that `revert-buffer' received.
5560 It also has access to the `preserve-modes' argument of `revert-buffer'
5561 via the `revert-buffer-preserve-modes' dynamic variable.
5563 For historical reasons, a value of nil means to use the default function.
5568 #'revert-buffer-insert-file-contents--default-function
5569 "Function to use to insert contents when reverting this buffer.
5570 The function receives two arguments: the first the nominal file name to use;
5571 the second is t if reading the auto-save file.
5573 The function is responsible for updating (or preserving) point.
5575 For historical reasons, a value of nil means to use the default function.
5579 "Default function to use for `buffer-stale-function'.
5580 This function ignores its argument.
5581 This returns non-nil if the current buffer is visiting a readable file
5582 whose modification time does not match that of the buffer.
5584 This function only handles buffers that are visiting files.
5585 Non-file buffers need a custom function"
5592 "Function to check whether a buffer needs reverting.
5593 This should be a function with one optional argument NOCONFIRM.
5594 Auto Revert Mode passes t for NOCONFIRM. The function should return
5595 non-nil if the buffer should be reverted. A return value of
5596 `fast' means that the need for reverting was not checked, but
5597 that reverting the buffer is fast. The buffer is current when
5598 this function is called.
5600 The idea behind the NOCONFIRM argument is that it should be
5601 non-nil if the buffer is going to be reverted without asking the
5602 user. In such situations, one has to be careful with potentially
5603 time consuming operations.
5605 For historical reasons, a value of nil means to use the default function.
5606 This should not be relied upon.
5608 For more information on how this variable is used by Auto Revert mode,
5612 "Normal hook for `revert-buffer' to run before reverting.
5613 The function `revert-buffer--default' runs this.
5617 "Normal hook for `revert-buffer' to run after reverting.
5618 Note that the hook value that it runs is the value that was in effect
5619 before reverting; that makes a difference if you have buffer-local
5620 hook functions.
5622 The function `revert-buffer--default' runs this.
5630 ;; `revert-buffer-function' was defined long ago to be a function of only
5631 ;; 2 arguments, so we have to use a dynbind variable to pass the
5632 ;; `preserve-modes' argument of `revert-buffer'.
5636 "Replace current buffer text with the text of the visited file on disk.
5637 This undoes all changes since the file was visited or saved.
5638 With a prefix argument, offer to revert from latest auto-save file, if
5639 that is more recent than the visited file.
5641 This command also implements an interface for special buffers
5642 that contain text which doesn't come from a file, but reflects
5643 some other data instead (e.g. Dired buffers, `buffer-list'
5644 buffers). This is done via the variable `revert-buffer-function'.
5645 In these cases, it should reconstruct the buffer contents from the
5646 appropriate data.
5648 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5649 to revert from the auto-save file when this is nil. Note that the
5650 sense of this argument is the reverse of the prefix argument, for the
5651 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5652 to nil.
5654 Optional second argument NOCONFIRM means don't ask for confirmation
5655 at all. (The variable `revert-without-query' offers another way to
5656 revert buffers without querying for confirmation.)
5658 Optional third argument PRESERVE-MODES non-nil means don't alter
5659 the files modes. Normally we reinitialize them using `normal-mode'.
5661 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5663 This function calls the function that `revert-buffer-function' specifies
5664 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5665 The default function runs the hooks `before-revert-hook' and
5666 `after-revert-hook'."
5667 ;; I admit it's odd to reverse the sense of the prefix argument, but
5668 ;; there is a lot of code out there which assumes that the first
5669 ;; argument should be t to avoid consulting the auto-save file, and
5670 ;; there's no straightforward way to encourage authors to notice a
5671 ;; reversal of the argument sense. So I'm just changing the user
5672 ;; interface, but leaving the programmatic interface the same.
5677 ignore-auto noconfirm)))
5680 "Default function for `revert-buffer'.
5681 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5682 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5683 start and end.
5685 Calls `revert-buffer-insert-file-contents-function' to reread the
5686 contents of the visited file, with two arguments: the first is the file
5687 name, the second is non-nil if reading an auto-save file.
5689 This function only handles buffers that are visiting files.
5690 Non-file buffers need a custom function."
5695 buffer-auto-save-file-name
5700 buffer-auto-save-file-name
5701 buffer-file-name)))
5711 file-name)))
5713 ;; If file was backed up but has changed since,
5714 ;; we should make another backup.
5718 ;; Effectively copy the after-revert-hook status,
5719 ;; since after-find-file will clobber it.
5722 after-revert-hook))
5724 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5728 file-name auto-save-p)
5729 ;; Recompute the truename in case changes in symlinks
5730 ;; have changed the truename.
5734 ;; Run after-revert-hook as it was before we reverted.
5738 local-hook)
5741 t)))))
5744 "Default function for `revert-buffer-insert-file-contents-function'.
5745 The function `revert-buffer--default' calls this.
5746 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5747 an auto-save file."
5751 "File %s no longer exists!"
5753 file-name))
5756 "File %s no longer readable!"
5758 file-name))
5760 ;; Bind buffer-file-name to nil
5761 ;; so that we don't try to lock the file.
5767 ;; Auto-saved file should be read by Emacs's
5768 ;; internal coding.
5772 buffer-file-coding-system-explicit
5775 coding-system-for-read
5777 coding-system-for-read)
5779 ;; As a coding system suitable for multibyte
5780 ;; buffer is specified, make the current
5781 ;; buffer multibyte.
5784 ;; This force after-insert-file-set-coding
5785 ;; (called from insert-file-contents) to set
5786 ;; buffer-file-coding-system to a proper value.
5789 ;; Note that this preserves point in an intelligent way.
5793 nil nil t))
5795 nil nil t))))))
5798 "Recover the visited file--get contents from its last auto-save file."
5805 "Visit file FILE, but get contents from its last auto-save file."
5806 ;; Actually putting the file name in the minibuffer should be used
5807 ;; only rarely.
5808 ;; Not just because users often use the default.
5821 "*Directory*" nil
5832 ;; Use insert-directory-safely, not insert-directory,
5833 ;; because these files might not exist. In particular,
5834 ;; FILE might not exist if the auto-save file was for
5835 ;; a buffer that didn't visit a file, such as "*mail*".
5836 ;; The code in v20.x called `ls' directly, so we need
5837 ;; to emulate what `ls' did in that case.
5842 ;; Keep the current buffer-file-coding-system.
5844 ;; Auto-saved file should be read with special coding.
5853 "Recover auto save files from a previous Emacs session.
5854 This command first displays a Dired buffer showing you the
5855 previous sessions that you could recover from.
5856 To choose one, move point to the proper line and then type C-c C-c.
5857 Then you'll be asked about a number of files to recover."
5867 directory-files-no-dot-files-regexp
5869 t)
5880 ;; Each line starts with a space
5881 ;; so that Font Lock mode won't highlight the first character.
5884 " To delete a session file, type \
5890 "Choose one saved session to recover auto-save files from.
5891 This command is used in the special Dired buffer created by
5894 ;; Get the name of the session file to recover from.
5896 files
5902 ;; Read in the auto-save-list file.
5905 ;; Loop thru the text of that file
5906 ;; and get out the names of the files to recover.
5910 ;; This is a pair of lines for a non-file-visiting buffer.
5911 ;; Get the auto-save file name and manufacture
5912 ;; a "visited file name" from that.
5915 ;; If there is no auto-save file name, the
5916 ;; auto-save-list file is probably corrupted.
5929 ;; This pair of lines is a file-visiting
5930 ;; buffer. Use the visited file name.
5940 ;; Ignore a file if its auto-save file does not exist now.
5944 ;; The file contains a pair of line for each auto-saved buffer.
5945 ;; The first line of the pair contains the visited file name
5946 ;; or is empty if the buffer was not visiting a file.
5947 ;; The second line is the auto-save file name.
5955 files
5961 "Kill BUFFER if confirmed."
5969 "Kill some buffers. Asks the user whether to kill each one of them.
5970 Non-interactively, if optional argument LIST is non-nil, it
5971 specifies the list of buffers to kill, asking for approval for each one."
5979 ; if we killed the base buffer.
5986 "Kill buffers whose name matches the specified REGEXP.
5987 Ignores buffers whose name starts with a space, unless optional
5988 prefix argument INTERNAL-TOO is non-nil. Asks before killing
5989 each buffer, unless NO-ASK is non-nil."
5998 \f
6000 "Adjust current buffer's auto save file name for current conditions.
6001 Also rename any existing auto save file, if it was made in this session."
6013 "Return file name to use for auto-saves of current buffer.
6014 Does not consider `auto-save-visited-file-name' as that variable is checked
6015 before calling this function. You can redefine this for customization.
6016 See also `auto-save-file-name-p'."
6024 result uniq)
6025 ;; Apply user-specified translations
6026 ;; to the file name.
6030 filename)
6040 filename))))
6045 ;; We truncate the file name to DOS 8+3 limits
6046 ;; before doing anything else, because the regexp
6047 ;; passed to string-match below cannot handle
6048 ;; extensions longer than 3 characters, multiple
6049 ;; dots, and other atrocities.
6054 fn)
6059 "#"
6062 ;; Make sure auto-save file names don't contain characters
6063 ;; invalid for the underlying filesystem.
6065 ;; Don't modify remote filenames
6068 result))))
6070 ;; Deal with buffers that don't have any associated files. (Mail
6071 ;; mode tends to create a good number of these.)
6075 file-name)
6076 ;; Restrict the characters used in the file name to those which
6077 ;; are known to be safe on all filesystems, url-encoding the
6078 ;; rest.
6079 ;; We do this on all platforms, because even if we are not
6080 ;; running on DOS/Windows, the current directory may be on a
6081 ;; mounted VFAT filesystem, such as a USB memory stick.
6085 ;; For multibyte characters, this will produce more than
6086 ;; 2 hex digits, so is not true URL encoding.
6090 ;; Generate the file name.
6096 ;; Try a few alternative directories, to get one we can
6097 ;; write it.
6103 ;; Don't modify remote filenames
6105 ;; The call to convert-standard-filename is in case
6106 ;; buffer-name includes characters not allowed by the
6107 ;; DOS/Windows filesystems. make-temp-file writes to the
6108 ;; file it creates, so we must fix the file name _before_
6109 ;; make-temp-file is called.
6111 fname))
6113 ;; make-temp-file creates the file,
6114 ;; but we don't want it to exist until we do an auto-save.
6118 file-name)))
6121 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6122 FILENAME should lack slashes. You can redefine this for customization."
6124 \f
6126 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6127 The generated regexp will match a filename only if the filename
6128 matches that wildcard according to shell rules. Only wildcards known
6129 by `sh' are supported."
6131 ;; Copy the initial run of non-special characters.
6134 ;; If no special characters, we're almost done.
6138 j)
6140 result
6161 ;; Found "[^". Insert a `\0' character
6162 ;; (which cannot happen in a filename)
6163 ;; into the character class, so that `^'
6164 ;; is not the first character after `[',
6165 ;; and thus non-special in a regexp.
6170 ;; I don't think `]' can appear in a
6171 ;; character class in a wildcard, but
6172 ;; let's be general here.
6179 i
6192 ;; Shell wildcards should match the entire filename,
6193 ;; not its part. Make the regexp say so.
6195 \f
6198 "Switches for `list-directory' to pass to `ls' for brief listing."
6204 "Switches for `list-directory' to pass to `ls' for verbose listing."
6209 "Expand wildcard pattern PATTERN.
6210 This returns a list of file names which match the pattern.
6211 Files are sorted in `string<' order.
6213 If PATTERN is written as an absolute file name,
6214 the values are absolute also.
6216 If PATTERN is written as a relative file name, it is interpreted
6217 relative to the current default directory, `default-directory'.
6218 The file names returned are normally also relative to the current
6219 default directory. However, if FULL is non-nil, they are absolute."
6223 ;; A list of all dirs that DIRPART specifies.
6224 ;; This can be more than one dir
6225 ;; if DIRPART contains wildcards.
6231 contents)
6236 ;; Filter out "." and ".."
6241 name))
6248 this-dir-contents)
6249 this-dir-contents)
6250 contents)))))
6251 contents)))
6253 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6257 "Display a list of files in or matching DIRNAME, a la `ls'.
6258 DIRNAME is globbed by the shell if necessary.
6259 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6260 Actions controlled by variables `list-directory-brief-switches'
6261 and `list-directory-verbose-switches'."
6265 nil default-directory nil)
6266 pfx)))
6268 list-directory-brief-switches))
6269 buffer)
6281 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6289 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6291 PATTERN is assumed to represent a file-name wildcard suitable for the
6292 underlying filesystem. For Unix and GNU/Linux, each character from the
6294 the parts of the pattern which don't include wildcard characters are
6295 quoted with double quotes.
6298 on Windows), so PATTERN can use them to quote wildcard characters that
6299 need to be passed verbatim to shell commands."
6303 ;; DOS/Windows don't allow `"' in file names. So if the
6304 ;; argument has quotes, we can safely assume it is already
6305 ;; quoted by the caller.
6307 ;; We quote [&()#$`'] in case their shell is a port of a
6308 ;; Unixy shell. We quote [,=+] because stock DOS and
6309 ;; Windows shells require that in some cases, such as
6310 ;; passing arguments to batch files that use positional
6311 ;; arguments like %1.
6313 pattern
6316 end)
6333 pattern))))
6340 "Program to get the amount of free space on a file system.
6341 We assume the output has the format of `df'.
6342 The value of this variable must be just a command name or file name;
6343 if you want to specify options, use `directory-free-space-args'.
6345 A value of nil disables this feature.
6347 If the function `file-system-info' is defined, it is always used in
6348 preference to the program given by this variable."
6354 "Options to use when running `directory-free-space-program'."
6359 "Return the amount of free space on directory DIR's file system.
6360 The return value is a string describing the amount of free
6361 space (normally, the number of free 1KB blocks).
6363 This function calls `file-system-info' if it is available, or
6364 invokes the program specified by `directory-free-space-program'
6365 and `directory-free-space-args'. If the system call or program
6366 is unsuccessful, or if DIR is a remote directory, this function
6367 returns nil."
6369 ;; Try to find the number of free blocks. Non-Posix systems don't
6370 ;; always have df, but might have an equivalent system call.
6379 ;; Avoid failure if the default directory does
6380 ;; not exist (Bug#2631, Bug#3911).
6384 nil t nil
6385 directory-free-space-args
6388 ;; Assume that the "available" column is before the
6389 ;; "capacity" column. Find the "%" and scan backward.
6393 "[[:space:]]+[^[:space:]]+%[^%]*$"
6400 ;; The following expression replaces `dired-move-to-filename-regexp'.
6404 ;; In some locales, month abbreviations are as short as 2 letters,
6405 ;; and they can be followed by ".".
6406 ;; In Breton, a month name can include a quote character.
6419 s "+"
6422 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6423 ;; omits the Kanji characters after month and day-of-month.
6424 ;; On Mac OS X 10.3, the date format in East Asian locales is
6425 ;; day-of-month digits followed by month digits.
6431 ;; The "[0-9]" below requires the previous column to end in a digit.
6432 ;; This avoids recognizing `1 may 1997' as a date in the line:
6433 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6435 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6437 ;; For non-iso date formats, we add the ".*" in order to find
6438 ;; the last possible match. This avoids recognizing
6439 ;; `jservice 10 1024' as a date in the line:
6440 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6442 ;; vc dired listings provide the state or blanks between file
6443 ;; permissions and date. The state is always surrounded by
6444 ;; parentheses:
6445 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6446 ;; This is not supported yet.
6451 "Regular expression to match up to the file name in a directory listing.
6452 The default value is designed to recognize dates and times
6458 "Return non-nil if DIR contents a shell wildcard in the directory part.
6459 The return value is a cons (DIR . WILDCARDS); DIR is the
6460 `default-directory' in the Dired buffer, and WILDCARDS are the wildcards.
6462 Valid wildcards are '*', '?', '[abc]' and '[a-z]'."
6465 ls-lisp-support-shell-wildcards)
6469 wildcards wildcards wildcards)))
6477 ;; The following overshoots by one line for an empty
6478 ;; directory listed with "--dired", but without "-a"
6479 ;; switch, where the ls output contains a
6480 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6481 ;; We take care of that case later.
6489 error-lines)
6490 ;; Find all the lines that are error messages,
6491 ;; and record the bounds of each one.
6498 ;; Now read the numeric positions of file names.
6505 error-lines))
6508 error-lines)))
6510 ;; End is followed by \n or by " -> ".
6512 ;; It seems that we can't trust ls's output as to
6513 ;; byte positions of filenames.
6519 ;; Take care of the case where the ls output contains a
6520 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6521 ;; and we went one line too far back (see above).
6526 ;; insert-directory
6527 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6528 ;; FULL-DIRECTORY-P is nil.
6529 ;; The single line of output must display FILE's name as it was
6530 ;; given, namely, an absolute path name.
6531 ;; - must insert exactly one line for each file if WILDCARD or
6532 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6533 ;; before the file lines, plus optional text after the file lines.
6534 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6535 ;; allowed.
6536 ;; File lines should display the basename.
6537 ;; - must be consistent with
6538 ;; - functions dired-move-to-filename, (these two define what a file line is)
6539 ;; dired-move-to-end-of-filename,
6540 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6541 ;; dired-insert-headerline
6542 ;; dired-after-subdir-garbage (defines what a "total" line is)
6543 ;; - variable dired-subdir-regexp
6544 ;; - may be passed "--dired" as the first argument in SWITCHES.
6545 ;; Filename handlers might have to remove this switch if their
6546 ;; "ls" command does not support it.
6548 "Insert directory listing for FILE, formatted according to SWITCHES.
6549 Leaves point after the inserted text.
6550 SWITCHES may be a string of options, or a list of strings
6551 representing individual options.
6552 Optional third arg WILDCARD means treat FILE as shell wildcard.
6553 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6554 switches do not contain `d', so that a full listing is expected.
6556 This works by running a directory listing program
6557 whose name is in the variable `insert-directory-program'.
6558 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6560 When SWITCHES contains the long `--dired' option, this function
6561 treats it specially, for the sake of dired. However, the
6562 normally equivalent short `-D' option is just passed on to
6563 `insert-directory-program', as any other option."
6564 ;; We need the directory in order to find the right handler.
6569 wildcard full-directory-p)
6572 ;; Read the actual directory using `insert-directory-program'.
6573 ;; RESULT gets the status code.
6575 ;; putting text property `dired-filename, decode one
6576 ;; bunch by one to preserve that property.
6578 ;; This is to control encoding the arguments in call-process.
6582 default-file-name-coding-system))))
6585 ;; If the wildcard is just in the file part, then run ls in
6586 ;; the directory part of the file pattern using the last
6587 ;; component as argument. Otherwise, run ls in the longest
6588 ;; subdirectory of the directory part free of wildcards; use
6589 ;; the remaining of the file pattern as argument.
6598 ;; NB since switches is passed to the shell, be
6599 ;; careful of malicious values, eg "-l;reboot".
6600 ;; See eg dired-safe-switches-p.
6602 shell-file-name nil t nil
6603 shell-command-switch
6605 ""
6607 insert-directory-program
6608 " -d "
6610 switches
6612 " -- "
6613 ;; Quote some characters that have
6614 ;; special meanings in shells; but
6615 ;; don't quote the wildcards--we want
6616 ;; them to be special. We also
6617 ;; currently don't quote the quoting
6618 ;; characters in case people want to
6619 ;; use them explicitly to quote
6620 ;; wildcard characters.
6622 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6623 ;; directory if FILE is a symbolic link.
6631 insert-directory-program nil t nil
6635 ;; Split the switches at any spaces so we can
6636 ;; pass separate options as separate args.
6638 ;; Avoid lossage if FILE starts with `-'.
6645 ;; (concat (file-name-as-directory file) ".")
6646 file
6647 file))))))))
6649 ;; If we got "//DIRED//" in the output, it means we got a real
6650 ;; directory listing, even if `ls' returned nonzero.
6651 ;; So ignore any errors.
6664 ;; The first time ls returns an error,
6665 ;; find the version numbers of ls,
6666 ;; and set insert-directory-ls-version
6667 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6668 ;; is equal or if the info cannot be obtained.
6669 ;; (That can mean it isn't GNU ls.)
6679 comparison)
6695 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6699 ;; If `insert-directory-program' failed, signal an error.
6701 ;; Delete the error message it may have output.
6703 ;; On non-Posix systems, we cannot open a directory, so
6704 ;; don't even try, because that will always result in
6705 ;; the ubiquitous "Access denied". Instead, show the
6706 ;; command line so the user can try to guess what went wrong.
6711 insert-directory-program
6713 file result)
6714 ;; Unix. Access the file to get a suitable error.
6718 ;; Now decode what read if necessary.
6720 file-name-coding-system
6721 default-file-name-coding-system
6723 coding-no-eol
6724 val pos)
6728 ;; If no coding system is specified or detection is
6729 ;; requested, detect the coding.
6743 ;; Force no eol conversion on a file name, so
6744 ;; that CR is preserved.
6752 ;; Try to insert the amount of free space.
6755 ;; First find the line to put it on.
6759 ;; Replace "total" with "used", to avoid confusion.
6765 "Convert `ls --dired' file name position value POS to a buffer position.
6766 File name position values returned in ls --dired output
6767 count only stdout; they don't count the error messages sent to stderr.
6768 So this function converts to them to real buffer positions.
6769 ERROR-LINES is a list of buffer positions of error message lines,
6770 of the form (START END)."
6774 pos)
6778 "Insert directory listing for FILE, formatted according to SWITCHES.
6780 Like `insert-directory', but if FILE does not exist, it inserts a
6781 message to that effect instead of signaling an error."
6784 ;; Simulate the message printed by `ls'.
6788 "Functions to call with no arguments to query about killing Emacs.
6789 If any of these functions returns nil, killing Emacs is canceled.
6790 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6791 the low level primitive, does not. See also `kill-emacs-hook'."
6797 "How to ask for confirmation when leaving Emacs.
6798 If nil, the default, don't ask at all. If the value is non-nil, it should
6799 be a predicate function; for example `yes-or-no-p'."
6808 "Non-nil if Emacs should confirm killing processes on exit.
6809 If this variable is nil, the value of
6810 `process-query-on-exit-flag' is ignored. Otherwise, if there are
6811 processes with a non-nil `process-query-on-exit-flag', Emacs will
6812 prompt the user before killing them."
6818 "Offer to save each buffer, then kill this Emacs process.
6819 With prefix ARG, silently save all file-visiting buffers without asking.
6820 If there are active processes where `process-query-on-exit-flag'
6821 returns non-nil and `confirm-kill-processes' is non-nil,
6822 asks whether processes should be killed.
6823 Runs the members of `kill-emacs-query-functions' in turn and stops
6824 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6826 ;; Don't use save-some-buffers-default-predicate, because we want
6827 ;; to ask about all the buffers before killing Emacs.
6838 ;; process-list is not defined on MSDOS.
6841 active)
6859 ;; Query the user for other things, perhaps.
6866 "Offer to save each buffer, then kill the current connection.
6867 If the current frame has no client, kill Emacs itself using
6868 `save-buffers-kill-emacs'.
6870 With prefix ARG, silently save all file-visiting buffers, then kill.
6872 If emacsclient was started with a list of filenames to edit, then
6873 only these files will be asked to be saved."
6878 \f
6879 ;; We use /: as a prefix to "quote" a file name
6880 ;; so that magic file name handlers will not apply to it.
6884 file-name-handler-alist))
6886 ;; We depend on being the last handler on the list,
6887 ;; so that anything else which does need handling
6888 ;; has been handled already.
6889 ;; So it is safe for us to inhibit *all* magic file name handlers.
6894 ;; Some operations respect file name handlers in
6895 ;; `default-directory'. Because core function like
6896 ;; `call-process' don't care about file name handlers in
6897 ;; `default-directory', we here have to resolve the
6898 ;; directory into a local one. For `process-file',
6899 ;; `start-file-process', and `shell-command', this fixes
6900 ;; Bug#25949.
6902 shell-command))
6906 default-directory))
6907 ;; Get a list of the indices of the args which are file names.
6910 ;; The first six are special because they
6911 ;; return a file name. We want to include the /:
6912 ;; in the return value.
6913 ;; So just avoid stripping it in the first place.
6920 ;; `identity' means just return the first arg
6921 ;; not stripped of its quoting.
6923 ;; `add' means add "/:" to the result.
6926 ;; `unquote-then-quote' means set buffer-file-name
6927 ;; temporarily to unquoted filename.
6929 ;; List the arguments which are filenames.
6937 ;; For all other operations, treat the first argument only
6938 ;; as the file name.
6940 method
6941 ;; Copy ARGUMENTS so we can replace elements in it.
6945 ;; Strip off the /: from the file names that have it.
6953 "/"
6959 (`insert-file-contents
6965 (`unquote-then-quote
6966 ;; We can't use `cl-letf' with `(buffer-local-value)' here
6967 ;; because it wouldn't work during bootstrapping.
6969 ;; `unquote-then-quote' is only used for the
6970 ;; `verify-visited-file-modtime' action, which takes a buffer
6971 ;; as only optional argument.
6974 ;; Make sure to hide the temporary buffer change from the
6975 ;; underlying operation.
6983 If NAME is a remote file name, check the local part of NAME."
6988 If NAME is a remote file name, the local part of NAME is quoted.
6989 If NAME is already a quoted file name, NAME is returned unchanged."
6991 name
6996 If NAME is a remote file name, the local part of NAME is unquoted."
7002 \f
7003 ;; Symbolic modes and read-file-modes.
7006 "Convert CHAR to a numeric bit-mask for extracting mode bits.
7007 CHAR is in [ugoa] and represents the category of users (Owner, Group,
7008 Others, or All) for whom to produce the mask.
7009 The bit-mask that is returned extracts from mode bits the access rights
7010 for the specified category of users."
7018 "Convert CHAR to a numeric value of mode bits.
7019 CHAR is in [rwxXstugo] and represents symbolic access permissions.
7020 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
7027 ;; Rights relative to the previous file modes.
7038 "Convert a symbolic mode string specification to an equivalent number.
7040 WHO-MASK is the bit-mask specifying the category of users to which to
7041 apply the access permissions. See `file-modes-char-to-who'.
7042 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7043 RIGHTS request to add, remove, or set permissions based on existing ones,
7050 char-right)
7057 num-rights
7061 op char-right)))
7062 num-rights))
7065 "Convert symbolic file modes to numeric file modes.
7066 MODES is the string to convert, it should match
7068 See Info node `(coreutils)File permissions' for more information on this
7069 notation.
7070 FROM (or 0 if nil) gives the mode bits on which to base permissions if
7071 MODES request to add, remove, or set permissions based on existing ones,
7085 num-who num-modes)
7088 num-modes)))
7091 "Read file modes in octal or symbolic notation and return its numeric value.
7093 ORIG-FILE is the name of a file on whose mode bits to base returned
7094 permissions if what user types requests to add, remove, or set permissions
7110 nil nil default)))
7119 ;; Trashcan handling.
7121 "Directory for `move-file-to-trash' to move files and directories to.
7122 This directory is only used when the function `system-move-file-to-trash'
7123 is not defined.
7124 Relative paths are interpreted relative to `default-directory'.
7125 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
7135 "Move the file (or directory) named FILENAME to the trash.
7136 When `delete-by-moving-to-trash' is non-nil, this function is
7137 called by `delete-file' and `delete-directory' instead of
7138 deleting files outright.
7140 If the function `system-move-file-to-trash' is defined, call it
7141 with FILENAME as an argument.
7142 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
7143 directory.
7144 Otherwise, trash FILENAME using the freedesktop.org conventions,
7145 like the GNOME, KDE and XFCE desktop environments. Emacs only
7149 ;; If `trash-directory' is non-nil, move the file there.
7153 trash-dir)))
7154 ;; We can't trash a parent directory of trash-directory.
7157 trash-dir filename))
7160 ;; Ensure that the trashed file-name is unique.
7167 ;; If `system-move-file-to-trash' is defined, use it.
7170 ;; Otherwise, use the freedesktop.org method, as specified at
7171 ;; http://freedesktop.org/wiki/Specifications/trash-spec
7182 ;; Check if we have permissions to delete.
7186 ;; The trashed file cannot be the trash dir or its parent.
7189 trash-files-dir filename))
7192 trash-info-dir filename))
7194 ;; Ensure that the trash directory exists; otherwise, create it.
7201 ;; Try to move to trash with .trashinfo undo information
7206 ;; Perform url-encoding on FN. For compatibility with
7207 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7208 ;; for path separators.
7213 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7214 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7227 fn))
7232 ;; Make a .trashinfo file. Use O_EXCL, as per trash-spec 1.0.
7236 trash-info-dir)))
7240 ;; Uniquify new-fn. Some file managers do not
7241 ;; like Emacs-style backup file names. E.g.:
7242 ;; https://bugs.kde.org/170956
7248 ;; Finally, try to move the file to the trashcan.
7254 "The type field in ATTRIBUTES returned by `file-attributes'.
7255 The value is either t for directory, string (name linked to) for
7256 symbolic link, or nil."
7260 "Return the number of links in ATTRIBUTES returned by `file-attributes'."
7264 "The UID field in ATTRIBUTES returned by `file-attributes'.
7265 This is either a string or a number. If a string value cannot be
7266 looked up, a numeric value, either an integer or a float, is
7267 returned."
7271 "The GID field in ATTRIBUTES returned by `file-attributes'.
7272 This is either a string or a number. If a string value cannot be
7273 looked up, a numeric value, either an integer or a float, is
7274 returned."
7278 "The last access time in ATTRIBUTES returned by `file-attributes'.
7279 This a list of integers (HIGH LOW USEC PSEC) in the same style
7280 as (current-time)."
7284 "The modification time in ATTRIBUTES returned by `file-attributes'.
7285 This is the time of the last change to the file's contents, and
7286 is a list of integers (HIGH LOW USEC PSEC) in the same style
7287 as (current-time)."
7291 "The status modification time in ATTRIBUTES returned by `file-attributes'.
7292 This is the time of last change to the file's attributes: owner
7293 and group, access mode bits, etc, and is a list of integers (HIGH
7294 LOW USEC PSEC) in the same style as (current-time)."
7298 "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
7299 This is a floating point number if the size is too large for an integer."
7303 "The file modes in ATTRIBUTES returned by `file-attributes'.
7304 This is a string of ten letters or dashes as in ls -l."
7308 "The inode number in ATTRIBUTES returned by `file-attributes'.
7309 If it is larger than what an Emacs integer can hold, this is of
7310 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7311 If even HIGH is too large for an Emacs integer, this is instead
7312 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7313 middle 24 bits, and finally the low 16 bits."
7317 "The file system device number in ATTRIBUTES returned by `file-attributes'.
7318 If it is larger than what an Emacs integer can hold, this is of
7319 the form (HIGH . LOW): first the high bits, then the low 16 bits.
7320 If even HIGH is too large for an Emacs integer, this is instead
7321 of the form (HIGH MIDDLE . LOW): first the high bits, then the
7322 middle 24 bits, and finally the low 16 bits."
7326 "Return a sublist of ATTRIBUTES returned by `file-attributes'.
7327 ATTR-NAMES are symbols with the selected attribute names.
7329 Valid attribute names are: type, link-number, user-id, group-id,
7330 access-time, modification-time, status-change-time, size, modes,
7331 inode-number and device-number."
7333 modification-time status-change-time
7334 size modes inode-number device-number))
7335 result)
7341 attributes)
7342 result)
7345 \f
7370 ;;; files.el ends here