| blob | 83ef4e271cdad06008a09d378b62a72747c71ebf |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
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 a match for FROM with TO when a directory name matches FROM. This
55 replacement is done when setting up the default directory of a
56 newly visited file buffer.
58 FROM is a regexp that is matched against directory names anchored at
62 FROM and TO should be equivalent names, which refer to the
63 same directory. TO should be an absolute directory name.
64 Do not use `~' in the TO strings.
66 Use this feature when you have directories which you normally refer to
67 via absolute symbolic links. Make TO the name of the link, and FROM
68 a regexp matching the name it is linked to."
77 "Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
100 "If non-nil, backups will be inhibited.
101 This variable is intended for use by making it local to a buffer,
106 "Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
112 "Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
119 "Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
131 "Non-nil means create backups by copying to preserve a privileged owner.
132 Renaming may still be used (subject to control of other variables)
133 when it would not result in changing the owner of the file or if the owner
134 has a user id greater than the value of this variable. This is useful
135 when low-numbered uid's are used for special system users (such as root)
136 that must maintain ownership of certain files.
137 This variable is relevant only if `backup-by-copying' and
138 `backup-by-copying-when-mismatch' are nil."
143 "Predicate that looks at a file name and decides whether to make backups.
147 "Non-nil in a buffer means always offer to save buffer on exit.
148 Do so even if the buffer is not visiting a file.
149 Automatically local in all buffers."
156 "Non-nil means find a file under alternative names, in existing buffers.
157 This means if any existing buffer is visiting the file you want
158 under another name, you get the existing buffer instead of a new buffer."
163 "Non-nil means visiting a file uses its truename as the visited-file name.
164 That is, the buffer visiting the file has the truename as the
165 value of `buffer-file-name'. The truename of a file is found by
166 chasing all links both at the file level and at the levels of the
167 containing directories."
173 "Specify which files should be reverted without query.
174 The value is a list of regular expressions.
175 If the file name matches one of these regular expressions,
176 then `revert-buffer' reverts the file without querying
177 if the file has changed on disk and you have not edited the buffer."
182 "The device number and file number of the file visited in the current buffer.
183 The value is a list of the form (FILENUM DEVNUM).
184 This pair of numbers uniquely identifies the file.
198 "The directory for writing small temporary files.
199 If non-nil, this directory is used instead of `temporary-file-directory'
200 by programs that create small temporary files. This is for systems that
201 have fast storage with limited space, such as a RAM disk."
206 ;; The system null device. (Should reference NULL_DEVICE from C.)
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
254 "Whether to allow breaking hardlinks when saving files.
255 If non-nil, then when saving a file that exists under several
256 names \(i.e., has multiple hardlinks), break the hardlink
257 associated with `buffer-file-name' and write to a new file, so
258 that the other instances of the file are not affected by the
259 save.
261 If `buffer-file-name' refers to a symlink, do not break the symlink.
263 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
264 For example, if the directory in which a file is being saved is not
265 itself writable, then error instead of saving in some
266 hardlink-nonbreaking way.
268 See also `backup-by-copying' and `backup-by-copying-when-linked'."
274 "Control use of version numbers for backup files.
275 When t, make numeric backup versions unconditionally.
276 When nil, make them for files that have some already.
277 The value `never' means do not make them."
287 "When cleaning directory, number of versions to keep."
293 "If t, delete excess backup versions silently.
294 If nil, ask confirmation. Any other value prevents any trimming."
301 "Number of oldest versions to keep when a new numbered backup is made."
307 "Number of newest versions to keep when a new numbered backup is made.
308 Includes the new backup. Must be > 0"
314 "Whether to add a newline automatically at the end of the file.
316 A value of t means do this only when the file is about to be saved.
317 A value of `visit' means do this right after the file is visited.
318 A value of `visit-save' means do it at both of those times.
319 Any other non-nil value means ask user whether to add a newline, when saving.
320 A value of nil means don't add newlines.
322 Certain major modes set this locally to the value obtained
323 from `mode-require-final-newline'."
333 "Whether to add a newline at end of file, in certain major modes.
334 Those modes set `require-final-newline' to this value when you enable them.
335 They do so because they are often used for files that are supposed
336 to end in newlines, and the question is how to arrange that.
338 A value of t means do this only when the file is about to be saved.
339 A value of `visit' means do this right after the file is visited.
340 A value of `visit-save' means do it at both of those times.
341 Any other non-nil value means ask user whether to add a newline, when saving.
343 A value of nil means do not add newlines. That is a risky choice in this
344 variable since this value is used for modes for files that ought to have
345 final newlines. So if you set this to nil, you must explicitly check and
346 add a final newline, whenever you save a file that really needs one."
356 "Non-nil says by default do auto-saving of every file-visiting buffer."
362 ;; Don't put "\\2" inside expand-file-name, since it will be
363 ;; transformed to "/2" on DOS/Windows.
365 "Transforms to apply to buffer file name before making auto-save file name.
366 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
367 REGEXP is a regular expression to match against the file name.
368 If it matches, `replace-match' is used to replace the
369 matching part with REPLACEMENT.
370 If the optional element UNIQUIFY is non-nil, the auto-save file name is
371 constructed by taking the directory part of the replaced file-name,
372 concatenated with the buffer file name with all directory separators
373 changed to `!' to prevent clashes. This will not work
374 correctly if your filesystem truncates the resulting name.
376 All the transforms in the list are tried, in the order they are listed.
377 When one transform applies, its result is final;
378 no further transforms are tried.
380 The default value is set up to put the auto-save file into the
381 temporary directory (see the variable `temporary-file-directory') for
382 editing a remote file.
384 On MS-DOS filesystems without long names this variable is always
385 ignored."
393 "Non-nil means save word abbrevs too when files are saved.
394 If `silently', don't ask the user before saving."
399 "Non-nil means allow `find-file' to visit directories.
400 To visit the directory, `find-file' runs `find-directory-functions'."
405 "List of functions to try in sequence to visit a directory.
406 Each function is called with the directory name as the sole argument
407 and should return either a buffer or nil."
411 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
413 "List of functions to try in sequence to get a file name at point.
414 Each function should return either nil or a file name found at the
415 location of point in the current buffer."
419 ;;;It is not useful to make this a local variable.
420 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
424 "List of functions to be called for `find-file' on nonexistent file.
425 These functions are called as soon as the error is detected.
426 Variable `buffer-file-name' is already set up.
429 ;;;It is not useful to make this a local variable.
430 ;;;(put 'find-file-hooks 'permanent-local t)
433 "List of functions to be called after a buffer is loaded from a file.
434 The buffer's local variables (if any) will have been processed before the
435 functions are called."
443 "List of functions to be called before saving a buffer to a file.
444 Only used by `save-buffer'.
445 If one of them returns non-nil, the file is considered already written
446 and the rest are not called.
447 These hooks are considered to pertain to the visited file.
448 So any buffer-local binding of this variable is discarded if you change
450 change the major mode.
452 This hook is not run if any of the functions in
453 `write-contents-functions' returns non-nil. Both hooks pertain
454 to how to save a buffer to file, for instance, choosing a suitable
455 coding system and setting mode bits. (See Info
456 node `(elisp)Saving Buffers'.) To perform various checks or
468 "List of functions to be called before writing out a buffer to a file.
469 Only used by `save-buffer'.
470 If one of them returns non-nil, the file is considered already written
471 and the rest are not called and neither are the functions in
472 `write-file-functions'.
474 This variable is meant to be used for hooks that pertain to the
475 buffer's contents, not to the particular visited file; thus,
476 `set-visited-file-name' does not clear this variable; but changing the
477 major mode does clear it.
479 For hooks that _do_ pertain to the particular visited file, use
480 `write-file-functions'. Both this variable and
481 `write-file-functions' relate to how a buffer is saved to file.
482 To perform various checks or updates before the buffer is saved,
487 "Control use of local variables in files you visit.
488 The value can be t, nil, :safe, :all, or something else.
490 A value of t means file local variables specifications are obeyed
491 if all the specified variable values are safe; if any values are
492 not safe, Emacs queries you, once, whether to set them all.
493 \(When you say yes to certain values, they are remembered as safe.)
495 :safe means set the safe variables, and ignore the rest.
496 :all means set all variables, whether safe or not.
497 (Don't set it permanently to :all.)
498 A value of nil means always ignore the file local variables.
500 Any other value means always query you once whether to set them all.
501 \(When you say yes to certain values, they are remembered as safe, but
504 This variable also controls use of major modes specified in
505 a -*- line.
508 always obeys file local variable specifications and the -*- line,
509 and ignores this variable."
510 :risky t
519 "Non-nil means enable use of directory-local variables.
520 Some modes may wish to set this to nil to prevent directory-local
523 ;; This is an odd variable IMO.
524 ;; You might wonder why it is needed, when we could just do:
525 ;; (set (make-local-variable 'enable-local-variables) nil)
526 ;; These two are not precisely the same.
527 ;; Setting this variable does not cause -*- mode settings to be
528 ;; ignored, whereas setting enable-local-variables does.
529 ;; Only three places in Emacs use this variable: tar and arc modes,
530 ;; and rmail. The first two don't need it. They already use
531 ;; inhibit-local-variables-regexps, which is probably enough, and
532 ;; could also just set enable-local-variables locally to nil.
533 ;; Them setting it has the side-effect that dir-locals cannot apply to
534 ;; eg tar files (?). FIXME Is this appropriate?
535 ;; AFAICS, rmail is the only thing that needs this, and the only
536 ;; reason it uses it is for BABYL files (which are obsolete).
537 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
538 ;; to respect, so that find-file on a BABYL file will switch to
539 ;; rmail-mode automatically (this is nice, but hardly essential,
540 ;; since most people are used to explicitly running a command to
541 ;; access their mail; M-x gnus etc). Rmail files may happen to
542 ;; contain Local Variables sections in messages, which Rmail wants to
543 ;; ignore. So AFAICS the only reason this variable exists is for a
544 ;; minor convenience feature for handling of an obsolete Rmail file format.
546 "Like `enable-local-variables' but meant for buffer-local bindings.
547 The meaningful values are nil and non-nil. The default is non-nil.
548 If a major mode sets this to nil, buffer-locally, then any local
549 variables list in a file visited in that mode will be ignored.
551 This variable does not affect the use of major modes specified
556 The value can be t, nil or something else.
557 A value of t means obey `eval' variables.
558 A value of nil means ignore them; anything else means query."
559 :risky t
566 "Non-nil means buffers visiting files read-only do so in view mode.
567 In fact, this means that all read-only buffers normally have
568 View mode enabled, including buffers that are read-only because
569 you visit a file you cannot alter, and buffers you make read-only
575 "History list of file names entered in the minibuffer.
577 Maximum length of the history list is determined by the value
581 "If non-nil, avoid messages when saving files.
582 Error-related messages will still be printed, but all other
585 \f
588 "Provides support for ange-ftp host name completion.
589 Runs the usual ange-ftp hook, but only for completion operations."
590 ;; Having this here avoids the need to load ange-ftp when it's not
591 ;; really in use.
597 inhibit-file-name-handlers)))
605 "Convert a standard file's name to something suitable for the OS.
606 This means to guarantee valid names and perhaps to canonicalize
607 certain patterns.
609 FILENAME should be an absolute file name since the conversion rules
610 sometimes vary depending on the position in the file name. E.g. c:/foo
611 is a valid DOS file name, but c:/bar/c:/foo is not.
613 This function's standard definition is trivial; it just returns
614 the argument. However, on Windows and DOS, replace invalid
615 characters. On DOS, make sure to obey the 8.3 limitations.
616 In the native Windows build, turn Cygwin names into native names,
617 and also turn slashes into backslashes if the shell requires it (see
618 `w32-shell-dos-semantics').
620 See Info node `(elisp)Standard File Names' for more details."
625 ;; Replace invalid filename characters with !
629 name))
637 "Read directory name, prompting with PROMPT and completing in directory DIR.
638 Value is not expanded---you must call `expand-file-name' yourself.
639 Default name to DEFAULT-DIRNAME if user exits with the same
640 non-empty string that was inserted by this function.
641 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
642 or just DIR if INITIAL is nil.)
643 If the user exits with an empty minibuffer, this function returns
644 an empty string. (This can only happen if the user erased the
645 pre-inserted contents or if `insert-default-directory' is nil.)
646 Fourth arg MUSTMATCH non-nil means require existing directory's name.
647 Non-nil and non-t means also require confirmation after completion.
648 Fifth arg INITIAL specifies text to start with.
649 DIR should be an absolute directory name. It defaults to
650 the value of `default-directory'."
655 dir))
656 mustmatch initial
659 \f
661 "Show the current default directory.
662 With prefix argument INSERT, insert the current default directory
663 at point instead."
670 "Value of the CDPATH environment variable, as a list.
674 "Explode a search path into a list of directory names.
675 Directories are separated by `path-separator' (which is colon in
676 GNU and Unix systems). Substitute environment variables into the
677 resulting list of directory names. For an empty path element (i.e.,
678 a leading or trailing separator, or two adjacent separators), return
679 nil (meaning `default-directory') as the associated list element."
687 "Change current directory to given absolute file name DIR."
688 ;; Put the name into directory syntax now,
689 ;; because otherwise expand-file-name may give some bad results.
691 ;; We used to additionally call abbreviate-file-name here, for an
692 ;; unknown reason. Problem is that most buffers are setup
693 ;; without going through cd-absolute and don't call
694 ;; abbreviate-file-name on their default-directory, so the few that
695 ;; do end up using a superficially different directory.
707 "Make DIR become the current buffer's default directory.
708 If your environment includes a `CDPATH' variable, try each one of
709 that list of directories (separated by occurrences of
710 `path-separator') when resolving a relative directory name.
711 The path separator is colon in GNU and GNU-like systems."
714 ;; FIXME: There's a subtle bug in the completion below. Seems linked
715 ;; to a fundamental difficulty of implementing `predicate' correctly.
716 ;; The manifestation is that TAB may list non-directories in the case where
717 ;; those files also correspond to valid directories (if your cd-path is (A/
718 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
719 ;; will be listed as valid completions).
720 ;; This is because `a' (listed because of A/a) is indeed a valid choice
721 ;; (which will lead to the use of B/a).
726 cd-path nil))
735 default-directory default-directory
736 t))))
746 "Return non-nil if NAME ends with a directory separator character."
756 "Return list of all files under DIR that have file names matching REGEXP.
758 order, and files from each directory are sorted in alphabetical order.
759 Each file name appears in the returned list in its absolute form.
760 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
761 output directories whose names match REGEXP."
764 ;; When DIR is "/", remote file names like "/method:" could
765 ;; also be offered. We shall suppress them.
773 ;; Don't follow symlinks to other directories.
777 full-file regexp include-directories))))
788 "Load the Lisp file named FILE."
789 ;; This is a case where .elc and .so/.dll make a lot of sense.
793 completion-ignored-extensions))))
798 "Search for FILENAME through PATH.
799 If found, return the absolute file name of FILENAME; otherwise
800 return nil.
801 PATH should be a list of directories to look in, like the lists in
802 `exec-path' or `load-path'.
803 If SUFFIXES is non-nil, it should be a list of suffixes to append to
806 If non-nil, PREDICATE is used instead of `file-readable-p'.
808 This function will normally skip directories, so if you want it to find
809 directories, make sure the PREDICATE function returns `dir-ok' for them.
811 PREDICATE can also be an integer to pass to the `access' system call,
812 in which case file-name handlers are ignored. This usage is deprecated.
813 For compatibility, PREDICATE can also be one of the symbols
814 `executable', `readable', `writable', or `exists', or a list of
815 one or more of those symbols."
826 "Do completion for file names passed to `locate-file'."
829 ;; FIXME: maybe we should use completion-file-name-table instead,
830 ;; tho at least for `load', the arg is passed through
831 ;; substitute-in-file-name for historical reasons.
841 ;; If we have files like "foo.el" and "foo.elc", we could load one of
842 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
843 ;; preferred way. So if we list all 3, that gives a lot of redundant
844 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
845 ;; the user does want to pay attention to the extension. We try to
846 ;; diffuse this tension by stripping the suffix, except when the
847 ;; result is a single element (i.e. usually we only list "foo" unless
848 ;; it's the only remaining element in the list, in which case we do
849 ;; list "foo", "foo.elc" and "foo.el").
860 string-file dir))
865 ;; Switching from names to names+fullnames creates a non-monotonicity
866 ;; which can cause problems with things like partial-completion.
867 ;; To minimize the problem, filter out completion-regexp-list, so that
868 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
869 ;; from `names' which only matched `string' when they still had
870 ;; their suffix.
872 ;; Remove duplicates of the first element, so that we can easily check
873 ;; if `names' really only contains a single element.
876 ;; There's no more than one matching non-suffixed element, so expand
877 ;; the list by adding the suffixed elements as well.
880 string-dir names string-file pred action)))))
883 "Do completion for file names passed to `locate-file'.
884 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
888 string nil action))
892 "Regexp of directory names which stop the search in `locate-dominating-file'.
893 Any directory whose name matches this regexp will be treated like
894 a kind of root directory by `locate-dominating-file' which will stop its search
895 when it bumps into it.
896 The default regexp prevents fruitless and time-consuming attempts to find
897 special files in directories in which filenames are interpreted as hostnames,
900 ;; (defun locate-dominating-files (file regexp)
901 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
902 ;; Stop at the first parent where a matching file is found and return the list
903 ;; of files that that match in this directory."
904 ;; (catch 'found
905 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
906 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
907 ;; (let ((user nil)
908 ;; ;; Abbreviate, so as to stop when we cross ~/.
909 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
910 ;; files)
911 ;; (while (and dir
912 ;; ;; As a heuristic, we stop looking up the hierarchy of
913 ;; ;; directories as soon as we find a directory belonging to
914 ;; ;; another user. This should save us from looking in
915 ;; ;; things like /net and /afs. This assumes that all the
916 ;; ;; files inside a project belong to the same user.
917 ;; (let ((prev-user user))
918 ;; (setq user (nth 2 (file-attributes dir)))
919 ;; (or (null prev-user) (equal user prev-user))))
920 ;; (if (setq files (condition-case nil
921 ;; (directory-files dir 'full regexp 'nosort)
922 ;; (error nil)))
923 ;; (throw 'found files)
924 ;; (if (equal dir
925 ;; (setq dir (file-name-directory
926 ;; (directory-file-name dir))))
927 ;; (setq dir nil))))
928 ;; nil)))
931 "Look up the directory hierarchy from FILE for a directory containing NAME.
932 Stop at the first parent directory containing a file NAME,
933 and return the directory. Return nil if not found.
934 Instead of a string, NAME can also be a predicate taking one argument
935 \(a directory) and returning a non-nil value if that directory is the one for
936 which we're looking."
937 ;; We used to use the above locate-dominating-files code, but the
938 ;; directory-files call is very costly, so we're much better off doing
939 ;; multiple calls using the code in here.
940 ;;
941 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
942 ;; `name' in /home or in /.
945 ;; `user' is not initialized outside the loop because
946 ;; `file' may not exist, so we may have to walk up part of the
947 ;; hierarchy before we find the "initial UID". Note: currently unused
948 ;; (user nil)
949 try)
952 ;; FIXME: Disabled this heuristic because it is sometimes
953 ;; inappropriate.
954 ;; As a heuristic, we stop looking up the hierarchy of
955 ;; directories as soon as we find a directory belonging
956 ;; to another user. This should save us from looking in
957 ;; things like /net and /afs. This assumes that all the
958 ;; files inside a project belong to the same user.
959 ;; (let ((prev-user user))
960 ;; (setq user (nth 2 (file-attributes file)))
961 ;; (and prev-user (not (equal user prev-user))))
973 "Non-nil means warn if cannot access `user-emacs-directory'.
974 Set this to nil at your own risk..."
980 "Return an absolute per-user Emacs-specific file name.
981 If NEW-NAME exists in `user-emacs-directory', return it.
982 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
983 Else return NEW-NAME in `user-emacs-directory', creating the
984 directory if it does not exist."
992 at-home
993 ;; Make sure `user-emacs-directory' exists,
994 ;; unless we're in batch mode or dumping Emacs.
996 purify-flag
1006 user-emacs-directory-warning
1008 ;; Only warn once per Emacs session.
1012 Unable to %s `user-emacs-directory' (%s).
1013 Any data that would normally be written there may be lost!
1014 If you never want to see this message again,
1015 customize the variable `user-emacs-directory-warning'."
1016 errtype user-emacs-directory)))))
1017 bestname))))
1021 "Search for COMMAND in `exec-path' and return the absolute file name.
1022 Return nil if COMMAND is not found anywhere in `exec-path'."
1023 ;; Use 1 rather than file-executable-p to better match the behavior of
1024 ;; call-process.
1028 "Load the Emacs Lisp library named LIBRARY.
1029 LIBRARY should be a string.
1030 This is an interface to the function `load'. LIBRARY is searched
1031 for in `load-path', both with and without `load-suffixes' (as
1032 well as `load-file-rep-suffixes').
1034 See Info node `(emacs)Lisp Libraries' for more details.
1035 See `load-file' for a different interface to `load'."
1040 load-path
1045 "Test whether FILE specifies a location on a remote system.
1046 A file is considered remote if accessing it is likely to
1047 be slower or less reliable than accessing local files.
1049 `file-remote-p' never opens a new remote connection. It can
1050 only reuse a connection that is already open.
1052 Return nil or a string identifying the remote connection
1053 \(ideally a prefix of FILE). Return nil if FILE is a relative
1054 file name.
1056 When IDENTIFICATION is nil, the returned string is a complete
1057 remote identifier: with components method, user, and host. The
1058 components are those present in FILE, with defaults filled in for
1059 any that are missing.
1061 IDENTIFICATION can specify which part of the identification to
1062 return. IDENTIFICATION can be the symbol `method', `user',
1063 `host', or `localname'. Any other value is handled like nil and
1064 means to return the complete identification. The string returned
1065 for IDENTIFICATION `localname' can differ depending on whether
1066 there is an existing connection.
1068 If CONNECTED is non-nil, return an identification only if FILE is
1069 located on a remote system and a connection is established to
1070 that remote system.
1072 Tip: You can use this expansion of remote identifier components
1073 to derive a new remote file name from an existing one. For
1079 same remote identifier as FILE but expanded; a name such as
1084 nil)))
1086 ;; Probably this entire variable should be obsolete now, in favor of
1087 ;; something Tramp-related (?). It is not used in many places.
1088 ;; It's not clear what the best file for this to be in is, but given
1089 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1090 ;; rather than autoloaded.
1092 ;; This used to try various hard-coded places for remsh, rsh, and
1093 ;; rcmd, trying to guess based on location whether "rsh" was
1094 ;; "restricted shell" or "remote shell", but I don't see the point
1095 ;; in this day and age. Almost everyone will use ssh, and have
1096 ;; whatever command they want to use in PATH.
1103 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1110 "Whether to use the remote file-name cache for read access.
1111 When nil, never expire cached values (caution)
1112 When t, never use the cache (safe, but may be slow)
1113 A number means use cached values for that amount of seconds since caching.
1115 The attributes of remote files are cached for better performance.
1116 If they are changed outside of Emacs's control, the cached values
1117 become invalid, and must be reread. If you are sure that nothing
1118 other than Emacs changes the files, you can set this variable to nil.
1120 If a remote file is checked regularly, it might be a good idea to
1121 let-bind this variable to a value less than the interval between
1122 consecutive checks. For example:
1124 (defun display-time-file-nonempty-p (file)
1125 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1126 (and (file-exists-p file)
1127 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1138 "Copy the file FILE into a temporary file on this machine.
1139 Returns the name of the local copy, or nil, if FILE is directly
1140 accessible."
1141 ;; This formerly had an optional BUFFER argument that wasn't used by
1142 ;; anything.
1146 nil)))
1149 "Return the truename of FILENAME.
1150 If FILENAME is not absolute, first expands it against `default-directory'.
1151 The truename of a file name is found by chasing symbolic links
1152 both at the level of the file and at the level of the directories
1153 containing it, until no links are left at any level.
1156 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1157 ;; COUNTER can be a cons cell whose car is the count of how many
1158 ;; more links to chase before getting an error.
1159 ;; PREV-DIRS can be a cons cell whose car is an alist
1160 ;; of truenames we've just recently computed.
1174 ;; For speed, remove the ange-ftp completion handler from the list.
1175 ;; We know it's not needed here.
1176 ;; For even more speed, do this only on the outermost call.
1183 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1184 ;; case differences being ignored by the OS, and short "8.3 DOS"
1185 ;; name aliases existing for all files. (The short names are not
1186 ;; reported by directory-files, but can be used to refer to files.)
1187 ;; It seems appropriate for file-truename to resolve these issues in
1188 ;; the most natural way, which on Windows is to call the function
1189 ;; `w32-long-file-name' - this returns the exact name of a file as
1190 ;; it is stored on disk (expanding short name aliases with the full
1191 ;; name in the process).
1194 ;; If filename exists, use its long name. If it doesn't
1195 ;; exist, the recursion below on the directory of filename
1196 ;; will drill down until we find a directory that exists,
1197 ;; and use the long name of that, with the extra
1198 ;; non-existent path components concatenated.
1203 ;; If this file directly leads to a link, process that iteratively
1204 ;; so that we don't use lots of stack.
1210 ;; For file name that has a special handler, call handler.
1211 ;; This is so that ange-ftp can save time by doing a no-op.
1214 done t)
1216 target dirfile)
1217 ;; Get the truename of the directory.
1219 ;; If these are equal, we have the (or a) root directory.
1223 ;; If this is the same dir we last got the truename for,
1224 ;; save time--don't recalculate.
1234 done t)
1237 done t)
1238 ;; Put it back on the file name.
1240 ;; Is the file name the name of a link?
1243 ;; Yes => chase that link, then start all over
1244 ;; since the link may point to a directory name that uses links.
1245 ;; We can't safely use expand-file-name here
1246 ;; since target might look like foo/../bar where foo
1247 ;; is itself a link. Instead, we handle . and .. above.
1250 target
1252 done nil)
1253 ;; No, we are done!
1255 filename))
1258 "Chase links in FILENAME until a name that is not a link.
1259 Unlike `file-truename', this does not check whether a parent
1260 directory name is a symbolic link.
1261 If the optional argument LIMIT is a number,
1262 it means chase no more than that many links and then stop."
1270 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1273 ;; Handle `..' by hand, since it needs to work in the
1274 ;; target of any directory symlink.
1275 ;; This code is not quite complete; it does not handle
1276 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1280 ;; Chase links in the default dir of the symlink.
1284 ;; Now find the parent of that dir.
1288 newname))
1290 ;; A handy function to display file sizes in human-readable form.
1291 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1293 "Produce a string showing FILE-SIZE in human-readable form.
1295 Optional second argument FLAVOR controls the units and the display format:
1297 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1299 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1301 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1304 1024.0
1307 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1313 "%.1f%s%s"
1315 file-size
1317 "K"
1322 "Create a temporary file.
1323 The returned file name (created by appending some random characters at the end
1324 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1325 is guaranteed to point to a newly created empty file.
1326 You can then use `write-region' to write new data into the file.
1328 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1330 If SUFFIX is non-nil, add that at the end of the file name."
1331 ;; Create temp files with strict access rights. It's easy to
1332 ;; loosen them later, whereas it's impossible to close the
1333 ;; time-window of loose permissions otherwise.
1342 temporary-file-directory)
1344 temporary-file-directory))))
1350 nil)
1352 ;; the file was somehow created by someone else between
1353 ;; `make-temp-name' and `write-region', let's try again.
1354 nil)
1355 file)))
1358 "Change the encoding of FILE's name from CODING to NEW-CODING.
1359 The value is a new name of FILE.
1360 Signals a `file-already-exists' error if a file of the new name
1361 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1362 is non-nil. A number as fourth arg means request confirmation if
1363 the new name already exists. This is what happens in interactive
1364 use with M-x."
1367 default-file-name-coding-system))
1369 from-coding to-coding)
1371 ;; We provide the default coding only when it seems that
1372 ;; the filename is correctly decoded by the default
1373 ;; coding.
1379 filename default-coding)
1380 default-coding))
1384 ;; We provide the default coding only when a user is going to
1385 ;; change the encoding not from the default coding.
1389 filename from-coding)))
1392 filename from-coding default-coding)
1393 default-coding)))
1397 default-file-name-coding-system))
1398 ;; FILE should have been decoded by DEFAULT-CODING.
1402 ;; Suppress further encoding.
1407 newname))
1408 \f
1410 "Whether confirmation is requested before visiting a new file or buffer.
1411 If nil, confirmation is not requested.
1412 If the value is `after-completion', confirmation is only
1413 requested if the user called `minibuffer-complete' right before
1414 `minibuffer-complete-and-exit'.
1415 Any other non-nil value means to request confirmation.
1417 This affects commands like `switch-to-buffer' and `find-file'."
1425 "Whether to request confirmation before visiting a new file or buffer.
1426 The variable `confirm-nonexistent-file-or-buffer' determines the
1427 return value, which may be passed as the REQUIRE-MATCH arg to
1428 `read-buffer' or `find-file-read-args'."
1436 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1438 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1439 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1440 instead of prepending it.
1442 BODY should use the minibuffer at most once.
1443 Recursive uses of the minibuffer are unaffected (FUN is not
1444 called additional times).
1446 This macro actually adds an auxiliary function that calls FUN,
1447 rather than FUN itself, to `minibuffer-setup-hook'."
1458 ;; Clear out this hook so it does not interfere
1459 ;; with any recursive minibuffer usage.
1470 t))
1473 "Edit file FILENAME.
1474 Switch to a buffer visiting file FILENAME,
1475 creating one if none already exists.
1476 Interactively, the default if you just type RET is the current directory,
1477 but the visited file name is available through the minibuffer history:
1478 type M-n to pull it into the minibuffer.
1480 You can visit files on remote machines by specifying something
1481 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1482 also visit local files as a different user by specifying
1483 /sudo::FILE for the file name.
1484 See the Info node `(tramp)File name Syntax' in the Tramp Info
1485 manual, for more about this.
1487 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1488 expand wildcards (if any) and visit multiple files. You can
1489 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1491 To visit a file without any kind of conversion and without
1502 "Edit file FILENAME, in another window.
1505 an existing one. See the function `display-buffer'.
1507 Interactively, the default if you just type RET is the current directory,
1508 but the visited file name is available through the minibuffer history:
1509 type M-n to pull it into the minibuffer.
1511 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1512 expand wildcards (if any) and visit multiple files."
1522 value)
1526 "Edit file FILENAME, in another frame.
1529 an existing one. See the function `display-buffer'.
1531 Interactively, the default if you just type RET is the current directory,
1532 but the visited file name is available through the minibuffer history:
1533 type M-n to pull it into the minibuffer.
1535 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1536 expand wildcards (if any) and visit multiple files."
1546 value)
1550 "Edit the existing file FILENAME.
1552 file names with wildcards."
1569 value))
1572 "Edit file FILENAME but don't allow changes.
1581 "Edit file FILENAME in another window but don't allow changes.
1590 "Edit file FILENAME in another frame but don't allow changes.
1599 "Find file FILENAME as a replacement for the file in the next window.
1600 This command does not select that window.
1604 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1605 expand wildcards (if any) and replace the file with multiple files."
1616 "Find alternate file: " file-dir nil
1618 t))))
1625 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1627 "Hook run when a buffer is killed.
1628 The buffer being killed is current while the hook is running.
1629 See `kill-buffer'.
1631 Note: Be careful with let-binding this hook considering it is
1635 "Find file FILENAME, select its buffer, kill previous buffer.
1636 If the current buffer now contains an empty file that you just visited
1637 \(presumably by mistake), use this command to visit the file you really want.
1641 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1642 expand wildcards (if any) and replace the file with multiple files.
1644 If the current buffer is an indirect buffer, or the base buffer
1645 for one or more indirect buffers, the other buffer(s) are not
1646 killed."
1655 "Find alternate file: " file-dir nil
1657 t)))
1671 ;; Run `kill-buffer-hook' here. It needs to happen before
1672 ;; variables like `buffer-file-name' etc are set to nil below,
1673 ;; because some of the hooks that could be invoked
1674 ;; (e.g., `save-place-to-alist') depend on those variables.
1675 ;;
1676 ;; Note that `kill-buffer-hook' is not what queries whether to
1677 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1678 ;; asks that itself. Thus, there's no need to temporarily do
1679 ;; `(set-buffer-modified-p nil)' before running this hook.
1681 ;; Okay, now we can end-of-life the old buffer.
1688 ;; This prevents us from finding the same buffer
1689 ;; if we specified the same file again.
1693 ;; Likewise for dired buffers.
1697 ;; This executes if find-file gets an error
1698 ;; and does not really find anything.
1699 ;; We put things back as they were.
1700 ;; If find-file actually finds something, we kill obuf below.
1709 ;; We already ran these; don't run them again.
1712 \f
1713 ;; FIXME we really need to fold the uniquify stuff in here by default,
1714 ;; not using advice, and add it to the doc string.
1716 "Create a suitably named buffer for visiting FILENAME, and return it.
1717 FILENAME (sans directory) is used unchanged if that name is free;
1718 otherwise a string <2> or <3> or ... is appended to get an unused name.
1720 Emacs treats buffers whose names begin with a space as internal buffers.
1721 To avoid confusion when visiting a file whose name begins with a space,
1728 lastname))))
1731 "Create and return a buffer with a name based on NAME.
1732 Choose the buffer's name using `generate-new-buffer-name'."
1736 "Regexp to match the automounter prefix in a directory name."
1742 "Regexp matching the user's homedir at the beginning of file name.
1746 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1748 home directory is a root directory) and removes automounter prefixes
1749 \(see the variable `automount-dir-prefix')."
1750 ;; Get rid of the prefixes added by the automounter.
1757 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1758 ;; To fix this right, we need a `file-name-case-sensitive-p'
1759 ;; function, but we don't have that yet, so just guess.
1762 ;; If any elt of directory-abbrev-alist matches this name,
1763 ;; abbreviate accordingly.
1769 ;; Compute and save the abbreviated homedir name.
1770 ;; We defer computing this until the first time it's needed, to
1771 ;; give time for directory-abbrev-alist to be set properly.
1772 ;; We include a slash at the end, to avoid spurious matches
1773 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1781 ;; Depending on whether default-directory does or
1782 ;; doesn't include non-ASCII characters, the value
1783 ;; of abbreviated-home-dir could be multibyte or
1784 ;; unibyte. In the latter case, we need to decode
1785 ;; it. Note that this function is called for the
1786 ;; first time (from startup.el) when
1787 ;; locale-coding-system is already set up.
1789 abbreviated-home-dir
1792 'utf-8
1793 locale-coding-system))))))
1795 ;; If FILENAME starts with the abbreviated homedir,
1796 ;; make it start with `~' instead.
1798 ;; If the home dir is just /, don't change it.
1801 ;; MS-DOS root directories can come with a drive letter;
1802 ;; Novell Netware allows drive letters beyond `Z:'.
1810 filename)))
1813 "Return the buffer visiting file FILENAME (a string).
1814 This is like `get-file-buffer', except that it checks for any buffer
1815 visiting the same file, possibly under a different name.
1816 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1817 and others are ignored.
1818 If there is no such live buffer, return nil."
1831 found)
1841 ;; Verify this buffer's file number
1842 ;; still belongs to its file.
1845 attributes)
1849 found))))
1850 \f
1852 "Non-nil means file-visiting commands should handle wildcards.
1853 For example, if you specify `*.c', that would visit all the files
1854 whose names match the pattern."
1860 "Non-nil means suppress warning messages for symlinked files.
1861 When nil, Emacs prints a warning when visiting a file that is already
1862 visited, but with a different name. Setting this option to t
1863 suppresses this warning."
1869 "Maximum size of file above which a confirmation is requested.
1870 When nil, never request confirmation."
1877 "Warn if file size exceeds this percentage of available free memory.
1878 When nil, never issue warning. Beware: This probably doesn't do what you
1886 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1887 OP-TYPE specifies the file operation being performed (for message to user)."
1896 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1906 "You are trying to open a file whose size (%s)
1907 exceeds the %S%% of currently available free memory (%s).
1908 If that fails, try to open it with `find-file-literally'
1909 \(but note that some characters might be displayed incorrectly)."
1911 out-of-memory-warning-percentage
1915 "Like `message', except sometimes don't print to minibuffer.
1916 If the variable `save-silently' is non-nil, the message is not
1917 displayed on the minibuffer."
1922 "Read file FILENAME into a buffer and return the buffer.
1923 If a buffer exists visiting FILENAME, return that one, but
1924 verify that the file has not changed since visited or saved.
1925 The buffer is not selected, just returned to the caller.
1926 Optional second arg NOWARN non-nil means suppress any warning messages.
1927 Optional third arg RAWFILE non-nil means the file is read literally.
1928 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1929 and visit all the matching files. When wildcards are actually
1930 used and expanded, return a list of buffers that are visiting
1931 the various files."
1938 'find-directory-functions
1941 filename)))
1944 find-file-wildcards
1958 ;; Find any buffer for a file which has same truename.
1960 ;; Let user know if there is a buffer with the same truename.
1964 find-file-suppress-same-file-warnings
1968 ;; Optionally also find that buffer.
1971 ;; Check to see if the file looks uncommonly large.
1976 ;; We are using an existing buffer.
1983 ;; Certain files should be reverted automatically
1984 ;; if they have changed on disk and not in the buffer.
1992 found))
2002 "File %s changed on disk. Discard your edits? "
2007 "File %s changed on disk. Discard your edits in %s? "
2015 ;; Check if a formerly read-only file has become
2016 ;; writable and vice versa, but if the buffer agrees
2017 ;; with the new state of the file, that is ok too.
2027 buffer-file-name
2028 new-status new-status)))
2034 nonexistent
2035 ;; It is confusing to ask whether to visit
2036 ;; non-literally if they have the file in
2037 ;; hexl-mode or image-mode.
2043 "The file %s is already visited normally,
2044 and you have edited the buffer. Now you have asked to visit it literally,
2045 meaning no coding system handling, format conversion, or local variables.
2046 Emacs can only visit a file in one way at a time.
2048 Do you want to save the file, and visit it literally instead? "
2049 "The file %s is already visited literally,
2050 meaning no coding system handling, format conversion, or local variables.
2051 You have edited the buffer. Now you have asked to visit the file normally,
2052 but Emacs can only visit a file in one way at a time.
2059 rawfile truename number))
2063 "\
2064 Do you want to discard your changes, and visit the file literally now? "
2065 "\
2068 rawfile truename number)
2074 "The file %s is already visited normally.
2075 You have asked to visit it literally,
2076 meaning no coding system decoding, format conversion, or local variables.
2077 But Emacs can only visit a file in one way at a time.
2079 Do you want to revisit the file literally now? "
2080 "The file %s is already visited literally,
2081 meaning no coding system decoding, format conversion, or local variables.
2082 You have asked to visit it normally,
2083 but Emacs can only visit a file in one way at a time.
2088 rawfile truename number)
2091 ;; Return the buffer we are using.
2092 buf)
2093 ;; Create a new buffer.
2095 ;; find-file-noselect-1 may use a different buffer.
2097 rawfile truename number))))))
2103 ;; Needed in case we are re-visiting the file with a different
2104 ;; text representation.
2121 filename)))
2122 ;; Unconditionally set error
2132 filename)))
2133 ;; Run find-file-not-found-functions until one returns non-nil.
2135 ;; If they fail too, set error.
2137 ;; Record the file's truename, and maybe use that as visited name.
2145 ;; Set buffer's default directory to that of the file.
2147 ;; Turn off backup files for certain file names. Since
2148 ;; this is a permanent local, the major mode won't eliminate it.
2162 \f
2164 "Like `insert-file-contents', but only reads in the file literally.
2165 See `insert-file-contents' for an explanation of the parameters.
2166 A buffer may be modified in several ways after reading into the buffer,
2167 due to Emacs features such as format decoding, character code
2168 conversion, `find-file-hook', automatic uncompression, etc.
2170 This function ensures that none of these modifications will take place."
2176 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2177 ;; into a file operation instead!
2179 inhibit-file-name-handlers))
2186 filename)))
2187 ;; Check whether the file is uncommonly large
2198 "Insert contents of file FILENAME into buffer after point with no conversion.
2200 This function is meant for the user to run interactively.
2201 Don't call it from programs! Use `insert-file-contents-literally' instead.
2202 \(Its calling sequence is different; see its documentation)."
2208 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2209 This has the `permanent-local' property, which takes effect if you
2214 "Visit file FILENAME with no conversion of any kind.
2215 Format conversion and character code conversion are both disabled,
2216 and multibyte characters are disabled in the resulting buffer.
2217 The major mode used is Fundamental mode regardless of the file name,
2218 and local variable specifications in the file are ignored.
2219 Automatic uncompression and adding a newline at the end of the
2220 file due to `require-final-newline' is also disabled.
2222 You cannot absolutely rely on this function to result in
2223 visiting the file literally. If Emacs already has a buffer
2224 which is visiting the file, you get the existing buffer,
2225 regardless of whether it was created literally or not.
2227 In a Lisp program, if you want to be sure of accessing a file's
2228 contents literally, you should create a temporary buffer and then read
2229 the file contents into it using `insert-file-contents-literally'."
2232 "Find file literally: " nil default-directory
2235 \f
2237 _after-find-file-from-revert-buffer
2238 nomodes)
2239 "Called after finding a file and by the default revert function.
2240 Sets buffer mode, parses local variables.
2241 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2242 error in reading the file. WARN non-nil means warn if there
2243 exists an auto-save file more recent than the visited file.
2244 NOAUTO means don't mess with auto-save mode.
2245 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2246 \(see `revert-buffer-in-progress-p' for similar functionality).
2247 Fifth arg NOMODES non-nil means don't alter the file's modes.
2248 Finishes by calling the functions in `find-file-hook'
2249 unless NOMODES is non-nil."
2252 nil
2262 "Symbolic link that points to nonexistent file"
2266 ;; No need to warn if buffer is auto-saved
2267 ;; under the name of the visited file.
2269 auto-save-visited-file-name))
2272 buffer-file-name))
2292 ;; Make people do a little extra work (C-x C-q)
2293 ;; before altering a backup file.
2296 ;; When a file is marked read-only,
2297 ;; make the buffer read-only even if root is looking at it.
2305 ;; If requested, add a newline at the end of the file.
2316 view-read-only
2324 "Choose the major mode for this buffer automatically.
2325 Also sets up any specified local variables of the file.
2326 Uses the visited file name, the -*- line, and the local variables spec.
2328 This function is called automatically from `find-file'. In that case,
2329 we may set up the file-specified mode and local variables,
2330 depending on the value of `enable-local-variables'.
2331 In addition, if `local-enable-local-variables' is nil, we do
2332 not set local variables (though we do notice a mode specified with -*-.)
2334 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2335 or from Lisp without specifying the optional argument FIND-FILE;
2336 in that case, this function acts as if `enable-local-variables' were t."
2340 ;; FIXME this is less efficient than it could be, since both
2341 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2346 ;; Turn font lock off and on, to make sure it takes account of
2347 ;; whatever file local variables are relevant to it.
2349 ;; Font-lock-mode (now in font-core.el) can be ON when
2350 ;; font-lock.el still hasn't been loaded.
2357 "Non-nil means to try second pass through `auto-mode-alist'.
2358 This means that if the first case-sensitive search through the alist fails
2359 to find a matching major mode, a second case-insensitive search is made.
2360 On systems with case-insensitive file names, this variable is ignored,
2361 since only a single case-insensitive search through the alist is made."
2367 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2368 ;; c++-mode, java-mode and more) are added through autoload
2369 ;; directives in that file. That way is discouraged since it
2370 ;; spreads out the definition of the initial value.
2416 ;; Less common extensions come here
2417 ;; so more common ones above are found faster.
2425 ;; Besides .gdbinit, gdb documents other names to be usable for init
2426 ;; files, cross-debuggers can use something like
2427 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2428 ;; don't interfere with each other.
2430 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2431 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2432 ;; loaded when GDB reads an objfile called 'emacs'.
2440 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2464 ;; The Fortran standard does not say anything about file extensions.
2465 ;; .f90 was widely used for F90, now we seem to be trapped into
2466 ;; using a different extension for each language revision.
2467 ;; Anyway, the following extensions are supported by gfortran.
2475 ;; The list of archive file extensions should be in sync with
2476 ;; `auto-coding-alist' with `no-conversion' coding system.
2482 ;; Mailer puts message to be edited in
2483 ;; /tmp/Re.... or Message
2486 ;; some news reader is reported to use this
2499 ;; .emacs or .gnus or .viper following a directory delimiter in
2500 ;; Unix or MS-DOS syntax.
2503 ;; _emacs following a directory delimiter in MS-DOS syntax
2507 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2508 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2509 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2512 ;; .xs is also used for ld scripts, but seems to be more commonly
2513 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2515 ;; Explained in binutils ld/genscripts.sh. Eg:
2516 ;; A .x script file is the default script.
2517 ;; A .xr script is for linking without relocation (-r flag). Etc.
2521 ;; Common Lisp ASDF package system.
2528 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2540 ;; Windows candidates may be opened case sensitively on Unix
2546 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2547 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2548 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2549 ;; this has lower priority to avoid matching changelog.sgml etc.
2551 ;; either user's dot-files or under /etc or some such
2553 ;; alas not all ~/.*rc files are like this
2554 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2559 ;; this contains everything twice, with space and with colon :-(
2561 ;; Get rid of any trailing .n.m and try again.
2562 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2563 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2564 ;; Using mode nil rather than `ignore' would let the search continue
2565 ;; through this list (with the shortened name) rather than start over.
2568 ;; This should come after "in" stripping (e.g. config.h.in).
2569 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2571 ;; The following should come after the ChangeLog pattern
2572 ;; for the sake of ChangeLog.1, etc.
2573 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2575 "Alist of filename patterns vs corresponding major mode functions.
2576 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2577 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2578 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2579 mode function to use. FUNCTION will be called, unless it is nil.
2581 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2582 calling FUNCTION (if it's not nil), we delete the suffix that matched
2583 REGEXP and search the list again for another match.
2585 The extensions whose FUNCTION is `archive-mode' should also
2586 appear in `auto-coding-alist' with `no-conversion' coding system.
2588 See also `interpreter-mode-alist', which detects executable script modes
2589 based on the interpreters they specify to run,
2594 "Select Conf mode or XML mode according to start of file."
2604 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2605 ;; and pike-mode) are added through autoload directives in that
2606 ;; file. That way is discouraged since it spreads out the
2607 ;; definition of the initial value.
2636 "Alist mapping interpreter names to major modes.
2637 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2638 Each element looks like (REGEXP . MODE).
2639 If REGEXP matches the entire name (minus any directory part) of
2640 the interpreter specified in the first line of a script, enable
2641 major mode MODE.
2648 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2649 ;; because we are duplicating info from auto-mode-alist.
2650 ;; TODO many elements of this list are also in auto-coding-alist.
2659 "List of regexps matching file names in which to ignore local variables.
2661 Files matching this list are typically binary file formats.
2662 They may happen to contain sequences that look like local variable
2663 specifications, but are not really, or they may be containers for
2664 member files with their own local variable sections, which are
2665 not appropriate for the containing file.
2672 "List of regexps matching suffixes to remove from file names.
2673 The function `inhibit-local-variables-p' uses this: when checking
2674 a file name, it first discards from the end of the name anything that
2677 ;; Can't think of any situation in which you'd want this to be nil...
2682 "Return non-nil if file local variables should be ignored.
2683 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2684 and `inhibit-local-variables-suffixes'. If
2685 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2694 sufs)
2699 temp))
2704 "Regexp matching interpreters, for file mode determination.
2705 This regular expression is matched against the first line of a file
2706 to determine the file's mode in `set-auto-mode'. If it matches, the file
2707 is assumed to be interpreted by the interpreter matched by the second group
2708 of the regular expression. The mode is then determined as the mode
2712 "Alist of buffer beginnings vs. corresponding major mode functions.
2713 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2714 After visiting a file, if REGEXP matches the text at the beginning of the
2715 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2716 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2717 major mode.
2719 If FUNCTION is nil, then it is not called. (That is a way of saying
2727 ;; The < comes before the groups (but the first) to reduce backtracking.
2728 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2729 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2733 comment-re "*"
2736 . html-mode)
2738 ;; These two must come after html, because they are more general:
2743 . sgml-mode)
2746 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2747 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2748 After visiting a file, if REGEXP matches the text at the beginning of the
2749 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2750 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2751 have not specified a mode for this file.
2757 "Upper limit on `magic-mode-alist' regexp matches.
2761 "Select major mode appropriate for current buffer.
2763 To find the right major mode, this function checks for a -*- mode tag
2764 checks for a `mode:' entry in the Local Variables section of the file,
2765 checks if it uses an interpreter listed in `interpreter-mode-alist',
2766 matches the buffer beginning against `magic-mode-alist',
2767 compares the filename against the entries in `auto-mode-alist',
2768 then matches the buffer beginning against `magic-fallback-mode-alist'.
2770 If `enable-local-variables' is nil, or if the file name matches
2771 `inhibit-local-variables-regexps', this function does not check
2772 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2773 is nil, then the only mode: tag that can be relevant is a -*- one.
2775 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2776 set the major mode only if that would change it. In other words
2777 we don't actually set it to the same mode the buffer already has."
2778 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2780 end done mode modes)
2781 ;; Once we drop the deprecated feature where mode: is also allowed to
2782 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2783 ;; remove this section and just let (hack-local-variables t) handle it.
2784 ;; Find a -*- mode tag.
2788 ;; Note by design local-enable-local-variables does not matter here.
2790 try-locals
2793 ;; Find all specifications for the `mode:' variable
2794 ;; and execute them left to right.
2806 modes)))
2807 ;; Simple -*-MODE-*- case.
2810 modes))))
2811 ;; If we found modes to use, invoke them now, outside the save-excursion.
2819 ;; continuing would call minor modes again, toggling them off
2821 ;; hack-local-variables checks local-enable-local-variables etc, but
2822 ;; we might as well be explicit here for the sake of clarity.
2824 enable-local-variables
2825 local-enable-local-variables
2826 try-locals
2833 ;; If we didn't, look for an interpreter specified in the first line.
2834 ;; As a special case, allow for things like "#!/bin/env perl", which
2835 ;; finds the interpreter anywhere in $PATH.
2841 ;; Map interpreter name to a mode, signaling we're done at the
2842 ;; same time.
2849 interpreter-mode-alist)
2851 ;; If we found an interpreter mode to use, invoke it now.
2853 ;; Next try matching the buffer beginning against magic-mode-alist.
2867 ;; Next compare the filename against the entries in auto-mode-alist.
2872 ;; Remove backup-suffixes from file name.
2874 ;; Remove remote file name identification.
2879 ;; Find first matching alist entry.
2882 ;; System is case-insensitive.
2886 ;; System is case-sensitive.
2888 ;; First match case-sensitively.
2892 ;; Fallback to case-insensitive match.
2906 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2923 ;; When `keep-mode-if-same' is set, we are working on behalf of
2924 ;; set-visited-file-name. In that case, if the major mode specified is the
2925 ;; same one we already have, don't actually reset it. We don't want to lose
2926 ;; minor modes such as Font Lock.
2928 "Apply MODE and return it.
2929 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2930 any aliases and compared to current major mode. If they are the
2931 same, do nothing and return nil."
2937 mode)))
2940 "Regexp of lines to skip when looking for file-local settings.
2941 If the first line matches this regular expression, then the -*-...-*- file-
2945 "Find the -*- spec in the buffer.
2946 Call with point at the place to start searching from.
2947 If one is found, set point to the beginning and return the position
2948 of the end. Otherwise, return nil; may change point.
2949 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2950 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2951 have no effect."
2954 ;; Don't look for -*- if this file name matches any
2955 ;; of the regexps in inhibit-local-variables-regexps.
2958 ;; If the file begins with "#!" (exec
2959 ;; interpreter magic), look for mode frobs
2960 ;; in the first two lines. You cannot
2961 ;; necessarily put them in the first line
2962 ;; of such a file without screwing up the
2963 ;; interpreter invocation. The same holds
2964 ;; for '\" in man pages (preprocessor
2965 ;; magic for the `man' program).
2976 end))))
2977 \f
2978 ;;; Handling file local variables
2982 file-local-variables-alist dir-local-variables-alist)
2987 "Normal hook run after processing a file's local variables specs.
2988 Major modes can use this to examine user-specified local variables
2992 "List variable-value pairs that are considered safe.
2993 Each element is a cons cell (VAR . VAL), where VAR is a variable
2994 symbol and VAL is a value that is considered safe."
2995 :risky t
3000 ;; This should be here at least as long as Emacs supports write-file-hooks.
3005 "Expressions that are considered safe in an `eval:' local variable.
3006 Add expressions to this list if you want Emacs to evaluate them, when
3007 they appear in an `eval' local variable specification, without first
3008 asking you for confirmation."
3009 :risky t
3014 ;; Risky local variables:
3017 buffer-auto-save-file-name
3018 buffer-file-name
3019 buffer-file-truename
3020 buffer-undo-list
3021 debugger
3022 default-text-properties
3023 eval
3024 exec-directory
3025 exec-path
3026 file-name-handler-alist
3027 frame-title-format
3028 global-mode-string
3029 header-line-format
3030 icon-title-format
3031 inhibit-quit
3032 load-path
3033 max-lisp-eval-depth
3034 max-specpdl-size
3035 minor-mode-map-alist
3036 minor-mode-overriding-map-alist
3037 mode-line-format
3038 mode-name
3039 overriding-local-map
3040 overriding-terminal-local-map
3041 process-environment
3042 standard-input
3043 standard-output
3044 unread-command-events))
3046 ;; Safe local variables:
3047 ;;
3048 ;; For variables defined by major modes, the safety declarations can go into
3049 ;; the major mode's file, since that will be loaded before file variables are
3050 ;; processed.
3051 ;;
3052 ;; For variables defined by minor modes, put the safety declarations in the
3053 ;; file defining the minor mode after the defcustom/defvar using an autoload
3054 ;; cookie, e.g.:
3055 ;;
3056 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3057 ;;
3058 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3059 ;; minor mode file may not be loaded yet.
3060 ;;
3061 ;; For variables defined in the C source code the declaration should go here:
3083 "Alist of file-local variable settings in the current buffer.
3084 Each element in this list has the form (VAR . VALUE), where VAR
3085 is a file-local variable (a symbol) and VALUE is the value
3086 specified. The actual value in the buffer may differ from VALUE,
3092 "Alist of directory-local variable settings in the current buffer.
3093 Each element in this list has the form (VAR . VALUE), where VAR
3094 is a directory-local variable (a symbol) and VALUE is the value
3095 specified in .dir-locals.el. The actual value in the buffer
3096 may differ from VALUE, if it is changed by the major or minor modes,
3101 "Normal hook run before setting file-local variables.
3102 It is called after checking for unsafe/risky variables and
3103 setting `file-local-variables-alist', and before applying the
3104 variables stored in `file-local-variables-alist'. A hook
3105 function is allowed to change the contents of this alist.
3107 This hook is called only if there is at least one file-local
3111 "Get confirmation before setting up local variable values.
3112 ALL-VARS is the list of all variables to be set up.
3113 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3114 RISKY-VARS is the list of those that are marked as risky.
3115 If these settings come from directory-local variables, then
3116 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3123 unsafe-vars))
3125 ;; Set up the contents of the *Local Variables* buffer.
3133 ", and variables that are risky (**)."
3141 y -- to apply the local variables list.
3145 ! -- to apply the local variables list, and permanently mark these
3157 ;; Make strings with embedded whitespace easier to read.
3165 ;; Display the buffer and read a choice.
3173 ""
3176 char)
3195 "Return local variables specified in the -*- line.
3196 Returns an alist of elements (VAR . VAL), where VAR is a variable
3197 and VAL is the specified value. Ignores any specification for
3198 `mode:' and `coding:' (which should have already been handled
3199 by `set-auto-mode' and `set-auto-coding', respectively).
3200 Return nil if the -*- line is malformed.
3202 If MODE-ONLY is non-nil, just returns the symbol specifying the
3203 mode, if there is one, otherwise nil."
3208 result)
3210 nil)
3212 ;; Simple form: "-*- MODENAME -*-".
3216 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3217 ;; (last ";" is optional).
3218 ;; If MODE-ONLY, just check for `mode'.
3219 ;; Otherwise, parse the -*- line into the RESULT alist.
3227 ;; There used to be a downcase here,
3228 ;; but the manual didn't say so,
3229 ;; and people want to set var names that aren't all lc.
3235 ;; It is traditional to ignore
3236 ;; case when checking for `mode' in set-auto-mode,
3237 ;; so we must do that here as well.
3238 ;; That is inconsistent, but we're stuck with it.
3239 ;; The same can be said for `coding' in set-auto-coding.
3249 ;; Downcase "Mode:".
3255 result))))))
3258 "Filter local variable settings, querying the user if necessary.
3259 VARIABLES is the alist of variable-value settings. This alist is
3260 filtered based on the values of `ignored-local-variables',
3261 `enable-local-eval', `enable-local-variables', and (if necessary)
3262 user interaction. The results are added to
3263 `file-local-variables-alist', without applying them.
3264 If these settings come from directory-local variables, then
3265 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3266 ;; Find those variables that we may want to save to
3267 ;; `safe-local-variable-values'.
3273 ;; Ignore any variable in `ignored-local-variables'.
3274 nil)
3275 ;; Obey `enable-local-eval'.
3279 ;; In case previously marked safe (bug#5636).
3281 ;; If not safe and e-l-v = :safe, ignore totally.
3285 safe
3287 ;; Ignore duplicates (except `mode') in the present list.
3289 ;; Accept known-safe variables.
3293 ;; The variable is either risky or unsafe:
3300 ;; Query, unless all vars are safe or user wants no querying.
3306 risky-vars dir-name))
3316 ;; TODO? Warn once per file rather than once per session?
3320 "Parse and put into effect this buffer's local variables spec.
3321 Uses `hack-local-variables-apply' to apply the variables.
3324 is specified, and return the corresponding mode symbol, or nil.
3325 In this case, we try to ignore minor-modes, and only return a
3326 major-mode.
3328 If `enable-local-variables' or `local-enable-local-variables' is nil,
3329 this function does nothing. If `inhibit-local-variables-regexps'
3330 applies to the file in question, the file is not scanned for
3331 local variables, but directory-local variables may still be applied."
3332 ;; We don't let inhibit-local-variables-p influence the value of
3333 ;; enable-local-variables, because then it would affect dir-local
3334 ;; variables. We don't want to search eg tar files for file local
3335 ;; variable sections, but there is no reason dir-locals cannot apply
3336 ;; to them. The real meaning of inhibit-local-variables-p is "do
3337 ;; not scan this file for local variables".
3340 result)
3344 ;; Note this is a no-op if enable-local-variables is nil.
3346 ;; This entire function is basically a no-op if enable-local-variables
3347 ;; is nil. All it does is set file-local-variables-alist to nil.
3349 ;; This part used to ignore enable-local-variables when mode-only
3350 ;; was non-nil. That was inappropriate, eg consider the
3351 ;; (artificial) example of:
3352 ;; (setq local-enable-local-variables nil)
3353 ;; Open a file foo.txt that contains "mode: sh".
3354 ;; It correctly opens in text-mode.
3355 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3357 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3358 ;; mode, then we're done, and have no need to scan further.
3360 mode-only))
3361 ;; Look for "Local variables:" line in last page.
3369 ;; suffix is what comes after "local variables:" in its line.
3370 ;; prefix is what comes before "local variables:" in its line.
3383 endpos
3389 nil t))
3390 ;; This used to be an error, but really all it means is
3391 ;; that this may simply not be a local-variables section,
3392 ;; so just ignore it.
3402 ;; Discard the prefix.
3407 ;; Discard the suffix.
3416 ;; Find the variable name;
3424 val val2)
3427 ;; Read the variable value.
3434 ;; Specifying minor-modes via mode: is
3435 ;; deprecated, but try to reject them anyway.
3445 'files
3447 "%s: `lexical-binding' at end of file unreliable"
3449 ;; We are called from
3450 ;; 'with-temp-buffer', so we need
3451 ;; to use 'thisbuf's name in the
3452 ;; warning message.
3457 'eval
3461 ;; Now we've read all the local variables.
3462 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3464 ;; Otherwise, set the variables.
3469 "Apply the elements of `file-local-variables-alist'.
3470 If there are any elements, runs `before-hack-local-variables-hook',
3471 then calls `hack-one-local-variable' to apply the alist elements one by one.
3472 Finishes by running `hack-local-variables-hook', regardless of whether
3473 the alist is empty or not.
3475 Note that this function ignores a `mode' entry if it specifies the same
3476 major mode as the buffer already has."
3478 ;; Any 'evals must run in the Right sequence.
3487 "Non-nil if SYM is safe as a file-local variable with value VAL.
3488 It is safe if any of these conditions are met:
3490 * There is a matching entry (SYM . VAL) in the
3491 `safe-local-variable-values' user option.
3493 * The `safe-local-variable' property of SYM is a function that
3494 evaluates to a non-nil value with VAL as an argument."
3498 ;; If the function signals an error, that means it
3499 ;; can't assure us that the value is safe.
3503 "Non-nil if SYM could be dangerous as a file-local variable.
3504 It is dangerous if either of these conditions are met:
3506 * Its `risky-local-variable' property is non-nil.
3512 ;; If this is an alias, check the base name.
3532 "Return t if it is safe to eval EXP when it is found in a file."
3534 ;; Detect certain `put' expressions.
3541 lisp-indent-function
3542 scheme-indent-function))
3543 ;; Only allow safe values (not functions).
3548 ;; Only allow indirect form specs.
3549 ;; During bootstrapping, edebug-basic-spec might not be
3550 ;; defined yet.
3554 ;; Allow expressions that the user requested.
3556 ;; Certain functions can be allowed with safe arguments
3557 ;; or can specify verification functions to try.
3559 ;; Allow (minor)-modes calls with no arguments.
3560 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3569 ok))
3577 ok))))))))
3591 "Set local variable VAR with value VAL.
3592 If VAR is `mode', call `VAL-mode' as a function unless it's
3593 already the major mode."
3595 (`mode
3601 (`eval
3607 ;; Make sure the string has no text properties.
3608 ;; Some text properties can get evaluated in various ways,
3609 ;; so it is risky to put them on with a local variable list.
3613 \f
3614 ;;; Handling directory-local variables, aka project settings.
3620 "List of cached directory roots for directory-local variable classes.
3621 Each element in this list has the form (DIR CLASS MTIME).
3622 DIR is the name of the directory.
3623 CLASS is the name of a variable class (a symbol).
3624 MTIME is the recorded modification time of the directory-local
3625 variables file associated with this entry. This time is a list
3626 of integers (the same format as `file-attributes'), and is
3627 used to test whether the cache entry is still valid.
3628 Alternatively, MTIME can be nil, which means the entry is always
3632 "Return the variable list for CLASS."
3636 "Collect directory-local variables from MODE-VARIABLES.
3637 VARIABLES is the initial list of variables.
3638 Returns the new list."
3643 ;; If variables are specified more than once, only use the last. (Why?)
3644 ;; The pseudo-variables mode and eval are different (bug#3430).
3647 ;; Need a new cons in case we setcdr later.
3651 "Collect entries from CLASS-VARIABLES into VARIABLES.
3652 ROOT is the root directory of the project.
3653 Return the new variables list."
3655 ;; Handle non-file buffers, too.
3658 ;; FIXME: Why not use file-relative-name?
3665 ;; Don't include this in the previous condition, because we
3666 ;; want to filter all strings before the next condition.
3680 ;; TODO someone might want to extend this to allow
3681 ;; integer values for subdir, where N means
3682 ;; variables apply to this directory and N levels
3683 ;; below it (0 == nil).
3686 alist variables))))))))
3688 ;; The file's content might be invalid (e.g. have a merge conflict), but
3689 ;; that shouldn't prevent the user from opening the file.
3691 nil))))
3694 "Declare that the DIRECTORY root is an instance of CLASS.
3695 DIRECTORY is the name of a directory, a string.
3696 CLASS is the name of a project class, a symbol.
3697 MTIME is either the modification time of the directory-local
3698 variables file that defined this class, or nil.
3700 When a file beneath DIRECTORY is visited, the mode-specific
3701 variables from CLASS are applied to the buffer. The variables
3702 for a class are defined using `dir-locals-set-class-variables'."
3709 "Map the type CLASS to a list of variable settings.
3710 CLASS is the project class, a symbol. VARIABLES is a list
3711 that declares directory-local variables for the class.
3712 An element in VARIABLES is either of the form:
3713 (MAJOR-MODE . ALIST)
3714 or
3715 (DIRECTORY . LIST)
3717 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3718 whose elements are of the form (VARIABLE . VALUE).
3720 In the second form, DIRECTORY is a directory name (a string), and
3721 LIST is a list of the form accepted by the function.
3723 When a file is visited, the file's class is found. A directory
3724 may be assigned a class using `dir-locals-set-directory-class'.
3725 Then variables are set in the file's buffer according to the
3726 VARIABLES list of the class. The list is processed in order.
3728 * If the element is of the form (MAJOR-MODE . ALIST), and the
3729 buffer's major mode is derived from MAJOR-MODE (as determined
3730 by `derived-mode-p'), then all the variables in ALIST are
3731 applied. A MAJOR-MODE of nil may be used to match any buffer.
3732 `make-local-variable' is called for each variable before it is
3733 set.
3735 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3736 is an initial substring of the file's directory, then LIST is
3737 applied by recursively following these rules."
3741 "File that contains directory-local variables.
3742 It has to be constant to enforce uniform values
3746 "Find the directory-local variables for FILE.
3747 This searches upward in the directory tree from FILE.
3748 It stops at the first directory that has been registered in
3749 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3750 If it finds an entry in the cache, it checks that it is valid.
3751 A cache entry with no modification time element (normally, one that
3752 has been assigned directly using `dir-locals-set-directory-class', not
3753 set from a file) is always valid.
3754 A cache entry based on a `dir-locals-file' is valid if the modification
3755 time stored in the cache matches the current file modification time.
3756 If not, the cache entry is cleared so that the file will be re-read.
3758 This function returns either nil (no directory local variables found),
3759 or the matching entry from `dir-locals-directory-cache' (a list),
3760 or the full path to the `dir-locals-file' (a string) in the case
3761 of no valid cache entry."
3766 dir-locals-file))
3769 ;; `locate-dominating-file' may have abbreviated the name.
3772 ;; Let dir-locals-read-from-file inform us via demoted-errors
3773 ;; about unreadable files, etc.
3774 ;; Maybe we'd want to keep searching though - that is
3775 ;; a locate-dominating-file issue.
3776 ;;; (or (not (file-readable-p locals-file))
3777 ;;; (not (file-regular-p locals-file)))
3778 ;;; (setq locals-file nil))
3779 ;; Find the best cached value in `dir-locals-directory-cache'.
3790 ;; Found a potential cache entry. Check validity.
3791 ;; A cache entry with no MTIME is assumed to always be valid
3792 ;; (ie, set directly, not from a dir-locals file).
3793 ;; Note, we don't bother to check that there is a matching class
3794 ;; element in dir-locals-class-alist, since that's done by
3795 ;; dir-locals-set-directory-class.
3802 ;; This cache entry is OK.
3803 dir-elt
3804 ;; This cache entry is invalid; clear it.
3807 ;; Return the first existing dir-locals file. Might be the same
3808 ;; as dir-elt's, might not (eg latter might have been deleted).
3809 locals-file)
3810 ;; No cache entry.
3811 locals-file)))
3814 "Load a variables FILE and register a new class and instance.
3815 FILE is the name of the file holding the variables to apply.
3816 The new class name is the same as the directory in which FILE
3817 is found. Returns the new class name."
3829 class-name)))))
3832 "Non-nil means dir-local variables will be applied to remote files."
3840 "Read per-directory local variables for the current buffer.
3841 Store the directory-local variables in `dir-local-variables-alist'
3842 and `file-local-variables-alist', without applying them.
3844 This does nothing if either `enable-local-variables' or
3845 `enable-dir-local-variables' are nil."
3847 enable-dir-local-variables
3850 default-directory)))))
3851 ;; Find the variables file.
3881 "Apply directory-local variables to a non-file buffer.
3882 For non-file buffers, such as Dired buffers, directory-local
3883 variables are looked for in `default-directory' and its parent
3884 directories."
3888 \f
3891 However, the mode will not be changed if
3892 \(1) a local variables list or the `-*-' line specifies a major mode, or
3894 not suitable for ordinary files, or
3895 \(3) the new file name does not particularly specify any mode."
3900 "Change name of file visited in current buffer to FILENAME.
3901 This also renames the buffer to correspond to the new file.
3902 The next time the buffer is saved it will go in the newly specified file.
3903 FILENAME nil or an empty string means mark buffer as not visiting any file.
3904 Remember to delete the initial contents of the minibuffer
3905 if you wish to pass an empty string as the argument.
3907 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3908 confirmation in the case where another buffer is already visiting FILENAME.
3910 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3911 the old visited file has been renamed to the new name FILENAME."
3919 nil
3934 filename)))
3941 buffer-file-name filename)
3945 ;; If new-name == old-name, renaming would add a spurious <2>
3946 ;; and it's considered as a feature in rename-buffer.
3952 ;; Abbreviate the file names of the buffer.
3961 nil))
3962 ;; write-file-functions is normally used for things like ftp-find-file
3963 ;; that visit things that are not local files as if they were files.
3964 ;; Changing to visit an ordinary local file instead should flush the hook.
3969 ;; If buffer was read-only because of version control,
3970 ;; that reason is gone now, so make it writable.
3974 ;; Turn off backup files for certain file names.
3975 ;; Since this is a permanent local, the major mode won't eliminate it.
3977 backup-enable-predicate
3986 ;; If auto-save was not already on, turn it on if appropriate.
3989 ;; If auto save is on, start using a new name. We
3990 ;; deliberately don't rename or delete the old auto save
3991 ;; for the old visited file name. This is because
3992 ;; perhaps the user wants to save the new state and then
3993 ;; compare with the previous state from the auto save
3994 ;; file.
3996 ;; Rename the old auto save file if any.
4003 ;; Update the major mode, if the file name determines it.
4005 ;; Don't change the mode if it is special.
4008 ;; Don't change the mode if the local variable list specifies it.
4009 ;; The file name can influence whether the local variables apply.
4011 ;; h-l-v also checks it, but might as well be explicit.
4014 ;; TODO consider making normal-mode handle this case.
4022 "Write current buffer into file FILENAME.
4023 This makes the buffer visit that file, and marks it as not modified.
4025 If you specify just a directory name as FILENAME, that means to use
4026 the default file name but in that directory. You can also yank
4027 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4029 If the buffer is not already visiting a file, the default file name
4030 for the output file is the buffer name.
4032 If optional second arg CONFIRM is non-nil, this function
4033 asks for confirmation before overwriting an existing file.
4034 Interactively, confirmation is required unless you supply a prefix argument."
4035 ;; (interactive "FWrite file: ")
4039 nil nil nil nil)
4043 default-directory)
4044 nil nil))
4048 ;; If arg is just a directory,
4049 ;; use the default file name, but in that directory.
4056 ;; NS does its own confirm dialog.
4059 use-dialog-box))
4065 ;; Make buffer writable if file is writable.
4070 ;; It's likely that the VC status at the new location is different from
4071 ;; the one at the old location.
4073 \f
4075 "Return an alist of extended attributes of file FILENAME.
4077 Extended attributes are platform-specific metadata about the file,
4078 such as SELinux context, list of ACL entries, etc."
4083 "Set extended attributes of file FILENAME to ATTRIBUTES.
4085 ATTRIBUTES must be an alist of file attributes as returned by
4086 `file-extended-attributes'.
4087 Value is t if the function succeeds in setting the attributes."
4098 result))
4099 \f
4101 "Make a backup of the disk file visited by the current buffer, if appropriate.
4102 This is normally done before saving the buffer the first time.
4104 A backup may be done by renaming or by copying; see documentation of
4105 variable `make-backup-files'. If it's done by renaming, then the file is
4106 no longer accessible under its old name.
4108 The value is non-nil after a backup was made by renaming.
4109 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4110 MODES is the result of `file-modes' on the original
4111 file; this means that the caller, after saving the buffer, should change
4112 the modes of the new file to agree with the old modes.
4113 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4114 on the original file; this means that the caller, after saving
4115 the buffer, should change the extended attributes of the new file
4116 to agree with the old attributes.
4117 BACKUPNAME is the backup file name, which is the old file renamed."
4121 ;; If specified name is a symbolic link, chase it to the target.
4122 ;; This makes backups in the directory where the real file is.
4129 ;; If have old versions to maybe delete,
4130 ;; ask the user to confirm now, before doing anything.
4131 ;; But don't actually delete til later.
4137 real-file-name)))
4138 targets))
4143 backup-by-copying-when-privileged-mismatch)
4146 ;; Don't rename a suid or sgid file.
4155 real-file-name
4158 copy-when-priv-mismatch))))
4160 t)))))
4161 setmodes)
4164 ;; Actually make the backup file.
4167 modes extended-attributes)
4168 ;; rename-file should delete old backup.
4171 backupname)))
4173 ;; Now delete the old versions, if desired.
4177 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4181 backupname)
4184 modes extended-attributes)
4186 setmodes)))))))
4189 ;; Create temp files with strict access rights. It's easy to
4190 ;; loosen them later, whereas it's impossible to close the
4191 ;; time-window of loose permissions otherwise.
4194 ;; Try to overwrite old backup first.
4202 nil)
4204 ;; The file was somehow created by someone else between
4205 ;; `delete-file' and `copy-file', so let's try again.
4206 ;; rms says "I think there is also a possible race
4207 ;; condition for making backup files" (emacs-devel 20070821).
4208 nil)))
4209 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4218 ;; The last ~[[:digit]]+ matches relative versions in git,
4219 ;; e.g. `foo.js.~HEAD~1~'.
4220 "Regular expression matching the backup/version part of a file name.
4224 "Return file NAME sans backup versions or strings.
4225 This is a separate procedure so your site-init or startup file can
4226 redefine it.
4227 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4228 we do not remove backup version numbers, only true file version numbers.
4229 See also `file-name-version-regexp'."
4236 name))))))
4239 "Return t if deleting FILE and rewriting it would preserve the owner.
4240 Return nil if FILE does not exist, or if deleting and recreating it
4241 might not preserve the owner. If GROUP is non-nil, check whether
4242 the group would be preserved too."
4247 ;; Return t if the file doesn't exist, since it's true that no
4248 ;; information would be lost by an (attempted) delete and create.
4251 ;; Files created on Windows by Administrator (RID=500)
4252 ;; have the Administrators group (RID=544) recorded as
4253 ;; their owner. Rewriting them will still preserve the
4254 ;; owner.
4258 ;; On BSD-derived systems files always inherit the parent
4259 ;; directory's group, so skip the group-gid test.
4265 ;; On some systems, a file created in a setuid directory
4266 ;; inherits that directory's owner.
4270 ;; On many systems, a file created in a setgid directory
4271 ;; inherits that directory's group. On some systems
4272 ;; this happens even if the setgid bit is not set.
4279 The extension, in a file name, is the part that begins with the last `.',
4280 except that a leading `.' of the file name, if there is one, doesn't count."
4283 directory)
4287 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4288 ;; we don't want to expand it.
4291 filename))))
4295 The extension, in a file name, is the part that begins with the last `.',
4296 excluding version numbers and backup suffixes, except that a leading `.'
4297 of the file name, if there is one, doesn't count.
4298 Return nil for extensionless file names such as `foo'.
4299 Return the empty string for file names such as `foo.'.
4301 By default, the returned value excludes the period that starts the
4302 extension, but if the optional argument PERIOD is non-nil, the period
4303 is included in the value, and in that case, if FILENAME has no
4314 "Return the base name of the FILENAME: no directory, no extension.
4315 FILENAME defaults to `buffer-file-name'."
4320 #'make-backup-file-name--default-function
4321 "A function that `make-backup-file-name' uses to create backup file names.
4322 The function receives a single argument, the original file name.
4324 If you change this, you may need to change `backup-file-name-p' and
4325 `file-name-sans-versions' too.
4327 You could make this buffer-local to do something special for specific files.
4329 For historical reasons, a value of nil means to use the default function.
4330 This should not be relied upon.
4332 See also `backup-directory-alist'."
4339 "Alist of filename patterns and backup directory names.
4340 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4341 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4342 relative or absolute. If it is absolute, so that all matching files
4343 are backed up into the same directory, the file names in this
4344 directory will be the full name of the file backed up with all
4345 directory separators changed to `!' to prevent clashes. This will not
4346 work correctly if your filesystem truncates the resulting name.
4348 For the common case of all backups going into one directory, the alist
4350 directory name.
4352 If this variable is nil, or it fails to match a filename, the backup
4353 is made in the original file's directory.
4355 On MS-DOS filesystems without long names this variable is always
4356 ignored."
4362 "Default `backup-enable-predicate' function.
4363 Checks for files in `temporary-file-directory',
4364 `small-temporary-file-directory', and /tmp."
4366 caseless)
4367 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4368 ;; their long file-name equivalents, so compare-strings does TRT.
4372 caseless t))
4375 ;; Directory is under temporary-file-directory.
4380 ;; Directory is under /tmp.
4385 0 nil
4387 ;; Directory is under small-temporary-file-directory.
4392 "Create the non-numeric backup file name for FILE.
4393 This calls the function that `make-backup-file-name-function' specifies,
4394 with a single argument FILE."
4397 file))
4400 "Default function for `make-backup-file-name'.
4401 Normally this just returns FILE's name with `~' appended.
4402 It searches for a match for FILE in `backup-directory-alist'.
4403 If the directory for the backup doesn't exist, it is created."
4415 "Subroutine of `make-backup-file-name--default-function'.
4416 The function `find-backup-file-name' also uses this."
4418 elt backup-directory abs-backup-directory)
4423 alist nil)))
4424 ;; If backup-directory is relative, it should be relative to the
4425 ;; file's directory. By expanding explicitly here, we avoid
4426 ;; depending on default-directory.
4435 abs-backup-directory nil))))
4437 file
4441 ;; Normalize DOSish file names: downcase the drive
4442 ;; letter, if any, and replace the leading "x:" with
4443 ;; "/drive_x".
4446 ;; Replace any invalid file-name characters (for the
4447 ;; case of backing up remote files).
4451 "drive_"
4454 ""
4457 ;; Make the name unique by substituting directory
4458 ;; separators. It may not really be worth bothering about
4459 ;; doubling `!'s in the original name...
4464 backup-directory))
4469 "Return non-nil if FILE is a backup file name (numeric or not).
4470 This is a separate function so you can redefine it for customization.
4471 You may need to redefine `file-name-sans-versions' as well."
4476 ;; This is used in various files.
4477 ;; The usage of backup-extract-version-start is not very clean,
4478 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4480 "Given the name of a numeric backup file, FN, return the backup number.
4481 Uses the free variable `backup-extract-version-start', whose value should be
4482 the index in the name where the version number begins."
4489 "Find a file name for a backup file FN, and suggestions for deletions.
4490 Value is a list whose car is the name for the backup file
4491 and whose cdr is a list of old versions to consider deleting now.
4492 If the value is nil, don't make a backup.
4493 Uses `backup-directory-alist' in the same way as
4494 `make-backup-file-name--default-function' does."
4496 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4500 ;; We don't support numbered backups on plain MS-DOS
4501 ;; when long file names are unavailable.
4511 possibilities deserve-versions-p versions)
4514 base-versions
4517 possibilities)
4518 #'<)
4523 kept-old-versions
4524 kept-new-versions
4531 ;; Delete nothing if there is overflow
4532 ;; in the number of versions to keep.
4538 v))))))))))
4541 "Return number of names file FILENAME has."
4544 ;; (defun file-relative-name (filename &optional directory)
4545 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4546 ;; This function returns a relative file name which is equivalent to FILENAME
4547 ;; when used with that default directory as the default.
4548 ;; If this is impossible (which can happen on MSDOS and Windows
4549 ;; when the file name and directory use different drive names)
4550 ;; then it returns FILENAME."
4551 ;; (save-match-data
4552 ;; (let ((fname (expand-file-name filename)))
4553 ;; (setq directory (file-name-as-directory
4554 ;; (expand-file-name (or directory default-directory))))
4555 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4556 ;; ;; drive names, they can't be relative, so return the absolute name.
4557 ;; (if (and (or (eq system-type 'ms-dos)
4558 ;; (eq system-type 'cygwin)
4559 ;; (eq system-type 'windows-nt))
4560 ;; (not (string-equal (substring fname 0 2)
4561 ;; (substring directory 0 2))))
4562 ;; filename
4563 ;; (let ((ancestor ".")
4564 ;; (fname-dir (file-name-as-directory fname)))
4565 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4566 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4567 ;; (setq directory (file-name-directory (substring directory 0 -1))
4568 ;; ancestor (if (equal ancestor ".")
4569 ;; ".."
4570 ;; (concat "../" ancestor))))
4571 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4572 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4573 ;; ;; We matched within FNAME's directory part.
4574 ;; ;; Add the rest of FNAME onto ANCESTOR.
4575 ;; (let ((rest (substring fname (match-end 0))))
4576 ;; (if (and (equal ancestor ".")
4577 ;; (not (equal rest "")))
4578 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4579 ;; rest
4580 ;; (concat (file-name-as-directory ancestor) rest)))
4581 ;; ;; We matched FNAME's directory equivalent.
4582 ;; ancestor))))))
4585 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4586 This function returns a relative file name which is equivalent to FILENAME
4587 when used with that default directory as the default.
4588 If FILENAME is a relative file name, it will be interpreted as existing in
4589 `default-directory'.
4590 If FILENAME and DIRECTORY lie on different machines or on different drives
4591 on a DOS/Windows machine, it returns FILENAME in expanded form."
4595 default-directory))))
4600 read-file-name-completion-ignore-case)))
4603 ;; Test for different filesystems on DOS/Windows
4605 ;; Should `cygwin' really be included here? --stef
4608 ;; Test for different drive letters
4610 ;; Test for UNCs on different servers
4615 ;; Windows file names cannot have ? in
4616 ;; them, so use that to detect when
4617 ;; neither FILENAME nor DIRECTORY is a
4618 ;; UNC.
4620 0 nil
4626 ;; Test for different remote file system identification
4628 filename
4636 ".."
4638 ;; Now ancestor is empty, or .., or ../.., etc.
4640 ;; We matched within FILENAME's directory part.
4641 ;; Add the rest of FILENAME onto ANCESTOR.
4644 ;; But don't bother with ANCESTOR if it would give us `./'.
4645 rest
4647 ;; We matched FILENAME's directory equivalent.
4648 ancestor))))))
4649 \f
4651 "Save current buffer in visited file if modified.
4652 Variations are described below.
4654 By default, makes the previous version into a backup file
4655 if previously requested or if this is the first save.
4657 to become a backup when the next save is done.
4659 makes the previous version into a backup file.
4661 to become a backup when the next save is done,
4662 and makes the previous version into a backup file.
4664 With a numeric prefix argument of 0, never make the previous version
4665 into a backup file.
4667 Note that the various variables that control backups, such
4668 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4669 and `backup-inhibited', to name just the more popular ones, still
4670 control whether a backup will actually be produced, even when you
4673 If a file's name is FOO, the names of its numbered backup versions are
4674 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4675 Numeric backups (rather than FOO~) will be made if value of
4676 `version-control' is not the atom `never' and either there are already
4677 numeric versions of the file being backed up, or `version-control' is
4678 non-nil.
4679 We don't want excessive versions piling up, so there are variables
4680 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4681 and `kept-new-versions', which tells how many newest versions to keep.
4682 Defaults are 2 old versions and 2 new.
4683 `dired-kept-versions' controls dired's clean-directory (.) command.
4684 If `delete-old-versions' is nil, system will query user
4685 before trimming versions. Otherwise it does it silently.
4687 If `vc-make-backup-files' is nil, which is the default,
4688 no backup files are made for files managed by version control.
4689 (This is because the version control system itself records previous versions.)
4691 See the subroutine `basic-save-buffer' for more information."
4697 ;; We used to display the message below only for files > 50KB, but
4698 ;; then Rmail-mbox never displays it due to buffer swapping. If
4699 ;; the test is ever re-introduced, be sure to handle saving of
4700 ;; Rmail files.
4710 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4711 Normally delete only if the file was written by this Emacs since
4712 the last real save, but optional arg FORCE non-nil means delete anyway."
4726 "Normal hook that is run before a buffer is saved to its file.
4727 Only used by `save-buffer'."
4733 "Normal hook that is run after a buffer is saved to its file.
4734 Only used by `save-buffer'."
4740 "If non-nil, use this coding system for saving the buffer.
4741 More precisely, use this coding system in place of the
4742 value of `buffer-file-coding-system', when saving the buffer.
4743 Calling `write-region' for any purpose other than saving the buffer
4744 will still use `buffer-file-coding-system'; this variable has no effect
4751 "Save the current buffer in its visited file, if it has been modified.
4752 The hooks `write-contents-functions' and `write-file-functions' get a chance
4753 to do the job of saving; if they do not, then the buffer is saved in
4754 the visited file in the usual way.
4755 Before and after saving the buffer, this function runs
4756 `before-save-hook' and `after-save-hook', respectively."
4759 ;; In an indirect buffer, save its base buffer instead.
4763 ;; handle the case when no modification has been made but
4764 ;; the file disappeared since visited
4768 setmodes)
4769 ;; If buffer has no file name, ask user for one.
4777 ;; Signal an error if the user specified the name of an
4778 ;; existing directory.
4781 "File `%s' exists; overwrite? "
4782 filename))
4789 "%s has changed since visited or saved. Save anyway? "
4809 ;; Support VC version backups.
4811 ;; Don't let errors prevent saving the buffer.
4816 ;; If a hook returned t, file is already "written".
4817 ;; Otherwise, write it the usual way now.
4827 ;; Now we have saved the current buffer. Let's make sure
4828 ;; that buffer-file-coding-system is fixed to what
4829 ;; actually used for saving by binding it locally.
4844 ;; If the auto-save file was recent before this command,
4845 ;; delete it now.
4847 ;; Support VC `implicit' locking.
4854 ;; This does the "real job" of writing a buffer into its visited file
4855 ;; and making a backup file. This is what is normally done
4856 ;; but inhibited if one of write-file-functions returns non-nil.
4857 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4858 ;; backup-buffer.
4868 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4869 ;; backup-buffer.
4882 "File %s is write-protected; try to save anyway? "
4884 buffer-file-name)))
4898 dir))))
4899 ;; Write temp name, then rename it.
4900 ;; This requires write access to the containing dir,
4901 ;; which is why we don't try it if we don't have that access.
4903 tempname succeed
4906 ;; Create temp files with strict access rights. It's easy to
4907 ;; loosen them later, whereas it's impossible to close the
4908 ;; time-window of loose permissions otherwise.
4913 ;; Try various temporary names.
4914 ;; This code follows the example of make-temp-file,
4915 ;; but it calls write-region in the appropriate way
4916 ;; for saving the buffer.
4922 ;; Pass in nil&nil rather than point-min&max
4923 ;; cause we're saving the whole buffer.
4924 ;; write-region-annotate-functions may use it.
4926 tempname nil realname
4929 nil)
4931 ;; The file was somehow created by someone else between
4932 ;; `make-temp-name' and `write-region', let's try again.
4933 nil)
4935 ;; Reset the umask.
4937 ;; If we failed, restore the buffer's modtime.
4940 ;; Since we have created an entirely new file,
4941 ;; make sure it gets the right permission bits set.
4946 buffer-file-name)))
4947 ;; We succeeded in writing the temp file,
4948 ;; so rename it.
4950 ;; If file not writable, see if we can make it writable
4951 ;; temporarily while we write it.
4952 ;; But no need to do so if we have just backed it up
4953 ;; (setmodes is set) because that says we're superseding.
4955 ;; Change the mode back, after writing.
4958 buffer-file-name))
4959 ;; If set-file-extended-attributes fails, fall back on
4960 ;; set-file-modes.
4970 ;; Pass in nil&nil rather than point-min&max to indicate
4971 ;; we're saving the buffer rather than just a region.
4972 ;; write-region-annotate-functions may make us of it.
4974 buffer-file-name nil t buffer-file-truename)
4977 ;; If we get an error writing the new file, and we made
4978 ;; the backup by renaming, undo the backing-up.
4983 setmodes))
4989 `((?\C-r
4996 ;; Return nil to ask about BUF again.
4997 nil)
5010 ;; Return nil to ask about BUF again.
5011 nil)
5021 "Save some modified file-visiting buffers. Asks user about each one.
5022 You can answer `y' to save, `n' not to save, `C-r' to look at the
5023 buffer in question with `view-buffer' before deciding or `d' to
5024 view the differences using `diff-buffer-with-file'.
5026 This command first saves any buffers where `buffer-save-without-query' is
5027 non-nil, without asking.
5029 Optional argument (the prefix) non-nil means save all with no questions.
5030 Optional second argument PRED determines which buffers are considered:
5031 If PRED is nil, all the file-visiting buffers are considered.
5032 If PRED is t, then certain non-file buffers will also be considered.
5033 If PRED is a zero-argument function, it indicates for each buffer whether
5034 to consider it or not when called with that buffer current.
5036 See `save-some-buffers-action-alist' if you want to
5037 change the additional actions you can take on files."
5041 files-done abbrevs-done)
5043 ;; First save any buffers that we're supposed to save unconditionally.
5044 ;; That way the following code won't ask about them.
5049 ;; Ask about those buffers that merit it,
5050 ;; and record the number thus saved.
5054 ;; Note that killing some buffers may kill others via
5055 ;; hooks (e.g. Rmail and its viewing buffer).
5068 t
5080 save-some-buffers-action-alist))
5081 ;; Maybe to save abbrevs, and record whether
5082 ;; we either saved them or asked to.
5089 ;; Don't keep bothering user if he says no.
5103 \f
5105 "Clear out records of last mod time of visited file.
5106 Next attempt to save will not complain of a discrepancy."
5110 "Mark current buffer as unmodified, not needing to be saved.
5113 It is not a good idea to use this function in Lisp programs, because it
5114 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5122 "Change whether this buffer is read-only."
5130 "Insert contents of file FILENAME into buffer after point.
5131 Set mark after the inserted text.
5133 This function is meant for the user to run interactively.
5134 Don't call it from programs! Use `insert-file-contents' instead.
5135 \(Its calling sequence is different; see its documentation)."
5141 "Append the contents of the region to the end of file FILENAME.
5142 When called from a function, expects three arguments,
5143 START, END and FILENAME. START and END are normally buffer positions
5144 specifying the part of the buffer to write.
5145 If START is nil, that means to use the entire buffer contents.
5146 If START is a string, then output that string to the file
5147 instead of any buffer contents; END is ignored.
5149 This does character code conversion and applies annotations
5150 like `write-region' does."
5156 "Return most recent backup file for FILENAME or nil if no backups exist."
5157 ;; `make-backup-file-name' will get us the right directory for
5158 ;; ordinary or numeric backups. It might create a directory for
5159 ;; backups as a side-effect, according to `backup-directory-alist'.
5166 tem)
5175 newest))
5178 "Rename current buffer to a similar name not already taken.
5179 This function is useful for creating multiple shell process buffers
5180 or multiple mail buffers, etc.
5182 Note that some commands, in particular those based on `compilation-mode'
5183 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5184 appropriate mode even if it has been renamed. So as well as renaming
5185 the buffer, you also need to switch buffers before running another
5186 instance of such commands."
5194 ;; If the existing buffer name has a <NNN>,
5195 ;; which isn't part of the file name (if any),
5196 ;; then get rid of that.
5202 "Create the directory DIR and optionally any nonexistent parent dirs.
5203 If DIR already exists as a directory, signal an error, unless
5204 PARENTS is non-nil.
5206 Interactively, the default choice of directory to create is the
5207 current buffer's default directory. That is useful when you have
5208 visited a file in a nonexistent directory.
5210 Noninteractively, the second (optional) argument PARENTS, if
5211 non-nil, says whether to create parent directories that don't
5212 exist. Interactively, this happens by default.
5214 If creating the directory or directories fail, an error will be
5215 raised."
5218 nil nil)
5219 t))
5220 ;; If default-directory is a remote directory,
5221 ;; make sure we find its make-directory handler.
5229 create-list)
5231 ;; If directory is its own parent, then we can't
5232 ;; keep looping forever
5247 "Delete the directory named DIRECTORY. Does not follow symlinks.
5248 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5249 TRASH non-nil means to trash the directory instead, provided
5250 `delete-by-moving-to-trash' is non-nil.
5252 When called interactively, TRASH is t if no prefix argument is
5253 given. With a prefix argument, TRASH is nil."
5260 "Move directory to trash: "
5262 default-directory default-directory nil nil))))
5268 nil)
5270 ;; If default-directory is a remote directory, make sure we find its
5271 ;; delete-directory handler.
5278 ;; Only move non-empty dir to trash if recursive deletion was
5279 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5280 ;; case, where the operation fails in delete-directory-internal.
5281 ;; As `move-file-to-trash' trashes directories (empty or
5282 ;; otherwise) as a unit, we do not need to recurse here.
5284 ;; Check if directory is empty apart from "." and "..".
5289 ;; Otherwise, call ourselves recursively if needed.
5293 ;; This test is equivalent to
5294 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5295 ;; but more efficient
5299 ;; We do not want to delete "." and "..".
5305 "Return non-nil if files FILE1 and FILE2 name the same file.
5306 If FILE1 or FILE2 does not exist, the return value is unspecified."
5317 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5319 Return nil if DIR is not an existing directory."
5331 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5346 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5347 This function always sets the file modes of the output files to match
5348 the corresponding input file.
5350 The third arg KEEP-TIME non-nil means give the output files the same
5351 last-modified time as the old ones. (This works on only some systems.)
5353 A prefix arg makes KEEP-TIME non-nil.
5355 Noninteractively, the last argument PARENTS says whether to
5356 create parent directories if they don't exist. Interactively,
5357 this happens by default.
5359 If NEWNAME names an existing directory, copy DIRECTORY as a
5360 subdirectory there. However, if called from Lisp with a non-nil
5361 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5362 directly into NEWNAME instead."
5369 default-directory default-directory nil nil)
5370 current-prefix-arg t nil)))
5373 directory newname))
5374 ;; If default-directory is a remote directory, make sure we find its
5375 ;; copy-directory handler.
5380 newname keep-time parents copy-contents)
5382 ;; Compute target name.
5387 ;; If NEWNAME is not an existing directory, create it;
5388 ;; that is where we will copy the files of DIRECTORY.
5390 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5391 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5396 newname))
5400 newname))
5403 ;; Copy recursively.
5405 ;; We do not want to copy "." and "..".
5407 directory-files-no-dot-files-regexp))
5417 ;; Set directory attributes.
5423 \f
5424 ;; At time of writing, only info uses this.
5426 "Return a copy of DIRS with all non-existent directories removed.
5427 The optional argument KEEP is a list of directories to retain even if
5428 they don't exist, and REJECT is a list of directories to remove from
5429 DIRS, even if they exist; REJECT takes precedence over KEEP.
5431 Note that membership in REJECT and KEEP is checked using simple string
5432 comparison."
5438 dirs)))
5440 \f
5443 "Function to use to revert this buffer.
5444 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5445 which are the arguments that `revert-buffer' received.
5446 It also has access to the `preserve-modes' argument of `revert-buffer'
5447 via the `revert-buffer-preserve-modes' dynamic variable.
5449 For historical reasons, a value of nil means to use the default function.
5454 #'revert-buffer-insert-file-contents--default-function
5455 "Function to use to insert contents when reverting this buffer.
5456 The function receives two arguments: the first the nominal file name to use;
5457 the second is t if reading the auto-save file.
5459 The function is responsible for updating (or preserving) point.
5461 For historical reasons, a value of nil means to use the default function.
5465 "Default function to use for `buffer-stale-function'.
5466 This function ignores its argument.
5467 This returns non-nil if the current buffer is visiting a readable file
5468 whose modification time does not match that of the buffer.
5470 This function only handles buffers that are visiting files.
5471 Non-file buffers need a custom function"
5478 "Function to check whether a buffer needs reverting.
5479 This should be a function with one optional argument NOCONFIRM.
5480 Auto Revert Mode passes t for NOCONFIRM. The function should return
5481 non-nil if the buffer should be reverted. A return value of
5482 `fast' means that the need for reverting was not checked, but
5483 that reverting the buffer is fast. The buffer is current when
5484 this function is called.
5486 The idea behind the NOCONFIRM argument is that it should be
5487 non-nil if the buffer is going to be reverted without asking the
5488 user. In such situations, one has to be careful with potentially
5489 time consuming operations.
5491 For historical reasons, a value of nil means to use the default function.
5492 This should not be relied upon.
5494 For more information on how this variable is used by Auto Revert mode,
5498 "Normal hook for `revert-buffer' to run before reverting.
5499 The function `revert-buffer--default' runs this.
5503 "Normal hook for `revert-buffer' to run after reverting.
5504 Note that the hook value that it runs is the value that was in effect
5505 before reverting; that makes a difference if you have buffer-local
5506 hook functions.
5508 The function `revert-buffer--default' runs this.
5516 ;; `revert-buffer-function' was defined long ago to be a function of only
5517 ;; 2 arguments, so we have to use a dynbind variable to pass the
5518 ;; `preserve-modes' argument of `revert-buffer'.
5522 "Replace current buffer text with the text of the visited file on disk.
5523 This undoes all changes since the file was visited or saved.
5524 With a prefix argument, offer to revert from latest auto-save file, if
5525 that is more recent than the visited file.
5527 This command also implements an interface for special buffers
5528 that contain text which doesn't come from a file, but reflects
5529 some other data instead (e.g. Dired buffers, `buffer-list'
5530 buffers). This is done via the variable `revert-buffer-function'.
5531 In these cases, it should reconstruct the buffer contents from the
5532 appropriate data.
5534 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5535 to revert from the auto-save file when this is nil. Note that the
5536 sense of this argument is the reverse of the prefix argument, for the
5537 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5538 to nil.
5540 Optional second argument NOCONFIRM means don't ask for confirmation
5541 at all. (The variable `revert-without-query' offers another way to
5542 revert buffers without querying for confirmation.)
5544 Optional third argument PRESERVE-MODES non-nil means don't alter
5545 the files modes. Normally we reinitialize them using `normal-mode'.
5547 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5549 This function calls the function that `revert-buffer-function' specifies
5550 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5551 The default function runs the hooks `before-revert-hook' and
5552 `after-revert-hook'."
5553 ;; I admit it's odd to reverse the sense of the prefix argument, but
5554 ;; there is a lot of code out there which assumes that the first
5555 ;; argument should be t to avoid consulting the auto-save file, and
5556 ;; there's no straightforward way to encourage authors to notice a
5557 ;; reversal of the argument sense. So I'm just changing the user
5558 ;; interface, but leaving the programmatic interface the same.
5563 ignore-auto noconfirm)))
5566 "Default function for `revert-buffer'.
5567 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5568 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5569 start and end.
5571 Calls `revert-buffer-insert-file-contents-function' to reread the
5572 contents of the visited file, with two arguments: the first is the file
5573 name, the second is non-nil if reading an auto-save file.
5575 This function only handles buffers that are visiting files.
5576 Non-file buffers need a custom function."
5581 buffer-auto-save-file-name
5586 buffer-auto-save-file-name
5587 buffer-file-name)))
5597 file-name)))
5599 ;; If file was backed up but has changed since,
5600 ;; we should make another backup.
5604 ;; Effectively copy the after-revert-hook status,
5605 ;; since after-find-file will clobber it.
5608 after-revert-hook))
5610 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5614 file-name auto-save-p)
5615 ;; Recompute the truename in case changes in symlinks
5616 ;; have changed the truename.
5620 ;; Run after-revert-hook as it was before we reverted.
5624 local-hook)
5627 t)))))
5630 "Default function for `revert-buffer-insert-file-contents-function'.
5631 The function `revert-buffer--default' calls this.
5632 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5633 an auto-save file."
5637 "File %s no longer exists!"
5639 file-name))
5642 "File %s no longer readable!"
5644 file-name))
5646 ;; Bind buffer-file-name to nil
5647 ;; so that we don't try to lock the file.
5653 ;; Auto-saved file should be read by Emacs's
5654 ;; internal coding.
5658 buffer-file-coding-system-explicit
5661 coding-system-for-read
5663 coding-system-for-read)
5665 ;; As a coding system suitable for multibyte
5666 ;; buffer is specified, make the current
5667 ;; buffer multibyte.
5670 ;; This force after-insert-file-set-coding
5671 ;; (called from insert-file-contents) to set
5672 ;; buffer-file-coding-system to a proper value.
5675 ;; Note that this preserves point in an intelligent way.
5679 nil nil t))
5681 nil nil t))))))
5684 "Recover the visited file--get contents from its last auto-save file."
5689 "Visit file FILE, but get contents from its last auto-save file."
5690 ;; Actually putting the file name in the minibuffer should be used
5691 ;; only rarely.
5692 ;; Not just because users often use the default.
5705 "*Directory*" nil
5716 ;; Use insert-directory-safely, not insert-directory,
5717 ;; because these files might not exist. In particular,
5718 ;; FILE might not exist if the auto-save file was for
5719 ;; a buffer that didn't visit a file, such as "*mail*".
5720 ;; The code in v20.x called `ls' directly, so we need
5721 ;; to emulate what `ls' did in that case.
5726 ;; Keep the current buffer-file-coding-system.
5728 ;; Auto-saved file should be read with special coding.
5737 "Recover auto save files from a previous Emacs session.
5738 This command first displays a Dired buffer showing you the
5739 previous sessions that you could recover from.
5740 To choose one, move point to the proper line and then type C-c C-c.
5741 Then you'll be asked about a number of files to recover."
5751 directory-files-no-dot-files-regexp
5753 t)
5764 ;; Each line starts with a space
5765 ;; so that Font Lock mode won't highlight the first character.
5768 " To delete a session file, type \
5774 "Choose one saved session to recover auto-save files from.
5775 This command is used in the special Dired buffer created by
5778 ;; Get the name of the session file to recover from.
5780 files
5786 ;; Read in the auto-save-list file.
5789 ;; Loop thru the text of that file
5790 ;; and get out the names of the files to recover.
5794 ;; This is a pair of lines for a non-file-visiting buffer.
5795 ;; Get the auto-save file name and manufacture
5796 ;; a "visited file name" from that.
5799 ;; If there is no auto-save file name, the
5800 ;; auto-save-list file is probably corrupted.
5813 ;; This pair of lines is a file-visiting
5814 ;; buffer. Use the visited file name.
5824 ;; Ignore a file if its auto-save file does not exist now.
5828 ;; The file contains a pair of line for each auto-saved buffer.
5829 ;; The first line of the pair contains the visited file name
5830 ;; or is empty if the buffer was not visiting a file.
5831 ;; The second line is the auto-save file name.
5839 files
5845 "Kill BUFFER if confirmed."
5853 "Kill some buffers. Asks the user whether to kill each one of them.
5854 Non-interactively, if optional argument LIST is non-nil, it
5855 specifies the list of buffers to kill, asking for approval for each one."
5863 ; if we killed the base buffer.
5870 "Kill buffers whose name matches the specified REGEXP.
5871 The optional second argument indicates whether to kill internal buffers too."
5880 \f
5882 "Adjust current buffer's auto save file name for current conditions.
5883 Also rename any existing auto save file, if it was made in this session."
5895 "Return file name to use for auto-saves of current buffer.
5896 Does not consider `auto-save-visited-file-name' as that variable is checked
5897 before calling this function. You can redefine this for customization.
5898 See also `auto-save-file-name-p'."
5906 result uniq)
5907 ;; Apply user-specified translations
5908 ;; to the file name.
5912 filename)
5922 filename))))
5927 ;; We truncate the file name to DOS 8+3 limits
5928 ;; before doing anything else, because the regexp
5929 ;; passed to string-match below cannot handle
5930 ;; extensions longer than 3 characters, multiple
5931 ;; dots, and other atrocities.
5936 fn)
5941 "#"
5944 ;; Make sure auto-save file names don't contain characters
5945 ;; invalid for the underlying filesystem.
5947 ;; Don't modify remote (ange-ftp) filenames
5950 result))))
5952 ;; Deal with buffers that don't have any associated files. (Mail
5953 ;; mode tends to create a good number of these.)
5957 file-name)
5958 ;; Restrict the characters used in the file name to those which
5959 ;; are known to be safe on all filesystems, url-encoding the
5960 ;; rest.
5961 ;; We do this on all platforms, because even if we are not
5962 ;; running on DOS/Windows, the current directory may be on a
5963 ;; mounted VFAT filesystem, such as a USB memory stick.
5967 ;; For multibyte characters, this will produce more than
5968 ;; 2 hex digits, so is not true URL encoding.
5972 ;; Generate the file name.
5978 ;; Try a few alternative directories, to get one we can
5979 ;; write it.
5985 ;; Don't modify remote (ange-ftp) filenames
5987 ;; The call to convert-standard-filename is in case
5988 ;; buffer-name includes characters not allowed by the
5989 ;; DOS/Windows filesystems. make-temp-file writes to the
5990 ;; file it creates, so we must fix the file name _before_
5991 ;; make-temp-file is called.
5993 fname))
5995 ;; make-temp-file creates the file,
5996 ;; but we don't want it to exist until we do an auto-save.
6000 file-name)))
6003 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6004 FILENAME should lack slashes. You can redefine this for customization."
6006 \f
6008 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6009 The generated regexp will match a filename only if the filename
6010 matches that wildcard according to shell rules. Only wildcards known
6011 by `sh' are supported."
6013 ;; Copy the initial run of non-special characters.
6016 ;; If no special characters, we're almost done.
6020 j)
6022 result
6043 ;; Found "[^". Insert a `\0' character
6044 ;; (which cannot happen in a filename)
6045 ;; into the character class, so that `^'
6046 ;; is not the first character after `[',
6047 ;; and thus non-special in a regexp.
6052 ;; I don't think `]' can appear in a
6053 ;; character class in a wildcard, but
6054 ;; let's be general here.
6061 i
6074 ;; Shell wildcards should match the entire filename,
6075 ;; not its part. Make the regexp say so.
6077 \f
6080 "Switches for `list-directory' to pass to `ls' for brief listing."
6086 "Switches for `list-directory' to pass to `ls' for verbose listing."
6091 "Expand wildcard pattern PATTERN.
6092 This returns a list of file names which match the pattern.
6093 Files are sorted in `string<' order.
6095 If PATTERN is written as an absolute file name,
6096 the values are absolute also.
6098 If PATTERN is written as a relative file name, it is interpreted
6099 relative to the current default directory, `default-directory'.
6100 The file names returned are normally also relative to the current
6101 default directory. However, if FULL is non-nil, they are absolute."
6105 ;; A list of all dirs that DIRPART specifies.
6106 ;; This can be more than one dir
6107 ;; if DIRPART contains wildcards.
6111 dirpart)))
6115 contents)
6120 ;; Filter out "." and ".."
6125 name))
6132 this-dir-contents)
6133 this-dir-contents)
6134 contents)))))
6135 contents)))
6137 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6141 "Display a list of files in or matching DIRNAME, a la `ls'.
6142 DIRNAME is globbed by the shell if necessary.
6143 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6144 Actions controlled by variables `list-directory-brief-switches'
6145 and `list-directory-verbose-switches'."
6149 nil default-directory nil)
6150 pfx)))
6152 list-directory-brief-switches))
6153 buffer)
6165 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6173 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6175 PATTERN is assumed to represent a file-name wildcard suitable for the
6176 underlying filesystem. For Unix and GNU/Linux, each character from the
6178 the parts of the pattern which don't include wildcard characters are
6179 quoted with double quotes.
6182 on Windows), so PATTERN can use them to quote wildcard characters that
6183 need to be passed verbatim to shell commands."
6187 ;; DOS/Windows don't allow `"' in file names. So if the
6188 ;; argument has quotes, we can safely assume it is already
6189 ;; quoted by the caller.
6191 ;; We quote [&()#$`'] in case their shell is a port of a
6192 ;; Unixy shell. We quote [,=+] because stock DOS and
6193 ;; Windows shells require that in some cases, such as
6194 ;; passing arguments to batch files that use positional
6195 ;; arguments like %1.
6197 pattern
6200 end)
6217 pattern))))
6224 "Program to get the amount of free space on a file system.
6225 We assume the output has the format of `df'.
6226 The value of this variable must be just a command name or file name;
6227 if you want to specify options, use `directory-free-space-args'.
6229 A value of nil disables this feature.
6231 If the function `file-system-info' is defined, it is always used in
6232 preference to the program given by this variable."
6238 "Options to use when running `directory-free-space-program'."
6243 "Return the amount of free space on directory DIR's file system.
6244 The return value is a string describing the amount of free
6245 space (normally, the number of free 1KB blocks).
6247 This function calls `file-system-info' if it is available, or
6248 invokes the program specified by `directory-free-space-program'
6249 and `directory-free-space-args'. If the system call or program
6250 is unsuccessful, or if DIR is a remote directory, this function
6251 returns nil."
6253 ;; Try to find the number of free blocks. Non-Posix systems don't
6254 ;; always have df, but might have an equivalent system call.
6263 ;; Avoid failure if the default directory does
6264 ;; not exist (Bug#2631, Bug#3911).
6268 nil t nil
6269 directory-free-space-args
6272 ;; Assume that the "available" column is before the
6273 ;; "capacity" column. Find the "%" and scan backward.
6277 "[[:space:]]+[^[:space:]]+%[^%]*$"
6284 ;; The following expression replaces `dired-move-to-filename-regexp'.
6288 ;; In some locales, month abbreviations are as short as 2 letters,
6289 ;; and they can be followed by ".".
6290 ;; In Breton, a month name can include a quote character.
6303 s "+"
6306 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6307 ;; omits the Kanji characters after month and day-of-month.
6308 ;; On Mac OS X 10.3, the date format in East Asian locales is
6309 ;; day-of-month digits followed by month digits.
6315 ;; The "[0-9]" below requires the previous column to end in a digit.
6316 ;; This avoids recognizing `1 may 1997' as a date in the line:
6317 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6319 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6321 ;; For non-iso date formats, we add the ".*" in order to find
6322 ;; the last possible match. This avoids recognizing
6323 ;; `jservice 10 1024' as a date in the line:
6324 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6326 ;; vc dired listings provide the state or blanks between file
6327 ;; permissions and date. The state is always surrounded by
6328 ;; parentheses:
6329 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6330 ;; This is not supported yet.
6335 "Regular expression to match up to the file name in a directory listing.
6336 The default value is designed to recognize dates and times
6341 ;; insert-directory
6342 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6343 ;; FULL-DIRECTORY-P is nil.
6344 ;; The single line of output must display FILE's name as it was
6345 ;; given, namely, an absolute path name.
6346 ;; - must insert exactly one line for each file if WILDCARD or
6347 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6348 ;; before the file lines, plus optional text after the file lines.
6349 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6350 ;; allowed.
6351 ;; File lines should display the basename.
6352 ;; - must be consistent with
6353 ;; - functions dired-move-to-filename, (these two define what a file line is)
6354 ;; dired-move-to-end-of-filename,
6355 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6356 ;; dired-insert-headerline
6357 ;; dired-after-subdir-garbage (defines what a "total" line is)
6358 ;; - variable dired-subdir-regexp
6359 ;; - may be passed "--dired" as the first argument in SWITCHES.
6360 ;; Filename handlers might have to remove this switch if their
6361 ;; "ls" command does not support it.
6363 "Insert directory listing for FILE, formatted according to SWITCHES.
6364 Leaves point after the inserted text.
6365 SWITCHES may be a string of options, or a list of strings
6366 representing individual options.
6367 Optional third arg WILDCARD means treat FILE as shell wildcard.
6368 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6369 switches do not contain `d', so that a full listing is expected.
6371 This works by running a directory listing program
6372 whose name is in the variable `insert-directory-program'.
6373 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6375 When SWITCHES contains the long `--dired' option, this function
6376 treats it specially, for the sake of dired. However, the
6377 normally equivalent short `-D' option is just passed on to
6378 `insert-directory-program', as any other option."
6379 ;; We need the directory in order to find the right handler.
6384 wildcard full-directory-p)
6387 ;; Read the actual directory using `insert-directory-program'.
6388 ;; RESULT gets the status code.
6390 ;; putting text property `dired-filename, decode one
6391 ;; bunch by one to preserve that property.
6393 ;; This is to control encoding the arguments in call-process.
6397 default-file-name-coding-system))))
6400 ;; Run ls in the directory part of the file pattern
6401 ;; using the last component as argument.
6407 ;; NB since switches is passed to the shell, be
6408 ;; careful of malicious values, eg "-l;reboot".
6409 ;; See eg dired-safe-switches-p.
6411 shell-file-name nil t nil
6412 "-c"
6414 ""
6416 insert-directory-program
6417 " -d "
6419 switches
6421 " -- "
6422 ;; Quote some characters that have
6423 ;; special meanings in shells; but
6424 ;; don't quote the wildcards--we want
6425 ;; them to be special. We also
6426 ;; currently don't quote the quoting
6427 ;; characters in case people want to
6428 ;; use them explicitly to quote
6429 ;; wildcard characters.
6431 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6432 ;; directory if FILE is a symbolic link.
6440 insert-directory-program nil t nil
6444 ;; Split the switches at any spaces so we can
6445 ;; pass separate options as separate args.
6447 ;; Avoid lossage if FILE starts with `-'.
6455 file))))))))
6457 ;; If we got "//DIRED//" in the output, it means we got a real
6458 ;; directory listing, even if `ls' returned nonzero.
6459 ;; So ignore any errors.
6472 ;; The first time ls returns an error,
6473 ;; find the version numbers of ls,
6474 ;; and set insert-directory-ls-version
6475 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6476 ;; is equal or if the info cannot be obtained.
6477 ;; (That can mean it isn't GNU ls.)
6487 comparison)
6503 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6507 ;; If `insert-directory-program' failed, signal an error.
6509 ;; Delete the error message it may have output.
6511 ;; On non-Posix systems, we cannot open a directory, so
6512 ;; don't even try, because that will always result in
6513 ;; the ubiquitous "Access denied". Instead, show the
6514 ;; command line so the user can try to guess what went wrong.
6519 insert-directory-program
6521 file result)
6522 ;; Unix. Access the file to get a suitable error.
6529 ;; The following overshoots by one line for an empty
6530 ;; directory listed with "--dired", but without "-a"
6531 ;; switch, where the ls output contains a
6532 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6533 ;; We take care of that case later.
6541 error-lines)
6542 ;; Find all the lines that are error messages,
6543 ;; and record the bounds of each one.
6550 ;; Now read the numeric positions of file names.
6557 error-lines))
6560 error-lines)))
6562 ;; End is followed by \n or by " -> ".
6564 ;; It seems that we can't trust ls's output as to
6565 ;; byte positions of filenames.
6571 ;; Take care of the case where the ls output contains a
6572 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6573 ;; and we went one line too far back (see above).
6578 ;; Now decode what read if necessary.
6580 file-name-coding-system
6581 default-file-name-coding-system
6583 coding-no-eol
6584 val pos)
6588 ;; If no coding system is specified or detection is
6589 ;; requested, detect the coding.
6603 ;; Force no eol conversion on a file name, so
6604 ;; that CR is preserved.
6612 ;; Try to insert the amount of free space.
6615 ;; First find the line to put it on.
6619 ;; Replace "total" with "used", to avoid confusion.
6625 "Convert `ls --dired' file name position value POS to a buffer position.
6626 File name position values returned in ls --dired output
6627 count only stdout; they don't count the error messages sent to stderr.
6628 So this function converts to them to real buffer positions.
6629 ERROR-LINES is a list of buffer positions of error message lines,
6630 of the form (START END)."
6634 pos)
6638 "Insert directory listing for FILE, formatted according to SWITCHES.
6640 Like `insert-directory', but if FILE does not exist, it inserts a
6641 message to that effect instead of signaling an error."
6644 ;; Simulate the message printed by `ls'.
6648 "Functions to call with no arguments to query about killing Emacs.
6649 If any of these functions returns nil, killing Emacs is canceled.
6650 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6654 "How to ask for confirmation when leaving Emacs.
6655 If nil, the default, don't ask at all. If the value is non-nil, it should
6656 be a predicate function; for example `yes-or-no-p'."
6665 "Offer to save each buffer, then kill this Emacs process.
6666 With prefix ARG, silently save all file-visiting buffers without asking.
6667 If there are active processes where `process-query-on-exit-flag'
6668 returns non-nil, asks whether processes should be killed.
6669 Runs the members of `kill-emacs-query-functions' in turn and stops
6670 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6682 ;; process-list is not defined on MSDOS.
6684 active)
6702 ;; Query the user for other things, perhaps.
6709 "Offer to save each buffer, then kill the current connection.
6710 If the current frame has no client, kill Emacs itself.
6712 With prefix ARG, silently save all file-visiting buffers, then kill.
6714 If emacsclient was started with a list of filenames to edit, then
6715 only these files will be asked to be saved."
6720 \f
6721 ;; We use /: as a prefix to "quote" a file name
6722 ;; so that magic file name handlers will not apply to it.
6726 file-name-handler-alist))
6728 ;; We depend on being the last handler on the list,
6729 ;; so that anything else which does need handling
6730 ;; has been handled already.
6731 ;; So it is safe for us to inhibit *all* magic file name handlers.
6740 default-directory))
6741 ;; Get a list of the indices of the args which are file names.
6744 ;; The first six are special because they
6745 ;; return a file name. We want to include the /:
6746 ;; in the return value.
6747 ;; So just avoid stripping it in the first place.
6754 ;; `identity' means just return the first arg
6755 ;; not stripped of its quoting.
6757 ;; `add' means add "/:" to the result.
6760 ;; `unquote-then-quote' means set buffer-file-name
6761 ;; temporarily to unquoted filename.
6763 ;; List the arguments which are filenames.
6771 ;; For all other operations, treat the first argument only
6772 ;; as the file name.
6774 method
6775 ;; Copy ARGUMENTS so we can replace elements in it.
6779 ;; Strip off the /: from the file names that have it.
6787 "/"
6793 (`insert-file-contents
6799 (`unquote-then-quote
6804 \f
6805 ;; Symbolic modes and read-file-modes.
6808 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6809 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6810 Others, or All) for whom to produce the mask.
6811 The bit-mask that is returned extracts from mode bits the access rights
6812 for the specified category of users."
6820 "Convert CHAR to a numeric value of mode bits.
6821 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6822 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6829 ;; Rights relative to the previous file modes.
6840 "Convert a symbolic mode string specification to an equivalent number.
6842 WHO-MASK is the bit-mask specifying the category of users to which to
6843 apply the access permissions. See `file-modes-char-to-who'.
6844 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6845 RIGHTS request to add, remove, or set permissions based on existing ones,
6852 char-right)
6859 num-rights
6863 op char-right)))
6864 num-rights))
6867 "Convert symbolic file modes to numeric file modes.
6868 MODES is the string to convert, it should match
6870 See Info node `(coreutils)File permissions' for more information on this
6871 notation.
6872 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6873 MODES request to add, remove, or set permissions based on existing ones,
6887 num-who num-modes)
6890 num-modes)))
6893 "Read file modes in octal or symbolic notation and return its numeric value.
6895 ORIG-FILE is the name of a file on whose mode bits to base returned
6896 permissions if what user types requests to add, remove, or set permissions
6912 nil nil default)))
6921 ;; Trashcan handling.
6923 "Directory for `move-file-to-trash' to move files and directories to.
6924 This directory is only used when the function `system-move-file-to-trash'
6925 is not defined.
6926 Relative paths are interpreted relative to `default-directory'.
6927 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6937 "Move the file (or directory) named FILENAME to the trash.
6938 When `delete-by-moving-to-trash' is non-nil, this function is
6939 called by `delete-file' and `delete-directory' instead of
6940 deleting files outright.
6942 If the function `system-move-file-to-trash' is defined, call it
6943 with FILENAME as an argument.
6944 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6945 directory.
6946 Otherwise, trash FILENAME using the freedesktop.org conventions,
6947 like the GNOME, KDE and XFCE desktop environments. Emacs only
6951 ;; If `trash-directory' is non-nil, move the file there.
6955 trash-dir)))
6956 ;; We can't trash a parent directory of trash-directory.
6959 trash-dir filename))
6962 ;; Ensure that the trashed file-name is unique.
6969 ;; If `system-move-file-to-trash' is defined, use it.
6972 ;; Otherwise, use the freedesktop.org method, as specified at
6973 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6984 ;; Check if we have permissions to delete.
6988 ;; The trashed file cannot be the trash dir or its parent.
6991 trash-files-dir filename))
6994 trash-info-dir filename))
6996 ;; Ensure that the trash directory exists; otherwise, create it.
7003 ;; Try to move to trash with .trashinfo undo information
7008 ;; Perform url-encoding on FN. For compatibility with
7009 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7010 ;; for path separators.
7015 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7016 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7029 fn))
7034 ;; Attempt to make .trashinfo file, trying up to 5
7035 ;; times. The .trashinfo file is opened with O_EXCL,
7036 ;; as per trash-spec 0.7, even if that can be a problem
7037 ;; on old NFS versions...
7041 trash-files-dir))
7043 success info-fn)
7048 trash-info-dir))
7056 ;; Uniquify new-fn. (Some file managers do not
7057 ;; like Emacs-style backup file names---e.g. bug
7058 ;; 170956 in Konqueror bug tracker.)
7063 ;; Finally, try to move the file to the trashcan.
7067 \f
7092 ;;; files.el ends here