| blob | a6fe381a50a3b57c24e0bbe9b5833c665268f4af |
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 writing out a buffer to a file.
444 If one of them returns non-nil, the file is considered already written
445 and the rest are not called.
446 These hooks are considered to pertain to the visited file.
447 So any buffer-local binding of this variable is discarded if you change
449 change the major mode.
451 This hook is not run if any of the functions in
452 `write-contents-functions' returns non-nil. Both hooks pertain
453 to how to save a buffer to file, for instance, choosing a suitable
454 coding system and setting mode bits. (See Info
455 node `(elisp)Saving Buffers'.) To perform various checks or
467 "List of functions to be called before writing out a buffer to a file.
468 If one of them returns non-nil, the file is considered already written
469 and the rest are not called and neither are the functions in
470 `write-file-functions'.
472 This variable is meant to be used for hooks that pertain to the
473 buffer's contents, not to the particular visited file; thus,
474 `set-visited-file-name' does not clear this variable; but changing the
475 major mode does clear it.
477 For hooks that _do_ pertain to the particular visited file, use
478 `write-file-functions'. Both this variable and
479 `write-file-functions' relate to how a buffer is saved to file.
480 To perform various checks or updates before the buffer is saved,
485 "Control use of local variables in files you visit.
486 The value can be t, nil, :safe, :all, or something else.
488 A value of t means file local variables specifications are obeyed
489 if all the specified variable values are safe; if any values are
490 not safe, Emacs queries you, once, whether to set them all.
491 \(When you say yes to certain values, they are remembered as safe.)
493 :safe means set the safe variables, and ignore the rest.
494 :all means set all variables, whether safe or not.
495 (Don't set it permanently to :all.)
496 A value of nil means always ignore the file local variables.
498 Any other value means always query you once whether to set them all.
499 \(When you say yes to certain values, they are remembered as safe, but
502 This variable also controls use of major modes specified in
503 a -*- line.
506 always obeys file local variable specifications and the -*- line,
507 and ignores this variable."
508 :risky t
517 "Non-nil means enable use of directory-local variables.
518 Some modes may wish to set this to nil to prevent directory-local
521 ;; This is an odd variable IMO.
522 ;; You might wonder why it is needed, when we could just do:
523 ;; (set (make-local-variable 'enable-local-variables) nil)
524 ;; These two are not precisely the same.
525 ;; Setting this variable does not cause -*- mode settings to be
526 ;; ignored, whereas setting enable-local-variables does.
527 ;; Only three places in Emacs use this variable: tar and arc modes,
528 ;; and rmail. The first two don't need it. They already use
529 ;; inhibit-local-variables-regexps, which is probably enough, and
530 ;; could also just set enable-local-variables locally to nil.
531 ;; Them setting it has the side-effect that dir-locals cannot apply to
532 ;; eg tar files (?). FIXME Is this appropriate?
533 ;; AFAICS, rmail is the only thing that needs this, and the only
534 ;; reason it uses it is for BABYL files (which are obsolete).
535 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
536 ;; to respect, so that find-file on a BABYL file will switch to
537 ;; rmail-mode automatically (this is nice, but hardly essential,
538 ;; since most people are used to explicitly running a command to
539 ;; access their mail; M-x gnus etc). Rmail files may happen to
540 ;; contain Local Variables sections in messages, which Rmail wants to
541 ;; ignore. So AFAICS the only reason this variable exists is for a
542 ;; minor convenience feature for handling of an obsolete Rmail file format.
544 "Like `enable-local-variables' but meant for buffer-local bindings.
545 The meaningful values are nil and non-nil. The default is non-nil.
546 If a major mode sets this to nil, buffer-locally, then any local
547 variables list in a file visited in that mode will be ignored.
549 This variable does not affect the use of major modes specified
554 The value can be t, nil or something else.
555 A value of t means obey `eval' variables.
556 A value of nil means ignore them; anything else means query."
557 :risky t
564 "Non-nil means buffers visiting files read-only do so in view mode.
565 In fact, this means that all read-only buffers normally have
566 View mode enabled, including buffers that are read-only because
567 you visit a file you cannot alter, and buffers you make read-only
573 "History list of file names entered in the minibuffer.
575 Maximum length of the history list is determined by the value
579 "If non-nil, avoid messages when saving files.
580 Error-related messages will still be printed, but all other
583 \f
586 "Provides support for ange-ftp host name completion.
587 Runs the usual ange-ftp hook, but only for completion operations."
588 ;; Having this here avoids the need to load ange-ftp when it's not
589 ;; really in use.
595 inhibit-file-name-handlers)))
603 "Convert a standard file's name to something suitable for the OS.
604 This means to guarantee valid names and perhaps to canonicalize
605 certain patterns.
607 FILENAME should be an absolute file name since the conversion rules
608 sometimes vary depending on the position in the file name. E.g. c:/foo
609 is a valid DOS file name, but c:/bar/c:/foo is not.
611 This function's standard definition is trivial; it just returns
612 the argument. However, on Windows and DOS, replace invalid
613 characters. On DOS, make sure to obey the 8.3 limitations.
614 In the native Windows build, turn Cygwin names into native names,
615 and also turn slashes into backslashes if the shell requires it (see
616 `w32-shell-dos-semantics').
618 See Info node `(elisp)Standard File Names' for more details."
623 ;; Replace invalid filename characters with !
627 name))
635 "Read directory name, prompting with PROMPT and completing in directory DIR.
636 Value is not expanded---you must call `expand-file-name' yourself.
637 Default name to DEFAULT-DIRNAME if user exits with the same
638 non-empty string that was inserted by this function.
639 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
640 or just DIR if INITIAL is nil.)
641 If the user exits with an empty minibuffer, this function returns
642 an empty string. (This can only happen if the user erased the
643 pre-inserted contents or if `insert-default-directory' is nil.)
644 Fourth arg MUSTMATCH non-nil means require existing directory's name.
645 Non-nil and non-t means also require confirmation after completion.
646 Fifth arg INITIAL specifies text to start with.
647 DIR should be an absolute directory name. It defaults to
648 the value of `default-directory'."
653 dir))
654 mustmatch initial
657 \f
659 "Show the current default directory.
660 With prefix argument INSERT, insert the current default directory
661 at point instead."
668 "Value of the CDPATH environment variable, as a list.
672 "Explode a search path into a list of directory names.
673 Directories are separated by `path-separator' (which is colon in
674 GNU and Unix systems). Substitute environment variables into the
675 resulting list of directory names. For an empty path element (i.e.,
676 a leading or trailing separator, or two adjacent separators), return
677 nil (meaning `default-directory') as the associated list element."
685 "Change current directory to given absolute file name DIR."
686 ;; Put the name into directory syntax now,
687 ;; because otherwise expand-file-name may give some bad results.
689 ;; We used to additionally call abbreviate-file-name here, for an
690 ;; unknown reason. Problem is that most buffers are setup
691 ;; without going through cd-absolute and don't call
692 ;; abbreviate-file-name on their default-directory, so the few that
693 ;; do end up using a superficially different directory.
705 "Make DIR become the current buffer's default directory.
706 If your environment includes a `CDPATH' variable, try each one of
707 that list of directories (separated by occurrences of
708 `path-separator') when resolving a relative directory name.
709 The path separator is colon in GNU and GNU-like systems."
712 ;; FIXME: There's a subtle bug in the completion below. Seems linked
713 ;; to a fundamental difficulty of implementing `predicate' correctly.
714 ;; The manifestation is that TAB may list non-directories in the case where
715 ;; those files also correspond to valid directories (if your cd-path is (A/
716 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
717 ;; will be listed as valid completions).
718 ;; This is because `a' (listed because of A/a) is indeed a valid choice
719 ;; (which will lead to the use of B/a).
724 cd-path nil))
733 default-directory default-directory
734 t))))
744 "Return non-nil if NAME ends with a directory separator character."
754 "Return list of all files under DIR that have file names matching REGEXP.
756 order, and files from each directory are sorted in alphabetical order.
757 Each file name appears in the returned list in its absolute form.
758 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
759 output directories whose names match REGEXP."
762 ;; When DIR is "/", remote file names like "/method:" could
763 ;; also be offered. We shall suppress them.
771 ;; Don't follow symlinks to other directories.
775 full-file regexp include-directories))))
786 "Load the Lisp file named FILE."
787 ;; This is a case where .elc and .so/.dll make a lot of sense.
791 completion-ignored-extensions))))
796 "Search for FILENAME through PATH.
797 If found, return the absolute file name of FILENAME; otherwise
798 return nil.
799 PATH should be a list of directories to look in, like the lists in
800 `exec-path' or `load-path'.
801 If SUFFIXES is non-nil, it should be a list of suffixes to append to
804 If non-nil, PREDICATE is used instead of `file-readable-p'.
806 This function will normally skip directories, so if you want it to find
807 directories, make sure the PREDICATE function returns `dir-ok' for them.
809 PREDICATE can also be an integer to pass to the `access' system call,
810 in which case file-name handlers are ignored. This usage is deprecated.
811 For compatibility, PREDICATE can also be one of the symbols
812 `executable', `readable', `writable', or `exists', or a list of
813 one or more of those symbols."
824 "Do completion for file names passed to `locate-file'."
827 ;; FIXME: maybe we should use completion-file-name-table instead,
828 ;; tho at least for `load', the arg is passed through
829 ;; substitute-in-file-name for historical reasons.
839 ;; If we have files like "foo.el" and "foo.elc", we could load one of
840 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
841 ;; preferred way. So if we list all 3, that gives a lot of redundant
842 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
843 ;; the user does want to pay attention to the extension. We try to
844 ;; diffuse this tension by stripping the suffix, except when the
845 ;; result is a single element (i.e. usually we only list "foo" unless
846 ;; it's the only remaining element in the list, in which case we do
847 ;; list "foo", "foo.elc" and "foo.el").
858 string-file dir))
863 ;; Switching from names to names+fullnames creates a non-monotonicity
864 ;; which can cause problems with things like partial-completion.
865 ;; To minimize the problem, filter out completion-regexp-list, so that
866 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
867 ;; from `names' which only matched `string' when they still had
868 ;; their suffix.
870 ;; Remove duplicates of the first element, so that we can easily check
871 ;; if `names' really only contains a single element.
874 ;; There's no more than one matching non-suffixed element, so expand
875 ;; the list by adding the suffixed elements as well.
878 string-dir names string-file pred action)))))
881 "Do completion for file names passed to `locate-file'.
882 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
886 string nil action))
890 "Regexp of directory names which stop the search in `locate-dominating-file'.
891 Any directory whose name matches this regexp will be treated like
892 a kind of root directory by `locate-dominating-file' which will stop its search
893 when it bumps into it.
894 The default regexp prevents fruitless and time-consuming attempts to find
895 special files in directories in which filenames are interpreted as hostnames,
898 ;; (defun locate-dominating-files (file regexp)
899 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
900 ;; Stop at the first parent where a matching file is found and return the list
901 ;; of files that that match in this directory."
902 ;; (catch 'found
903 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
904 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
905 ;; (let ((user nil)
906 ;; ;; Abbreviate, so as to stop when we cross ~/.
907 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
908 ;; files)
909 ;; (while (and dir
910 ;; ;; As a heuristic, we stop looking up the hierarchy of
911 ;; ;; directories as soon as we find a directory belonging to
912 ;; ;; another user. This should save us from looking in
913 ;; ;; things like /net and /afs. This assumes that all the
914 ;; ;; files inside a project belong to the same user.
915 ;; (let ((prev-user user))
916 ;; (setq user (nth 2 (file-attributes dir)))
917 ;; (or (null prev-user) (equal user prev-user))))
918 ;; (if (setq files (condition-case nil
919 ;; (directory-files dir 'full regexp 'nosort)
920 ;; (error nil)))
921 ;; (throw 'found files)
922 ;; (if (equal dir
923 ;; (setq dir (file-name-directory
924 ;; (directory-file-name dir))))
925 ;; (setq dir nil))))
926 ;; nil)))
929 "Look up the directory hierarchy from FILE for a directory containing NAME.
930 Stop at the first parent directory containing a file NAME,
931 and return the directory. Return nil if not found.
932 Instead of a string, NAME can also be a predicate taking one argument
933 \(a directory) and returning a non-nil value if that directory is the one for
934 which we're looking."
935 ;; We used to use the above locate-dominating-files code, but the
936 ;; directory-files call is very costly, so we're much better off doing
937 ;; multiple calls using the code in here.
938 ;;
939 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
940 ;; `name' in /home or in /.
943 ;; `user' is not initialized outside the loop because
944 ;; `file' may not exist, so we may have to walk up part of the
945 ;; hierarchy before we find the "initial UID". Note: currently unused
946 ;; (user nil)
947 try)
950 ;; FIXME: Disabled this heuristic because it is sometimes
951 ;; inappropriate.
952 ;; As a heuristic, we stop looking up the hierarchy of
953 ;; directories as soon as we find a directory belonging
954 ;; to another user. This should save us from looking in
955 ;; things like /net and /afs. This assumes that all the
956 ;; files inside a project belong to the same user.
957 ;; (let ((prev-user user))
958 ;; (setq user (nth 2 (file-attributes file)))
959 ;; (and prev-user (not (equal user prev-user))))
971 "Non-nil means warn if cannot access `user-emacs-directory'.
972 Set this to nil at your own risk..."
978 "Return an absolute per-user Emacs-specific file name.
979 If NEW-NAME exists in `user-emacs-directory', return it.
980 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
981 Else return NEW-NAME in `user-emacs-directory', creating the
982 directory if it does not exist."
990 at-home
991 ;; Make sure `user-emacs-directory' exists,
992 ;; unless we're in batch mode or dumping Emacs.
994 purify-flag
1004 user-emacs-directory-warning
1006 ;; Only warn once per Emacs session.
1010 Unable to %s `user-emacs-directory' (%s).
1011 Any data that would normally be written there may be lost!
1012 If you never want to see this message again,
1013 customize the variable `user-emacs-directory-warning'."
1014 errtype user-emacs-directory)))))
1015 bestname))))
1019 "Search for COMMAND in `exec-path' and return the absolute file name.
1020 Return nil if COMMAND is not found anywhere in `exec-path'."
1021 ;; Use 1 rather than file-executable-p to better match the behavior of
1022 ;; call-process.
1026 "Load the Emacs Lisp library named LIBRARY.
1027 LIBRARY should be a string.
1028 This is an interface to the function `load'. LIBRARY is searched
1029 for in `load-path', both with and without `load-suffixes' (as
1030 well as `load-file-rep-suffixes').
1032 See Info node `(emacs)Lisp Libraries' for more details.
1033 See `load-file' for a different interface to `load'."
1038 load-path
1043 "Test whether FILE specifies a location on a remote system.
1044 A file is considered remote if accessing it is likely to
1045 be slower or less reliable than accessing local files.
1047 `file-remote-p' never opens a new remote connection. It can
1048 only reuse a connection that is already open.
1050 Return nil or a string identifying the remote connection
1051 \(ideally a prefix of FILE). Return nil if FILE is a relative
1052 file name.
1054 When IDENTIFICATION is nil, the returned string is a complete
1055 remote identifier: with components method, user, and host. The
1056 components are those present in FILE, with defaults filled in for
1057 any that are missing.
1059 IDENTIFICATION can specify which part of the identification to
1060 return. IDENTIFICATION can be the symbol `method', `user',
1061 `host', or `localname'. Any other value is handled like nil and
1062 means to return the complete identification. The string returned
1063 for IDENTIFICATION `localname' can differ depending on whether
1064 there is an existing connection.
1066 If CONNECTED is non-nil, return an identification only if FILE is
1067 located on a remote system and a connection is established to
1068 that remote system.
1070 Tip: You can use this expansion of remote identifier components
1071 to derive a new remote file name from an existing one. For
1077 same remote identifier as FILE but expanded; a name such as
1082 nil)))
1084 ;; Probably this entire variable should be obsolete now, in favor of
1085 ;; something Tramp-related (?). It is not used in many places.
1086 ;; It's not clear what the best file for this to be in is, but given
1087 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1088 ;; rather than autoloaded.
1090 ;; This used to try various hard-coded places for remsh, rsh, and
1091 ;; rcmd, trying to guess based on location whether "rsh" was
1092 ;; "restricted shell" or "remote shell", but I don't see the point
1093 ;; in this day and age. Almost everyone will use ssh, and have
1094 ;; whatever command they want to use in PATH.
1101 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1108 "Whether to use the remote file-name cache for read access.
1109 When nil, never expire cached values (caution)
1110 When t, never use the cache (safe, but may be slow)
1111 A number means use cached values for that amount of seconds since caching.
1113 The attributes of remote files are cached for better performance.
1114 If they are changed outside of Emacs's control, the cached values
1115 become invalid, and must be reread. If you are sure that nothing
1116 other than Emacs changes the files, you can set this variable to nil.
1118 If a remote file is checked regularly, it might be a good idea to
1119 let-bind this variable to a value less than the interval between
1120 consecutive checks. For example:
1122 (defun display-time-file-nonempty-p (file)
1123 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1124 (and (file-exists-p file)
1125 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1136 "Copy the file FILE into a temporary file on this machine.
1137 Returns the name of the local copy, or nil, if FILE is directly
1138 accessible."
1139 ;; This formerly had an optional BUFFER argument that wasn't used by
1140 ;; anything.
1144 nil)))
1147 "Return the truename of FILENAME.
1148 If FILENAME is not absolute, first expands it against `default-directory'.
1149 The truename of a file name is found by chasing symbolic links
1150 both at the level of the file and at the level of the directories
1151 containing it, until no links are left at any level.
1154 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1155 ;; COUNTER can be a cons cell whose car is the count of how many
1156 ;; more links to chase before getting an error.
1157 ;; PREV-DIRS can be a cons cell whose car is an alist
1158 ;; of truenames we've just recently computed.
1172 ;; For speed, remove the ange-ftp completion handler from the list.
1173 ;; We know it's not needed here.
1174 ;; For even more speed, do this only on the outermost call.
1181 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1182 ;; case differences being ignored by the OS, and short "8.3 DOS"
1183 ;; name aliases existing for all files. (The short names are not
1184 ;; reported by directory-files, but can be used to refer to files.)
1185 ;; It seems appropriate for file-truename to resolve these issues in
1186 ;; the most natural way, which on Windows is to call the function
1187 ;; `w32-long-file-name' - this returns the exact name of a file as
1188 ;; it is stored on disk (expanding short name aliases with the full
1189 ;; name in the process).
1192 ;; If filename exists, use its long name. If it doesn't
1193 ;; exist, the recursion below on the directory of filename
1194 ;; will drill down until we find a directory that exists,
1195 ;; and use the long name of that, with the extra
1196 ;; non-existent path components concatenated.
1201 ;; If this file directly leads to a link, process that iteratively
1202 ;; so that we don't use lots of stack.
1208 ;; For file name that has a special handler, call handler.
1209 ;; This is so that ange-ftp can save time by doing a no-op.
1212 done t)
1214 target dirfile)
1215 ;; Get the truename of the directory.
1217 ;; If these are equal, we have the (or a) root directory.
1221 ;; If this is the same dir we last got the truename for,
1222 ;; save time--don't recalculate.
1232 done t)
1235 done t)
1236 ;; Put it back on the file name.
1238 ;; Is the file name the name of a link?
1241 ;; Yes => chase that link, then start all over
1242 ;; since the link may point to a directory name that uses links.
1243 ;; We can't safely use expand-file-name here
1244 ;; since target might look like foo/../bar where foo
1245 ;; is itself a link. Instead, we handle . and .. above.
1248 target
1250 done nil)
1251 ;; No, we are done!
1253 filename))
1256 "Chase links in FILENAME until a name that is not a link.
1257 Unlike `file-truename', this does not check whether a parent
1258 directory name is a symbolic link.
1259 If the optional argument LIMIT is a number,
1260 it means chase no more than that many links and then stop."
1268 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1271 ;; Handle `..' by hand, since it needs to work in the
1272 ;; target of any directory symlink.
1273 ;; This code is not quite complete; it does not handle
1274 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1278 ;; Chase links in the default dir of the symlink.
1282 ;; Now find the parent of that dir.
1286 newname))
1288 ;; A handy function to display file sizes in human-readable form.
1289 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1291 "Produce a string showing FILE-SIZE in human-readable form.
1293 Optional second argument FLAVOR controls the units and the display format:
1295 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1297 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1299 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1302 1024.0
1305 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1311 "%.1f%s%s"
1313 file-size
1315 "K"
1320 "Create a temporary file.
1321 The returned file name (created by appending some random characters at the end
1322 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1323 is guaranteed to point to a newly created empty file.
1324 You can then use `write-region' to write new data into the file.
1326 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1328 If SUFFIX is non-nil, add that at the end of the file name."
1329 ;; Create temp files with strict access rights. It's easy to
1330 ;; loosen them later, whereas it's impossible to close the
1331 ;; time-window of loose permissions otherwise.
1340 temporary-file-directory)
1342 temporary-file-directory))))
1348 nil)
1350 ;; the file was somehow created by someone else between
1351 ;; `make-temp-name' and `write-region', let's try again.
1352 nil)
1353 file)))
1356 "Change the encoding of FILE's name from CODING to NEW-CODING.
1357 The value is a new name of FILE.
1358 Signals a `file-already-exists' error if a file of the new name
1359 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1360 is non-nil. A number as fourth arg means request confirmation if
1361 the new name already exists. This is what happens in interactive
1362 use with M-x."
1365 default-file-name-coding-system))
1367 from-coding to-coding)
1369 ;; We provide the default coding only when it seems that
1370 ;; the filename is correctly decoded by the default
1371 ;; coding.
1377 filename default-coding)
1378 default-coding))
1382 ;; We provide the default coding only when a user is going to
1383 ;; change the encoding not from the default coding.
1387 filename from-coding)))
1390 filename from-coding default-coding)
1391 default-coding)))
1395 default-file-name-coding-system))
1396 ;; FILE should have been decoded by DEFAULT-CODING.
1400 ;; Suppress further encoding.
1405 newname))
1406 \f
1408 "Whether confirmation is requested before visiting a new file or buffer.
1409 If nil, confirmation is not requested.
1410 If the value is `after-completion', confirmation is only
1411 requested if the user called `minibuffer-complete' right before
1412 `minibuffer-complete-and-exit'.
1413 Any other non-nil value means to request confirmation.
1415 This affects commands like `switch-to-buffer' and `find-file'."
1423 "Whether to request confirmation before visiting a new file or buffer.
1424 The variable `confirm-nonexistent-file-or-buffer' determines the
1425 return value, which may be passed as the REQUIRE-MATCH arg to
1426 `read-buffer' or `find-file-read-args'."
1434 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1436 By default, FUN is prepended to `minibuffer-setup-hook'. But if FUN is of
1437 the form `(:append FUN1)', FUN1 will be appended to `minibuffer-setup-hook'
1438 instead of prepending it.
1440 BODY should use the minibuffer at most once.
1441 Recursive uses of the minibuffer are unaffected (FUN is not
1442 called additional times).
1444 This macro actually adds an auxiliary function that calls FUN,
1445 rather than FUN itself, to `minibuffer-setup-hook'."
1456 ;; Clear out this hook so it does not interfere
1457 ;; with any recursive minibuffer usage.
1468 t))
1471 "Edit file FILENAME.
1472 Switch to a buffer visiting file FILENAME,
1473 creating one if none already exists.
1474 Interactively, the default if you just type RET is the current directory,
1475 but the visited file name is available through the minibuffer history:
1476 type M-n to pull it into the minibuffer.
1478 You can visit files on remote machines by specifying something
1479 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1480 also visit local files as a different user by specifying
1481 /sudo::FILE for the file name.
1482 See the Info node `(tramp)File name Syntax' in the Tramp Info
1483 manual, for more about this.
1485 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1486 expand wildcards (if any) and visit multiple files. You can
1487 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1489 To visit a file without any kind of conversion and without
1500 "Edit file FILENAME, in another window.
1503 an existing one. See the function `display-buffer'.
1505 Interactively, the default if you just type RET is the current directory,
1506 but the visited file name is available through the minibuffer history:
1507 type M-n to pull it into the minibuffer.
1509 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1510 expand wildcards (if any) and visit multiple files."
1520 value)
1524 "Edit file FILENAME, in another frame.
1527 an existing one. See the function `display-buffer'.
1529 Interactively, the default if you just type RET is the current directory,
1530 but the visited file name is available through the minibuffer history:
1531 type M-n to pull it into the minibuffer.
1533 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1534 expand wildcards (if any) and visit multiple files."
1544 value)
1548 "Edit the existing file FILENAME.
1550 file names with wildcards."
1567 value))
1570 "Edit file FILENAME but don't allow changes.
1579 "Edit file FILENAME in another window but don't allow changes.
1588 "Edit file FILENAME in another frame but don't allow changes.
1597 "Find file FILENAME as a replacement for the file in the next window.
1598 This command does not select that window.
1602 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1603 expand wildcards (if any) and replace the file with multiple files."
1614 "Find alternate file: " file-dir nil
1616 t))))
1623 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1625 "Hook run when a buffer is killed.
1626 The buffer being killed is current while the hook is running.
1627 See `kill-buffer'.
1629 Note: Be careful with let-binding this hook considering it is
1633 "Find file FILENAME, select its buffer, kill previous buffer.
1634 If the current buffer now contains an empty file that you just visited
1635 \(presumably by mistake), use this command to visit the file you really want.
1639 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1640 expand wildcards (if any) and replace the file with multiple files.
1642 If the current buffer is an indirect buffer, or the base buffer
1643 for one or more indirect buffers, the other buffer(s) are not
1644 killed."
1653 "Find alternate file: " file-dir nil
1655 t)))
1669 ;; Run `kill-buffer-hook' here. It needs to happen before
1670 ;; variables like `buffer-file-name' etc are set to nil below,
1671 ;; because some of the hooks that could be invoked
1672 ;; (e.g., `save-place-to-alist') depend on those variables.
1673 ;;
1674 ;; Note that `kill-buffer-hook' is not what queries whether to
1675 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1676 ;; asks that itself. Thus, there's no need to temporarily do
1677 ;; `(set-buffer-modified-p nil)' before running this hook.
1679 ;; Okay, now we can end-of-life the old buffer.
1686 ;; This prevents us from finding the same buffer
1687 ;; if we specified the same file again.
1691 ;; Likewise for dired buffers.
1695 ;; This executes if find-file gets an error
1696 ;; and does not really find anything.
1697 ;; We put things back as they were.
1698 ;; If find-file actually finds something, we kill obuf below.
1707 ;; We already ran these; don't run them again.
1710 \f
1711 ;; FIXME we really need to fold the uniquify stuff in here by default,
1712 ;; not using advice, and add it to the doc string.
1714 "Create a suitably named buffer for visiting FILENAME, and return it.
1715 FILENAME (sans directory) is used unchanged if that name is free;
1716 otherwise a string <2> or <3> or ... is appended to get an unused name.
1718 Emacs treats buffers whose names begin with a space as internal buffers.
1719 To avoid confusion when visiting a file whose name begins with a space,
1726 lastname))))
1729 "Create and return a buffer with a name based on NAME.
1730 Choose the buffer's name using `generate-new-buffer-name'."
1734 "Regexp to match the automounter prefix in a directory name."
1740 "Regexp matching the user's homedir at the beginning of file name.
1744 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1746 home directory is a root directory) and removes automounter prefixes
1747 \(see the variable `automount-dir-prefix')."
1748 ;; Get rid of the prefixes added by the automounter.
1755 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1756 ;; To fix this right, we need a `file-name-case-sensitive-p'
1757 ;; function, but we don't have that yet, so just guess.
1760 ;; If any elt of directory-abbrev-alist matches this name,
1761 ;; abbreviate accordingly.
1767 ;; Compute and save the abbreviated homedir name.
1768 ;; We defer computing this until the first time it's needed, to
1769 ;; give time for directory-abbrev-alist to be set properly.
1770 ;; We include a slash at the end, to avoid spurious matches
1771 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1779 ;; Depending on whether default-directory does or
1780 ;; doesn't include non-ASCII characters, the value
1781 ;; of abbreviated-home-dir could be multibyte or
1782 ;; unibyte. In the latter case, we need to decode
1783 ;; it. Note that this function is called for the
1784 ;; first time (from startup.el) when
1785 ;; locale-coding-system is already set up.
1787 abbreviated-home-dir
1790 'utf-8
1791 locale-coding-system))))))
1793 ;; If FILENAME starts with the abbreviated homedir,
1794 ;; make it start with `~' instead.
1796 ;; If the home dir is just /, don't change it.
1799 ;; MS-DOS root directories can come with a drive letter;
1800 ;; Novell Netware allows drive letters beyond `Z:'.
1808 filename)))
1811 "Return the buffer visiting file FILENAME (a string).
1812 This is like `get-file-buffer', except that it checks for any buffer
1813 visiting the same file, possibly under a different name.
1814 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1815 and others are ignored.
1816 If there is no such live buffer, return nil."
1829 found)
1839 ;; Verify this buffer's file number
1840 ;; still belongs to its file.
1843 attributes)
1847 found))))
1848 \f
1850 "Non-nil means file-visiting commands should handle wildcards.
1851 For example, if you specify `*.c', that would visit all the files
1852 whose names match the pattern."
1858 "Non-nil means suppress warning messages for symlinked files.
1859 When nil, Emacs prints a warning when visiting a file that is already
1860 visited, but with a different name. Setting this option to t
1861 suppresses this warning."
1867 "Maximum size of file above which a confirmation is requested.
1868 When nil, never request confirmation."
1875 "Warn if file size exceeds this percentage of available free memory.
1876 When nil, never issue warning. Beware: This probably doesn't do what you
1884 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1885 OP-TYPE specifies the file operation being performed (for message to user)."
1894 "Warn if an attempt to open file of SIZE bytes may run out of memory."
1904 "You are trying to open a file whose size (%s)
1905 exceeds the %S%% of currently available free memory (%s).
1906 If that fails, try to open it with `find-file-literally'
1907 \(but note that some characters might be displayed incorrectly)."
1909 out-of-memory-warning-percentage
1913 "Like `message', except sometimes don't print to minibuffer.
1914 If the variable `save-silently' is non-nil, the message is not
1915 displayed on the minibuffer."
1920 "Read file FILENAME into a buffer and return the buffer.
1921 If a buffer exists visiting FILENAME, return that one, but
1922 verify that the file has not changed since visited or saved.
1923 The buffer is not selected, just returned to the caller.
1924 Optional second arg NOWARN non-nil means suppress any warning messages.
1925 Optional third arg RAWFILE non-nil means the file is read literally.
1926 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1927 and visit all the matching files. When wildcards are actually
1928 used and expanded, return a list of buffers that are visiting
1929 the various files."
1936 'find-directory-functions
1939 filename)))
1942 find-file-wildcards
1956 ;; Find any buffer for a file which has same truename.
1958 ;; Let user know if there is a buffer with the same truename.
1962 find-file-suppress-same-file-warnings
1966 ;; Optionally also find that buffer.
1969 ;; Check to see if the file looks uncommonly large.
1974 ;; We are using an existing buffer.
1981 ;; Certain files should be reverted automatically
1982 ;; if they have changed on disk and not in the buffer.
1990 found))
2000 "File %s changed on disk. Discard your edits? "
2005 "File %s changed on disk. Discard your edits in %s? "
2013 ;; Check if a formerly read-only file has become
2014 ;; writable and vice versa, but if the buffer agrees
2015 ;; with the new state of the file, that is ok too.
2025 buffer-file-name
2026 new-status new-status)))
2032 nonexistent
2033 ;; It is confusing to ask whether to visit
2034 ;; non-literally if they have the file in
2035 ;; hexl-mode or image-mode.
2041 "The file %s is already visited normally,
2042 and you have edited the buffer. Now you have asked to visit it literally,
2043 meaning no coding system handling, format conversion, or local variables.
2044 Emacs can only visit a file in one way at a time.
2046 Do you want to save the file, and visit it literally instead? "
2047 "The file %s is already visited literally,
2048 meaning no coding system handling, format conversion, or local variables.
2049 You have edited the buffer. Now you have asked to visit the file normally,
2050 but Emacs can only visit a file in one way at a time.
2057 rawfile truename number))
2061 "\
2062 Do you want to discard your changes, and visit the file literally now? "
2063 "\
2066 rawfile truename number)
2072 "The file %s is already visited normally.
2073 You have asked to visit it literally,
2074 meaning no coding system decoding, format conversion, or local variables.
2075 But Emacs can only visit a file in one way at a time.
2077 Do you want to revisit the file literally now? "
2078 "The file %s is already visited literally,
2079 meaning no coding system decoding, format conversion, or local variables.
2080 You have asked to visit it normally,
2081 but Emacs can only visit a file in one way at a time.
2086 rawfile truename number)
2089 ;; Return the buffer we are using.
2090 buf)
2091 ;; Create a new buffer.
2093 ;; find-file-noselect-1 may use a different buffer.
2095 rawfile truename number))))))
2101 ;; Needed in case we are re-visiting the file with a different
2102 ;; text representation.
2119 filename)))
2120 ;; Unconditionally set error
2130 filename)))
2131 ;; Run find-file-not-found-functions until one returns non-nil.
2133 ;; If they fail too, set error.
2135 ;; Record the file's truename, and maybe use that as visited name.
2143 ;; Set buffer's default directory to that of the file.
2145 ;; Turn off backup files for certain file names. Since
2146 ;; this is a permanent local, the major mode won't eliminate it.
2160 \f
2162 "Like `insert-file-contents', but only reads in the file literally.
2163 See `insert-file-contents' for an explanation of the parameters.
2164 A buffer may be modified in several ways after reading into the buffer,
2165 due to Emacs features such as format decoding, character code
2166 conversion, `find-file-hook', automatic uncompression, etc.
2168 This function ensures that none of these modifications will take place."
2174 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2175 ;; into a file operation instead!
2177 inhibit-file-name-handlers))
2184 filename)))
2185 ;; Check whether the file is uncommonly large
2196 "Insert contents of file FILENAME into buffer after point with no conversion.
2198 This function is meant for the user to run interactively.
2199 Don't call it from programs! Use `insert-file-contents-literally' instead.
2200 \(Its calling sequence is different; see its documentation)."
2206 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2207 This has the `permanent-local' property, which takes effect if you
2212 "Visit file FILENAME with no conversion of any kind.
2213 Format conversion and character code conversion are both disabled,
2214 and multibyte characters are disabled in the resulting buffer.
2215 The major mode used is Fundamental mode regardless of the file name,
2216 and local variable specifications in the file are ignored.
2217 Automatic uncompression and adding a newline at the end of the
2218 file due to `require-final-newline' is also disabled.
2220 You cannot absolutely rely on this function to result in
2221 visiting the file literally. If Emacs already has a buffer
2222 which is visiting the file, you get the existing buffer,
2223 regardless of whether it was created literally or not.
2225 In a Lisp program, if you want to be sure of accessing a file's
2226 contents literally, you should create a temporary buffer and then read
2227 the file contents into it using `insert-file-contents-literally'."
2230 "Find file literally: " nil default-directory
2233 \f
2235 _after-find-file-from-revert-buffer
2236 nomodes)
2237 "Called after finding a file and by the default revert function.
2238 Sets buffer mode, parses local variables.
2239 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2240 error in reading the file. WARN non-nil means warn if there
2241 exists an auto-save file more recent than the visited file.
2242 NOAUTO means don't mess with auto-save mode.
2243 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2244 \(see `revert-buffer-in-progress-p' for similar functionality).
2245 Fifth arg NOMODES non-nil means don't alter the file's modes.
2246 Finishes by calling the functions in `find-file-hook'
2247 unless NOMODES is non-nil."
2250 nil
2260 "Symbolic link that points to nonexistent file"
2264 ;; No need to warn if buffer is auto-saved
2265 ;; under the name of the visited file.
2267 auto-save-visited-file-name))
2270 buffer-file-name))
2290 ;; Make people do a little extra work (C-x C-q)
2291 ;; before altering a backup file.
2294 ;; When a file is marked read-only,
2295 ;; make the buffer read-only even if root is looking at it.
2303 ;; If requested, add a newline at the end of the file.
2314 view-read-only
2322 "Choose the major mode for this buffer automatically.
2323 Also sets up any specified local variables of the file.
2324 Uses the visited file name, the -*- line, and the local variables spec.
2326 This function is called automatically from `find-file'. In that case,
2327 we may set up the file-specified mode and local variables,
2328 depending on the value of `enable-local-variables'.
2329 In addition, if `local-enable-local-variables' is nil, we do
2330 not set local variables (though we do notice a mode specified with -*-.)
2332 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2333 or from Lisp without specifying the optional argument FIND-FILE;
2334 in that case, this function acts as if `enable-local-variables' were t."
2338 ;; FIXME this is less efficient than it could be, since both
2339 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2344 ;; Turn font lock off and on, to make sure it takes account of
2345 ;; whatever file local variables are relevant to it.
2347 ;; Font-lock-mode (now in font-core.el) can be ON when
2348 ;; font-lock.el still hasn't been loaded.
2355 "Non-nil means to try second pass through `auto-mode-alist'.
2356 This means that if the first case-sensitive search through the alist fails
2357 to find a matching major mode, a second case-insensitive search is made.
2358 On systems with case-insensitive file names, this variable is ignored,
2359 since only a single case-insensitive search through the alist is made."
2365 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2366 ;; c++-mode, java-mode and more) are added through autoload
2367 ;; directives in that file. That way is discouraged since it
2368 ;; spreads out the definition of the initial value.
2414 ;; Less common extensions come here
2415 ;; so more common ones above are found faster.
2423 ;; Besides .gdbinit, gdb documents other names to be usable for init
2424 ;; files, cross-debuggers can use something like
2425 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2426 ;; don't interfere with each other.
2428 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2429 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2430 ;; loaded when GDB reads an objfile called 'emacs'.
2438 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2462 ;; The Fortran standard does not say anything about file extensions.
2463 ;; .f90 was widely used for F90, now we seem to be trapped into
2464 ;; using a different extension for each language revision.
2465 ;; Anyway, the following extensions are supported by gfortran.
2473 ;; The list of archive file extensions should be in sync with
2474 ;; `auto-coding-alist' with `no-conversion' coding system.
2480 ;; Mailer puts message to be edited in
2481 ;; /tmp/Re.... or Message
2484 ;; some news reader is reported to use this
2497 ;; .emacs or .gnus or .viper following a directory delimiter in
2498 ;; Unix or MS-DOS syntax.
2501 ;; _emacs following a directory delimiter in MS-DOS syntax
2505 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2506 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2507 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2510 ;; .xs is also used for ld scripts, but seems to be more commonly
2511 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2513 ;; Explained in binutils ld/genscripts.sh. Eg:
2514 ;; A .x script file is the default script.
2515 ;; A .xr script is for linking without relocation (-r flag). Etc.
2519 ;; Common Lisp ASDF package system.
2526 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2538 ;; Windows candidates may be opened case sensitively on Unix
2544 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2545 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2546 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2547 ;; this has lower priority to avoid matching changelog.sgml etc.
2549 ;; either user's dot-files or under /etc or some such
2551 ;; alas not all ~/.*rc files are like this
2552 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2557 ;; this contains everything twice, with space and with colon :-(
2559 ;; Get rid of any trailing .n.m and try again.
2560 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2561 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2562 ;; Using mode nil rather than `ignore' would let the search continue
2563 ;; through this list (with the shortened name) rather than start over.
2566 ;; This should come after "in" stripping (e.g. config.h.in).
2567 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2569 ;; The following should come after the ChangeLog pattern
2570 ;; for the sake of ChangeLog.1, etc.
2571 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2573 "Alist of filename patterns vs corresponding major mode functions.
2574 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2575 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2576 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2577 mode function to use. FUNCTION will be called, unless it is nil.
2579 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2580 calling FUNCTION (if it's not nil), we delete the suffix that matched
2581 REGEXP and search the list again for another match.
2583 The extensions whose FUNCTION is `archive-mode' should also
2584 appear in `auto-coding-alist' with `no-conversion' coding system.
2586 See also `interpreter-mode-alist', which detects executable script modes
2587 based on the interpreters they specify to run,
2592 "Select Conf mode or XML mode according to start of file."
2602 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2603 ;; and pike-mode) are added through autoload directives in that
2604 ;; file. That way is discouraged since it spreads out the
2605 ;; definition of the initial value.
2634 "Alist mapping interpreter names to major modes.
2635 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2636 Each element looks like (REGEXP . MODE).
2637 If REGEXP matches the entire name (minus any directory part) of
2638 the interpreter specified in the first line of a script, enable
2639 major mode MODE.
2646 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2647 ;; because we are duplicating info from auto-mode-alist.
2648 ;; TODO many elements of this list are also in auto-coding-alist.
2657 "List of regexps matching file names in which to ignore local variables.
2659 Files matching this list are typically binary file formats.
2660 They may happen to contain sequences that look like local variable
2661 specifications, but are not really, or they may be containers for
2662 member files with their own local variable sections, which are
2663 not appropriate for the containing file.
2670 "List of regexps matching suffixes to remove from file names.
2671 The function `inhibit-local-variables-p' uses this: when checking
2672 a file name, it first discards from the end of the name anything that
2675 ;; Can't think of any situation in which you'd want this to be nil...
2680 "Return non-nil if file local variables should be ignored.
2681 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2682 and `inhibit-local-variables-suffixes'. If
2683 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2692 sufs)
2697 temp))
2702 "Regexp matching interpreters, for file mode determination.
2703 This regular expression is matched against the first line of a file
2704 to determine the file's mode in `set-auto-mode'. If it matches, the file
2705 is assumed to be interpreted by the interpreter matched by the second group
2706 of the regular expression. The mode is then determined as the mode
2710 "Alist of buffer beginnings vs. corresponding major mode functions.
2711 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2712 After visiting a file, if REGEXP matches the text at the beginning of the
2713 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2714 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2715 major mode.
2717 If FUNCTION is nil, then it is not called. (That is a way of saying
2725 ;; The < comes before the groups (but the first) to reduce backtracking.
2726 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2727 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2731 comment-re "*"
2734 . html-mode)
2736 ;; These two must come after html, because they are more general:
2741 . sgml-mode)
2744 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2745 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2746 After visiting a file, if REGEXP matches the text at the beginning of the
2747 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2748 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2749 have not specified a mode for this file.
2755 "Upper limit on `magic-mode-alist' regexp matches.
2759 "Select major mode appropriate for current buffer.
2761 To find the right major mode, this function checks for a -*- mode tag
2762 checks for a `mode:' entry in the Local Variables section of the file,
2763 checks if it uses an interpreter listed in `interpreter-mode-alist',
2764 matches the buffer beginning against `magic-mode-alist',
2765 compares the filename against the entries in `auto-mode-alist',
2766 then matches the buffer beginning against `magic-fallback-mode-alist'.
2768 If `enable-local-variables' is nil, or if the file name matches
2769 `inhibit-local-variables-regexps', this function does not check
2770 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2771 is nil, then the only mode: tag that can be relevant is a -*- one.
2773 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2774 set the major mode only if that would change it. In other words
2775 we don't actually set it to the same mode the buffer already has."
2776 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2778 end done mode modes)
2779 ;; Once we drop the deprecated feature where mode: is also allowed to
2780 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2781 ;; remove this section and just let (hack-local-variables t) handle it.
2782 ;; Find a -*- mode tag.
2786 ;; Note by design local-enable-local-variables does not matter here.
2788 try-locals
2791 ;; Find all specifications for the `mode:' variable
2792 ;; and execute them left to right.
2804 modes)))
2805 ;; Simple -*-MODE-*- case.
2808 modes))))
2809 ;; If we found modes to use, invoke them now, outside the save-excursion.
2817 ;; continuing would call minor modes again, toggling them off
2819 ;; hack-local-variables checks local-enable-local-variables etc, but
2820 ;; we might as well be explicit here for the sake of clarity.
2822 enable-local-variables
2823 local-enable-local-variables
2824 try-locals
2831 ;; If we didn't, look for an interpreter specified in the first line.
2832 ;; As a special case, allow for things like "#!/bin/env perl", which
2833 ;; finds the interpreter anywhere in $PATH.
2839 ;; Map interpreter name to a mode, signaling we're done at the
2840 ;; same time.
2847 interpreter-mode-alist)
2849 ;; If we found an interpreter mode to use, invoke it now.
2851 ;; Next try matching the buffer beginning against magic-mode-alist.
2865 ;; Next compare the filename against the entries in auto-mode-alist.
2870 ;; Remove backup-suffixes from file name.
2872 ;; Remove remote file name identification.
2877 ;; Find first matching alist entry.
2880 ;; System is case-insensitive.
2884 ;; System is case-sensitive.
2886 ;; First match case-sensitively.
2890 ;; Fallback to case-insensitive match.
2904 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2921 ;; When `keep-mode-if-same' is set, we are working on behalf of
2922 ;; set-visited-file-name. In that case, if the major mode specified is the
2923 ;; same one we already have, don't actually reset it. We don't want to lose
2924 ;; minor modes such as Font Lock.
2926 "Apply MODE and return it.
2927 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2928 any aliases and compared to current major mode. If they are the
2929 same, do nothing and return nil."
2935 mode)))
2938 "Regexp of lines to skip when looking for file-local settings.
2939 If the first line matches this regular expression, then the -*-...-*- file-
2943 "Find the -*- spec in the buffer.
2944 Call with point at the place to start searching from.
2945 If one is found, set point to the beginning and return the position
2946 of the end. Otherwise, return nil; may change point.
2947 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2948 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2949 have no effect."
2952 ;; Don't look for -*- if this file name matches any
2953 ;; of the regexps in inhibit-local-variables-regexps.
2956 ;; If the file begins with "#!" (exec
2957 ;; interpreter magic), look for mode frobs
2958 ;; in the first two lines. You cannot
2959 ;; necessarily put them in the first line
2960 ;; of such a file without screwing up the
2961 ;; interpreter invocation. The same holds
2962 ;; for '\" in man pages (preprocessor
2963 ;; magic for the `man' program).
2974 end))))
2975 \f
2976 ;;; Handling file local variables
2980 file-local-variables-alist dir-local-variables-alist)
2985 "Normal hook run after processing a file's local variables specs.
2986 Major modes can use this to examine user-specified local variables
2990 "List variable-value pairs that are considered safe.
2991 Each element is a cons cell (VAR . VAL), where VAR is a variable
2992 symbol and VAL is a value that is considered safe."
2993 :risky t
2998 ;; This should be here at least as long as Emacs supports write-file-hooks.
3003 "Expressions that are considered safe in an `eval:' local variable.
3004 Add expressions to this list if you want Emacs to evaluate them, when
3005 they appear in an `eval' local variable specification, without first
3006 asking you for confirmation."
3007 :risky t
3012 ;; Risky local variables:
3015 buffer-auto-save-file-name
3016 buffer-file-name
3017 buffer-file-truename
3018 buffer-undo-list
3019 debugger
3020 default-text-properties
3021 eval
3022 exec-directory
3023 exec-path
3024 file-name-handler-alist
3025 frame-title-format
3026 global-mode-string
3027 header-line-format
3028 icon-title-format
3029 inhibit-quit
3030 load-path
3031 max-lisp-eval-depth
3032 max-specpdl-size
3033 minor-mode-map-alist
3034 minor-mode-overriding-map-alist
3035 mode-line-format
3036 mode-name
3037 overriding-local-map
3038 overriding-terminal-local-map
3039 process-environment
3040 standard-input
3041 standard-output
3042 unread-command-events))
3044 ;; Safe local variables:
3045 ;;
3046 ;; For variables defined by major modes, the safety declarations can go into
3047 ;; the major mode's file, since that will be loaded before file variables are
3048 ;; processed.
3049 ;;
3050 ;; For variables defined by minor modes, put the safety declarations in the
3051 ;; file defining the minor mode after the defcustom/defvar using an autoload
3052 ;; cookie, e.g.:
3053 ;;
3054 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
3055 ;;
3056 ;; Otherwise, when Emacs visits a file specifying that local variable, the
3057 ;; minor mode file may not be loaded yet.
3058 ;;
3059 ;; For variables defined in the C source code the declaration should go here:
3081 "Alist of file-local variable settings in the current buffer.
3082 Each element in this list has the form (VAR . VALUE), where VAR
3083 is a file-local variable (a symbol) and VALUE is the value
3084 specified. The actual value in the buffer may differ from VALUE,
3090 "Alist of directory-local variable settings in the current buffer.
3091 Each element in this list has the form (VAR . VALUE), where VAR
3092 is a directory-local variable (a symbol) and VALUE is the value
3093 specified in .dir-locals.el. The actual value in the buffer
3094 may differ from VALUE, if it is changed by the major or minor modes,
3099 "Normal hook run before setting file-local variables.
3100 It is called after checking for unsafe/risky variables and
3101 setting `file-local-variables-alist', and before applying the
3102 variables stored in `file-local-variables-alist'. A hook
3103 function is allowed to change the contents of this alist.
3105 This hook is called only if there is at least one file-local
3109 "Get confirmation before setting up local variable values.
3110 ALL-VARS is the list of all variables to be set up.
3111 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3112 RISKY-VARS is the list of those that are marked as risky.
3113 If these settings come from directory-local variables, then
3114 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3121 unsafe-vars))
3123 ;; Set up the contents of the *Local Variables* buffer.
3131 ", and variables that are risky (**)."
3139 y -- to apply the local variables list.
3143 ! -- to apply the local variables list, and permanently mark these
3155 ;; Make strings with embedded whitespace easier to read.
3163 ;; Display the buffer and read a choice.
3171 ""
3174 char)
3193 "Return local variables specified in the -*- line.
3194 Returns an alist of elements (VAR . VAL), where VAR is a variable
3195 and VAL is the specified value. Ignores any specification for
3196 `mode:' and `coding:' (which should have already been handled
3197 by `set-auto-mode' and `set-auto-coding', respectively).
3198 Return nil if the -*- line is malformed.
3200 If MODE-ONLY is non-nil, just returns the symbol specifying the
3201 mode, if there is one, otherwise nil."
3206 result)
3208 nil)
3210 ;; Simple form: "-*- MODENAME -*-".
3214 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3215 ;; (last ";" is optional).
3216 ;; If MODE-ONLY, just check for `mode'.
3217 ;; Otherwise, parse the -*- line into the RESULT alist.
3225 ;; There used to be a downcase here,
3226 ;; but the manual didn't say so,
3227 ;; and people want to set var names that aren't all lc.
3233 ;; It is traditional to ignore
3234 ;; case when checking for `mode' in set-auto-mode,
3235 ;; so we must do that here as well.
3236 ;; That is inconsistent, but we're stuck with it.
3237 ;; The same can be said for `coding' in set-auto-coding.
3247 ;; Downcase "Mode:".
3253 result))))))
3256 "Filter local variable settings, querying the user if necessary.
3257 VARIABLES is the alist of variable-value settings. This alist is
3258 filtered based on the values of `ignored-local-variables',
3259 `enable-local-eval', `enable-local-variables', and (if necessary)
3260 user interaction. The results are added to
3261 `file-local-variables-alist', without applying them.
3262 If these settings come from directory-local variables, then
3263 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3264 ;; Find those variables that we may want to save to
3265 ;; `safe-local-variable-values'.
3271 ;; Ignore any variable in `ignored-local-variables'.
3272 nil)
3273 ;; Obey `enable-local-eval'.
3277 ;; In case previously marked safe (bug#5636).
3279 ;; If not safe and e-l-v = :safe, ignore totally.
3283 safe
3285 ;; Ignore duplicates (except `mode') in the present list.
3287 ;; Accept known-safe variables.
3291 ;; The variable is either risky or unsafe:
3298 ;; Query, unless all vars are safe or user wants no querying.
3304 risky-vars dir-name))
3314 ;; TODO? Warn once per file rather than once per session?
3318 "Parse and put into effect this buffer's local variables spec.
3319 Uses `hack-local-variables-apply' to apply the variables.
3322 is specified, and return the corresponding mode symbol, or nil.
3323 In this case, we try to ignore minor-modes, and only return a
3324 major-mode.
3326 If `enable-local-variables' or `local-enable-local-variables' is nil,
3327 this function does nothing. If `inhibit-local-variables-regexps'
3328 applies to the file in question, the file is not scanned for
3329 local variables, but directory-local variables may still be applied."
3330 ;; We don't let inhibit-local-variables-p influence the value of
3331 ;; enable-local-variables, because then it would affect dir-local
3332 ;; variables. We don't want to search eg tar files for file local
3333 ;; variable sections, but there is no reason dir-locals cannot apply
3334 ;; to them. The real meaning of inhibit-local-variables-p is "do
3335 ;; not scan this file for local variables".
3338 result)
3342 ;; Note this is a no-op if enable-local-variables is nil.
3344 ;; This entire function is basically a no-op if enable-local-variables
3345 ;; is nil. All it does is set file-local-variables-alist to nil.
3347 ;; This part used to ignore enable-local-variables when mode-only
3348 ;; was non-nil. That was inappropriate, eg consider the
3349 ;; (artificial) example of:
3350 ;; (setq local-enable-local-variables nil)
3351 ;; Open a file foo.txt that contains "mode: sh".
3352 ;; It correctly opens in text-mode.
3353 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3355 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3356 ;; mode, then we're done, and have no need to scan further.
3358 mode-only))
3359 ;; Look for "Local variables:" line in last page.
3367 ;; suffix is what comes after "local variables:" in its line.
3368 ;; prefix is what comes before "local variables:" in its line.
3381 endpos
3387 nil t))
3388 ;; This used to be an error, but really all it means is
3389 ;; that this may simply not be a local-variables section,
3390 ;; so just ignore it.
3400 ;; Discard the prefix.
3405 ;; Discard the suffix.
3414 ;; Find the variable name;
3422 val val2)
3425 ;; Read the variable value.
3432 ;; Specifying minor-modes via mode: is
3433 ;; deprecated, but try to reject them anyway.
3443 'files
3445 "%s: `lexical-binding' at end of file unreliable"
3447 ;; We are called from
3448 ;; 'with-temp-buffer', so we need
3449 ;; to use 'thisbuf's name in the
3450 ;; warning message.
3455 'eval
3459 ;; Now we've read all the local variables.
3460 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3462 ;; Otherwise, set the variables.
3467 "Apply the elements of `file-local-variables-alist'.
3468 If there are any elements, runs `before-hack-local-variables-hook',
3469 then calls `hack-one-local-variable' to apply the alist elements one by one.
3470 Finishes by running `hack-local-variables-hook', regardless of whether
3471 the alist is empty or not.
3473 Note that this function ignores a `mode' entry if it specifies the same
3474 major mode as the buffer already has."
3476 ;; Any 'evals must run in the Right sequence.
3485 "Non-nil if SYM is safe as a file-local variable with value VAL.
3486 It is safe if any of these conditions are met:
3488 * There is a matching entry (SYM . VAL) in the
3489 `safe-local-variable-values' user option.
3491 * The `safe-local-variable' property of SYM is a function that
3492 evaluates to a non-nil value with VAL as an argument."
3496 ;; If the function signals an error, that means it
3497 ;; can't assure us that the value is safe.
3501 "Non-nil if SYM could be dangerous as a file-local variable.
3502 It is dangerous if either of these conditions are met:
3504 * Its `risky-local-variable' property is non-nil.
3510 ;; If this is an alias, check the base name.
3530 "Return t if it is safe to eval EXP when it is found in a file."
3532 ;; Detect certain `put' expressions.
3539 lisp-indent-function
3540 scheme-indent-function))
3541 ;; Only allow safe values (not functions).
3546 ;; Only allow indirect form specs.
3547 ;; During bootstrapping, edebug-basic-spec might not be
3548 ;; defined yet.
3552 ;; Allow expressions that the user requested.
3554 ;; Certain functions can be allowed with safe arguments
3555 ;; or can specify verification functions to try.
3557 ;; Allow (minor)-modes calls with no arguments.
3558 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3567 ok))
3575 ok))))))))
3589 "Set local variable VAR with value VAL.
3590 If VAR is `mode', call `VAL-mode' as a function unless it's
3591 already the major mode."
3593 (`mode
3599 (`eval
3605 ;; Make sure the string has no text properties.
3606 ;; Some text properties can get evaluated in various ways,
3607 ;; so it is risky to put them on with a local variable list.
3611 \f
3612 ;;; Handling directory-local variables, aka project settings.
3618 "List of cached directory roots for directory-local variable classes.
3619 Each element in this list has the form (DIR CLASS MTIME).
3620 DIR is the name of the directory.
3621 CLASS is the name of a variable class (a symbol).
3622 MTIME is the recorded modification time of the directory-local
3623 variables file associated with this entry. This time is a list
3624 of integers (the same format as `file-attributes'), and is
3625 used to test whether the cache entry is still valid.
3626 Alternatively, MTIME can be nil, which means the entry is always
3630 "Return the variable list for CLASS."
3634 "Collect directory-local variables from MODE-VARIABLES.
3635 VARIABLES is the initial list of variables.
3636 Returns the new list."
3641 ;; If variables are specified more than once, only use the last. (Why?)
3642 ;; The pseudo-variables mode and eval are different (bug#3430).
3645 ;; Need a new cons in case we setcdr later.
3649 "Collect entries from CLASS-VARIABLES into VARIABLES.
3650 ROOT is the root directory of the project.
3651 Return the new variables list."
3653 ;; Handle non-file buffers, too.
3656 ;; FIXME: Why not use file-relative-name?
3663 ;; Don't include this in the previous condition, because we
3664 ;; want to filter all strings before the next condition.
3678 ;; TODO someone might want to extend this to allow
3679 ;; integer values for subdir, where N means
3680 ;; variables apply to this directory and N levels
3681 ;; below it (0 == nil).
3684 alist variables))))))))
3686 ;; The file's content might be invalid (e.g. have a merge conflict), but
3687 ;; that shouldn't prevent the user from opening the file.
3689 nil))))
3692 "Declare that the DIRECTORY root is an instance of CLASS.
3693 DIRECTORY is the name of a directory, a string.
3694 CLASS is the name of a project class, a symbol.
3695 MTIME is either the modification time of the directory-local
3696 variables file that defined this class, or nil.
3698 When a file beneath DIRECTORY is visited, the mode-specific
3699 variables from CLASS are applied to the buffer. The variables
3700 for a class are defined using `dir-locals-set-class-variables'."
3707 "Map the type CLASS to a list of variable settings.
3708 CLASS is the project class, a symbol. VARIABLES is a list
3709 that declares directory-local variables for the class.
3710 An element in VARIABLES is either of the form:
3711 (MAJOR-MODE . ALIST)
3712 or
3713 (DIRECTORY . LIST)
3715 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3716 whose elements are of the form (VARIABLE . VALUE).
3718 In the second form, DIRECTORY is a directory name (a string), and
3719 LIST is a list of the form accepted by the function.
3721 When a file is visited, the file's class is found. A directory
3722 may be assigned a class using `dir-locals-set-directory-class'.
3723 Then variables are set in the file's buffer according to the
3724 VARIABLES list of the class. The list is processed in order.
3726 * If the element is of the form (MAJOR-MODE . ALIST), and the
3727 buffer's major mode is derived from MAJOR-MODE (as determined
3728 by `derived-mode-p'), then all the variables in ALIST are
3729 applied. A MAJOR-MODE of nil may be used to match any buffer.
3730 `make-local-variable' is called for each variable before it is
3731 set.
3733 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3734 is an initial substring of the file's directory, then LIST is
3735 applied by recursively following these rules."
3739 "File that contains directory-local variables.
3740 It has to be constant to enforce uniform values
3744 "Find the directory-local variables for FILE.
3745 This searches upward in the directory tree from FILE.
3746 It stops at the first directory that has been registered in
3747 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3748 If it finds an entry in the cache, it checks that it is valid.
3749 A cache entry with no modification time element (normally, one that
3750 has been assigned directly using `dir-locals-set-directory-class', not
3751 set from a file) is always valid.
3752 A cache entry based on a `dir-locals-file' is valid if the modification
3753 time stored in the cache matches the current file modification time.
3754 If not, the cache entry is cleared so that the file will be re-read.
3756 This function returns either nil (no directory local variables found),
3757 or the matching entry from `dir-locals-directory-cache' (a list),
3758 or the full path to the `dir-locals-file' (a string) in the case
3759 of no valid cache entry."
3764 dir-locals-file))
3767 ;; `locate-dominating-file' may have abbreviated the name.
3770 ;; Let dir-locals-read-from-file inform us via demoted-errors
3771 ;; about unreadable files, etc.
3772 ;; Maybe we'd want to keep searching though - that is
3773 ;; a locate-dominating-file issue.
3774 ;;; (or (not (file-readable-p locals-file))
3775 ;;; (not (file-regular-p locals-file)))
3776 ;;; (setq locals-file nil))
3777 ;; Find the best cached value in `dir-locals-directory-cache'.
3788 ;; Found a potential cache entry. Check validity.
3789 ;; A cache entry with no MTIME is assumed to always be valid
3790 ;; (ie, set directly, not from a dir-locals file).
3791 ;; Note, we don't bother to check that there is a matching class
3792 ;; element in dir-locals-class-alist, since that's done by
3793 ;; dir-locals-set-directory-class.
3800 ;; This cache entry is OK.
3801 dir-elt
3802 ;; This cache entry is invalid; clear it.
3805 ;; Return the first existing dir-locals file. Might be the same
3806 ;; as dir-elt's, might not (eg latter might have been deleted).
3807 locals-file)
3808 ;; No cache entry.
3809 locals-file)))
3812 "Load a variables FILE and register a new class and instance.
3813 FILE is the name of the file holding the variables to apply.
3814 The new class name is the same as the directory in which FILE
3815 is found. Returns the new class name."
3827 class-name)))))
3830 "Non-nil means dir-local variables will be applied to remote files."
3838 "Read per-directory local variables for the current buffer.
3839 Store the directory-local variables in `dir-local-variables-alist'
3840 and `file-local-variables-alist', without applying them.
3842 This does nothing if either `enable-local-variables' or
3843 `enable-dir-local-variables' are nil."
3845 enable-dir-local-variables
3848 default-directory)))))
3849 ;; Find the variables file.
3879 "Apply directory-local variables to a non-file buffer.
3880 For non-file buffers, such as Dired buffers, directory-local
3881 variables are looked for in `default-directory' and its parent
3882 directories."
3886 \f
3889 However, the mode will not be changed if
3890 \(1) a local variables list or the `-*-' line specifies a major mode, or
3892 not suitable for ordinary files, or
3893 \(3) the new file name does not particularly specify any mode."
3898 "Change name of file visited in current buffer to FILENAME.
3899 This also renames the buffer to correspond to the new file.
3900 The next time the buffer is saved it will go in the newly specified file.
3901 FILENAME nil or an empty string means mark buffer as not visiting any file.
3902 Remember to delete the initial contents of the minibuffer
3903 if you wish to pass an empty string as the argument.
3905 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3906 confirmation in the case where another buffer is already visiting FILENAME.
3908 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3909 the old visited file has been renamed to the new name FILENAME."
3917 nil
3932 filename)))
3939 buffer-file-name filename)
3943 ;; If new-name == old-name, renaming would add a spurious <2>
3944 ;; and it's considered as a feature in rename-buffer.
3950 ;; Abbreviate the file names of the buffer.
3959 nil))
3960 ;; write-file-functions is normally used for things like ftp-find-file
3961 ;; that visit things that are not local files as if they were files.
3962 ;; Changing to visit an ordinary local file instead should flush the hook.
3967 ;; If buffer was read-only because of version control,
3968 ;; that reason is gone now, so make it writable.
3972 ;; Turn off backup files for certain file names.
3973 ;; Since this is a permanent local, the major mode won't eliminate it.
3975 backup-enable-predicate
3984 ;; If auto-save was not already on, turn it on if appropriate.
3987 ;; If auto save is on, start using a new name. We
3988 ;; deliberately don't rename or delete the old auto save
3989 ;; for the old visited file name. This is because
3990 ;; perhaps the user wants to save the new state and then
3991 ;; compare with the previous state from the auto save
3992 ;; file.
3994 ;; Rename the old auto save file if any.
4001 ;; Update the major mode, if the file name determines it.
4003 ;; Don't change the mode if it is special.
4006 ;; Don't change the mode if the local variable list specifies it.
4007 ;; The file name can influence whether the local variables apply.
4009 ;; h-l-v also checks it, but might as well be explicit.
4012 ;; TODO consider making normal-mode handle this case.
4020 "Write current buffer into file FILENAME.
4021 This makes the buffer visit that file, and marks it as not modified.
4023 If you specify just a directory name as FILENAME, that means to use
4024 the default file name but in that directory. You can also yank
4025 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
4027 If the buffer is not already visiting a file, the default file name
4028 for the output file is the buffer name.
4030 If optional second arg CONFIRM is non-nil, this function
4031 asks for confirmation before overwriting an existing file.
4032 Interactively, confirmation is required unless you supply a prefix argument."
4033 ;; (interactive "FWrite file: ")
4037 nil nil nil nil)
4041 default-directory)
4042 nil nil))
4046 ;; If arg is just a directory,
4047 ;; use the default file name, but in that directory.
4054 ;; NS does its own confirm dialog.
4057 use-dialog-box))
4063 ;; Make buffer writable if file is writable.
4068 ;; It's likely that the VC status at the new location is different from
4069 ;; the one at the old location.
4071 \f
4073 "Return an alist of extended attributes of file FILENAME.
4075 Extended attributes are platform-specific metadata about the file,
4076 such as SELinux context, list of ACL entries, etc."
4081 "Set extended attributes of file FILENAME to ATTRIBUTES.
4083 ATTRIBUTES must be an alist of file attributes as returned by
4084 `file-extended-attributes'.
4085 Value is t if the function succeeds in setting the attributes."
4096 result))
4097 \f
4099 "Make a backup of the disk file visited by the current buffer, if appropriate.
4100 This is normally done before saving the buffer the first time.
4102 A backup may be done by renaming or by copying; see documentation of
4103 variable `make-backup-files'. If it's done by renaming, then the file is
4104 no longer accessible under its old name.
4106 The value is non-nil after a backup was made by renaming.
4107 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
4108 MODES is the result of `file-modes' on the original
4109 file; this means that the caller, after saving the buffer, should change
4110 the modes of the new file to agree with the old modes.
4111 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
4112 on the original file; this means that the caller, after saving
4113 the buffer, should change the extended attributes of the new file
4114 to agree with the old attributes.
4115 BACKUPNAME is the backup file name, which is the old file renamed."
4119 ;; If specified name is a symbolic link, chase it to the target.
4120 ;; This makes backups in the directory where the real file is.
4127 ;; If have old versions to maybe delete,
4128 ;; ask the user to confirm now, before doing anything.
4129 ;; But don't actually delete til later.
4135 real-file-name)))
4136 targets))
4141 backup-by-copying-when-privileged-mismatch)
4144 ;; Don't rename a suid or sgid file.
4153 real-file-name
4156 copy-when-priv-mismatch))))
4158 t)))))
4159 setmodes)
4162 ;; Actually make the backup file.
4165 modes extended-attributes)
4166 ;; rename-file should delete old backup.
4169 backupname)))
4171 ;; Now delete the old versions, if desired.
4175 ;; If trouble writing the backup, write it in .emacs.d/%backup%.
4179 backupname)
4182 modes extended-attributes)
4184 setmodes)))))))
4187 ;; Create temp files with strict access rights. It's easy to
4188 ;; loosen them later, whereas it's impossible to close the
4189 ;; time-window of loose permissions otherwise.
4192 ;; Try to overwrite old backup first.
4200 nil)
4202 ;; The file was somehow created by someone else between
4203 ;; `delete-file' and `copy-file', so let's try again.
4204 ;; rms says "I think there is also a possible race
4205 ;; condition for making backup files" (emacs-devel 20070821).
4206 nil)))
4207 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4216 ;; The last ~[[:digit]]+ matches relative versions in git,
4217 ;; e.g. `foo.js.~HEAD~1~'.
4218 "Regular expression matching the backup/version part of a file name.
4222 "Return file NAME sans backup versions or strings.
4223 This is a separate procedure so your site-init or startup file can
4224 redefine it.
4225 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4226 we do not remove backup version numbers, only true file version numbers.
4227 See also `file-name-version-regexp'."
4234 name))))))
4237 "Return t if deleting FILE and rewriting it would preserve the owner.
4238 Return nil if FILE does not exist, or if deleting and recreating it
4239 might not preserve the owner. If GROUP is non-nil, check whether
4240 the group would be preserved too."
4245 ;; Return t if the file doesn't exist, since it's true that no
4246 ;; information would be lost by an (attempted) delete and create.
4249 ;; Files created on Windows by Administrator (RID=500)
4250 ;; have the Administrators group (RID=544) recorded as
4251 ;; their owner. Rewriting them will still preserve the
4252 ;; owner.
4256 ;; On BSD-derived systems files always inherit the parent
4257 ;; directory's group, so skip the group-gid test.
4263 ;; On some systems, a file created in a setuid directory
4264 ;; inherits that directory's owner.
4268 ;; On many systems, a file created in a setgid directory
4269 ;; inherits that directory's group. On some systems
4270 ;; this happens even if the setgid bit is not set.
4277 The extension, in a file name, is the part that begins with the last `.',
4278 except that a leading `.' of the file name, if there is one, doesn't count."
4281 directory)
4285 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4286 ;; we don't want to expand it.
4289 filename))))
4293 The extension, in a file name, is the part that begins with the last `.',
4294 excluding version numbers and backup suffixes, except that a leading `.'
4295 of the file name, if there is one, doesn't count.
4296 Return nil for extensionless file names such as `foo'.
4297 Return the empty string for file names such as `foo.'.
4299 By default, the returned value excludes the period that starts the
4300 extension, but if the optional argument PERIOD is non-nil, the period
4301 is included in the value, and in that case, if FILENAME has no
4312 "Return the base name of the FILENAME: no directory, no extension.
4313 FILENAME defaults to `buffer-file-name'."
4318 #'make-backup-file-name--default-function
4319 "A function that `make-backup-file-name' uses to create backup file names.
4320 The function receives a single argument, the original file name.
4322 If you change this, you may need to change `backup-file-name-p' and
4323 `file-name-sans-versions' too.
4325 You could make this buffer-local to do something special for specific files.
4327 For historical reasons, a value of nil means to use the default function.
4328 This should not be relied upon.
4330 See also `backup-directory-alist'."
4337 "Alist of filename patterns and backup directory names.
4338 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4339 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4340 relative or absolute. If it is absolute, so that all matching files
4341 are backed up into the same directory, the file names in this
4342 directory will be the full name of the file backed up with all
4343 directory separators changed to `!' to prevent clashes. This will not
4344 work correctly if your filesystem truncates the resulting name.
4346 For the common case of all backups going into one directory, the alist
4348 directory name.
4350 If this variable is nil, or it fails to match a filename, the backup
4351 is made in the original file's directory.
4353 On MS-DOS filesystems without long names this variable is always
4354 ignored."
4360 "Default `backup-enable-predicate' function.
4361 Checks for files in `temporary-file-directory',
4362 `small-temporary-file-directory', and /tmp."
4364 caseless)
4365 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4366 ;; their long file-name equivalents, so compare-strings does TRT.
4370 caseless t))
4373 ;; Directory is under temporary-file-directory.
4378 ;; Directory is under /tmp.
4383 0 nil
4385 ;; Directory is under small-temporary-file-directory.
4390 "Create the non-numeric backup file name for FILE.
4391 This calls the function that `make-backup-file-name-function' specifies,
4392 with a single argument FILE."
4395 file))
4398 "Default function for `make-backup-file-name'.
4399 Normally this just returns FILE's name with `~' appended.
4400 It searches for a match for FILE in `backup-directory-alist'.
4401 If the directory for the backup doesn't exist, it is created."
4413 "Subroutine of `make-backup-file-name--default-function'.
4414 The function `find-backup-file-name' also uses this."
4416 elt backup-directory abs-backup-directory)
4421 alist nil)))
4422 ;; If backup-directory is relative, it should be relative to the
4423 ;; file's directory. By expanding explicitly here, we avoid
4424 ;; depending on default-directory.
4433 abs-backup-directory nil))))
4435 file
4439 ;; Normalize DOSish file names: downcase the drive
4440 ;; letter, if any, and replace the leading "x:" with
4441 ;; "/drive_x".
4444 ;; Replace any invalid file-name characters (for the
4445 ;; case of backing up remote files).
4449 "drive_"
4452 ""
4455 ;; Make the name unique by substituting directory
4456 ;; separators. It may not really be worth bothering about
4457 ;; doubling `!'s in the original name...
4462 backup-directory))
4467 "Return non-nil if FILE is a backup file name (numeric or not).
4468 This is a separate function so you can redefine it for customization.
4469 You may need to redefine `file-name-sans-versions' as well."
4474 ;; This is used in various files.
4475 ;; The usage of backup-extract-version-start is not very clean,
4476 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4478 "Given the name of a numeric backup file, FN, return the backup number.
4479 Uses the free variable `backup-extract-version-start', whose value should be
4480 the index in the name where the version number begins."
4487 "Find a file name for a backup file FN, and suggestions for deletions.
4488 Value is a list whose car is the name for the backup file
4489 and whose cdr is a list of old versions to consider deleting now.
4490 If the value is nil, don't make a backup.
4491 Uses `backup-directory-alist' in the same way as
4492 `make-backup-file-name--default-function' does."
4494 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4498 ;; We don't support numbered backups on plain MS-DOS
4499 ;; when long file names are unavailable.
4509 possibilities deserve-versions-p versions)
4512 base-versions
4515 possibilities)
4516 #'<)
4521 kept-old-versions
4522 kept-new-versions
4529 ;; Delete nothing if there is overflow
4530 ;; in the number of versions to keep.
4536 v))))))))))
4539 "Return number of names file FILENAME has."
4542 ;; (defun file-relative-name (filename &optional directory)
4543 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4544 ;; This function returns a relative file name which is equivalent to FILENAME
4545 ;; when used with that default directory as the default.
4546 ;; If this is impossible (which can happen on MSDOS and Windows
4547 ;; when the file name and directory use different drive names)
4548 ;; then it returns FILENAME."
4549 ;; (save-match-data
4550 ;; (let ((fname (expand-file-name filename)))
4551 ;; (setq directory (file-name-as-directory
4552 ;; (expand-file-name (or directory default-directory))))
4553 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4554 ;; ;; drive names, they can't be relative, so return the absolute name.
4555 ;; (if (and (or (eq system-type 'ms-dos)
4556 ;; (eq system-type 'cygwin)
4557 ;; (eq system-type 'windows-nt))
4558 ;; (not (string-equal (substring fname 0 2)
4559 ;; (substring directory 0 2))))
4560 ;; filename
4561 ;; (let ((ancestor ".")
4562 ;; (fname-dir (file-name-as-directory fname)))
4563 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4564 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4565 ;; (setq directory (file-name-directory (substring directory 0 -1))
4566 ;; ancestor (if (equal ancestor ".")
4567 ;; ".."
4568 ;; (concat "../" ancestor))))
4569 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4570 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4571 ;; ;; We matched within FNAME's directory part.
4572 ;; ;; Add the rest of FNAME onto ANCESTOR.
4573 ;; (let ((rest (substring fname (match-end 0))))
4574 ;; (if (and (equal ancestor ".")
4575 ;; (not (equal rest "")))
4576 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4577 ;; rest
4578 ;; (concat (file-name-as-directory ancestor) rest)))
4579 ;; ;; We matched FNAME's directory equivalent.
4580 ;; ancestor))))))
4583 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4584 This function returns a relative file name which is equivalent to FILENAME
4585 when used with that default directory as the default.
4586 If FILENAME is a relative file name, it will be interpreted as existing in
4587 `default-directory'.
4588 If FILENAME and DIRECTORY lie on different machines or on different drives
4589 on a DOS/Windows machine, it returns FILENAME in expanded form."
4593 default-directory))))
4598 read-file-name-completion-ignore-case)))
4601 ;; Test for different filesystems on DOS/Windows
4603 ;; Should `cygwin' really be included here? --stef
4606 ;; Test for different drive letters
4608 ;; Test for UNCs on different servers
4613 ;; Windows file names cannot have ? in
4614 ;; them, so use that to detect when
4615 ;; neither FILENAME nor DIRECTORY is a
4616 ;; UNC.
4618 0 nil
4624 ;; Test for different remote file system identification
4626 filename
4634 ".."
4636 ;; Now ancestor is empty, or .., or ../.., etc.
4638 ;; We matched within FILENAME's directory part.
4639 ;; Add the rest of FILENAME onto ANCESTOR.
4642 ;; But don't bother with ANCESTOR if it would give us `./'.
4643 rest
4645 ;; We matched FILENAME's directory equivalent.
4646 ancestor))))))
4647 \f
4649 "Save current buffer in visited file if modified.
4650 Variations are described below.
4652 By default, makes the previous version into a backup file
4653 if previously requested or if this is the first save.
4655 to become a backup when the next save is done.
4657 makes the previous version into a backup file.
4659 to become a backup when the next save is done,
4660 and makes the previous version into a backup file.
4662 With a numeric prefix argument of 0, never make the previous version
4663 into a backup file.
4665 Note that the various variables that control backups, such
4666 as `version-control', `backup-enable-predicate', `vc-make-backup-files',
4667 and `backup-inhibited', to name just the more popular ones, still
4668 control whether a backup will actually be produced, even when you
4671 If a file's name is FOO, the names of its numbered backup versions are
4672 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4673 Numeric backups (rather than FOO~) will be made if value of
4674 `version-control' is not the atom `never' and either there are already
4675 numeric versions of the file being backed up, or `version-control' is
4676 non-nil.
4677 We don't want excessive versions piling up, so there are variables
4678 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4679 and `kept-new-versions', which tells how many newest versions to keep.
4680 Defaults are 2 old versions and 2 new.
4681 `dired-kept-versions' controls dired's clean-directory (.) command.
4682 If `delete-old-versions' is nil, system will query user
4683 before trimming versions. Otherwise it does it silently.
4685 If `vc-make-backup-files' is nil, which is the default,
4686 no backup files are made for files managed by version control.
4687 (This is because the version control system itself records previous versions.)
4689 See the subroutine `basic-save-buffer' for more information."
4695 ;; We used to display the message below only for files > 50KB, but
4696 ;; then Rmail-mbox never displays it due to buffer swapping. If
4697 ;; the test is ever re-introduced, be sure to handle saving of
4698 ;; Rmail files.
4708 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4709 Normally delete only if the file was written by this Emacs since
4710 the last real save, but optional arg FORCE non-nil means delete anyway."
4724 "Normal hook that is run before a buffer is saved to its file."
4730 "Normal hook that is run after a buffer is saved to its file."
4736 "If non-nil, use this coding system for saving the buffer.
4737 More precisely, use this coding system in place of the
4738 value of `buffer-file-coding-system', when saving the buffer.
4739 Calling `write-region' for any purpose other than saving the buffer
4740 will still use `buffer-file-coding-system'; this variable has no effect
4747 "Save the current buffer in its visited file, if it has been modified.
4748 The hooks `write-contents-functions' and `write-file-functions' get a chance
4749 to do the job of saving; if they do not, then the buffer is saved in
4750 the visited file in the usual way.
4751 Before and after saving the buffer, this function runs
4752 `before-save-hook' and `after-save-hook', respectively."
4755 ;; In an indirect buffer, save its base buffer instead.
4759 ;; handle the case when no modification has been made but
4760 ;; the file disappeared since visited
4764 setmodes)
4765 ;; If buffer has no file name, ask user for one.
4773 ;; Signal an error if the user specified the name of an
4774 ;; existing directory.
4777 "File `%s' exists; overwrite? "
4778 filename))
4785 "%s has changed since visited or saved. Save anyway? "
4805 ;; Support VC version backups.
4807 ;; Don't let errors prevent saving the buffer.
4812 ;; If a hook returned t, file is already "written".
4813 ;; Otherwise, write it the usual way now.
4823 ;; Now we have saved the current buffer. Let's make sure
4824 ;; that buffer-file-coding-system is fixed to what
4825 ;; actually used for saving by binding it locally.
4840 ;; If the auto-save file was recent before this command,
4841 ;; delete it now.
4843 ;; Support VC `implicit' locking.
4850 ;; This does the "real job" of writing a buffer into its visited file
4851 ;; and making a backup file. This is what is normally done
4852 ;; but inhibited if one of write-file-functions returns non-nil.
4853 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4854 ;; backup-buffer.
4864 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4865 ;; backup-buffer.
4878 "File %s is write-protected; try to save anyway? "
4880 buffer-file-name)))
4894 dir))))
4895 ;; Write temp name, then rename it.
4896 ;; This requires write access to the containing dir,
4897 ;; which is why we don't try it if we don't have that access.
4899 tempname succeed
4902 ;; Create temp files with strict access rights. It's easy to
4903 ;; loosen them later, whereas it's impossible to close the
4904 ;; time-window of loose permissions otherwise.
4909 ;; Try various temporary names.
4910 ;; This code follows the example of make-temp-file,
4911 ;; but it calls write-region in the appropriate way
4912 ;; for saving the buffer.
4918 ;; Pass in nil&nil rather than point-min&max
4919 ;; cause we're saving the whole buffer.
4920 ;; write-region-annotate-functions may use it.
4922 tempname nil realname
4925 nil)
4927 ;; The file was somehow created by someone else between
4928 ;; `make-temp-name' and `write-region', let's try again.
4929 nil)
4931 ;; Reset the umask.
4933 ;; If we failed, restore the buffer's modtime.
4936 ;; Since we have created an entirely new file,
4937 ;; make sure it gets the right permission bits set.
4942 buffer-file-name)))
4943 ;; We succeeded in writing the temp file,
4944 ;; so rename it.
4946 ;; If file not writable, see if we can make it writable
4947 ;; temporarily while we write it.
4948 ;; But no need to do so if we have just backed it up
4949 ;; (setmodes is set) because that says we're superseding.
4951 ;; Change the mode back, after writing.
4954 buffer-file-name))
4955 ;; If set-file-extended-attributes fails, fall back on
4956 ;; set-file-modes.
4966 ;; Pass in nil&nil rather than point-min&max to indicate
4967 ;; we're saving the buffer rather than just a region.
4968 ;; write-region-annotate-functions may make us of it.
4970 buffer-file-name nil t buffer-file-truename)
4973 ;; If we get an error writing the new file, and we made
4974 ;; the backup by renaming, undo the backing-up.
4979 setmodes))
4985 `((?\C-r
4992 ;; Return nil to ask about BUF again.
4993 nil)
5006 ;; Return nil to ask about BUF again.
5007 nil)
5017 "Save some modified file-visiting buffers. Asks user about each one.
5018 You can answer `y' to save, `n' not to save, `C-r' to look at the
5019 buffer in question with `view-buffer' before deciding or `d' to
5020 view the differences using `diff-buffer-with-file'.
5022 This command first saves any buffers where `buffer-save-without-query' is
5023 non-nil, without asking.
5025 Optional argument (the prefix) non-nil means save all with no questions.
5026 Optional second argument PRED determines which buffers are considered:
5027 If PRED is nil, all the file-visiting buffers are considered.
5028 If PRED is t, then certain non-file buffers will also be considered.
5029 If PRED is a zero-argument function, it indicates for each buffer whether
5030 to consider it or not when called with that buffer current.
5032 See `save-some-buffers-action-alist' if you want to
5033 change the additional actions you can take on files."
5037 files-done abbrevs-done)
5039 ;; First save any buffers that we're supposed to save unconditionally.
5040 ;; That way the following code won't ask about them.
5045 ;; Ask about those buffers that merit it,
5046 ;; and record the number thus saved.
5050 ;; Note that killing some buffers may kill others via
5051 ;; hooks (e.g. Rmail and its viewing buffer).
5064 t
5076 save-some-buffers-action-alist))
5077 ;; Maybe to save abbrevs, and record whether
5078 ;; we either saved them or asked to.
5085 ;; Don't keep bothering user if he says no.
5099 \f
5101 "Clear out records of last mod time of visited file.
5102 Next attempt to save will not complain of a discrepancy."
5106 "Mark current buffer as unmodified, not needing to be saved.
5109 It is not a good idea to use this function in Lisp programs, because it
5110 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5118 "Change whether this buffer is read-only."
5126 "Insert contents of file FILENAME into buffer after point.
5127 Set mark after the inserted text.
5129 This function is meant for the user to run interactively.
5130 Don't call it from programs! Use `insert-file-contents' instead.
5131 \(Its calling sequence is different; see its documentation)."
5137 "Append the contents of the region to the end of file FILENAME.
5138 When called from a function, expects three arguments,
5139 START, END and FILENAME. START and END are normally buffer positions
5140 specifying the part of the buffer to write.
5141 If START is nil, that means to use the entire buffer contents.
5142 If START is a string, then output that string to the file
5143 instead of any buffer contents; END is ignored.
5145 This does character code conversion and applies annotations
5146 like `write-region' does."
5152 "Return most recent backup file for FILENAME or nil if no backups exist."
5153 ;; `make-backup-file-name' will get us the right directory for
5154 ;; ordinary or numeric backups. It might create a directory for
5155 ;; backups as a side-effect, according to `backup-directory-alist'.
5162 tem)
5171 newest))
5174 "Rename current buffer to a similar name not already taken.
5175 This function is useful for creating multiple shell process buffers
5176 or multiple mail buffers, etc.
5178 Note that some commands, in particular those based on `compilation-mode'
5179 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5180 appropriate mode even if it has been renamed. So as well as renaming
5181 the buffer, you also need to switch buffers before running another
5182 instance of such commands."
5190 ;; If the existing buffer name has a <NNN>,
5191 ;; which isn't part of the file name (if any),
5192 ;; then get rid of that.
5198 "Create the directory DIR and optionally any nonexistent parent dirs.
5199 If DIR already exists as a directory, signal an error, unless
5200 PARENTS is non-nil.
5202 Interactively, the default choice of directory to create is the
5203 current buffer's default directory. That is useful when you have
5204 visited a file in a nonexistent directory.
5206 Noninteractively, the second (optional) argument PARENTS, if
5207 non-nil, says whether to create parent directories that don't
5208 exist. Interactively, this happens by default.
5210 If creating the directory or directories fail, an error will be
5211 raised."
5214 nil nil)
5215 t))
5216 ;; If default-directory is a remote directory,
5217 ;; make sure we find its make-directory handler.
5225 create-list)
5227 ;; If directory is its own parent, then we can't
5228 ;; keep looping forever
5243 "Delete the directory named DIRECTORY. Does not follow symlinks.
5244 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5245 TRASH non-nil means to trash the directory instead, provided
5246 `delete-by-moving-to-trash' is non-nil.
5248 When called interactively, TRASH is t if no prefix argument is
5249 given. With a prefix argument, TRASH is nil."
5256 "Move directory to trash: "
5258 default-directory default-directory nil nil))))
5264 nil)
5266 ;; If default-directory is a remote directory, make sure we find its
5267 ;; delete-directory handler.
5274 ;; Only move non-empty dir to trash if recursive deletion was
5275 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5276 ;; case, where the operation fails in delete-directory-internal.
5277 ;; As `move-file-to-trash' trashes directories (empty or
5278 ;; otherwise) as a unit, we do not need to recurse here.
5280 ;; Check if directory is empty apart from "." and "..".
5285 ;; Otherwise, call ourselves recursively if needed.
5289 ;; This test is equivalent to
5290 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5291 ;; but more efficient
5295 ;; We do not want to delete "." and "..".
5301 "Return non-nil if files FILE1 and FILE2 name the same file.
5302 If FILE1 or FILE2 does not exist, the return value is unspecified."
5313 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5315 Return nil if DIR is not an existing directory."
5327 ;; A UNC on Windows systems, or a "super-root" on Apollo.
5342 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5343 This function always sets the file modes of the output files to match
5344 the corresponding input file.
5346 The third arg KEEP-TIME non-nil means give the output files the same
5347 last-modified time as the old ones. (This works on only some systems.)
5349 A prefix arg makes KEEP-TIME non-nil.
5351 Noninteractively, the last argument PARENTS says whether to
5352 create parent directories if they don't exist. Interactively,
5353 this happens by default.
5355 If NEWNAME names an existing directory, copy DIRECTORY as a
5356 subdirectory there. However, if called from Lisp with a non-nil
5357 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5358 directly into NEWNAME instead."
5365 default-directory default-directory nil nil)
5366 current-prefix-arg t nil)))
5369 directory newname))
5370 ;; If default-directory is a remote directory, make sure we find its
5371 ;; copy-directory handler.
5376 newname keep-time parents copy-contents)
5378 ;; Compute target name.
5383 ;; If NEWNAME is not an existing directory, create it;
5384 ;; that is where we will copy the files of DIRECTORY.
5386 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5387 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5392 newname))
5396 newname))
5399 ;; Copy recursively.
5401 ;; We do not want to copy "." and "..".
5403 directory-files-no-dot-files-regexp))
5413 ;; Set directory attributes.
5419 \f
5420 ;; At time of writing, only info uses this.
5422 "Return a copy of DIRS with all non-existent directories removed.
5423 The optional argument KEEP is a list of directories to retain even if
5424 they don't exist, and REJECT is a list of directories to remove from
5425 DIRS, even if they exist; REJECT takes precedence over KEEP.
5427 Note that membership in REJECT and KEEP is checked using simple string
5428 comparison."
5434 dirs)))
5436 \f
5439 "Function to use to revert this buffer.
5440 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5441 which are the arguments that `revert-buffer' received.
5442 It also has access to the `preserve-modes' argument of `revert-buffer'
5443 via the `revert-buffer-preserve-modes' dynamic variable.
5445 For historical reasons, a value of nil means to use the default function.
5450 #'revert-buffer-insert-file-contents--default-function
5451 "Function to use to insert contents when reverting this buffer.
5452 The function receives two arguments: the first the nominal file name to use;
5453 the second is t if reading the auto-save file.
5455 The function is responsible for updating (or preserving) point.
5457 For historical reasons, a value of nil means to use the default function.
5461 "Default function to use for `buffer-stale-function'.
5462 This function ignores its argument.
5463 This returns non-nil if the current buffer is visiting a readable file
5464 whose modification time does not match that of the buffer.
5466 This function only handles buffers that are visiting files.
5467 Non-file buffers need a custom function"
5474 "Function to check whether a buffer needs reverting.
5475 This should be a function with one optional argument NOCONFIRM.
5476 Auto Revert Mode passes t for NOCONFIRM. The function should return
5477 non-nil if the buffer should be reverted. A return value of
5478 `fast' means that the need for reverting was not checked, but
5479 that reverting the buffer is fast. The buffer is current when
5480 this function is called.
5482 The idea behind the NOCONFIRM argument is that it should be
5483 non-nil if the buffer is going to be reverted without asking the
5484 user. In such situations, one has to be careful with potentially
5485 time consuming operations.
5487 For historical reasons, a value of nil means to use the default function.
5488 This should not be relied upon.
5490 For more information on how this variable is used by Auto Revert mode,
5494 "Normal hook for `revert-buffer' to run before reverting.
5495 The function `revert-buffer--default' runs this.
5499 "Normal hook for `revert-buffer' to run after reverting.
5500 Note that the hook value that it runs is the value that was in effect
5501 before reverting; that makes a difference if you have buffer-local
5502 hook functions.
5504 The function `revert-buffer--default' runs this.
5512 ;; `revert-buffer-function' was defined long ago to be a function of only
5513 ;; 2 arguments, so we have to use a dynbind variable to pass the
5514 ;; `preserve-modes' argument of `revert-buffer'.
5518 "Replace current buffer text with the text of the visited file on disk.
5519 This undoes all changes since the file was visited or saved.
5520 With a prefix argument, offer to revert from latest auto-save file, if
5521 that is more recent than the visited file.
5523 This command also implements an interface for special buffers
5524 that contain text which doesn't come from a file, but reflects
5525 some other data instead (e.g. Dired buffers, `buffer-list'
5526 buffers). This is done via the variable `revert-buffer-function'.
5527 In these cases, it should reconstruct the buffer contents from the
5528 appropriate data.
5530 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5531 to revert from the auto-save file when this is nil. Note that the
5532 sense of this argument is the reverse of the prefix argument, for the
5533 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5534 to nil.
5536 Optional second argument NOCONFIRM means don't ask for confirmation
5537 at all. (The variable `revert-without-query' offers another way to
5538 revert buffers without querying for confirmation.)
5540 Optional third argument PRESERVE-MODES non-nil means don't alter
5541 the files modes. Normally we reinitialize them using `normal-mode'.
5543 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5545 This function calls the function that `revert-buffer-function' specifies
5546 to do the work, with arguments IGNORE-AUTO and NOCONFIRM.
5547 The default function runs the hooks `before-revert-hook' and
5548 `after-revert-hook'."
5549 ;; I admit it's odd to reverse the sense of the prefix argument, but
5550 ;; there is a lot of code out there which assumes that the first
5551 ;; argument should be t to avoid consulting the auto-save file, and
5552 ;; there's no straightforward way to encourage authors to notice a
5553 ;; reversal of the argument sense. So I'm just changing the user
5554 ;; interface, but leaving the programmatic interface the same.
5559 ignore-auto noconfirm)))
5562 "Default function for `revert-buffer'.
5563 The arguments IGNORE-AUTO and NOCONFIRM are as described for `revert-buffer'.
5564 Runs the hooks `before-revert-hook' and `after-revert-hook' at the
5565 start and end.
5567 Calls `revert-buffer-insert-file-contents-function' to reread the
5568 contents of the visited file, with two arguments: the first is the file
5569 name, the second is non-nil if reading an auto-save file.
5571 This function only handles buffers that are visiting files.
5572 Non-file buffers need a custom function."
5577 buffer-auto-save-file-name
5582 buffer-auto-save-file-name
5583 buffer-file-name)))
5593 file-name)))
5595 ;; If file was backed up but has changed since,
5596 ;; we should make another backup.
5600 ;; Effectively copy the after-revert-hook status,
5601 ;; since after-find-file will clobber it.
5604 after-revert-hook))
5606 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5610 file-name auto-save-p)
5611 ;; Recompute the truename in case changes in symlinks
5612 ;; have changed the truename.
5616 ;; Run after-revert-hook as it was before we reverted.
5620 local-hook)
5623 t)))))
5626 "Default function for `revert-buffer-insert-file-contents-function'.
5627 The function `revert-buffer--default' calls this.
5628 FILE-NAME is the name of the file. AUTO-SAVE-P is non-nil if this is
5629 an auto-save file."
5633 "File %s no longer exists!"
5635 file-name))
5638 "File %s no longer readable!"
5640 file-name))
5642 ;; Bind buffer-file-name to nil
5643 ;; so that we don't try to lock the file.
5649 ;; Auto-saved file should be read by Emacs's
5650 ;; internal coding.
5654 buffer-file-coding-system-explicit
5657 coding-system-for-read
5659 coding-system-for-read)
5661 ;; As a coding system suitable for multibyte
5662 ;; buffer is specified, make the current
5663 ;; buffer multibyte.
5666 ;; This force after-insert-file-set-coding
5667 ;; (called from insert-file-contents) to set
5668 ;; buffer-file-coding-system to a proper value.
5671 ;; Note that this preserves point in an intelligent way.
5675 nil nil t))
5677 nil nil t))))))
5680 "Recover the visited file--get contents from its last auto-save file."
5685 "Visit file FILE, but get contents from its last auto-save file."
5686 ;; Actually putting the file name in the minibuffer should be used
5687 ;; only rarely.
5688 ;; Not just because users often use the default.
5701 "*Directory*" nil
5712 ;; Use insert-directory-safely, not insert-directory,
5713 ;; because these files might not exist. In particular,
5714 ;; FILE might not exist if the auto-save file was for
5715 ;; a buffer that didn't visit a file, such as "*mail*".
5716 ;; The code in v20.x called `ls' directly, so we need
5717 ;; to emulate what `ls' did in that case.
5722 ;; Keep the current buffer-file-coding-system.
5724 ;; Auto-saved file should be read with special coding.
5733 "Recover auto save files from a previous Emacs session.
5734 This command first displays a Dired buffer showing you the
5735 previous sessions that you could recover from.
5736 To choose one, move point to the proper line and then type C-c C-c.
5737 Then you'll be asked about a number of files to recover."
5747 directory-files-no-dot-files-regexp
5749 t)
5760 ;; Each line starts with a space
5761 ;; so that Font Lock mode won't highlight the first character.
5764 " To delete a session file, type \
5770 "Choose one saved session to recover auto-save files from.
5771 This command is used in the special Dired buffer created by
5774 ;; Get the name of the session file to recover from.
5776 files
5782 ;; Read in the auto-save-list file.
5785 ;; Loop thru the text of that file
5786 ;; and get out the names of the files to recover.
5790 ;; This is a pair of lines for a non-file-visiting buffer.
5791 ;; Get the auto-save file name and manufacture
5792 ;; a "visited file name" from that.
5795 ;; If there is no auto-save file name, the
5796 ;; auto-save-list file is probably corrupted.
5809 ;; This pair of lines is a file-visiting
5810 ;; buffer. Use the visited file name.
5820 ;; Ignore a file if its auto-save file does not exist now.
5824 ;; The file contains a pair of line for each auto-saved buffer.
5825 ;; The first line of the pair contains the visited file name
5826 ;; or is empty if the buffer was not visiting a file.
5827 ;; The second line is the auto-save file name.
5835 files
5841 "Kill BUFFER if confirmed."
5849 "Kill some buffers. Asks the user whether to kill each one of them.
5850 Non-interactively, if optional argument LIST is non-nil, it
5851 specifies the list of buffers to kill, asking for approval for each one."
5859 ; if we killed the base buffer.
5866 "Kill buffers whose name matches the specified REGEXP.
5867 The optional second argument indicates whether to kill internal buffers too."
5876 \f
5878 "Adjust current buffer's auto save file name for current conditions.
5879 Also rename any existing auto save file, if it was made in this session."
5891 "Return file name to use for auto-saves of current buffer.
5892 Does not consider `auto-save-visited-file-name' as that variable is checked
5893 before calling this function. You can redefine this for customization.
5894 See also `auto-save-file-name-p'."
5902 result uniq)
5903 ;; Apply user-specified translations
5904 ;; to the file name.
5908 filename)
5918 filename))))
5923 ;; We truncate the file name to DOS 8+3 limits
5924 ;; before doing anything else, because the regexp
5925 ;; passed to string-match below cannot handle
5926 ;; extensions longer than 3 characters, multiple
5927 ;; dots, and other atrocities.
5932 fn)
5937 "#"
5940 ;; Make sure auto-save file names don't contain characters
5941 ;; invalid for the underlying filesystem.
5943 ;; Don't modify remote (ange-ftp) filenames
5946 result))))
5948 ;; Deal with buffers that don't have any associated files. (Mail
5949 ;; mode tends to create a good number of these.)
5953 file-name)
5954 ;; Restrict the characters used in the file name to those which
5955 ;; are known to be safe on all filesystems, url-encoding the
5956 ;; rest.
5957 ;; We do this on all platforms, because even if we are not
5958 ;; running on DOS/Windows, the current directory may be on a
5959 ;; mounted VFAT filesystem, such as a USB memory stick.
5963 ;; For multibyte characters, this will produce more than
5964 ;; 2 hex digits, so is not true URL encoding.
5968 ;; Generate the file name.
5974 ;; Try a few alternative directories, to get one we can
5975 ;; write it.
5981 ;; Don't modify remote (ange-ftp) filenames
5983 ;; The call to convert-standard-filename is in case
5984 ;; buffer-name includes characters not allowed by the
5985 ;; DOS/Windows filesystems. make-temp-file writes to the
5986 ;; file it creates, so we must fix the file name _before_
5987 ;; make-temp-file is called.
5989 fname))
5991 ;; make-temp-file creates the file,
5992 ;; but we don't want it to exist until we do an auto-save.
5996 file-name)))
5999 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
6000 FILENAME should lack slashes. You can redefine this for customization."
6002 \f
6004 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
6005 The generated regexp will match a filename only if the filename
6006 matches that wildcard according to shell rules. Only wildcards known
6007 by `sh' are supported."
6009 ;; Copy the initial run of non-special characters.
6012 ;; If no special characters, we're almost done.
6016 j)
6018 result
6039 ;; Found "[^". Insert a `\0' character
6040 ;; (which cannot happen in a filename)
6041 ;; into the character class, so that `^'
6042 ;; is not the first character after `[',
6043 ;; and thus non-special in a regexp.
6048 ;; I don't think `]' can appear in a
6049 ;; character class in a wildcard, but
6050 ;; let's be general here.
6057 i
6070 ;; Shell wildcards should match the entire filename,
6071 ;; not its part. Make the regexp say so.
6073 \f
6076 "Switches for `list-directory' to pass to `ls' for brief listing."
6082 "Switches for `list-directory' to pass to `ls' for verbose listing."
6087 "Expand wildcard pattern PATTERN.
6088 This returns a list of file names which match the pattern.
6089 Files are sorted in `string<' order.
6091 If PATTERN is written as an absolute file name,
6092 the values are absolute also.
6094 If PATTERN is written as a relative file name, it is interpreted
6095 relative to the current default directory, `default-directory'.
6096 The file names returned are normally also relative to the current
6097 default directory. However, if FULL is non-nil, they are absolute."
6101 ;; A list of all dirs that DIRPART specifies.
6102 ;; This can be more than one dir
6103 ;; if DIRPART contains wildcards.
6107 dirpart)))
6111 contents)
6116 ;; Filter out "." and ".."
6121 name))
6128 this-dir-contents)
6129 this-dir-contents)
6130 contents)))))
6131 contents)))
6133 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
6137 "Display a list of files in or matching DIRNAME, a la `ls'.
6138 DIRNAME is globbed by the shell if necessary.
6139 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
6140 Actions controlled by variables `list-directory-brief-switches'
6141 and `list-directory-verbose-switches'."
6145 nil default-directory nil)
6146 pfx)))
6148 list-directory-brief-switches))
6149 buffer)
6161 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6169 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6171 PATTERN is assumed to represent a file-name wildcard suitable for the
6172 underlying filesystem. For Unix and GNU/Linux, each character from the
6174 the parts of the pattern which don't include wildcard characters are
6175 quoted with double quotes.
6178 on Windows), so PATTERN can use them to quote wildcard characters that
6179 need to be passed verbatim to shell commands."
6183 ;; DOS/Windows don't allow `"' in file names. So if the
6184 ;; argument has quotes, we can safely assume it is already
6185 ;; quoted by the caller.
6187 ;; We quote [&()#$`'] in case their shell is a port of a
6188 ;; Unixy shell. We quote [,=+] because stock DOS and
6189 ;; Windows shells require that in some cases, such as
6190 ;; passing arguments to batch files that use positional
6191 ;; arguments like %1.
6193 pattern
6196 end)
6213 pattern))))
6220 "Program to get the amount of free space on a file system.
6221 We assume the output has the format of `df'.
6222 The value of this variable must be just a command name or file name;
6223 if you want to specify options, use `directory-free-space-args'.
6225 A value of nil disables this feature.
6227 If the function `file-system-info' is defined, it is always used in
6228 preference to the program given by this variable."
6234 "Options to use when running `directory-free-space-program'."
6239 "Return the amount of free space on directory DIR's file system.
6240 The return value is a string describing the amount of free
6241 space (normally, the number of free 1KB blocks).
6243 This function calls `file-system-info' if it is available, or
6244 invokes the program specified by `directory-free-space-program'
6245 and `directory-free-space-args'. If the system call or program
6246 is unsuccessful, or if DIR is a remote directory, this function
6247 returns nil."
6249 ;; Try to find the number of free blocks. Non-Posix systems don't
6250 ;; always have df, but might have an equivalent system call.
6259 ;; Avoid failure if the default directory does
6260 ;; not exist (Bug#2631, Bug#3911).
6264 nil t nil
6265 directory-free-space-args
6268 ;; Assume that the "available" column is before the
6269 ;; "capacity" column. Find the "%" and scan backward.
6273 "[[:space:]]+[^[:space:]]+%[^%]*$"
6280 ;; The following expression replaces `dired-move-to-filename-regexp'.
6284 ;; In some locales, month abbreviations are as short as 2 letters,
6285 ;; and they can be followed by ".".
6286 ;; In Breton, a month name can include a quote character.
6299 s "+"
6302 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6303 ;; omits the Kanji characters after month and day-of-month.
6304 ;; On Mac OS X 10.3, the date format in East Asian locales is
6305 ;; day-of-month digits followed by month digits.
6311 ;; The "[0-9]" below requires the previous column to end in a digit.
6312 ;; This avoids recognizing `1 may 1997' as a date in the line:
6313 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6315 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6317 ;; For non-iso date formats, we add the ".*" in order to find
6318 ;; the last possible match. This avoids recognizing
6319 ;; `jservice 10 1024' as a date in the line:
6320 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6322 ;; vc dired listings provide the state or blanks between file
6323 ;; permissions and date. The state is always surrounded by
6324 ;; parentheses:
6325 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6326 ;; This is not supported yet.
6331 "Regular expression to match up to the file name in a directory listing.
6332 The default value is designed to recognize dates and times
6337 ;; insert-directory
6338 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6339 ;; FULL-DIRECTORY-P is nil.
6340 ;; The single line of output must display FILE's name as it was
6341 ;; given, namely, an absolute path name.
6342 ;; - must insert exactly one line for each file if WILDCARD or
6343 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6344 ;; before the file lines, plus optional text after the file lines.
6345 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6346 ;; allowed.
6347 ;; File lines should display the basename.
6348 ;; - must be consistent with
6349 ;; - functions dired-move-to-filename, (these two define what a file line is)
6350 ;; dired-move-to-end-of-filename,
6351 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6352 ;; dired-insert-headerline
6353 ;; dired-after-subdir-garbage (defines what a "total" line is)
6354 ;; - variable dired-subdir-regexp
6355 ;; - may be passed "--dired" as the first argument in SWITCHES.
6356 ;; Filename handlers might have to remove this switch if their
6357 ;; "ls" command does not support it.
6359 "Insert directory listing for FILE, formatted according to SWITCHES.
6360 Leaves point after the inserted text.
6361 SWITCHES may be a string of options, or a list of strings
6362 representing individual options.
6363 Optional third arg WILDCARD means treat FILE as shell wildcard.
6364 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6365 switches do not contain `d', so that a full listing is expected.
6367 This works by running a directory listing program
6368 whose name is in the variable `insert-directory-program'.
6369 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6371 When SWITCHES contains the long `--dired' option, this function
6372 treats it specially, for the sake of dired. However, the
6373 normally equivalent short `-D' option is just passed on to
6374 `insert-directory-program', as any other option."
6375 ;; We need the directory in order to find the right handler.
6380 wildcard full-directory-p)
6383 ;; Read the actual directory using `insert-directory-program'.
6384 ;; RESULT gets the status code.
6386 ;; putting text property `dired-filename, decode one
6387 ;; bunch by one to preserve that property.
6389 ;; This is to control encoding the arguments in call-process.
6393 default-file-name-coding-system))))
6396 ;; Run ls in the directory part of the file pattern
6397 ;; using the last component as argument.
6403 ;; NB since switches is passed to the shell, be
6404 ;; careful of malicious values, eg "-l;reboot".
6405 ;; See eg dired-safe-switches-p.
6407 shell-file-name nil t nil
6408 "-c"
6410 ""
6412 insert-directory-program
6413 " -d "
6415 switches
6417 " -- "
6418 ;; Quote some characters that have
6419 ;; special meanings in shells; but
6420 ;; don't quote the wildcards--we want
6421 ;; them to be special. We also
6422 ;; currently don't quote the quoting
6423 ;; characters in case people want to
6424 ;; use them explicitly to quote
6425 ;; wildcard characters.
6427 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6428 ;; directory if FILE is a symbolic link.
6436 insert-directory-program nil t nil
6440 ;; Split the switches at any spaces so we can
6441 ;; pass separate options as separate args.
6443 ;; Avoid lossage if FILE starts with `-'.
6451 file))))))))
6453 ;; If we got "//DIRED//" in the output, it means we got a real
6454 ;; directory listing, even if `ls' returned nonzero.
6455 ;; So ignore any errors.
6468 ;; The first time ls returns an error,
6469 ;; find the version numbers of ls,
6470 ;; and set insert-directory-ls-version
6471 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6472 ;; is equal or if the info cannot be obtained.
6473 ;; (That can mean it isn't GNU ls.)
6483 comparison)
6499 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6503 ;; If `insert-directory-program' failed, signal an error.
6505 ;; Delete the error message it may have output.
6507 ;; On non-Posix systems, we cannot open a directory, so
6508 ;; don't even try, because that will always result in
6509 ;; the ubiquitous "Access denied". Instead, show the
6510 ;; command line so the user can try to guess what went wrong.
6515 insert-directory-program
6517 file result)
6518 ;; Unix. Access the file to get a suitable error.
6525 ;; The following overshoots by one line for an empty
6526 ;; directory listed with "--dired", but without "-a"
6527 ;; switch, where the ls output contains a
6528 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6529 ;; We take care of that case later.
6537 error-lines)
6538 ;; Find all the lines that are error messages,
6539 ;; and record the bounds of each one.
6546 ;; Now read the numeric positions of file names.
6553 error-lines))
6556 error-lines)))
6558 ;; End is followed by \n or by " -> ".
6560 ;; It seems that we can't trust ls's output as to
6561 ;; byte positions of filenames.
6567 ;; Take care of the case where the ls output contains a
6568 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6569 ;; and we went one line too far back (see above).
6574 ;; Now decode what read if necessary.
6576 file-name-coding-system
6577 default-file-name-coding-system
6579 coding-no-eol
6580 val pos)
6584 ;; If no coding system is specified or detection is
6585 ;; requested, detect the coding.
6599 ;; Force no eol conversion on a file name, so
6600 ;; that CR is preserved.
6608 ;; Try to insert the amount of free space.
6611 ;; First find the line to put it on.
6615 ;; Replace "total" with "used", to avoid confusion.
6621 "Convert `ls --dired' file name position value POS to a buffer position.
6622 File name position values returned in ls --dired output
6623 count only stdout; they don't count the error messages sent to stderr.
6624 So this function converts to them to real buffer positions.
6625 ERROR-LINES is a list of buffer positions of error message lines,
6626 of the form (START END)."
6630 pos)
6634 "Insert directory listing for FILE, formatted according to SWITCHES.
6636 Like `insert-directory', but if FILE does not exist, it inserts a
6637 message to that effect instead of signaling an error."
6640 ;; Simulate the message printed by `ls'.
6644 "Functions to call with no arguments to query about killing Emacs.
6645 If any of these functions returns nil, killing Emacs is canceled.
6646 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6650 "How to ask for confirmation when leaving Emacs.
6651 If nil, the default, don't ask at all. If the value is non-nil, it should
6652 be a predicate function; for example `yes-or-no-p'."
6661 "Offer to save each buffer, then kill this Emacs process.
6662 With prefix ARG, silently save all file-visiting buffers without asking.
6663 If there are active processes where `process-query-on-exit-flag'
6664 returns non-nil, asks whether processes should be killed.
6665 Runs the members of `kill-emacs-query-functions' in turn and stops
6666 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6678 ;; process-list is not defined on MSDOS.
6680 active)
6698 ;; Query the user for other things, perhaps.
6705 "Offer to save each buffer, then kill the current connection.
6706 If the current frame has no client, kill Emacs itself.
6708 With prefix ARG, silently save all file-visiting buffers, then kill.
6710 If emacsclient was started with a list of filenames to edit, then
6711 only these files will be asked to be saved."
6716 \f
6717 ;; We use /: as a prefix to "quote" a file name
6718 ;; so that magic file name handlers will not apply to it.
6722 file-name-handler-alist))
6724 ;; We depend on being the last handler on the list,
6725 ;; so that anything else which does need handling
6726 ;; has been handled already.
6727 ;; So it is safe for us to inhibit *all* magic file name handlers.
6736 default-directory))
6737 ;; Get a list of the indices of the args which are file names.
6740 ;; The first six are special because they
6741 ;; return a file name. We want to include the /:
6742 ;; in the return value.
6743 ;; So just avoid stripping it in the first place.
6750 ;; `identity' means just return the first arg
6751 ;; not stripped of its quoting.
6753 ;; `add' means add "/:" to the result.
6756 ;; `unquote-then-quote' means set buffer-file-name
6757 ;; temporarily to unquoted filename.
6759 ;; List the arguments which are filenames.
6767 ;; For all other operations, treat the first argument only
6768 ;; as the file name.
6770 method
6771 ;; Copy ARGUMENTS so we can replace elements in it.
6775 ;; Strip off the /: from the file names that have it.
6783 "/"
6789 (`insert-file-contents
6795 (`unquote-then-quote
6800 \f
6801 ;; Symbolic modes and read-file-modes.
6804 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6805 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6806 Others, or All) for whom to produce the mask.
6807 The bit-mask that is returned extracts from mode bits the access rights
6808 for the specified category of users."
6816 "Convert CHAR to a numeric value of mode bits.
6817 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6818 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6825 ;; Rights relative to the previous file modes.
6836 "Convert a symbolic mode string specification to an equivalent number.
6838 WHO-MASK is the bit-mask specifying the category of users to which to
6839 apply the access permissions. See `file-modes-char-to-who'.
6840 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6841 RIGHTS request to add, remove, or set permissions based on existing ones,
6848 char-right)
6855 num-rights
6859 op char-right)))
6860 num-rights))
6863 "Convert symbolic file modes to numeric file modes.
6864 MODES is the string to convert, it should match
6866 See Info node `(coreutils)File permissions' for more information on this
6867 notation.
6868 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6869 MODES request to add, remove, or set permissions based on existing ones,
6883 num-who num-modes)
6886 num-modes)))
6889 "Read file modes in octal or symbolic notation and return its numeric value.
6891 ORIG-FILE is the name of a file on whose mode bits to base returned
6892 permissions if what user types requests to add, remove, or set permissions
6908 nil nil default)))
6917 ;; Trashcan handling.
6919 "Directory for `move-file-to-trash' to move files and directories to.
6920 This directory is only used when the function `system-move-file-to-trash'
6921 is not defined.
6922 Relative paths are interpreted relative to `default-directory'.
6923 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6933 "Move the file (or directory) named FILENAME to the trash.
6934 When `delete-by-moving-to-trash' is non-nil, this function is
6935 called by `delete-file' and `delete-directory' instead of
6936 deleting files outright.
6938 If the function `system-move-file-to-trash' is defined, call it
6939 with FILENAME as an argument.
6940 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6941 directory.
6942 Otherwise, trash FILENAME using the freedesktop.org conventions,
6943 like the GNOME, KDE and XFCE desktop environments. Emacs only
6947 ;; If `trash-directory' is non-nil, move the file there.
6951 trash-dir)))
6952 ;; We can't trash a parent directory of trash-directory.
6955 trash-dir filename))
6958 ;; Ensure that the trashed file-name is unique.
6965 ;; If `system-move-file-to-trash' is defined, use it.
6968 ;; Otherwise, use the freedesktop.org method, as specified at
6969 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6980 ;; Check if we have permissions to delete.
6984 ;; The trashed file cannot be the trash dir or its parent.
6987 trash-files-dir filename))
6990 trash-info-dir filename))
6992 ;; Ensure that the trash directory exists; otherwise, create it.
6999 ;; Try to move to trash with .trashinfo undo information
7004 ;; Perform url-encoding on FN. For compatibility with
7005 ;; other programs (e.g. XFCE Thunar), allow literal "/"
7006 ;; for path separators.
7011 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
7012 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
7025 fn))
7030 ;; Attempt to make .trashinfo file, trying up to 5
7031 ;; times. The .trashinfo file is opened with O_EXCL,
7032 ;; as per trash-spec 0.7, even if that can be a problem
7033 ;; on old NFS versions...
7037 trash-files-dir))
7039 success info-fn)
7044 trash-info-dir))
7052 ;; Uniquify new-fn. (Some file managers do not
7053 ;; like Emacs-style backup file names---e.g. bug
7054 ;; 170956 in Konqueror bug tracker.)
7059 ;; Finally, try to move the file to the trashcan.
7063 \f
7088 ;;; files.el ends here