| blob | 73a0c5c9e24d21e91940cd7fc7fd0cf02564ea40 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
5 ;; 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
62 FROM and TO should be equivalent names, which refer to the
63 same directory. Do not use `~' in the TO strings;
64 they should be ordinary absolute directory names.
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 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 "Non-nil means don't make a backup, regardless of the other parameters.
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."
129 "Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
141 "Predicate that looks at a file name and decides whether to make backups.
145 "Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
153 "Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
160 "Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
168 "Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
197 "The directory for writing temporary files."
204 "The directory for writing small temporary files.
205 If non-nil, this directory is used instead of `temporary-file-directory'
206 by programs that create small temporary files. This is for systems that
207 have fast storage with limited space, such as a RAM disk."
212 ;; The system null device. (Should reference NULL_DEVICE from C.)
240 "Non-nil means protect against I/O errors while saving files.
241 Some modes set this non-nil in particular buffers.
243 This feature works by writing the new contents into a temporary file
244 and then renaming the temporary file to replace the original.
245 In this way, any I/O error in writing leaves the original untouched,
246 and there is never any instant where the file is nonexistent.
248 Note that this feature forces backups to be made by copying.
249 Yet, at the same time, saving a precious file
250 breaks any hard links between it and other files.
252 This feature is advisory: for example, if the directory in which the
253 file is being saved is not writable, Emacs may ignore a non-nil value
254 of `file-precious-flag' and write directly into the file.
256 See also: `break-hardlink-on-save'."
261 "Non-nil means when saving a file that exists under several names
262 \(i.e., has multiple hardlinks), break the hardlink associated with
263 `buffer-file-name' and write to a new file, so that the other
264 instances of the file are not affected by the save.
266 If `buffer-file-name' refers to a symlink, do not break the symlink.
268 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
269 For example, if the directory in which a file is being saved is not
270 itself writable, then error instead of saving in some
271 hardlink-nonbreaking way.
273 See also `backup-by-copying' and `backup-by-copying-when-linked'."
279 "Control use of version numbers for backup files.
280 When t, make numeric backup versions unconditionally.
281 When nil, make them for files that have some already.
282 The value `never' means do not make them."
292 "When cleaning directory, number of versions to keep."
298 "If t, delete excess backup versions silently.
299 If nil, ask confirmation. Any other value prevents any trimming."
306 "Number of oldest versions to keep when a new numbered backup is made."
312 "Number of newest versions to keep when a new numbered backup is made.
313 Includes the new backup. Must be > 0"
319 "Whether to add a newline automatically at the end of the file.
321 A value of t means do this only when the file is about to be saved.
322 A value of `visit' means do this right after the file is visited.
323 A value of `visit-save' means do it at both of those times.
324 Any other non-nil value means ask user whether to add a newline, when saving.
325 A value of nil means don't add newlines.
327 Certain major modes set this locally to the value obtained
328 from `mode-require-final-newline'."
337 "Whether to add a newline at end of file, in certain major modes.
338 Those modes set `require-final-newline' to this value when you enable them.
339 They do so because they are often used for files that are supposed
340 to end in newlines, and the question is how to arrange that.
342 A value of t means do this only when the file is about to be saved.
343 A value of `visit' means do this right after the file is visited.
344 A value of `visit-save' means do it at both of those times.
345 Any other non-nil value means ask user whether to add a newline, when saving.
347 A value of nil means do not add newlines. That is a risky choice in this
348 variable since this value is used for modes for files that ought to have
349 final newlines. So if you set this to nil, you must explicitly check and
350 add a final newline, whenever you save a file that really needs one."
360 "Non-nil says by default do auto-saving of every file-visiting buffer."
366 ;; Don't put "\\2" inside expand-file-name, since it will be
367 ;; transformed to "/2" on DOS/Windows.
369 "Transforms to apply to buffer file name before making auto-save file name.
370 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
371 REGEXP is a regular expression to match against the file name.
372 If it matches, `replace-match' is used to replace the
373 matching part with REPLACEMENT.
374 If the optional element UNIQUIFY is non-nil, the auto-save file name is
375 constructed by taking the directory part of the replaced file-name,
376 concatenated with the buffer file name with all directory separators
377 changed to `!' to prevent clashes. This will not work
378 correctly if your filesystem truncates the resulting name.
380 All the transforms in the list are tried, in the order they are listed.
381 When one transform applies, its result is final;
382 no further transforms are tried.
384 The default value is set up to put the auto-save file into the
385 temporary directory (see the variable `temporary-file-directory') for
386 editing a remote file.
388 On MS-DOS filesystems without long names this variable is always
389 ignored."
397 "Non-nil means save word abbrevs too when files are saved.
398 If `silently', don't ask the user before saving."
403 "Non-nil means allow `find-file' to visit directories.
404 To visit the directory, `find-file' runs `find-directory-functions'."
409 "List of functions to try in sequence to visit a directory.
410 Each function is called with the directory name as the sole argument
411 and should return either a buffer or nil."
415 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
417 "List of functions to try in sequence to get a file name at point.
418 Each function should return either nil or a file name found at the
419 location of point in the current buffer."
423 ;;;It is not useful to make this a local variable.
424 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
426 "List of functions to be called for `find-file' on nonexistent file.
427 These functions are called as soon as the error is detected.
428 Variable `buffer-file-name' is already set up.
433 ;;;It is not useful to make this a local variable.
434 ;;;(put 'find-file-hooks 'permanent-local t)
437 "List of functions to be called after a buffer is loaded from a file.
438 The buffer's local variables (if any) will have been processed before the
439 functions are called."
446 "List of functions to be called before writing out a buffer to a file.
447 If one of them returns non-nil, the file is considered already written
448 and the rest are not called.
449 These hooks are considered to pertain to the visited file.
450 So any buffer-local binding of this variable is discarded if you change
452 change the major mode.
454 This hook is not run if any of the functions in
455 `write-contents-functions' returns non-nil. Both hooks pertain
456 to how to save a buffer to file, for instance, choosing a suitable
457 coding system and setting mode bits. (See Info
458 node `(elisp)Saving Buffers'.) To perform various checks or
469 "List of functions to be called before writing out a buffer to a file.
470 If one of them returns non-nil, the file is considered already written
471 and the rest are not called and neither are the functions in
472 `write-file-functions'.
474 This variable is meant to be used for hooks that pertain to the
475 buffer's contents, not to the particular visited file; thus,
476 `set-visited-file-name' does not clear this variable; but changing the
477 major mode does clear it.
479 For hooks that _do_ pertain to the particular visited file, use
480 `write-file-functions'. Both this variable and
481 `write-file-functions' relate to how a buffer is saved to file.
482 To perform various checks or updates before the buffer is saved,
489 "Control use of local variables in files you visit.
490 The value can be t, nil, :safe, :all, or something else.
492 A value of t means file local variables specifications are obeyed
493 if all the specified variable values are safe; if any values are
494 not safe, Emacs queries you, once, whether to set them all.
495 \(When you say yes to certain values, they are remembered as safe.)
497 :safe means set the safe variables, and ignore the rest.
498 :all means set all variables, whether safe or not.
499 (Don't set it permanently to :all.)
500 A value of nil means always ignore the file local variables.
502 Any other value means always query you once whether to set them all.
503 \(When you say yes to certain values, they are remembered as safe, but
506 This variable also controls use of major modes specified in
507 a -*- line.
510 always obeys file local variable specifications and the -*- line,
511 and ignores this variable."
512 :risky t
521 "Like `enable-local-variables' but meant for buffer-local bindings.
522 The meaningful values are nil and non-nil. The default is non-nil.
523 If a major mode sets this to nil, buffer-locally, then any local
524 variables list in the file will be ignored.
526 This variable does not affect the use of major modes
531 The value can be t, nil or something else.
532 A value of t means obey `eval' variables.
533 A value of nil means ignore them; anything else means query."
534 :risky t
540 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
549 "Non-nil means buffers visiting files read-only do so in view mode.
550 In fact, this means that all read-only buffers normally have
551 View mode enabled, including buffers that are read-only because
552 you visit a file you cannot alter, and buffers you make read-only
558 "History list of file names entered in the minibuffer.
560 Maximum length of the history list is determined by the value
562 \f
565 "Provides support for ange-ftp host name completion.
566 Runs the usual ange-ftp hook, but only for completion operations."
567 ;; Having this here avoids the need to load ange-ftp when it's not
568 ;; really in use.
574 inhibit-file-name-handlers)))
582 "Convert a standard file's name to something suitable for the OS.
583 This means to guarantee valid names and perhaps to canonicalize
584 certain patterns.
586 FILENAME should be an absolute file name since the conversion rules
587 sometimes vary depending on the position in the file name. E.g. c:/foo
588 is a valid DOS file name, but c:/bar/c:/foo is not.
590 This function's standard definition is trivial; it just returns
591 the argument. However, on Windows and DOS, replace invalid
592 characters. On DOS, make sure to obey the 8.3 limitations.
593 In the native Windows build, turn Cygwin names into native names,
594 and also turn slashes into backslashes if the shell requires it (see
595 `w32-shell-dos-semantics').
597 See Info node `(elisp)Standard File Names' for more details."
602 ;; Replace invalid filename characters with !
606 name))
614 "Read directory name, prompting with PROMPT and completing in directory DIR.
615 Value is not expanded---you must call `expand-file-name' yourself.
616 Default name to DEFAULT-DIRNAME if user exits with the same
617 non-empty string that was inserted by this function.
618 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
619 or just DIR if INITIAL is nil.)
620 If the user exits with an empty minibuffer, this function returns
621 an empty string. (This can only happen if the user erased the
622 pre-inserted contents or if `insert-default-directory' is nil.)
623 Fourth arg MUSTMATCH non-nil means require existing directory's name.
624 Non-nil and non-t means also require confirmation after completion.
625 Fifth arg INITIAL specifies text to start with.
626 DIR should be an absolute directory name. It defaults to
627 the value of `default-directory'."
632 dir))
633 mustmatch initial
636 \f
638 "Show the current default directory."
643 "Value of the CDPATH environment variable, as a list.
647 "Explode a search path into a list of directory names.
648 Directories are separated by occurrences of `path-separator'
649 \(which is colon in GNU and GNU-like systems)."
650 ;; We could use split-string here.
658 nil
663 cd-list)))
666 "Change current directory to given absolute file name DIR."
667 ;; Put the name into directory syntax now,
668 ;; because otherwise expand-file-name may give some bad results.
670 ;; We used to additionally call abbreviate-file-name here, for an
671 ;; unknown reason. Problem is that most buffers are setup
672 ;; without going through cd-absolute and don't call
673 ;; abbreviate-file-name on their default-directory, so the few that
674 ;; do end up using a superficially different directory.
686 "Make DIR become the current buffer's default directory.
687 If your environment includes a `CDPATH' variable, try each one of
688 that list of directories (separated by occurrences of
689 `path-separator') when resolving a relative directory name.
690 The path separator is colon in GNU and GNU-like systems."
693 default-directory default-directory
709 cd-path)
710 nil))
714 "Load the Lisp file named FILE."
715 ;; This is a case where .elc makes a lot of sense.
722 "Search for FILENAME through PATH.
723 If found, return the absolute file name of FILENAME, with its suffixes;
724 otherwise return nil.
725 PATH should be a list of directories to look in, like the lists in
726 `exec-path' or `load-path'.
727 If SUFFIXES is non-nil, it should be a list of suffixes to append to
730 If non-nil, PREDICATE is used instead of `file-readable-p'.
731 PREDICATE can also be an integer to pass to the `access' system call,
732 in which case file-name handlers are ignored. This usage is deprecated.
734 For compatibility, PREDICATE can also be one of the symbols
735 `executable', `readable', `writable', or `exists', or a list of
736 one or more of those symbols."
747 "Do completion for file names passed to `locate-file'."
750 ;; FIXME: maybe we should use completion-file-name-table instead,
751 ;; tho at least for `load', the arg is passed through
752 ;; substitute-in-file-name for historical reasons.
762 ;; If we have files like "foo.el" and "foo.elc", we could load one of
763 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
764 ;; preferred way. So if we list all 3, that gives a lot of redundant
765 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
766 ;; the user does want to pay attention to the extension. We try to
767 ;; diffuse this tension by stripping the suffix, except when the
768 ;; result is a single element (i.e. usually we only list "foo" unless
769 ;; it's the only remaining element in the list, in which case we do
770 ;; list "foo", "foo.elc" and "foo.el").
781 string-file dir))
786 ;; Switching from names to names+fullnames creates a non-monotonicity
787 ;; which can cause problems with things like partial-completion.
788 ;; To minimize the problem, filter out completion-regexp-list, so that
789 ;; M-x load-library RET t/x.e TAB finds some files.
792 ;; Remove duplicates of the first element, so that we can easily check
793 ;; if `names' really only contains a single element.
796 ;; There's no more than one matching non-suffixed element, so expand
797 ;; the list by adding the suffixed elements as well.
800 string-dir names string-file pred action)))))
803 "Do completion for file names passed to `locate-file'.
804 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
807 string nil action))
812 "Regexp of directory names which stop the search in `locate-dominating-file'.
813 Any directory whose name matches this regexp will be treated like
814 a kind of root directory by `locate-dominating-file' which will stop its search
815 when it bumps into it.
816 The default regexp prevents fruitless and time-consuming attempts to find
817 special files in directories in which filenames are interpreted as hostnames,
820 ;; (defun locate-dominating-files (file regexp)
821 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
822 ;; Stop at the first parent where a matching file is found and return the list
823 ;; of files that that match in this directory."
824 ;; (catch 'found
825 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
826 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
827 ;; (let ((user nil)
828 ;; ;; Abbreviate, so as to stop when we cross ~/.
829 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
830 ;; files)
831 ;; (while (and dir
832 ;; ;; As a heuristic, we stop looking up the hierarchy of
833 ;; ;; directories as soon as we find a directory belonging to
834 ;; ;; another user. This should save us from looking in
835 ;; ;; things like /net and /afs. This assumes that all the
836 ;; ;; files inside a project belong to the same user.
837 ;; (let ((prev-user user))
838 ;; (setq user (nth 2 (file-attributes dir)))
839 ;; (or (null prev-user) (equal user prev-user))))
840 ;; (if (setq files (condition-case nil
841 ;; (directory-files dir 'full regexp 'nosort)
842 ;; (error nil)))
843 ;; (throw 'found files)
844 ;; (if (equal dir
845 ;; (setq dir (file-name-directory
846 ;; (directory-file-name dir))))
847 ;; (setq dir nil))))
848 ;; nil)))
851 "Look up the directory hierarchy from FILE for a file named NAME.
852 Stop at the first parent directory containing a file NAME,
853 and return the directory. Return nil if not found."
854 ;; We used to use the above locate-dominating-files code, but the
855 ;; directory-files call is very costly, so we're much better off doing
856 ;; multiple calls using the code in here.
857 ;;
858 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
859 ;; `name' in /home or in /.
863 ;; `user' is not initialized outside the loop because
864 ;; `file' may not exist, so we may have to walk up part of the
865 ;; hierarchy before we find the "initial UID".
867 try)
870 ;; FIXME: Disabled this heuristic because it is sometimes
871 ;; inappropriate.
872 ;; As a heuristic, we stop looking up the hierarchy of
873 ;; directories as soon as we find a directory belonging
874 ;; to another user. This should save us from looking in
875 ;; things like /net and /afs. This assumes that all the
876 ;; files inside a project belong to the same user.
877 ;; (let ((prev-user user))
878 ;; (setq user (nth 2 (file-attributes file)))
879 ;; (and prev-user (not (equal user prev-user))))
887 root))
891 "Search for COMMAND in `exec-path' and return the absolute file name.
892 Return nil if COMMAND is not found anywhere in `exec-path'."
893 ;; Use 1 rather than file-executable-p to better match the behavior of
894 ;; call-process.
898 "Load the Emacs Lisp library named LIBRARY.
899 This is an interface to the function `load'. LIBRARY is searched
900 for in `load-path', both with and without `load-suffixes' (as
901 well as `load-file-rep-suffixes').
903 See Info node `(emacs)Lisp Libraries' for more details.
904 See `load-file' for a different interface to `load'."
908 load-path
913 "Test whether FILE specifies a location on a remote system.
914 Returns nil or a string identifying the remote connection (ideally
915 a prefix of FILE). For example, the remote identification for filename
918 less reliable than accessing local files.
919 Furthermore, relative file names do not work across remote connections.
921 IDENTIFICATION specifies which part of the identification shall
922 be returned as string. IDENTIFICATION can be the symbol
923 `method', `user', `host' or `localname'; any other value is
924 handled like nil and means to return the complete identification
925 string.
927 If CONNECTED is non-nil, the function returns an identification only
928 if FILE is located on a remote system, and a connection is established
929 to that remote system.
931 `file-remote-p' will never open a connection on its own."
935 nil)))
938 "Copy the file FILE into a temporary file on this machine.
939 Returns the name of the local copy, or nil, if FILE is directly
940 accessible."
941 ;; This formerly had an optional BUFFER argument that wasn't used by
942 ;; anything.
946 nil)))
949 "Return the truename of FILENAME, which should be absolute.
950 The truename of a file name is found by chasing symbolic links
951 both at the level of the file and at the level of the directories
952 containing it, until no links are left at any level.
955 ;; COUNTER and PREV-DIRS are only used in recursive calls.
956 ;; COUNTER can be a cons cell whose car is the count of how many
957 ;; more links to chase before getting an error.
958 ;; PREV-DIRS can be a cons cell whose car is an alist
959 ;; of truenames we've just recently computed.
973 ;; For speed, remove the ange-ftp completion handler from the list.
974 ;; We know it's not needed here.
975 ;; For even more speed, do this only on the outermost call.
982 ;; andrewi@harlequin.co.uk - none of the following code (except for
983 ;; invoking the file-name handler) currently applies on Windows
984 ;; (ie. there are no native symlinks), but there is an issue with
985 ;; case differences being ignored by the OS, and short "8.3 DOS"
986 ;; name aliases existing for all files. (The short names are not
987 ;; reported by directory-files, but can be used to refer to files.)
988 ;; It seems appropriate for file-truename to resolve these issues in
989 ;; the most natural way, which on Windows is to call the function
990 ;; `w32-long-file-name' - this returns the exact name of a file as
991 ;; it is stored on disk (expanding short name aliases with the full
992 ;; name in the process).
995 ;; For file name that has a special handler, call handler.
996 ;; This is so that ange-ftp can save time by doing a no-op.
999 ;; If filename contains a wildcard, newname will be the old name.
1001 ;; If filename exists, use the long name. If it doesn't exist,
1002 ;; drill down until we find a directory that exists, and use
1003 ;; the long name of that, with the extra non-existent path
1004 ;; components concatenated.
1006 missing rest)
1009 ;; Include the preceding directory separator in the missing
1010 ;; part so subsequent recursion on the rest works.
1015 ""
1020 ;; If this file directly leads to a link, process that iteratively
1021 ;; so that we don't use lots of stack.
1027 ;; For file name that has a special handler, call handler.
1028 ;; This is so that ange-ftp can save time by doing a no-op.
1031 done t)
1033 target dirfile)
1034 ;; Get the truename of the directory.
1036 ;; If these are equal, we have the (or a) root directory.
1038 ;; If this is the same dir we last got the truename for,
1039 ;; save time--don't recalculate.
1049 done t)
1052 done t)
1053 ;; Put it back on the file name.
1055 ;; Is the file name the name of a link?
1058 ;; Yes => chase that link, then start all over
1059 ;; since the link may point to a directory name that uses links.
1060 ;; We can't safely use expand-file-name here
1061 ;; since target might look like foo/../bar where foo
1062 ;; is itself a link. Instead, we handle . and .. above.
1065 target
1067 done nil)
1068 ;; No, we are done!
1070 filename))
1073 "Chase links in FILENAME until a name that is not a link.
1074 Unlike `file-truename', this does not check whether a parent
1075 directory name is a symbolic link.
1076 If the optional argument LIMIT is a number,
1077 it means chase no more than that many links and then stop."
1085 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1088 ;; Handle `..' by hand, since it needs to work in the
1089 ;; target of any directory symlink.
1090 ;; This code is not quite complete; it does not handle
1091 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1095 ;; Chase links in the default dir of the symlink.
1099 ;; Now find the parent of that dir.
1103 newname))
1106 "Create a temporary file.
1107 The returned file name (created by appending some random characters at the end
1108 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1109 is guaranteed to point to a newly created empty file.
1110 You can then use `write-region' to write new data into the file.
1112 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1114 If SUFFIX is non-nil, add that at the end of the file name."
1116 file)
1119 ;; Create temp files with strict access rights. It's easy to
1120 ;; loosen them later, whereas it's impossible to close the
1121 ;; time-window of loose permissions otherwise.
1129 temporary-file-directory)
1131 temporary-file-directory))))
1137 nil)
1139 ;; the file was somehow created by someone else between
1140 ;; `make-temp-name' and `write-region', let's try again.
1141 nil)
1142 file)
1143 ;; Reset the umask.
1147 "Change the encoding of FILE's name from CODING to NEW-CODING.
1148 The value is a new name of FILE.
1149 Signals a `file-already-exists' error if a file of the new name
1150 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1151 is non-nil. A number as fourth arg means request confirmation if
1152 the new name already exists. This is what happens in interactive
1153 use with M-x."
1156 default-file-name-coding-system))
1158 from-coding to-coding)
1160 ;; We provide the default coding only when it seems that
1161 ;; the filename is correctly decoded by the default
1162 ;; coding.
1168 filename default-coding)
1169 default-coding))
1173 ;; We provide the default coding only when a user is going to
1174 ;; change the encoding not from the default coding.
1178 filename from-coding)))
1181 filename from-coding default-coding)
1182 default-coding)))
1186 default-file-name-coding-system))
1187 ;; FILE should have been decoded by DEFAULT-CODING.
1191 ;; Suppress further encoding.
1196 newname))
1197 \f
1199 "Whether confirmation is requested before visiting a new file or buffer.
1200 If nil, confirmation is not requested.
1201 If the value is `after-completion', confirmation is only
1202 requested if the user called `minibuffer-complete' right before
1203 `minibuffer-complete-and-exit'.
1204 Any other non-nil value means to request confirmation.
1206 This affects commands like `switch-to-buffer' and `find-file'."
1214 "Whether to request confirmation before visiting a new file or buffer.
1215 The variable `confirm-nonexistent-file-or-buffer' determines the
1216 return value, which may be passed as the REQUIRE-MATCH arg to
1217 `read-buffer' or `find-file-read-args'."
1225 "Read the name of a buffer to switch to and return as a string.
1226 It is intended for `switch-to-buffer' family of commands since they
1227 need to omit the name of current buffer from the list of completions
1228 and default values."
1233 ;; Since rbts-completion-table is built dynamically, we
1234 ;; can't just add it to the default value of
1235 ;; icomplete-with-completion-tables, so we add it
1236 ;; here manually.
1241 icomplete-with-completion-tables))))
1246 "Select the buffer specified by BUFFER-OR-NAME in another window.
1247 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1248 nil. Return the buffer switched to.
1250 If called interactively, prompt for the buffer name using the
1251 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1252 determines whether to request confirmation before creating a new
1253 buffer.
1255 If BUFFER-OR-NAME is a string and does not identify an existing
1256 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1257 nil, switch to the buffer returned by `other-buffer'.
1259 Optional second argument NORECORD non-nil means do not put this
1260 buffer at the front of the list of recently selected ones.
1262 This uses the function `display-buffer' as a subroutine; see its
1263 documentation for additional customization information."
1267 same-window-buffer-names same-window-regexps)
1271 "Switch to buffer BUFFER-OR-NAME in another frame.
1272 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1273 nil. Return the buffer switched to.
1275 If called interactively, prompt for the buffer name using the
1276 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1277 determines whether to request confirmation before creating a new
1278 buffer.
1280 If BUFFER-OR-NAME is a string and does not identify an existing
1281 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1282 nil, switch to the buffer returned by `other-buffer'.
1284 Optional second arg NORECORD non-nil means do not put this
1285 buffer at the front of the list of recently selected ones.
1287 This uses the function `display-buffer' as a subroutine; see its
1288 documentation for additional customization information."
1292 same-window-buffer-names same-window-regexps)
1296 "Display buffer BUFFER in another frame.
1297 This uses the function `display-buffer' as a subroutine; see
1298 its documentation for additional customization information."
1301 same-window-buffer-names same-window-regexps
1303 new-window)
1305 ;; This may have been here in order to prevent the new frame from hiding
1306 ;; the old frame. But it does more harm than good.
1307 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1308 ;;(lower-frame (window-frame new-window))
1310 ;; This may have been here in order to make sure the old-frame gets the
1311 ;; focus. But not only can it cause an annoying flicker, with some
1312 ;; window-managers it just makes the window invisible, with no easy
1313 ;; way to recover it. --Stef
1314 ;;(make-frame-invisible (window-frame old-window))
1315 ;;(make-frame-visible (window-frame old-window))
1316 ))
1319 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1320 BODY should use the minibuffer at most once.
1321 Recursive uses of the minibuffer are unaffected (FUN is not
1322 called additional times).
1324 This macro actually adds an auxiliary function that calls FUN,
1325 rather than FUN itself, to `minibuffer-setup-hook'."
1331 ;; Clear out this hook so it does not interfere
1332 ;; with any recursive minibuffer usage.
1343 t))
1346 "Edit file FILENAME.
1347 Switch to a buffer visiting file FILENAME,
1348 creating one if none already exists.
1349 Interactively, the default if you just type RET is the current directory,
1350 but the visited file name is available through the minibuffer history:
1351 type M-n to pull it into the minibuffer.
1353 You can visit files on remote machines by specifying something
1354 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1355 also visit local files as a different user by specifying
1356 /sudo::FILE for the file name.
1357 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1358 manual, for more about this.
1360 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1361 expand wildcards (if any) and visit multiple files. You can
1362 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1364 To visit a file without any kind of conversion and without
1375 "Edit file FILENAME, in another window.
1378 an existing one. See the function `display-buffer'.
1380 Interactively, the default if you just type RET is the current directory,
1381 but the visited file name is available through the minibuffer history:
1382 type M-n to pull it into the minibuffer.
1384 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1385 expand wildcards (if any) and visit multiple files."
1398 "Edit file FILENAME, in another frame.
1401 an existing one. See the function `display-buffer'.
1403 Interactively, the default if you just type RET is the current directory,
1404 but the visited file name is available through the minibuffer history:
1405 type M-n to pull it into the minibuffer.
1407 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1408 expand wildcards (if any) and visit multiple files."
1421 "Edit the existing file FILENAME.
1423 file names with wildcards."
1432 "Edit file FILENAME but don't allow changes.
1446 value))
1449 "Edit file FILENAME in another window but don't allow changes.
1463 value))
1466 "Edit file FILENAME in another frame but don't allow changes.
1480 value))
1483 "Find file FILENAME as a replacement for the file in the next window.
1484 This command does not select that window.
1488 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1489 expand wildcards (if any) and replace the file with multiple files."
1500 "Find alternate file: " file-dir nil
1502 t))))
1510 "Find file FILENAME, select its buffer, kill previous buffer.
1511 If the current buffer now contains an empty file that you just visited
1512 \(presumably by mistake), use this command to visit the file you really want.
1516 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1517 expand wildcards (if any) and replace the file with multiple files.
1519 If the current buffer is an indirect buffer, or the base buffer
1520 for one or more indirect buffers, the other buffer(s) are not
1521 killed."
1530 "Find alternate file: " file-dir nil
1532 t)))
1547 ;; Run `kill-buffer-hook' here. It needs to happen before
1548 ;; variables like `buffer-file-name' etc are set to nil below,
1549 ;; because some of the hooks that could be invoked
1550 ;; (e.g., `save-place-to-alist') depend on those variables.
1551 ;;
1552 ;; Note that `kill-buffer-hook' is not what queries whether to
1553 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1554 ;; asks that itself. Thus, there's no need to temporarily do
1555 ;; `(set-buffer-modified-p nil)' before running this hook.
1557 ;; Okay, now we can end-of-life the old buffer.
1564 ;; This prevents us from finding the same buffer
1565 ;; if we specified the same file again.
1569 ;; Likewise for dired buffers.
1573 ;; This executes if find-file gets an error
1574 ;; and does not really find anything.
1575 ;; We put things back as they were.
1576 ;; If find-file actually finds something, we kill obuf below.
1585 ;; We already ran these; don't run them again.
1588 \f
1590 "Create a suitably named buffer for visiting FILENAME, and return it.
1591 FILENAME (sans directory) is used unchanged if that name is free;
1592 otherwise a string <2> or <3> or ... is appended to get an unused name.
1593 Spaces at the start of FILENAME (sans directory) are removed."
1602 "Create and return a buffer with a name based on NAME.
1603 Choose the buffer's name using `generate-new-buffer-name'."
1607 "Regexp to match the automounter prefix in a directory name."
1615 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1617 home directory is a root directory) and removes automounter prefixes
1618 \(see the variable `automount-dir-prefix')."
1619 ;; Get rid of the prefixes added by the automounter.
1626 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1627 ;; To fix this right, we need a `file-name-case-sensitive-p'
1628 ;; function, but we don't have that yet, so just guess.
1631 ;; If any elt of directory-abbrev-alist matches this name,
1632 ;; abbreviate accordingly.
1638 ;; Compute and save the abbreviated homedir name.
1639 ;; We defer computing this until the first time it's needed, to
1640 ;; give time for directory-abbrev-alist to be set properly.
1641 ;; We include a slash at the end, to avoid spurious matches
1642 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1649 ;; If FILENAME starts with the abbreviated homedir,
1650 ;; make it start with `~' instead.
1652 ;; If the home dir is just /, don't change it.
1655 ;; MS-DOS root directories can come with a drive letter;
1656 ;; Novell Netware allows drive letters beyond `Z:'.
1664 filename)))
1667 "List of logical names for which visiting shouldn't save the true dirname."
1672 "Return the buffer visiting file FILENAME (a string).
1673 This is like `get-file-buffer', except that it checks for any buffer
1674 visiting the same file, possibly under a different name.
1675 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1676 and others are ignored.
1677 If there is no such live buffer, return nil."
1690 found)
1700 ;; Verify this buffer's file number
1701 ;; still belongs to its file.
1704 attributes)
1708 found))))
1709 \f
1711 "Non-nil means file-visiting commands should handle wildcards.
1712 For example, if you specify `*.c', that would visit all the files
1713 whose names match the pattern."
1719 "Non-nil means suppress warning messages for symlinked files.
1720 When nil, Emacs prints a warning when visiting a file that is already
1721 visited, but with a different name. Setting this option to t
1722 suppresses this warning."
1728 "Maximum size of file above which a confirmation is requested.
1729 When nil, never request confirmation."
1736 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1737 OP-TYPE specifies the file operation being performed (for message to user)."
1747 "Read file FILENAME into a buffer and return the buffer.
1748 If a buffer exists visiting FILENAME, return that one, but
1749 verify that the file has not changed since visited or saved.
1750 The buffer is not selected, just returned to the caller.
1751 Optional second arg NOWARN non-nil means suppress any warning messages.
1752 Optional third arg RAWFILE non-nil means the file is read literally.
1753 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1754 and visit all the matching files. When wildcards are actually
1755 used and expanded, return a list of buffers that are visiting
1756 the various files."
1763 'find-directory-functions
1766 filename)))
1769 find-file-wildcards
1783 ;; Find any buffer for a file which has same truename.
1785 ;; Let user know if there is a buffer with the same truename.
1789 find-file-suppress-same-file-warnings
1793 ;; Optionally also find that buffer.
1796 ;; Check to see if the file looks uncommonly large.
1800 ;; We are using an existing buffer.
1807 ;; Certain files should be reverted automatically
1808 ;; if they have changed on disk and not in the buffer.
1816 found))
1826 "File %s changed on disk. Discard your edits? "
1831 "File %s changed on disk. Discard your edits in %s? "
1839 ;; Check if a formerly read-only file has become
1840 ;; writable and vice versa, but if the buffer agrees
1841 ;; with the new state of the file, that is ok too.
1849 buffer-file-name
1858 ;; It is confusing to ask whether to visit
1859 ;; non-literally if they have the file in
1860 ;; hexl-mode.
1866 "The file %s is already visited normally,
1867 and you have edited the buffer. Now you have asked to visit it literally,
1868 meaning no coding system handling, format conversion, or local variables.
1869 Emacs can only visit a file in one way at a time.
1871 Do you want to save the file, and visit it literally instead? "
1872 "The file %s is already visited literally,
1873 meaning no coding system handling, format conversion, or local variables.
1874 You have edited the buffer. Now you have asked to visit the file normally,
1875 but Emacs can only visit a file in one way at a time.
1882 rawfile truename number))
1886 "\
1887 Do you want to discard your changes, and visit the file literally now? "
1888 "\
1891 rawfile truename number)
1897 "The file %s is already visited normally.
1898 You have asked to visit it literally,
1899 meaning no coding system decoding, format conversion, or local variables.
1900 But Emacs can only visit a file in one way at a time.
1902 Do you want to revisit the file literally now? "
1903 "The file %s is already visited literally,
1904 meaning no coding system decoding, format conversion, or local variables.
1905 You have asked to visit it normally,
1906 but Emacs can only visit a file in one way at a time.
1911 rawfile truename number)
1914 ;; Return the buffer we are using.
1915 buf)
1916 ;; Create a new buffer.
1918 ;; find-file-noselect-1 may use a different buffer.
1920 rawfile truename number))))))
1926 ;; Needed in case we are re-visiting the file with a different
1927 ;; text representation.
1944 filename)))
1945 ;; Unconditionally set error
1955 filename)))
1956 ;; Run find-file-not-found-functions until one returns non-nil.
1958 ;; If they fail too, set error.
1960 ;; Record the file's truename, and maybe use that as visited name.
1968 ;; Set buffer's default directory to that of the file.
1970 ;; Turn off backup files for certain file names. Since
1971 ;; this is a permanent local, the major mode won't eliminate it.
1986 \f
1988 "Like `insert-file-contents', but only reads in the file literally.
1989 A buffer may be modified in several ways after reading into the buffer,
1990 to Emacs features such as format decoding, character code
1991 conversion, `find-file-hook', automatic uncompression, etc.
1993 This function ensures that none of these modifications will take place."
2001 nil))
2004 inhibit-file-name-handlers))
2017 filename)))
2018 ;; Check whether the file is uncommonly large
2029 "Insert contents of file FILENAME into buffer after point with no conversion.
2031 This function is meant for the user to run interactively.
2032 Don't call it from programs! Use `insert-file-contents-literally' instead.
2033 \(Its calling sequence is different; see its documentation)."
2038 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2043 "Visit file FILENAME with no conversion of any kind.
2044 Format conversion and character code conversion are both disabled,
2045 and multibyte characters are disabled in the resulting buffer.
2046 The major mode used is Fundamental mode regardless of the file name,
2047 and local variable specifications in the file are ignored.
2048 Automatic uncompression and adding a newline at the end of the
2049 file due to `require-final-newline' is also disabled.
2051 You cannot absolutely rely on this function to result in
2052 visiting the file literally. If Emacs already has a buffer
2053 which is visiting the file, you get the existing buffer,
2054 regardless of whether it was created literally or not.
2056 In a Lisp program, if you want to be sure of accessing a file's
2057 contents literally, you should create a temporary buffer and then read
2058 the file contents into it using `insert-file-contents-literally'."
2061 "Find file literally: " nil default-directory
2064 \f
2068 after-find-file-from-revert-buffer
2069 nomodes)
2070 "Called after finding a file and by the default revert function.
2071 Sets buffer mode, parses local variables.
2072 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2073 error in reading the file. WARN non-nil means warn if there
2074 exists an auto-save file more recent than the visited file.
2075 NOAUTO means don't mess with auto-save mode.
2076 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2077 means this call was from `revert-buffer'.
2078 Fifth arg NOMODES non-nil means don't alter the file's modes.
2079 Finishes by calling the functions in `find-file-hook'
2080 unless NOMODES is non-nil."
2083 nil
2093 ;; No need to warn if buffer is auto-saved
2094 ;; under the name of the visited file.
2096 auto-save-visited-file-name))
2099 buffer-file-name))
2119 ;; Make people do a little extra work (C-x C-q)
2120 ;; before altering a backup file.
2123 ;; When a file is marked read-only,
2124 ;; make the buffer read-only even if root is looking at it.
2132 ;; If requested, add a newline at the end of the file.
2142 view-read-only
2148 "Eval BODY and turn any error into a FORMAT message.
2149 FORMAT can have a %s escape which will be replaced with the actual error.
2150 If `debug-on-error' is set, errors are not caught, so that you can
2151 debug them.
2152 Avoid using a large BODY since it is duplicated."
2161 "Choose the major mode for this buffer automatically.
2162 Also sets up any specified local variables of the file.
2163 Uses the visited file name, the -*- line, and the local variables spec.
2165 This function is called automatically from `find-file'. In that case,
2166 we may set up the file-specified mode and local variables,
2167 depending on the value of `enable-local-variables'.
2168 In addition, if `local-enable-local-variables' is nil, we do
2169 not set local variables (though we do notice a mode specified with -*-.)
2171 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2172 or from Lisp without specifying the optional argument FIND-FILE;
2173 in that case, this function acts as if `enable-local-variables' were t."
2181 ;; Turn font lock off and on, to make sure it takes account of
2182 ;; whatever file local variables are relevant to it.
2184 ;; Font-lock-mode (now in font-core.el) can be ON when
2185 ;; font-lock.el still hasn't been loaded.
2195 "Non-nil means to try second pass through `auto-mode-alist'.
2196 This means that if the first case-sensitive search through the alist fails
2197 to find a matching major mode, a second case-insensitive search is made.
2198 On systems with case-insensitive file names, this variable is ignored,
2199 since only a single case-insensitive search through the alist is made."
2205 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2206 ;; c++-mode, java-mode and more) are added through autoload
2207 ;; directives in that file. That way is discouraged since it
2208 ;; spreads out the definition of the initial value.
2243 ;; Less common extensions come here
2244 ;; so more common ones above are found faster.
2284 ;; The list of archive file extensions should be in sync with
2285 ;; `auto-coding-alist' with `no-conversion' coding system.
2291 ;; Mailer puts message to be edited in
2292 ;; /tmp/Re.... or Message
2295 ;; some news reader is reported to use this
2304 ;; .emacs or .gnus or .viper following a directory delimiter in
2305 ;; Unix, MSDOG or VMS syntax.
2308 ;; _emacs following a directory delimiter
2309 ;; in MsDos syntax
2313 ;; Common Lisp ASDF package system.
2331 ;; Windows candidates may be opened case sensitively on Unix
2337 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2339 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2340 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2341 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2342 ;; this has lower priority to avoid matching changelog.sgml etc.
2344 ;; either user's dot-files or under /etc or some such
2346 ;; alas not all ~/.*rc files are like this
2347 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2352 ;; this contains everything twice, with space and with colon :-(
2354 ;; Get rid of any trailing .n.m and try again.
2355 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2356 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2357 ;; Using mode nil rather than `ignore' would let the search continue
2358 ;; through this list (with the shortened name) rather than start over.
2360 ;; The following should come after the ChangeLog pattern
2361 ;; for the sake of ChangeLog.1, etc.
2362 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2365 "Alist of filename patterns vs corresponding major mode functions.
2366 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2367 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2368 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2369 mode function to use. FUNCTION will be called, unless it is nil.
2371 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2372 calling FUNCTION (if it's not nil), we delete the suffix that matched
2373 REGEXP and search the list again for another match.
2375 If the file name matches `inhibit-first-line-modes-regexps',
2376 then `auto-mode-alist' is not processed.
2378 The extensions whose FUNCTION is `archive-mode' should also
2379 appear in `auto-coding-alist' with `no-conversion' coding system.
2381 See also `interpreter-mode-alist', which detects executable script modes
2382 based on the interpreters they specify to run,
2387 "Select Conf mode or XML mode according to start of file."
2397 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2398 ;; and pike-mode) are added through autoload directives in that
2399 ;; file. That way is discouraged since it spreads out the
2400 ;; definition of the initial value.
2439 "Alist mapping interpreter names to major modes.
2440 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2441 Each element looks like (INTERPRETER . MODE).
2442 If INTERPRETER matches the name of the interpreter specified in the first line
2443 of a script, mode MODE is enabled.
2451 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2452 When checking `inhibit-first-line-modes-regexps', we first discard
2458 "Regexp matching interpreters, for file mode determination.
2459 This regular expression is matched against the first line of a file
2460 to determine the file's mode in `set-auto-mode'. If it matches, the file
2461 is assumed to be interpreted by the interpreter matched by the second group
2462 of the regular expression. The mode is then determined as the mode
2466 "Alist of buffer beginnings vs. corresponding major mode functions.
2467 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2468 After visiting a file, if REGEXP matches the text at the beginning of the
2469 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2470 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2471 major mode.
2473 If FUNCTION is nil, then it is not called. (That is a way of saying
2481 ;; The < comes before the groups (but the first) to reduce backtracking.
2482 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2483 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2487 comment-re "*"
2490 . html-mode)
2492 ;; These two must come after html, because they are more general:
2497 . sgml-mode)
2500 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2501 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2502 After visiting a file, if REGEXP matches the text at the beginning of the
2503 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2504 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2505 have not specified a mode for this file.
2511 "Upper limit on `magic-mode-alist' regexp matches.
2515 "Select major mode appropriate for current buffer.
2517 To find the right major mode, this function checks for a -*- mode tag,
2518 checks if it uses an interpreter listed in `interpreter-mode-alist',
2519 matches the buffer beginning against `magic-mode-alist',
2520 compares the filename against the entries in `auto-mode-alist',
2521 then matches the buffer beginning against `magic-fallback-mode-alist'.
2523 It does not check for the `mode:' local variable in the
2524 Local Variables section of the file; for that, use `hack-local-variables'.
2526 If `enable-local-variables' is nil, this function does not check for a
2527 -*- mode tag.
2529 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2530 set the major mode only if that would change it. In other words
2531 we don't actually set it to the same mode the buffer already has."
2532 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2534 ;; Find a -*- mode tag
2541 ;; Find all specifications for the `mode:' variable
2542 ;; and execute them left to right.
2554 modes)))
2555 ;; Simple -*-MODE-*- case.
2558 modes))))
2559 ;; If we found modes to use, invoke them now, outside the save-excursion.
2567 ;; continuing would call minor modes again, toggling them off
2569 ;; If we didn't, look for an interpreter specified in the first line.
2570 ;; As a special case, allow for things like "#!/bin/env perl", which
2571 ;; finds the interpreter anywhere in $PATH.
2578 ;; Map interpreter name to a mode, signalling we're done at the
2579 ;; same time.
2581 interpreter-mode-alist))
2582 ;; If we found an interpreter mode to use, invoke it now.
2585 ;; Next try matching the buffer beginning against magic-mode-alist.
2599 ;; Next compare the filename against the entries in auto-mode-alist.
2604 ;; Remove remote file name identification.
2608 ;; Remove backup-suffixes from file name.
2611 ;; Find first matching alist entry.
2614 ;; System is case-insensitive.
2618 ;; System is case-sensitive.
2620 ;; First match case-sensitively.
2624 ;; Fallback to case-insensitive match.
2638 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2653 ;; When `keep-mode-if-same' is set, we are working on behalf of
2654 ;; set-visited-file-name. In that case, if the major mode specified is the
2655 ;; same one we already have, don't actually reset it. We don't want to lose
2656 ;; minor modes such as Font Lock.
2658 "Apply MODE and return it.
2659 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2660 any aliases and compared to current major mode. If they are the
2661 same, do nothing and return nil."
2667 mode)))
2670 "Find the -*- spec in the buffer.
2671 Call with point at the place to start searching from.
2672 If one is found, set point to the beginning
2673 and return the position of the end.
2674 Otherwise, return nil; point may be changed."
2677 ;; Don't look for -*- if this file name matches any
2678 ;; of the regexps in inhibit-first-line-modes-regexps.
2686 sufs)
2694 ;; If the file begins with "#!"
2695 ;; (exec interpreter magic), look
2696 ;; for mode frobs in the first two
2697 ;; lines. You cannot necessarily
2698 ;; put them in the first line of
2699 ;; such a file without screwing up
2700 ;; the interpreter invocation.
2701 ;; The same holds for
2702 ;; '\"
2703 ;; in man pages (preprocessor
2704 ;; magic for the `man' program).
2715 end))))
2716 \f
2717 ;;; Handling file local variables
2721 file-local-variables-alist dir-local-variables-alist)
2726 "Normal hook run after processing a file's local variables specs.
2727 Major modes can use this to examine user-specified local variables
2731 "List variable-value pairs that are considered safe.
2732 Each element is a cons cell (VAR . VAL), where VAR is a variable
2733 symbol and VAL is a value that is considered safe."
2734 :risky t
2741 "Expressions that are considered safe in an `eval:' local variable.
2742 Add expressions to this list if you want Emacs to evaluate them, when
2743 they appear in an `eval' local variable specification, without first
2744 asking you for confirmation."
2745 :risky t
2750 ;; Risky local variables:
2753 buffer-auto-save-file-name
2754 buffer-file-name
2755 buffer-file-truename
2756 buffer-undo-list
2757 debugger
2758 default-text-properties
2759 eval
2760 exec-directory
2761 exec-path
2762 file-name-handler-alist
2763 frame-title-format
2764 global-mode-string
2765 header-line-format
2766 icon-title-format
2767 inhibit-quit
2768 load-path
2769 max-lisp-eval-depth
2770 max-specpdl-size
2771 minor-mode-map-alist
2772 minor-mode-overriding-map-alist
2773 mode-line-format
2774 mode-name
2775 overriding-local-map
2776 overriding-terminal-local-map
2777 process-environment
2778 standard-input
2779 standard-output
2780 unread-command-events))
2782 ;; Safe local variables:
2783 ;;
2784 ;; For variables defined by major modes, the safety declarations can go into
2785 ;; the major mode's file, since that will be loaded before file variables are
2786 ;; processed.
2787 ;;
2788 ;; For variables defined by minor modes, put the safety declarations in the
2789 ;; file defining the minor mode after the defcustom/defvar using an autoload
2790 ;; cookie, e.g.:
2791 ;;
2792 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2793 ;;
2794 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2795 ;; minor mode file may not be loaded yet.
2796 ;;
2797 ;; For variables defined in the C source code the declaration should go here:
2818 "Alist of file-local variable settings in the current buffer.
2819 Each element in this list has the form (VAR . VALUE), where VAR
2820 is a file-local variable (a symbol) and VALUE is the value
2821 specified. The actual value in the buffer may differ from VALUE,
2826 "Alist of directory-local variable settings in the current buffer.
2827 Each element in this list has the form (VAR . VALUE), where VAR
2828 is a directory-local variable (a symbol) and VALUE is the value
2829 specified in .dir-locals.el. The actual value in the buffer
2830 may differ from VALUE, if it is changed by the major or minor modes,
2835 "Normal hook run before setting file-local variables.
2836 It is called after checking for unsafe/risky variables and
2837 setting `file-local-variables-alist', and before applying the
2838 variables stored in `file-local-variables-alist'. A hook
2839 function is allowed to change the contents of this alist.
2841 This hook is called only if there is at least one file-local
2845 "Get confirmation before setting up local variable values.
2846 ALL-VARS is the list of all variables to be set up.
2847 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2848 RISKY-VARS is the list of those that are marked as risky.
2849 DIR-NAME is a directory name if these settings come from
2850 directory-local variables, or nil otherwise."
2852 nil
2858 prompt char)
2868 ", and variables that are risky (**)."
2875 y -- to apply the local variables list.
2879 ! -- to apply the local variables list, and permanently mark these
2891 ;; Make strings with embedded whitespace easier to read.
2899 ""
2906 done)
2915 ;; read-event returns -1 if we are in a kbd
2916 ;; macro and there are no more events in the
2917 ;; macro. In that case, attempt to get an
2918 ;; event interactively.
2926 ;; When this is called from desktop-restore-file-buffer,
2927 ;; coding-system-for-read may be non-nil. Reset it before
2928 ;; writing to .emacs.
2932 'safe-local-variable-values
2933 safe-local-variable-values))))
2940 "Return local variables specified in the -*- line.
2941 Ignore any specification for `mode:' and `coding:';
2942 `set-auto-mode' should already have handled `mode:',
2943 `set-auto-coding' should already have handled `coding:'.
2945 If MODE-ONLY is non-nil, all we do is check whether the major
2946 mode is specified, returning t if it is specified. Otherwise,
2947 return an alist of elements (VAR . VAL), where VAR is a variable
2948 and VAL is the specified value."
2952 result mode-specified)
2953 ;; Parse the -*- line into the RESULT alist.
2954 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2956 nil)
2958 ;; Simple form: "-*- MODENAME -*-". Already handled.
2960 nil)
2962 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2963 ;; (last ";" is optional).
2968 ;; There used to be a downcase here,
2969 ;; but the manual didn't say so,
2970 ;; and people want to set var names that aren't all lc.
2976 ;; It is traditional to ignore
2977 ;; case when checking for `mode' in set-auto-mode,
2978 ;; so we must do that here as well.
2979 ;; That is inconsistent, but we're stuck with it.
2980 ;; The same can be said for `coding' in set-auto-coding.
2986 'eval
2993 mode-specified
2994 result))))
2997 "Filter local variable settings, querying the user if necessary.
2998 VARIABLES is the alist of variable-value settings. This alist is
2999 filtered based on the values of `ignored-local-variables',
3000 `enable-local-eval', `enable-local-variables', and (if necessary)
3001 user interaction. The results are added to
3002 `file-local-variables-alist', without applying them.
3003 DIR-NAME is a directory name if these settings come from
3004 directory-local variables, or nil otherwise."
3005 ;; Find those variables that we may want to save to
3006 ;; `safe-local-variable-values'.
3012 ;; Ignore any variable in `ignored-local-variables'.
3013 nil)
3014 ;; Obey `enable-local-eval'.
3022 ;; Ignore duplicates (except `mode') in the present list.
3024 ;; Accept known-safe variables.
3028 ;; The variable is either risky or unsafe:
3035 ;; Query, unless all vars are safe or user wants no querying.
3041 risky-vars dir-name))
3052 "Parse and put into effect this buffer's local variables spec.
3053 If MODE-ONLY is non-nil, all we do is check whether the major mode
3054 is specified, returning t if it is specified."
3057 result)
3064 ;; Look for "Local variables:" line in last page.
3072 ;; suffix is what comes after "local variables:" in its line.
3073 ;; prefix is what comes before "local variables:" in its line.
3083 beg)
3087 endpos
3093 nil t))
3094 ;; This used to be an error, but really all it means is
3095 ;; that this may simply not be a local-variables section,
3096 ;; so just ignore it.
3106 ;; Discard the prefix.
3111 ;; Discard the suffix.
3119 ;; Find the variable name; strip whitespace.
3128 val)
3129 ;; Read the variable value.
3140 'eval
3145 ;; Now we've read all the local variables.
3146 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3148 ;; Otherwise, set the variables.
3155 ;; Any 'evals must run in the Right sequence.
3164 "Non-nil if SYM is safe as a file-local variable with value VAL.
3165 It is safe if any of these conditions are met:
3167 * There is a matching entry (SYM . VAL) in the
3168 `safe-local-variable-values' user option.
3170 * The `safe-local-variable' property of SYM is a function that
3171 evaluates to a non-nil value with VAL as an argument."
3177 "Non-nil if SYM could be dangerous as a file-local variable.
3178 It is dangerous if either of these conditions are met:
3180 * Its `risky-local-variable' property is non-nil.
3186 ;; If this is an alias, check the base name.
3206 "Return t if it is safe to eval EXP when it is found in a file."
3208 ;; Detect certain `put' expressions.
3215 lisp-indent-function
3216 scheme-indent-function))
3217 ;; Only allow safe values (not functions).
3222 ;; Only allow indirect form specs.
3223 ;; During bootstrapping, edebug-basic-spec might not be
3224 ;; defined yet.
3228 ;; Allow expressions that the user requested.
3230 ;; Certain functions can be allowed with safe arguments
3231 ;; or can specify verification functions to try.
3239 ok))
3247 ok)))))))
3250 "Set local variable VAR with value VAL.
3251 If VAR is `mode', call `VAL-mode' as a function unless it's
3252 already the major mode."
3259 ;; A minor mode must be passed an argument.
3260 ;; Otherwise, if the user enables the minor mode in a
3261 ;; major mode hook, this would toggle it off.
3267 ;; Make sure the string has no text properties.
3268 ;; Some text properties can get evaluated in various ways,
3269 ;; so it is risky to put them on with a local variable list.
3273 \f
3274 ;;; Handling directory-local variables, aka project settings.
3280 "List of cached directory roots for directory-local variable classes.
3281 Each element in this list has the form (DIR CLASS MTIME).
3282 DIR is the name of the directory.
3283 CLASS is the name of a variable class (a symbol).
3284 MTIME is the recorded modification time of the directory-local
3285 variables file associated with this entry. This time is a list
3286 of two integers (the same format as `file-attributes'), and is
3287 used to test whether the cache entry is still valid.
3288 Alternatively, MTIME can be nil, which means the entry is always
3292 "Return the variable list for CLASS."
3296 "Collect directory-local variables from MODE-VARIABLES.
3297 VARIABLES is the initial list of variables.
3298 Returns the new list."
3303 ;; If variables are specified more than once, only use the last. (Why?)
3304 ;; The pseudo-variables mode and eval are different (bug#3430).
3307 ;; Need a new cons in case we setcdr later.
3311 "Collect entries from CLASS-VARIABLES into VARIABLES.
3312 ROOT is the root directory of the project.
3313 Return the new variables list."
3321 ;; Don't include this in the previous condition, because we
3322 ;; want to filter all strings before the next condition.
3334 "Declare that the DIRECTORY root is an instance of CLASS.
3335 DIRECTORY is the name of a directory, a string.
3336 CLASS is the name of a project class, a symbol.
3337 MTIME is either the modification time of the directory-local
3338 variables file that defined this class, or nil.
3340 When a file beneath DIRECTORY is visited, the mode-specific
3341 variables from CLASS are applied to the buffer. The variables
3342 for a class are defined using `dir-locals-set-class-variables'."
3349 "Map the type CLASS to a list of variable settings.
3350 CLASS is the project class, a symbol. VARIABLES is a list
3351 that declares directory-local variables for the class.
3352 An element in VARIABLES is either of the form:
3353 (MAJOR-MODE . ALIST)
3354 or
3355 (DIRECTORY . LIST)
3357 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3358 whose elements are of the form (VARIABLE . VALUE).
3360 In the second form, DIRECTORY is a directory name (a string), and
3361 LIST is a list of the form accepted by the function.
3363 When a file is visited, the file's class is found. A directory
3364 may be assigned a class using `dir-locals-set-directory-class'.
3365 Then variables are set in the file's buffer according to the
3366 class' LIST. The list is processed in order.
3368 * If the element is of the form (MAJOR-MODE . ALIST), and the
3369 buffer's major mode is derived from MAJOR-MODE (as determined
3370 by `derived-mode-p'), then all the variables in ALIST are
3371 applied. A MAJOR-MODE of nil may be used to match any buffer.
3372 `make-local-variable' is called for each variable before it is
3373 set.
3375 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3376 is an initial substring of the file's directory, then LIST is
3377 applied by recursively following these rules."
3384 "File that contains directory-local variables.
3385 It has to be constant to enforce uniform values
3389 "Find the directory-local variables for FILE.
3390 This searches upward in the directory tree from FILE.
3391 If the directory root of FILE has been registered in
3392 `dir-locals-directory-cache' and the directory-local variables
3393 file has not been modified, return the matching entry in
3394 `dir-locals-directory-cache'.
3395 Otherwise, if a directory-local variables file is found, return
3396 the file name.
3397 Otherwise, return nil."
3402 dir-locals-file))
3405 ;; `locate-dominating-file' may have abbreviated the name.
3408 ;; Find the best cached value in `dir-locals-directory-cache'.
3421 ;; Check the validity of the cache.
3426 ;; This cache entry is OK.
3427 dir-elt
3428 ;; This cache entry is invalid; clear it.
3431 locals-file)
3432 locals-file))))
3435 "Load a variables FILE and register a new class and instance.
3436 FILE is the name of the file holding the variables to apply.
3437 The new class name is the same as the directory in which FILE
3438 is found. Returns the new class name."
3448 class-name)))
3451 "Read per-directory local variables for the current buffer.
3452 Store the directory-local variables in `dir-local-variables-alist'
3453 and `file-local-variables-alist', without applying them."
3456 ;; Find the variables file.
3462 (setq dir-name (if (buffer-file-name) (file-name-directory (buffer-file-name)) default-directory))
3483 \f
3486 However, the mode will not be changed if
3487 \(1) a local variables list or the `-*-' line specifies a major mode, or
3489 \ not suitable for ordinary files, or
3490 \(3) the new file name does not particularly specify any mode."
3495 "Change name of file visited in current buffer to FILENAME.
3496 This also renames the buffer to correspond to the new file.
3497 The next time the buffer is saved it will go in the newly specified file.
3498 FILENAME nil or an empty string means mark buffer as not visiting any file.
3499 Remember to delete the initial contents of the minibuffer
3500 if you wish to pass an empty string as the argument.
3502 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3503 confirmation in the case where another buffer is already visiting FILENAME.
3505 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3506 the old visited file has been renamed to the new name FILENAME."
3514 nil
3529 filename)))
3539 ;; If new-name == old-name, renaming would add a spurious <2>
3540 ;; and it's considered as a feature in rename-buffer.
3546 ;; Abbreviate the file names of the buffer.
3555 nil)))
3556 ;; write-file-functions is normally used for things like ftp-find-file
3557 ;; that visit things that are not local files as if they were files.
3558 ;; Changing to visit an ordinary local file instead should flush the hook.
3563 ;; If buffer was read-only because of version control,
3564 ;; that reason is gone now, so make it writable.
3568 ;; Turn off backup files for certain file names.
3569 ;; Since this is a permanent local, the major mode won't eliminate it.
3571 backup-enable-predicate
3577 ;; If auto-save was not already on, turn it on if appropriate.
3581 ;; If auto save is on, start using a new name.
3582 ;; We deliberately don't rename or delete the old auto save
3583 ;; for the old visited file name. This is because perhaps
3584 ;; the user wants to save the new state and then compare with the
3585 ;; previous state from the auto save file.
3588 ;; Rename the old auto save file if any.
3595 ;; Update the major mode, if the file name determines it.
3597 ;; Don't change the mode if it is special.
3600 ;; Don't change the mode if the local variable list specifies it.
3606 "Write current buffer into file FILENAME.
3607 This makes the buffer visit that file, and marks it as not modified.
3609 If you specify just a directory name as FILENAME, that means to use
3610 the default file name but in that directory. You can also yank
3611 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3613 If the buffer is not already visiting a file, the default file name
3614 for the output file is the buffer name.
3616 If optional second arg CONFIRM is non-nil, this function
3617 asks for confirmation before overwriting an existing file.
3618 Interactively, confirmation is required unless you supply a prefix argument."
3619 ;; (interactive "FWrite file: ")
3623 nil nil nil nil)
3627 default-directory)
3628 nil nil))
3632 ;; If arg is just a directory,
3633 ;; use the default file name, but in that directory.
3644 ;; Make buffer writable if file is writable.
3649 ;; It's likely that the VC status at the new location is different from
3650 ;; the one at the old location.
3652 \f
3654 "Make a backup of the disk file visited by the current buffer, if appropriate.
3655 This is normally done before saving the buffer the first time.
3657 A backup may be done by renaming or by copying; see documentation of
3658 variable `make-backup-files'. If it's done by renaming, then the file is
3659 no longer accessible under its old name.
3661 The value is non-nil after a backup was made by renaming.
3662 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3663 MODES is the result of `file-modes' on the original
3664 file; this means that the caller, after saving the buffer, should change
3665 the modes of the new file to agree with the old modes.
3666 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3667 file; this means that the caller, after saving the buffer, should change
3668 the SELinux context of the new file to agree with the old context.
3669 BACKUPNAME is the backup file name, which is the old file renamed."
3676 backup-info backupname targets setmodes)
3677 ;; If specified name is a symbolic link, chase it to the target.
3678 ;; Thus we make the backups in the directory where the real file is.
3683 ;; (if (file-directory-p buffer-file-name)
3684 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3688 ;; If have old versions to maybe delete,
3689 ;; ask the user to confirm now, before doing anything.
3690 ;; But don't actually delete til later.
3695 real-file-name)))))
3698 ;; Actually write the back up file.
3701 ; (file-symlink-p buffer-file-name)
3702 backup-by-copying
3703 ;; Don't rename a suid or sgid file.
3718 ;; rename-file should delete old backup.
3722 ;; If trouble writing the backup, write it in ~.
3727 backupname)
3731 ;; Now delete the old versions, if desired.
3738 setmodes)
3745 ;; Create temp files with strict access rights. It's easy to
3746 ;; loosen them later, whereas it's impossible to close the
3747 ;; time-window of loose permissions otherwise.
3750 ;; Try to overwrite old backup first.
3758 nil)
3760 ;; The file was somehow created by someone else between
3761 ;; `delete-file' and `copy-file', so let's try again.
3762 ;; rms says "I think there is also a possible race
3763 ;; condition for making backup files" (emacs-devel 20070821).
3764 nil)))
3765 ;; Reset the umask.
3773 "Return file NAME sans backup versions or strings.
3774 This is a separate procedure so your site-init or startup file can
3775 redefine it.
3776 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3777 we do not remove backup version numbers, only true file version numbers."
3789 "Return t if deleting FILE and rewriting it would preserve the owner."
3794 ;; Return t if the file doesn't exist, since it's true that no
3795 ;; information would be lost by an (attempted) delete and create.
3801 The extension, in a file name, is the part that follows the last `.',
3802 except that a leading `.', if any, doesn't count."
3805 directory)
3809 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3810 ;; we don't want to expand it.
3813 filename))))
3817 The extension, in a file name, is the part that follows the last `.',
3818 excluding version numbers and backup suffixes,
3819 except that a leading `.', if any, doesn't count.
3820 Return nil for extensionless file names such as `foo'.
3821 Return the empty string for file names such as `foo.'.
3823 If PERIOD is non-nil, then the returned value includes the period
3824 that delimits the extension, and if FILENAME has no extension,
3835 "A function to use instead of the default `make-backup-file-name'.
3836 A value of nil gives the default `make-backup-file-name' behavior.
3838 This could be buffer-local to do something special for specific
3839 files. If you define it, you may need to change `backup-file-name-p'
3840 and `file-name-sans-versions' too.
3842 See also `backup-directory-alist'."
3848 "Alist of filename patterns and backup directory names.
3849 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3850 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3851 relative or absolute. If it is absolute, so that all matching files
3852 are backed up into the same directory, the file names in this
3853 directory will be the full name of the file backed up with all
3854 directory separators changed to `!' to prevent clashes. This will not
3855 work correctly if your filesystem truncates the resulting name.
3857 For the common case of all backups going into one directory, the alist
3859 directory name.
3861 If this variable is nil, or it fails to match a filename, the backup
3862 is made in the original file's directory.
3864 On MS-DOS filesystems without long names this variable is always
3865 ignored."
3871 "Default `backup-enable-predicate' function.
3872 Checks for files in `temporary-file-directory',
3873 `small-temporary-file-directory', and /tmp."
3876 ;; Directory is under temporary-file-directory.
3881 ;; Directory is under /tmp.
3886 0 nil
3888 ;; Directory is under small-temporary-file-directory.
3893 "Create the non-numeric backup file name for FILE.
3894 Normally this will just be the file's name with `~' appended.
3895 Customization hooks are provided as follows.
3897 If the variable `make-backup-file-name-function' is non-nil, its value
3898 should be a function which will be called with FILE as its argument;
3899 the resulting name is used.
3901 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3902 the documentation of that variable. If the directory for the backup
3903 doesn't exist, it is created."
3917 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3919 elt backup-directory abs-backup-directory)
3924 alist nil)))
3925 ;; If backup-directory is relative, it should be relative to the
3926 ;; file's directory. By expanding explicitly here, we avoid
3927 ;; depending on default-directory.
3936 abs-backup-directory nil))))
3938 file
3942 ;; Normalize DOSish file names: downcase the drive
3943 ;; letter, if any, and replace the leading "x:" with
3944 ;; "/drive_x".
3947 ;; Replace any invalid file-name characters (for the
3948 ;; case of backing up remote files).
3952 "drive_"
3955 ""
3958 ;; Make the name unique by substituting directory
3959 ;; separators. It may not really be worth bothering about
3960 ;; doubling `!'s in the original name...
3965 backup-directory))
3970 "Return non-nil if FILE is a backup file name (numeric or not).
3971 This is a separate function so you can redefine it for customization.
3972 You may need to redefine `file-name-sans-versions' as well."
3977 ;; This is used in various files.
3978 ;; The usage of backup-extract-version-start is not very clean,
3979 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3981 "Given the name of a numeric backup file, FN, return the backup number.
3982 Uses the free variable `backup-extract-version-start', whose value should be
3983 the index in the name where the version number begins."
3990 "Find a file name for a backup file FN, and suggestions for deletions.
3991 Value is a list whose car is the name for the backup file
3992 and whose cdr is a list of old versions to consider deleting now.
3993 If the value is nil, don't make a backup.
3994 Uses `backup-directory-alist' in the same way as does
3995 `make-backup-file-name'."
3997 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4001 ;; We don't support numbered backups on plain MS-DOS
4002 ;; when long file names are unavailable.
4012 possibilities deserve-versions-p versions)
4015 base-versions
4018 possibilities)
4019 #'<)
4024 kept-old-versions
4025 kept-new-versions
4032 ;; Delete nothing if there is overflow
4033 ;; in the number of versions to keep.
4039 v))))))))))
4042 "Return number of names file FILENAME has."
4045 ;; (defun file-relative-name (filename &optional directory)
4046 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4047 ;; This function returns a relative file name which is equivalent to FILENAME
4048 ;; when used with that default directory as the default.
4049 ;; If this is impossible (which can happen on MSDOS and Windows
4050 ;; when the file name and directory use different drive names)
4051 ;; then it returns FILENAME."
4052 ;; (save-match-data
4053 ;; (let ((fname (expand-file-name filename)))
4054 ;; (setq directory (file-name-as-directory
4055 ;; (expand-file-name (or directory default-directory))))
4056 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4057 ;; ;; drive names, they can't be relative, so return the absolute name.
4058 ;; (if (and (or (eq system-type 'ms-dos)
4059 ;; (eq system-type 'cygwin)
4060 ;; (eq system-type 'windows-nt))
4061 ;; (not (string-equal (substring fname 0 2)
4062 ;; (substring directory 0 2))))
4063 ;; filename
4064 ;; (let ((ancestor ".")
4065 ;; (fname-dir (file-name-as-directory fname)))
4066 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4067 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4068 ;; (setq directory (file-name-directory (substring directory 0 -1))
4069 ;; ancestor (if (equal ancestor ".")
4070 ;; ".."
4071 ;; (concat "../" ancestor))))
4072 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4073 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4074 ;; ;; We matched within FNAME's directory part.
4075 ;; ;; Add the rest of FNAME onto ANCESTOR.
4076 ;; (let ((rest (substring fname (match-end 0))))
4077 ;; (if (and (equal ancestor ".")
4078 ;; (not (equal rest "")))
4079 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4080 ;; rest
4081 ;; (concat (file-name-as-directory ancestor) rest)))
4082 ;; ;; We matched FNAME's directory equivalent.
4083 ;; ancestor))))))
4086 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4087 This function returns a relative file name which is equivalent to FILENAME
4088 when used with that default directory as the default.
4089 If FILENAME and DIRECTORY lie on different machines or on different drives
4090 on a DOS/Windows machine, it returns FILENAME in expanded form."
4094 default-directory))))
4100 ;; Test for different drives on DOS/Windows
4102 ;; Should `cygwin' really be included here? --stef
4105 ;; Test for different remote file system identification
4107 filename
4113 directory nil nil case-fold-search))
4115 directory nil nil case-fold-search))))
4118 ".."
4120 ;; Now ancestor is empty, or .., or ../.., etc.
4122 directory nil nil case-fold-search))
4123 ;; We matched within FILENAME's directory part.
4124 ;; Add the rest of FILENAME onto ANCESTOR.
4127 ;; But don't bother with ANCESTOR if it would give us `./'.
4128 rest
4130 ;; We matched FILENAME's directory equivalent.
4131 ancestor))))))
4132 \f
4134 "Save current buffer in visited file if modified.
4135 Variations are described below.
4137 By default, makes the previous version into a backup file
4138 if previously requested or if this is the first save.
4140 to become a backup when the next save is done.
4142 unconditionally makes the previous version into a backup file.
4144 to become a backup when the next save is done,
4145 and unconditionally makes the previous version into a backup file.
4147 With a numeric argument of 0, never make the previous version
4148 into a backup file.
4150 If a file's name is FOO, the names of its numbered backup versions are
4151 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4152 Numeric backups (rather than FOO~) will be made if value of
4153 `version-control' is not the atom `never' and either there are already
4154 numeric versions of the file being backed up, or `version-control' is
4155 non-nil.
4156 We don't want excessive versions piling up, so there are variables
4157 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4158 and `kept-new-versions', which tells how many newest versions to keep.
4159 Defaults are 2 old versions and 2 new.
4160 `dired-kept-versions' controls dired's clean-directory (.) command.
4161 If `delete-old-versions' is nil, system will query user
4162 before trimming versions. Otherwise it does it silently.
4164 If `vc-make-backup-files' is nil, which is the default,
4165 no backup files are made for files managed by version control.
4166 (This is because the version control system itself records previous versions.)
4168 See the subroutine `basic-save-buffer' for more information."
4174 ;; We used to display the message below only for files > 50KB, but
4175 ;; then Rmail-mbox never displays it due to buffer swapping. If
4176 ;; the test is ever re-introduced, be sure to handle saving of
4177 ;; Rmail files.
4184 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4185 Normally delete only if the file was written by this Emacs since
4186 the last real save, but optional arg FORCE non-nil means delete anyway."
4200 "Normal hook that is run before a buffer is saved to its file."
4206 "Normal hook that is run after a buffer is saved to its file."
4212 "If non-nil, use this coding system for saving the buffer.
4213 More precisely, use this coding system in place of the
4214 value of `buffer-file-coding-system', when saving the buffer.
4215 Calling `write-region' for any purpose other than saving the buffer
4216 will still use `buffer-file-coding-system'; this variable has no effect
4223 "Save the current buffer in its visited file, if it has been modified.
4224 The hooks `write-contents-functions' and `write-file-functions' get a chance
4225 to do the job of saving; if they do not, then the buffer is saved in
4226 the visited file in the usual way.
4227 Before and after saving the buffer, this function runs
4228 `before-save-hook' and `after-save-hook', respectively."
4231 ;; In an indirect buffer, save its base buffer instead.
4236 setmodes)
4237 ;; If buffer has no file name, ask user for one.
4244 ;; Signal an error if the user specified the name of an
4245 ;; existing directory.
4248 filename))
4250 ;; Signal an error if the specified name refers to a
4251 ;; non-existing directory.
4281 ;; Support VC version backups.
4287 ;; If a hook returned t, file is already "written".
4288 ;; Otherwise, write it the usual way now.
4290 ;; Now we have saved the current buffer. Let's make sure
4291 ;; that buffer-file-coding-system is fixed to what
4292 ;; actually used for saving by binding it locally.
4304 ;; If the auto-save file was recent before this command,
4305 ;; delete it now.
4307 ;; Support VC `implicit' locking.
4312 ;; This does the "real job" of writing a buffer into its visited file
4313 ;; and making a backup file. This is what is normally done
4314 ;; but inhibited if one of write-file-functions returns non-nil.
4315 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4327 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4341 buffer-file-name)))
4355 ;; Write temp name, then rename it.
4356 ;; This requires write access to the containing dir,
4357 ;; which is why we don't try it if we don't have that access.
4359 tempname succeed
4362 ;; Create temp files with strict access rights. It's easy to
4363 ;; loosen them later, whereas it's impossible to close the
4364 ;; time-window of loose permissions otherwise.
4369 ;; Try various temporary names.
4370 ;; This code follows the example of make-temp-file,
4371 ;; but it calls write-region in the appropriate way
4372 ;; for saving the buffer.
4378 ;; Pass in nil&nil rather than point-min&max
4379 ;; cause we're saving the whole buffer.
4380 ;; write-region-annotate-functions may use it.
4382 tempname nil realname
4384 nil)
4386 ;; The file was somehow created by someone else between
4387 ;; `make-temp-name' and `write-region', let's try again.
4388 nil)
4390 ;; Reset the umask.
4392 ;; If we failed, restore the buffer's modtime.
4395 ;; Since we have created an entirely new file,
4396 ;; make sure it gets the right permission bits set.
4401 buffer-file-name)))
4402 ;; We succeeded in writing the temp file,
4403 ;; so rename it.
4405 ;; If file not writable, see if we can make it writable
4406 ;; temporarily while we write it.
4407 ;; But no need to do so if we have just backed it up
4408 ;; (setmodes is set) because that says we're superseding.
4410 ;; Change the mode back, after writing.
4413 buffer-file-name))
4419 ;; Pass in nil&nil rather than point-min&max to indicate
4420 ;; we're saving the buffer rather than just a region.
4421 ;; write-region-annotate-functions may make us of it.
4423 buffer-file-name nil t buffer-file-truename)
4425 ;; If we get an error writing the new file, and we made
4426 ;; the backup by renaming, undo the backing-up.
4431 setmodes))
4434 "View the differences between BUFFER and its associated file.
4435 This requires the external program `diff' to be in your `exec-path'."
4449 ;; Display that message for 1 second so that user can read it
4450 ;; in the minibuffer.
4452 ;; return always nil, so that save-buffers-kill-emacs will not move
4453 ;; over to the next unsaved buffer when calling `d'.
4454 nil)
4457 `((?\C-r
4464 ;; Return nil to ask about BUF again.
4465 nil)
4477 ;; Return nil to ask about BUF again.
4478 nil)
4488 "Save some modified file-visiting buffers. Asks user about each one.
4489 You can answer `y' to save, `n' not to save, `C-r' to look at the
4490 buffer in question with `view-buffer' before deciding or `d' to
4491 view the differences using `diff-buffer-with-file'.
4493 Optional argument (the prefix) non-nil means save all with no questions.
4494 Optional second argument PRED determines which buffers are considered:
4495 If PRED is nil, all the file-visiting buffers are considered.
4496 If PRED is t, then certain non-file buffers will also be considered.
4497 If PRED is a zero-argument function, it indicates for each buffer whether
4498 to consider it or not when called with that buffer current.
4500 See `save-some-buffers-action-alist' if you want to
4501 change the additional actions you can take on files."
4505 files-done abbrevs-done)
4507 ;; First save any buffers that we're supposed to save unconditionally.
4508 ;; That way the following code won't ask about them.
4513 ;; Ask about those buffers that merit it,
4514 ;; and record the number thus saved.
4518 ;; Note that killing some buffers may kill others via
4519 ;; hooks (e.g. Rmail and its viewing buffer).
4532 t
4544 save-some-buffers-action-alist))
4545 ;; Maybe to save abbrevs, and record whether
4546 ;; we either saved them or asked to.
4552 abbrev-file-name)))
4554 ;; Don't keep bothering user if he says no.
4559 "(Some special files were saved without asking)"
4561 \f
4563 "Mark current buffer as unmodified, not needing to be saved.
4566 It is not a good idea to use this function in Lisp programs, because it
4567 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4574 "Change whether this buffer is read-only.
4575 With prefix argument ARG, make the buffer read-only if ARG is
4576 positive, otherwise make it writable. If buffer is read-only
4577 and `view-read-only' is non-nil, enter view mode."
4582 nil ; do nothing.
4583 ;; Toggle.
4590 ;; If view-mode is already active, `view-mode-enter' is a nop.
4602 "Insert contents of file FILENAME into buffer after point.
4603 Set mark after the inserted text.
4605 This function is meant for the user to run interactively.
4606 Don't call it from programs! Use `insert-file-contents' instead.
4607 \(Its calling sequence is different; see its documentation)."
4612 "Append the contents of the region to the end of file FILENAME.
4613 When called from a function, expects three arguments,
4614 START, END and FILENAME. START and END are normally buffer positions
4615 specifying the part of the buffer to write.
4616 If START is nil, that means to use the entire buffer contents.
4617 If START is a string, then output that string to the file
4618 instead of any buffer contents; END is ignored.
4620 This does character code conversion and applies annotations
4621 like `write-region' does."
4626 "Return most recent backup file for FILENAME or nil if no backups exist."
4627 ;; `make-backup-file-name' will get us the right directory for
4628 ;; ordinary or numeric backups. It might create a directory for
4629 ;; backups as a side-effect, according to `backup-directory-alist'.
4636 tem)
4645 newest))
4648 "Rename current buffer to a similar name not already taken.
4649 This function is useful for creating multiple shell process buffers
4650 or multiple mail buffers, etc."
4658 ;; If the existing buffer name has a <NNN>,
4659 ;; which isn't part of the file name (if any),
4660 ;; then get rid of that.
4666 "Create the directory DIR and optionally any nonexistent parent dirs.
4667 If DIR already exists as a directory, signal an error, unless
4668 PARENTS is non-nil.
4670 Interactively, the default choice of directory to create is the
4671 current buffer's default directory. That is useful when you have
4672 visited a file in a nonexistent directory.
4674 Noninteractively, the second (optional) argument PARENTS, if
4675 non-nil, says whether to create parent directories that don't
4676 exist. Interactively, this happens by default."
4679 nil nil)
4680 t))
4681 ;; If default-directory is a remote directory,
4682 ;; make sure we find its make-directory handler.
4690 create-list)
4692 ;; If directory is its own parent, then we can't
4693 ;; keep looping forever
4708 "Delete the directory named DIRECTORY. Does not follow symlinks.
4709 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4710 TRASH non-nil means to trash the directory instead, provided
4711 `delete-by-moving-to-trash' is non-nil.
4713 When called interactively, TRASH is t if no prefix argument is
4714 given. With a prefix argument, TRASH is nil."
4721 "Move directory to trash: "
4723 default-directory default-directory nil nil))))
4729 nil)
4731 ;; If default-directory is a remote directory, make sure we find its
4732 ;; delete-directory handler.
4739 ;; Only move non-empty dir to trash if recursive deletion was
4740 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4741 ;; case, where the operation fails in delete-directory-internal.
4742 ;; As `move-file-to-trash' trashes directories (empty or
4743 ;; otherwise) as a unit, we do not need to recurse here.
4745 ;; Check if directory is empty apart from "." and "..".
4750 ;; Otherwise, call outselves recursively if needed.
4754 ;; This test is equivalent to
4755 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4756 ;; but more efficient
4760 ;; We do not want to delete "." and "..".
4766 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4767 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4769 This function always sets the file modes of the output files to match
4770 the corresponding input file.
4772 The third arg KEEP-TIME non-nil means give the output files the same
4773 last-modified time as the old ones. (This works on only some systems.)
4775 A prefix arg makes KEEP-TIME non-nil.
4777 Noninteractively, the last argument PARENTS says whether to
4778 create parent directories if they don't exist. Interactively,
4779 this happens by default."
4786 default-directory default-directory nil nil)
4787 current-prefix-arg t)))
4788 ;; If default-directory is a remote directory, make sure we find its
4789 ;; copy-directory handler.
4795 ;; Compute target name.
4800 ;; Copy recursively.
4812 ;; We do not want to copy "." and "..".
4815 ;; Set directory attributes.
4819 \f
4822 "Function to use to revert this buffer, or nil to do the default.
4823 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4828 "Function to use to insert contents when reverting this buffer.
4829 Gets two args, first the nominal file name to use,
4830 and second, t if reading the auto-save file.
4835 "Function to check whether a non-file buffer needs reverting.
4836 This should be a function with one optional argument NOCONFIRM.
4837 Auto Revert Mode passes t for NOCONFIRM. The function should return
4838 non-nil if the buffer should be reverted. A return value of
4839 `fast' means that the need for reverting was not checked, but
4840 that reverting the buffer is fast. The buffer is current when
4841 this function is called.
4843 The idea behind the NOCONFIRM argument is that it should be
4844 non-nil if the buffer is going to be reverted without asking the
4845 user. In such situations, one has to be careful with potentially
4846 time consuming operations.
4848 For more information on how this variable is used by Auto Revert mode,
4852 "Normal hook for `revert-buffer' to run before reverting.
4853 If `revert-buffer-function' is used to override the normal revert
4857 "Normal hook for `revert-buffer' to run after reverting.
4858 Note that the hook value that it runs is the value that was in effect
4859 before reverting; that makes a difference if you have buffer-local
4860 hook functions.
4862 If `revert-buffer-function' is used to override the normal revert
4868 "Replace current buffer text with the text of the visited file on disk.
4869 This undoes all changes since the file was visited or saved.
4870 With a prefix argument, offer to revert from latest auto-save file, if
4871 that is more recent than the visited file.
4873 This command also implements an interface for special buffers
4874 that contain text which doesn't come from a file, but reflects
4875 some other data instead (e.g. Dired buffers, `buffer-list'
4876 buffers). This is done via the variable `revert-buffer-function'.
4877 In these cases, it should reconstruct the buffer contents from the
4878 appropriate data.
4880 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4881 to revert from the auto-save file when this is nil. Note that the
4882 sense of this argument is the reverse of the prefix argument, for the
4883 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4884 to nil.
4886 Optional second argument NOCONFIRM means don't ask for confirmation
4887 at all. \(The variable `revert-without-query' offers another way to
4888 revert buffers without querying for confirmation.)
4890 Optional third argument PRESERVE-MODES non-nil means don't alter
4891 the files modes. Normally we reinitialize them using `normal-mode'.
4893 If the value of `revert-buffer-function' is non-nil, it is called to
4894 do all the work for this command. Otherwise, the hooks
4895 `before-revert-hook' and `after-revert-hook' are run at the beginning
4896 and the end, and if `revert-buffer-insert-file-contents-function' is
4897 non-nil, it is called instead of rereading visited file contents."
4899 ;; I admit it's odd to reverse the sense of the prefix argument, but
4900 ;; there is a lot of code out there which assumes that the first
4901 ;; argument should be t to avoid consulting the auto-save file, and
4902 ;; there's no straightforward way to encourage authors to notice a
4903 ;; reversal of the argument sense. So I'm just changing the user
4904 ;; interface, but leaving the programmatic interface the same.
4912 buffer-auto-save-file-name
4917 buffer-auto-save-file-name
4918 buffer-file-name)))
4928 file-name)))
4930 ;; If file was backed up but has changed since,
4931 ;; we should make another backup.
4935 ;; Effectively copy the after-revert-hook status,
4936 ;; since after-find-file will clobber it.
4939 after-revert-hook))
4944 ;; Get rid of all undo records for this buffer.
4946 ;; Don't make undo records for the reversion.
4949 file-name auto-save-p)))
4952 "File %s no longer exists!"
4954 file-name))
4957 "File %s no longer readable!"
4959 file-name))
4961 ;; Bind buffer-file-name to nil
4962 ;; so that we don't try to lock the file.
4968 ;; Auto-saved file should be read by Emacs'
4969 ;; internal coding.
4973 buffer-file-coding-system-explicit
4976 coding-system-for-read
4978 coding-system-for-read)
4980 ;; As a coding system suitable for multibyte
4981 ;; buffer is specified, make the current
4982 ;; buffer multibyte.
4985 ;; This force after-insert-file-set-coding
4986 ;; (called from insert-file-contents) to set
4987 ;; buffer-file-coding-system to a proper value.
4990 ;; Note that this preserves point in an intelligent way.
4994 nil nil t))
4996 nil nil t)))))
4997 ;; Recompute the truename in case changes in symlinks
4998 ;; have changed the truename.
5002 ;; Run after-revert-hook as it was before we reverted.
5006 local-hook)
5009 t))))))
5012 "Recover the visited file--get contents from its last auto-save file."
5017 "Visit file FILE, but get contents from its last auto-save file."
5018 ;; Actually putting the file name in the minibuffer should be used
5019 ;; only rarely.
5020 ;; Not just because users often use the default.
5040 ;; Use insert-directory-safely, not insert-directory,
5041 ;; because these files might not exist. In particular,
5042 ;; FILE might not exist if the auto-save file was for
5043 ;; a buffer that didn't visit a file, such as "*mail*".
5044 ;; The code in v20.x called `ls' directly, so we need
5045 ;; to emulate what `ls' did in that case.
5051 ;; Keep the current buffer-file-coding-system.
5053 ;; Auto-saved file should be read with special coding.
5062 "Recover auto save files from a previous Emacs session.
5063 This command first displays a Dired buffer showing you the
5064 previous sessions that you could recover from.
5065 To choose one, move point to the proper line and then type C-c C-c.
5066 Then you'll be asked about a number of files to recover."
5076 auto-save-list-file-prefix)))
5077 t)
5086 ;; Each line starts with a space
5087 ;; so that Font Lock mode won't highlight the first character.
5096 "Choose one saved session to recover auto-save files from.
5097 This command is used in the special Dired buffer created by
5100 ;; Get the name of the session file to recover from.
5102 files
5108 ;; Read in the auto-save-list file.
5111 ;; Loop thru the text of that file
5112 ;; and get out the names of the files to recover.
5116 ;; This is a pair of lines for a non-file-visiting buffer.
5117 ;; Get the auto-save file name and manufacture
5118 ;; a "visited file name" from that.
5121 ;; If there is no auto-save file name, the
5122 ;; auto-save-list file is probably corrupted.
5135 ;; This pair of lines is a file-visiting
5136 ;; buffer. Use the visited file name.
5146 ;; Ignore a file if its auto-save file does not exist now.
5150 ;; The file contains a pair of line for each auto-saved buffer.
5151 ;; The first line of the pair contains the visited file name
5152 ;; or is empty if the buffer was not visiting a file.
5153 ;; The second line is the auto-save file name.
5161 files
5167 "Kill BUFFER if confirmed."
5175 "Kill some buffers. Asks the user whether to kill each one of them.
5176 Non-interactively, if optional argument LIST is non-nil, it
5177 specifies the list of buffers to kill, asking for approval for each one."
5185 ; if we killed the base buffer.
5192 "Kill buffers whose name matches the specified REGEXP.
5193 The optional second argument indicates whether to kill internal buffers too."
5202 \f
5204 "Adjust current buffer's auto save file name for current conditions.
5205 Also rename any existing auto save file, if it was made in this session."
5217 "Return file name to use for auto-saves of current buffer.
5218 Does not consider `auto-save-visited-file-name' as that variable is checked
5219 before calling this function. You can redefine this for customization.
5220 See also `auto-save-file-name-p'."
5228 result uniq)
5229 ;; Apply user-specified translations
5230 ;; to the file name.
5234 filename)
5244 filename))))
5249 ;; We truncate the file name to DOS 8+3 limits
5250 ;; before doing anything else, because the regexp
5251 ;; passed to string-match below cannot handle
5252 ;; extensions longer than 3 characters, multiple
5253 ;; dots, and other atrocities.
5258 fn)
5263 "#"
5266 ;; Make sure auto-save file names don't contain characters
5267 ;; invalid for the underlying filesystem.
5269 ;; Don't modify remote (ange-ftp) filenames
5272 result))))
5274 ;; Deal with buffers that don't have any associated files. (Mail
5275 ;; mode tends to create a good number of these.)
5279 file-name)
5280 ;; Restrict the characters used in the file name to those which
5281 ;; are known to be safe on all filesystems, url-encoding the
5282 ;; rest.
5283 ;; We do this on all platforms, because even if we are not
5284 ;; running on DOS/Windows, the current directory may be on a
5285 ;; mounted VFAT filesystem, such as a USB memory stick.
5289 ;; For multibyte characters, this will produce more than
5290 ;; 2 hex digits, so is not true URL encoding.
5294 ;; Generate the file name.
5300 ;; Try a few alternative directories, to get one we can
5301 ;; write it.
5307 ;; Don't modify remote (ange-ftp) filenames
5309 ;; The call to convert-standard-filename is in case
5310 ;; buffer-name includes characters not allowed by the
5311 ;; DOS/Windows filesystems. make-temp-file writes to the
5312 ;; file it creates, so we must fix the file name _before_
5313 ;; make-temp-file is called.
5315 fname))
5317 ;; make-temp-file creates the file,
5318 ;; but we don't want it to exist until we do an auto-save.
5322 file-name)))
5325 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5326 FILENAME should lack slashes. You can redefine this for customization."
5328 \f
5330 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5331 The generated regexp will match a filename only if the filename
5332 matches that wildcard according to shell rules. Only wildcards known
5333 by `sh' are supported."
5335 ;; Copy the initial run of non-special characters.
5338 ;; If no special characters, we're almost done.
5342 j)
5344 result
5365 ;; Found "[^". Insert a `\0' character
5366 ;; (which cannot happen in a filename)
5367 ;; into the character class, so that `^'
5368 ;; is not the first character after `[',
5369 ;; and thus non-special in a regexp.
5374 ;; I don't think `]' can appear in a
5375 ;; character class in a wildcard, but
5376 ;; let's be general here.
5383 i
5396 ;; Shell wildcards should match the entire filename,
5397 ;; not its part. Make the regexp say so.
5399 \f
5402 "Switches for `list-directory' to pass to `ls' for brief listing."
5408 "Switches for `list-directory' to pass to `ls' for verbose listing."
5413 "Expand wildcard pattern PATTERN.
5414 This returns a list of file names which match the pattern.
5416 If PATTERN is written as an absolute file name,
5417 the values are absolute also.
5419 If PATTERN is written as a relative file name, it is interpreted
5420 relative to the current default directory, `default-directory'.
5421 The file names returned are normally also relative to the current
5422 default directory. However, if FULL is non-nil, they are absolute."
5426 ;; A list of all dirs that DIRPART specifies.
5427 ;; This can be more than one dir
5428 ;; if DIRPART contains wildcards.
5432 dirpart)))
5436 contents)
5441 ;; Filter out "." and ".."
5446 name))
5453 this-dir-contents)
5454 this-dir-contents)
5455 contents))))
5457 contents)))
5459 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5463 "Display a list of files in or matching DIRNAME, a la `ls'.
5464 DIRNAME is globbed by the shell if necessary.
5465 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5466 Actions controlled by variables `list-directory-brief-switches'
5467 and `list-directory-verbose-switches'."
5471 nil default-directory nil)
5472 pfx)))
5474 list-directory-brief-switches))
5475 buffer)
5487 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5495 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5497 PATTERN is assumed to represent a file-name wildcard suitable for the
5498 underlying filesystem. For Unix and GNU/Linux, each character from the
5500 the parts of the pattern which don't include wildcard characters are
5501 quoted with double quotes.
5504 on Windows), so PATTERN can use them to quote wildcard characters that
5505 need to be passed verbatim to shell commands."
5509 ;; DOS/Windows don't allow `"' in file names. So if the
5510 ;; argument has quotes, we can safely assume it is already
5511 ;; quoted by the caller.
5513 ;; We quote [&()#$'] in case their shell is a port of a
5514 ;; Unixy shell. We quote [,=+] because stock DOS and
5515 ;; Windows shells require that in some cases, such as
5516 ;; passing arguments to batch files that use positional
5517 ;; arguments like %1.
5519 pattern
5522 end)
5539 pattern))))
5546 "Program to get the amount of free space on a file system.
5547 We assume the output has the format of `df'.
5548 The value of this variable must be just a command name or file name;
5549 if you want to specify options, use `directory-free-space-args'.
5551 A value of nil disables this feature.
5553 If the function `file-system-info' is defined, it is always used in
5554 preference to the program given by this variable."
5560 "Options to use when running `directory-free-space-program'."
5565 "Return the amount of free space on directory DIR's file system.
5566 The result is a string that gives the number of free 1KB blocks,
5567 or nil if the system call or the program which retrieve the information
5568 fail. It returns also nil when DIR is a remote directory.
5570 This function calls `file-system-info' if it is available, or invokes the
5571 program specified by `directory-free-space-program' if that is non-nil."
5573 ;; Try to find the number of free blocks. Non-Posix systems don't
5574 ;; always have df, but might have an equivalent system call.
5583 ;; Avoid failure if the default directory does
5584 ;; not exist (Bug#2631, Bug#3911).
5587 nil t nil
5588 directory-free-space-args
5589 dir)
5591 ;; Usual format is a header line followed by a line of
5592 ;; numbers.
5597 ;; Move to the end of the "available blocks" number.
5600 ;; Copy it into AVAILABLE.
5605 ;; The following expression replaces `dired-move-to-filename-regexp'.
5609 ;; In some locales, month abbreviations are as short as 2 letters,
5610 ;; and they can be followed by ".".
5611 ;; In Breton, a month name can include a quote character.
5624 s "+"
5627 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5628 ;; omits the Kanji characters after month and day-of-month.
5629 ;; On Mac OS X 10.3, the date format in East Asian locales is
5630 ;; day-of-month digits followed by month digits.
5636 ;; The "[0-9]" below requires the previous column to end in a digit.
5637 ;; This avoids recognizing `1 may 1997' as a date in the line:
5638 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5640 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5642 ;; For non-iso date formats, we add the ".*" in order to find
5643 ;; the last possible match. This avoids recognizing
5644 ;; `jservice 10 1024' as a date in the line:
5645 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5647 ;; vc dired listings provide the state or blanks between file
5648 ;; permissions and date. The state is always surrounded by
5649 ;; parantheses:
5650 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5651 ;; This is not supported yet.
5656 "Regular expression to match up to the file name in a directory listing.
5657 The default value is designed to recognize dates and times
5662 ;; insert-directory
5663 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5664 ;; FULL-DIRECTORY-P is nil.
5665 ;; The single line of output must display FILE's name as it was
5666 ;; given, namely, an absolute path name.
5667 ;; - must insert exactly one line for each file if WILDCARD or
5668 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5669 ;; before the file lines, plus optional text after the file lines.
5670 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5671 ;; allowed.
5672 ;; File lines should display the basename.
5673 ;; - must be consistent with
5674 ;; - functions dired-move-to-filename, (these two define what a file line is)
5675 ;; dired-move-to-end-of-filename,
5676 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5677 ;; dired-insert-headerline
5678 ;; dired-after-subdir-garbage (defines what a "total" line is)
5679 ;; - variable dired-subdir-regexp
5680 ;; - may be passed "--dired" as the first argument in SWITCHES.
5681 ;; Filename handlers might have to remove this switch if their
5682 ;; "ls" command does not support it.
5684 "Insert directory listing for FILE, formatted according to SWITCHES.
5685 Leaves point after the inserted text.
5686 SWITCHES may be a string of options, or a list of strings
5687 representing individual options.
5688 Optional third arg WILDCARD means treat FILE as shell wildcard.
5689 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5690 switches do not contain `d', so that a full listing is expected.
5692 This works by running a directory listing program
5693 whose name is in the variable `insert-directory-program'.
5694 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5696 When SWITCHES contains the long `--dired' option, this function
5697 treats it specially, for the sake of dired. However, the
5698 normally equivalent short `-D' option is just passed on to
5699 `insert-directory-program', as any other option."
5700 ;; We need the directory in order to find the right handler.
5705 wildcard full-directory-p)
5708 ;; Read the actual directory using `insert-directory-program'.
5709 ;; RESULT gets the status code.
5711 ;; putting text property `dired-filename, decode one
5712 ;; bunch by one to preserve that property.
5714 ;; This is to control encoding the arguments in call-process.
5718 default-file-name-coding-system))))
5721 ;; Run ls in the directory part of the file pattern
5722 ;; using the last component as argument.
5729 shell-file-name nil t nil
5730 "-c"
5732 ""
5734 insert-directory-program
5735 " -d "
5737 switches
5739 " -- "
5740 ;; Quote some characters that have
5741 ;; special meanings in shells; but
5742 ;; don't quote the wildcards--we want
5743 ;; them to be special. We also
5744 ;; currently don't quote the quoting
5745 ;; characters in case people want to
5746 ;; use them explicitly to quote
5747 ;; wildcard characters.
5749 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5750 ;; directory if FILE is a symbolic link.
5757 insert-directory-program nil t nil
5761 ;; Split the switches at any spaces so we can
5762 ;; pass separate options as separate args.
5764 ;; Avoid lossage if FILE starts with `-'.
5772 file))))))))
5774 ;; If we got "//DIRED//" in the output, it means we got a real
5775 ;; directory listing, even if `ls' returned nonzero.
5776 ;; So ignore any errors.
5789 ;; The first time ls returns an error,
5790 ;; find the version numbers of ls,
5791 ;; and set insert-directory-ls-version
5792 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5793 ;; is equal or if the info cannot be obtained.
5794 ;; (That can mean it isn't GNU ls.)
5804 comparison)
5820 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5824 ;; If `insert-directory-program' failed, signal an error.
5826 ;; Delete the error message it may have output.
5828 ;; On non-Posix systems, we cannot open a directory, so
5829 ;; don't even try, because that will always result in
5830 ;; the ubiquitous "Access denied". Instead, show the
5831 ;; command line so the user can try to guess what went wrong.
5836 insert-directory-program
5838 file result)
5839 ;; Unix. Access the file to get a suitable error.
5846 ;; The following overshoots by one line for an empty
5847 ;; directory listed with "--dired", but without "-a"
5848 ;; switch, where the ls output contains a
5849 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5850 ;; We take care of that case later.
5858 error-lines)
5859 ;; Find all the lines that are error messages,
5860 ;; and record the bounds of each one.
5867 ;; Now read the numeric positions of file names.
5874 error-lines))
5877 error-lines)))
5879 ;; End is followed by \n or by " -> ".
5881 ;; It seems that we can't trust ls's output as to
5882 ;; byte positions of filenames.
5888 ;; Take care of the case where the ls output contains a
5889 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5890 ;; and we went one line too far back (see above).
5895 ;; Now decode what read if necessary.
5897 file-name-coding-system
5898 default-file-name-coding-system
5900 coding-no-eol
5901 val pos)
5905 ;; If no coding system is specified or detection is
5906 ;; requested, detect the coding.
5920 ;; Force no eol conversion on a file name, so
5921 ;; that CR is preserved.
5929 ;; Try to insert the amount of free space.
5932 ;; First find the line to put it on.
5936 ;; Replace "total" with "used", to avoid confusion.
5942 "Convert `ls --dired' file name position value POS to a buffer position.
5943 File name position values returned in ls --dired output
5944 count only stdout; they don't count the error messages sent to stderr.
5945 So this function converts to them to real buffer positions.
5946 ERROR-LINES is a list of buffer positions of error message lines,
5947 of the form (START END)."
5951 pos)
5955 "Insert directory listing for FILE, formatted according to SWITCHES.
5957 Like `insert-directory', but if FILE does not exist, it inserts a
5958 message to that effect instead of signaling an error."
5961 ;; Simulate the message printed by `ls'.
5965 "Functions to call with no arguments to query about killing Emacs.
5966 If any of these functions returns nil, killing Emacs is cancelled.
5967 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5971 "How to ask for confirmation when leaving Emacs.
5972 If nil, the default, don't ask at all. If the value is non-nil, it should
5973 be a predicate function such as `yes-or-no-p'."
5981 "Offer to save each buffer, then kill this Emacs process.
5982 With prefix ARG, silently save all file-visiting buffers, then kill."
5991 ;; process-list is not defined on MSDOS.
5993 active)
6002 ;; Query the user for other things, perhaps.
6009 "Offer to save each buffer, then kill the current connection.
6010 If the current frame has no client, kill Emacs itself.
6012 With prefix ARG, silently save all file-visiting buffers, then kill.
6014 If emacsclient was started with a list of filenames to edit, then
6015 only these files will be asked to be saved."
6020 \f
6021 ;; We use /: as a prefix to "quote" a file name
6022 ;; so that magic file name handlers will not apply to it.
6026 file-name-handler-alist))
6028 ;; We depend on being the last handler on the list,
6029 ;; so that anything else which does need handling
6030 ;; has been handled already.
6031 ;; So it is safe for us to inhibit *all* magic file name handlers.
6040 default-directory))
6041 ;; Get a list of the indices of the args which are file names.
6044 ;; The first six are special because they
6045 ;; return a file name. We want to include the /:
6046 ;; in the return value.
6047 ;; So just avoid stripping it in the first place.
6054 ;; `identity' means just return the first arg
6055 ;; not stripped of its quoting.
6057 ;; `add' means add "/:" to the result.
6059 ;; `quote' means add "/:" to buffer-file-name.
6061 ;; `unquote-then-quote' means set buffer-file-name
6062 ;; temporarily to unquoted filename.
6064 ;; List the arguments which are filenames.
6072 ;; For all other operations, treat the first argument only
6073 ;; as the file name.
6075 method
6076 ;; Copy ARGUMENTS so we can replace elements in it.
6080 ;; Strip off the /: from the file names that have it.
6088 "/"
6104 res))
6107 \f
6108 ;; Symbolic modes and read-file-modes.
6111 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6112 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6113 Others, or All) for whom to produce the mask.
6114 The bit-mask that is returned extracts from mode bits the access rights
6115 for the specified category of users."
6123 "Convert CHAR to a numeric value of mode bits.
6124 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6125 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6132 ;; Rights relative to the previous file modes.
6143 "Convert a symbolic mode string specification to an equivalent number.
6145 WHO-MASK is the bit-mask specifying the category of users to which to
6146 apply the access permissions. See `file-modes-char-to-who'.
6147 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6148 RIGHTS request to add, remove, or set permissions based on existing ones,
6155 char-right)
6162 num-rights
6166 op char-right)))
6167 num-rights))
6170 "Convert symbolic file modes to numeric file modes.
6171 MODES is the string to convert, it should match
6174 notation.
6175 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6176 MODES request to add, remove, or set permissions based on existing ones,
6190 num-who num-modes)
6193 num-modes)))
6196 "Read file modes in octal or symbolic notation and return its numeric value.
6197 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6198 ORIG-FILE is the name of a file on whose mode bits to base returned
6199 permissions if what user types requests to add, remove, or set permissions
6215 nil nil default)))
6221 \f
6222 ;; Trashcan handling.
6224 "Directory for `move-file-to-trash' to move files and directories to.
6225 This directory is only used when the function `system-move-file-to-trash'
6226 is not defined.
6227 Relative paths are interpreted relative to `default-directory'.
6228 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6238 "Move the file (or directory) named FILENAME to the trash.
6239 When `delete-by-moving-to-trash' is non-nil, this function is
6240 called by `delete-file' and `delete-directory' instead of
6241 deleting files outright.
6243 If the function `system-move-file-to-trash' is defined, call it
6244 with FILENAME as an argument.
6245 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6246 directory.
6247 Otherwise, trash FILENAME using the freedesktop.org conventions,
6248 like the GNOME, KDE and XFCE desktop environments. Emacs only
6252 ;; If `trash-directory' is non-nil, move the file there.
6256 trash-dir)))
6257 ;; We can't trash a parent directory of trash-directory.
6260 trash-dir filename))
6263 ;; Ensure that the trashed file-name is unique.
6270 ;; If `system-move-file-to-trash' is defined, use it.
6273 ;; Otherwise, use the freedesktop.org method, as specified at
6274 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6285 ;; Check if we have permissions to delete.
6289 ;; The trashed file cannot be the trash dir or its parent.
6292 trash-files-dir filename))
6295 trash-info-dir filename))
6297 ;; Ensure that the trash directory exists; otherwise, create it.
6306 ;; Try to move to trash with .trashinfo undo information
6311 ;; Perform url-encoding on FN. For compatibility with
6312 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6313 ;; for path separators.
6318 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6319 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6332 fn))
6337 ;; Attempt to make .trashinfo file, trying up to 5
6338 ;; times. The .trashinfo file is opened with O_EXCL,
6339 ;; as per trash-spec 0.7, even if that can be a problem
6340 ;; on old NFS versions...
6344 trash-files-dir))
6346 success info-fn)
6351 trash-info-dir))
6359 ;; Uniqify new-fn. (Some file managers do not
6360 ;; like Emacs-style backup file names---e.g. bug
6361 ;; 170956 in Konqueror bug tracker.)
6366 ;; Finally, try to move the file to the trashcan.
6370 \f
6395 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6396 ;;; files.el ends here