| blob | e9632edacef4c08f4e59ce4b3bb03eaa43de0db4 |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2015 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:
34 "Backups of edited data files."
38 "Finding files."
43 "Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that the auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
57 FROM is matched against directory names anchored at the first
61 FROM and TO should be equivalent names, which refer to the
62 same directory. Do not use `~' in the TO strings;
63 they should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
99 "If non-nil, backups will be inhibited.
100 This variable is intended for use by making it local to a buffer,
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
130 "Non-nil means create backups by copying to preserve a privileged owner.
131 Renaming may still be used (subject to control of other variables)
132 when it would not result in changing the owner of the file or if the owner
133 has a user id greater than the value of this variable. This is useful
134 when low-numbered uid's are used for special system users (such as root)
135 that must maintain ownership of certain files.
136 This variable is relevant only if `backup-by-copying' and
137 `backup-by-copying-when-mismatch' are nil."
142 "Predicate that looks at a file name and decides whether to make backups.
146 "Non-nil in a buffer means always offer to save buffer on exit.
147 Do so even if the buffer is not visiting a file.
148 Automatically local in all buffers."
155 "Non-nil means find a file under alternative names, in existing buffers.
156 This means if any existing buffer is visiting the file you want
157 under another name, you get the existing buffer instead of a new buffer."
162 "Non-nil means visiting a file uses its truename as the visited-file name.
163 That is, the buffer visiting the file has the truename as the
164 value of `buffer-file-name'. The truename of a file is found by
165 chasing all links both at the file level and at the levels of the
166 containing directories."
172 "Specify which files should be reverted without query.
173 The value is a list of regular expressions.
174 If the file name matches one of these regular expressions,
175 then `revert-buffer' reverts the file without querying
176 if the file has changed on disk and you have not edited the buffer."
181 "The device number and file number of the file visited in the current buffer.
182 The value is a list of the form (FILENUM DEVNUM).
183 This pair of numbers uniquely identifies the file.
197 "The directory for writing small temporary files.
198 If non-nil, this directory is used instead of `temporary-file-directory'
199 by programs that create small temporary files. This is for systems that
200 have fast storage with limited space, such as a RAM disk."
205 ;; The system null device. (Should reference NULL_DEVICE from C.)
232 "Non-nil means protect against I/O errors while saving files.
233 Some modes set this non-nil in particular buffers.
235 This feature works by writing the new contents into a temporary file
236 and then renaming the temporary file to replace the original.
237 In this way, any I/O error in writing leaves the original untouched,
238 and there is never any instant where the file is nonexistent.
240 Note that this feature forces backups to be made by copying.
241 Yet, at the same time, saving a precious file
242 breaks any hard links between it and other files.
244 This feature is advisory: for example, if the directory in which the
245 file is being saved is not writable, Emacs may ignore a non-nil value
246 of `file-precious-flag' and write directly into the file.
248 See also: `break-hardlink-on-save'."
253 "Whether to allow breaking hardlinks when saving files.
254 If non-nil, then when saving a file that exists under several
255 names \(i.e., has multiple hardlinks), break the hardlink
256 associated with `buffer-file-name' and write to a new file, so
257 that the other instances of the file are not affected by the
258 save.
260 If `buffer-file-name' refers to a symlink, do not break the symlink.
262 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
263 For example, if the directory in which a file is being saved is not
264 itself writable, then error instead of saving in some
265 hardlink-nonbreaking way.
267 See also `backup-by-copying' and `backup-by-copying-when-linked'."
273 "Control use of version numbers for backup files.
274 When t, make numeric backup versions unconditionally.
275 When nil, make them for files that have some already.
276 The value `never' means do not make them."
286 "When cleaning directory, number of versions to keep."
292 "If t, delete excess backup versions silently.
293 If nil, ask confirmation. Any other value prevents any trimming."
300 "Number of oldest versions to keep when a new numbered backup is made."
306 "Number of newest versions to keep when a new numbered backup is made.
307 Includes the new backup. Must be > 0"
313 "Whether to add a newline automatically at the end of the file.
315 A value of t means do this only when the file is about to be saved.
316 A value of `visit' means do this right after the file is visited.
317 A value of `visit-save' means do it at both of those times.
318 Any other non-nil value means ask user whether to add a newline, when saving.
319 A value of nil means don't add newlines.
321 Certain major modes set this locally to the value obtained
322 from `mode-require-final-newline'."
332 "Whether to add a newline at end of file, in certain major modes.
333 Those modes set `require-final-newline' to this value when you enable them.
334 They do so because they are often used for files that are supposed
335 to end in newlines, and the question is how to arrange that.
337 A value of t means do this only when the file is about to be saved.
338 A value of `visit' means do this right after the file is visited.
339 A value of `visit-save' means do it at both of those times.
340 Any other non-nil value means ask user whether to add a newline, when saving.
342 A value of nil means do not add newlines. That is a risky choice in this
343 variable since this value is used for modes for files that ought to have
344 final newlines. So if you set this to nil, you must explicitly check and
345 add a final newline, whenever you save a file that really needs one."
355 "Non-nil says by default do auto-saving of every file-visiting buffer."
361 ;; Don't put "\\2" inside expand-file-name, since it will be
362 ;; transformed to "/2" on DOS/Windows.
364 "Transforms to apply to buffer file name before making auto-save file name.
365 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
366 REGEXP is a regular expression to match against the file name.
367 If it matches, `replace-match' is used to replace the
368 matching part with REPLACEMENT.
369 If the optional element UNIQUIFY is non-nil, the auto-save file name is
370 constructed by taking the directory part of the replaced file-name,
371 concatenated with the buffer file name with all directory separators
372 changed to `!' to prevent clashes. This will not work
373 correctly if your filesystem truncates the resulting name.
375 All the transforms in the list are tried, in the order they are listed.
376 When one transform applies, its result is final;
377 no further transforms are tried.
379 The default value is set up to put the auto-save file into the
380 temporary directory (see the variable `temporary-file-directory') for
381 editing a remote file.
383 On MS-DOS filesystems without long names this variable is always
384 ignored."
392 "Non-nil means save word abbrevs too when files are saved.
393 If `silently', don't ask the user before saving."
398 "Non-nil means allow `find-file' to visit directories.
399 To visit the directory, `find-file' runs `find-directory-functions'."
404 "List of functions to try in sequence to visit a directory.
405 Each function is called with the directory name as the sole argument
406 and should return either a buffer or nil."
410 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
412 "List of functions to try in sequence to get a file name at point.
413 Each function should return either nil or a file name found at the
414 location of point in the current buffer."
418 ;;;It is not useful to make this a local variable.
419 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
423 "List of functions to be called for `find-file' on nonexistent file.
424 These functions are called as soon as the error is detected.
425 Variable `buffer-file-name' is already set up.
428 ;;;It is not useful to make this a local variable.
429 ;;;(put 'find-file-hooks 'permanent-local t)
432 "List of functions to be called after a buffer is loaded from a file.
433 The buffer's local variables (if any) will have been processed before the
434 functions are called."
442 "List of functions to be called before writing out a buffer to a file.
443 If one of them returns non-nil, the file is considered already written
444 and the rest are not called.
445 These hooks are considered to pertain to the visited file.
446 So any buffer-local binding of this variable is discarded if you change
448 change the major mode.
450 This hook is not run if any of the functions in
451 `write-contents-functions' returns non-nil. Both hooks pertain
452 to how to save a buffer to file, for instance, choosing a suitable
453 coding system and setting mode bits. (See Info
454 node `(elisp)Saving Buffers'.) To perform various checks or
466 "List of functions to be called before writing out a buffer to a file.
467 If one of them returns non-nil, the file is considered already written
468 and the rest are not called and neither are the functions in
469 `write-file-functions'.
471 This variable is meant to be used for hooks that pertain to the
472 buffer's contents, not to the particular visited file; thus,
473 `set-visited-file-name' does not clear this variable; but changing the
474 major mode does clear it.
476 For hooks that _do_ pertain to the particular visited file, use
477 `write-file-functions'. Both this variable and
478 `write-file-functions' relate to how a buffer is saved to file.
479 To perform various checks or updates before the buffer is saved,
484 "Control use of local variables in files you visit.
485 The value can be t, nil, :safe, :all, or something else.
487 A value of t means file local variables specifications are obeyed
488 if all the specified variable values are safe; if any values are
489 not safe, Emacs queries you, once, whether to set them all.
490 \(When you say yes to certain values, they are remembered as safe.)
492 :safe means set the safe variables, and ignore the rest.
493 :all means set all variables, whether safe or not.
494 (Don't set it permanently to :all.)
495 A value of nil means always ignore the file local variables.
497 Any other value means always query you once whether to set them all.
498 \(When you say yes to certain values, they are remembered as safe, but
501 This variable also controls use of major modes specified in
502 a -*- line.
505 always obeys file local variable specifications and the -*- line,
506 and ignores this variable."
507 :risky t
516 "Non-nil means enable use of directory-local variables.
517 Some modes may wish to set this to nil to prevent directory-local
520 ;; This is an odd variable IMO.
521 ;; You might wonder why it is needed, when we could just do:
522 ;; (set (make-local-variable 'enable-local-variables) nil)
523 ;; These two are not precisely the same.
524 ;; Setting this variable does not cause -*- mode settings to be
525 ;; ignored, whereas setting enable-local-variables does.
526 ;; Only three places in Emacs use this variable: tar and arc modes,
527 ;; and rmail. The first two don't need it. They already use
528 ;; inhibit-local-variables-regexps, which is probably enough, and
529 ;; could also just set enable-local-variables locally to nil.
530 ;; Them setting it has the side-effect that dir-locals cannot apply to
531 ;; eg tar files (?). FIXME Is this appropriate?
532 ;; AFAICS, rmail is the only thing that needs this, and the only
533 ;; reason it uses it is for BABYL files (which are obsolete).
534 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
535 ;; to respect, so that find-file on a BABYL file will switch to
536 ;; rmail-mode automatically (this is nice, but hardly essential,
537 ;; since most people are used to explicitly running a command to
538 ;; access their mail; M-x gnus etc). Rmail files may happen to
539 ;; contain Local Variables sections in messages, which Rmail wants to
540 ;; ignore. So AFAICS the only reason this variable exists is for a
541 ;; minor convenience feature for handling of an obsolete Rmail file format.
543 "Like `enable-local-variables' but meant for buffer-local bindings.
544 The meaningful values are nil and non-nil. The default is non-nil.
545 If a major mode sets this to nil, buffer-locally, then any local
546 variables list in a file visited in that mode will be ignored.
548 This variable does not affect the use of major modes specified
553 The value can be t, nil or something else.
554 A value of t means obey `eval' variables.
555 A value of nil means ignore them; anything else means query."
556 :risky t
563 "Non-nil means buffers visiting files read-only do so in view mode.
564 In fact, this means that all read-only buffers normally have
565 View mode enabled, including buffers that are read-only because
566 you visit a file you cannot alter, and buffers you make read-only
572 "History list of file names entered in the minibuffer.
574 Maximum length of the history list is determined by the value
576 \f
579 "Provides support for ange-ftp host name completion.
580 Runs the usual ange-ftp hook, but only for completion operations."
581 ;; Having this here avoids the need to load ange-ftp when it's not
582 ;; really in use.
588 inhibit-file-name-handlers)))
596 "Convert a standard file's name to something suitable for the OS.
597 This means to guarantee valid names and perhaps to canonicalize
598 certain patterns.
600 FILENAME should be an absolute file name since the conversion rules
601 sometimes vary depending on the position in the file name. E.g. c:/foo
602 is a valid DOS file name, but c:/bar/c:/foo is not.
604 This function's standard definition is trivial; it just returns
605 the argument. However, on Windows and DOS, replace invalid
606 characters. On DOS, make sure to obey the 8.3 limitations.
607 In the native Windows build, turn Cygwin names into native names,
608 and also turn slashes into backslashes if the shell requires it (see
609 `w32-shell-dos-semantics').
611 See Info node `(elisp)Standard File Names' for more details."
616 ;; Replace invalid filename characters with !
620 name))
628 "Read directory name, prompting with PROMPT and completing in directory DIR.
629 Value is not expanded---you must call `expand-file-name' yourself.
630 Default name to DEFAULT-DIRNAME if user exits with the same
631 non-empty string that was inserted by this function.
632 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
633 or just DIR if INITIAL is nil.)
634 If the user exits with an empty minibuffer, this function returns
635 an empty string. (This can only happen if the user erased the
636 pre-inserted contents or if `insert-default-directory' is nil.)
637 Fourth arg MUSTMATCH non-nil means require existing directory's name.
638 Non-nil and non-t means also require confirmation after completion.
639 Fifth arg INITIAL specifies text to start with.
640 DIR should be an absolute directory name. It defaults to
641 the value of `default-directory'."
646 dir))
647 mustmatch initial
650 \f
652 "Show the current default directory."
657 "Value of the CDPATH environment variable, as a list.
661 "Explode a search path into a list of directory names.
662 Directories are separated by `path-separator' (which is colon in
663 GNU and Unix systems). Substitute environment variables into the
664 resulting list of directory names. For an empty path element (i.e.,
665 a leading or trailing separator, or two adjacent separators), return
666 nil (meaning `default-directory') as the associated list element."
674 "Change current directory to given absolute file name DIR."
675 ;; Put the name into directory syntax now,
676 ;; because otherwise expand-file-name may give some bad results.
678 ;; We used to additionally call abbreviate-file-name here, for an
679 ;; unknown reason. Problem is that most buffers are setup
680 ;; without going through cd-absolute and don't call
681 ;; abbreviate-file-name on their default-directory, so the few that
682 ;; do end up using a superficially different directory.
694 "Make DIR become the current buffer's default directory.
695 If your environment includes a `CDPATH' variable, try each one of
696 that list of directories (separated by occurrences of
697 `path-separator') when resolving a relative directory name.
698 The path separator is colon in GNU and GNU-like systems."
701 ;; FIXME: There's a subtle bug in the completion below. Seems linked
702 ;; to a fundamental difficulty of implementing `predicate' correctly.
703 ;; The manifestation is that TAB may list non-directories in the case where
704 ;; those files also correspond to valid directories (if your cd-path is (A/
705 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
706 ;; will be listed as valid completions).
707 ;; This is because `a' (listed because of A/a) is indeed a valid choice
708 ;; (which will lead to the use of B/a).
713 cd-path nil))
722 default-directory default-directory
723 t))))
733 "Return non-nil if NAME ends with a slash character."
738 "Return all files under DIR that have file names matching MATCH (a regexp).
740 and alphabetical order.
741 If INCLUDE-DIRECTORIES, also include directories that have matching names."
744 ;; When DIR is "/", remote file names like "/method:" could
745 ;; also be offered. We shall suppress them.
753 ;; Don't follow symlinks to other directories.
757 full-file match include-directories))))
766 "Load the Lisp file named FILE."
767 ;; This is a case where .elc makes a lot of sense.
774 "Search for FILENAME through PATH.
775 If found, return the absolute file name of FILENAME; otherwise
776 return nil.
777 PATH should be a list of directories to look in, like the lists in
778 `exec-path' or `load-path'.
779 If SUFFIXES is non-nil, it should be a list of suffixes to append to
782 If non-nil, PREDICATE is used instead of `file-readable-p'.
784 This function will normally skip directories, so if you want it to find
785 directories, make sure the PREDICATE function returns `dir-ok' for them.
787 PREDICATE can also be an integer to pass to the `access' system call,
788 in which case file-name handlers are ignored. This usage is deprecated.
789 For compatibility, PREDICATE can also be one of the symbols
790 `executable', `readable', `writable', or `exists', or a list of
791 one or more of those symbols."
802 "Do completion for file names passed to `locate-file'."
805 ;; FIXME: maybe we should use completion-file-name-table instead,
806 ;; tho at least for `load', the arg is passed through
807 ;; substitute-in-file-name for historical reasons.
817 ;; If we have files like "foo.el" and "foo.elc", we could load one of
818 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
819 ;; preferred way. So if we list all 3, that gives a lot of redundant
820 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
821 ;; the user does want to pay attention to the extension. We try to
822 ;; diffuse this tension by stripping the suffix, except when the
823 ;; result is a single element (i.e. usually we only list "foo" unless
824 ;; it's the only remaining element in the list, in which case we do
825 ;; list "foo", "foo.elc" and "foo.el").
836 string-file dir))
841 ;; Switching from names to names+fullnames creates a non-monotonicity
842 ;; which can cause problems with things like partial-completion.
843 ;; To minimize the problem, filter out completion-regexp-list, so that
844 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
845 ;; from `names' which only matched `string' when they still had
846 ;; their suffix.
848 ;; Remove duplicates of the first element, so that we can easily check
849 ;; if `names' really only contains a single element.
852 ;; There's no more than one matching non-suffixed element, so expand
853 ;; the list by adding the suffixed elements as well.
856 string-dir names string-file pred action)))))
859 "Do completion for file names passed to `locate-file'.
860 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
864 string nil action))
868 "Regexp of directory names which stop the search in `locate-dominating-file'.
869 Any directory whose name matches this regexp will be treated like
870 a kind of root directory by `locate-dominating-file' which will stop its search
871 when it bumps into it.
872 The default regexp prevents fruitless and time-consuming attempts to find
873 special files in directories in which filenames are interpreted as hostnames,
876 ;; (defun locate-dominating-files (file regexp)
877 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
878 ;; Stop at the first parent where a matching file is found and return the list
879 ;; of files that that match in this directory."
880 ;; (catch 'found
881 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
882 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
883 ;; (let ((user nil)
884 ;; ;; Abbreviate, so as to stop when we cross ~/.
885 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
886 ;; files)
887 ;; (while (and dir
888 ;; ;; As a heuristic, we stop looking up the hierarchy of
889 ;; ;; directories as soon as we find a directory belonging to
890 ;; ;; another user. This should save us from looking in
891 ;; ;; things like /net and /afs. This assumes that all the
892 ;; ;; files inside a project belong to the same user.
893 ;; (let ((prev-user user))
894 ;; (setq user (nth 2 (file-attributes dir)))
895 ;; (or (null prev-user) (equal user prev-user))))
896 ;; (if (setq files (condition-case nil
897 ;; (directory-files dir 'full regexp 'nosort)
898 ;; (error nil)))
899 ;; (throw 'found files)
900 ;; (if (equal dir
901 ;; (setq dir (file-name-directory
902 ;; (directory-file-name dir))))
903 ;; (setq dir nil))))
904 ;; nil)))
907 "Look up the directory hierarchy from FILE for a directory containing NAME.
908 Stop at the first parent directory containing a file NAME,
909 and return the directory. Return nil if not found.
910 Instead of a string, NAME can also be a predicate taking one argument
911 \(a directory) and returning a non-nil value if that directory is the one for
912 which we're looking."
913 ;; We used to use the above locate-dominating-files code, but the
914 ;; directory-files call is very costly, so we're much better off doing
915 ;; multiple calls using the code in here.
916 ;;
917 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
918 ;; `name' in /home or in /.
921 ;; `user' is not initialized outside the loop because
922 ;; `file' may not exist, so we may have to walk up part of the
923 ;; hierarchy before we find the "initial UID". Note: currently unused
924 ;; (user nil)
925 try)
928 ;; FIXME: Disabled this heuristic because it is sometimes
929 ;; inappropriate.
930 ;; As a heuristic, we stop looking up the hierarchy of
931 ;; directories as soon as we find a directory belonging
932 ;; to another user. This should save us from looking in
933 ;; things like /net and /afs. This assumes that all the
934 ;; files inside a project belong to the same user.
935 ;; (let ((prev-user user))
936 ;; (setq user (nth 2 (file-attributes file)))
937 ;; (and prev-user (not (equal user prev-user))))
949 "Non-nil means warn if cannot access `user-emacs-directory'.
950 Set this to nil at your own risk..."
956 "Return an absolute per-user Emacs-specific file name.
957 If NEW-NAME exists in `user-emacs-directory', return it.
958 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
959 Else return NEW-NAME in `user-emacs-directory', creating the
960 directory if it does not exist."
968 at-home
969 ;; Make sure `user-emacs-directory' exists,
970 ;; unless we're in batch mode or dumping Emacs.
972 purify-flag
982 user-emacs-directory-warning
984 ;; Only warn once per Emacs session.
988 Unable to %s `user-emacs-directory' (%s).
989 Any data that would normally be written there may be lost!
990 If you never want to see this message again,
991 customize the variable `user-emacs-directory-warning'."
992 errtype user-emacs-directory)))))
993 bestname))))
997 "Search for COMMAND in `exec-path' and return the absolute file name.
998 Return nil if COMMAND is not found anywhere in `exec-path'."
999 ;; Use 1 rather than file-executable-p to better match the behavior of
1000 ;; call-process.
1004 "Load the Emacs Lisp library named LIBRARY.
1005 This is an interface to the function `load'. LIBRARY is searched
1006 for in `load-path', both with and without `load-suffixes' (as
1007 well as `load-file-rep-suffixes').
1009 See Info node `(emacs)Lisp Libraries' for more details.
1010 See `load-file' for a different interface to `load'."
1014 load-path
1019 "Test whether FILE specifies a location on a remote system.
1020 A file is considered remote if accessing it is likely to
1021 be slower or less reliable than accessing local files.
1023 `file-remote-p' never opens a new remote connection. It can
1024 only reuse a connection that is already open.
1026 Return nil or a string identifying the remote connection
1027 \(ideally a prefix of FILE). Return nil if FILE is a relative
1028 file name.
1030 When IDENTIFICATION is nil, the returned string is a complete
1031 remote identifier: with components method, user, and host. The
1032 components are those present in FILE, with defaults filled in for
1033 any that are missing.
1035 IDENTIFICATION can specify which part of the identification to
1036 return. IDENTIFICATION can be the symbol `method', `user',
1037 `host', or `localname'. Any other value is handled like nil and
1038 means to return the complete identification. The string returned
1039 for IDENTIFICATION `localname' can differ depending on whether
1040 there is an existing connection.
1042 If CONNECTED is non-nil, return an identification only if FILE is
1043 located on a remote system and a connection is established to
1044 that remote system.
1046 Tip: You can use this expansion of remote identifier components
1047 to derive a new remote file name from an existing one. For
1053 same remote identifier as FILE but expanded; a name such as
1058 nil)))
1060 ;; Probably this entire variable should be obsolete now, in favor of
1061 ;; something Tramp-related (?). It is not used in many places.
1062 ;; It's not clear what the best file for this to be in is, but given
1063 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1064 ;; rather than autoloaded.
1066 ;; This used to try various hard-coded places for remsh, rsh, and
1067 ;; rcmd, trying to guess based on location whether "rsh" was
1068 ;; "restricted shell" or "remote shell", but I don't see the point
1069 ;; in this day and age. Almost everyone will use ssh, and have
1070 ;; whatever command they want to use in PATH.
1077 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1084 "Whether to use the remote file-name cache for read access.
1085 When `nil', never expire cached values (caution)
1086 When `t', never use the cache (safe, but may be slow)
1087 A number means use cached values for that amount of seconds since caching.
1089 The attributes of remote files are cached for better performance.
1090 If they are changed outside of Emacs's control, the cached values
1091 become invalid, and must be reread. If you are sure that nothing
1092 other than Emacs changes the files, you can set this variable to `nil'.
1094 If a remote file is checked regularly, it might be a good idea to
1095 let-bind this variable to a value less than the interval between
1096 consecutive checks. For example:
1098 (defun display-time-file-nonempty-p (file)
1099 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1100 (and (file-exists-p file)
1101 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1112 "Copy the file FILE into a temporary file on this machine.
1113 Returns the name of the local copy, or nil, if FILE is directly
1114 accessible."
1115 ;; This formerly had an optional BUFFER argument that wasn't used by
1116 ;; anything.
1120 nil)))
1123 "Return the truename of FILENAME.
1124 If FILENAME is not absolute, first expands it against `default-directory'.
1125 The truename of a file name is found by chasing symbolic links
1126 both at the level of the file and at the level of the directories
1127 containing it, until no links are left at any level.
1130 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1131 ;; COUNTER can be a cons cell whose car is the count of how many
1132 ;; more links to chase before getting an error.
1133 ;; PREV-DIRS can be a cons cell whose car is an alist
1134 ;; of truenames we've just recently computed.
1148 ;; For speed, remove the ange-ftp completion handler from the list.
1149 ;; We know it's not needed here.
1150 ;; For even more speed, do this only on the outermost call.
1157 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1158 ;; case differences being ignored by the OS, and short "8.3 DOS"
1159 ;; name aliases existing for all files. (The short names are not
1160 ;; reported by directory-files, but can be used to refer to files.)
1161 ;; It seems appropriate for file-truename to resolve these issues in
1162 ;; the most natural way, which on Windows is to call the function
1163 ;; `w32-long-file-name' - this returns the exact name of a file as
1164 ;; it is stored on disk (expanding short name aliases with the full
1165 ;; name in the process).
1168 ;; If filename exists, use its long name. If it doesn't
1169 ;; exist, the recursion below on the directory of filename
1170 ;; will drill down until we find a directory that exists,
1171 ;; and use the long name of that, with the extra
1172 ;; non-existent path components concatenated.
1177 ;; If this file directly leads to a link, process that iteratively
1178 ;; so that we don't use lots of stack.
1184 ;; For file name that has a special handler, call handler.
1185 ;; This is so that ange-ftp can save time by doing a no-op.
1188 done t)
1190 target dirfile)
1191 ;; Get the truename of the directory.
1193 ;; If these are equal, we have the (or a) root directory.
1197 ;; If this is the same dir we last got the truename for,
1198 ;; save time--don't recalculate.
1208 done t)
1211 done t)
1212 ;; Put it back on the file name.
1214 ;; Is the file name the name of a link?
1217 ;; Yes => chase that link, then start all over
1218 ;; since the link may point to a directory name that uses links.
1219 ;; We can't safely use expand-file-name here
1220 ;; since target might look like foo/../bar where foo
1221 ;; is itself a link. Instead, we handle . and .. above.
1224 target
1226 done nil)
1227 ;; No, we are done!
1229 filename))
1232 "Chase links in FILENAME until a name that is not a link.
1233 Unlike `file-truename', this does not check whether a parent
1234 directory name is a symbolic link.
1235 If the optional argument LIMIT is a number,
1236 it means chase no more than that many links and then stop."
1244 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1247 ;; Handle `..' by hand, since it needs to work in the
1248 ;; target of any directory symlink.
1249 ;; This code is not quite complete; it does not handle
1250 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1254 ;; Chase links in the default dir of the symlink.
1258 ;; Now find the parent of that dir.
1262 newname))
1264 ;; A handy function to display file sizes in human-readable form.
1265 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1267 "Produce a string showing FILE-SIZE in human-readable form.
1269 Optional second argument FLAVOR controls the units and the display format:
1271 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1273 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1275 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1278 1024.0
1281 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1287 "%.1f%s%s"
1289 file-size
1291 "K"
1296 "Create a temporary file.
1297 The returned file name (created by appending some random characters at the end
1298 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1299 is guaranteed to point to a newly created empty file.
1300 You can then use `write-region' to write new data into the file.
1302 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1304 If SUFFIX is non-nil, add that at the end of the file name."
1305 ;; Create temp files with strict access rights. It's easy to
1306 ;; loosen them later, whereas it's impossible to close the
1307 ;; time-window of loose permissions otherwise.
1316 temporary-file-directory)
1318 temporary-file-directory))))
1324 nil)
1326 ;; the file was somehow created by someone else between
1327 ;; `make-temp-name' and `write-region', let's try again.
1328 nil)
1329 file)))
1332 "Change the encoding of FILE's name from CODING to NEW-CODING.
1333 The value is a new name of FILE.
1334 Signals a `file-already-exists' error if a file of the new name
1335 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1336 is non-nil. A number as fourth arg means request confirmation if
1337 the new name already exists. This is what happens in interactive
1338 use with M-x."
1341 default-file-name-coding-system))
1343 from-coding to-coding)
1345 ;; We provide the default coding only when it seems that
1346 ;; the filename is correctly decoded by the default
1347 ;; coding.
1353 filename default-coding)
1354 default-coding))
1358 ;; We provide the default coding only when a user is going to
1359 ;; change the encoding not from the default coding.
1363 filename from-coding)))
1366 filename from-coding default-coding)
1367 default-coding)))
1371 default-file-name-coding-system))
1372 ;; FILE should have been decoded by DEFAULT-CODING.
1376 ;; Suppress further encoding.
1381 newname))
1382 \f
1384 "Whether confirmation is requested before visiting a new file or buffer.
1385 If nil, confirmation is not requested.
1386 If the value is `after-completion', confirmation is only
1387 requested if the user called `minibuffer-complete' right before
1388 `minibuffer-complete-and-exit'.
1389 Any other non-nil value means to request confirmation.
1391 This affects commands like `switch-to-buffer' and `find-file'."
1399 "Whether to request confirmation before visiting a new file or buffer.
1400 The variable `confirm-nonexistent-file-or-buffer' determines the
1401 return value, which may be passed as the REQUIRE-MATCH arg to
1402 `read-buffer' or `find-file-read-args'."
1410 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1411 FUN can also be (:append FUN1), in which case FUN1 is appended to
1412 `minibuffer-setup-hook'.
1414 BODY should use the minibuffer at most once.
1415 Recursive uses of the minibuffer are unaffected (FUN is not
1416 called additional times).
1418 This macro actually adds an auxiliary function that calls FUN,
1419 rather than FUN itself, to `minibuffer-setup-hook'."
1430 ;; Clear out this hook so it does not interfere
1431 ;; with any recursive minibuffer usage.
1442 t))
1445 "Edit file FILENAME.
1446 Switch to a buffer visiting file FILENAME,
1447 creating one if none already exists.
1448 Interactively, the default if you just type RET is the current directory,
1449 but the visited file name is available through the minibuffer history:
1450 type M-n to pull it into the minibuffer.
1452 You can visit files on remote machines by specifying something
1453 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1454 also visit local files as a different user by specifying
1455 /sudo::FILE for the file name.
1456 See the Info node `(tramp)File name Syntax' in the Tramp Info
1457 manual, for more about this.
1459 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1460 expand wildcards (if any) and visit multiple files. You can
1461 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1463 To visit a file without any kind of conversion and without
1474 "Edit file FILENAME, in another window.
1477 an existing one. See the function `display-buffer'.
1479 Interactively, the default if you just type RET is the current directory,
1480 but the visited file name is available through the minibuffer history:
1481 type M-n to pull it into the minibuffer.
1483 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1484 expand wildcards (if any) and visit multiple files."
1494 value)
1498 "Edit file FILENAME, in another frame.
1501 an existing one. See the function `display-buffer'.
1503 Interactively, the default if you just type RET is the current directory,
1504 but the visited file name is available through the minibuffer history:
1505 type M-n to pull it into the minibuffer.
1507 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1508 expand wildcards (if any) and visit multiple files."
1518 value)
1522 "Edit the existing file FILENAME.
1524 file names with wildcards."
1541 value))
1544 "Edit file FILENAME but don't allow changes.
1553 "Edit file FILENAME in another window but don't allow changes.
1562 "Edit file FILENAME in another frame but don't allow changes.
1571 "Find file FILENAME as a replacement for the file in the next window.
1572 This command does not select that window.
1576 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1577 expand wildcards (if any) and replace the file with multiple files."
1588 "Find alternate file: " file-dir nil
1590 t))))
1597 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1599 "Hook run when a buffer is killed.
1600 The buffer being killed is current while the hook is running.
1601 See `kill-buffer'.
1603 Note: Be careful with let-binding this hook considering it is
1607 "Find file FILENAME, select its buffer, kill previous buffer.
1608 If the current buffer now contains an empty file that you just visited
1609 \(presumably by mistake), use this command to visit the file you really want.
1613 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1614 expand wildcards (if any) and replace the file with multiple files.
1616 If the current buffer is an indirect buffer, or the base buffer
1617 for one or more indirect buffers, the other buffer(s) are not
1618 killed."
1627 "Find alternate file: " file-dir nil
1629 t)))
1641 ;; Run `kill-buffer-hook' here. It needs to happen before
1642 ;; variables like `buffer-file-name' etc are set to nil below,
1643 ;; because some of the hooks that could be invoked
1644 ;; (e.g., `save-place-to-alist') depend on those variables.
1645 ;;
1646 ;; Note that `kill-buffer-hook' is not what queries whether to
1647 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1648 ;; asks that itself. Thus, there's no need to temporarily do
1649 ;; `(set-buffer-modified-p nil)' before running this hook.
1651 ;; Okay, now we can end-of-life the old buffer.
1658 ;; This prevents us from finding the same buffer
1659 ;; if we specified the same file again.
1663 ;; Likewise for dired buffers.
1667 ;; This executes if find-file gets an error
1668 ;; and does not really find anything.
1669 ;; We put things back as they were.
1670 ;; If find-file actually finds something, we kill obuf below.
1679 ;; We already ran these; don't run them again.
1682 \f
1683 ;; FIXME we really need to fold the uniquify stuff in here by default,
1684 ;; not using advice, and add it to the doc string.
1686 "Create a suitably named buffer for visiting FILENAME, and return it.
1687 FILENAME (sans directory) is used unchanged if that name is free;
1688 otherwise a string <2> or <3> or ... is appended to get an unused name.
1690 Emacs treats buffers whose names begin with a space as internal buffers.
1691 To avoid confusion when visiting a file whose name begins with a space,
1698 lastname))))
1701 "Create and return a buffer with a name based on NAME.
1702 Choose the buffer's name using `generate-new-buffer-name'."
1706 "Regexp to match the automounter prefix in a directory name."
1715 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1717 home directory is a root directory) and removes automounter prefixes
1718 \(see the variable `automount-dir-prefix')."
1719 ;; Get rid of the prefixes added by the automounter.
1726 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1727 ;; To fix this right, we need a `file-name-case-sensitive-p'
1728 ;; function, but we don't have that yet, so just guess.
1731 ;; If any elt of directory-abbrev-alist matches this name,
1732 ;; abbreviate accordingly.
1738 ;; Compute and save the abbreviated homedir name.
1739 ;; We defer computing this until the first time it's needed, to
1740 ;; give time for directory-abbrev-alist to be set properly.
1741 ;; We include a slash at the end, to avoid spurious matches
1742 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1749 ;; If FILENAME starts with the abbreviated homedir,
1750 ;; make it start with `~' instead.
1752 ;; If the home dir is just /, don't change it.
1755 ;; MS-DOS root directories can come with a drive letter;
1756 ;; Novell Netware allows drive letters beyond `Z:'.
1764 filename)))
1767 "Return the buffer visiting file FILENAME (a string).
1768 This is like `get-file-buffer', except that it checks for any buffer
1769 visiting the same file, possibly under a different name.
1770 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1771 and others are ignored.
1772 If there is no such live buffer, return nil."
1785 found)
1795 ;; Verify this buffer's file number
1796 ;; still belongs to its file.
1799 attributes)
1803 found))))
1804 \f
1806 "Non-nil means file-visiting commands should handle wildcards.
1807 For example, if you specify `*.c', that would visit all the files
1808 whose names match the pattern."
1814 "Non-nil means suppress warning messages for symlinked files.
1815 When nil, Emacs prints a warning when visiting a file that is already
1816 visited, but with a different name. Setting this option to t
1817 suppresses this warning."
1823 "Maximum size of file above which a confirmation is requested.
1824 When nil, never request confirmation."
1831 "Warn if file size exceeds this percentage of available free memory.
1832 When nil, never issue warning. Beware: This probably doesn't do what you
1840 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1841 OP-TYPE specifies the file operation being performed (for message to user)."
1850 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1860 "You are trying to open a file whose size (%s)
1861 exceeds the %S%% of currently available free memory (%s).
1862 If that fails, try to open it with `find-file-literally'
1863 \(but note that some characters might be displayed incorrectly)."
1865 out-of-memory-warning-percentage
1869 "Read file FILENAME into a buffer and return the buffer.
1870 If a buffer exists visiting FILENAME, return that one, but
1871 verify that the file has not changed since visited or saved.
1872 The buffer is not selected, just returned to the caller.
1873 Optional second arg NOWARN non-nil means suppress any warning messages.
1874 Optional third arg RAWFILE non-nil means the file is read literally.
1875 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1876 and visit all the matching files. When wildcards are actually
1877 used and expanded, return a list of buffers that are visiting
1878 the various files."
1885 'find-directory-functions
1888 filename)))
1891 find-file-wildcards
1905 ;; Find any buffer for a file which has same truename.
1907 ;; Let user know if there is a buffer with the same truename.
1911 find-file-suppress-same-file-warnings
1915 ;; Optionally also find that buffer.
1918 ;; Check to see if the file looks uncommonly large.
1923 ;; We are using an existing buffer.
1930 ;; Certain files should be reverted automatically
1931 ;; if they have changed on disk and not in the buffer.
1939 found))
1949 "File %s changed on disk. Discard your edits? "
1954 "File %s changed on disk. Discard your edits in %s? "
1962 ;; Check if a formerly read-only file has become
1963 ;; writable and vice versa, but if the buffer agrees
1964 ;; with the new state of the file, that is ok too.
1974 buffer-file-name
1975 new-status new-status)))
1981 nonexistent
1982 ;; It is confusing to ask whether to visit
1983 ;; non-literally if they have the file in
1984 ;; hexl-mode or image-mode.
1990 "The file %s is already visited normally,
1991 and you have edited the buffer. Now you have asked to visit it literally,
1992 meaning no coding system handling, format conversion, or local variables.
1993 Emacs can only visit a file in one way at a time.
1995 Do you want to save the file, and visit it literally instead? "
1996 "The file %s is already visited literally,
1997 meaning no coding system handling, format conversion, or local variables.
1998 You have edited the buffer. Now you have asked to visit the file normally,
1999 but Emacs can only visit a file in one way at a time.
2006 rawfile truename number))
2010 "\
2011 Do you want to discard your changes, and visit the file literally now? "
2012 "\
2015 rawfile truename number)
2021 "The file %s is already visited normally.
2022 You have asked to visit it literally,
2023 meaning no coding system decoding, format conversion, or local variables.
2024 But Emacs can only visit a file in one way at a time.
2026 Do you want to revisit the file literally now? "
2027 "The file %s is already visited literally,
2028 meaning no coding system decoding, format conversion, or local variables.
2029 You have asked to visit it normally,
2030 but Emacs can only visit a file in one way at a time.
2035 rawfile truename number)
2038 ;; Return the buffer we are using.
2039 buf)
2040 ;; Create a new buffer.
2042 ;; find-file-noselect-1 may use a different buffer.
2044 rawfile truename number))))))
2050 ;; Needed in case we are re-visiting the file with a different
2051 ;; text representation.
2068 filename)))
2069 ;; Unconditionally set error
2079 filename)))
2080 ;; Run find-file-not-found-functions until one returns non-nil.
2082 ;; If they fail too, set error.
2084 ;; Record the file's truename, and maybe use that as visited name.
2092 ;; Set buffer's default directory to that of the file.
2094 ;; Turn off backup files for certain file names. Since
2095 ;; this is a permanent local, the major mode won't eliminate it.
2109 \f
2111 "Like `insert-file-contents', but only reads in the file literally.
2112 A buffer may be modified in several ways after reading into the buffer,
2113 to Emacs features such as format decoding, character code
2114 conversion, `find-file-hook', automatic uncompression, etc.
2116 This function ensures that none of these modifications will take place."
2122 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2123 ;; into a file operation instead!
2125 inhibit-file-name-handlers))
2132 filename)))
2133 ;; Check whether the file is uncommonly large
2144 "Insert contents of file FILENAME into buffer after point with no conversion.
2146 This function is meant for the user to run interactively.
2147 Don't call it from programs! Use `insert-file-contents-literally' instead.
2148 \(Its calling sequence is different; see its documentation)."
2154 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2155 This has the `permanent-local' property, which takes effect if you
2160 "Visit file FILENAME with no conversion of any kind.
2161 Format conversion and character code conversion are both disabled,
2162 and multibyte characters are disabled in the resulting buffer.
2163 The major mode used is Fundamental mode regardless of the file name,
2164 and local variable specifications in the file are ignored.
2165 Automatic uncompression and adding a newline at the end of the
2166 file due to `require-final-newline' is also disabled.
2168 You cannot absolutely rely on this function to result in
2169 visiting the file literally. If Emacs already has a buffer
2170 which is visiting the file, you get the existing buffer,
2171 regardless of whether it was created literally or not.
2173 In a Lisp program, if you want to be sure of accessing a file's
2174 contents literally, you should create a temporary buffer and then read
2175 the file contents into it using `insert-file-contents-literally'."
2178 "Find file literally: " nil default-directory
2181 \f
2183 _after-find-file-from-revert-buffer
2184 nomodes)
2185 "Called after finding a file and by the default revert function.
2186 Sets buffer mode, parses local variables.
2187 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2188 error in reading the file. WARN non-nil means warn if there
2189 exists an auto-save file more recent than the visited file.
2190 NOAUTO means don't mess with auto-save mode.
2191 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2192 \(see `revert-buffer-in-progress-p' for similar functionality).
2193 Fifth arg NOMODES non-nil means don't alter the file's modes.
2194 Finishes by calling the functions in `find-file-hook'
2195 unless NOMODES is non-nil."
2198 nil
2208 "Symbolic link that points to nonexistent file"
2212 ;; No need to warn if buffer is auto-saved
2213 ;; under the name of the visited file.
2215 auto-save-visited-file-name))
2218 buffer-file-name))
2238 ;; Make people do a little extra work (C-x C-q)
2239 ;; before altering a backup file.
2242 ;; When a file is marked read-only,
2243 ;; make the buffer read-only even if root is looking at it.
2251 ;; If requested, add a newline at the end of the file.
2262 view-read-only
2268 "Eval BODY and turn any error into a FORMAT message.
2269 FORMAT can have a %s escape which will be replaced with the actual error.
2270 If `debug-on-error' is set, errors are not caught, so that you can
2271 debug them.
2272 Avoid using a large BODY since it is duplicated."
2281 "Choose the major mode for this buffer automatically.
2282 Also sets up any specified local variables of the file.
2283 Uses the visited file name, the -*- line, and the local variables spec.
2285 This function is called automatically from `find-file'. In that case,
2286 we may set up the file-specified mode and local variables,
2287 depending on the value of `enable-local-variables'.
2288 In addition, if `local-enable-local-variables' is nil, we do
2289 not set local variables (though we do notice a mode specified with -*-.)
2291 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2292 or from Lisp without specifying the optional argument FIND-FILE;
2293 in that case, this function acts as if `enable-local-variables' were t."
2297 ;; FIXME this is less efficient than it could be, since both
2298 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2303 ;; Turn font lock off and on, to make sure it takes account of
2304 ;; whatever file local variables are relevant to it.
2306 ;; Font-lock-mode (now in font-core.el) can be ON when
2307 ;; font-lock.el still hasn't been loaded.
2314 "Non-nil means to try second pass through `auto-mode-alist'.
2315 This means that if the first case-sensitive search through the alist fails
2316 to find a matching major mode, a second case-insensitive search is made.
2317 On systems with case-insensitive file names, this variable is ignored,
2318 since only a single case-insensitive search through the alist is made."
2324 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2325 ;; c++-mode, java-mode and more) are added through autoload
2326 ;; directives in that file. That way is discouraged since it
2327 ;; spreads out the definition of the initial value.
2373 ;; Less common extensions come here
2374 ;; so more common ones above are found faster.
2382 ;; Besides .gdbinit, gdb documents other names to be usable for init
2383 ;; files, cross-debuggers can use something like
2384 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2385 ;; don't interfere with each other.
2387 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2388 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2389 ;; loaded when GDB reads an objfile called 'emacs'.
2397 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2421 ;; The Fortran standard does not say anything about file extensions.
2422 ;; .f90 was widely used for F90, now we seem to be trapped into
2423 ;; using a different extension for each language revision.
2424 ;; Anyway, the following extensions are supported by gfortran.
2432 ;; The list of archive file extensions should be in sync with
2433 ;; `auto-coding-alist' with `no-conversion' coding system.
2439 ;; Mailer puts message to be edited in
2440 ;; /tmp/Re.... or Message
2443 ;; some news reader is reported to use this
2456 ;; .emacs or .gnus or .viper following a directory delimiter in
2457 ;; Unix or MS-DOS syntax.
2460 ;; _emacs following a directory delimiter in MS-DOS syntax
2464 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2465 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2466 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2469 ;; .xs is also used for ld scripts, but seems to be more commonly
2470 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2472 ;; Explained in binutils ld/genscripts.sh. Eg:
2473 ;; A .x script file is the default script.
2474 ;; A .xr script is for linking without relocation (-r flag). Etc.
2478 ;; Common Lisp ASDF package system.
2485 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2497 ;; Windows candidates may be opened case sensitively on Unix
2503 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2504 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2505 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2506 ;; this has lower priority to avoid matching changelog.sgml etc.
2508 ;; either user's dot-files or under /etc or some such
2510 ;; alas not all ~/.*rc files are like this
2511 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2516 ;; this contains everything twice, with space and with colon :-(
2518 ;; Get rid of any trailing .n.m and try again.
2519 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2520 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2521 ;; Using mode nil rather than `ignore' would let the search continue
2522 ;; through this list (with the shortened name) rather than start over.
2525 ;; This should come after "in" stripping (e.g. config.h.in).
2526 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2528 ;; The following should come after the ChangeLog pattern
2529 ;; for the sake of ChangeLog.1, etc.
2530 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2532 "Alist of filename patterns vs corresponding major mode functions.
2533 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2534 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2535 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2536 mode function to use. FUNCTION will be called, unless it is nil.
2538 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2539 calling FUNCTION (if it's not nil), we delete the suffix that matched
2540 REGEXP and search the list again for another match.
2542 The extensions whose FUNCTION is `archive-mode' should also
2543 appear in `auto-coding-alist' with `no-conversion' coding system.
2545 See also `interpreter-mode-alist', which detects executable script modes
2546 based on the interpreters they specify to run,
2551 "Select Conf mode or XML mode according to start of file."
2561 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2562 ;; and pike-mode) are added through autoload directives in that
2563 ;; file. That way is discouraged since it spreads out the
2564 ;; definition of the initial value.
2593 "Alist mapping interpreter names to major modes.
2594 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2595 Each element looks like (REGEXP . MODE).
2597 the interpreter specified in the first line of a script, enable
2598 major mode MODE.
2605 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2606 ;; because we are duplicating info from auto-mode-alist.
2607 ;; TODO many elements of this list are also in auto-coding-alist.
2616 "List of regexps matching file names in which to ignore local variables.
2618 Files matching this list are typically binary file formats.
2619 They may happen to contain sequences that look like local variable
2620 specifications, but are not really, or they may be containers for
2621 member files with their own local variable sections, which are
2622 not appropriate for the containing file.
2629 "List of regexps matching suffixes to remove from file names.
2630 The function `inhibit-local-variables-p' uses this: when checking
2631 a file name, it first discards from the end of the name anything that
2634 ;; Can't think of any situation in which you'd want this to be nil...
2639 "Return non-nil if file local variables should be ignored.
2640 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2641 and `inhibit-local-variables-suffixes'. If
2642 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2651 sufs)
2656 temp))
2661 "Regexp matching interpreters, for file mode determination.
2662 This regular expression is matched against the first line of a file
2663 to determine the file's mode in `set-auto-mode'. If it matches, the file
2664 is assumed to be interpreted by the interpreter matched by the second group
2665 of the regular expression. The mode is then determined as the mode
2669 "Alist of buffer beginnings vs. corresponding major mode functions.
2670 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2671 After visiting a file, if REGEXP matches the text at the beginning of the
2672 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2673 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2674 major mode.
2676 If FUNCTION is nil, then it is not called. (That is a way of saying
2684 ;; The < comes before the groups (but the first) to reduce backtracking.
2685 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2686 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2690 comment-re "*"
2693 . html-mode)
2695 ;; These two must come after html, because they are more general:
2700 . sgml-mode)
2703 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2704 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2705 After visiting a file, if REGEXP matches the text at the beginning of the
2706 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2707 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2708 have not specified a mode for this file.
2714 "Upper limit on `magic-mode-alist' regexp matches.
2718 "Select major mode appropriate for current buffer.
2720 To find the right major mode, this function checks for a -*- mode tag
2721 checks for a `mode:' entry in the Local Variables section of the file,
2722 checks if it uses an interpreter listed in `interpreter-mode-alist',
2723 matches the buffer beginning against `magic-mode-alist',
2724 compares the filename against the entries in `auto-mode-alist',
2725 then matches the buffer beginning against `magic-fallback-mode-alist'.
2727 If `enable-local-variables' is nil, or if the file name matches
2728 `inhibit-local-variables-regexps', this function does not check
2729 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2730 is nil, then the only mode: tag that can be relevant is a -*- one.
2732 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2733 set the major mode only if that would change it. In other words
2734 we don't actually set it to the same mode the buffer already has."
2735 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2737 end done mode modes)
2738 ;; Once we drop the deprecated feature where mode: is also allowed to
2739 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2740 ;; remove this section and just let (hack-local-variables t) handle it.
2741 ;; Find a -*- mode tag.
2745 ;; Note by design local-enable-local-variables does not matter here.
2747 try-locals
2750 ;; Find all specifications for the `mode:' variable
2751 ;; and execute them left to right.
2763 modes)))
2764 ;; Simple -*-MODE-*- case.
2767 modes))))
2768 ;; If we found modes to use, invoke them now, outside the save-excursion.
2776 ;; continuing would call minor modes again, toggling them off
2778 ;; hack-local-variables checks local-enable-local-variables etc, but
2779 ;; we might as well be explicit here for the sake of clarity.
2781 enable-local-variables
2782 local-enable-local-variables
2783 try-locals
2790 ;; If we didn't, look for an interpreter specified in the first line.
2791 ;; As a special case, allow for things like "#!/bin/env perl", which
2792 ;; finds the interpreter anywhere in $PATH.
2798 ;; Map interpreter name to a mode, signaling we're done at the
2799 ;; same time.
2806 interpreter-mode-alist)
2808 ;; If we found an interpreter mode to use, invoke it now.
2810 ;; Next try matching the buffer beginning against magic-mode-alist.
2824 ;; Next compare the filename against the entries in auto-mode-alist.
2829 ;; Remove backup-suffixes from file name.
2831 ;; Remove remote file name identification.
2836 ;; Find first matching alist entry.
2839 ;; System is case-insensitive.
2843 ;; System is case-sensitive.
2845 ;; First match case-sensitively.
2849 ;; Fallback to case-insensitive match.
2863 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2880 ;; When `keep-mode-if-same' is set, we are working on behalf of
2881 ;; set-visited-file-name. In that case, if the major mode specified is the
2882 ;; same one we already have, don't actually reset it. We don't want to lose
2883 ;; minor modes such as Font Lock.
2885 "Apply MODE and return it.
2886 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2887 any aliases and compared to current major mode. If they are the
2888 same, do nothing and return nil."
2894 mode)))
2897 "Regexp of lines to skip when looking for file-local settings.
2898 If the first line matches this regular expression, then the -*-...-*- file-
2902 "Find the -*- spec in the buffer.
2903 Call with point at the place to start searching from.
2904 If one is found, set point to the beginning and return the position
2905 of the end. Otherwise, return nil; may change point.
2906 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2907 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2908 have no effect."
2911 ;; Don't look for -*- if this file name matches any
2912 ;; of the regexps in inhibit-local-variables-regexps.
2915 ;; If the file begins with "#!" (exec
2916 ;; interpreter magic), look for mode frobs
2917 ;; in the first two lines. You cannot
2918 ;; necessarily put them in the first line
2919 ;; of such a file without screwing up the
2920 ;; interpreter invocation. The same holds
2921 ;; for '\" in man pages (preprocessor
2922 ;; magic for the `man' program).
2933 end))))
2934 \f
2935 ;;; Handling file local variables
2939 file-local-variables-alist dir-local-variables-alist)
2944 "Normal hook run after processing a file's local variables specs.
2945 Major modes can use this to examine user-specified local variables
2949 "List variable-value pairs that are considered safe.
2950 Each element is a cons cell (VAR . VAL), where VAR is a variable
2951 symbol and VAL is a value that is considered safe."
2952 :risky t
2957 ;; This should be here at least as long as Emacs supports write-file-hooks.
2962 "Expressions that are considered safe in an `eval:' local variable.
2963 Add expressions to this list if you want Emacs to evaluate them, when
2964 they appear in an `eval' local variable specification, without first
2965 asking you for confirmation."
2966 :risky t
2971 ;; Risky local variables:
2974 buffer-auto-save-file-name
2975 buffer-file-name
2976 buffer-file-truename
2977 buffer-undo-list
2978 debugger
2979 default-text-properties
2980 eval
2981 exec-directory
2982 exec-path
2983 file-name-handler-alist
2984 frame-title-format
2985 global-mode-string
2986 header-line-format
2987 icon-title-format
2988 inhibit-quit
2989 load-path
2990 max-lisp-eval-depth
2991 max-specpdl-size
2992 minor-mode-map-alist
2993 minor-mode-overriding-map-alist
2994 mode-line-format
2995 mode-name
2996 overriding-local-map
2997 overriding-terminal-local-map
2998 process-environment
2999 standard-input
3000 standard-output
3001 unread-command-events))
3003 ;; Safe local variables:
3004 ;;
3005 ;; For variables defined by major modes, the safety declarations can go into
3006 ;; the major mode's file, since that will be loaded before file variables are
3007 ;; processed.
3008 ;;
3009 ;; For variables defined by minor modes, put the safety declarations in the
3010 ;; file defining the minor mode after the defcustom/defvar using an autoload
3011 ;; cookie, e.g.:
3012 ;;
3013 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3014 ;;
3015 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3016 ;; minor mode file may not be loaded yet.
3017 ;;
3018 ;; For variables defined in the C source code the declaration should go here:
3040 "Alist of file-local variable settings in the current buffer.
3041 Each element in this list has the form (VAR . VALUE), where VAR
3042 is a file-local variable (a symbol) and VALUE is the value
3043 specified. The actual value in the buffer may differ from VALUE,
3049 "Alist of directory-local variable settings in the current buffer.
3050 Each element in this list has the form (VAR . VALUE), where VAR
3051 is a directory-local variable (a symbol) and VALUE is the value
3052 specified in .dir-locals.el. The actual value in the buffer
3053 may differ from VALUE, if it is changed by the major or minor modes,
3058 "Normal hook run before setting file-local variables.
3059 It is called after checking for unsafe/risky variables and
3060 setting `file-local-variables-alist', and before applying the
3061 variables stored in `file-local-variables-alist'. A hook
3062 function is allowed to change the contents of this alist.
3064 This hook is called only if there is at least one file-local
3068 "Get confirmation before setting up local variable values.
3069 ALL-VARS is the list of all variables to be set up.
3070 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3071 RISKY-VARS is the list of those that are marked as risky.
3072 If these settings come from directory-local variables, then
3073 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3080 unsafe-vars))
3082 ;; Set up the contents of the *Local Variables* buffer.
3090 ", and variables that are risky (**)."
3098 y -- to apply the local variables list.
3102 ! -- to apply the local variables list, and permanently mark these
3114 ;; Make strings with embedded whitespace easier to read.
3122 ;; Display the buffer and read a choice.
3130 ""
3133 char)
3152 "Return local variables specified in the -*- line.
3153 Returns an alist of elements (VAR . VAL), where VAR is a variable
3154 and VAL is the specified value. Ignores any specification for
3155 `mode:' and `coding:' (which should have already been handled
3156 by `set-auto-mode' and `set-auto-coding', respectively).
3157 Return nil if the -*- line is malformed.
3159 If MODE-ONLY is non-nil, just returns the symbol specifying the
3160 mode, if there is one, otherwise nil."
3165 result)
3167 nil)
3169 ;; Simple form: "-*- MODENAME -*-".
3173 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3174 ;; (last ";" is optional).
3175 ;; If MODE-ONLY, just check for `mode'.
3176 ;; Otherwise, parse the -*- line into the RESULT alist.
3184 ;; There used to be a downcase here,
3185 ;; but the manual didn't say so,
3186 ;; and people want to set var names that aren't all lc.
3192 ;; It is traditional to ignore
3193 ;; case when checking for `mode' in set-auto-mode,
3194 ;; so we must do that here as well.
3195 ;; That is inconsistent, but we're stuck with it.
3196 ;; The same can be said for `coding' in set-auto-coding.
3206 ;; Downcase "Mode:".
3212 result))))))
3215 "Filter local variable settings, querying the user if necessary.
3216 VARIABLES is the alist of variable-value settings. This alist is
3217 filtered based on the values of `ignored-local-variables',
3218 `enable-local-eval', `enable-local-variables', and (if necessary)
3219 user interaction. The results are added to
3220 `file-local-variables-alist', without applying them.
3221 If these settings come from directory-local variables, then
3222 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3223 ;; Find those variables that we may want to save to
3224 ;; `safe-local-variable-values'.
3230 ;; Ignore any variable in `ignored-local-variables'.
3231 nil)
3232 ;; Obey `enable-local-eval'.
3236 ;; In case previously marked safe (bug#5636).
3238 ;; If not safe and e-l-v = :safe, ignore totally.
3242 safe
3244 ;; Ignore duplicates (except `mode') in the present list.
3246 ;; Accept known-safe variables.
3250 ;; The variable is either risky or unsafe:
3257 ;; Query, unless all vars are safe or user wants no querying.
3263 risky-vars dir-name))
3273 ;; TODO? Warn once per file rather than once per session?
3277 "Parse and put into effect this buffer's local variables spec.
3278 Uses `hack-local-variables-apply' to apply the variables.
3281 is specified, and return the corresponding mode symbol, or nil.
3282 In this case, we try to ignore minor-modes, and only return a
3283 major-mode.
3285 If `enable-local-variables' or `local-enable-local-variables' is nil,
3286 this function does nothing. If `inhibit-local-variables-regexps'
3287 applies to the file in question, the file is not scanned for
3288 local variables, but directory-local variables may still be applied."
3289 ;; We don't let inhibit-local-variables-p influence the value of
3290 ;; enable-local-variables, because then it would affect dir-local
3291 ;; variables. We don't want to search eg tar files for file local
3292 ;; variable sections, but there is no reason dir-locals cannot apply
3293 ;; to them. The real meaning of inhibit-local-variables-p is "do
3294 ;; not scan this file for local variables".
3297 result)
3301 ;; Note this is a no-op if enable-local-variables is nil.
3303 ;; This entire function is basically a no-op if enable-local-variables
3304 ;; is nil. All it does is set file-local-variables-alist to nil.
3306 ;; This part used to ignore enable-local-variables when mode-only
3307 ;; was non-nil. That was inappropriate, eg consider the
3308 ;; (artificial) example of:
3309 ;; (setq local-enable-local-variables nil)
3310 ;; Open a file foo.txt that contains "mode: sh".
3311 ;; It correctly opens in text-mode.
3312 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3314 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3315 ;; mode, then we're done, and have no need to scan further.
3317 mode-only))
3318 ;; Look for "Local variables:" line in last page.
3326 ;; suffix is what comes after "local variables:" in its line.
3327 ;; prefix is what comes before "local variables:" in its line.
3340 endpos
3346 nil t))
3347 ;; This used to be an error, but really all it means is
3348 ;; that this may simply not be a local-variables section,
3349 ;; so just ignore it.
3359 ;; Discard the prefix.
3364 ;; Discard the suffix.
3373 ;; Find the variable name;
3381 val val2)
3384 ;; Read the variable value.
3391 ;; Specifying minor-modes via mode: is
3392 ;; deprecated, but try to reject them anyway.
3402 :warning
3409 'eval
3413 ;; Now we've read all the local variables.
3414 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3416 ;; Otherwise, set the variables.
3421 "Apply the elements of `file-local-variables-alist'.
3422 If there are any elements, runs `before-hack-local-variables-hook',
3423 then calls `hack-one-local-variable' to apply the alist elements one by one.
3424 Finishes by running `hack-local-variables-hook', regardless of whether
3425 the alist is empty or not.
3427 Note that this function ignores a `mode' entry if it specifies the same
3428 major mode as the buffer already has."
3430 ;; Any 'evals must run in the Right sequence.
3439 "Non-nil if SYM is safe as a file-local variable with value VAL.
3440 It is safe if any of these conditions are met:
3442 * There is a matching entry (SYM . VAL) in the
3443 `safe-local-variable-values' user option.
3445 * The `safe-local-variable' property of SYM is a function that
3446 evaluates to a non-nil value with VAL as an argument."
3450 ;; If the function signals an error, that means it
3451 ;; can't assure us that the value is safe.
3455 "Non-nil if SYM could be dangerous as a file-local variable.
3456 It is dangerous if either of these conditions are met:
3458 * Its `risky-local-variable' property is non-nil.
3464 ;; If this is an alias, check the base name.
3484 "Return t if it is safe to eval EXP when it is found in a file."
3486 ;; Detect certain `put' expressions.
3493 lisp-indent-function
3494 scheme-indent-function))
3495 ;; Only allow safe values (not functions).
3500 ;; Only allow indirect form specs.
3501 ;; During bootstrapping, edebug-basic-spec might not be
3502 ;; defined yet.
3506 ;; Allow expressions that the user requested.
3508 ;; Certain functions can be allowed with safe arguments
3509 ;; or can specify verification functions to try.
3511 ;; Allow (minor)-modes calls with no arguments.
3512 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3521 ok))
3529 ok))))))))
3542 "Set local variable VAR with value VAL.
3543 If VAR is `mode', call `VAL-mode' as a function unless it's
3544 already the major mode."
3546 (`mode
3552 (`eval
3558 ;; Make sure the string has no text properties.
3559 ;; Some text properties can get evaluated in various ways,
3560 ;; so it is risky to put them on with a local variable list.
3564 \f
3565 ;;; Handling directory-local variables, aka project settings.
3571 "List of cached directory roots for directory-local variable classes.
3572 Each element in this list has the form (DIR CLASS MTIME).
3573 DIR is the name of the directory.
3574 CLASS is the name of a variable class (a symbol).
3575 MTIME is the recorded modification time of the directory-local
3576 variables file associated with this entry. This time is a list
3577 of integers (the same format as `file-attributes'), and is
3578 used to test whether the cache entry is still valid.
3579 Alternatively, MTIME can be nil, which means the entry is always
3583 "Return the variable list for CLASS."
3587 "Collect directory-local variables from MODE-VARIABLES.
3588 VARIABLES is the initial list of variables.
3589 Returns the new list."
3594 ;; If variables are specified more than once, only use the last. (Why?)
3595 ;; The pseudo-variables mode and eval are different (bug#3430).
3598 ;; Need a new cons in case we setcdr later.
3602 "Collect entries from CLASS-VARIABLES into VARIABLES.
3603 ROOT is the root directory of the project.
3604 Return the new variables list."
3606 ;; Handle non-file buffers, too.
3609 ;; FIXME: Why not use file-relative-name?
3616 ;; Don't include this in the previous condition, because we
3617 ;; want to filter all strings before the next condition.
3631 ;; TODO someone might want to extend this to allow
3632 ;; integer values for subdir, where N means
3633 ;; variables apply to this directory and N levels
3634 ;; below it (0 == nil).
3637 alist variables))))))))
3639 ;; The file's content might be invalid (e.g. have a merge conflict), but
3640 ;; that shouldn't prevent the user from opening the file.
3642 nil))))
3645 "Declare that the DIRECTORY root is an instance of CLASS.
3646 DIRECTORY is the name of a directory, a string.
3647 CLASS is the name of a project class, a symbol.
3648 MTIME is either the modification time of the directory-local
3649 variables file that defined this class, or nil.
3651 When a file beneath DIRECTORY is visited, the mode-specific
3652 variables from CLASS are applied to the buffer. The variables
3653 for a class are defined using `dir-locals-set-class-variables'."
3660 "Map the type CLASS to a list of variable settings.
3661 CLASS is the project class, a symbol. VARIABLES is a list
3662 that declares directory-local variables for the class.
3663 An element in VARIABLES is either of the form:
3664 (MAJOR-MODE . ALIST)
3665 or
3666 (DIRECTORY . LIST)
3668 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3669 whose elements are of the form (VARIABLE . VALUE).
3671 In the second form, DIRECTORY is a directory name (a string), and
3672 LIST is a list of the form accepted by the function.
3674 When a file is visited, the file's class is found. A directory
3675 may be assigned a class using `dir-locals-set-directory-class'.
3676 Then variables are set in the file's buffer according to the
3677 VARIABLES list of the class. The list is processed in order.
3679 * If the element is of the form (MAJOR-MODE . ALIST), and the
3680 buffer's major mode is derived from MAJOR-MODE (as determined
3681 by `derived-mode-p'), then all the variables in ALIST are
3682 applied. A MAJOR-MODE of nil may be used to match any buffer.
3683 `make-local-variable' is called for each variable before it is
3684 set.
3686 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3687 is an initial substring of the file's directory, then LIST is
3688 applied by recursively following these rules."
3692 "File that contains directory-local variables.
3693 It has to be constant to enforce uniform values
3697 "Find the directory-local variables for FILE.
3698 This searches upward in the directory tree from FILE.
3699 It stops at the first directory that has been registered in
3700 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3701 If it finds an entry in the cache, it checks that it is valid.
3702 A cache entry with no modification time element (normally, one that
3703 has been assigned directly using `dir-locals-set-directory-class', not
3704 set from a file) is always valid.
3705 A cache entry based on a `dir-locals-file' is valid if the modification
3706 time stored in the cache matches the current file modification time.
3707 If not, the cache entry is cleared so that the file will be re-read.
3709 This function returns either nil (no directory local variables found),
3710 or the matching entry from `dir-locals-directory-cache' (a list),
3711 or the full path to the `dir-locals-file' (a string) in the case
3712 of no valid cache entry."
3717 dir-locals-file))
3720 ;; `locate-dominating-file' may have abbreviated the name.
3723 ;; Let dir-locals-read-from-file inform us via demoted-errors
3724 ;; about unreadable files, etc.
3725 ;; Maybe we'd want to keep searching though - that is
3726 ;; a locate-dominating-file issue.
3727 ;;; (or (not (file-readable-p locals-file))
3728 ;;; (not (file-regular-p locals-file)))
3729 ;;; (setq locals-file nil))
3730 ;; Find the best cached value in `dir-locals-directory-cache'.
3741 ;; Found a potential cache entry. Check validity.
3742 ;; A cache entry with no MTIME is assumed to always be valid
3743 ;; (ie, set directly, not from a dir-locals file).
3744 ;; Note, we don't bother to check that there is a matching class
3745 ;; element in dir-locals-class-alist, since that's done by
3746 ;; dir-locals-set-directory-class.
3753 ;; This cache entry is OK.
3754 dir-elt
3755 ;; This cache entry is invalid; clear it.
3758 ;; Return the first existing dir-locals file. Might be the same
3759 ;; as dir-elt's, might not (eg latter might have been deleted).
3760 locals-file)
3761 ;; No cache entry.
3762 locals-file)))
3765 "Load a variables FILE and register a new class and instance.
3766 FILE is the name of the file holding the variables to apply.
3767 The new class name is the same as the directory in which FILE
3768 is found. Returns the new class name."
3780 class-name)))))
3783 "Non-nil means dir-local variables will be applied to remote files."
3791 "Read per-directory local variables for the current buffer.
3792 Store the directory-local variables in `dir-local-variables-alist'
3793 and `file-local-variables-alist', without applying them.
3795 This does nothing if either `enable-local-variables' or
3796 `enable-dir-local-variables' are nil."
3798 enable-dir-local-variables
3801 default-directory)))))
3802 ;; Find the variables file.
3832 "Apply directory-local variables to a non-file buffer.
3833 For non-file buffers, such as Dired buffers, directory-local
3834 variables are looked for in `default-directory' and its parent
3835 directories."
3839 \f
3842 However, the mode will not be changed if
3843 \(1) a local variables list or the `-*-' line specifies a major mode, or
3845 \ not suitable for ordinary files, or
3846 \(3) the new file name does not particularly specify any mode."
3851 "Change name of file visited in current buffer to FILENAME.
3852 This also renames the buffer to correspond to the new file.
3853 The next time the buffer is saved it will go in the newly specified file.
3854 FILENAME nil or an empty string means mark buffer as not visiting any file.
3855 Remember to delete the initial contents of the minibuffer
3856 if you wish to pass an empty string as the argument.
3858 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3859 confirmation in the case where another buffer is already visiting FILENAME.
3861 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3862 the old visited file has been renamed to the new name FILENAME."
3870 nil
3885 filename)))
3892 buffer-file-name filename)
3896 ;; If new-name == old-name, renaming would add a spurious <2>
3897 ;; and it's considered as a feature in rename-buffer.
3903 ;; Abbreviate the file names of the buffer.
3912 nil))
3913 ;; write-file-functions is normally used for things like ftp-find-file
3914 ;; that visit things that are not local files as if they were files.
3915 ;; Changing to visit an ordinary local file instead should flush the hook.
3920 ;; If buffer was read-only because of version control,
3921 ;; that reason is gone now, so make it writable.
3925 ;; Turn off backup files for certain file names.
3926 ;; Since this is a permanent local, the major mode won't eliminate it.
3928 backup-enable-predicate
3934 ;; If auto-save was not already on, turn it on if appropriate.
3938 ;; If auto save is on, start using a new name.
3939 ;; We deliberately don't rename or delete the old auto save
3940 ;; for the old visited file name. This is because perhaps
3941 ;; the user wants to save the new state and then compare with the
3942 ;; previous state from the auto save file.
3945 ;; Rename the old auto save file if any.
3952 ;; Update the major mode, if the file name determines it.
3954 ;; Don't change the mode if it is special.
3957 ;; Don't change the mode if the local variable list specifies it.
3958 ;; The file name can influence whether the local variables apply.
3960 ;; h-l-v also checks it, but might as well be explicit.
3963 ;; TODO consider making normal-mode handle this case.
3971 "Write current buffer into file FILENAME.
3972 This makes the buffer visit that file, and marks it as not modified.
3974 If you specify just a directory name as FILENAME, that means to use
3975 the default file name but in that directory. You can also yank
3976 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3978 If the buffer is not already visiting a file, the default file name
3979 for the output file is the buffer name.
3981 If optional second arg CONFIRM is non-nil, this function
3982 asks for confirmation before overwriting an existing file.
3983 Interactively, confirmation is required unless you supply a prefix argument."
3984 ;; (interactive "FWrite file: ")
3988 nil nil nil nil)
3992 default-directory)
3993 nil nil))
3997 ;; If arg is just a directory,
3998 ;; use the default file name, but in that directory.
4005 ;; NS does its own confirm dialog.
4008 use-dialog-box))
4013 ;; Make buffer writable if file is writable.
4018 ;; It's likely that the VC status at the new location is different from
4019 ;; the one at the old location.
4021 \f
4023 "Return an alist of extended attributes of file FILENAME.
4025 Extended attributes are platform-specific metadata about the file,
4026 such as SELinux context, list of ACL entries, etc."
4031 "Set extended attributes of file FILENAME to ATTRIBUTES.
4033 ATTRIBUTES must be an alist of file attributes as returned by
4034 `file-extended-attributes'."
4042 \f
4044 "Make a backup of the disk file visited by the current buffer, if appropriate.
4045 This is normally done before saving the buffer the first time.
4047 A backup may be done by renaming or by copying; see documentation of
4048 variable `make-backup-files'. If it's done by renaming, then the file is
4049 no longer accessible under its old name.
4051 The value is non-nil after a backup was made by renaming.
4052 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4053 MODES is the result of `file-modes' on the original
4054 file; this means that the caller, after saving the buffer, should change
4055 the modes of the new file to agree with the old modes.
4056 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4057 on the original file; this means that the caller, after saving
4058 the buffer, should change the extended attributes of the new file
4059 to agree with the old attributes.
4060 BACKUPNAME is the backup file name, which is the old file renamed."
4067 backup-info backupname targets setmodes)
4068 ;; If specified name is a symbolic link, chase it to the target.
4069 ;; Thus we make the backups in the directory where the real file is.
4074 ;; (if (file-directory-p buffer-file-name)
4075 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
4079 ;; If have old versions to maybe delete,
4080 ;; ask the user to confirm now, before doing anything.
4081 ;; But don't actually delete til later.
4086 real-file-name)))))
4090 ;; Actually write the back up file.
4093 ; (file-symlink-p buffer-file-name)
4094 backup-by-copying
4095 ;; Don't rename a suid or sgid file.
4108 real-file-name t))))))
4110 backupname modes
4111 extended-attributes)
4112 ;; rename-file should delete old backup.
4115 backupname)))
4117 ;; If trouble writing the backup, write it in
4118 ;; .emacs.d/%backup%.
4121 backupname)
4124 modes extended-attributes)))
4126 ;; Now delete the old versions, if desired.
4133 setmodes)
4137 ;; Create temp files with strict access rights. It's easy to
4138 ;; loosen them later, whereas it's impossible to close the
4139 ;; time-window of loose permissions otherwise.
4142 ;; Try to overwrite old backup first.
4150 nil)
4152 ;; The file was somehow created by someone else between
4153 ;; `delete-file' and `copy-file', so let's try again.
4154 ;; rms says "I think there is also a possible race
4155 ;; condition for making backup files" (emacs-devel 20070821).
4156 nil)))
4157 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4166 ;; The last ~[[:digit]]+ matches relative versions in git,
4167 ;; e.g. `foo.js.~HEAD~1~'.
4168 "Regular expression matching the backup/version part of a file name.
4172 "Return file NAME sans backup versions or strings.
4173 This is a separate procedure so your site-init or startup file can
4174 redefine it.
4175 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4176 we do not remove backup version numbers, only true file version numbers.
4177 See also `file-name-version-regexp'."
4184 name))))))
4187 "Return t if deleting FILE and rewriting it would preserve the owner.
4188 Return nil if FILE does not exist, or if deleting and recreating it
4189 might not preserve the owner. If GROUP is non-nil, check whether
4190 the group would be preserved too."
4195 ;; Return t if the file doesn't exist, since it's true that no
4196 ;; information would be lost by an (attempted) delete and create.
4199 ;; Files created on Windows by Administrator (RID=500)
4200 ;; have the Administrators group (RID=544) recorded as
4201 ;; their owner. Rewriting them will still preserve the
4202 ;; owner.
4206 ;; On BSD-derived systems files always inherit the parent
4207 ;; directory's group, so skip the group-gid test.
4213 ;; On some systems, a file created in a setuid directory
4214 ;; inherits that directory's owner.
4218 ;; On many systems, a file created in a setgid directory
4219 ;; inherits that directory's group. On some systems
4220 ;; this happens even if the setgid bit is not set.
4227 The extension, in a file name, is the part that follows the last `.',
4228 except that a leading `.', if any, doesn't count."
4231 directory)
4235 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4236 ;; we don't want to expand it.
4239 filename))))
4243 The extension, in a file name, is the part that follows the last `.',
4244 excluding version numbers and backup suffixes,
4245 except that a leading `.', if any, doesn't count.
4246 Return nil for extensionless file names such as `foo'.
4247 Return the empty string for file names such as `foo.'.
4249 If PERIOD is non-nil, then the returned value includes the period
4250 that delimits the extension, and if FILENAME has no extension,
4261 "Return the base name of the FILENAME: no directory, no extension.
4262 FILENAME defaults to `buffer-file-name'."
4267 #'make-backup-file-name--default-function
4268 "A function that `make-backup-file-name' uses to create backup file names.
4269 The function receives a single argument, the original file name.
4271 If you change this, you may need to change `backup-file-name-p' and
4272 `file-name-sans-versions' too.
4274 You could make this buffer-local to do something special for specific files.
4276 For historical reasons, a value of nil means to use the default function.
4277 This should not be relied upon.
4279 See also `backup-directory-alist'."
4286 "Alist of filename patterns and backup directory names.
4287 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4288 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4289 relative or absolute. If it is absolute, so that all matching files
4290 are backed up into the same directory, the file names in this
4291 directory will be the full name of the file backed up with all
4292 directory separators changed to `!' to prevent clashes. This will not
4293 work correctly if your filesystem truncates the resulting name.
4295 For the common case of all backups going into one directory, the alist
4297 directory name.
4299 If this variable is nil, or it fails to match a filename, the backup
4300 is made in the original file's directory.
4302 On MS-DOS filesystems without long names this variable is always
4303 ignored."
4309 "Default `backup-enable-predicate' function.
4310 Checks for files in `temporary-file-directory',
4311 `small-temporary-file-directory', and /tmp."
4313 caseless)
4314 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4315 ;; their long file-name equivalents, so compare-strings does TRT.
4319 caseless t))
4322 ;; Directory is under temporary-file-directory.
4327 ;; Directory is under /tmp.
4332 0 nil
4334 ;; Directory is under small-temporary-file-directory.
4339 "Create the non-numeric backup file name for FILE.
4340 This calls the function that `make-backup-file-name-function' specifies,
4341 with a single argument FILE."
4344 file))
4347 "Default function for `make-backup-file-name'.
4348 Normally this just returns FILE's name with `~' appended.
4349 It searches for a match for FILE in `backup-directory-alist'.
4350 If the directory for the backup doesn't exist, it is created."
4362 "Subroutine of `make-backup-file-name--default-function'.
4363 The function `find-backup-file-name' also uses this."
4365 elt backup-directory abs-backup-directory)
4370 alist nil)))
4371 ;; If backup-directory is relative, it should be relative to the
4372 ;; file's directory. By expanding explicitly here, we avoid
4373 ;; depending on default-directory.
4382 abs-backup-directory nil))))
4384 file
4388 ;; Normalize DOSish file names: downcase the drive
4389 ;; letter, if any, and replace the leading "x:" with
4390 ;; "/drive_x".
4393 ;; Replace any invalid file-name characters (for the
4394 ;; case of backing up remote files).
4398 "drive_"
4401 ""
4404 ;; Make the name unique by substituting directory
4405 ;; separators. It may not really be worth bothering about
4406 ;; doubling `!'s in the original name...
4411 backup-directory))
4416 "Return non-nil if FILE is a backup file name (numeric or not).
4417 This is a separate function so you can redefine it for customization.
4418 You may need to redefine `file-name-sans-versions' as well."
4423 ;; This is used in various files.
4424 ;; The usage of backup-extract-version-start is not very clean,
4425 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4427 "Given the name of a numeric backup file, FN, return the backup number.
4428 Uses the free variable `backup-extract-version-start', whose value should be
4429 the index in the name where the version number begins."
4436 "Find a file name for a backup file FN, and suggestions for deletions.
4437 Value is a list whose car is the name for the backup file
4438 and whose cdr is a list of old versions to consider deleting now.
4439 If the value is nil, don't make a backup.
4440 Uses `backup-directory-alist' in the same way as
4441 `make-backup-file-name--default-function' does."
4443 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4447 ;; We don't support numbered backups on plain MS-DOS
4448 ;; when long file names are unavailable.
4458 possibilities deserve-versions-p versions)
4461 base-versions
4464 possibilities)
4465 #'<)
4470 kept-old-versions
4471 kept-new-versions
4478 ;; Delete nothing if there is overflow
4479 ;; in the number of versions to keep.
4485 v))))))))))
4488 "Return number of names file FILENAME has."
4491 ;; (defun file-relative-name (filename &optional directory)
4492 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4493 ;; This function returns a relative file name which is equivalent to FILENAME
4494 ;; when used with that default directory as the default.
4495 ;; If this is impossible (which can happen on MSDOS and Windows
4496 ;; when the file name and directory use different drive names)
4497 ;; then it returns FILENAME."
4498 ;; (save-match-data
4499 ;; (let ((fname (expand-file-name filename)))
4500 ;; (setq directory (file-name-as-directory
4501 ;; (expand-file-name (or directory default-directory))))
4502 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4503 ;; ;; drive names, they can't be relative, so return the absolute name.
4504 ;; (if (and (or (eq system-type 'ms-dos)
4505 ;; (eq system-type 'cygwin)
4506 ;; (eq system-type 'windows-nt))
4507 ;; (not (string-equal (substring fname 0 2)
4508 ;; (substring directory 0 2))))
4509 ;; filename
4510 ;; (let ((ancestor ".")
4511 ;; (fname-dir (file-name-as-directory fname)))
4512 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4513 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4514 ;; (setq directory (file-name-directory (substring directory 0 -1))
4515 ;; ancestor (if (equal ancestor ".")
4516 ;; ".."
4517 ;; (concat "../" ancestor))))
4518 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4519 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4520 ;; ;; We matched within FNAME's directory part.
4521 ;; ;; Add the rest of FNAME onto ANCESTOR.
4522 ;; (let ((rest (substring fname (match-end 0))))
4523 ;; (if (and (equal ancestor ".")
4524 ;; (not (equal rest "")))
4525 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4526 ;; rest
4527 ;; (concat (file-name-as-directory ancestor) rest)))
4528 ;; ;; We matched FNAME's directory equivalent.
4529 ;; ancestor))))))
4532 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4533 This function returns a relative file name which is equivalent to FILENAME
4534 when used with that default directory as the default.
4535 If FILENAME is a relative file name, it will be interpreted as existing in
4536 `default-directory'.
4537 If FILENAME and DIRECTORY lie on different machines or on different drives
4538 on a DOS/Windows machine, it returns FILENAME in expanded form."
4542 default-directory))))
4547 read-file-name-completion-ignore-case)))
4550 ;; Test for different filesystems on DOS/Windows
4552 ;; Should `cygwin' really be included here? --stef
4555 ;; Test for different drive letters
4557 ;; Test for UNCs on different servers
4562 ;; Windows file names cannot have ? in
4563 ;; them, so use that to detect when
4564 ;; neither FILENAME nor DIRECTORY is a
4565 ;; UNC.
4567 0 nil
4573 ;; Test for different remote file system identification
4575 filename
4583 ".."
4585 ;; Now ancestor is empty, or .., or ../.., etc.
4587 ;; We matched within FILENAME's directory part.
4588 ;; Add the rest of FILENAME onto ANCESTOR.
4591 ;; But don't bother with ANCESTOR if it would give us `./'.
4592 rest
4594 ;; We matched FILENAME's directory equivalent.
4595 ancestor))))))
4596 \f
4598 "Save current buffer in visited file if modified.
4599 Variations are described below.
4601 By default, makes the previous version into a backup file
4602 if previously requested or if this is the first save.
4604 to become a backup when the next save is done.
4606 unconditionally makes the previous version into a backup file.
4608 to become a backup when the next save is done,
4609 and unconditionally makes the previous version into a backup file.
4611 With a numeric prefix argument of 0, never make the previous version
4612 into a backup file.
4614 If a file's name is FOO, the names of its numbered backup versions are
4615 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4616 Numeric backups (rather than FOO~) will be made if value of
4617 `version-control' is not the atom `never' and either there are already
4618 numeric versions of the file being backed up, or `version-control' is
4619 non-nil.
4620 We don't want excessive versions piling up, so there are variables
4621 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4622 and `kept-new-versions', which tells how many newest versions to keep.
4623 Defaults are 2 old versions and 2 new.
4624 `dired-kept-versions' controls dired's clean-directory (.) command.
4625 If `delete-old-versions' is nil, system will query user
4626 before trimming versions. Otherwise it does it silently.
4628 If `vc-make-backup-files' is nil, which is the default,
4629 no backup files are made for files managed by version control.
4630 (This is because the version control system itself records previous versions.)
4632 See the subroutine `basic-save-buffer' for more information."
4638 ;; We used to display the message below only for files > 50KB, but
4639 ;; then Rmail-mbox never displays it due to buffer swapping. If
4640 ;; the test is ever re-introduced, be sure to handle saving of
4641 ;; Rmail files.
4648 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4649 Normally delete only if the file was written by this Emacs since
4650 the last real save, but optional arg FORCE non-nil means delete anyway."
4664 "Normal hook that is run before a buffer is saved to its file."
4670 "Normal hook that is run after a buffer is saved to its file."
4676 "If non-nil, use this coding system for saving the buffer.
4677 More precisely, use this coding system in place of the
4678 value of `buffer-file-coding-system', when saving the buffer.
4679 Calling `write-region' for any purpose other than saving the buffer
4680 will still use `buffer-file-coding-system'; this variable has no effect
4687 "Save the current buffer in its visited file, if it has been modified.
4688 The hooks `write-contents-functions' and `write-file-functions' get a chance
4689 to do the job of saving; if they do not, then the buffer is saved in
4690 the visited file in the usual way.
4691 Before and after saving the buffer, this function runs
4692 `before-save-hook' and `after-save-hook', respectively."
4695 ;; In an indirect buffer, save its base buffer instead.
4699 ;; handle the case when no modification has been made but
4700 ;; the file disappeared since visited
4704 setmodes)
4705 ;; If buffer has no file name, ask user for one.
4713 ;; Signal an error if the user specified the name of an
4714 ;; existing directory.
4717 filename))
4724 "%s has changed since visited or saved. Save anyway? "
4744 ;; Support VC version backups.
4746 ;; Don't let errors prevent saving the buffer.
4751 ;; If a hook returned t, file is already "written".
4752 ;; Otherwise, write it the usual way now.
4761 ;; Now we have saved the current buffer. Let's make sure
4762 ;; that buffer-file-coding-system is fixed to what
4763 ;; actually used for saving by binding it locally.
4778 ;; If the auto-save file was recent before this command,
4779 ;; delete it now.
4781 ;; Support VC `implicit' locking.
4786 ;; This does the "real job" of writing a buffer into its visited file
4787 ;; and making a backup file. This is what is normally done
4788 ;; but inhibited if one of write-file-functions returns non-nil.
4789 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4790 ;; backup-buffer.
4800 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4801 ;; backup-buffer.
4814 "File %s is write-protected; try to save anyway? "
4816 buffer-file-name)))
4831 ;; Write temp name, then rename it.
4832 ;; This requires write access to the containing dir,
4833 ;; which is why we don't try it if we don't have that access.
4835 tempname succeed
4838 ;; Create temp files with strict access rights. It's easy to
4839 ;; loosen them later, whereas it's impossible to close the
4840 ;; time-window of loose permissions otherwise.
4845 ;; Try various temporary names.
4846 ;; This code follows the example of make-temp-file,
4847 ;; but it calls write-region in the appropriate way
4848 ;; for saving the buffer.
4854 ;; Pass in nil&nil rather than point-min&max
4855 ;; cause we're saving the whole buffer.
4856 ;; write-region-annotate-functions may use it.
4858 tempname nil realname
4860 nil)
4862 ;; The file was somehow created by someone else between
4863 ;; `make-temp-name' and `write-region', let's try again.
4864 nil)
4866 ;; Reset the umask.
4868 ;; If we failed, restore the buffer's modtime.
4871 ;; Since we have created an entirely new file,
4872 ;; make sure it gets the right permission bits set.
4877 buffer-file-name)))
4878 ;; We succeeded in writing the temp file,
4879 ;; so rename it.
4881 ;; If file not writable, see if we can make it writable
4882 ;; temporarily while we write it.
4883 ;; But no need to do so if we have just backed it up
4884 ;; (setmodes is set) because that says we're superseding.
4886 ;; Change the mode back, after writing.
4889 buffer-file-name))
4890 ;; If set-file-extended-attributes fails, fall back on
4891 ;; set-file-modes.
4901 ;; Pass in nil&nil rather than point-min&max to indicate
4902 ;; we're saving the buffer rather than just a region.
4903 ;; write-region-annotate-functions may make us of it.
4905 buffer-file-name nil t buffer-file-truename)
4907 ;; If we get an error writing the new file, and we made
4908 ;; the backup by renaming, undo the backing-up.
4913 setmodes))
4919 `((?\C-r
4926 ;; Return nil to ask about BUF again.
4927 nil)
4940 ;; Return nil to ask about BUF again.
4941 nil)
4951 "Save some modified file-visiting buffers. Asks user about each one.
4952 You can answer `y' to save, `n' not to save, `C-r' to look at the
4953 buffer in question with `view-buffer' before deciding or `d' to
4954 view the differences using `diff-buffer-with-file'.
4956 This command first saves any buffers where `buffer-save-without-query' is
4957 non-nil, without asking.
4959 Optional argument (the prefix) non-nil means save all with no questions.
4960 Optional second argument PRED determines which buffers are considered:
4961 If PRED is nil, all the file-visiting buffers are considered.
4962 If PRED is t, then certain non-file buffers will also be considered.
4963 If PRED is a zero-argument function, it indicates for each buffer whether
4964 to consider it or not when called with that buffer current.
4966 See `save-some-buffers-action-alist' if you want to
4967 change the additional actions you can take on files."
4971 files-done abbrevs-done)
4973 ;; First save any buffers that we're supposed to save unconditionally.
4974 ;; That way the following code won't ask about them.
4979 ;; Ask about those buffers that merit it,
4980 ;; and record the number thus saved.
4984 ;; Note that killing some buffers may kill others via
4985 ;; hooks (e.g. Rmail and its viewing buffer).
4998 t
5010 save-some-buffers-action-alist))
5011 ;; Maybe to save abbrevs, and record whether
5012 ;; we either saved them or asked to.
5019 ;; Don't keep bothering user if he says no.
5032 \f
5034 "Clear out records of last mod time of visited file.
5035 Next attempt to save will certainly not complain of a discrepancy."
5039 "Mark current buffer as unmodified, not needing to be saved.
5042 It is not a good idea to use this function in Lisp programs, because it
5043 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5051 "Change whether this buffer is read-only."
5059 "Insert contents of file FILENAME into buffer after point.
5060 Set mark after the inserted text.
5062 This function is meant for the user to run interactively.
5063 Don't call it from programs! Use `insert-file-contents' instead.
5064 \(Its calling sequence is different; see its documentation)."
5070 "Append the contents of the region to the end of file FILENAME.
5071 When called from a function, expects three arguments,
5072 START, END and FILENAME. START and END are normally buffer positions
5073 specifying the part of the buffer to write.
5074 If START is nil, that means to use the entire buffer contents.
5075 If START is a string, then output that string to the file
5076 instead of any buffer contents; END is ignored.
5078 This does character code conversion and applies annotations
5079 like `write-region' does."
5084 "Return most recent backup file for FILENAME or nil if no backups exist."
5085 ;; `make-backup-file-name' will get us the right directory for
5086 ;; ordinary or numeric backups. It might create a directory for
5087 ;; backups as a side-effect, according to `backup-directory-alist'.
5094 tem)
5103 newest))
5106 "Rename current buffer to a similar name not already taken.
5107 This function is useful for creating multiple shell process buffers
5108 or multiple mail buffers, etc.
5110 Note that some commands, in particular those based on `compilation-mode'
5111 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5112 appropriate mode even if it has been renamed. So as well as renaming
5113 the buffer, you also need to switch buffers before running another
5114 instance of such commands."
5122 ;; If the existing buffer name has a <NNN>,
5123 ;; which isn't part of the file name (if any),
5124 ;; then get rid of that.
5130 "Create the directory DIR and optionally any nonexistent parent dirs.
5131 If DIR already exists as a directory, signal an error, unless
5132 PARENTS is non-nil.
5134 Interactively, the default choice of directory to create is the
5135 current buffer's default directory. That is useful when you have
5136 visited a file in a nonexistent directory.
5138 Noninteractively, the second (optional) argument PARENTS, if
5139 non-nil, says whether to create parent directories that don't
5140 exist. Interactively, this happens by default.
5142 If creating the directory or directories fail, an error will be
5143 raised."
5146 nil nil)
5147 t))
5148 ;; If default-directory is a remote directory,
5149 ;; make sure we find its make-directory handler.
5157 create-list)
5159 ;; If directory is its own parent, then we can't
5160 ;; keep looping forever
5175 "Delete the directory named DIRECTORY. Does not follow symlinks.
5176 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5177 TRASH non-nil means to trash the directory instead, provided
5178 `delete-by-moving-to-trash' is non-nil.
5180 When called interactively, TRASH is t if no prefix argument is
5181 given. With a prefix argument, TRASH is nil."
5188 "Move directory to trash: "
5190 default-directory default-directory nil nil))))
5196 nil)
5198 ;; If default-directory is a remote directory, make sure we find its
5199 ;; delete-directory handler.
5206 ;; Only move non-empty dir to trash if recursive deletion was
5207 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5208 ;; case, where the operation fails in delete-directory-internal.
5209 ;; As `move-file-to-trash' trashes directories (empty or
5210 ;; otherwise) as a unit, we do not need to recurse here.
5212 ;; Check if directory is empty apart from "." and "..".
5217 ;; Otherwise, call ourselves recursively if needed.
5221 ;; This test is equivalent to
5222 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5223 ;; but more efficient
5227 ;; We do not want to delete "." and "..".
5233 "Return non-nil if files FILE1 and FILE2 name the same file.
5234 If FILE1 or FILE2 does not exist, the return value is unspecified."
5245 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5247 Return nil if DIR is not an existing directory."
5269 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5270 This function always sets the file modes of the output files to match
5271 the corresponding input file.
5273 The third arg KEEP-TIME non-nil means give the output files the same
5274 last-modified time as the old ones. (This works on only some systems.)
5276 A prefix arg makes KEEP-TIME non-nil.
5278 Noninteractively, the last argument PARENTS says whether to
5279 create parent directories if they don't exist. Interactively,
5280 this happens by default.
5282 If NEWNAME names an existing directory, copy DIRECTORY as a
5283 subdirectory there. However, if called from Lisp with a non-nil
5284 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5285 directly into NEWNAME instead."
5292 default-directory default-directory nil nil)
5293 current-prefix-arg t nil)))
5296 directory newname))
5297 ;; If default-directory is a remote directory, make sure we find its
5298 ;; copy-directory handler.
5303 newname keep-time parents copy-contents)
5305 ;; Compute target name.
5310 ;; If NEWNAME is not an existing directory, create it;
5311 ;; that is where we will copy the files of DIRECTORY.
5313 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5314 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5319 newname))
5323 newname))
5326 ;; Copy recursively.
5328 ;; We do not want to copy "." and "..".
5330 directory-files-no-dot-files-regexp))
5340 ;; Set directory attributes.
5346 \f
5347 ;; At time of writing, only info uses this.
5349 "Return a copy of DIRS with all non-existent directories removed.
5350 The optional argument KEEP is a list of directories to retain even if
5351 they don't exist, and REJECT is a list of directories to remove from
5352 DIRS, even if they exist; REJECT takes precedence over KEEP.
5354 Note that membership in REJECT and KEEP is checked using simple string
5355 comparison."
5361 dirs)))
5363 \f
5366 "Function to use to revert this buffer.
5367 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5368 which are the arguments that `revert-buffer' received.
5369 It also has access to the `preserve-modes' argument of `revert-buffer'
5370 via the `revert-buffer-preserve-modes' dynamic variable.
5372 For historical reasons, a value of nil means to use the default function.
5377 #'revert-buffer-insert-file-contents--default-function
5378 "Function to use to insert contents when reverting this buffer.
5379 The function receives two arguments: the first the nominal file name to use;
5380 the second is t if reading the auto-save file.
5382 The function is responsible for updating (or preserving) point.
5384 For historical reasons, a value of nil means to use the default function.
5388 "Default function to use for `buffer-stale-function'.
5389 This function ignores its argument.
5390 This returns non-nil if the current buffer is visiting a readable file
5391 whose modification time does not match that of the buffer.
5393 This function only handles buffers that are visiting files.
5394 Non-file buffers need a custom function"
5400 "Function to check whether a buffer needs reverting.
5401 This should be a function with one optional argument NOCONFIRM.
5402 Auto Revert Mode passes t for NOCONFIRM. The function should return
5403 non-nil if the buffer should be reverted. A return value of
5404 `fast' means that the need for reverting was not checked, but
5405 that reverting the buffer is fast. The buffer is current when
5406 this function is called.
5408 The idea behind the NOCONFIRM argument is that it should be
5409 non-nil if the buffer is going to be reverted without asking the
5410 user. In such situations, one has to be careful with potentially
5411 time consuming operations.
5413 For historical reasons, a value of nil means to use the default function.
5414 This should not be relied upon.
5416 For more information on how this variable is used by Auto Revert mode,
5420 "Normal hook for `revert-buffer' to run before reverting.
5421 The function `revert-buffer--default' runs this.
5425 "Normal hook for `revert-buffer' to run after reverting.
5426 Note that the hook value that it runs is the value that was in effect
5427 before reverting; that makes a difference if you have buffer-local
5428 hook functions.
5430 The function `revert-buffer--default' runs this.
5438 ;; `revert-buffer-function' was defined long ago to be a function of only
5439 ;; 2 arguments, so we have to use a dynbind variable to pass the
5440 ;; `preserve-modes' argument of `revert-buffer'.
5444 "Replace current buffer text with the text of the visited file on disk.
5445 This undoes all changes since the file was visited or saved.
5446 With a prefix argument, offer to revert from latest auto-save file, if
5447 that is more recent than the visited file.
5449 This command also implements an interface for special buffers
5450 that contain text which doesn't come from a file, but reflects
5451 some other data instead (e.g. Dired buffers, `buffer-list'
5452 buffers). This is done via the variable `revert-buffer-function'.
5453 In these cases, it should reconstruct the buffer contents from the
5454 appropriate data.
5456 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5457 to revert from the auto-save file when this is nil. Note that the
5458 sense of this argument is the reverse of the prefix argument, for the
5459 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5460 to nil.
5462 Optional second argument NOCONFIRM means don't ask for confirmation
5463 at all. (The variable `revert-without-query' offers another way to
5464 revert buffers without querying for confirmation.)
5466 Optional third argument PRESERVE-MODES non-nil means don't alter
5467 the files modes. Normally we reinitialize them using `normal-mode'.
5469 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5471 This function calls the function that `revert-buffer-function' specifies
5472 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5473 The default function runs the hooks `before-revert-hook' and
5474 `after-revert-hook'."
5475 ;; I admit it's odd to reverse the sense of the prefix argument, but
5476 ;; there is a lot of code out there which assumes that the first
5477 ;; argument should be t to avoid consulting the auto-save file, and
5478 ;; there's no straightforward way to encourage authors to notice a
5479 ;; reversal of the argument sense. So I'm just changing the user
5480 ;; interface, but leaving the programmatic interface the same.
5485 ignore-auto noconfirm)))
5488 "Default function for `revert-buffer'.
5489 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5490 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5491 start and end.
5493 Calls `revert-buffer-insert-file-contents-function' to reread the
5494 contents of the visited file, with two arguments: the first is the file
5495 name, the second is non-nil if reading an auto-save file.
5497 This function only handles buffers that are visiting files.
5498 Non-file buffers need a custom function."
5503 buffer-auto-save-file-name
5508 buffer-auto-save-file-name
5509 buffer-file-name)))
5519 file-name)))
5521 ;; If file was backed up but has changed since,
5522 ;; we should make another backup.
5526 ;; Effectively copy the after-revert-hook status,
5527 ;; since after-find-file will clobber it.
5530 after-revert-hook))
5532 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5536 file-name auto-save-p)
5537 ;; Recompute the truename in case changes in symlinks
5538 ;; have changed the truename.
5542 ;; Run after-revert-hook as it was before we reverted.
5546 local-hook)
5549 t)))))
5552 "Default function for `revert-buffer-insert-file-contents-function'.
5553 The function `revert-buffer--default' calls this.
5554 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5555 an auto-save file."
5559 "File %s no longer exists!"
5561 file-name))
5564 "File %s no longer readable!"
5566 file-name))
5568 ;; Bind buffer-file-name to nil
5569 ;; so that we don't try to lock the file.
5575 ;; Auto-saved file should be read by Emacs's
5576 ;; internal coding.
5580 buffer-file-coding-system-explicit
5583 coding-system-for-read
5585 coding-system-for-read)
5587 ;; As a coding system suitable for multibyte
5588 ;; buffer is specified, make the current
5589 ;; buffer multibyte.
5592 ;; This force after-insert-file-set-coding
5593 ;; (called from insert-file-contents) to set
5594 ;; buffer-file-coding-system to a proper value.
5597 ;; Note that this preserves point in an intelligent way.
5601 nil nil t))
5603 nil nil t))))))
5606 "Recover the visited file--get contents from its last auto-save file."
5611 "Visit file FILE, but get contents from its last auto-save file."
5612 ;; Actually putting the file name in the minibuffer should be used
5613 ;; only rarely.
5614 ;; Not just because users often use the default.
5627 "*Directory*" nil
5638 ;; Use insert-directory-safely, not insert-directory,
5639 ;; because these files might not exist. In particular,
5640 ;; FILE might not exist if the auto-save file was for
5641 ;; a buffer that didn't visit a file, such as "*mail*".
5642 ;; The code in v20.x called `ls' directly, so we need
5643 ;; to emulate what `ls' did in that case.
5648 ;; Keep the current buffer-file-coding-system.
5650 ;; Auto-saved file should be read with special coding.
5659 "Recover auto save files from a previous Emacs session.
5660 This command first displays a Dired buffer showing you the
5661 previous sessions that you could recover from.
5662 To choose one, move point to the proper line and then type C-c C-c.
5663 Then you'll be asked about a number of files to recover."
5673 auto-save-list-file-prefix)))
5674 t)
5685 ;; Each line starts with a space
5686 ;; so that Font Lock mode won't highlight the first character.
5689 " To delete a session file, type \
5695 "Choose one saved session to recover auto-save files from.
5696 This command is used in the special Dired buffer created by
5699 ;; Get the name of the session file to recover from.
5701 files
5707 ;; Read in the auto-save-list file.
5710 ;; Loop thru the text of that file
5711 ;; and get out the names of the files to recover.
5715 ;; This is a pair of lines for a non-file-visiting buffer.
5716 ;; Get the auto-save file name and manufacture
5717 ;; a "visited file name" from that.
5720 ;; If there is no auto-save file name, the
5721 ;; auto-save-list file is probably corrupted.
5734 ;; This pair of lines is a file-visiting
5735 ;; buffer. Use the visited file name.
5745 ;; Ignore a file if its auto-save file does not exist now.
5749 ;; The file contains a pair of line for each auto-saved buffer.
5750 ;; The first line of the pair contains the visited file name
5751 ;; or is empty if the buffer was not visiting a file.
5752 ;; The second line is the auto-save file name.
5760 files
5766 "Kill BUFFER if confirmed."
5774 "Kill some buffers. Asks the user whether to kill each one of them.
5775 Non-interactively, if optional argument LIST is non-nil, it
5776 specifies the list of buffers to kill, asking for approval for each one."
5784 ; if we killed the base buffer.
5791 "Kill buffers whose name matches the specified REGEXP.
5792 The optional second argument indicates whether to kill internal buffers too."
5801 \f
5803 "Adjust current buffer's auto save file name for current conditions.
5804 Also rename any existing auto save file, if it was made in this session."
5816 "Return file name to use for auto-saves of current buffer.
5817 Does not consider `auto-save-visited-file-name' as that variable is checked
5818 before calling this function. You can redefine this for customization.
5819 See also `auto-save-file-name-p'."
5827 result uniq)
5828 ;; Apply user-specified translations
5829 ;; to the file name.
5833 filename)
5843 filename))))
5848 ;; We truncate the file name to DOS 8+3 limits
5849 ;; before doing anything else, because the regexp
5850 ;; passed to string-match below cannot handle
5851 ;; extensions longer than 3 characters, multiple
5852 ;; dots, and other atrocities.
5857 fn)
5862 "#"
5865 ;; Make sure auto-save file names don't contain characters
5866 ;; invalid for the underlying filesystem.
5868 ;; Don't modify remote (ange-ftp) filenames
5871 result))))
5873 ;; Deal with buffers that don't have any associated files. (Mail
5874 ;; mode tends to create a good number of these.)
5878 file-name)
5879 ;; Restrict the characters used in the file name to those which
5880 ;; are known to be safe on all filesystems, url-encoding the
5881 ;; rest.
5882 ;; We do this on all platforms, because even if we are not
5883 ;; running on DOS/Windows, the current directory may be on a
5884 ;; mounted VFAT filesystem, such as a USB memory stick.
5888 ;; For multibyte characters, this will produce more than
5889 ;; 2 hex digits, so is not true URL encoding.
5893 ;; Generate the file name.
5899 ;; Try a few alternative directories, to get one we can
5900 ;; write it.
5906 ;; Don't modify remote (ange-ftp) filenames
5908 ;; The call to convert-standard-filename is in case
5909 ;; buffer-name includes characters not allowed by the
5910 ;; DOS/Windows filesystems. make-temp-file writes to the
5911 ;; file it creates, so we must fix the file name _before_
5912 ;; make-temp-file is called.
5914 fname))
5916 ;; make-temp-file creates the file,
5917 ;; but we don't want it to exist until we do an auto-save.
5921 file-name)))
5924 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5925 FILENAME should lack slashes. You can redefine this for customization."
5927 \f
5929 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5930 The generated regexp will match a filename only if the filename
5931 matches that wildcard according to shell rules. Only wildcards known
5932 by `sh' are supported."
5934 ;; Copy the initial run of non-special characters.
5937 ;; If no special characters, we're almost done.
5941 j)
5943 result
5964 ;; Found "[^". Insert a `\0' character
5965 ;; (which cannot happen in a filename)
5966 ;; into the character class, so that `^'
5967 ;; is not the first character after `[',
5968 ;; and thus non-special in a regexp.
5973 ;; I don't think `]' can appear in a
5974 ;; character class in a wildcard, but
5975 ;; let's be general here.
5982 i
5995 ;; Shell wildcards should match the entire filename,
5996 ;; not its part. Make the regexp say so.
5998 \f
6001 "Switches for `list-directory' to pass to `ls' for brief listing."
6007 "Switches for `list-directory' to pass to `ls' for verbose listing."
6012 "Expand wildcard pattern PATTERN.
6013 This returns a list of file names which match the pattern.
6015 If PATTERN is written as an absolute file name,
6016 the values are absolute also.
6018 If PATTERN is written as a relative file name, it is interpreted
6019 relative to the current default directory, `default-directory'.
6020 The file names returned are normally also relative to the current
6021 default directory. However, if FULL is non-nil, they are absolute."
6025 ;; A list of all dirs that DIRPART specifies.
6026 ;; This can be more than one dir
6027 ;; if DIRPART contains wildcards.
6031 dirpart)))
6035 contents)
6040 ;; Filter out "." and ".."
6045 name))
6052 this-dir-contents)
6053 this-dir-contents)
6054 contents)))))
6055 contents)))
6057 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6061 "Display a list of files in or matching DIRNAME, a la `ls'.
6062 DIRNAME is globbed by the shell if necessary.
6063 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6064 Actions controlled by variables `list-directory-brief-switches'
6065 and `list-directory-verbose-switches'."
6069 nil default-directory nil)
6070 pfx)))
6072 list-directory-brief-switches))
6073 buffer)
6085 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6093 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6095 PATTERN is assumed to represent a file-name wildcard suitable for the
6096 underlying filesystem. For Unix and GNU/Linux, each character from the
6098 the parts of the pattern which don't include wildcard characters are
6099 quoted with double quotes.
6102 on Windows), so PATTERN can use them to quote wildcard characters that
6103 need to be passed verbatim to shell commands."
6107 ;; DOS/Windows don't allow `"' in file names. So if the
6108 ;; argument has quotes, we can safely assume it is already
6109 ;; quoted by the caller.
6111 ;; We quote [&()#$'] in case their shell is a port of a
6112 ;; Unixy shell. We quote [,=+] because stock DOS and
6113 ;; Windows shells require that in some cases, such as
6114 ;; passing arguments to batch files that use positional
6115 ;; arguments like %1.
6117 pattern
6120 end)
6137 pattern))))
6144 "Program to get the amount of free space on a file system.
6145 We assume the output has the format of `df'.
6146 The value of this variable must be just a command name or file name;
6147 if you want to specify options, use `directory-free-space-args'.
6149 A value of nil disables this feature.
6151 If the function `file-system-info' is defined, it is always used in
6152 preference to the program given by this variable."
6158 "Options to use when running `directory-free-space-program'."
6163 "Return the amount of free space on directory DIR's file system.
6164 The return value is a string describing the amount of free
6165 space (normally, the number of free 1KB blocks).
6167 This function calls `file-system-info' if it is available, or
6168 invokes the program specified by `directory-free-space-program'
6169 and `directory-free-space-args'. If the system call or program
6170 is unsuccessful, or if DIR is a remote directory, this function
6171 returns nil."
6173 ;; Try to find the number of free blocks. Non-Posix systems don't
6174 ;; always have df, but might have an equivalent system call.
6183 ;; Avoid failure if the default directory does
6184 ;; not exist (Bug#2631, Bug#3911).
6188 nil t nil
6189 directory-free-space-args
6192 ;; Assume that the "available" column is before the
6193 ;; "capacity" column. Find the "%" and scan backward.
6197 "[[:space:]]+[^[:space:]]+%[^%]*$"
6204 ;; The following expression replaces `dired-move-to-filename-regexp'.
6208 ;; In some locales, month abbreviations are as short as 2 letters,
6209 ;; and they can be followed by ".".
6210 ;; In Breton, a month name can include a quote character.
6223 s "+"
6226 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6227 ;; omits the Kanji characters after month and day-of-month.
6228 ;; On Mac OS X 10.3, the date format in East Asian locales is
6229 ;; day-of-month digits followed by month digits.
6235 ;; The "[0-9]" below requires the previous column to end in a digit.
6236 ;; This avoids recognizing `1 may 1997' as a date in the line:
6237 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6239 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6241 ;; For non-iso date formats, we add the ".*" in order to find
6242 ;; the last possible match. This avoids recognizing
6243 ;; `jservice 10 1024' as a date in the line:
6244 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6246 ;; vc dired listings provide the state or blanks between file
6247 ;; permissions and date. The state is always surrounded by
6248 ;; parentheses:
6249 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6250 ;; This is not supported yet.
6255 "Regular expression to match up to the file name in a directory listing.
6256 The default value is designed to recognize dates and times
6261 ;; insert-directory
6262 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6263 ;; FULL-DIRECTORY-P is nil.
6264 ;; The single line of output must display FILE's name as it was
6265 ;; given, namely, an absolute path name.
6266 ;; - must insert exactly one line for each file if WILDCARD or
6267 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6268 ;; before the file lines, plus optional text after the file lines.
6269 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6270 ;; allowed.
6271 ;; File lines should display the basename.
6272 ;; - must be consistent with
6273 ;; - functions dired-move-to-filename, (these two define what a file line is)
6274 ;; dired-move-to-end-of-filename,
6275 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6276 ;; dired-insert-headerline
6277 ;; dired-after-subdir-garbage (defines what a "total" line is)
6278 ;; - variable dired-subdir-regexp
6279 ;; - may be passed "--dired" as the first argument in SWITCHES.
6280 ;; Filename handlers might have to remove this switch if their
6281 ;; "ls" command does not support it.
6283 "Insert directory listing for FILE, formatted according to SWITCHES.
6284 Leaves point after the inserted text.
6285 SWITCHES may be a string of options, or a list of strings
6286 representing individual options.
6287 Optional third arg WILDCARD means treat FILE as shell wildcard.
6288 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6289 switches do not contain `d', so that a full listing is expected.
6291 This works by running a directory listing program
6292 whose name is in the variable `insert-directory-program'.
6293 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6295 When SWITCHES contains the long `--dired' option, this function
6296 treats it specially, for the sake of dired. However, the
6297 normally equivalent short `-D' option is just passed on to
6298 `insert-directory-program', as any other option."
6299 ;; We need the directory in order to find the right handler.
6304 wildcard full-directory-p)
6307 ;; Read the actual directory using `insert-directory-program'.
6308 ;; RESULT gets the status code.
6310 ;; putting text property `dired-filename, decode one
6311 ;; bunch by one to preserve that property.
6313 ;; This is to control encoding the arguments in call-process.
6317 default-file-name-coding-system))))
6320 ;; Run ls in the directory part of the file pattern
6321 ;; using the last component as argument.
6327 ;; NB since switches is passed to the shell, be
6328 ;; careful of malicious values, eg "-l;reboot".
6329 ;; See eg dired-safe-switches-p.
6331 shell-file-name nil t nil
6332 "-c"
6334 ""
6336 insert-directory-program
6337 " -d "
6339 switches
6341 " -- "
6342 ;; Quote some characters that have
6343 ;; special meanings in shells; but
6344 ;; don't quote the wildcards--we want
6345 ;; them to be special. We also
6346 ;; currently don't quote the quoting
6347 ;; characters in case people want to
6348 ;; use them explicitly to quote
6349 ;; wildcard characters.
6351 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6352 ;; directory if FILE is a symbolic link.
6360 insert-directory-program nil t nil
6364 ;; Split the switches at any spaces so we can
6365 ;; pass separate options as separate args.
6367 ;; Avoid lossage if FILE starts with `-'.
6375 file))))))))
6377 ;; If we got "//DIRED//" in the output, it means we got a real
6378 ;; directory listing, even if `ls' returned nonzero.
6379 ;; So ignore any errors.
6392 ;; The first time ls returns an error,
6393 ;; find the version numbers of ls,
6394 ;; and set insert-directory-ls-version
6395 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6396 ;; is equal or if the info cannot be obtained.
6397 ;; (That can mean it isn't GNU ls.)
6407 comparison)
6423 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6427 ;; If `insert-directory-program' failed, signal an error.
6429 ;; Delete the error message it may have output.
6431 ;; On non-Posix systems, we cannot open a directory, so
6432 ;; don't even try, because that will always result in
6433 ;; the ubiquitous "Access denied". Instead, show the
6434 ;; command line so the user can try to guess what went wrong.
6439 insert-directory-program
6441 file result)
6442 ;; Unix. Access the file to get a suitable error.
6449 ;; The following overshoots by one line for an empty
6450 ;; directory listed with "--dired", but without "-a"
6451 ;; switch, where the ls output contains a
6452 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6453 ;; We take care of that case later.
6461 error-lines)
6462 ;; Find all the lines that are error messages,
6463 ;; and record the bounds of each one.
6470 ;; Now read the numeric positions of file names.
6477 error-lines))
6480 error-lines)))
6482 ;; End is followed by \n or by " -> ".
6484 ;; It seems that we can't trust ls's output as to
6485 ;; byte positions of filenames.
6491 ;; Take care of the case where the ls output contains a
6492 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6493 ;; and we went one line too far back (see above).
6498 ;; Now decode what read if necessary.
6500 file-name-coding-system
6501 default-file-name-coding-system
6503 coding-no-eol
6504 val pos)
6508 ;; If no coding system is specified or detection is
6509 ;; requested, detect the coding.
6523 ;; Force no eol conversion on a file name, so
6524 ;; that CR is preserved.
6532 ;; Try to insert the amount of free space.
6535 ;; First find the line to put it on.
6539 ;; Replace "total" with "used", to avoid confusion.
6545 "Convert `ls --dired' file name position value POS to a buffer position.
6546 File name position values returned in ls --dired output
6547 count only stdout; they don't count the error messages sent to stderr.
6548 So this function converts to them to real buffer positions.
6549 ERROR-LINES is a list of buffer positions of error message lines,
6550 of the form (START END)."
6554 pos)
6558 "Insert directory listing for FILE, formatted according to SWITCHES.
6560 Like `insert-directory', but if FILE does not exist, it inserts a
6561 message to that effect instead of signaling an error."
6564 ;; Simulate the message printed by `ls'.
6568 "Functions to call with no arguments to query about killing Emacs.
6569 If any of these functions returns nil, killing Emacs is canceled.
6570 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6574 "How to ask for confirmation when leaving Emacs.
6575 If nil, the default, don't ask at all. If the value is non-nil, it should
6576 be a predicate function; for example `yes-or-no-p'."
6585 "Offer to save each buffer, then kill this Emacs process.
6586 With prefix ARG, silently save all file-visiting buffers without asking.
6587 If there are active processes where `process-query-on-exit-flag'
6588 returns non-nil, asks whether processes should be killed.
6589 Runs the members of `kill-emacs-query-functions' in turn and stops
6590 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6599 ;; process-list is not defined on MSDOS.
6601 active)
6617 ;; Query the user for other things, perhaps.
6624 "Offer to save each buffer, then kill the current connection.
6625 If the current frame has no client, kill Emacs itself.
6627 With prefix ARG, silently save all file-visiting buffers, then kill.
6629 If emacsclient was started with a list of filenames to edit, then
6630 only these files will be asked to be saved."
6635 \f
6636 ;; We use /: as a prefix to "quote" a file name
6637 ;; so that magic file name handlers will not apply to it.
6641 file-name-handler-alist))
6643 ;; We depend on being the last handler on the list,
6644 ;; so that anything else which does need handling
6645 ;; has been handled already.
6646 ;; So it is safe for us to inhibit *all* magic file name handlers.
6655 default-directory))
6656 ;; Get a list of the indices of the args which are file names.
6659 ;; The first six are special because they
6660 ;; return a file name. We want to include the /:
6661 ;; in the return value.
6662 ;; So just avoid stripping it in the first place.
6669 ;; `identity' means just return the first arg
6670 ;; not stripped of its quoting.
6672 ;; `add' means add "/:" to the result.
6675 ;; `unquote-then-quote' means set buffer-file-name
6676 ;; temporarily to unquoted filename.
6678 ;; List the arguments which are filenames.
6686 ;; For all other operations, treat the first argument only
6687 ;; as the file name.
6689 method
6690 ;; Copy ARGUMENTS so we can replace elements in it.
6694 ;; Strip off the /: from the file names that have it.
6702 "/"
6708 (`insert-file-contents
6714 (`unquote-then-quote
6719 \f
6720 ;; Symbolic modes and read-file-modes.
6723 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6724 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6725 Others, or All) for whom to produce the mask.
6726 The bit-mask that is returned extracts from mode bits the access rights
6727 for the specified category of users."
6735 "Convert CHAR to a numeric value of mode bits.
6736 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6737 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6744 ;; Rights relative to the previous file modes.
6755 "Convert a symbolic mode string specification to an equivalent number.
6757 WHO-MASK is the bit-mask specifying the category of users to which to
6758 apply the access permissions. See `file-modes-char-to-who'.
6759 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6760 RIGHTS request to add, remove, or set permissions based on existing ones,
6767 char-right)
6774 num-rights
6778 op char-right)))
6779 num-rights))
6782 "Convert symbolic file modes to numeric file modes.
6783 MODES is the string to convert, it should match
6785 See Info node `(coreutils)File permissions' for more information on this
6786 notation.
6787 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6788 MODES request to add, remove, or set permissions based on existing ones,
6802 num-who num-modes)
6805 num-modes)))
6808 "Read file modes in octal or symbolic notation and return its numeric value.
6809 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6810 ORIG-FILE is the name of a file on whose mode bits to base returned
6811 permissions if what user types requests to add, remove, or set permissions
6827 nil nil default)))
6836 ;; Trashcan handling.
6838 "Directory for `move-file-to-trash' to move files and directories to.
6839 This directory is only used when the function `system-move-file-to-trash'
6840 is not defined.
6841 Relative paths are interpreted relative to `default-directory'.
6842 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6852 "Move the file (or directory) named FILENAME to the trash.
6853 When `delete-by-moving-to-trash' is non-nil, this function is
6854 called by `delete-file' and `delete-directory' instead of
6855 deleting files outright.
6857 If the function `system-move-file-to-trash' is defined, call it
6858 with FILENAME as an argument.
6859 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6860 directory.
6861 Otherwise, trash FILENAME using the freedesktop.org conventions,
6862 like the GNOME, KDE and XFCE desktop environments. Emacs only
6866 ;; If `trash-directory' is non-nil, move the file there.
6870 trash-dir)))
6871 ;; We can't trash a parent directory of trash-directory.
6874 trash-dir filename))
6877 ;; Ensure that the trashed file-name is unique.
6884 ;; If `system-move-file-to-trash' is defined, use it.
6887 ;; Otherwise, use the freedesktop.org method, as specified at
6888 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6899 ;; Check if we have permissions to delete.
6903 ;; The trashed file cannot be the trash dir or its parent.
6906 trash-files-dir filename))
6909 trash-info-dir filename))
6911 ;; Ensure that the trash directory exists; otherwise, create it.
6918 ;; Try to move to trash with .trashinfo undo information
6923 ;; Perform url-encoding on FN. For compatibility with
6924 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6925 ;; for path separators.
6930 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6931 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6944 fn))
6949 ;; Attempt to make .trashinfo file, trying up to 5
6950 ;; times. The .trashinfo file is opened with O_EXCL,
6951 ;; as per trash-spec 0.7, even if that can be a problem
6952 ;; on old NFS versions...
6956 trash-files-dir))
6958 success info-fn)
6963 trash-info-dir))
6971 ;; Uniquify new-fn. (Some file managers do not
6972 ;; like Emacs-style backup file names---e.g. bug
6973 ;; 170956 in Konqueror bug tracker.)
6978 ;; Finally, try to move the file to the trashcan.
6982 \f
7007 ;;; files.el ends here