| blob | 3b130a20d2bcae76909dde50080f0ec328badd5d |
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."
130 "Non-nil means create backups by copying to preserve a privileged owner.
131 Renaming may still be used (subject to control of other variables)
132 when it would not result in changing the owner of the file or if the owner
133 has a user id greater than the value of this variable. This is useful
134 when low-numbered uid's are used for special system users (such as root)
135 that must maintain ownership of certain files.
136 This variable is relevant only if `backup-by-copying' and
137 `backup-by-copying-when-mismatch' are nil."
142 "Predicate that looks at a file name and decides whether to make backups.
146 "Non-nil in a buffer means always offer to save buffer on exit.
147 Do so even if the buffer is not visiting a file.
148 Automatically local in all buffers."
154 "Non-nil means find a file under alternative names, in existing buffers.
155 This means if any existing buffer is visiting the file you want
156 under another name, you get the existing buffer instead of a new buffer."
161 "Non-nil means visit a file under its truename.
162 The truename of a file is found by chasing all links
163 both at the file level and at the levels of the containing directories."
169 "Specify which files should be reverted without query.
170 The value is a list of regular expressions.
171 If the file name matches one of these regular expressions,
172 then `revert-buffer' reverts the file without querying
173 if the file has changed on disk and you have not edited the buffer."
178 "The device number and file number of the file visited in the current buffer.
179 The value is a list of the form (FILENUM DEVNUM).
180 This pair of numbers uniquely identifies the file.
194 "The directory for writing small temporary files.
195 If non-nil, this directory is used instead of `temporary-file-directory'
196 by programs that create small temporary files. This is for systems that
197 have fast storage with limited space, such as a RAM disk."
202 ;; The system null device. (Should reference NULL_DEVICE from C.)
230 "Non-nil means protect against I/O errors while saving files.
231 Some modes set this non-nil in particular buffers.
233 This feature works by writing the new contents into a temporary file
234 and then renaming the temporary file to replace the original.
235 In this way, any I/O error in writing leaves the original untouched,
236 and there is never any instant where the file is nonexistent.
238 Note that this feature forces backups to be made by copying.
239 Yet, at the same time, saving a precious file
240 breaks any hard links between it and other files.
242 This feature is advisory: for example, if the directory in which the
243 file is being saved is not writable, Emacs may ignore a non-nil value
244 of `file-precious-flag' and write directly into the file.
246 See also: `break-hardlink-on-save'."
251 "Non-nil means when saving a file that exists under several names
252 \(i.e., has multiple hardlinks), break the hardlink associated with
253 `buffer-file-name' and write to a new file, so that the other
254 instances of the file are not affected by the save.
256 If `buffer-file-name' refers to a symlink, do not break the symlink.
258 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
259 For example, if the directory in which a file is being saved is not
260 itself writable, then error instead of saving in some
261 hardlink-nonbreaking way.
263 See also `backup-by-copying' and `backup-by-copying-when-linked'."
269 "Control use of version numbers for backup files.
270 When t, make numeric backup versions unconditionally.
271 When nil, make them for files that have some already.
272 The value `never' means do not make them."
282 "When cleaning directory, number of versions to keep."
288 "If t, delete excess backup versions silently.
289 If nil, ask confirmation. Any other value prevents any trimming."
296 "Number of oldest versions to keep when a new numbered backup is made."
302 "Number of newest versions to keep when a new numbered backup is made.
303 Includes the new backup. Must be > 0"
309 "Whether to add a newline automatically at the end of the file.
311 A value of t means do this only when the file is about to be saved.
312 A value of `visit' means do this right after the file is visited.
313 A value of `visit-save' means do it at both of those times.
314 Any other non-nil value means ask user whether to add a newline, when saving.
315 A value of nil means don't add newlines.
317 Certain major modes set this locally to the value obtained
318 from `mode-require-final-newline'."
327 "Whether to add a newline at end of file, in certain major modes.
328 Those modes set `require-final-newline' to this value when you enable them.
329 They do so because they are often used for files that are supposed
330 to end in newlines, and the question is how to arrange that.
332 A value of t means do this only when the file is about to be saved.
333 A value of `visit' means do this right after the file is visited.
334 A value of `visit-save' means do it at both of those times.
335 Any other non-nil value means ask user whether to add a newline, when saving.
337 A value of nil means do not add newlines. That is a risky choice in this
338 variable since this value is used for modes for files that ought to have
339 final newlines. So if you set this to nil, you must explicitly check and
340 add a final newline, whenever you save a file that really needs one."
350 "Non-nil says by default do auto-saving of every file-visiting buffer."
356 ;; Don't put "\\2" inside expand-file-name, since it will be
357 ;; transformed to "/2" on DOS/Windows.
359 "Transforms to apply to buffer file name before making auto-save file name.
360 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
361 REGEXP is a regular expression to match against the file name.
362 If it matches, `replace-match' is used to replace the
363 matching part with REPLACEMENT.
364 If the optional element UNIQUIFY is non-nil, the auto-save file name is
365 constructed by taking the directory part of the replaced file-name,
366 concatenated with the buffer file name with all directory separators
367 changed to `!' to prevent clashes. This will not work
368 correctly if your filesystem truncates the resulting name.
370 All the transforms in the list are tried, in the order they are listed.
371 When one transform applies, its result is final;
372 no further transforms are tried.
374 The default value is set up to put the auto-save file into the
375 temporary directory (see the variable `temporary-file-directory') for
376 editing a remote file.
378 On MS-DOS filesystems without long names this variable is always
379 ignored."
387 "Non-nil means save word abbrevs too when files are saved.
388 If `silently', don't ask the user before saving."
393 "Non-nil means allow `find-file' to visit directories.
394 To visit the directory, `find-file' runs `find-directory-functions'."
399 "List of functions to try in sequence to visit a directory.
400 Each function is called with the directory name as the sole argument
401 and should return either a buffer or nil."
405 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
407 "List of functions to try in sequence to get a file name at point.
408 Each function should return either nil or a file name found at the
409 location of point in the current buffer."
413 ;;;It is not useful to make this a local variable.
414 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
416 "List of functions to be called for `find-file' on nonexistent file.
417 These functions are called as soon as the error is detected.
418 Variable `buffer-file-name' is already set up.
423 ;;;It is not useful to make this a local variable.
424 ;;;(put 'find-file-hooks 'permanent-local t)
427 "List of functions to be called after a buffer is loaded from a file.
428 The buffer's local variables (if any) will have been processed before the
429 functions are called."
436 "List of functions to be called before writing out a buffer to a file.
437 If one of them returns non-nil, the file is considered already written
438 and the rest are not called.
439 These hooks are considered to pertain to the visited file.
440 So any buffer-local binding of this variable is discarded if you change
442 change the major mode.
444 This hook is not run if any of the functions in
445 `write-contents-functions' returns non-nil. Both hooks pertain
446 to how to save a buffer to file, for instance, choosing a suitable
447 coding system and setting mode bits. (See Info
448 node `(elisp)Saving Buffers'.) To perform various checks or
459 "List of functions to be called before writing out a buffer to a file.
460 If one of them returns non-nil, the file is considered already written
461 and the rest are not called and neither are the functions in
462 `write-file-functions'.
464 This variable is meant to be used for hooks that pertain to the
465 buffer's contents, not to the particular visited file; thus,
466 `set-visited-file-name' does not clear this variable; but changing the
467 major mode does clear it.
469 For hooks that _do_ pertain to the particular visited file, use
470 `write-file-functions'. Both this variable and
471 `write-file-functions' relate to how a buffer is saved to file.
472 To perform various checks or updates before the buffer is saved,
479 "Control use of local variables in files you visit.
480 The value can be t, nil, :safe, :all, or something else.
482 A value of t means file local variables specifications are obeyed
483 if all the specified variable values are safe; if any values are
484 not safe, Emacs queries you, once, whether to set them all.
485 \(When you say yes to certain values, they are remembered as safe.)
487 :safe means set the safe variables, and ignore the rest.
488 :all means set all variables, whether safe or not.
489 (Don't set it permanently to :all.)
490 A value of nil means always ignore the file local variables.
492 Any other value means always query you once whether to set them all.
493 \(When you say yes to certain values, they are remembered as safe, but
496 This variable also controls use of major modes specified in
497 a -*- line.
500 always obeys file local variable specifications and the -*- line,
501 and ignores this variable."
502 :risky t
511 "Like `enable-local-variables' but meant for buffer-local bindings.
512 The meaningful values are nil and non-nil. The default is non-nil.
513 If a major mode sets this to nil, buffer-locally, then any local
514 variables list in the file will be ignored.
516 This variable does not affect the use of major modes
521 The value can be t, nil or something else.
522 A value of t means obey `eval' variables.
523 A value of nil means ignore them; anything else means query."
524 :risky t
530 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
539 "Non-nil means buffers visiting files read-only do so in view mode.
540 In fact, this means that all read-only buffers normally have
541 View mode enabled, including buffers that are read-only because
542 you visit a file you cannot alter, and buffers you make read-only
548 "History list of file names entered in the minibuffer.
550 Maximum length of the history list is determined by the value
552 \f
555 "Provides support for ange-ftp host name completion.
556 Runs the usual ange-ftp hook, but only for completion operations."
557 ;; Having this here avoids the need to load ange-ftp when it's not
558 ;; really in use.
564 inhibit-file-name-handlers)))
572 "Convert a standard file's name to something suitable for the OS.
573 This means to guarantee valid names and perhaps to canonicalize
574 certain patterns.
576 FILENAME should be an absolute file name since the conversion rules
577 sometimes vary depending on the position in the file name. E.g. c:/foo
578 is a valid DOS file name, but c:/bar/c:/foo is not.
580 This function's standard definition is trivial; it just returns
581 the argument. However, on Windows and DOS, replace invalid
582 characters. On DOS, make sure to obey the 8.3 limitations.
583 In the native Windows build, turn Cygwin names into native names,
584 and also turn slashes into backslashes if the shell requires it (see
585 `w32-shell-dos-semantics').
587 See Info node `(elisp)Standard File Names' for more details."
592 ;; Replace invalid filename characters with !
596 name))
604 "Read directory name, prompting with PROMPT and completing in directory DIR.
605 Value is not expanded---you must call `expand-file-name' yourself.
606 Default name to DEFAULT-DIRNAME if user exits with the same
607 non-empty string that was inserted by this function.
608 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
609 or just DIR if INITIAL is nil.)
610 If the user exits with an empty minibuffer, this function returns
611 an empty string. (This can only happen if the user erased the
612 pre-inserted contents or if `insert-default-directory' is nil.)
613 Fourth arg MUSTMATCH non-nil means require existing directory's name.
614 Non-nil and non-t means also require confirmation after completion.
615 Fifth arg INITIAL specifies text to start with.
616 DIR should be an absolute directory name. It defaults to
617 the value of `default-directory'."
622 dir))
623 mustmatch initial
626 \f
628 "Show the current default directory."
633 "Value of the CDPATH environment variable, as a list.
637 "Explode a search path into a list of directory names.
638 Directories are separated by occurrences of `path-separator'
639 \(which is colon in GNU and GNU-like systems)."
640 ;; We could use split-string here.
648 nil
653 cd-list)))
656 "Change current directory to given absolute file name DIR."
657 ;; Put the name into directory syntax now,
658 ;; because otherwise expand-file-name may give some bad results.
660 ;; We used to additionally call abbreviate-file-name here, for an
661 ;; unknown reason. Problem is that most buffers are setup
662 ;; without going through cd-absolute and don't call
663 ;; abbreviate-file-name on their default-directory, so the few that
664 ;; do end up using a superficially different directory.
676 "Make DIR become the current buffer's default directory.
677 If your environment includes a `CDPATH' variable, try each one of
678 that list of directories (separated by occurrences of
679 `path-separator') when resolving a relative directory name.
680 The path separator is colon in GNU and GNU-like systems."
683 default-directory default-directory
699 cd-path)
700 nil))
704 "Load the Lisp file named FILE."
705 ;; This is a case where .elc makes a lot of sense.
712 "Search for FILENAME through PATH.
713 If found, return the absolute file name of FILENAME, with its suffixes;
714 otherwise return nil.
715 PATH should be a list of directories to look in, like the lists in
716 `exec-path' or `load-path'.
717 If SUFFIXES is non-nil, it should be a list of suffixes to append to
720 If non-nil, PREDICATE is used instead of `file-readable-p'.
721 PREDICATE can also be an integer to pass to the `access' system call,
722 in which case file-name handlers are ignored. This usage is deprecated.
724 For compatibility, PREDICATE can also be one of the symbols
725 `executable', `readable', `writable', or `exists', or a list of
726 one or more of those symbols."
737 "Do completion for file names passed to `locate-file'."
740 ;; FIXME: maybe we should use completion-file-name-table instead,
741 ;; tho at least for `load', the arg is passed through
742 ;; substitute-in-file-name for historical reasons.
752 ;; If we have files like "foo.el" and "foo.elc", we could load one of
753 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
754 ;; preferred way. So if we list all 3, that gives a lot of redundant
755 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
756 ;; the user does want to pay attention to the extension. We try to
757 ;; diffuse this tension by stripping the suffix, except when the
758 ;; result is a single element (i.e. usually we only list "foo" unless
759 ;; it's the only remaining element in the list, in which case we do
760 ;; list "foo", "foo.elc" and "foo.el").
771 string-file dir))
776 ;; Switching from names to names+fullnames creates a non-monotonicity
777 ;; which can cause problems with things like partial-completion.
778 ;; To minimize the problem, filter out completion-regexp-list, so that
779 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
780 ;; from `names' which only matched `string' when they still had
781 ;; their suffix.
783 ;; Remove duplicates of the first element, so that we can easily check
784 ;; if `names' really only contains a single element.
787 ;; There's no more than one matching non-suffixed element, so expand
788 ;; the list by adding the suffixed elements as well.
791 string-dir names string-file pred action)))))
794 "Do completion for file names passed to `locate-file'.
795 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
798 string nil action))
803 "Regexp of directory names which stop the search in `locate-dominating-file'.
804 Any directory whose name matches this regexp will be treated like
805 a kind of root directory by `locate-dominating-file' which will stop its search
806 when it bumps into it.
807 The default regexp prevents fruitless and time-consuming attempts to find
808 special files in directories in which filenames are interpreted as hostnames,
811 ;; (defun locate-dominating-files (file regexp)
812 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
813 ;; Stop at the first parent where a matching file is found and return the list
814 ;; of files that that match in this directory."
815 ;; (catch 'found
816 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
817 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
818 ;; (let ((user nil)
819 ;; ;; Abbreviate, so as to stop when we cross ~/.
820 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
821 ;; files)
822 ;; (while (and dir
823 ;; ;; As a heuristic, we stop looking up the hierarchy of
824 ;; ;; directories as soon as we find a directory belonging to
825 ;; ;; another user. This should save us from looking in
826 ;; ;; things like /net and /afs. This assumes that all the
827 ;; ;; files inside a project belong to the same user.
828 ;; (let ((prev-user user))
829 ;; (setq user (nth 2 (file-attributes dir)))
830 ;; (or (null prev-user) (equal user prev-user))))
831 ;; (if (setq files (condition-case nil
832 ;; (directory-files dir 'full regexp 'nosort)
833 ;; (error nil)))
834 ;; (throw 'found files)
835 ;; (if (equal dir
836 ;; (setq dir (file-name-directory
837 ;; (directory-file-name dir))))
838 ;; (setq dir nil))))
839 ;; nil)))
842 "Look up the directory hierarchy from FILE for a file named NAME.
843 Stop at the first parent directory containing a file NAME,
844 and return the directory. Return nil if not found."
845 ;; We used to use the above locate-dominating-files code, but the
846 ;; directory-files call is very costly, so we're much better off doing
847 ;; multiple calls using the code in here.
848 ;;
849 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
850 ;; `name' in /home or in /.
854 ;; `user' is not initialized outside the loop because
855 ;; `file' may not exist, so we may have to walk up part of the
856 ;; hierarchy before we find the "initial UID".
858 try)
861 ;; FIXME: Disabled this heuristic because it is sometimes
862 ;; inappropriate.
863 ;; As a heuristic, we stop looking up the hierarchy of
864 ;; directories as soon as we find a directory belonging
865 ;; to another user. This should save us from looking in
866 ;; things like /net and /afs. This assumes that all the
867 ;; files inside a project belong to the same user.
868 ;; (let ((prev-user user))
869 ;; (setq user (nth 2 (file-attributes file)))
870 ;; (and prev-user (not (equal user prev-user))))
878 root))
882 "Search for COMMAND in `exec-path' and return the absolute file name.
883 Return nil if COMMAND is not found anywhere in `exec-path'."
884 ;; Use 1 rather than file-executable-p to better match the behavior of
885 ;; call-process.
889 "Load the Emacs Lisp library named LIBRARY.
890 This is an interface to the function `load'. LIBRARY is searched
891 for in `load-path', both with and without `load-suffixes' (as
892 well as `load-file-rep-suffixes').
894 See Info node `(emacs)Lisp Libraries' for more details.
895 See `load-file' for a different interface to `load'."
899 load-path
904 "Test whether FILE specifies a location on a remote system.
905 Returns nil or a string identifying the remote connection (ideally
906 a prefix of FILE). For example, the remote identification for filename
909 less reliable than accessing local files.
910 Furthermore, relative file names do not work across remote connections.
912 IDENTIFICATION specifies which part of the identification shall
913 be returned as string. IDENTIFICATION can be the symbol
914 `method', `user', `host' or `localname'; any other value is
915 handled like nil and means to return the complete identification
916 string.
918 If CONNECTED is non-nil, the function returns an identification only
919 if FILE is located on a remote system, and a connection is established
920 to that remote system.
922 `file-remote-p' will never open a connection on its own."
926 nil)))
929 "Whether to use the remote file-name cache for read access.
931 When `nil', always use the cached values.
932 When `t', never use them.
933 A number means use them for that amount of seconds since they were
934 cached.
936 File attributes of remote files are cached for better performance.
937 If they are changed out of Emacs' control, the cached values
938 become invalid, and must be invalidated.
940 In case a remote file is checked regularly, it might be
941 reasonable to let-bind this variable to a value less then the
942 time period between two checks.
943 Example:
945 \(defun display-time-file-nonempty-p \(file)
946 \(let \(\(remote-file-name-inhibit-cache \(- display-time-interval 5)))
947 \(and \(file-exists-p file)
948 \(< 0 \(nth 7 \(file-attributes \(file-chase-links file)))))))"
959 "Copy the file FILE into a temporary file on this machine.
960 Returns the name of the local copy, or nil, if FILE is directly
961 accessible."
962 ;; This formerly had an optional BUFFER argument that wasn't used by
963 ;; anything.
967 nil)))
970 "Return the truename of FILENAME, which should be absolute.
971 The truename of a file name is found by chasing symbolic links
972 both at the level of the file and at the level of the directories
973 containing it, until no links are left at any level.
976 ;; COUNTER and PREV-DIRS are only used in recursive calls.
977 ;; COUNTER can be a cons cell whose car is the count of how many
978 ;; more links to chase before getting an error.
979 ;; PREV-DIRS can be a cons cell whose car is an alist
980 ;; of truenames we've just recently computed.
994 ;; For speed, remove the ange-ftp completion handler from the list.
995 ;; We know it's not needed here.
996 ;; For even more speed, do this only on the outermost call.
1003 ;; andrewi@harlequin.co.uk - none of the following code (except for
1004 ;; invoking the file-name handler) currently applies on Windows
1005 ;; (ie. there are no native symlinks), but there is an issue with
1006 ;; case differences being ignored by the OS, and short "8.3 DOS"
1007 ;; name aliases existing for all files. (The short names are not
1008 ;; reported by directory-files, but can be used to refer to files.)
1009 ;; It seems appropriate for file-truename to resolve these issues in
1010 ;; the most natural way, which on Windows is to call the function
1011 ;; `w32-long-file-name' - this returns the exact name of a file as
1012 ;; it is stored on disk (expanding short name aliases with the full
1013 ;; name in the process).
1016 ;; For file name that has a special handler, call handler.
1017 ;; This is so that ange-ftp can save time by doing a no-op.
1020 ;; If filename contains a wildcard, newname will be the old name.
1022 ;; If filename exists, use the long name. If it doesn't exist,
1023 ;; drill down until we find a directory that exists, and use
1024 ;; the long name of that, with the extra non-existent path
1025 ;; components concatenated.
1027 missing rest)
1030 ;; Include the preceding directory separator in the missing
1031 ;; part so subsequent recursion on the rest works.
1036 ""
1041 ;; If this file directly leads to a link, process that iteratively
1042 ;; so that we don't use lots of stack.
1048 ;; For file name that has a special handler, call handler.
1049 ;; This is so that ange-ftp can save time by doing a no-op.
1052 done t)
1054 target dirfile)
1055 ;; Get the truename of the directory.
1057 ;; If these are equal, we have the (or a) root directory.
1059 ;; If this is the same dir we last got the truename for,
1060 ;; save time--don't recalculate.
1070 done t)
1073 done t)
1074 ;; Put it back on the file name.
1076 ;; Is the file name the name of a link?
1079 ;; Yes => chase that link, then start all over
1080 ;; since the link may point to a directory name that uses links.
1081 ;; We can't safely use expand-file-name here
1082 ;; since target might look like foo/../bar where foo
1083 ;; is itself a link. Instead, we handle . and .. above.
1086 target
1088 done nil)
1089 ;; No, we are done!
1091 filename))
1094 "Chase links in FILENAME until a name that is not a link.
1095 Unlike `file-truename', this does not check whether a parent
1096 directory name is a symbolic link.
1097 If the optional argument LIMIT is a number,
1098 it means chase no more than that many links and then stop."
1106 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1109 ;; Handle `..' by hand, since it needs to work in the
1110 ;; target of any directory symlink.
1111 ;; This code is not quite complete; it does not handle
1112 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1116 ;; Chase links in the default dir of the symlink.
1120 ;; Now find the parent of that dir.
1124 newname))
1127 "Create a temporary file.
1128 The returned file name (created by appending some random characters at the end
1129 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1130 is guaranteed to point to a newly created empty file.
1131 You can then use `write-region' to write new data into the file.
1133 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1135 If SUFFIX is non-nil, add that at the end of the file name."
1137 file)
1140 ;; Create temp files with strict access rights. It's easy to
1141 ;; loosen them later, whereas it's impossible to close the
1142 ;; time-window of loose permissions otherwise.
1150 temporary-file-directory)
1152 temporary-file-directory))))
1158 nil)
1160 ;; the file was somehow created by someone else between
1161 ;; `make-temp-name' and `write-region', let's try again.
1162 nil)
1163 file)
1164 ;; Reset the umask.
1168 "Change the encoding of FILE's name from CODING to NEW-CODING.
1169 The value is a new name of FILE.
1170 Signals a `file-already-exists' error if a file of the new name
1171 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1172 is non-nil. A number as fourth arg means request confirmation if
1173 the new name already exists. This is what happens in interactive
1174 use with M-x."
1177 default-file-name-coding-system))
1179 from-coding to-coding)
1181 ;; We provide the default coding only when it seems that
1182 ;; the filename is correctly decoded by the default
1183 ;; coding.
1189 filename default-coding)
1190 default-coding))
1194 ;; We provide the default coding only when a user is going to
1195 ;; change the encoding not from the default coding.
1199 filename from-coding)))
1202 filename from-coding default-coding)
1203 default-coding)))
1207 default-file-name-coding-system))
1208 ;; FILE should have been decoded by DEFAULT-CODING.
1212 ;; Suppress further encoding.
1217 newname))
1218 \f
1220 "Whether confirmation is requested before visiting a new file or buffer.
1221 If nil, confirmation is not requested.
1222 If the value is `after-completion', confirmation is only
1223 requested if the user called `minibuffer-complete' right before
1224 `minibuffer-complete-and-exit'.
1225 Any other non-nil value means to request confirmation.
1227 This affects commands like `switch-to-buffer' and `find-file'."
1235 "Whether to request confirmation before visiting a new file or buffer.
1236 The variable `confirm-nonexistent-file-or-buffer' determines the
1237 return value, which may be passed as the REQUIRE-MATCH arg to
1238 `read-buffer' or `find-file-read-args'."
1246 "Read the name of a buffer to switch to and return as a string.
1247 It is intended for `switch-to-buffer' family of commands since they
1248 need to omit the name of current buffer from the list of completions
1249 and default values."
1254 ;; Since rbts-completion-table is built dynamically, we
1255 ;; can't just add it to the default value of
1256 ;; icomplete-with-completion-tables, so we add it
1257 ;; here manually.
1262 icomplete-with-completion-tables))))
1267 "Select the buffer specified by BUFFER-OR-NAME in another window.
1268 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1269 nil. Return the buffer switched to.
1271 If called interactively, prompt for the buffer name using the
1272 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1273 determines whether to request confirmation before creating a new
1274 buffer.
1276 If BUFFER-OR-NAME is a string and does not identify an existing
1277 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1278 nil, switch to the buffer returned by `other-buffer'.
1280 Optional second argument NORECORD non-nil means do not put this
1281 buffer at the front of the list of recently selected ones.
1283 This uses the function `display-buffer' as a subroutine; see its
1284 documentation for additional customization information."
1288 same-window-buffer-names same-window-regexps)
1292 "Switch to buffer BUFFER-OR-NAME in another frame.
1293 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1294 nil. Return the buffer switched to.
1296 If called interactively, prompt for the buffer name using the
1297 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1298 determines whether to request confirmation before creating a new
1299 buffer.
1301 If BUFFER-OR-NAME is a string and does not identify an existing
1302 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1303 nil, switch to the buffer returned by `other-buffer'.
1305 Optional second arg NORECORD non-nil means do not put this
1306 buffer at the front of the list of recently selected ones.
1308 This uses the function `display-buffer' as a subroutine; see its
1309 documentation for additional customization information."
1313 same-window-buffer-names same-window-regexps)
1317 "Display buffer BUFFER in another frame.
1318 This uses the function `display-buffer' as a subroutine; see
1319 its documentation for additional customization information."
1322 same-window-buffer-names same-window-regexps
1324 new-window)
1326 ;; This may have been here in order to prevent the new frame from hiding
1327 ;; the old frame. But it does more harm than good.
1328 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1329 ;;(lower-frame (window-frame new-window))
1331 ;; This may have been here in order to make sure the old-frame gets the
1332 ;; focus. But not only can it cause an annoying flicker, with some
1333 ;; window-managers it just makes the window invisible, with no easy
1334 ;; way to recover it. --Stef
1335 ;;(make-frame-invisible (window-frame old-window))
1336 ;;(make-frame-visible (window-frame old-window))
1337 ))
1340 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1341 BODY should use the minibuffer at most once.
1342 Recursive uses of the minibuffer are unaffected (FUN is not
1343 called additional times).
1345 This macro actually adds an auxiliary function that calls FUN,
1346 rather than FUN itself, to `minibuffer-setup-hook'."
1352 ;; Clear out this hook so it does not interfere
1353 ;; with any recursive minibuffer usage.
1364 t))
1367 "Edit file FILENAME.
1368 Switch to a buffer visiting file FILENAME,
1369 creating one if none already exists.
1370 Interactively, the default if you just type RET is the current directory,
1371 but the visited file name is available through the minibuffer history:
1372 type M-n to pull it into the minibuffer.
1374 You can visit files on remote machines by specifying something
1375 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1376 also visit local files as a different user by specifying
1377 /sudo::FILE for the file name.
1378 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1379 manual, for more about this.
1381 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1382 expand wildcards (if any) and visit multiple files. You can
1383 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1385 To visit a file without any kind of conversion and without
1396 "Edit file FILENAME, in another window.
1399 an existing one. See the function `display-buffer'.
1401 Interactively, the default if you just type RET is the current directory,
1402 but the visited file name is available through the minibuffer history:
1403 type M-n to pull it into the minibuffer.
1405 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1406 expand wildcards (if any) and visit multiple files."
1419 "Edit file FILENAME, in another frame.
1422 an existing one. See the function `display-buffer'.
1424 Interactively, the default if you just type RET is the current directory,
1425 but the visited file name is available through the minibuffer history:
1426 type M-n to pull it into the minibuffer.
1428 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1429 expand wildcards (if any) and visit multiple files."
1442 "Edit the existing file FILENAME.
1444 file names with wildcards."
1453 "Edit file FILENAME but don't allow changes.
1467 value))
1470 "Edit file FILENAME in another window but don't allow changes.
1484 value))
1487 "Edit file FILENAME in another frame but don't allow changes.
1501 value))
1504 "Find file FILENAME as a replacement for the file in the next window.
1505 This command does not select that window.
1509 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1510 expand wildcards (if any) and replace the file with multiple files."
1521 "Find alternate file: " file-dir nil
1523 t))))
1531 "Find file FILENAME, select its buffer, kill previous buffer.
1532 If the current buffer now contains an empty file that you just visited
1533 \(presumably by mistake), use this command to visit the file you really want.
1537 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1538 expand wildcards (if any) and replace the file with multiple files.
1540 If the current buffer is an indirect buffer, or the base buffer
1541 for one or more indirect buffers, the other buffer(s) are not
1542 killed."
1551 "Find alternate file: " file-dir nil
1553 t)))
1568 ;; Run `kill-buffer-hook' here. It needs to happen before
1569 ;; variables like `buffer-file-name' etc are set to nil below,
1570 ;; because some of the hooks that could be invoked
1571 ;; (e.g., `save-place-to-alist') depend on those variables.
1572 ;;
1573 ;; Note that `kill-buffer-hook' is not what queries whether to
1574 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1575 ;; asks that itself. Thus, there's no need to temporarily do
1576 ;; `(set-buffer-modified-p nil)' before running this hook.
1578 ;; Okay, now we can end-of-life the old buffer.
1585 ;; This prevents us from finding the same buffer
1586 ;; if we specified the same file again.
1590 ;; Likewise for dired buffers.
1594 ;; This executes if find-file gets an error
1595 ;; and does not really find anything.
1596 ;; We put things back as they were.
1597 ;; If find-file actually finds something, we kill obuf below.
1606 ;; We already ran these; don't run them again.
1609 \f
1611 "Create a suitably named buffer for visiting FILENAME, and return it.
1612 FILENAME (sans directory) is used unchanged if that name is free;
1613 otherwise a string <2> or <3> or ... is appended to get an unused name.
1614 Spaces at the start of FILENAME (sans directory) are removed."
1623 "Create and return a buffer with a name based on NAME.
1624 Choose the buffer's name using `generate-new-buffer-name'."
1628 "Regexp to match the automounter prefix in a directory name."
1636 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1638 home directory is a root directory) and removes automounter prefixes
1639 \(see the variable `automount-dir-prefix')."
1640 ;; Get rid of the prefixes added by the automounter.
1647 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1648 ;; To fix this right, we need a `file-name-case-sensitive-p'
1649 ;; function, but we don't have that yet, so just guess.
1652 ;; If any elt of directory-abbrev-alist matches this name,
1653 ;; abbreviate accordingly.
1659 ;; Compute and save the abbreviated homedir name.
1660 ;; We defer computing this until the first time it's needed, to
1661 ;; give time for directory-abbrev-alist to be set properly.
1662 ;; We include a slash at the end, to avoid spurious matches
1663 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1670 ;; If FILENAME starts with the abbreviated homedir,
1671 ;; make it start with `~' instead.
1673 ;; If the home dir is just /, don't change it.
1676 ;; MS-DOS root directories can come with a drive letter;
1677 ;; Novell Netware allows drive letters beyond `Z:'.
1685 filename)))
1688 "List of logical names for which visiting shouldn't save the true dirname."
1693 "Return the buffer visiting file FILENAME (a string).
1694 This is like `get-file-buffer', except that it checks for any buffer
1695 visiting the same file, possibly under a different name.
1696 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1697 and others are ignored.
1698 If there is no such live buffer, return nil."
1711 found)
1721 ;; Verify this buffer's file number
1722 ;; still belongs to its file.
1725 attributes)
1729 found))))
1730 \f
1732 "Non-nil means file-visiting commands should handle wildcards.
1733 For example, if you specify `*.c', that would visit all the files
1734 whose names match the pattern."
1740 "Non-nil means suppress warning messages for symlinked files.
1741 When nil, Emacs prints a warning when visiting a file that is already
1742 visited, but with a different name. Setting this option to t
1743 suppresses this warning."
1749 "Maximum size of file above which a confirmation is requested.
1750 When nil, never request confirmation."
1757 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1758 OP-TYPE specifies the file operation being performed (for message to user)."
1768 "Read file FILENAME into a buffer and return the buffer.
1769 If a buffer exists visiting FILENAME, return that one, but
1770 verify that the file has not changed since visited or saved.
1771 The buffer is not selected, just returned to the caller.
1772 Optional second arg NOWARN non-nil means suppress any warning messages.
1773 Optional third arg RAWFILE non-nil means the file is read literally.
1774 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1775 and visit all the matching files. When wildcards are actually
1776 used and expanded, return a list of buffers that are visiting
1777 the various files."
1784 'find-directory-functions
1787 filename)))
1790 find-file-wildcards
1804 ;; Find any buffer for a file which has same truename.
1806 ;; Let user know if there is a buffer with the same truename.
1810 find-file-suppress-same-file-warnings
1814 ;; Optionally also find that buffer.
1817 ;; Check to see if the file looks uncommonly large.
1821 ;; We are using an existing buffer.
1828 ;; Certain files should be reverted automatically
1829 ;; if they have changed on disk and not in the buffer.
1837 found))
1847 "File %s changed on disk. Discard your edits? "
1852 "File %s changed on disk. Discard your edits in %s? "
1860 ;; Check if a formerly read-only file has become
1861 ;; writable and vice versa, but if the buffer agrees
1862 ;; with the new state of the file, that is ok too.
1870 buffer-file-name
1879 ;; It is confusing to ask whether to visit
1880 ;; non-literally if they have the file in
1881 ;; hexl-mode.
1887 "The file %s is already visited normally,
1888 and you have edited the buffer. Now you have asked to visit it literally,
1889 meaning no coding system handling, format conversion, or local variables.
1890 Emacs can only visit a file in one way at a time.
1892 Do you want to save the file, and visit it literally instead? "
1893 "The file %s is already visited literally,
1894 meaning no coding system handling, format conversion, or local variables.
1895 You have edited the buffer. Now you have asked to visit the file normally,
1896 but Emacs can only visit a file in one way at a time.
1903 rawfile truename number))
1907 "\
1908 Do you want to discard your changes, and visit the file literally now? "
1909 "\
1912 rawfile truename number)
1918 "The file %s is already visited normally.
1919 You have asked to visit it literally,
1920 meaning no coding system decoding, format conversion, or local variables.
1921 But Emacs can only visit a file in one way at a time.
1923 Do you want to revisit the file literally now? "
1924 "The file %s is already visited literally,
1925 meaning no coding system decoding, format conversion, or local variables.
1926 You have asked to visit it normally,
1927 but Emacs can only visit a file in one way at a time.
1932 rawfile truename number)
1935 ;; Return the buffer we are using.
1936 buf)
1937 ;; Create a new buffer.
1939 ;; find-file-noselect-1 may use a different buffer.
1941 rawfile truename number))))))
1947 ;; Needed in case we are re-visiting the file with a different
1948 ;; text representation.
1965 filename)))
1966 ;; Unconditionally set error
1976 filename)))
1977 ;; Run find-file-not-found-functions until one returns non-nil.
1979 ;; If they fail too, set error.
1981 ;; Record the file's truename, and maybe use that as visited name.
1989 ;; Set buffer's default directory to that of the file.
1991 ;; Turn off backup files for certain file names. Since
1992 ;; this is a permanent local, the major mode won't eliminate it.
2007 \f
2009 "Like `insert-file-contents', but only reads in the file literally.
2010 A buffer may be modified in several ways after reading into the buffer,
2011 to Emacs features such as format decoding, character code
2012 conversion, `find-file-hook', automatic uncompression, etc.
2014 This function ensures that none of these modifications will take place."
2022 nil))
2025 inhibit-file-name-handlers))
2038 filename)))
2039 ;; Check whether the file is uncommonly large
2050 "Insert contents of file FILENAME into buffer after point with no conversion.
2052 This function is meant for the user to run interactively.
2053 Don't call it from programs! Use `insert-file-contents-literally' instead.
2054 \(Its calling sequence is different; see its documentation)."
2059 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2064 "Visit file FILENAME with no conversion of any kind.
2065 Format conversion and character code conversion are both disabled,
2066 and multibyte characters are disabled in the resulting buffer.
2067 The major mode used is Fundamental mode regardless of the file name,
2068 and local variable specifications in the file are ignored.
2069 Automatic uncompression and adding a newline at the end of the
2070 file due to `require-final-newline' is also disabled.
2072 You cannot absolutely rely on this function to result in
2073 visiting the file literally. If Emacs already has a buffer
2074 which is visiting the file, you get the existing buffer,
2075 regardless of whether it was created literally or not.
2077 In a Lisp program, if you want to be sure of accessing a file's
2078 contents literally, you should create a temporary buffer and then read
2079 the file contents into it using `insert-file-contents-literally'."
2082 "Find file literally: " nil default-directory
2085 \f
2089 after-find-file-from-revert-buffer
2090 nomodes)
2091 "Called after finding a file and by the default revert function.
2092 Sets buffer mode, parses local variables.
2093 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2094 error in reading the file. WARN non-nil means warn if there
2095 exists an auto-save file more recent than the visited file.
2096 NOAUTO means don't mess with auto-save mode.
2097 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2098 means this call was from `revert-buffer'.
2099 Fifth arg NOMODES non-nil means don't alter the file's modes.
2100 Finishes by calling the functions in `find-file-hook'
2101 unless NOMODES is non-nil."
2104 nil
2114 ;; No need to warn if buffer is auto-saved
2115 ;; under the name of the visited file.
2117 auto-save-visited-file-name))
2120 buffer-file-name))
2140 ;; Make people do a little extra work (C-x C-q)
2141 ;; before altering a backup file.
2144 ;; When a file is marked read-only,
2145 ;; make the buffer read-only even if root is looking at it.
2153 ;; If requested, add a newline at the end of the file.
2163 view-read-only
2169 "Eval BODY and turn any error into a FORMAT message.
2170 FORMAT can have a %s escape which will be replaced with the actual error.
2171 If `debug-on-error' is set, errors are not caught, so that you can
2172 debug them.
2173 Avoid using a large BODY since it is duplicated."
2182 "Choose the major mode for this buffer automatically.
2183 Also sets up any specified local variables of the file.
2184 Uses the visited file name, the -*- line, and the local variables spec.
2186 This function is called automatically from `find-file'. In that case,
2187 we may set up the file-specified mode and local variables,
2188 depending on the value of `enable-local-variables'.
2189 In addition, if `local-enable-local-variables' is nil, we do
2190 not set local variables (though we do notice a mode specified with -*-.)
2192 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2193 or from Lisp without specifying the optional argument FIND-FILE;
2194 in that case, this function acts as if `enable-local-variables' were t."
2202 ;; Turn font lock off and on, to make sure it takes account of
2203 ;; whatever file local variables are relevant to it.
2205 ;; Font-lock-mode (now in font-core.el) can be ON when
2206 ;; font-lock.el still hasn't been loaded.
2216 "Non-nil means to try second pass through `auto-mode-alist'.
2217 This means that if the first case-sensitive search through the alist fails
2218 to find a matching major mode, a second case-insensitive search is made.
2219 On systems with case-insensitive file names, this variable is ignored,
2220 since only a single case-insensitive search through the alist is made."
2226 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2227 ;; c++-mode, java-mode and more) are added through autoload
2228 ;; directives in that file. That way is discouraged since it
2229 ;; spreads out the definition of the initial value.
2273 ;; Less common extensions come here
2274 ;; so more common ones above are found faster.
2282 ;; Besides .gdbinit, gdb documents other names to be usable for init
2283 ;; files, cross-debuggers can use something like
2284 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2285 ;; don't interfere with each other.
2323 ;; The list of archive file extensions should be in sync with
2324 ;; `auto-coding-alist' with `no-conversion' coding system.
2330 ;; Mailer puts message to be edited in
2331 ;; /tmp/Re.... or Message
2334 ;; some news reader is reported to use this
2343 ;; .emacs or .gnus or .viper following a directory delimiter in
2344 ;; Unix, MSDOG or VMS syntax.
2347 ;; _emacs following a directory delimiter
2348 ;; in MsDos syntax
2352 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2353 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2354 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2357 ;; .xs is also used for ld scripts, but seems to be more commonly
2358 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2360 ;; Explained in binutils ld/genscripts.sh. Eg:
2361 ;; A .x script file is the default script.
2362 ;; A .xr script is for linking without relocation (-r flag). Etc.
2366 ;; Common Lisp ASDF package system.
2384 ;; Windows candidates may be opened case sensitively on Unix
2390 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2392 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2393 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2394 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2395 ;; this has lower priority to avoid matching changelog.sgml etc.
2397 ;; either user's dot-files or under /etc or some such
2399 ;; alas not all ~/.*rc files are like this
2400 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2405 ;; this contains everything twice, with space and with colon :-(
2407 ;; Get rid of any trailing .n.m and try again.
2408 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2409 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2410 ;; Using mode nil rather than `ignore' would let the search continue
2411 ;; through this list (with the shortened name) rather than start over.
2413 ;; The following should come after the ChangeLog pattern
2414 ;; for the sake of ChangeLog.1, etc.
2415 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2418 "Alist of filename patterns vs corresponding major mode functions.
2419 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2420 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2421 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2422 mode function to use. FUNCTION will be called, unless it is nil.
2424 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2425 calling FUNCTION (if it's not nil), we delete the suffix that matched
2426 REGEXP and search the list again for another match.
2428 If the file name matches `inhibit-first-line-modes-regexps',
2429 then `auto-mode-alist' is not processed.
2431 The extensions whose FUNCTION is `archive-mode' should also
2432 appear in `auto-coding-alist' with `no-conversion' coding system.
2434 See also `interpreter-mode-alist', which detects executable script modes
2435 based on the interpreters they specify to run,
2440 "Select Conf mode or XML mode according to start of file."
2450 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2451 ;; and pike-mode) are added through autoload directives in that
2452 ;; file. That way is discouraged since it spreads out the
2453 ;; definition of the initial value.
2492 "Alist mapping interpreter names to major modes.
2493 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2494 Each element looks like (INTERPRETER . MODE).
2495 If INTERPRETER matches the name of the interpreter specified in the first line
2496 of a script, mode MODE is enabled.
2504 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2505 When checking `inhibit-first-line-modes-regexps', we first discard
2511 "Regexp matching interpreters, for file mode determination.
2512 This regular expression is matched against the first line of a file
2513 to determine the file's mode in `set-auto-mode'. If it matches, the file
2514 is assumed to be interpreted by the interpreter matched by the second group
2515 of the regular expression. The mode is then determined as the mode
2519 "Alist of buffer beginnings vs. corresponding major mode functions.
2520 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2521 After visiting a file, if REGEXP matches the text at the beginning of the
2522 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2523 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2524 major mode.
2526 If FUNCTION is nil, then it is not called. (That is a way of saying
2534 ;; The < comes before the groups (but the first) to reduce backtracking.
2535 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2536 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2540 comment-re "*"
2543 . html-mode)
2545 ;; These two must come after html, because they are more general:
2550 . sgml-mode)
2553 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2554 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2555 After visiting a file, if REGEXP matches the text at the beginning of the
2556 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2557 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2558 have not specified a mode for this file.
2564 "Upper limit on `magic-mode-alist' regexp matches.
2568 "Select major mode appropriate for current buffer.
2570 To find the right major mode, this function checks for a -*- mode tag,
2571 checks if it uses an interpreter listed in `interpreter-mode-alist',
2572 matches the buffer beginning against `magic-mode-alist',
2573 compares the filename against the entries in `auto-mode-alist',
2574 then matches the buffer beginning against `magic-fallback-mode-alist'.
2576 It does not check for the `mode:' local variable in the
2577 Local Variables section of the file; for that, use `hack-local-variables'.
2579 If `enable-local-variables' is nil, this function does not check for a
2580 -*- mode tag.
2582 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2583 set the major mode only if that would change it. In other words
2584 we don't actually set it to the same mode the buffer already has."
2585 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2587 ;; Find a -*- mode tag
2594 ;; Find all specifications for the `mode:' variable
2595 ;; and execute them left to right.
2607 modes)))
2608 ;; Simple -*-MODE-*- case.
2611 modes))))
2612 ;; If we found modes to use, invoke them now, outside the save-excursion.
2620 ;; continuing would call minor modes again, toggling them off
2622 ;; If we didn't, look for an interpreter specified in the first line.
2623 ;; As a special case, allow for things like "#!/bin/env perl", which
2624 ;; finds the interpreter anywhere in $PATH.
2631 ;; Map interpreter name to a mode, signalling we're done at the
2632 ;; same time.
2634 interpreter-mode-alist))
2635 ;; If we found an interpreter mode to use, invoke it now.
2638 ;; Next try matching the buffer beginning against magic-mode-alist.
2652 ;; Next compare the filename against the entries in auto-mode-alist.
2657 ;; Remove remote file name identification.
2661 ;; Remove backup-suffixes from file name.
2664 ;; Find first matching alist entry.
2667 ;; System is case-insensitive.
2671 ;; System is case-sensitive.
2673 ;; First match case-sensitively.
2677 ;; Fallback to case-insensitive match.
2691 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2706 ;; When `keep-mode-if-same' is set, we are working on behalf of
2707 ;; set-visited-file-name. In that case, if the major mode specified is the
2708 ;; same one we already have, don't actually reset it. We don't want to lose
2709 ;; minor modes such as Font Lock.
2711 "Apply MODE and return it.
2712 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2713 any aliases and compared to current major mode. If they are the
2714 same, do nothing and return nil."
2720 mode)))
2723 "Find the -*- spec in the buffer.
2724 Call with point at the place to start searching from.
2725 If one is found, set point to the beginning
2726 and return the position of the end.
2727 Otherwise, return nil; point may be changed."
2730 ;; Don't look for -*- if this file name matches any
2731 ;; of the regexps in inhibit-first-line-modes-regexps.
2739 sufs)
2747 ;; If the file begins with "#!"
2748 ;; (exec interpreter magic), look
2749 ;; for mode frobs in the first two
2750 ;; lines. You cannot necessarily
2751 ;; put them in the first line of
2752 ;; such a file without screwing up
2753 ;; the interpreter invocation.
2754 ;; The same holds for
2755 ;; '\"
2756 ;; in man pages (preprocessor
2757 ;; magic for the `man' program).
2768 end))))
2769 \f
2770 ;;; Handling file local variables
2774 file-local-variables-alist dir-local-variables-alist)
2779 "Normal hook run after processing a file's local variables specs.
2780 Major modes can use this to examine user-specified local variables
2784 "List variable-value pairs that are considered safe.
2785 Each element is a cons cell (VAR . VAL), where VAR is a variable
2786 symbol and VAL is a value that is considered safe."
2787 :risky t
2794 "Expressions that are considered safe in an `eval:' local variable.
2795 Add expressions to this list if you want Emacs to evaluate them, when
2796 they appear in an `eval' local variable specification, without first
2797 asking you for confirmation."
2798 :risky t
2803 ;; Risky local variables:
2806 buffer-auto-save-file-name
2807 buffer-file-name
2808 buffer-file-truename
2809 buffer-undo-list
2810 debugger
2811 default-text-properties
2812 eval
2813 exec-directory
2814 exec-path
2815 file-name-handler-alist
2816 frame-title-format
2817 global-mode-string
2818 header-line-format
2819 icon-title-format
2820 inhibit-quit
2821 load-path
2822 max-lisp-eval-depth
2823 max-specpdl-size
2824 minor-mode-map-alist
2825 minor-mode-overriding-map-alist
2826 mode-line-format
2827 mode-name
2828 overriding-local-map
2829 overriding-terminal-local-map
2830 process-environment
2831 standard-input
2832 standard-output
2833 unread-command-events))
2835 ;; Safe local variables:
2836 ;;
2837 ;; For variables defined by major modes, the safety declarations can go into
2838 ;; the major mode's file, since that will be loaded before file variables are
2839 ;; processed.
2840 ;;
2841 ;; For variables defined by minor modes, put the safety declarations in the
2842 ;; file defining the minor mode after the defcustom/defvar using an autoload
2843 ;; cookie, e.g.:
2844 ;;
2845 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2846 ;;
2847 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2848 ;; minor mode file may not be loaded yet.
2849 ;;
2850 ;; For variables defined in the C source code the declaration should go here:
2871 "Alist of file-local variable settings in the current buffer.
2872 Each element in this list has the form (VAR . VALUE), where VAR
2873 is a file-local variable (a symbol) and VALUE is the value
2874 specified. The actual value in the buffer may differ from VALUE,
2879 "Alist of directory-local variable settings in the current buffer.
2880 Each element in this list has the form (VAR . VALUE), where VAR
2881 is a directory-local variable (a symbol) and VALUE is the value
2882 specified in .dir-locals.el. The actual value in the buffer
2883 may differ from VALUE, if it is changed by the major or minor modes,
2888 "Normal hook run before setting file-local variables.
2889 It is called after checking for unsafe/risky variables and
2890 setting `file-local-variables-alist', and before applying the
2891 variables stored in `file-local-variables-alist'. A hook
2892 function is allowed to change the contents of this alist.
2894 This hook is called only if there is at least one file-local
2898 "Get confirmation before setting up local variable values.
2899 ALL-VARS is the list of all variables to be set up.
2900 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2901 RISKY-VARS is the list of those that are marked as risky.
2902 DIR-NAME is a directory name if these settings come from
2903 directory-local variables, or nil otherwise."
2905 nil
2911 prompt char)
2921 ", and variables that are risky (**)."
2928 y -- to apply the local variables list.
2932 ! -- to apply the local variables list, and permanently mark these
2944 ;; Make strings with embedded whitespace easier to read.
2952 ""
2959 done)
2968 ;; read-event returns -1 if we are in a kbd
2969 ;; macro and there are no more events in the
2970 ;; macro. In that case, attempt to get an
2971 ;; event interactively.
2979 ;; When this is called from desktop-restore-file-buffer,
2980 ;; coding-system-for-read may be non-nil. Reset it before
2981 ;; writing to .emacs.
2985 'safe-local-variable-values
2986 safe-local-variable-values))))
2993 "Return local variables specified in the -*- line.
2994 Ignore any specification for `mode:' and `coding:';
2995 `set-auto-mode' should already have handled `mode:',
2996 `set-auto-coding' should already have handled `coding:'.
2998 If MODE-ONLY is non-nil, all we do is check whether the major
2999 mode is specified, returning t if it is specified. Otherwise,
3000 return an alist of elements (VAR . VAL), where VAR is a variable
3001 and VAL is the specified value."
3005 result mode-specified)
3006 ;; Parse the -*- line into the RESULT alist.
3007 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
3009 nil)
3011 ;; Simple form: "-*- MODENAME -*-". Already handled.
3013 nil)
3015 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3016 ;; (last ";" is optional).
3021 ;; There used to be a downcase here,
3022 ;; but the manual didn't say so,
3023 ;; and people want to set var names that aren't all lc.
3029 ;; It is traditional to ignore
3030 ;; case when checking for `mode' in set-auto-mode,
3031 ;; so we must do that here as well.
3032 ;; That is inconsistent, but we're stuck with it.
3033 ;; The same can be said for `coding' in set-auto-coding.
3039 'eval
3046 mode-specified
3047 result))))
3050 "Filter local variable settings, querying the user if necessary.
3051 VARIABLES is the alist of variable-value settings. This alist is
3052 filtered based on the values of `ignored-local-variables',
3053 `enable-local-eval', `enable-local-variables', and (if necessary)
3054 user interaction. The results are added to
3055 `file-local-variables-alist', without applying them.
3056 DIR-NAME is a directory name if these settings come from
3057 directory-local variables, or nil otherwise."
3058 ;; Find those variables that we may want to save to
3059 ;; `safe-local-variable-values'.
3065 ;; Ignore any variable in `ignored-local-variables'.
3066 nil)
3067 ;; Obey `enable-local-eval'.
3075 ;; Ignore duplicates (except `mode') in the present list.
3077 ;; Accept known-safe variables.
3081 ;; The variable is either risky or unsafe:
3088 ;; Query, unless all vars are safe or user wants no querying.
3094 risky-vars dir-name))
3105 "Parse and put into effect this buffer's local variables spec.
3106 If MODE-ONLY is non-nil, all we do is check whether the major mode
3107 is specified, returning t if it is specified."
3110 result)
3117 ;; Look for "Local variables:" line in last page.
3125 ;; suffix is what comes after "local variables:" in its line.
3126 ;; prefix is what comes before "local variables:" in its line.
3136 beg)
3140 endpos
3146 nil t))
3147 ;; This used to be an error, but really all it means is
3148 ;; that this may simply not be a local-variables section,
3149 ;; so just ignore it.
3159 ;; Discard the prefix.
3164 ;; Discard the suffix.
3172 ;; Find the variable name; strip whitespace.
3181 val)
3182 ;; Read the variable value.
3193 'eval
3198 ;; Now we've read all the local variables.
3199 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3201 ;; Otherwise, set the variables.
3208 ;; Any 'evals must run in the Right sequence.
3217 "Non-nil if SYM is safe as a file-local variable with value VAL.
3218 It is safe if any of these conditions are met:
3220 * There is a matching entry (SYM . VAL) in the
3221 `safe-local-variable-values' user option.
3223 * The `safe-local-variable' property of SYM is a function that
3224 evaluates to a non-nil value with VAL as an argument."
3228 ;; If the function signals an error, that means it
3229 ;; can't assure us that the value is safe.
3233 "Non-nil if SYM could be dangerous as a file-local variable.
3234 It is dangerous if either of these conditions are met:
3236 * Its `risky-local-variable' property is non-nil.
3242 ;; If this is an alias, check the base name.
3262 "Return t if it is safe to eval EXP when it is found in a file."
3264 ;; Detect certain `put' expressions.
3271 lisp-indent-function
3272 scheme-indent-function))
3273 ;; Only allow safe values (not functions).
3278 ;; Only allow indirect form specs.
3279 ;; During bootstrapping, edebug-basic-spec might not be
3280 ;; defined yet.
3284 ;; Allow expressions that the user requested.
3286 ;; Certain functions can be allowed with safe arguments
3287 ;; or can specify verification functions to try.
3295 ok))
3303 ok)))))))
3306 "Set local variable VAR with value VAL.
3307 If VAR is `mode', call `VAL-mode' as a function unless it's
3308 already the major mode."
3315 ;; A minor mode must be passed an argument.
3316 ;; Otherwise, if the user enables the minor mode in a
3317 ;; major mode hook, this would toggle it off.
3323 ;; Make sure the string has no text properties.
3324 ;; Some text properties can get evaluated in various ways,
3325 ;; so it is risky to put them on with a local variable list.
3329 \f
3330 ;;; Handling directory-local variables, aka project settings.
3336 "List of cached directory roots for directory-local variable classes.
3337 Each element in this list has the form (DIR CLASS MTIME).
3338 DIR is the name of the directory.
3339 CLASS is the name of a variable class (a symbol).
3340 MTIME is the recorded modification time of the directory-local
3341 variables file associated with this entry. This time is a list
3342 of two integers (the same format as `file-attributes'), and is
3343 used to test whether the cache entry is still valid.
3344 Alternatively, MTIME can be nil, which means the entry is always
3348 "Return the variable list for CLASS."
3352 "Collect directory-local variables from MODE-VARIABLES.
3353 VARIABLES is the initial list of variables.
3354 Returns the new list."
3359 ;; If variables are specified more than once, only use the last. (Why?)
3360 ;; The pseudo-variables mode and eval are different (bug#3430).
3363 ;; Need a new cons in case we setcdr later.
3367 "Collect entries from CLASS-VARIABLES into VARIABLES.
3368 ROOT is the root directory of the project.
3369 Return the new variables list."
3377 ;; Don't include this in the previous condition, because we
3378 ;; want to filter all strings before the next condition.
3390 "Declare that the DIRECTORY root is an instance of CLASS.
3391 DIRECTORY is the name of a directory, a string.
3392 CLASS is the name of a project class, a symbol.
3393 MTIME is either the modification time of the directory-local
3394 variables file that defined this class, or nil.
3396 When a file beneath DIRECTORY is visited, the mode-specific
3397 variables from CLASS are applied to the buffer. The variables
3398 for a class are defined using `dir-locals-set-class-variables'."
3405 "Map the type CLASS to a list of variable settings.
3406 CLASS is the project class, a symbol. VARIABLES is a list
3407 that declares directory-local variables for the class.
3408 An element in VARIABLES is either of the form:
3409 (MAJOR-MODE . ALIST)
3410 or
3411 (DIRECTORY . LIST)
3413 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3414 whose elements are of the form (VARIABLE . VALUE).
3416 In the second form, DIRECTORY is a directory name (a string), and
3417 LIST is a list of the form accepted by the function.
3419 When a file is visited, the file's class is found. A directory
3420 may be assigned a class using `dir-locals-set-directory-class'.
3421 Then variables are set in the file's buffer according to the
3422 class' LIST. The list is processed in order.
3424 * If the element is of the form (MAJOR-MODE . ALIST), and the
3425 buffer's major mode is derived from MAJOR-MODE (as determined
3426 by `derived-mode-p'), then all the variables in ALIST are
3427 applied. A MAJOR-MODE of nil may be used to match any buffer.
3428 `make-local-variable' is called for each variable before it is
3429 set.
3431 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3432 is an initial substring of the file's directory, then LIST is
3433 applied by recursively following these rules."
3440 "File that contains directory-local variables.
3441 It has to be constant to enforce uniform values
3445 "Find the directory-local variables for FILE.
3446 This searches upward in the directory tree from FILE.
3447 If the directory root of FILE has been registered in
3448 `dir-locals-directory-cache' and the directory-local variables
3449 file has not been modified, return the matching entry in
3450 `dir-locals-directory-cache'.
3451 Otherwise, if a directory-local variables file is found, return
3452 the file name.
3453 Otherwise, return nil."
3458 dir-locals-file))
3461 ;; `locate-dominating-file' may have abbreviated the name.
3464 ;; Find the best cached value in `dir-locals-directory-cache'.
3477 ;; Check the validity of the cache.
3482 ;; This cache entry is OK.
3483 dir-elt
3484 ;; This cache entry is invalid; clear it.
3487 locals-file)
3488 locals-file))))
3491 "Load a variables FILE and register a new class and instance.
3492 FILE is the name of the file holding the variables to apply.
3493 The new class name is the same as the directory in which FILE
3494 is found. Returns the new class name."
3504 class-name)))
3507 "Read per-directory local variables for the current buffer.
3508 Store the directory-local variables in `dir-local-variables-alist'
3509 and `file-local-variables-alist', without applying them."
3512 ;; Find the variables file.
3518 (setq dir-name (if (buffer-file-name) (file-name-directory (buffer-file-name)) default-directory))
3539 \f
3542 However, the mode will not be changed if
3543 \(1) a local variables list or the `-*-' line specifies a major mode, or
3545 \ not suitable for ordinary files, or
3546 \(3) the new file name does not particularly specify any mode."
3551 "Change name of file visited in current buffer to FILENAME.
3552 This also renames the buffer to correspond to the new file.
3553 The next time the buffer is saved it will go in the newly specified file.
3554 FILENAME nil or an empty string means mark buffer as not visiting any file.
3555 Remember to delete the initial contents of the minibuffer
3556 if you wish to pass an empty string as the argument.
3558 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3559 confirmation in the case where another buffer is already visiting FILENAME.
3561 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3562 the old visited file has been renamed to the new name FILENAME."
3570 nil
3585 filename)))
3595 ;; If new-name == old-name, renaming would add a spurious <2>
3596 ;; and it's considered as a feature in rename-buffer.
3602 ;; Abbreviate the file names of the buffer.
3611 nil)))
3612 ;; write-file-functions is normally used for things like ftp-find-file
3613 ;; that visit things that are not local files as if they were files.
3614 ;; Changing to visit an ordinary local file instead should flush the hook.
3619 ;; If buffer was read-only because of version control,
3620 ;; that reason is gone now, so make it writable.
3624 ;; Turn off backup files for certain file names.
3625 ;; Since this is a permanent local, the major mode won't eliminate it.
3627 backup-enable-predicate
3633 ;; If auto-save was not already on, turn it on if appropriate.
3637 ;; If auto save is on, start using a new name.
3638 ;; We deliberately don't rename or delete the old auto save
3639 ;; for the old visited file name. This is because perhaps
3640 ;; the user wants to save the new state and then compare with the
3641 ;; previous state from the auto save file.
3644 ;; Rename the old auto save file if any.
3651 ;; Update the major mode, if the file name determines it.
3653 ;; Don't change the mode if it is special.
3656 ;; Don't change the mode if the local variable list specifies it.
3662 "Write current buffer into file FILENAME.
3663 This makes the buffer visit that file, and marks it as not modified.
3665 If you specify just a directory name as FILENAME, that means to use
3666 the default file name but in that directory. You can also yank
3667 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3669 If the buffer is not already visiting a file, the default file name
3670 for the output file is the buffer name.
3672 If optional second arg CONFIRM is non-nil, this function
3673 asks for confirmation before overwriting an existing file.
3674 Interactively, confirmation is required unless you supply a prefix argument."
3675 ;; (interactive "FWrite file: ")
3679 nil nil nil nil)
3683 default-directory)
3684 nil nil))
3688 ;; If arg is just a directory,
3689 ;; use the default file name, but in that directory.
3700 ;; Make buffer writable if file is writable.
3705 ;; It's likely that the VC status at the new location is different from
3706 ;; the one at the old location.
3708 \f
3710 "Make a backup of the disk file visited by the current buffer, if appropriate.
3711 This is normally done before saving the buffer the first time.
3713 A backup may be done by renaming or by copying; see documentation of
3714 variable `make-backup-files'. If it's done by renaming, then the file is
3715 no longer accessible under its old name.
3717 The value is non-nil after a backup was made by renaming.
3718 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3719 MODES is the result of `file-modes' on the original
3720 file; this means that the caller, after saving the buffer, should change
3721 the modes of the new file to agree with the old modes.
3722 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3723 file; this means that the caller, after saving the buffer, should change
3724 the SELinux context of the new file to agree with the old context.
3725 BACKUPNAME is the backup file name, which is the old file renamed."
3732 backup-info backupname targets setmodes)
3733 ;; If specified name is a symbolic link, chase it to the target.
3734 ;; Thus we make the backups in the directory where the real file is.
3739 ;; (if (file-directory-p buffer-file-name)
3740 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3744 ;; If have old versions to maybe delete,
3745 ;; ask the user to confirm now, before doing anything.
3746 ;; But don't actually delete til later.
3751 real-file-name)))))
3754 ;; Actually write the back up file.
3757 ; (file-symlink-p buffer-file-name)
3758 backup-by-copying
3759 ;; Don't rename a suid or sgid file.
3774 ;; rename-file should delete old backup.
3778 ;; If trouble writing the backup, write it in ~.
3783 backupname)
3787 ;; Now delete the old versions, if desired.
3794 setmodes)
3801 ;; Create temp files with strict access rights. It's easy to
3802 ;; loosen them later, whereas it's impossible to close the
3803 ;; time-window of loose permissions otherwise.
3806 ;; Try to overwrite old backup first.
3814 nil)
3816 ;; The file was somehow created by someone else between
3817 ;; `delete-file' and `copy-file', so let's try again.
3818 ;; rms says "I think there is also a possible race
3819 ;; condition for making backup files" (emacs-devel 20070821).
3820 nil)))
3821 ;; Reset the umask.
3829 "Return file NAME sans backup versions or strings.
3830 This is a separate procedure so your site-init or startup file can
3831 redefine it.
3832 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3833 we do not remove backup version numbers, only true file version numbers."
3845 "Return t if deleting FILE and rewriting it would preserve the owner."
3850 ;; Return t if the file doesn't exist, since it's true that no
3851 ;; information would be lost by an (attempted) delete and create.
3857 The extension, in a file name, is the part that follows the last `.',
3858 except that a leading `.', if any, doesn't count."
3861 directory)
3865 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3866 ;; we don't want to expand it.
3869 filename))))
3873 The extension, in a file name, is the part that follows the last `.',
3874 excluding version numbers and backup suffixes,
3875 except that a leading `.', if any, doesn't count.
3876 Return nil for extensionless file names such as `foo'.
3877 Return the empty string for file names such as `foo.'.
3879 If PERIOD is non-nil, then the returned value includes the period
3880 that delimits the extension, and if FILENAME has no extension,
3891 "A function to use instead of the default `make-backup-file-name'.
3892 A value of nil gives the default `make-backup-file-name' behavior.
3894 This could be buffer-local to do something special for specific
3895 files. If you define it, you may need to change `backup-file-name-p'
3896 and `file-name-sans-versions' too.
3898 See also `backup-directory-alist'."
3904 "Alist of filename patterns and backup directory names.
3905 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3906 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3907 relative or absolute. If it is absolute, so that all matching files
3908 are backed up into the same directory, the file names in this
3909 directory will be the full name of the file backed up with all
3910 directory separators changed to `!' to prevent clashes. This will not
3911 work correctly if your filesystem truncates the resulting name.
3913 For the common case of all backups going into one directory, the alist
3915 directory name.
3917 If this variable is nil, or it fails to match a filename, the backup
3918 is made in the original file's directory.
3920 On MS-DOS filesystems without long names this variable is always
3921 ignored."
3927 "Default `backup-enable-predicate' function.
3928 Checks for files in `temporary-file-directory',
3929 `small-temporary-file-directory', and /tmp."
3932 ;; Directory is under temporary-file-directory.
3937 ;; Directory is under /tmp.
3942 0 nil
3944 ;; Directory is under small-temporary-file-directory.
3949 "Create the non-numeric backup file name for FILE.
3950 Normally this will just be the file's name with `~' appended.
3951 Customization hooks are provided as follows.
3953 If the variable `make-backup-file-name-function' is non-nil, its value
3954 should be a function which will be called with FILE as its argument;
3955 the resulting name is used.
3957 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3958 the documentation of that variable. If the directory for the backup
3959 doesn't exist, it is created."
3973 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3975 elt backup-directory abs-backup-directory)
3980 alist nil)))
3981 ;; If backup-directory is relative, it should be relative to the
3982 ;; file's directory. By expanding explicitly here, we avoid
3983 ;; depending on default-directory.
3992 abs-backup-directory nil))))
3994 file
3998 ;; Normalize DOSish file names: downcase the drive
3999 ;; letter, if any, and replace the leading "x:" with
4000 ;; "/drive_x".
4003 ;; Replace any invalid file-name characters (for the
4004 ;; case of backing up remote files).
4008 "drive_"
4011 ""
4014 ;; Make the name unique by substituting directory
4015 ;; separators. It may not really be worth bothering about
4016 ;; doubling `!'s in the original name...
4021 backup-directory))
4026 "Return non-nil if FILE is a backup file name (numeric or not).
4027 This is a separate function so you can redefine it for customization.
4028 You may need to redefine `file-name-sans-versions' as well."
4033 ;; This is used in various files.
4034 ;; The usage of backup-extract-version-start is not very clean,
4035 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4037 "Given the name of a numeric backup file, FN, return the backup number.
4038 Uses the free variable `backup-extract-version-start', whose value should be
4039 the index in the name where the version number begins."
4046 "Find a file name for a backup file FN, and suggestions for deletions.
4047 Value is a list whose car is the name for the backup file
4048 and whose cdr is a list of old versions to consider deleting now.
4049 If the value is nil, don't make a backup.
4050 Uses `backup-directory-alist' in the same way as does
4051 `make-backup-file-name'."
4053 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4057 ;; We don't support numbered backups on plain MS-DOS
4058 ;; when long file names are unavailable.
4068 possibilities deserve-versions-p versions)
4071 base-versions
4074 possibilities)
4075 #'<)
4080 kept-old-versions
4081 kept-new-versions
4088 ;; Delete nothing if there is overflow
4089 ;; in the number of versions to keep.
4095 v))))))))))
4098 "Return number of names file FILENAME has."
4101 ;; (defun file-relative-name (filename &optional directory)
4102 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4103 ;; This function returns a relative file name which is equivalent to FILENAME
4104 ;; when used with that default directory as the default.
4105 ;; If this is impossible (which can happen on MSDOS and Windows
4106 ;; when the file name and directory use different drive names)
4107 ;; then it returns FILENAME."
4108 ;; (save-match-data
4109 ;; (let ((fname (expand-file-name filename)))
4110 ;; (setq directory (file-name-as-directory
4111 ;; (expand-file-name (or directory default-directory))))
4112 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4113 ;; ;; drive names, they can't be relative, so return the absolute name.
4114 ;; (if (and (or (eq system-type 'ms-dos)
4115 ;; (eq system-type 'cygwin)
4116 ;; (eq system-type 'windows-nt))
4117 ;; (not (string-equal (substring fname 0 2)
4118 ;; (substring directory 0 2))))
4119 ;; filename
4120 ;; (let ((ancestor ".")
4121 ;; (fname-dir (file-name-as-directory fname)))
4122 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4123 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4124 ;; (setq directory (file-name-directory (substring directory 0 -1))
4125 ;; ancestor (if (equal ancestor ".")
4126 ;; ".."
4127 ;; (concat "../" ancestor))))
4128 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4129 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4130 ;; ;; We matched within FNAME's directory part.
4131 ;; ;; Add the rest of FNAME onto ANCESTOR.
4132 ;; (let ((rest (substring fname (match-end 0))))
4133 ;; (if (and (equal ancestor ".")
4134 ;; (not (equal rest "")))
4135 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4136 ;; rest
4137 ;; (concat (file-name-as-directory ancestor) rest)))
4138 ;; ;; We matched FNAME's directory equivalent.
4139 ;; ancestor))))))
4142 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4143 This function returns a relative file name which is equivalent to FILENAME
4144 when used with that default directory as the default.
4145 If FILENAME and DIRECTORY lie on different machines or on different drives
4146 on a DOS/Windows machine, it returns FILENAME in expanded form."
4150 default-directory))))
4156 ;; Test for different drives on DOS/Windows
4158 ;; Should `cygwin' really be included here? --stef
4161 ;; Test for different remote file system identification
4163 filename
4169 directory nil nil case-fold-search))
4171 directory nil nil case-fold-search))))
4174 ".."
4176 ;; Now ancestor is empty, or .., or ../.., etc.
4178 directory nil nil case-fold-search))
4179 ;; We matched within FILENAME's directory part.
4180 ;; Add the rest of FILENAME onto ANCESTOR.
4183 ;; But don't bother with ANCESTOR if it would give us `./'.
4184 rest
4186 ;; We matched FILENAME's directory equivalent.
4187 ancestor))))))
4188 \f
4190 "Save current buffer in visited file if modified.
4191 Variations are described below.
4193 By default, makes the previous version into a backup file
4194 if previously requested or if this is the first save.
4196 to become a backup when the next save is done.
4198 unconditionally makes the previous version into a backup file.
4200 to become a backup when the next save is done,
4201 and unconditionally makes the previous version into a backup file.
4203 With a numeric argument of 0, never make the previous version
4204 into a backup file.
4206 If a file's name is FOO, the names of its numbered backup versions are
4207 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4208 Numeric backups (rather than FOO~) will be made if value of
4209 `version-control' is not the atom `never' and either there are already
4210 numeric versions of the file being backed up, or `version-control' is
4211 non-nil.
4212 We don't want excessive versions piling up, so there are variables
4213 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4214 and `kept-new-versions', which tells how many newest versions to keep.
4215 Defaults are 2 old versions and 2 new.
4216 `dired-kept-versions' controls dired's clean-directory (.) command.
4217 If `delete-old-versions' is nil, system will query user
4218 before trimming versions. Otherwise it does it silently.
4220 If `vc-make-backup-files' is nil, which is the default,
4221 no backup files are made for files managed by version control.
4222 (This is because the version control system itself records previous versions.)
4224 See the subroutine `basic-save-buffer' for more information."
4230 ;; We used to display the message below only for files > 50KB, but
4231 ;; then Rmail-mbox never displays it due to buffer swapping. If
4232 ;; the test is ever re-introduced, be sure to handle saving of
4233 ;; Rmail files.
4240 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4241 Normally delete only if the file was written by this Emacs since
4242 the last real save, but optional arg FORCE non-nil means delete anyway."
4256 "Normal hook that is run before a buffer is saved to its file."
4262 "Normal hook that is run after a buffer is saved to its file."
4268 "If non-nil, use this coding system for saving the buffer.
4269 More precisely, use this coding system in place of the
4270 value of `buffer-file-coding-system', when saving the buffer.
4271 Calling `write-region' for any purpose other than saving the buffer
4272 will still use `buffer-file-coding-system'; this variable has no effect
4279 "Save the current buffer in its visited file, if it has been modified.
4280 The hooks `write-contents-functions' and `write-file-functions' get a chance
4281 to do the job of saving; if they do not, then the buffer is saved in
4282 the visited file in the usual way.
4283 Before and after saving the buffer, this function runs
4284 `before-save-hook' and `after-save-hook', respectively."
4287 ;; In an indirect buffer, save its base buffer instead.
4292 setmodes)
4293 ;; If buffer has no file name, ask user for one.
4300 ;; Signal an error if the user specified the name of an
4301 ;; existing directory.
4304 filename))
4306 ;; Signal an error if the specified name refers to a
4307 ;; non-existing directory.
4337 ;; Support VC version backups.
4343 ;; If a hook returned t, file is already "written".
4344 ;; Otherwise, write it the usual way now.
4346 ;; Now we have saved the current buffer. Let's make sure
4347 ;; that buffer-file-coding-system is fixed to what
4348 ;; actually used for saving by binding it locally.
4360 ;; If the auto-save file was recent before this command,
4361 ;; delete it now.
4363 ;; Support VC `implicit' locking.
4368 ;; This does the "real job" of writing a buffer into its visited file
4369 ;; and making a backup file. This is what is normally done
4370 ;; but inhibited if one of write-file-functions returns non-nil.
4371 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4383 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4397 buffer-file-name)))
4411 ;; Write temp name, then rename it.
4412 ;; This requires write access to the containing dir,
4413 ;; which is why we don't try it if we don't have that access.
4415 tempname succeed
4418 ;; Create temp files with strict access rights. It's easy to
4419 ;; loosen them later, whereas it's impossible to close the
4420 ;; time-window of loose permissions otherwise.
4425 ;; Try various temporary names.
4426 ;; This code follows the example of make-temp-file,
4427 ;; but it calls write-region in the appropriate way
4428 ;; for saving the buffer.
4434 ;; Pass in nil&nil rather than point-min&max
4435 ;; cause we're saving the whole buffer.
4436 ;; write-region-annotate-functions may use it.
4438 tempname nil realname
4440 nil)
4442 ;; The file was somehow created by someone else between
4443 ;; `make-temp-name' and `write-region', let's try again.
4444 nil)
4446 ;; Reset the umask.
4448 ;; If we failed, restore the buffer's modtime.
4451 ;; Since we have created an entirely new file,
4452 ;; make sure it gets the right permission bits set.
4457 buffer-file-name)))
4458 ;; We succeeded in writing the temp file,
4459 ;; so rename it.
4461 ;; If file not writable, see if we can make it writable
4462 ;; temporarily while we write it.
4463 ;; But no need to do so if we have just backed it up
4464 ;; (setmodes is set) because that says we're superseding.
4466 ;; Change the mode back, after writing.
4469 buffer-file-name))
4475 ;; Pass in nil&nil rather than point-min&max to indicate
4476 ;; we're saving the buffer rather than just a region.
4477 ;; write-region-annotate-functions may make us of it.
4479 buffer-file-name nil t buffer-file-truename)
4481 ;; If we get an error writing the new file, and we made
4482 ;; the backup by renaming, undo the backing-up.
4487 setmodes))
4490 "View the differences between BUFFER and its associated file.
4491 This requires the external program `diff' to be in your `exec-path'."
4505 ;; Display that message for 1 second so that user can read it
4506 ;; in the minibuffer.
4508 ;; return always nil, so that save-buffers-kill-emacs will not move
4509 ;; over to the next unsaved buffer when calling `d'.
4510 nil)
4513 `((?\C-r
4520 ;; Return nil to ask about BUF again.
4521 nil)
4533 ;; Return nil to ask about BUF again.
4534 nil)
4544 "Save some modified file-visiting buffers. Asks user about each one.
4545 You can answer `y' to save, `n' not to save, `C-r' to look at the
4546 buffer in question with `view-buffer' before deciding or `d' to
4547 view the differences using `diff-buffer-with-file'.
4549 Optional argument (the prefix) non-nil means save all with no questions.
4550 Optional second argument PRED determines which buffers are considered:
4551 If PRED is nil, all the file-visiting buffers are considered.
4552 If PRED is t, then certain non-file buffers will also be considered.
4553 If PRED is a zero-argument function, it indicates for each buffer whether
4554 to consider it or not when called with that buffer current.
4556 See `save-some-buffers-action-alist' if you want to
4557 change the additional actions you can take on files."
4561 files-done abbrevs-done)
4563 ;; First save any buffers that we're supposed to save unconditionally.
4564 ;; That way the following code won't ask about them.
4569 ;; Ask about those buffers that merit it,
4570 ;; and record the number thus saved.
4574 ;; Note that killing some buffers may kill others via
4575 ;; hooks (e.g. Rmail and its viewing buffer).
4588 t
4600 save-some-buffers-action-alist))
4601 ;; Maybe to save abbrevs, and record whether
4602 ;; we either saved them or asked to.
4608 abbrev-file-name)))
4610 ;; Don't keep bothering user if he says no.
4615 "(Some special files were saved without asking)"
4617 \f
4619 "Mark current buffer as unmodified, not needing to be saved.
4622 It is not a good idea to use this function in Lisp programs, because it
4623 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4630 "Change whether this buffer is read-only.
4631 With prefix argument ARG, make the buffer read-only if ARG is
4632 positive, otherwise make it writable. If buffer is read-only
4633 and `view-read-only' is non-nil, enter view mode."
4638 nil ; do nothing.
4639 ;; Toggle.
4646 ;; If view-mode is already active, `view-mode-enter' is a nop.
4658 "Insert contents of file FILENAME into buffer after point.
4659 Set mark after the inserted text.
4661 This function is meant for the user to run interactively.
4662 Don't call it from programs! Use `insert-file-contents' instead.
4663 \(Its calling sequence is different; see its documentation)."
4668 "Append the contents of the region to the end of file FILENAME.
4669 When called from a function, expects three arguments,
4670 START, END and FILENAME. START and END are normally buffer positions
4671 specifying the part of the buffer to write.
4672 If START is nil, that means to use the entire buffer contents.
4673 If START is a string, then output that string to the file
4674 instead of any buffer contents; END is ignored.
4676 This does character code conversion and applies annotations
4677 like `write-region' does."
4682 "Return most recent backup file for FILENAME or nil if no backups exist."
4683 ;; `make-backup-file-name' will get us the right directory for
4684 ;; ordinary or numeric backups. It might create a directory for
4685 ;; backups as a side-effect, according to `backup-directory-alist'.
4692 tem)
4701 newest))
4704 "Rename current buffer to a similar name not already taken.
4705 This function is useful for creating multiple shell process buffers
4706 or multiple mail buffers, etc."
4714 ;; If the existing buffer name has a <NNN>,
4715 ;; which isn't part of the file name (if any),
4716 ;; then get rid of that.
4722 "Create the directory DIR and optionally any nonexistent parent dirs.
4723 If DIR already exists as a directory, signal an error, unless
4724 PARENTS is non-nil.
4726 Interactively, the default choice of directory to create is the
4727 current buffer's default directory. That is useful when you have
4728 visited a file in a nonexistent directory.
4730 Noninteractively, the second (optional) argument PARENTS, if
4731 non-nil, says whether to create parent directories that don't
4732 exist. Interactively, this happens by default."
4735 nil nil)
4736 t))
4737 ;; If default-directory is a remote directory,
4738 ;; make sure we find its make-directory handler.
4746 create-list)
4748 ;; If directory is its own parent, then we can't
4749 ;; keep looping forever
4764 "Delete the directory named DIRECTORY. Does not follow symlinks.
4765 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4766 TRASH non-nil means to trash the directory instead, provided
4767 `delete-by-moving-to-trash' is non-nil.
4769 When called interactively, TRASH is t if no prefix argument is
4770 given. With a prefix argument, TRASH is nil."
4777 "Move directory to trash: "
4779 default-directory default-directory nil nil))))
4785 nil)
4787 ;; If default-directory is a remote directory, make sure we find its
4788 ;; delete-directory handler.
4795 ;; Only move non-empty dir to trash if recursive deletion was
4796 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4797 ;; case, where the operation fails in delete-directory-internal.
4798 ;; As `move-file-to-trash' trashes directories (empty or
4799 ;; otherwise) as a unit, we do not need to recurse here.
4801 ;; Check if directory is empty apart from "." and "..".
4806 ;; Otherwise, call outselves recursively if needed.
4810 ;; This test is equivalent to
4811 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4812 ;; but more efficient
4816 ;; We do not want to delete "." and "..".
4822 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4823 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4825 This function always sets the file modes of the output files to match
4826 the corresponding input file.
4828 The third arg KEEP-TIME non-nil means give the output files the same
4829 last-modified time as the old ones. (This works on only some systems.)
4831 A prefix arg makes KEEP-TIME non-nil.
4833 Noninteractively, the last argument PARENTS says whether to
4834 create parent directories if they don't exist. Interactively,
4835 this happens by default."
4842 default-directory default-directory nil nil)
4843 current-prefix-arg t)))
4844 ;; If default-directory is a remote directory, make sure we find its
4845 ;; copy-directory handler.
4851 ;; Compute target name.
4856 ;; Copy recursively.
4868 ;; We do not want to copy "." and "..".
4871 ;; Set directory attributes.
4875 \f
4878 "Function to use to revert this buffer, or nil to do the default.
4879 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4884 "Function to use to insert contents when reverting this buffer.
4885 Gets two args, first the nominal file name to use,
4886 and second, t if reading the auto-save file.
4891 "Function to check whether a non-file buffer needs reverting.
4892 This should be a function with one optional argument NOCONFIRM.
4893 Auto Revert Mode passes t for NOCONFIRM. The function should return
4894 non-nil if the buffer should be reverted. A return value of
4895 `fast' means that the need for reverting was not checked, but
4896 that reverting the buffer is fast. The buffer is current when
4897 this function is called.
4899 The idea behind the NOCONFIRM argument is that it should be
4900 non-nil if the buffer is going to be reverted without asking the
4901 user. In such situations, one has to be careful with potentially
4902 time consuming operations.
4904 For more information on how this variable is used by Auto Revert mode,
4908 "Normal hook for `revert-buffer' to run before reverting.
4909 If `revert-buffer-function' is used to override the normal revert
4913 "Normal hook for `revert-buffer' to run after reverting.
4914 Note that the hook value that it runs is the value that was in effect
4915 before reverting; that makes a difference if you have buffer-local
4916 hook functions.
4918 If `revert-buffer-function' is used to override the normal revert
4924 "Replace current buffer text with the text of the visited file on disk.
4925 This undoes all changes since the file was visited or saved.
4926 With a prefix argument, offer to revert from latest auto-save file, if
4927 that is more recent than the visited file.
4929 This command also implements an interface for special buffers
4930 that contain text which doesn't come from a file, but reflects
4931 some other data instead (e.g. Dired buffers, `buffer-list'
4932 buffers). This is done via the variable `revert-buffer-function'.
4933 In these cases, it should reconstruct the buffer contents from the
4934 appropriate data.
4936 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4937 to revert from the auto-save file when this is nil. Note that the
4938 sense of this argument is the reverse of the prefix argument, for the
4939 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4940 to nil.
4942 Optional second argument NOCONFIRM means don't ask for confirmation
4943 at all. \(The variable `revert-without-query' offers another way to
4944 revert buffers without querying for confirmation.)
4946 Optional third argument PRESERVE-MODES non-nil means don't alter
4947 the files modes. Normally we reinitialize them using `normal-mode'.
4949 If the value of `revert-buffer-function' is non-nil, it is called to
4950 do all the work for this command. Otherwise, the hooks
4951 `before-revert-hook' and `after-revert-hook' are run at the beginning
4952 and the end, and if `revert-buffer-insert-file-contents-function' is
4953 non-nil, it is called instead of rereading visited file contents."
4955 ;; I admit it's odd to reverse the sense of the prefix argument, but
4956 ;; there is a lot of code out there which assumes that the first
4957 ;; argument should be t to avoid consulting the auto-save file, and
4958 ;; there's no straightforward way to encourage authors to notice a
4959 ;; reversal of the argument sense. So I'm just changing the user
4960 ;; interface, but leaving the programmatic interface the same.
4968 buffer-auto-save-file-name
4973 buffer-auto-save-file-name
4974 buffer-file-name)))
4984 file-name)))
4986 ;; If file was backed up but has changed since,
4987 ;; we should make another backup.
4991 ;; Effectively copy the after-revert-hook status,
4992 ;; since after-find-file will clobber it.
4995 after-revert-hook))
5000 ;; Get rid of all undo records for this buffer.
5002 ;; Don't make undo records for the reversion.
5005 file-name auto-save-p)))
5008 "File %s no longer exists!"
5010 file-name))
5013 "File %s no longer readable!"
5015 file-name))
5017 ;; Bind buffer-file-name to nil
5018 ;; so that we don't try to lock the file.
5024 ;; Auto-saved file should be read by Emacs'
5025 ;; internal coding.
5029 buffer-file-coding-system-explicit
5032 coding-system-for-read
5034 coding-system-for-read)
5036 ;; As a coding system suitable for multibyte
5037 ;; buffer is specified, make the current
5038 ;; buffer multibyte.
5041 ;; This force after-insert-file-set-coding
5042 ;; (called from insert-file-contents) to set
5043 ;; buffer-file-coding-system to a proper value.
5046 ;; Note that this preserves point in an intelligent way.
5050 nil nil t))
5052 nil nil t)))))
5053 ;; Recompute the truename in case changes in symlinks
5054 ;; have changed the truename.
5058 ;; Run after-revert-hook as it was before we reverted.
5062 local-hook)
5065 t))))))
5068 "Recover the visited file--get contents from its last auto-save file."
5073 "Visit file FILE, but get contents from its last auto-save file."
5074 ;; Actually putting the file name in the minibuffer should be used
5075 ;; only rarely.
5076 ;; Not just because users often use the default.
5096 ;; Use insert-directory-safely, not insert-directory,
5097 ;; because these files might not exist. In particular,
5098 ;; FILE might not exist if the auto-save file was for
5099 ;; a buffer that didn't visit a file, such as "*mail*".
5100 ;; The code in v20.x called `ls' directly, so we need
5101 ;; to emulate what `ls' did in that case.
5107 ;; Keep the current buffer-file-coding-system.
5109 ;; Auto-saved file should be read with special coding.
5118 "Recover auto save files from a previous Emacs session.
5119 This command first displays a Dired buffer showing you the
5120 previous sessions that you could recover from.
5121 To choose one, move point to the proper line and then type C-c C-c.
5122 Then you'll be asked about a number of files to recover."
5132 auto-save-list-file-prefix)))
5133 t)
5142 ;; Each line starts with a space
5143 ;; so that Font Lock mode won't highlight the first character.
5152 "Choose one saved session to recover auto-save files from.
5153 This command is used in the special Dired buffer created by
5156 ;; Get the name of the session file to recover from.
5158 files
5164 ;; Read in the auto-save-list file.
5167 ;; Loop thru the text of that file
5168 ;; and get out the names of the files to recover.
5172 ;; This is a pair of lines for a non-file-visiting buffer.
5173 ;; Get the auto-save file name and manufacture
5174 ;; a "visited file name" from that.
5177 ;; If there is no auto-save file name, the
5178 ;; auto-save-list file is probably corrupted.
5191 ;; This pair of lines is a file-visiting
5192 ;; buffer. Use the visited file name.
5202 ;; Ignore a file if its auto-save file does not exist now.
5206 ;; The file contains a pair of line for each auto-saved buffer.
5207 ;; The first line of the pair contains the visited file name
5208 ;; or is empty if the buffer was not visiting a file.
5209 ;; The second line is the auto-save file name.
5217 files
5223 "Kill BUFFER if confirmed."
5231 "Kill some buffers. Asks the user whether to kill each one of them.
5232 Non-interactively, if optional argument LIST is non-nil, it
5233 specifies the list of buffers to kill, asking for approval for each one."
5241 ; if we killed the base buffer.
5248 "Kill buffers whose name matches the specified REGEXP.
5249 The optional second argument indicates whether to kill internal buffers too."
5258 \f
5260 "Adjust current buffer's auto save file name for current conditions.
5261 Also rename any existing auto save file, if it was made in this session."
5273 "Return file name to use for auto-saves of current buffer.
5274 Does not consider `auto-save-visited-file-name' as that variable is checked
5275 before calling this function. You can redefine this for customization.
5276 See also `auto-save-file-name-p'."
5284 result uniq)
5285 ;; Apply user-specified translations
5286 ;; to the file name.
5290 filename)
5300 filename))))
5305 ;; We truncate the file name to DOS 8+3 limits
5306 ;; before doing anything else, because the regexp
5307 ;; passed to string-match below cannot handle
5308 ;; extensions longer than 3 characters, multiple
5309 ;; dots, and other atrocities.
5314 fn)
5319 "#"
5322 ;; Make sure auto-save file names don't contain characters
5323 ;; invalid for the underlying filesystem.
5325 ;; Don't modify remote (ange-ftp) filenames
5328 result))))
5330 ;; Deal with buffers that don't have any associated files. (Mail
5331 ;; mode tends to create a good number of these.)
5335 file-name)
5336 ;; Restrict the characters used in the file name to those which
5337 ;; are known to be safe on all filesystems, url-encoding the
5338 ;; rest.
5339 ;; We do this on all platforms, because even if we are not
5340 ;; running on DOS/Windows, the current directory may be on a
5341 ;; mounted VFAT filesystem, such as a USB memory stick.
5345 ;; For multibyte characters, this will produce more than
5346 ;; 2 hex digits, so is not true URL encoding.
5350 ;; Generate the file name.
5356 ;; Try a few alternative directories, to get one we can
5357 ;; write it.
5363 ;; Don't modify remote (ange-ftp) filenames
5365 ;; The call to convert-standard-filename is in case
5366 ;; buffer-name includes characters not allowed by the
5367 ;; DOS/Windows filesystems. make-temp-file writes to the
5368 ;; file it creates, so we must fix the file name _before_
5369 ;; make-temp-file is called.
5371 fname))
5373 ;; make-temp-file creates the file,
5374 ;; but we don't want it to exist until we do an auto-save.
5378 file-name)))
5381 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5382 FILENAME should lack slashes. You can redefine this for customization."
5384 \f
5386 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5387 The generated regexp will match a filename only if the filename
5388 matches that wildcard according to shell rules. Only wildcards known
5389 by `sh' are supported."
5391 ;; Copy the initial run of non-special characters.
5394 ;; If no special characters, we're almost done.
5398 j)
5400 result
5421 ;; Found "[^". Insert a `\0' character
5422 ;; (which cannot happen in a filename)
5423 ;; into the character class, so that `^'
5424 ;; is not the first character after `[',
5425 ;; and thus non-special in a regexp.
5430 ;; I don't think `]' can appear in a
5431 ;; character class in a wildcard, but
5432 ;; let's be general here.
5439 i
5452 ;; Shell wildcards should match the entire filename,
5453 ;; not its part. Make the regexp say so.
5455 \f
5458 "Switches for `list-directory' to pass to `ls' for brief listing."
5464 "Switches for `list-directory' to pass to `ls' for verbose listing."
5469 "Expand wildcard pattern PATTERN.
5470 This returns a list of file names which match the pattern.
5472 If PATTERN is written as an absolute file name,
5473 the values are absolute also.
5475 If PATTERN is written as a relative file name, it is interpreted
5476 relative to the current default directory, `default-directory'.
5477 The file names returned are normally also relative to the current
5478 default directory. However, if FULL is non-nil, they are absolute."
5482 ;; A list of all dirs that DIRPART specifies.
5483 ;; This can be more than one dir
5484 ;; if DIRPART contains wildcards.
5488 dirpart)))
5492 contents)
5497 ;; Filter out "." and ".."
5502 name))
5509 this-dir-contents)
5510 this-dir-contents)
5511 contents))))
5513 contents)))
5515 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5519 "Display a list of files in or matching DIRNAME, a la `ls'.
5520 DIRNAME is globbed by the shell if necessary.
5521 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5522 Actions controlled by variables `list-directory-brief-switches'
5523 and `list-directory-verbose-switches'."
5527 nil default-directory nil)
5528 pfx)))
5530 list-directory-brief-switches))
5531 buffer)
5543 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5551 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5553 PATTERN is assumed to represent a file-name wildcard suitable for the
5554 underlying filesystem. For Unix and GNU/Linux, each character from the
5556 the parts of the pattern which don't include wildcard characters are
5557 quoted with double quotes.
5560 on Windows), so PATTERN can use them to quote wildcard characters that
5561 need to be passed verbatim to shell commands."
5565 ;; DOS/Windows don't allow `"' in file names. So if the
5566 ;; argument has quotes, we can safely assume it is already
5567 ;; quoted by the caller.
5569 ;; We quote [&()#$'] in case their shell is a port of a
5570 ;; Unixy shell. We quote [,=+] because stock DOS and
5571 ;; Windows shells require that in some cases, such as
5572 ;; passing arguments to batch files that use positional
5573 ;; arguments like %1.
5575 pattern
5578 end)
5595 pattern))))
5602 "Program to get the amount of free space on a file system.
5603 We assume the output has the format of `df'.
5604 The value of this variable must be just a command name or file name;
5605 if you want to specify options, use `directory-free-space-args'.
5607 A value of nil disables this feature.
5609 If the function `file-system-info' is defined, it is always used in
5610 preference to the program given by this variable."
5616 "Options to use when running `directory-free-space-program'."
5621 "Return the amount of free space on directory DIR's file system.
5622 The return value is a string describing the amount of free
5623 space (normally, the number of free 1KB blocks).
5625 This function calls `file-system-info' if it is available, or
5626 invokes the program specified by `directory-free-space-program'
5627 and `directory-free-space-args'. If the system call or program
5628 is unsuccessful, or if DIR is a remote directory, this function
5629 returns nil."
5631 ;; Try to find the number of free blocks. Non-Posix systems don't
5632 ;; always have df, but might have an equivalent system call.
5641 ;; Avoid failure if the default directory does
5642 ;; not exist (Bug#2631, Bug#3911).
5645 nil t nil
5646 directory-free-space-args
5647 dir)
5649 ;; Assume that the "available" column is before the
5650 ;; "capacity" column. Find the "%" and scan backward.
5654 "[[:space:]]+[^[:space:]]+%[^%]*$"
5661 ;; The following expression replaces `dired-move-to-filename-regexp'.
5665 ;; In some locales, month abbreviations are as short as 2 letters,
5666 ;; and they can be followed by ".".
5667 ;; In Breton, a month name can include a quote character.
5680 s "+"
5683 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5684 ;; omits the Kanji characters after month and day-of-month.
5685 ;; On Mac OS X 10.3, the date format in East Asian locales is
5686 ;; day-of-month digits followed by month digits.
5692 ;; The "[0-9]" below requires the previous column to end in a digit.
5693 ;; This avoids recognizing `1 may 1997' as a date in the line:
5694 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5696 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5698 ;; For non-iso date formats, we add the ".*" in order to find
5699 ;; the last possible match. This avoids recognizing
5700 ;; `jservice 10 1024' as a date in the line:
5701 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5703 ;; vc dired listings provide the state or blanks between file
5704 ;; permissions and date. The state is always surrounded by
5705 ;; parantheses:
5706 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5707 ;; This is not supported yet.
5712 "Regular expression to match up to the file name in a directory listing.
5713 The default value is designed to recognize dates and times
5718 ;; insert-directory
5719 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5720 ;; FULL-DIRECTORY-P is nil.
5721 ;; The single line of output must display FILE's name as it was
5722 ;; given, namely, an absolute path name.
5723 ;; - must insert exactly one line for each file if WILDCARD or
5724 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5725 ;; before the file lines, plus optional text after the file lines.
5726 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5727 ;; allowed.
5728 ;; File lines should display the basename.
5729 ;; - must be consistent with
5730 ;; - functions dired-move-to-filename, (these two define what a file line is)
5731 ;; dired-move-to-end-of-filename,
5732 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5733 ;; dired-insert-headerline
5734 ;; dired-after-subdir-garbage (defines what a "total" line is)
5735 ;; - variable dired-subdir-regexp
5736 ;; - may be passed "--dired" as the first argument in SWITCHES.
5737 ;; Filename handlers might have to remove this switch if their
5738 ;; "ls" command does not support it.
5740 "Insert directory listing for FILE, formatted according to SWITCHES.
5741 Leaves point after the inserted text.
5742 SWITCHES may be a string of options, or a list of strings
5743 representing individual options.
5744 Optional third arg WILDCARD means treat FILE as shell wildcard.
5745 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5746 switches do not contain `d', so that a full listing is expected.
5748 This works by running a directory listing program
5749 whose name is in the variable `insert-directory-program'.
5750 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5752 When SWITCHES contains the long `--dired' option, this function
5753 treats it specially, for the sake of dired. However, the
5754 normally equivalent short `-D' option is just passed on to
5755 `insert-directory-program', as any other option."
5756 ;; We need the directory in order to find the right handler.
5761 wildcard full-directory-p)
5764 ;; Read the actual directory using `insert-directory-program'.
5765 ;; RESULT gets the status code.
5767 ;; putting text property `dired-filename, decode one
5768 ;; bunch by one to preserve that property.
5770 ;; This is to control encoding the arguments in call-process.
5774 default-file-name-coding-system))))
5777 ;; Run ls in the directory part of the file pattern
5778 ;; using the last component as argument.
5785 shell-file-name nil t nil
5786 "-c"
5788 ""
5790 insert-directory-program
5791 " -d "
5793 switches
5795 " -- "
5796 ;; Quote some characters that have
5797 ;; special meanings in shells; but
5798 ;; don't quote the wildcards--we want
5799 ;; them to be special. We also
5800 ;; currently don't quote the quoting
5801 ;; characters in case people want to
5802 ;; use them explicitly to quote
5803 ;; wildcard characters.
5805 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5806 ;; directory if FILE is a symbolic link.
5813 insert-directory-program nil t nil
5817 ;; Split the switches at any spaces so we can
5818 ;; pass separate options as separate args.
5820 ;; Avoid lossage if FILE starts with `-'.
5828 file))))))))
5830 ;; If we got "//DIRED//" in the output, it means we got a real
5831 ;; directory listing, even if `ls' returned nonzero.
5832 ;; So ignore any errors.
5845 ;; The first time ls returns an error,
5846 ;; find the version numbers of ls,
5847 ;; and set insert-directory-ls-version
5848 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5849 ;; is equal or if the info cannot be obtained.
5850 ;; (That can mean it isn't GNU ls.)
5860 comparison)
5876 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5880 ;; If `insert-directory-program' failed, signal an error.
5882 ;; Delete the error message it may have output.
5884 ;; On non-Posix systems, we cannot open a directory, so
5885 ;; don't even try, because that will always result in
5886 ;; the ubiquitous "Access denied". Instead, show the
5887 ;; command line so the user can try to guess what went wrong.
5892 insert-directory-program
5894 file result)
5895 ;; Unix. Access the file to get a suitable error.
5902 ;; The following overshoots by one line for an empty
5903 ;; directory listed with "--dired", but without "-a"
5904 ;; switch, where the ls output contains a
5905 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5906 ;; We take care of that case later.
5914 error-lines)
5915 ;; Find all the lines that are error messages,
5916 ;; and record the bounds of each one.
5923 ;; Now read the numeric positions of file names.
5930 error-lines))
5933 error-lines)))
5935 ;; End is followed by \n or by " -> ".
5937 ;; It seems that we can't trust ls's output as to
5938 ;; byte positions of filenames.
5944 ;; Take care of the case where the ls output contains a
5945 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5946 ;; and we went one line too far back (see above).
5951 ;; Now decode what read if necessary.
5953 file-name-coding-system
5954 default-file-name-coding-system
5956 coding-no-eol
5957 val pos)
5961 ;; If no coding system is specified or detection is
5962 ;; requested, detect the coding.
5976 ;; Force no eol conversion on a file name, so
5977 ;; that CR is preserved.
5985 ;; Try to insert the amount of free space.
5988 ;; First find the line to put it on.
5992 ;; Replace "total" with "used", to avoid confusion.
5998 "Convert `ls --dired' file name position value POS to a buffer position.
5999 File name position values returned in ls --dired output
6000 count only stdout; they don't count the error messages sent to stderr.
6001 So this function converts to them to real buffer positions.
6002 ERROR-LINES is a list of buffer positions of error message lines,
6003 of the form (START END)."
6007 pos)
6011 "Insert directory listing for FILE, formatted according to SWITCHES.
6013 Like `insert-directory', but if FILE does not exist, it inserts a
6014 message to that effect instead of signaling an error."
6017 ;; Simulate the message printed by `ls'.
6021 "Functions to call with no arguments to query about killing Emacs.
6022 If any of these functions returns nil, killing Emacs is cancelled.
6023 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6027 "How to ask for confirmation when leaving Emacs.
6028 If nil, the default, don't ask at all. If the value is non-nil, it should
6029 be a predicate function such as `yes-or-no-p'."
6037 "Offer to save each buffer, then kill this Emacs process.
6038 With prefix ARG, silently save all file-visiting buffers, then kill."
6047 ;; process-list is not defined on MSDOS.
6049 active)
6058 ;; Query the user for other things, perhaps.
6065 "Offer to save each buffer, then kill the current connection.
6066 If the current frame has no client, kill Emacs itself.
6068 With prefix ARG, silently save all file-visiting buffers, then kill.
6070 If emacsclient was started with a list of filenames to edit, then
6071 only these files will be asked to be saved."
6076 \f
6077 ;; We use /: as a prefix to "quote" a file name
6078 ;; so that magic file name handlers will not apply to it.
6082 file-name-handler-alist))
6084 ;; We depend on being the last handler on the list,
6085 ;; so that anything else which does need handling
6086 ;; has been handled already.
6087 ;; So it is safe for us to inhibit *all* magic file name handlers.
6096 default-directory))
6097 ;; Get a list of the indices of the args which are file names.
6100 ;; The first six are special because they
6101 ;; return a file name. We want to include the /:
6102 ;; in the return value.
6103 ;; So just avoid stripping it in the first place.
6110 ;; `identity' means just return the first arg
6111 ;; not stripped of its quoting.
6113 ;; `add' means add "/:" to the result.
6115 ;; `quote' means add "/:" to buffer-file-name.
6117 ;; `unquote-then-quote' means set buffer-file-name
6118 ;; temporarily to unquoted filename.
6120 ;; List the arguments which are filenames.
6128 ;; For all other operations, treat the first argument only
6129 ;; as the file name.
6131 method
6132 ;; Copy ARGUMENTS so we can replace elements in it.
6136 ;; Strip off the /: from the file names that have it.
6144 "/"
6160 res))
6163 \f
6164 ;; Symbolic modes and read-file-modes.
6167 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6168 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6169 Others, or All) for whom to produce the mask.
6170 The bit-mask that is returned extracts from mode bits the access rights
6171 for the specified category of users."
6179 "Convert CHAR to a numeric value of mode bits.
6180 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6181 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6188 ;; Rights relative to the previous file modes.
6199 "Convert a symbolic mode string specification to an equivalent number.
6201 WHO-MASK is the bit-mask specifying the category of users to which to
6202 apply the access permissions. See `file-modes-char-to-who'.
6203 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6204 RIGHTS request to add, remove, or set permissions based on existing ones,
6211 char-right)
6218 num-rights
6222 op char-right)))
6223 num-rights))
6226 "Convert symbolic file modes to numeric file modes.
6227 MODES is the string to convert, it should match
6230 notation.
6231 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6232 MODES request to add, remove, or set permissions based on existing ones,
6246 num-who num-modes)
6249 num-modes)))
6252 "Read file modes in octal or symbolic notation and return its numeric value.
6253 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6254 ORIG-FILE is the name of a file on whose mode bits to base returned
6255 permissions if what user types requests to add, remove, or set permissions
6271 nil nil default)))
6277 \f
6278 ;; Trashcan handling.
6280 "Directory for `move-file-to-trash' to move files and directories to.
6281 This directory is only used when the function `system-move-file-to-trash'
6282 is not defined.
6283 Relative paths are interpreted relative to `default-directory'.
6284 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6294 "Move the file (or directory) named FILENAME to the trash.
6295 When `delete-by-moving-to-trash' is non-nil, this function is
6296 called by `delete-file' and `delete-directory' instead of
6297 deleting files outright.
6299 If the function `system-move-file-to-trash' is defined, call it
6300 with FILENAME as an argument.
6301 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6302 directory.
6303 Otherwise, trash FILENAME using the freedesktop.org conventions,
6304 like the GNOME, KDE and XFCE desktop environments. Emacs only
6308 ;; If `trash-directory' is non-nil, move the file there.
6312 trash-dir)))
6313 ;; We can't trash a parent directory of trash-directory.
6316 trash-dir filename))
6319 ;; Ensure that the trashed file-name is unique.
6326 ;; If `system-move-file-to-trash' is defined, use it.
6329 ;; Otherwise, use the freedesktop.org method, as specified at
6330 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6341 ;; Check if we have permissions to delete.
6345 ;; The trashed file cannot be the trash dir or its parent.
6348 trash-files-dir filename))
6351 trash-info-dir filename))
6353 ;; Ensure that the trash directory exists; otherwise, create it.
6362 ;; Try to move to trash with .trashinfo undo information
6367 ;; Perform url-encoding on FN. For compatibility with
6368 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6369 ;; for path separators.
6374 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6375 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6388 fn))
6393 ;; Attempt to make .trashinfo file, trying up to 5
6394 ;; times. The .trashinfo file is opened with O_EXCL,
6395 ;; as per trash-spec 0.7, even if that can be a problem
6396 ;; on old NFS versions...
6400 trash-files-dir))
6402 success info-fn)
6407 trash-info-dir))
6415 ;; Uniqify new-fn. (Some file managers do not
6416 ;; like Emacs-style backup file names---e.g. bug
6417 ;; 170956 in Konqueror bug tracker.)
6422 ;; Finally, try to move the file to the trashcan.
6426 \f
6451 ;;; files.el ends here