| blob | edbf647530cee329024b709033c85d0b5447b3e7 |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2014 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 "Load the Lisp file named FILE."
734 ;; This is a case where .elc makes a lot of sense.
741 "Search for FILENAME through PATH.
742 If found, return the absolute file name of FILENAME; otherwise
743 return nil.
744 PATH should be a list of directories to look in, like the lists in
745 `exec-path' or `load-path'.
746 If SUFFIXES is non-nil, it should be a list of suffixes to append to
749 If non-nil, PREDICATE is used instead of `file-readable-p'.
751 This function will normally skip directories, so if you want it to find
752 directories, make sure the PREDICATE function returns `dir-ok' for them.
754 PREDICATE can also be an integer to pass to the `access' system call,
755 in which case file-name handlers are ignored. This usage is deprecated.
756 For compatibility, PREDICATE can also be one of the symbols
757 `executable', `readable', `writable', or `exists', or a list of
758 one or more of those symbols."
769 "Do completion for file names passed to `locate-file'."
772 ;; FIXME: maybe we should use completion-file-name-table instead,
773 ;; tho at least for `load', the arg is passed through
774 ;; substitute-in-file-name for historical reasons.
784 ;; If we have files like "foo.el" and "foo.elc", we could load one of
785 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
786 ;; preferred way. So if we list all 3, that gives a lot of redundant
787 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
788 ;; the user does want to pay attention to the extension. We try to
789 ;; diffuse this tension by stripping the suffix, except when the
790 ;; result is a single element (i.e. usually we only list "foo" unless
791 ;; it's the only remaining element in the list, in which case we do
792 ;; list "foo", "foo.elc" and "foo.el").
803 string-file dir))
808 ;; Switching from names to names+fullnames creates a non-monotonicity
809 ;; which can cause problems with things like partial-completion.
810 ;; To minimize the problem, filter out completion-regexp-list, so that
811 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
812 ;; from `names' which only matched `string' when they still had
813 ;; their suffix.
815 ;; Remove duplicates of the first element, so that we can easily check
816 ;; if `names' really only contains a single element.
819 ;; There's no more than one matching non-suffixed element, so expand
820 ;; the list by adding the suffixed elements as well.
823 string-dir names string-file pred action)))))
826 "Do completion for file names passed to `locate-file'.
827 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
831 string nil action))
835 "Regexp of directory names which stop the search in `locate-dominating-file'.
836 Any directory whose name matches this regexp will be treated like
837 a kind of root directory by `locate-dominating-file' which will stop its search
838 when it bumps into it.
839 The default regexp prevents fruitless and time-consuming attempts to find
840 special files in directories in which filenames are interpreted as hostnames,
843 ;; (defun locate-dominating-files (file regexp)
844 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
845 ;; Stop at the first parent where a matching file is found and return the list
846 ;; of files that that match in this directory."
847 ;; (catch 'found
848 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
849 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
850 ;; (let ((user nil)
851 ;; ;; Abbreviate, so as to stop when we cross ~/.
852 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
853 ;; files)
854 ;; (while (and dir
855 ;; ;; As a heuristic, we stop looking up the hierarchy of
856 ;; ;; directories as soon as we find a directory belonging to
857 ;; ;; another user. This should save us from looking in
858 ;; ;; things like /net and /afs. This assumes that all the
859 ;; ;; files inside a project belong to the same user.
860 ;; (let ((prev-user user))
861 ;; (setq user (nth 2 (file-attributes dir)))
862 ;; (or (null prev-user) (equal user prev-user))))
863 ;; (if (setq files (condition-case nil
864 ;; (directory-files dir 'full regexp 'nosort)
865 ;; (error nil)))
866 ;; (throw 'found files)
867 ;; (if (equal dir
868 ;; (setq dir (file-name-directory
869 ;; (directory-file-name dir))))
870 ;; (setq dir nil))))
871 ;; nil)))
874 "Look up the directory hierarchy from FILE for a directory containing NAME.
875 Stop at the first parent directory containing a file NAME,
876 and return the directory. Return nil if not found.
877 Instead of a string, NAME can also be a predicate taking one argument
878 \(a directory) and returning a non-nil value if that directory is the one for
879 which we're looking."
880 ;; We used to use the above locate-dominating-files code, but the
881 ;; directory-files call is very costly, so we're much better off doing
882 ;; multiple calls using the code in here.
883 ;;
884 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
885 ;; `name' in /home or in /.
888 ;; `user' is not initialized outside the loop because
889 ;; `file' may not exist, so we may have to walk up part of the
890 ;; hierarchy before we find the "initial UID". Note: currently unused
891 ;; (user nil)
892 try)
895 ;; FIXME: Disabled this heuristic because it is sometimes
896 ;; inappropriate.
897 ;; As a heuristic, we stop looking up the hierarchy of
898 ;; directories as soon as we find a directory belonging
899 ;; to another user. This should save us from looking in
900 ;; things like /net and /afs. This assumes that all the
901 ;; files inside a project belong to the same user.
902 ;; (let ((prev-user user))
903 ;; (setq user (nth 2 (file-attributes file)))
904 ;; (and prev-user (not (equal user prev-user))))
916 "Non-nil means warn if cannot access `user-emacs-directory'.
917 Set this to nil at your own risk..."
923 "Return an absolute per-user Emacs-specific file name.
924 If NEW-NAME exists in `user-emacs-directory', return it.
925 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
926 Else return NEW-NAME in `user-emacs-directory', creating the
927 directory if it does not exist."
935 at-home
936 ;; Make sure `user-emacs-directory' exists,
937 ;; unless we're in batch mode or dumping Emacs.
939 purify-flag
949 user-emacs-directory-warning
951 ;; Only warn once per Emacs session.
955 Unable to %s `user-emacs-directory' (%s).
956 Any data that would normally be written there may be lost!
957 If you never want to see this message again,
958 customize the variable `user-emacs-directory-warning'."
959 errtype user-emacs-directory)))))
960 bestname))))
964 "Search for COMMAND in `exec-path' and return the absolute file name.
965 Return nil if COMMAND is not found anywhere in `exec-path'."
966 ;; Use 1 rather than file-executable-p to better match the behavior of
967 ;; call-process.
971 "Load the Emacs Lisp library named LIBRARY.
972 This is an interface to the function `load'. LIBRARY is searched
973 for in `load-path', both with and without `load-suffixes' (as
974 well as `load-file-rep-suffixes').
976 See Info node `(emacs)Lisp Libraries' for more details.
977 See `load-file' for a different interface to `load'."
981 load-path
986 "Test whether FILE specifies a location on a remote system.
987 A file is considered remote if accessing it is likely to
988 be slower or less reliable than accessing local files.
990 `file-remote-p' never opens a new remote connection. It can
991 only reuse a connection that is already open.
993 Return nil or a string identifying the remote connection
994 \(ideally a prefix of FILE). Return nil if FILE is a relative
995 file name.
997 When IDENTIFICATION is nil, the returned string is a complete
998 remote identifier: with components method, user, and host. The
999 components are those present in FILE, with defaults filled in for
1000 any that are missing.
1002 IDENTIFICATION can specify which part of the identification to
1003 return. IDENTIFICATION can be the symbol `method', `user',
1004 `host', or `localname'. Any other value is handled like nil and
1005 means to return the complete identification. The string returned
1006 for IDENTIFICATION `localname' can differ depending on whether
1007 there is an existing connection.
1009 If CONNECTED is non-nil, return an identification only if FILE is
1010 located on a remote system and a connection is established to
1011 that remote system.
1013 Tip: You can use this expansion of remote identifier components
1014 to derive a new remote file name from an existing one. For
1020 same remote identifier as FILE but expanded; a name such as
1025 nil)))
1027 ;; Probably this entire variable should be obsolete now, in favor of
1028 ;; something Tramp-related (?). It is not used in many places.
1029 ;; It's not clear what the best file for this to be in is, but given
1030 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1031 ;; rather than autoloaded.
1033 ;; This used to try various hard-coded places for remsh, rsh, and
1034 ;; rcmd, trying to guess based on location whether "rsh" was
1035 ;; "restricted shell" or "remote shell", but I don't see the point
1036 ;; in this day and age. Almost everyone will use ssh, and have
1037 ;; whatever command they want to use in PATH.
1044 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1051 "Whether to use the remote file-name cache for read access.
1052 When `nil', never expire cached values (caution)
1053 When `t', never use the cache (safe, but may be slow)
1054 A number means use cached values for that amount of seconds since caching.
1056 The attributes of remote files are cached for better performance.
1057 If they are changed outside of Emacs's control, the cached values
1058 become invalid, and must be reread. If you are sure that nothing
1059 other than Emacs changes the files, you can set this variable to `nil'.
1061 If a remote file is checked regularly, it might be a good idea to
1062 let-bind this variable to a value less than the interval between
1063 consecutive checks. For example:
1065 (defun display-time-file-nonempty-p (file)
1066 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1067 (and (file-exists-p file)
1068 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1079 "Copy the file FILE into a temporary file on this machine.
1080 Returns the name of the local copy, or nil, if FILE is directly
1081 accessible."
1082 ;; This formerly had an optional BUFFER argument that wasn't used by
1083 ;; anything.
1087 nil)))
1090 "Return the truename of FILENAME.
1091 If FILENAME is not absolute, first expands it against `default-directory'.
1092 The truename of a file name is found by chasing symbolic links
1093 both at the level of the file and at the level of the directories
1094 containing it, until no links are left at any level.
1097 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1098 ;; COUNTER can be a cons cell whose car is the count of how many
1099 ;; more links to chase before getting an error.
1100 ;; PREV-DIRS can be a cons cell whose car is an alist
1101 ;; of truenames we've just recently computed.
1115 ;; For speed, remove the ange-ftp completion handler from the list.
1116 ;; We know it's not needed here.
1117 ;; For even more speed, do this only on the outermost call.
1124 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1125 ;; case differences being ignored by the OS, and short "8.3 DOS"
1126 ;; name aliases existing for all files. (The short names are not
1127 ;; reported by directory-files, but can be used to refer to files.)
1128 ;; It seems appropriate for file-truename to resolve these issues in
1129 ;; the most natural way, which on Windows is to call the function
1130 ;; `w32-long-file-name' - this returns the exact name of a file as
1131 ;; it is stored on disk (expanding short name aliases with the full
1132 ;; name in the process).
1135 ;; If filename exists, use its long name. If it doesn't
1136 ;; exist, the recursion below on the directory of filename
1137 ;; will drill down until we find a directory that exists,
1138 ;; and use the long name of that, with the extra
1139 ;; non-existent path components concatenated.
1144 ;; If this file directly leads to a link, process that iteratively
1145 ;; so that we don't use lots of stack.
1151 ;; For file name that has a special handler, call handler.
1152 ;; This is so that ange-ftp can save time by doing a no-op.
1155 done t)
1157 target dirfile)
1158 ;; Get the truename of the directory.
1160 ;; If these are equal, we have the (or a) root directory.
1164 ;; If this is the same dir we last got the truename for,
1165 ;; save time--don't recalculate.
1175 done t)
1178 done t)
1179 ;; Put it back on the file name.
1181 ;; Is the file name the name of a link?
1184 ;; Yes => chase that link, then start all over
1185 ;; since the link may point to a directory name that uses links.
1186 ;; We can't safely use expand-file-name here
1187 ;; since target might look like foo/../bar where foo
1188 ;; is itself a link. Instead, we handle . and .. above.
1191 target
1193 done nil)
1194 ;; No, we are done!
1196 filename))
1199 "Chase links in FILENAME until a name that is not a link.
1200 Unlike `file-truename', this does not check whether a parent
1201 directory name is a symbolic link.
1202 If the optional argument LIMIT is a number,
1203 it means chase no more than that many links and then stop."
1211 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1214 ;; Handle `..' by hand, since it needs to work in the
1215 ;; target of any directory symlink.
1216 ;; This code is not quite complete; it does not handle
1217 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1221 ;; Chase links in the default dir of the symlink.
1225 ;; Now find the parent of that dir.
1229 newname))
1231 ;; A handy function to display file sizes in human-readable form.
1232 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1234 "Produce a string showing FILE-SIZE in human-readable form.
1236 Optional second argument FLAVOR controls the units and the display format:
1238 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1240 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1242 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1245 1024.0
1248 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1254 "%.1f%s%s"
1256 file-size
1258 "K"
1263 "Create a temporary file.
1264 The returned file name (created by appending some random characters at the end
1265 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1266 is guaranteed to point to a newly created empty file.
1267 You can then use `write-region' to write new data into the file.
1269 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1271 If SUFFIX is non-nil, add that at the end of the file name."
1272 ;; Create temp files with strict access rights. It's easy to
1273 ;; loosen them later, whereas it's impossible to close the
1274 ;; time-window of loose permissions otherwise.
1283 temporary-file-directory)
1285 temporary-file-directory))))
1291 nil)
1293 ;; the file was somehow created by someone else between
1294 ;; `make-temp-name' and `write-region', let's try again.
1295 nil)
1296 file)))
1299 "Change the encoding of FILE's name from CODING to NEW-CODING.
1300 The value is a new name of FILE.
1301 Signals a `file-already-exists' error if a file of the new name
1302 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1303 is non-nil. A number as fourth arg means request confirmation if
1304 the new name already exists. This is what happens in interactive
1305 use with M-x."
1308 default-file-name-coding-system))
1310 from-coding to-coding)
1312 ;; We provide the default coding only when it seems that
1313 ;; the filename is correctly decoded by the default
1314 ;; coding.
1320 filename default-coding)
1321 default-coding))
1325 ;; We provide the default coding only when a user is going to
1326 ;; change the encoding not from the default coding.
1330 filename from-coding)))
1333 filename from-coding default-coding)
1334 default-coding)))
1338 default-file-name-coding-system))
1339 ;; FILE should have been decoded by DEFAULT-CODING.
1343 ;; Suppress further encoding.
1348 newname))
1349 \f
1351 "Whether confirmation is requested before visiting a new file or buffer.
1352 If nil, confirmation is not requested.
1353 If the value is `after-completion', confirmation is only
1354 requested if the user called `minibuffer-complete' right before
1355 `minibuffer-complete-and-exit'.
1356 Any other non-nil value means to request confirmation.
1358 This affects commands like `switch-to-buffer' and `find-file'."
1366 "Whether to request confirmation before visiting a new file or buffer.
1367 The variable `confirm-nonexistent-file-or-buffer' determines the
1368 return value, which may be passed as the REQUIRE-MATCH arg to
1369 `read-buffer' or `find-file-read-args'."
1377 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1378 BODY should use the minibuffer at most once.
1379 Recursive uses of the minibuffer are unaffected (FUN is not
1380 called additional times).
1382 This macro actually adds an auxiliary function that calls FUN,
1383 rather than FUN itself, to `minibuffer-setup-hook'."
1391 ;; Clear out this hook so it does not interfere
1392 ;; with any recursive minibuffer usage.
1403 t))
1406 "Edit file FILENAME.
1407 Switch to a buffer visiting file FILENAME,
1408 creating one if none already exists.
1409 Interactively, the default if you just type RET is the current directory,
1410 but the visited file name is available through the minibuffer history:
1411 type M-n to pull it into the minibuffer.
1413 You can visit files on remote machines by specifying something
1414 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1415 also visit local files as a different user by specifying
1416 /sudo::FILE for the file name.
1417 See the Info node `(tramp)File name Syntax' in the Tramp Info
1418 manual, for more about this.
1420 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1421 expand wildcards (if any) and visit multiple files. You can
1422 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1424 To visit a file without any kind of conversion and without
1435 "Edit file FILENAME, in another window.
1438 an existing one. See the function `display-buffer'.
1440 Interactively, the default if you just type RET is the current directory,
1441 but the visited file name is available through the minibuffer history:
1442 type M-n to pull it into the minibuffer.
1444 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1445 expand wildcards (if any) and visit multiple files."
1458 "Edit file FILENAME, in another frame.
1461 an existing one. See the function `display-buffer'.
1463 Interactively, the default if you just type RET is the current directory,
1464 but the visited file name is available through the minibuffer history:
1465 type M-n to pull it into the minibuffer.
1467 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1468 expand wildcards (if any) and visit multiple files."
1481 "Edit the existing file FILENAME.
1483 file names with wildcards."
1500 value))
1503 "Edit file FILENAME but don't allow changes.
1512 "Edit file FILENAME in another window but don't allow changes.
1521 "Edit file FILENAME in another frame but don't allow changes.
1530 "Find file FILENAME as a replacement for the file in the next window.
1531 This command does not select that window.
1535 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1536 expand wildcards (if any) and replace the file with multiple files."
1547 "Find alternate file: " file-dir nil
1549 t))))
1556 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1558 "Hook run when a buffer is killed.
1559 The buffer being killed is current while the hook is running.
1560 See `kill-buffer'.
1562 Note: Be careful with let-binding this hook considering it is
1566 "Find file FILENAME, select its buffer, kill previous buffer.
1567 If the current buffer now contains an empty file that you just visited
1568 \(presumably by mistake), use this command to visit the file you really want.
1572 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1573 expand wildcards (if any) and replace the file with multiple files.
1575 If the current buffer is an indirect buffer, or the base buffer
1576 for one or more indirect buffers, the other buffer(s) are not
1577 killed."
1586 "Find alternate file: " file-dir nil
1588 t)))
1600 ;; Run `kill-buffer-hook' here. It needs to happen before
1601 ;; variables like `buffer-file-name' etc are set to nil below,
1602 ;; because some of the hooks that could be invoked
1603 ;; (e.g., `save-place-to-alist') depend on those variables.
1604 ;;
1605 ;; Note that `kill-buffer-hook' is not what queries whether to
1606 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1607 ;; asks that itself. Thus, there's no need to temporarily do
1608 ;; `(set-buffer-modified-p nil)' before running this hook.
1610 ;; Okay, now we can end-of-life the old buffer.
1617 ;; This prevents us from finding the same buffer
1618 ;; if we specified the same file again.
1622 ;; Likewise for dired buffers.
1626 ;; This executes if find-file gets an error
1627 ;; and does not really find anything.
1628 ;; We put things back as they were.
1629 ;; If find-file actually finds something, we kill obuf below.
1638 ;; We already ran these; don't run them again.
1641 \f
1642 ;; FIXME we really need to fold the uniquify stuff in here by default,
1643 ;; not using advice, and add it to the doc string.
1645 "Create a suitably named buffer for visiting FILENAME, and return it.
1646 FILENAME (sans directory) is used unchanged if that name is free;
1647 otherwise a string <2> or <3> or ... is appended to get an unused name.
1649 Emacs treats buffers whose names begin with a space as internal buffers.
1650 To avoid confusion when visiting a file whose name begins with a space,
1657 lastname))))
1660 "Create and return a buffer with a name based on NAME.
1661 Choose the buffer's name using `generate-new-buffer-name'."
1665 "Regexp to match the automounter prefix in a directory name."
1674 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1676 home directory is a root directory) and removes automounter prefixes
1677 \(see the variable `automount-dir-prefix')."
1678 ;; Get rid of the prefixes added by the automounter.
1685 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1686 ;; To fix this right, we need a `file-name-case-sensitive-p'
1687 ;; function, but we don't have that yet, so just guess.
1690 ;; If any elt of directory-abbrev-alist matches this name,
1691 ;; abbreviate accordingly.
1697 ;; Compute and save the abbreviated homedir name.
1698 ;; We defer computing this until the first time it's needed, to
1699 ;; give time for directory-abbrev-alist to be set properly.
1700 ;; We include a slash at the end, to avoid spurious matches
1701 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1708 ;; If FILENAME starts with the abbreviated homedir,
1709 ;; make it start with `~' instead.
1711 ;; If the home dir is just /, don't change it.
1714 ;; MS-DOS root directories can come with a drive letter;
1715 ;; Novell Netware allows drive letters beyond `Z:'.
1723 filename)))
1726 "Return the buffer visiting file FILENAME (a string).
1727 This is like `get-file-buffer', except that it checks for any buffer
1728 visiting the same file, possibly under a different name.
1729 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1730 and others are ignored.
1731 If there is no such live buffer, return nil."
1744 found)
1754 ;; Verify this buffer's file number
1755 ;; still belongs to its file.
1758 attributes)
1762 found))))
1763 \f
1765 "Non-nil means file-visiting commands should handle wildcards.
1766 For example, if you specify `*.c', that would visit all the files
1767 whose names match the pattern."
1773 "Non-nil means suppress warning messages for symlinked files.
1774 When nil, Emacs prints a warning when visiting a file that is already
1775 visited, but with a different name. Setting this option to t
1776 suppresses this warning."
1782 "Maximum size of file above which a confirmation is requested.
1783 When nil, never request confirmation."
1790 "Warn if file size exceeds this percentage of available free memory.
1791 When nil, never issue warning. Beware: This probably doesn't do what you
1799 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1800 OP-TYPE specifies the file operation being performed (for message to user)."
1809 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1819 "You are trying to open a file whose size (%s)
1820 exceeds the %S%% of currently available free memory (%s).
1821 If that fails, try to open it with `find-file-literally'
1822 \(but note that some characters might be displayed incorrectly)."
1824 out-of-memory-warning-percentage
1828 "Read file FILENAME into a buffer and return the buffer.
1829 If a buffer exists visiting FILENAME, return that one, but
1830 verify that the file has not changed since visited or saved.
1831 The buffer is not selected, just returned to the caller.
1832 Optional second arg NOWARN non-nil means suppress any warning messages.
1833 Optional third arg RAWFILE non-nil means the file is read literally.
1834 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1835 and visit all the matching files. When wildcards are actually
1836 used and expanded, return a list of buffers that are visiting
1837 the various files."
1844 'find-directory-functions
1847 filename)))
1850 find-file-wildcards
1864 ;; Find any buffer for a file which has same truename.
1866 ;; Let user know if there is a buffer with the same truename.
1870 find-file-suppress-same-file-warnings
1874 ;; Optionally also find that buffer.
1877 ;; Check to see if the file looks uncommonly large.
1882 ;; We are using an existing buffer.
1889 ;; Certain files should be reverted automatically
1890 ;; if they have changed on disk and not in the buffer.
1898 found))
1908 "File %s changed on disk. Discard your edits? "
1913 "File %s changed on disk. Discard your edits in %s? "
1921 ;; Check if a formerly read-only file has become
1922 ;; writable and vice versa, but if the buffer agrees
1923 ;; with the new state of the file, that is ok too.
1933 buffer-file-name
1934 new-status new-status)))
1940 nonexistent
1941 ;; It is confusing to ask whether to visit
1942 ;; non-literally if they have the file in
1943 ;; hexl-mode or image-mode.
1949 "The file %s is already visited normally,
1950 and you have edited the buffer. Now you have asked to visit it literally,
1951 meaning no coding system handling, format conversion, or local variables.
1952 Emacs can only visit a file in one way at a time.
1954 Do you want to save the file, and visit it literally instead? "
1955 "The file %s is already visited literally,
1956 meaning no coding system handling, format conversion, or local variables.
1957 You have edited the buffer. Now you have asked to visit the file normally,
1958 but Emacs can only visit a file in one way at a time.
1965 rawfile truename number))
1969 "\
1970 Do you want to discard your changes, and visit the file literally now? "
1971 "\
1974 rawfile truename number)
1980 "The file %s is already visited normally.
1981 You have asked to visit it literally,
1982 meaning no coding system decoding, format conversion, or local variables.
1983 But Emacs can only visit a file in one way at a time.
1985 Do you want to revisit the file literally now? "
1986 "The file %s is already visited literally,
1987 meaning no coding system decoding, format conversion, or local variables.
1988 You have asked to visit it normally,
1989 but Emacs can only visit a file in one way at a time.
1994 rawfile truename number)
1997 ;; Return the buffer we are using.
1998 buf)
1999 ;; Create a new buffer.
2001 ;; find-file-noselect-1 may use a different buffer.
2003 rawfile truename number))))))
2009 ;; Needed in case we are re-visiting the file with a different
2010 ;; text representation.
2027 filename)))
2028 ;; Unconditionally set error
2038 filename)))
2039 ;; Run find-file-not-found-functions until one returns non-nil.
2041 ;; If they fail too, set error.
2043 ;; Record the file's truename, and maybe use that as visited name.
2051 ;; Set buffer's default directory to that of the file.
2053 ;; Turn off backup files for certain file names. Since
2054 ;; this is a permanent local, the major mode won't eliminate it.
2068 \f
2070 "Like `insert-file-contents', but only reads in the file literally.
2071 A buffer may be modified in several ways after reading into the buffer,
2072 to Emacs features such as format decoding, character code
2073 conversion, `find-file-hook', automatic uncompression, etc.
2075 This function ensures that none of these modifications will take place."
2081 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2082 ;; into a file operation instead!
2084 inhibit-file-name-handlers))
2091 filename)))
2092 ;; Check whether the file is uncommonly large
2103 "Insert contents of file FILENAME into buffer after point with no conversion.
2105 This function is meant for the user to run interactively.
2106 Don't call it from programs! Use `insert-file-contents-literally' instead.
2107 \(Its calling sequence is different; see its documentation)."
2113 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2114 This has the `permanent-local' property, which takes effect if you
2119 "Visit file FILENAME with no conversion of any kind.
2120 Format conversion and character code conversion are both disabled,
2121 and multibyte characters are disabled in the resulting buffer.
2122 The major mode used is Fundamental mode regardless of the file name,
2123 and local variable specifications in the file are ignored.
2124 Automatic uncompression and adding a newline at the end of the
2125 file due to `require-final-newline' is also disabled.
2127 You cannot absolutely rely on this function to result in
2128 visiting the file literally. If Emacs already has a buffer
2129 which is visiting the file, you get the existing buffer,
2130 regardless of whether it was created literally or not.
2132 In a Lisp program, if you want to be sure of accessing a file's
2133 contents literally, you should create a temporary buffer and then read
2134 the file contents into it using `insert-file-contents-literally'."
2137 "Find file literally: " nil default-directory
2140 \f
2142 _after-find-file-from-revert-buffer
2143 nomodes)
2144 "Called after finding a file and by the default revert function.
2145 Sets buffer mode, parses local variables.
2146 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2147 error in reading the file. WARN non-nil means warn if there
2148 exists an auto-save file more recent than the visited file.
2149 NOAUTO means don't mess with auto-save mode.
2150 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2151 \(see `revert-buffer-in-progress-p' for similar functionality).
2152 Fifth arg NOMODES non-nil means don't alter the file's modes.
2153 Finishes by calling the functions in `find-file-hook'
2154 unless NOMODES is non-nil."
2157 nil
2167 "Symbolic link that points to nonexistent file"
2171 ;; No need to warn if buffer is auto-saved
2172 ;; under the name of the visited file.
2174 auto-save-visited-file-name))
2177 buffer-file-name))
2197 ;; Make people do a little extra work (C-x C-q)
2198 ;; before altering a backup file.
2201 ;; When a file is marked read-only,
2202 ;; make the buffer read-only even if root is looking at it.
2210 ;; If requested, add a newline at the end of the file.
2221 view-read-only
2227 "Eval BODY and turn any error into a FORMAT message.
2228 FORMAT can have a %s escape which will be replaced with the actual error.
2229 If `debug-on-error' is set, errors are not caught, so that you can
2230 debug them.
2231 Avoid using a large BODY since it is duplicated."
2240 "Choose the major mode for this buffer automatically.
2241 Also sets up any specified local variables of the file.
2242 Uses the visited file name, the -*- line, and the local variables spec.
2244 This function is called automatically from `find-file'. In that case,
2245 we may set up the file-specified mode and local variables,
2246 depending on the value of `enable-local-variables'.
2247 In addition, if `local-enable-local-variables' is nil, we do
2248 not set local variables (though we do notice a mode specified with -*-.)
2250 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2251 or from Lisp without specifying the optional argument FIND-FILE;
2252 in that case, this function acts as if `enable-local-variables' were t."
2256 ;; FIXME this is less efficient than it could be, since both
2257 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2262 ;; Turn font lock off and on, to make sure it takes account of
2263 ;; whatever file local variables are relevant to it.
2265 ;; Font-lock-mode (now in font-core.el) can be ON when
2266 ;; font-lock.el still hasn't been loaded.
2273 "Non-nil means to try second pass through `auto-mode-alist'.
2274 This means that if the first case-sensitive search through the alist fails
2275 to find a matching major mode, a second case-insensitive search is made.
2276 On systems with case-insensitive file names, this variable is ignored,
2277 since only a single case-insensitive search through the alist is made."
2283 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2284 ;; c++-mode, java-mode and more) are added through autoload
2285 ;; directives in that file. That way is discouraged since it
2286 ;; spreads out the definition of the initial value.
2332 ;; Less common extensions come here
2333 ;; so more common ones above are found faster.
2341 ;; Besides .gdbinit, gdb documents other names to be usable for init
2342 ;; files, cross-debuggers can use something like
2343 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2344 ;; don't interfere with each other.
2346 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2347 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2348 ;; loaded when GDB reads an objfile called 'emacs'.
2356 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2380 ;; The Fortran standard does not say anything about file extensions.
2381 ;; .f90 was widely used for F90, now we seem to be trapped into
2382 ;; using a different extension for each language revision.
2383 ;; Anyway, the following extensions are supported by gfortran.
2391 ;; The list of archive file extensions should be in sync with
2392 ;; `auto-coding-alist' with `no-conversion' coding system.
2398 ;; Mailer puts message to be edited in
2399 ;; /tmp/Re.... or Message
2402 ;; some news reader is reported to use this
2415 ;; .emacs or .gnus or .viper following a directory delimiter in
2416 ;; Unix or MS-DOS syntax.
2419 ;; _emacs following a directory delimiter in MS-DOS syntax
2423 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2424 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2425 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2428 ;; .xs is also used for ld scripts, but seems to be more commonly
2429 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2431 ;; Explained in binutils ld/genscripts.sh. Eg:
2432 ;; A .x script file is the default script.
2433 ;; A .xr script is for linking without relocation (-r flag). Etc.
2437 ;; Common Lisp ASDF package system.
2444 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2456 ;; Windows candidates may be opened case sensitively on Unix
2462 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2463 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2464 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2465 ;; this has lower priority to avoid matching changelog.sgml etc.
2467 ;; either user's dot-files or under /etc or some such
2469 ;; alas not all ~/.*rc files are like this
2470 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2475 ;; this contains everything twice, with space and with colon :-(
2477 ;; Get rid of any trailing .n.m and try again.
2478 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2479 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2480 ;; Using mode nil rather than `ignore' would let the search continue
2481 ;; through this list (with the shortened name) rather than start over.
2484 ;; This should come after "in" stripping (e.g. config.h.in).
2485 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2487 ;; The following should come after the ChangeLog pattern
2488 ;; for the sake of ChangeLog.1, etc.
2489 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2491 "Alist of filename patterns vs corresponding major mode functions.
2492 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2493 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2494 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2495 mode function to use. FUNCTION will be called, unless it is nil.
2497 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2498 calling FUNCTION (if it's not nil), we delete the suffix that matched
2499 REGEXP and search the list again for another match.
2501 The extensions whose FUNCTION is `archive-mode' should also
2502 appear in `auto-coding-alist' with `no-conversion' coding system.
2504 See also `interpreter-mode-alist', which detects executable script modes
2505 based on the interpreters they specify to run,
2510 "Select Conf mode or XML mode according to start of file."
2520 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2521 ;; and pike-mode) are added through autoload directives in that
2522 ;; file. That way is discouraged since it spreads out the
2523 ;; definition of the initial value.
2552 "Alist mapping interpreter names to major modes.
2553 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2554 Each element looks like (REGEXP . MODE).
2556 the interpreter specified in the first line of a script, enable
2557 major mode MODE.
2564 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2565 ;; because we are duplicating info from auto-mode-alist.
2566 ;; TODO many elements of this list are also in auto-coding-alist.
2575 "List of regexps matching file names in which to ignore local variables.
2577 Files matching this list are typically binary file formats.
2578 They may happen to contain sequences that look like local variable
2579 specifications, but are not really, or they may be containers for
2580 member files with their own local variable sections, which are
2581 not appropriate for the containing file.
2588 "List of regexps matching suffixes to remove from file names.
2589 The function `inhibit-local-variables-p' uses this: when checking
2590 a file name, it first discards from the end of the name anything that
2593 ;; Can't think of any situation in which you'd want this to be nil...
2598 "Return non-nil if file local variables should be ignored.
2599 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2600 and `inhibit-local-variables-suffixes'. If
2601 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2610 sufs)
2615 temp))
2620 "Regexp matching interpreters, for file mode determination.
2621 This regular expression is matched against the first line of a file
2622 to determine the file's mode in `set-auto-mode'. If it matches, the file
2623 is assumed to be interpreted by the interpreter matched by the second group
2624 of the regular expression. The mode is then determined as the mode
2628 "Alist of buffer beginnings vs. corresponding major mode functions.
2629 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2630 After visiting a file, if REGEXP matches the text at the beginning of the
2631 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2632 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2633 major mode.
2635 If FUNCTION is nil, then it is not called. (That is a way of saying
2643 ;; The < comes before the groups (but the first) to reduce backtracking.
2644 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2645 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2649 comment-re "*"
2652 . html-mode)
2654 ;; These two must come after html, because they are more general:
2659 . sgml-mode)
2662 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2663 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2664 After visiting a file, if REGEXP matches the text at the beginning of the
2665 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2666 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2667 have not specified a mode for this file.
2673 "Upper limit on `magic-mode-alist' regexp matches.
2677 "Select major mode appropriate for current buffer.
2679 To find the right major mode, this function checks for a -*- mode tag
2680 checks for a `mode:' entry in the Local Variables section of the file,
2681 checks if it uses an interpreter listed in `interpreter-mode-alist',
2682 matches the buffer beginning against `magic-mode-alist',
2683 compares the filename against the entries in `auto-mode-alist',
2684 then matches the buffer beginning against `magic-fallback-mode-alist'.
2686 If `enable-local-variables' is nil, or if the file name matches
2687 `inhibit-local-variables-regexps', this function does not check
2688 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2689 is nil, then the only mode: tag that can be relevant is a -*- one.
2691 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2692 set the major mode only if that would change it. In other words
2693 we don't actually set it to the same mode the buffer already has."
2694 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2696 end done mode modes)
2697 ;; Once we drop the deprecated feature where mode: is also allowed to
2698 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2699 ;; remove this section and just let (hack-local-variables t) handle it.
2700 ;; Find a -*- mode tag.
2704 ;; Note by design local-enable-local-variables does not matter here.
2706 try-locals
2709 ;; Find all specifications for the `mode:' variable
2710 ;; and execute them left to right.
2722 modes)))
2723 ;; Simple -*-MODE-*- case.
2726 modes))))
2727 ;; If we found modes to use, invoke them now, outside the save-excursion.
2735 ;; continuing would call minor modes again, toggling them off
2737 ;; hack-local-variables checks local-enable-local-variables etc, but
2738 ;; we might as well be explicit here for the sake of clarity.
2740 enable-local-variables
2741 local-enable-local-variables
2742 try-locals
2749 ;; If we didn't, look for an interpreter specified in the first line.
2750 ;; As a special case, allow for things like "#!/bin/env perl", which
2751 ;; finds the interpreter anywhere in $PATH.
2757 ;; Map interpreter name to a mode, signaling we're done at the
2758 ;; same time.
2765 interpreter-mode-alist)
2767 ;; If we found an interpreter mode to use, invoke it now.
2769 ;; Next try matching the buffer beginning against magic-mode-alist.
2783 ;; Next compare the filename against the entries in auto-mode-alist.
2788 ;; Remove backup-suffixes from file name.
2790 ;; Remove remote file name identification.
2795 ;; Find first matching alist entry.
2798 ;; System is case-insensitive.
2802 ;; System is case-sensitive.
2804 ;; First match case-sensitively.
2808 ;; Fallback to case-insensitive match.
2822 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2839 ;; When `keep-mode-if-same' is set, we are working on behalf of
2840 ;; set-visited-file-name. In that case, if the major mode specified is the
2841 ;; same one we already have, don't actually reset it. We don't want to lose
2842 ;; minor modes such as Font Lock.
2844 "Apply MODE and return it.
2845 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2846 any aliases and compared to current major mode. If they are the
2847 same, do nothing and return nil."
2853 mode)))
2856 "Regexp of lines to skip when looking for file-local settings.
2857 If the first line matches this regular expression, then the -*-...-*- file-
2861 "Find the -*- spec in the buffer.
2862 Call with point at the place to start searching from.
2863 If one is found, set point to the beginning and return the position
2864 of the end. Otherwise, return nil; may change point.
2865 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2866 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2867 have no effect."
2870 ;; Don't look for -*- if this file name matches any
2871 ;; of the regexps in inhibit-local-variables-regexps.
2874 ;; If the file begins with "#!" (exec
2875 ;; interpreter magic), look for mode frobs
2876 ;; in the first two lines. You cannot
2877 ;; necessarily put them in the first line
2878 ;; of such a file without screwing up the
2879 ;; interpreter invocation. The same holds
2880 ;; for '\" in man pages (preprocessor
2881 ;; magic for the `man' program).
2892 end))))
2893 \f
2894 ;;; Handling file local variables
2898 file-local-variables-alist dir-local-variables-alist)
2903 "Normal hook run after processing a file's local variables specs.
2904 Major modes can use this to examine user-specified local variables
2908 "List variable-value pairs that are considered safe.
2909 Each element is a cons cell (VAR . VAL), where VAR is a variable
2910 symbol and VAL is a value that is considered safe."
2911 :risky t
2916 ;; This should be here at least as long as Emacs supports write-file-hooks.
2921 "Expressions that are considered safe in an `eval:' local variable.
2922 Add expressions to this list if you want Emacs to evaluate them, when
2923 they appear in an `eval' local variable specification, without first
2924 asking you for confirmation."
2925 :risky t
2930 ;; Risky local variables:
2933 buffer-auto-save-file-name
2934 buffer-file-name
2935 buffer-file-truename
2936 buffer-undo-list
2937 debugger
2938 default-text-properties
2939 eval
2940 exec-directory
2941 exec-path
2942 file-name-handler-alist
2943 frame-title-format
2944 global-mode-string
2945 header-line-format
2946 icon-title-format
2947 inhibit-quit
2948 load-path
2949 max-lisp-eval-depth
2950 max-specpdl-size
2951 minor-mode-map-alist
2952 minor-mode-overriding-map-alist
2953 mode-line-format
2954 mode-name
2955 overriding-local-map
2956 overriding-terminal-local-map
2957 process-environment
2958 standard-input
2959 standard-output
2960 unread-command-events))
2962 ;; Safe local variables:
2963 ;;
2964 ;; For variables defined by major modes, the safety declarations can go into
2965 ;; the major mode's file, since that will be loaded before file variables are
2966 ;; processed.
2967 ;;
2968 ;; For variables defined by minor modes, put the safety declarations in the
2969 ;; file defining the minor mode after the defcustom/defvar using an autoload
2970 ;; cookie, e.g.:
2971 ;;
2972 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2973 ;;
2974 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2975 ;; minor mode file may not be loaded yet.
2976 ;;
2977 ;; For variables defined in the C source code the declaration should go here:
2999 "Alist of file-local variable settings in the current buffer.
3000 Each element in this list has the form (VAR . VALUE), where VAR
3001 is a file-local variable (a symbol) and VALUE is the value
3002 specified. The actual value in the buffer may differ from VALUE,
3008 "Alist of directory-local variable settings in the current buffer.
3009 Each element in this list has the form (VAR . VALUE), where VAR
3010 is a directory-local variable (a symbol) and VALUE is the value
3011 specified in .dir-locals.el. The actual value in the buffer
3012 may differ from VALUE, if it is changed by the major or minor modes,
3017 "Normal hook run before setting file-local variables.
3018 It is called after checking for unsafe/risky variables and
3019 setting `file-local-variables-alist', and before applying the
3020 variables stored in `file-local-variables-alist'. A hook
3021 function is allowed to change the contents of this alist.
3023 This hook is called only if there is at least one file-local
3027 "Get confirmation before setting up local variable values.
3028 ALL-VARS is the list of all variables to be set up.
3029 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3030 RISKY-VARS is the list of those that are marked as risky.
3031 If these settings come from directory-local variables, then
3032 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3039 unsafe-vars))
3041 ;; Set up the contents of the *Local Variables* buffer.
3049 ", and variables that are risky (**)."
3057 y -- to apply the local variables list.
3061 ! -- to apply the local variables list, and permanently mark these
3073 ;; Make strings with embedded whitespace easier to read.
3081 ;; Display the buffer and read a choice.
3089 ""
3092 char)
3111 "Return local variables specified in the -*- line.
3112 Returns an alist of elements (VAR . VAL), where VAR is a variable
3113 and VAL is the specified value. Ignores any specification for
3114 `mode:' and `coding:' (which should have already been handled
3115 by `set-auto-mode' and `set-auto-coding', respectively).
3116 Return nil if the -*- line is malformed.
3118 If MODE-ONLY is non-nil, just returns the symbol specifying the
3119 mode, if there is one, otherwise nil."
3124 result)
3126 nil)
3128 ;; Simple form: "-*- MODENAME -*-".
3132 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3133 ;; (last ";" is optional).
3134 ;; If MODE-ONLY, just check for `mode'.
3135 ;; Otherwise, parse the -*- line into the RESULT alist.
3143 ;; There used to be a downcase here,
3144 ;; but the manual didn't say so,
3145 ;; and people want to set var names that aren't all lc.
3151 ;; It is traditional to ignore
3152 ;; case when checking for `mode' in set-auto-mode,
3153 ;; so we must do that here as well.
3154 ;; That is inconsistent, but we're stuck with it.
3155 ;; The same can be said for `coding' in set-auto-coding.
3165 ;; Downcase "Mode:".
3171 result))))))
3174 "Filter local variable settings, querying the user if necessary.
3175 VARIABLES is the alist of variable-value settings. This alist is
3176 filtered based on the values of `ignored-local-variables',
3177 `enable-local-eval', `enable-local-variables', and (if necessary)
3178 user interaction. The results are added to
3179 `file-local-variables-alist', without applying them.
3180 If these settings come from directory-local variables, then
3181 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3182 ;; Find those variables that we may want to save to
3183 ;; `safe-local-variable-values'.
3189 ;; Ignore any variable in `ignored-local-variables'.
3190 nil)
3191 ;; Obey `enable-local-eval'.
3195 ;; In case previously marked safe (bug#5636).
3197 ;; If not safe and e-l-v = :safe, ignore totally.
3201 safe
3203 ;; Ignore duplicates (except `mode') in the present list.
3205 ;; Accept known-safe variables.
3209 ;; The variable is either risky or unsafe:
3216 ;; Query, unless all vars are safe or user wants no querying.
3222 risky-vars dir-name))
3232 ;; TODO? Warn once per file rather than once per session?
3236 "Parse and put into effect this buffer's local variables spec.
3237 Uses `hack-local-variables-apply' to apply the variables.
3240 is specified, and return the corresponding mode symbol, or nil.
3241 In this case, we try to ignore minor-modes, and only return a
3242 major-mode.
3244 If `enable-local-variables' or `local-enable-local-variables' is nil,
3245 this function does nothing. If `inhibit-local-variables-regexps'
3246 applies to the file in question, the file is not scanned for
3247 local variables, but directory-local variables may still be applied."
3248 ;; We don't let inhibit-local-variables-p influence the value of
3249 ;; enable-local-variables, because then it would affect dir-local
3250 ;; variables. We don't want to search eg tar files for file local
3251 ;; variable sections, but there is no reason dir-locals cannot apply
3252 ;; to them. The real meaning of inhibit-local-variables-p is "do
3253 ;; not scan this file for local variables".
3256 result)
3260 ;; Note this is a no-op if enable-local-variables is nil.
3262 ;; This entire function is basically a no-op if enable-local-variables
3263 ;; is nil. All it does is set file-local-variables-alist to nil.
3265 ;; This part used to ignore enable-local-variables when mode-only
3266 ;; was non-nil. That was inappropriate, eg consider the
3267 ;; (artificial) example of:
3268 ;; (setq local-enable-local-variables nil)
3269 ;; Open a file foo.txt that contains "mode: sh".
3270 ;; It correctly opens in text-mode.
3271 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3273 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3274 ;; mode, then we're done, and have no need to scan further.
3276 mode-only))
3277 ;; Look for "Local variables:" line in last page.
3285 ;; suffix is what comes after "local variables:" in its line.
3286 ;; prefix is what comes before "local variables:" in its line.
3299 endpos
3305 nil t))
3306 ;; This used to be an error, but really all it means is
3307 ;; that this may simply not be a local-variables section,
3308 ;; so just ignore it.
3318 ;; Discard the prefix.
3323 ;; Discard the suffix.
3332 ;; Find the variable name;
3340 val val2)
3343 ;; Read the variable value.
3350 ;; Specifying minor-modes via mode: is
3351 ;; deprecated, but try to reject them anyway.
3361 :warning
3368 'eval
3372 ;; Now we've read all the local variables.
3373 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3375 ;; Otherwise, set the variables.
3380 "Apply the elements of `file-local-variables-alist'.
3381 If there are any elements, runs `before-hack-local-variables-hook',
3382 then calls `hack-one-local-variable' to apply the alist elements one by one.
3383 Finishes by running `hack-local-variables-hook', regardless of whether
3384 the alist is empty or not.
3386 Note that this function ignores a `mode' entry if it specifies the same
3387 major mode as the buffer already has."
3389 ;; Any 'evals must run in the Right sequence.
3398 "Non-nil if SYM is safe as a file-local variable with value VAL.
3399 It is safe if any of these conditions are met:
3401 * There is a matching entry (SYM . VAL) in the
3402 `safe-local-variable-values' user option.
3404 * The `safe-local-variable' property of SYM is a function that
3405 evaluates to a non-nil value with VAL as an argument."
3409 ;; If the function signals an error, that means it
3410 ;; can't assure us that the value is safe.
3414 "Non-nil if SYM could be dangerous as a file-local variable.
3415 It is dangerous if either of these conditions are met:
3417 * Its `risky-local-variable' property is non-nil.
3423 ;; If this is an alias, check the base name.
3443 "Return t if it is safe to eval EXP when it is found in a file."
3445 ;; Detect certain `put' expressions.
3452 lisp-indent-function
3453 scheme-indent-function))
3454 ;; Only allow safe values (not functions).
3459 ;; Only allow indirect form specs.
3460 ;; During bootstrapping, edebug-basic-spec might not be
3461 ;; defined yet.
3465 ;; Allow expressions that the user requested.
3467 ;; Certain functions can be allowed with safe arguments
3468 ;; or can specify verification functions to try.
3470 ;; Allow (minor)-modes calls with no arguments.
3471 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3480 ok))
3488 ok))))))))
3501 "Set local variable VAR with value VAL.
3502 If VAR is `mode', call `VAL-mode' as a function unless it's
3503 already the major mode."
3505 (`mode
3511 (`eval
3517 ;; Make sure the string has no text properties.
3518 ;; Some text properties can get evaluated in various ways,
3519 ;; so it is risky to put them on with a local variable list.
3523 \f
3524 ;;; Handling directory-local variables, aka project settings.
3530 "List of cached directory roots for directory-local variable classes.
3531 Each element in this list has the form (DIR CLASS MTIME).
3532 DIR is the name of the directory.
3533 CLASS is the name of a variable class (a symbol).
3534 MTIME is the recorded modification time of the directory-local
3535 variables file associated with this entry. This time is a list
3536 of integers (the same format as `file-attributes'), and is
3537 used to test whether the cache entry is still valid.
3538 Alternatively, MTIME can be nil, which means the entry is always
3542 "Return the variable list for CLASS."
3546 "Collect directory-local variables from MODE-VARIABLES.
3547 VARIABLES is the initial list of variables.
3548 Returns the new list."
3553 ;; If variables are specified more than once, only use the last. (Why?)
3554 ;; The pseudo-variables mode and eval are different (bug#3430).
3557 ;; Need a new cons in case we setcdr later.
3561 "Collect entries from CLASS-VARIABLES into VARIABLES.
3562 ROOT is the root directory of the project.
3563 Return the new variables list."
3566 ;; FIXME: Why not use file-relative-name?
3573 ;; Don't include this in the previous condition, because we
3574 ;; want to filter all strings before the next condition.
3588 ;; TODO someone might want to extend this to allow
3589 ;; integer values for subdir, where N means
3590 ;; variables apply to this directory and N levels
3591 ;; below it (0 == nil).
3594 alist variables))))))))
3596 ;; The file's content might be invalid (e.g. have a merge conflict), but
3597 ;; that shouldn't prevent the user from opening the file.
3599 nil))))
3602 "Declare that the DIRECTORY root is an instance of CLASS.
3603 DIRECTORY is the name of a directory, a string.
3604 CLASS is the name of a project class, a symbol.
3605 MTIME is either the modification time of the directory-local
3606 variables file that defined this class, or nil.
3608 When a file beneath DIRECTORY is visited, the mode-specific
3609 variables from CLASS are applied to the buffer. The variables
3610 for a class are defined using `dir-locals-set-class-variables'."
3617 "Map the type CLASS to a list of variable settings.
3618 CLASS is the project class, a symbol. VARIABLES is a list
3619 that declares directory-local variables for the class.
3620 An element in VARIABLES is either of the form:
3621 (MAJOR-MODE . ALIST)
3622 or
3623 (DIRECTORY . LIST)
3625 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3626 whose elements are of the form (VARIABLE . VALUE).
3628 In the second form, DIRECTORY is a directory name (a string), and
3629 LIST is a list of the form accepted by the function.
3631 When a file is visited, the file's class is found. A directory
3632 may be assigned a class using `dir-locals-set-directory-class'.
3633 Then variables are set in the file's buffer according to the
3634 VARIABLES list of the class. The list is processed in order.
3636 * If the element is of the form (MAJOR-MODE . ALIST), and the
3637 buffer's major mode is derived from MAJOR-MODE (as determined
3638 by `derived-mode-p'), then all the variables in ALIST are
3639 applied. A MAJOR-MODE of nil may be used to match any buffer.
3640 `make-local-variable' is called for each variable before it is
3641 set.
3643 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3644 is an initial substring of the file's directory, then LIST is
3645 applied by recursively following these rules."
3652 "File that contains directory-local variables.
3653 It has to be constant to enforce uniform values
3657 "Find the directory-local variables for FILE.
3658 This searches upward in the directory tree from FILE.
3659 It stops at the first directory that has been registered in
3660 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3661 If it finds an entry in the cache, it checks that it is valid.
3662 A cache entry with no modification time element (normally, one that
3663 has been assigned directly using `dir-locals-set-directory-class', not
3664 set from a file) is always valid.
3665 A cache entry based on a `dir-locals-file' is valid if the modification
3666 time stored in the cache matches the current file modification time.
3667 If not, the cache entry is cleared so that the file will be re-read.
3669 This function returns either nil (no directory local variables found),
3670 or the matching entry from `dir-locals-directory-cache' (a list),
3671 or the full path to the `dir-locals-file' (a string) in the case
3672 of no valid cache entry."
3677 dir-locals-file))
3680 ;; `locate-dominating-file' may have abbreviated the name.
3683 ;; Let dir-locals-read-from-file inform us via demoted-errors
3684 ;; about unreadable files, etc.
3685 ;; Maybe we'd want to keep searching though - that is
3686 ;; a locate-dominating-file issue.
3687 ;;; (or (not (file-readable-p locals-file))
3688 ;;; (not (file-regular-p locals-file)))
3689 ;;; (setq locals-file nil))
3690 ;; Find the best cached value in `dir-locals-directory-cache'.
3701 ;; Found a potential cache entry. Check validity.
3702 ;; A cache entry with no MTIME is assumed to always be valid
3703 ;; (ie, set directly, not from a dir-locals file).
3704 ;; Note, we don't bother to check that there is a matching class
3705 ;; element in dir-locals-class-alist, since that's done by
3706 ;; dir-locals-set-directory-class.
3713 ;; This cache entry is OK.
3714 dir-elt
3715 ;; This cache entry is invalid; clear it.
3718 ;; Return the first existing dir-locals file. Might be the same
3719 ;; as dir-elt's, might not (eg latter might have been deleted).
3720 locals-file)
3721 ;; No cache entry.
3722 locals-file)))
3725 "Load a variables FILE and register a new class and instance.
3726 FILE is the name of the file holding the variables to apply.
3727 The new class name is the same as the directory in which FILE
3728 is found. Returns the new class name."
3740 class-name)))))
3743 "Non-nil means dir-local variables will be applied to remote files."
3751 "Read per-directory local variables for the current buffer.
3752 Store the directory-local variables in `dir-local-variables-alist'
3753 and `file-local-variables-alist', without applying them.
3755 This does nothing if either `enable-local-variables' or
3756 `enable-dir-local-variables' are nil."
3758 enable-dir-local-variables
3761 default-directory)))))
3762 ;; Find the variables file.
3792 "Apply directory-local variables to a non-file buffer.
3793 For non-file buffers, such as Dired buffers, directory-local
3794 variables are looked for in `default-directory' and its parent
3795 directories."
3799 \f
3802 However, the mode will not be changed if
3803 \(1) a local variables list or the `-*-' line specifies a major mode, or
3805 \ not suitable for ordinary files, or
3806 \(3) the new file name does not particularly specify any mode."
3811 "Change name of file visited in current buffer to FILENAME.
3812 This also renames the buffer to correspond to the new file.
3813 The next time the buffer is saved it will go in the newly specified file.
3814 FILENAME nil or an empty string means mark buffer as not visiting any file.
3815 Remember to delete the initial contents of the minibuffer
3816 if you wish to pass an empty string as the argument.
3818 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3819 confirmation in the case where another buffer is already visiting FILENAME.
3821 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3822 the old visited file has been renamed to the new name FILENAME."
3830 nil
3845 filename)))
3852 buffer-file-name filename)
3856 ;; If new-name == old-name, renaming would add a spurious <2>
3857 ;; and it's considered as a feature in rename-buffer.
3863 ;; Abbreviate the file names of the buffer.
3872 nil))
3873 ;; write-file-functions is normally used for things like ftp-find-file
3874 ;; that visit things that are not local files as if they were files.
3875 ;; Changing to visit an ordinary local file instead should flush the hook.
3880 ;; If buffer was read-only because of version control,
3881 ;; that reason is gone now, so make it writable.
3885 ;; Turn off backup files for certain file names.
3886 ;; Since this is a permanent local, the major mode won't eliminate it.
3888 backup-enable-predicate
3894 ;; If auto-save was not already on, turn it on if appropriate.
3898 ;; If auto save is on, start using a new name.
3899 ;; We deliberately don't rename or delete the old auto save
3900 ;; for the old visited file name. This is because perhaps
3901 ;; the user wants to save the new state and then compare with the
3902 ;; previous state from the auto save file.
3905 ;; Rename the old auto save file if any.
3912 ;; Update the major mode, if the file name determines it.
3914 ;; Don't change the mode if it is special.
3917 ;; Don't change the mode if the local variable list specifies it.
3918 ;; The file name can influence whether the local variables apply.
3920 ;; h-l-v also checks it, but might as well be explicit.
3923 ;; TODO consider making normal-mode handle this case.
3931 "Write current buffer into file FILENAME.
3932 This makes the buffer visit that file, and marks it as not modified.
3934 If you specify just a directory name as FILENAME, that means to use
3935 the default file name but in that directory. You can also yank
3936 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3938 If the buffer is not already visiting a file, the default file name
3939 for the output file is the buffer name.
3941 If optional second arg CONFIRM is non-nil, this function
3942 asks for confirmation before overwriting an existing file.
3943 Interactively, confirmation is required unless you supply a prefix argument."
3944 ;; (interactive "FWrite file: ")
3948 nil nil nil nil)
3952 default-directory)
3953 nil nil))
3957 ;; If arg is just a directory,
3958 ;; use the default file name, but in that directory.
3965 ;; NS does its own confirm dialog.
3968 use-dialog-box))
3973 ;; Make buffer writable if file is writable.
3978 ;; It's likely that the VC status at the new location is different from
3979 ;; the one at the old location.
3981 \f
3983 "Return an alist of extended attributes of file FILENAME.
3985 Extended attributes are platform-specific metadata about the file,
3986 such as SELinux context, list of ACL entries, etc."
3991 "Set extended attributes of file FILENAME to ATTRIBUTES.
3993 ATTRIBUTES must be an alist of file attributes as returned by
3994 `file-extended-attributes'."
4002 \f
4004 "Make a backup of the disk file visited by the current buffer, if appropriate.
4005 This is normally done before saving the buffer the first time.
4007 A backup may be done by renaming or by copying; see documentation of
4008 variable `make-backup-files'. If it's done by renaming, then the file is
4009 no longer accessible under its old name.
4011 The value is non-nil after a backup was made by renaming.
4012 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4013 MODES is the result of `file-modes' on the original
4014 file; this means that the caller, after saving the buffer, should change
4015 the modes of the new file to agree with the old modes.
4016 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4017 on the original file; this means that the caller, after saving
4018 the buffer, should change the extended attributes of the new file
4019 to agree with the old attributes.
4020 BACKUPNAME is the backup file name, which is the old file renamed."
4027 backup-info backupname targets setmodes)
4028 ;; If specified name is a symbolic link, chase it to the target.
4029 ;; Thus we make the backups in the directory where the real file is.
4034 ;; (if (file-directory-p buffer-file-name)
4035 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
4039 ;; If have old versions to maybe delete,
4040 ;; ask the user to confirm now, before doing anything.
4041 ;; But don't actually delete til later.
4046 real-file-name)))))
4050 ;; Actually write the back up file.
4053 ; (file-symlink-p buffer-file-name)
4054 backup-by-copying
4055 ;; Don't rename a suid or sgid file.
4068 real-file-name t))))))
4070 backupname modes
4071 extended-attributes)
4072 ;; rename-file should delete old backup.
4075 backupname)))
4077 ;; If trouble writing the backup, write it in
4078 ;; .emacs.d/%backup%.
4081 backupname)
4084 modes extended-attributes)))
4086 ;; Now delete the old versions, if desired.
4093 setmodes)
4097 ;; Create temp files with strict access rights. It's easy to
4098 ;; loosen them later, whereas it's impossible to close the
4099 ;; time-window of loose permissions otherwise.
4102 ;; Try to overwrite old backup first.
4110 nil)
4112 ;; The file was somehow created by someone else between
4113 ;; `delete-file' and `copy-file', so let's try again.
4114 ;; rms says "I think there is also a possible race
4115 ;; condition for making backup files" (emacs-devel 20070821).
4116 nil)))
4117 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4126 ;; The last ~[[:digit]]+ matches relative versions in git,
4127 ;; e.g. `foo.js.~HEAD~1~'.
4128 "Regular expression matching the backup/version part of a file name.
4132 "Return file NAME sans backup versions or strings.
4133 This is a separate procedure so your site-init or startup file can
4134 redefine it.
4135 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4136 we do not remove backup version numbers, only true file version numbers.
4137 See also `file-name-version-regexp'."
4144 name))))))
4147 "Return t if deleting FILE and rewriting it would preserve the owner.
4148 Return nil if FILE does not exist, or if deleting and recreating it
4149 might not preserve the owner. If GROUP is non-nil, check whether
4150 the group would be preserved too."
4155 ;; Return t if the file doesn't exist, since it's true that no
4156 ;; information would be lost by an (attempted) delete and create.
4159 ;; Files created on Windows by Administrator (RID=500)
4160 ;; have the Administrators group (RID=544) recorded as
4161 ;; their owner. Rewriting them will still preserve the
4162 ;; owner.
4166 ;; On BSD-derived systems files always inherit the parent
4167 ;; directory's group, so skip the group-gid test.
4173 ;; On some systems, a file created in a setuid directory
4174 ;; inherits that directory's owner.
4178 ;; On many systems, a file created in a setgid directory
4179 ;; inherits that directory's group. On some systems
4180 ;; this happens even if the setgid bit is not set.
4187 The extension, in a file name, is the part that follows the last `.',
4188 except that a leading `.', if any, doesn't count."
4191 directory)
4195 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4196 ;; we don't want to expand it.
4199 filename))))
4203 The extension, in a file name, is the part that follows the last `.',
4204 excluding version numbers and backup suffixes,
4205 except that a leading `.', if any, doesn't count.
4206 Return nil for extensionless file names such as `foo'.
4207 Return the empty string for file names such as `foo.'.
4209 If PERIOD is non-nil, then the returned value includes the period
4210 that delimits the extension, and if FILENAME has no extension,
4221 "Return the base name of the FILENAME: no directory, no extension.
4222 FILENAME defaults to `buffer-file-name'."
4227 #'make-backup-file-name--default-function
4228 "A function that `make-backup-file-name' uses to create backup file names.
4229 The function receives a single argument, the original file name.
4231 If you change this, you may need to change `backup-file-name-p' and
4232 `file-name-sans-versions' too.
4234 You could make this buffer-local to do something special for specific files.
4236 For historical reasons, a value of nil means to use the default function.
4237 This should not be relied upon.
4239 See also `backup-directory-alist'."
4246 "Alist of filename patterns and backup directory names.
4247 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4248 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4249 relative or absolute. If it is absolute, so that all matching files
4250 are backed up into the same directory, the file names in this
4251 directory will be the full name of the file backed up with all
4252 directory separators changed to `!' to prevent clashes. This will not
4253 work correctly if your filesystem truncates the resulting name.
4255 For the common case of all backups going into one directory, the alist
4257 directory name.
4259 If this variable is nil, or it fails to match a filename, the backup
4260 is made in the original file's directory.
4262 On MS-DOS filesystems without long names this variable is always
4263 ignored."
4269 "Default `backup-enable-predicate' function.
4270 Checks for files in `temporary-file-directory',
4271 `small-temporary-file-directory', and /tmp."
4273 caseless)
4274 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4275 ;; their long file-name equivalents, so compare-strings does TRT.
4279 caseless t))
4282 ;; Directory is under temporary-file-directory.
4287 ;; Directory is under /tmp.
4292 0 nil
4294 ;; Directory is under small-temporary-file-directory.
4299 "Create the non-numeric backup file name for FILE.
4300 This calls the function that `make-backup-file-name-function' specifies,
4301 with a single argument FILE."
4304 file))
4307 "Default function for `make-backup-file-name'.
4308 Normally this just returns FILE's name with `~' appended.
4309 It searches for a match for FILE in `backup-directory-alist'.
4310 If the directory for the backup doesn't exist, it is created."
4322 "Subroutine of `make-backup-file-name--default-function'.
4323 The function `find-backup-file-name' also uses this."
4325 elt backup-directory abs-backup-directory)
4330 alist nil)))
4331 ;; If backup-directory is relative, it should be relative to the
4332 ;; file's directory. By expanding explicitly here, we avoid
4333 ;; depending on default-directory.
4342 abs-backup-directory nil))))
4344 file
4348 ;; Normalize DOSish file names: downcase the drive
4349 ;; letter, if any, and replace the leading "x:" with
4350 ;; "/drive_x".
4353 ;; Replace any invalid file-name characters (for the
4354 ;; case of backing up remote files).
4358 "drive_"
4361 ""
4364 ;; Make the name unique by substituting directory
4365 ;; separators. It may not really be worth bothering about
4366 ;; doubling `!'s in the original name...
4371 backup-directory))
4376 "Return non-nil if FILE is a backup file name (numeric or not).
4377 This is a separate function so you can redefine it for customization.
4378 You may need to redefine `file-name-sans-versions' as well."
4383 ;; This is used in various files.
4384 ;; The usage of backup-extract-version-start is not very clean,
4385 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4387 "Given the name of a numeric backup file, FN, return the backup number.
4388 Uses the free variable `backup-extract-version-start', whose value should be
4389 the index in the name where the version number begins."
4396 "Find a file name for a backup file FN, and suggestions for deletions.
4397 Value is a list whose car is the name for the backup file
4398 and whose cdr is a list of old versions to consider deleting now.
4399 If the value is nil, don't make a backup.
4400 Uses `backup-directory-alist' in the same way as
4401 `make-backup-file-name--default-function' does."
4403 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4407 ;; We don't support numbered backups on plain MS-DOS
4408 ;; when long file names are unavailable.
4418 possibilities deserve-versions-p versions)
4421 base-versions
4424 possibilities)
4425 #'<)
4430 kept-old-versions
4431 kept-new-versions
4438 ;; Delete nothing if there is overflow
4439 ;; in the number of versions to keep.
4445 v))))))))))
4448 "Return number of names file FILENAME has."
4451 ;; (defun file-relative-name (filename &optional directory)
4452 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4453 ;; This function returns a relative file name which is equivalent to FILENAME
4454 ;; when used with that default directory as the default.
4455 ;; If this is impossible (which can happen on MSDOS and Windows
4456 ;; when the file name and directory use different drive names)
4457 ;; then it returns FILENAME."
4458 ;; (save-match-data
4459 ;; (let ((fname (expand-file-name filename)))
4460 ;; (setq directory (file-name-as-directory
4461 ;; (expand-file-name (or directory default-directory))))
4462 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4463 ;; ;; drive names, they can't be relative, so return the absolute name.
4464 ;; (if (and (or (eq system-type 'ms-dos)
4465 ;; (eq system-type 'cygwin)
4466 ;; (eq system-type 'windows-nt))
4467 ;; (not (string-equal (substring fname 0 2)
4468 ;; (substring directory 0 2))))
4469 ;; filename
4470 ;; (let ((ancestor ".")
4471 ;; (fname-dir (file-name-as-directory fname)))
4472 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4473 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4474 ;; (setq directory (file-name-directory (substring directory 0 -1))
4475 ;; ancestor (if (equal ancestor ".")
4476 ;; ".."
4477 ;; (concat "../" ancestor))))
4478 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4479 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4480 ;; ;; We matched within FNAME's directory part.
4481 ;; ;; Add the rest of FNAME onto ANCESTOR.
4482 ;; (let ((rest (substring fname (match-end 0))))
4483 ;; (if (and (equal ancestor ".")
4484 ;; (not (equal rest "")))
4485 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4486 ;; rest
4487 ;; (concat (file-name-as-directory ancestor) rest)))
4488 ;; ;; We matched FNAME's directory equivalent.
4489 ;; ancestor))))))
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 FILENAME is a relative file name, it will be interpreted as existing in
4496 `default-directory'.
4497 If FILENAME and DIRECTORY lie on different machines or on different drives
4498 on a DOS/Windows machine, it returns FILENAME in expanded form."
4502 default-directory))))
4507 read-file-name-completion-ignore-case)))
4510 ;; Test for different filesystems on DOS/Windows
4512 ;; Should `cygwin' really be included here? --stef
4515 ;; Test for different drive letters
4517 ;; Test for UNCs on different servers
4522 ;; Windows file names cannot have ? in
4523 ;; them, so use that to detect when
4524 ;; neither FILENAME nor DIRECTORY is a
4525 ;; UNC.
4527 0 nil
4533 ;; Test for different remote file system identification
4535 filename
4543 ".."
4545 ;; Now ancestor is empty, or .., or ../.., etc.
4547 ;; We matched within FILENAME's directory part.
4548 ;; Add the rest of FILENAME onto ANCESTOR.
4551 ;; But don't bother with ANCESTOR if it would give us `./'.
4552 rest
4554 ;; We matched FILENAME's directory equivalent.
4555 ancestor))))))
4556 \f
4558 "Save current buffer in visited file if modified.
4559 Variations are described below.
4561 By default, makes the previous version into a backup file
4562 if previously requested or if this is the first save.
4564 to become a backup when the next save is done.
4566 unconditionally makes the previous version into a backup file.
4568 to become a backup when the next save is done,
4569 and unconditionally makes the previous version into a backup file.
4571 With a numeric prefix argument of 0, never make the previous version
4572 into a backup file.
4574 If a file's name is FOO, the names of its numbered backup versions are
4575 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4576 Numeric backups (rather than FOO~) will be made if value of
4577 `version-control' is not the atom `never' and either there are already
4578 numeric versions of the file being backed up, or `version-control' is
4579 non-nil.
4580 We don't want excessive versions piling up, so there are variables
4581 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4582 and `kept-new-versions', which tells how many newest versions to keep.
4583 Defaults are 2 old versions and 2 new.
4584 `dired-kept-versions' controls dired's clean-directory (.) command.
4585 If `delete-old-versions' is nil, system will query user
4586 before trimming versions. Otherwise it does it silently.
4588 If `vc-make-backup-files' is nil, which is the default,
4589 no backup files are made for files managed by version control.
4590 (This is because the version control system itself records previous versions.)
4592 See the subroutine `basic-save-buffer' for more information."
4598 ;; We used to display the message below only for files > 50KB, but
4599 ;; then Rmail-mbox never displays it due to buffer swapping. If
4600 ;; the test is ever re-introduced, be sure to handle saving of
4601 ;; Rmail files.
4608 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4609 Normally delete only if the file was written by this Emacs since
4610 the last real save, but optional arg FORCE non-nil means delete anyway."
4624 "Normal hook that is run before a buffer is saved to its file."
4630 "Normal hook that is run after a buffer is saved to its file."
4636 "If non-nil, use this coding system for saving the buffer.
4637 More precisely, use this coding system in place of the
4638 value of `buffer-file-coding-system', when saving the buffer.
4639 Calling `write-region' for any purpose other than saving the buffer
4640 will still use `buffer-file-coding-system'; this variable has no effect
4647 "Save the current buffer in its visited file, if it has been modified.
4648 The hooks `write-contents-functions' and `write-file-functions' get a chance
4649 to do the job of saving; if they do not, then the buffer is saved in
4650 the visited file in the usual way.
4651 Before and after saving the buffer, this function runs
4652 `before-save-hook' and `after-save-hook', respectively."
4655 ;; In an indirect buffer, save its base buffer instead.
4659 ;; handle the case when no modification has been made but
4660 ;; the file disappeared since visited
4664 setmodes)
4665 ;; If buffer has no file name, ask user for one.
4673 ;; Signal an error if the user specified the name of an
4674 ;; existing directory.
4677 filename))
4684 "%s has changed since visited or saved. Save anyway? "
4704 ;; Support VC version backups.
4706 ;; Don't let errors prevent saving the buffer.
4711 ;; If a hook returned t, file is already "written".
4712 ;; Otherwise, write it the usual way now.
4721 ;; Now we have saved the current buffer. Let's make sure
4722 ;; that buffer-file-coding-system is fixed to what
4723 ;; actually used for saving by binding it locally.
4738 ;; If the auto-save file was recent before this command,
4739 ;; delete it now.
4741 ;; Support VC `implicit' locking.
4746 ;; This does the "real job" of writing a buffer into its visited file
4747 ;; and making a backup file. This is what is normally done
4748 ;; but inhibited if one of write-file-functions returns non-nil.
4749 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4750 ;; backup-buffer.
4760 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4761 ;; backup-buffer.
4774 "File %s is write-protected; try to save anyway? "
4776 buffer-file-name)))
4791 ;; Write temp name, then rename it.
4792 ;; This requires write access to the containing dir,
4793 ;; which is why we don't try it if we don't have that access.
4795 tempname succeed
4798 ;; Create temp files with strict access rights. It's easy to
4799 ;; loosen them later, whereas it's impossible to close the
4800 ;; time-window of loose permissions otherwise.
4805 ;; Try various temporary names.
4806 ;; This code follows the example of make-temp-file,
4807 ;; but it calls write-region in the appropriate way
4808 ;; for saving the buffer.
4814 ;; Pass in nil&nil rather than point-min&max
4815 ;; cause we're saving the whole buffer.
4816 ;; write-region-annotate-functions may use it.
4818 tempname nil realname
4820 nil)
4822 ;; The file was somehow created by someone else between
4823 ;; `make-temp-name' and `write-region', let's try again.
4824 nil)
4826 ;; Reset the umask.
4828 ;; If we failed, restore the buffer's modtime.
4831 ;; Since we have created an entirely new file,
4832 ;; make sure it gets the right permission bits set.
4837 buffer-file-name)))
4838 ;; We succeeded in writing the temp file,
4839 ;; so rename it.
4841 ;; If file not writable, see if we can make it writable
4842 ;; temporarily while we write it.
4843 ;; But no need to do so if we have just backed it up
4844 ;; (setmodes is set) because that says we're superseding.
4846 ;; Change the mode back, after writing.
4849 buffer-file-name))
4850 ;; If set-file-extended-attributes fails, fall back on
4851 ;; set-file-modes.
4861 ;; Pass in nil&nil rather than point-min&max to indicate
4862 ;; we're saving the buffer rather than just a region.
4863 ;; write-region-annotate-functions may make us of it.
4865 buffer-file-name nil t buffer-file-truename)
4867 ;; If we get an error writing the new file, and we made
4868 ;; the backup by renaming, undo the backing-up.
4873 setmodes))
4879 `((?\C-r
4886 ;; Return nil to ask about BUF again.
4887 nil)
4900 ;; Return nil to ask about BUF again.
4901 nil)
4911 "Save some modified file-visiting buffers. Asks user about each one.
4912 You can answer `y' to save, `n' not to save, `C-r' to look at the
4913 buffer in question with `view-buffer' before deciding or `d' to
4914 view the differences using `diff-buffer-with-file'.
4916 This command first saves any buffers where `buffer-save-without-query' is
4917 non-nil, without asking.
4919 Optional argument (the prefix) non-nil means save all with no questions.
4920 Optional second argument PRED determines which buffers are considered:
4921 If PRED is nil, all the file-visiting buffers are considered.
4922 If PRED is t, then certain non-file buffers will also be considered.
4923 If PRED is a zero-argument function, it indicates for each buffer whether
4924 to consider it or not when called with that buffer current.
4926 See `save-some-buffers-action-alist' if you want to
4927 change the additional actions you can take on files."
4931 files-done abbrevs-done)
4933 ;; First save any buffers that we're supposed to save unconditionally.
4934 ;; That way the following code won't ask about them.
4939 ;; Ask about those buffers that merit it,
4940 ;; and record the number thus saved.
4944 ;; Note that killing some buffers may kill others via
4945 ;; hooks (e.g. Rmail and its viewing buffer).
4958 t
4970 save-some-buffers-action-alist))
4971 ;; Maybe to save abbrevs, and record whether
4972 ;; we either saved them or asked to.
4979 ;; Don't keep bothering user if he says no.
4992 \f
4994 "Clear out records of last mod time of visited file.
4995 Next attempt to save will certainly not complain of a discrepancy."
4999 "Mark current buffer as unmodified, not needing to be saved.
5002 It is not a good idea to use this function in Lisp programs, because it
5003 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5011 "Change whether this buffer is read-only."
5019 "Insert contents of file FILENAME into buffer after point.
5020 Set mark after the inserted text.
5022 This function is meant for the user to run interactively.
5023 Don't call it from programs! Use `insert-file-contents' instead.
5024 \(Its calling sequence is different; see its documentation)."
5030 "Append the contents of the region to the end of file FILENAME.
5031 When called from a function, expects three arguments,
5032 START, END and FILENAME. START and END are normally buffer positions
5033 specifying the part of the buffer to write.
5034 If START is nil, that means to use the entire buffer contents.
5035 If START is a string, then output that string to the file
5036 instead of any buffer contents; END is ignored.
5038 This does character code conversion and applies annotations
5039 like `write-region' does."
5044 "Return most recent backup file for FILENAME or nil if no backups exist."
5045 ;; `make-backup-file-name' will get us the right directory for
5046 ;; ordinary or numeric backups. It might create a directory for
5047 ;; backups as a side-effect, according to `backup-directory-alist'.
5054 tem)
5063 newest))
5066 "Rename current buffer to a similar name not already taken.
5067 This function is useful for creating multiple shell process buffers
5068 or multiple mail buffers, etc.
5070 Note that some commands, in particular those based on `compilation-mode'
5071 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5072 appropriate mode even if it has been renamed. So as well as renaming
5073 the buffer, you also need to switch buffers before running another
5074 instance of such commands."
5082 ;; If the existing buffer name has a <NNN>,
5083 ;; which isn't part of the file name (if any),
5084 ;; then get rid of that.
5090 "Create the directory DIR and optionally any nonexistent parent dirs.
5091 If DIR already exists as a directory, signal an error, unless
5092 PARENTS is non-nil.
5094 Interactively, the default choice of directory to create is the
5095 current buffer's default directory. That is useful when you have
5096 visited a file in a nonexistent directory.
5098 Noninteractively, the second (optional) argument PARENTS, if
5099 non-nil, says whether to create parent directories that don't
5100 exist. Interactively, this happens by default.
5102 If creating the directory or directories fail, an error will be
5103 raised."
5106 nil nil)
5107 t))
5108 ;; If default-directory is a remote directory,
5109 ;; make sure we find its make-directory handler.
5117 create-list)
5119 ;; If directory is its own parent, then we can't
5120 ;; keep looping forever
5135 "Delete the directory named DIRECTORY. Does not follow symlinks.
5136 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5137 TRASH non-nil means to trash the directory instead, provided
5138 `delete-by-moving-to-trash' is non-nil.
5140 When called interactively, TRASH is t if no prefix argument is
5141 given. With a prefix argument, TRASH is nil."
5148 "Move directory to trash: "
5150 default-directory default-directory nil nil))))
5156 nil)
5158 ;; If default-directory is a remote directory, make sure we find its
5159 ;; delete-directory handler.
5166 ;; Only move non-empty dir to trash if recursive deletion was
5167 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5168 ;; case, where the operation fails in delete-directory-internal.
5169 ;; As `move-file-to-trash' trashes directories (empty or
5170 ;; otherwise) as a unit, we do not need to recurse here.
5172 ;; Check if directory is empty apart from "." and "..".
5177 ;; Otherwise, call ourselves recursively if needed.
5181 ;; This test is equivalent to
5182 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5183 ;; but more efficient
5187 ;; We do not want to delete "." and "..".
5193 "Return non-nil if files FILE1 and FILE2 name the same file.
5194 If FILE1 or FILE2 does not exist, the return value is unspecified."
5205 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5207 Return nil if DIR is not an existing directory."
5229 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5230 This function always sets the file modes of the output files to match
5231 the corresponding input file.
5233 The third arg KEEP-TIME non-nil means give the output files the same
5234 last-modified time as the old ones. (This works on only some systems.)
5236 A prefix arg makes KEEP-TIME non-nil.
5238 Noninteractively, the last argument PARENTS says whether to
5239 create parent directories if they don't exist. Interactively,
5240 this happens by default.
5242 If NEWNAME names an existing directory, copy DIRECTORY as a
5243 subdirectory there. However, if called from Lisp with a non-nil
5244 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5245 directly into NEWNAME instead."
5252 default-directory default-directory nil nil)
5253 current-prefix-arg t nil)))
5256 directory newname))
5257 ;; If default-directory is a remote directory, make sure we find its
5258 ;; copy-directory handler.
5263 newname keep-time parents copy-contents)
5265 ;; Compute target name.
5270 ;; If NEWNAME is not an existing directory, create it;
5271 ;; that is where we will copy the files of DIRECTORY.
5273 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5274 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5279 newname))
5283 newname))
5286 ;; Copy recursively.
5288 ;; We do not want to copy "." and "..".
5290 directory-files-no-dot-files-regexp))
5300 ;; Set directory attributes.
5306 \f
5307 ;; At time of writing, only info uses this.
5309 "Return a copy of DIRS with all non-existent directories removed.
5310 The optional argument KEEP is a list of directories to retain even if
5311 they don't exist, and REJECT is a list of directories to remove from
5312 DIRS, even if they exist; REJECT takes precedence over KEEP.
5314 Note that membership in REJECT and KEEP is checked using simple string
5315 comparison."
5321 dirs)))
5323 \f
5326 "Function to use to revert this buffer.
5327 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5328 which are the arguments that `revert-buffer' received.
5329 It also has access to the `preserve-modes' argument of `revert-buffer'
5330 via the `revert-buffer-preserve-modes' dynamic variable.
5332 For historical reasons, a value of nil means to use the default function.
5337 #'revert-buffer-insert-file-contents--default-function
5338 "Function to use to insert contents when reverting this buffer.
5339 The function receives two arguments: the first the nominal file name to use;
5340 the second is t if reading the auto-save file.
5342 The function is responsible for updating (or preserving) point.
5344 For historical reasons, a value of nil means to use the default function.
5348 "Default function to use for `buffer-stale-function'.
5349 This function ignores its argument.
5350 This returns non-nil if the current buffer is visiting a readable file
5351 whose modification time does not match that of the buffer.
5353 This function only handles buffers that are visiting files.
5354 Non-file buffers need a custom function"
5360 "Function to check whether a buffer needs reverting.
5361 This should be a function with one optional argument NOCONFIRM.
5362 Auto Revert Mode passes t for NOCONFIRM. The function should return
5363 non-nil if the buffer should be reverted. A return value of
5364 `fast' means that the need for reverting was not checked, but
5365 that reverting the buffer is fast. The buffer is current when
5366 this function is called.
5368 The idea behind the NOCONFIRM argument is that it should be
5369 non-nil if the buffer is going to be reverted without asking the
5370 user. In such situations, one has to be careful with potentially
5371 time consuming operations.
5373 For historical reasons, a value of nil means to use the default function.
5374 This should not be relied upon.
5376 For more information on how this variable is used by Auto Revert mode,
5380 "Normal hook for `revert-buffer' to run before reverting.
5381 The function `revert-buffer--default' runs this.
5385 "Normal hook for `revert-buffer' to run after reverting.
5386 Note that the hook value that it runs is the value that was in effect
5387 before reverting; that makes a difference if you have buffer-local
5388 hook functions.
5390 The function `revert-buffer--default' runs this.
5398 ;; `revert-buffer-function' was defined long ago to be a function of only
5399 ;; 2 arguments, so we have to use a dynbind variable to pass the
5400 ;; `preserve-modes' argument of `revert-buffer'.
5404 "Replace current buffer text with the text of the visited file on disk.
5405 This undoes all changes since the file was visited or saved.
5406 With a prefix argument, offer to revert from latest auto-save file, if
5407 that is more recent than the visited file.
5409 This command also implements an interface for special buffers
5410 that contain text which doesn't come from a file, but reflects
5411 some other data instead (e.g. Dired buffers, `buffer-list'
5412 buffers). This is done via the variable `revert-buffer-function'.
5413 In these cases, it should reconstruct the buffer contents from the
5414 appropriate data.
5416 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5417 to revert from the auto-save file when this is nil. Note that the
5418 sense of this argument is the reverse of the prefix argument, for the
5419 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5420 to nil.
5422 Optional second argument NOCONFIRM means don't ask for confirmation
5423 at all. (The variable `revert-without-query' offers another way to
5424 revert buffers without querying for confirmation.)
5426 Optional third argument PRESERVE-MODES non-nil means don't alter
5427 the files modes. Normally we reinitialize them using `normal-mode'.
5429 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5431 This function calls the function that `revert-buffer-function' specifies
5432 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5433 The default function runs the hooks `before-revert-hook' and
5434 `after-revert-hook'."
5435 ;; I admit it's odd to reverse the sense of the prefix argument, but
5436 ;; there is a lot of code out there which assumes that the first
5437 ;; argument should be t to avoid consulting the auto-save file, and
5438 ;; there's no straightforward way to encourage authors to notice a
5439 ;; reversal of the argument sense. So I'm just changing the user
5440 ;; interface, but leaving the programmatic interface the same.
5445 ignore-auto noconfirm)))
5448 "Default function for `revert-buffer'.
5449 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5450 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5451 start and end.
5453 Calls `revert-buffer-insert-file-contents-function' to reread the
5454 contents of the visited file, with two arguments: the first is the file
5455 name, the second is non-nil if reading an auto-save file.
5457 This function only handles buffers that are visiting files.
5458 Non-file buffers need a custom function."
5463 buffer-auto-save-file-name
5468 buffer-auto-save-file-name
5469 buffer-file-name)))
5479 file-name)))
5481 ;; If file was backed up but has changed since,
5482 ;; we should make another backup.
5486 ;; Effectively copy the after-revert-hook status,
5487 ;; since after-find-file will clobber it.
5490 after-revert-hook))
5492 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5496 file-name auto-save-p)
5497 ;; Recompute the truename in case changes in symlinks
5498 ;; have changed the truename.
5502 ;; Run after-revert-hook as it was before we reverted.
5506 local-hook)
5509 t)))))
5512 "Default function for `revert-buffer-insert-file-contents-function'.
5513 The function `revert-buffer--default' calls this.
5514 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5515 an auto-save file."
5519 "File %s no longer exists!"
5521 file-name))
5524 "File %s no longer readable!"
5526 file-name))
5528 ;; Bind buffer-file-name to nil
5529 ;; so that we don't try to lock the file.
5535 ;; Auto-saved file should be read by Emacs's
5536 ;; internal coding.
5540 buffer-file-coding-system-explicit
5543 coding-system-for-read
5545 coding-system-for-read)
5547 ;; As a coding system suitable for multibyte
5548 ;; buffer is specified, make the current
5549 ;; buffer multibyte.
5552 ;; This force after-insert-file-set-coding
5553 ;; (called from insert-file-contents) to set
5554 ;; buffer-file-coding-system to a proper value.
5557 ;; Note that this preserves point in an intelligent way.
5561 nil nil t))
5563 nil nil t))))))
5566 "Recover the visited file--get contents from its last auto-save file."
5571 "Visit file FILE, but get contents from its last auto-save file."
5572 ;; Actually putting the file name in the minibuffer should be used
5573 ;; only rarely.
5574 ;; Not just because users often use the default.
5587 "*Directory*" nil
5598 ;; Use insert-directory-safely, not insert-directory,
5599 ;; because these files might not exist. In particular,
5600 ;; FILE might not exist if the auto-save file was for
5601 ;; a buffer that didn't visit a file, such as "*mail*".
5602 ;; The code in v20.x called `ls' directly, so we need
5603 ;; to emulate what `ls' did in that case.
5608 ;; Keep the current buffer-file-coding-system.
5610 ;; Auto-saved file should be read with special coding.
5619 "Recover auto save files from a previous Emacs session.
5620 This command first displays a Dired buffer showing you the
5621 previous sessions that you could recover from.
5622 To choose one, move point to the proper line and then type C-c C-c.
5623 Then you'll be asked about a number of files to recover."
5633 auto-save-list-file-prefix)))
5634 t)
5645 ;; Each line starts with a space
5646 ;; so that Font Lock mode won't highlight the first character.
5649 " To delete a session file, type \
5655 "Choose one saved session to recover auto-save files from.
5656 This command is used in the special Dired buffer created by
5659 ;; Get the name of the session file to recover from.
5661 files
5667 ;; Read in the auto-save-list file.
5670 ;; Loop thru the text of that file
5671 ;; and get out the names of the files to recover.
5675 ;; This is a pair of lines for a non-file-visiting buffer.
5676 ;; Get the auto-save file name and manufacture
5677 ;; a "visited file name" from that.
5680 ;; If there is no auto-save file name, the
5681 ;; auto-save-list file is probably corrupted.
5694 ;; This pair of lines is a file-visiting
5695 ;; buffer. Use the visited file name.
5705 ;; Ignore a file if its auto-save file does not exist now.
5709 ;; The file contains a pair of line for each auto-saved buffer.
5710 ;; The first line of the pair contains the visited file name
5711 ;; or is empty if the buffer was not visiting a file.
5712 ;; The second line is the auto-save file name.
5720 files
5726 "Kill BUFFER if confirmed."
5734 "Kill some buffers. Asks the user whether to kill each one of them.
5735 Non-interactively, if optional argument LIST is non-nil, it
5736 specifies the list of buffers to kill, asking for approval for each one."
5744 ; if we killed the base buffer.
5751 "Kill buffers whose name matches the specified REGEXP.
5752 The optional second argument indicates whether to kill internal buffers too."
5761 \f
5763 "Adjust current buffer's auto save file name for current conditions.
5764 Also rename any existing auto save file, if it was made in this session."
5776 "Return file name to use for auto-saves of current buffer.
5777 Does not consider `auto-save-visited-file-name' as that variable is checked
5778 before calling this function. You can redefine this for customization.
5779 See also `auto-save-file-name-p'."
5787 result uniq)
5788 ;; Apply user-specified translations
5789 ;; to the file name.
5793 filename)
5803 filename))))
5808 ;; We truncate the file name to DOS 8+3 limits
5809 ;; before doing anything else, because the regexp
5810 ;; passed to string-match below cannot handle
5811 ;; extensions longer than 3 characters, multiple
5812 ;; dots, and other atrocities.
5817 fn)
5822 "#"
5825 ;; Make sure auto-save file names don't contain characters
5826 ;; invalid for the underlying filesystem.
5828 ;; Don't modify remote (ange-ftp) filenames
5831 result))))
5833 ;; Deal with buffers that don't have any associated files. (Mail
5834 ;; mode tends to create a good number of these.)
5838 file-name)
5839 ;; Restrict the characters used in the file name to those which
5840 ;; are known to be safe on all filesystems, url-encoding the
5841 ;; rest.
5842 ;; We do this on all platforms, because even if we are not
5843 ;; running on DOS/Windows, the current directory may be on a
5844 ;; mounted VFAT filesystem, such as a USB memory stick.
5848 ;; For multibyte characters, this will produce more than
5849 ;; 2 hex digits, so is not true URL encoding.
5853 ;; Generate the file name.
5859 ;; Try a few alternative directories, to get one we can
5860 ;; write it.
5866 ;; Don't modify remote (ange-ftp) filenames
5868 ;; The call to convert-standard-filename is in case
5869 ;; buffer-name includes characters not allowed by the
5870 ;; DOS/Windows filesystems. make-temp-file writes to the
5871 ;; file it creates, so we must fix the file name _before_
5872 ;; make-temp-file is called.
5874 fname))
5876 ;; make-temp-file creates the file,
5877 ;; but we don't want it to exist until we do an auto-save.
5881 file-name)))
5884 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5885 FILENAME should lack slashes. You can redefine this for customization."
5887 \f
5889 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5890 The generated regexp will match a filename only if the filename
5891 matches that wildcard according to shell rules. Only wildcards known
5892 by `sh' are supported."
5894 ;; Copy the initial run of non-special characters.
5897 ;; If no special characters, we're almost done.
5901 j)
5903 result
5924 ;; Found "[^". Insert a `\0' character
5925 ;; (which cannot happen in a filename)
5926 ;; into the character class, so that `^'
5927 ;; is not the first character after `[',
5928 ;; and thus non-special in a regexp.
5933 ;; I don't think `]' can appear in a
5934 ;; character class in a wildcard, but
5935 ;; let's be general here.
5942 i
5955 ;; Shell wildcards should match the entire filename,
5956 ;; not its part. Make the regexp say so.
5958 \f
5961 "Switches for `list-directory' to pass to `ls' for brief listing."
5967 "Switches for `list-directory' to pass to `ls' for verbose listing."
5972 "Expand wildcard pattern PATTERN.
5973 This returns a list of file names which match the pattern.
5975 If PATTERN is written as an absolute file name,
5976 the values are absolute also.
5978 If PATTERN is written as a relative file name, it is interpreted
5979 relative to the current default directory, `default-directory'.
5980 The file names returned are normally also relative to the current
5981 default directory. However, if FULL is non-nil, they are absolute."
5985 ;; A list of all dirs that DIRPART specifies.
5986 ;; This can be more than one dir
5987 ;; if DIRPART contains wildcards.
5991 dirpart)))
5995 contents)
6000 ;; Filter out "." and ".."
6005 name))
6012 this-dir-contents)
6013 this-dir-contents)
6014 contents)))))
6015 contents)))
6017 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6021 "Display a list of files in or matching DIRNAME, a la `ls'.
6022 DIRNAME is globbed by the shell if necessary.
6023 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6024 Actions controlled by variables `list-directory-brief-switches'
6025 and `list-directory-verbose-switches'."
6029 nil default-directory nil)
6030 pfx)))
6032 list-directory-brief-switches))
6033 buffer)
6045 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6053 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6055 PATTERN is assumed to represent a file-name wildcard suitable for the
6056 underlying filesystem. For Unix and GNU/Linux, each character from the
6058 the parts of the pattern which don't include wildcard characters are
6059 quoted with double quotes.
6062 on Windows), so PATTERN can use them to quote wildcard characters that
6063 need to be passed verbatim to shell commands."
6067 ;; DOS/Windows don't allow `"' in file names. So if the
6068 ;; argument has quotes, we can safely assume it is already
6069 ;; quoted by the caller.
6071 ;; We quote [&()#$'] in case their shell is a port of a
6072 ;; Unixy shell. We quote [,=+] because stock DOS and
6073 ;; Windows shells require that in some cases, such as
6074 ;; passing arguments to batch files that use positional
6075 ;; arguments like %1.
6077 pattern
6080 end)
6097 pattern))))
6104 "Program to get the amount of free space on a file system.
6105 We assume the output has the format of `df'.
6106 The value of this variable must be just a command name or file name;
6107 if you want to specify options, use `directory-free-space-args'.
6109 A value of nil disables this feature.
6111 If the function `file-system-info' is defined, it is always used in
6112 preference to the program given by this variable."
6118 "Options to use when running `directory-free-space-program'."
6123 "Return the amount of free space on directory DIR's file system.
6124 The return value is a string describing the amount of free
6125 space (normally, the number of free 1KB blocks).
6127 This function calls `file-system-info' if it is available, or
6128 invokes the program specified by `directory-free-space-program'
6129 and `directory-free-space-args'. If the system call or program
6130 is unsuccessful, or if DIR is a remote directory, this function
6131 returns nil."
6133 ;; Try to find the number of free blocks. Non-Posix systems don't
6134 ;; always have df, but might have an equivalent system call.
6143 ;; Avoid failure if the default directory does
6144 ;; not exist (Bug#2631, Bug#3911).
6148 nil t nil
6149 directory-free-space-args
6152 ;; Assume that the "available" column is before the
6153 ;; "capacity" column. Find the "%" and scan backward.
6157 "[[:space:]]+[^[:space:]]+%[^%]*$"
6164 ;; The following expression replaces `dired-move-to-filename-regexp'.
6168 ;; In some locales, month abbreviations are as short as 2 letters,
6169 ;; and they can be followed by ".".
6170 ;; In Breton, a month name can include a quote character.
6183 s "+"
6186 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6187 ;; omits the Kanji characters after month and day-of-month.
6188 ;; On Mac OS X 10.3, the date format in East Asian locales is
6189 ;; day-of-month digits followed by month digits.
6195 ;; The "[0-9]" below requires the previous column to end in a digit.
6196 ;; This avoids recognizing `1 may 1997' as a date in the line:
6197 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6199 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6201 ;; For non-iso date formats, we add the ".*" in order to find
6202 ;; the last possible match. This avoids recognizing
6203 ;; `jservice 10 1024' as a date in the line:
6204 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6206 ;; vc dired listings provide the state or blanks between file
6207 ;; permissions and date. The state is always surrounded by
6208 ;; parentheses:
6209 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6210 ;; This is not supported yet.
6215 "Regular expression to match up to the file name in a directory listing.
6216 The default value is designed to recognize dates and times
6221 ;; insert-directory
6222 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6223 ;; FULL-DIRECTORY-P is nil.
6224 ;; The single line of output must display FILE's name as it was
6225 ;; given, namely, an absolute path name.
6226 ;; - must insert exactly one line for each file if WILDCARD or
6227 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6228 ;; before the file lines, plus optional text after the file lines.
6229 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6230 ;; allowed.
6231 ;; File lines should display the basename.
6232 ;; - must be consistent with
6233 ;; - functions dired-move-to-filename, (these two define what a file line is)
6234 ;; dired-move-to-end-of-filename,
6235 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6236 ;; dired-insert-headerline
6237 ;; dired-after-subdir-garbage (defines what a "total" line is)
6238 ;; - variable dired-subdir-regexp
6239 ;; - may be passed "--dired" as the first argument in SWITCHES.
6240 ;; Filename handlers might have to remove this switch if their
6241 ;; "ls" command does not support it.
6243 "Insert directory listing for FILE, formatted according to SWITCHES.
6244 Leaves point after the inserted text.
6245 SWITCHES may be a string of options, or a list of strings
6246 representing individual options.
6247 Optional third arg WILDCARD means treat FILE as shell wildcard.
6248 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6249 switches do not contain `d', so that a full listing is expected.
6251 This works by running a directory listing program
6252 whose name is in the variable `insert-directory-program'.
6253 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6255 When SWITCHES contains the long `--dired' option, this function
6256 treats it specially, for the sake of dired. However, the
6257 normally equivalent short `-D' option is just passed on to
6258 `insert-directory-program', as any other option."
6259 ;; We need the directory in order to find the right handler.
6264 wildcard full-directory-p)
6267 ;; Read the actual directory using `insert-directory-program'.
6268 ;; RESULT gets the status code.
6270 ;; putting text property `dired-filename, decode one
6271 ;; bunch by one to preserve that property.
6273 ;; This is to control encoding the arguments in call-process.
6277 default-file-name-coding-system))))
6280 ;; Run ls in the directory part of the file pattern
6281 ;; using the last component as argument.
6287 ;; NB since switches is passed to the shell, be
6288 ;; careful of malicious values, eg "-l;reboot".
6289 ;; See eg dired-safe-switches-p.
6291 shell-file-name nil t nil
6292 "-c"
6294 ""
6296 insert-directory-program
6297 " -d "
6299 switches
6301 " -- "
6302 ;; Quote some characters that have
6303 ;; special meanings in shells; but
6304 ;; don't quote the wildcards--we want
6305 ;; them to be special. We also
6306 ;; currently don't quote the quoting
6307 ;; characters in case people want to
6308 ;; use them explicitly to quote
6309 ;; wildcard characters.
6311 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6312 ;; directory if FILE is a symbolic link.
6320 insert-directory-program nil t nil
6324 ;; Split the switches at any spaces so we can
6325 ;; pass separate options as separate args.
6327 ;; Avoid lossage if FILE starts with `-'.
6335 file))))))))
6337 ;; If we got "//DIRED//" in the output, it means we got a real
6338 ;; directory listing, even if `ls' returned nonzero.
6339 ;; So ignore any errors.
6352 ;; The first time ls returns an error,
6353 ;; find the version numbers of ls,
6354 ;; and set insert-directory-ls-version
6355 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6356 ;; is equal or if the info cannot be obtained.
6357 ;; (That can mean it isn't GNU ls.)
6367 comparison)
6383 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6387 ;; If `insert-directory-program' failed, signal an error.
6389 ;; Delete the error message it may have output.
6391 ;; On non-Posix systems, we cannot open a directory, so
6392 ;; don't even try, because that will always result in
6393 ;; the ubiquitous "Access denied". Instead, show the
6394 ;; command line so the user can try to guess what went wrong.
6399 insert-directory-program
6401 file result)
6402 ;; Unix. Access the file to get a suitable error.
6409 ;; The following overshoots by one line for an empty
6410 ;; directory listed with "--dired", but without "-a"
6411 ;; switch, where the ls output contains a
6412 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6413 ;; We take care of that case later.
6421 error-lines)
6422 ;; Find all the lines that are error messages,
6423 ;; and record the bounds of each one.
6430 ;; Now read the numeric positions of file names.
6437 error-lines))
6440 error-lines)))
6442 ;; End is followed by \n or by " -> ".
6444 ;; It seems that we can't trust ls's output as to
6445 ;; byte positions of filenames.
6451 ;; Take care of the case where the ls output contains a
6452 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6453 ;; and we went one line too far back (see above).
6458 ;; Now decode what read if necessary.
6460 file-name-coding-system
6461 default-file-name-coding-system
6463 coding-no-eol
6464 val pos)
6468 ;; If no coding system is specified or detection is
6469 ;; requested, detect the coding.
6483 ;; Force no eol conversion on a file name, so
6484 ;; that CR is preserved.
6492 ;; Try to insert the amount of free space.
6495 ;; First find the line to put it on.
6499 ;; Replace "total" with "used", to avoid confusion.
6505 "Convert `ls --dired' file name position value POS to a buffer position.
6506 File name position values returned in ls --dired output
6507 count only stdout; they don't count the error messages sent to stderr.
6508 So this function converts to them to real buffer positions.
6509 ERROR-LINES is a list of buffer positions of error message lines,
6510 of the form (START END)."
6514 pos)
6518 "Insert directory listing for FILE, formatted according to SWITCHES.
6520 Like `insert-directory', but if FILE does not exist, it inserts a
6521 message to that effect instead of signaling an error."
6524 ;; Simulate the message printed by `ls'.
6528 "Functions to call with no arguments to query about killing Emacs.
6529 If any of these functions returns nil, killing Emacs is canceled.
6530 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6534 "How to ask for confirmation when leaving Emacs.
6535 If nil, the default, don't ask at all. If the value is non-nil, it should
6536 be a predicate function; for example `yes-or-no-p'."
6545 "Offer to save each buffer, then kill this Emacs process.
6546 With prefix ARG, silently save all file-visiting buffers without asking.
6547 If there are active processes where `process-query-on-exit-flag'
6548 returns non-nil, asks whether processes should be killed.
6549 Runs the members of `kill-emacs-query-functions' in turn and stops
6550 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6559 ;; process-list is not defined on MSDOS.
6561 active)
6577 ;; Query the user for other things, perhaps.
6584 "Offer to save each buffer, then kill the current connection.
6585 If the current frame has no client, kill Emacs itself.
6587 With prefix ARG, silently save all file-visiting buffers, then kill.
6589 If emacsclient was started with a list of filenames to edit, then
6590 only these files will be asked to be saved."
6595 \f
6596 ;; We use /: as a prefix to "quote" a file name
6597 ;; so that magic file name handlers will not apply to it.
6601 file-name-handler-alist))
6603 ;; We depend on being the last handler on the list,
6604 ;; so that anything else which does need handling
6605 ;; has been handled already.
6606 ;; So it is safe for us to inhibit *all* magic file name handlers.
6615 default-directory))
6616 ;; Get a list of the indices of the args which are file names.
6619 ;; The first six are special because they
6620 ;; return a file name. We want to include the /:
6621 ;; in the return value.
6622 ;; So just avoid stripping it in the first place.
6629 ;; `identity' means just return the first arg
6630 ;; not stripped of its quoting.
6632 ;; `add' means add "/:" to the result.
6635 ;; `unquote-then-quote' means set buffer-file-name
6636 ;; temporarily to unquoted filename.
6638 ;; List the arguments which are filenames.
6646 ;; For all other operations, treat the first argument only
6647 ;; as the file name.
6649 method
6650 ;; Copy ARGUMENTS so we can replace elements in it.
6654 ;; Strip off the /: from the file names that have it.
6662 "/"
6668 (`insert-file-contents
6674 (`unquote-then-quote
6679 \f
6680 ;; Symbolic modes and read-file-modes.
6683 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6684 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6685 Others, or All) for whom to produce the mask.
6686 The bit-mask that is returned extracts from mode bits the access rights
6687 for the specified category of users."
6695 "Convert CHAR to a numeric value of mode bits.
6696 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6697 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6704 ;; Rights relative to the previous file modes.
6715 "Convert a symbolic mode string specification to an equivalent number.
6717 WHO-MASK is the bit-mask specifying the category of users to which to
6718 apply the access permissions. See `file-modes-char-to-who'.
6719 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6720 RIGHTS request to add, remove, or set permissions based on existing ones,
6727 char-right)
6734 num-rights
6738 op char-right)))
6739 num-rights))
6742 "Convert symbolic file modes to numeric file modes.
6743 MODES is the string to convert, it should match
6745 See Info node `(coreutils)File permissions' for more information on this
6746 notation.
6747 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6748 MODES request to add, remove, or set permissions based on existing ones,
6762 num-who num-modes)
6765 num-modes)))
6768 "Read file modes in octal or symbolic notation and return its numeric value.
6769 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6770 ORIG-FILE is the name of a file on whose mode bits to base returned
6771 permissions if what user types requests to add, remove, or set permissions
6787 nil nil default)))
6796 ;; Trashcan handling.
6798 "Directory for `move-file-to-trash' to move files and directories to.
6799 This directory is only used when the function `system-move-file-to-trash'
6800 is not defined.
6801 Relative paths are interpreted relative to `default-directory'.
6802 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6812 "Move the file (or directory) named FILENAME to the trash.
6813 When `delete-by-moving-to-trash' is non-nil, this function is
6814 called by `delete-file' and `delete-directory' instead of
6815 deleting files outright.
6817 If the function `system-move-file-to-trash' is defined, call it
6818 with FILENAME as an argument.
6819 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6820 directory.
6821 Otherwise, trash FILENAME using the freedesktop.org conventions,
6822 like the GNOME, KDE and XFCE desktop environments. Emacs only
6826 ;; If `trash-directory' is non-nil, move the file there.
6830 trash-dir)))
6831 ;; We can't trash a parent directory of trash-directory.
6834 trash-dir filename))
6837 ;; Ensure that the trashed file-name is unique.
6844 ;; If `system-move-file-to-trash' is defined, use it.
6847 ;; Otherwise, use the freedesktop.org method, as specified at
6848 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6859 ;; Check if we have permissions to delete.
6863 ;; The trashed file cannot be the trash dir or its parent.
6866 trash-files-dir filename))
6869 trash-info-dir filename))
6871 ;; Ensure that the trash directory exists; otherwise, create it.
6878 ;; Try to move to trash with .trashinfo undo information
6883 ;; Perform url-encoding on FN. For compatibility with
6884 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6885 ;; for path separators.
6890 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6891 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6904 fn))
6909 ;; Attempt to make .trashinfo file, trying up to 5
6910 ;; times. The .trashinfo file is opened with O_EXCL,
6911 ;; as per trash-spec 0.7, even if that can be a problem
6912 ;; on old NFS versions...
6916 trash-files-dir))
6918 success info-fn)
6923 trash-info-dir))
6931 ;; Uniquify new-fn. (Some file managers do not
6932 ;; like Emacs-style backup file names---e.g. bug
6933 ;; 170956 in Konqueror bug tracker.)
6938 ;; Finally, try to move the file to the trashcan.
6942 \f
6967 ;;; files.el ends here