| blob | 2e2d4eeb1fb7dd86403ce5b73df49202f38330f7 |
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."
131 "Non-nil means create backups by copying to preserve a privileged owner.
132 Renaming may still be used (subject to control of other variables)
133 when it would not result in changing the owner of the file or if the owner
134 has a user id greater than the value of this variable. This is useful
135 when low-numbered uid's are used for special system users (such as root)
136 that must maintain ownership of certain files.
137 This variable is relevant only if `backup-by-copying' and
138 `backup-by-copying-when-mismatch' are nil."
143 "Predicate that looks at a file name and decides whether to make backups.
147 "Non-nil in a buffer means always offer to save buffer on exit.
148 Do so even if the buffer is not visiting a file.
149 Automatically local in all buffers."
155 "Non-nil means find a file under alternative names, in existing buffers.
156 This means if any existing buffer is visiting the file you want
157 under another name, you get the existing buffer instead of a new buffer."
162 "Non-nil means visit a file under its truename.
163 The truename of a file is found by chasing all links
164 both at the file level and at the levels of the containing directories."
170 "Specify which files should be reverted without query.
171 The value is a list of regular expressions.
172 If the file name matches one of these regular expressions,
173 then `revert-buffer' reverts the file without querying
174 if the file has changed on disk and you have not edited the buffer."
179 "The device number and file number of the file visited in the current buffer.
180 The value is a list of the form (FILENUM DEVNUM).
181 This pair of numbers uniquely identifies the file.
195 "The directory for writing small temporary files.
196 If non-nil, this directory is used instead of `temporary-file-directory'
197 by programs that create small temporary files. This is for systems that
198 have fast storage with limited space, such as a RAM disk."
203 ;; The system null device. (Should reference NULL_DEVICE from C.)
231 "Non-nil means protect against I/O errors while saving files.
232 Some modes set this non-nil in particular buffers.
234 This feature works by writing the new contents into a temporary file
235 and then renaming the temporary file to replace the original.
236 In this way, any I/O error in writing leaves the original untouched,
237 and there is never any instant where the file is nonexistent.
239 Note that this feature forces backups to be made by copying.
240 Yet, at the same time, saving a precious file
241 breaks any hard links between it and other files.
243 This feature is advisory: for example, if the directory in which the
244 file is being saved is not writable, Emacs may ignore a non-nil value
245 of `file-precious-flag' and write directly into the file.
247 See also: `break-hardlink-on-save'."
252 "Non-nil means when saving a file that exists under several names
253 \(i.e., has multiple hardlinks), break the hardlink associated with
254 `buffer-file-name' and write to a new file, so that the other
255 instances of the file are not affected by the save.
257 If `buffer-file-name' refers to a symlink, do not break the symlink.
259 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
260 For example, if the directory in which a file is being saved is not
261 itself writable, then error instead of saving in some
262 hardlink-nonbreaking way.
264 See also `backup-by-copying' and `backup-by-copying-when-linked'."
270 "Control use of version numbers for backup files.
271 When t, make numeric backup versions unconditionally.
272 When nil, make them for files that have some already.
273 The value `never' means do not make them."
283 "When cleaning directory, number of versions to keep."
289 "If t, delete excess backup versions silently.
290 If nil, ask confirmation. Any other value prevents any trimming."
297 "Number of oldest versions to keep when a new numbered backup is made."
303 "Number of newest versions to keep when a new numbered backup is made.
304 Includes the new backup. Must be > 0"
310 "Whether to add a newline automatically at the end of the file.
312 A value of t means do this only when the file is about to be saved.
313 A value of `visit' means do this right after the file is visited.
314 A value of `visit-save' means do it at both of those times.
315 Any other non-nil value means ask user whether to add a newline, when saving.
316 A value of nil means don't add newlines.
318 Certain major modes set this locally to the value obtained
319 from `mode-require-final-newline'."
328 "Whether to add a newline at end of file, in certain major modes.
329 Those modes set `require-final-newline' to this value when you enable them.
330 They do so because they are often used for files that are supposed
331 to end in newlines, and the question is how to arrange that.
333 A value of t means do this only when the file is about to be saved.
334 A value of `visit' means do this right after the file is visited.
335 A value of `visit-save' means do it at both of those times.
336 Any other non-nil value means ask user whether to add a newline, when saving.
338 A value of nil means do not add newlines. That is a risky choice in this
339 variable since this value is used for modes for files that ought to have
340 final newlines. So if you set this to nil, you must explicitly check and
341 add a final newline, whenever you save a file that really needs one."
351 "Non-nil says by default do auto-saving of every file-visiting buffer."
357 ;; Don't put "\\2" inside expand-file-name, since it will be
358 ;; transformed to "/2" on DOS/Windows.
360 "Transforms to apply to buffer file name before making auto-save file name.
361 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
362 REGEXP is a regular expression to match against the file name.
363 If it matches, `replace-match' is used to replace the
364 matching part with REPLACEMENT.
365 If the optional element UNIQUIFY is non-nil, the auto-save file name is
366 constructed by taking the directory part of the replaced file-name,
367 concatenated with the buffer file name with all directory separators
368 changed to `!' to prevent clashes. This will not work
369 correctly if your filesystem truncates the resulting name.
371 All the transforms in the list are tried, in the order they are listed.
372 When one transform applies, its result is final;
373 no further transforms are tried.
375 The default value is set up to put the auto-save file into the
376 temporary directory (see the variable `temporary-file-directory') for
377 editing a remote file.
379 On MS-DOS filesystems without long names this variable is always
380 ignored."
388 "Non-nil means save word abbrevs too when files are saved.
389 If `silently', don't ask the user before saving."
394 "Non-nil means allow `find-file' to visit directories.
395 To visit the directory, `find-file' runs `find-directory-functions'."
400 "List of functions to try in sequence to visit a directory.
401 Each function is called with the directory name as the sole argument
402 and should return either a buffer or nil."
406 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
408 "List of functions to try in sequence to get a file name at point.
409 Each function should return either nil or a file name found at the
410 location of point in the current buffer."
414 ;;;It is not useful to make this a local variable.
415 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
417 "List of functions to be called for `find-file' on nonexistent file.
418 These functions are called as soon as the error is detected.
419 Variable `buffer-file-name' is already set up.
424 ;;;It is not useful to make this a local variable.
425 ;;;(put 'find-file-hooks 'permanent-local t)
428 "List of functions to be called after a buffer is loaded from a file.
429 The buffer's local variables (if any) will have been processed before the
430 functions are called."
437 "List of functions to be called before writing out a buffer to a file.
438 If one of them returns non-nil, the file is considered already written
439 and the rest are not called.
440 These hooks are considered to pertain to the visited file.
441 So any buffer-local binding of this variable is discarded if you change
443 change the major mode.
445 This hook is not run if any of the functions in
446 `write-contents-functions' returns non-nil. Both hooks pertain
447 to how to save a buffer to file, for instance, choosing a suitable
448 coding system and setting mode bits. (See Info
449 node `(elisp)Saving Buffers'.) To perform various checks or
460 "List of functions to be called before writing out a buffer to a file.
461 If one of them returns non-nil, the file is considered already written
462 and the rest are not called and neither are the functions in
463 `write-file-functions'.
465 This variable is meant to be used for hooks that pertain to the
466 buffer's contents, not to the particular visited file; thus,
467 `set-visited-file-name' does not clear this variable; but changing the
468 major mode does clear it.
470 For hooks that _do_ pertain to the particular visited file, use
471 `write-file-functions'. Both this variable and
472 `write-file-functions' relate to how a buffer is saved to file.
473 To perform various checks or updates before the buffer is saved,
480 "Control use of local variables in files you visit.
481 The value can be t, nil, :safe, :all, or something else.
483 A value of t means file local variables specifications are obeyed
484 if all the specified variable values are safe; if any values are
485 not safe, Emacs queries you, once, whether to set them all.
486 \(When you say yes to certain values, they are remembered as safe.)
488 :safe means set the safe variables, and ignore the rest.
489 :all means set all variables, whether safe or not.
490 (Don't set it permanently to :all.)
491 A value of nil means always ignore the file local variables.
493 Any other value means always query you once whether to set them all.
494 \(When you say yes to certain values, they are remembered as safe, but
497 This variable also controls use of major modes specified in
498 a -*- line.
501 always obeys file local variable specifications and the -*- line,
502 and ignores this variable."
503 :risky t
512 "Like `enable-local-variables' but meant for buffer-local bindings.
513 The meaningful values are nil and non-nil. The default is non-nil.
514 If a major mode sets this to nil, buffer-locally, then any local
515 variables list in the file will be ignored.
517 This variable does not affect the use of major modes
522 The value can be t, nil or something else.
523 A value of t means obey `eval' variables.
524 A value of nil means ignore them; anything else means query."
525 :risky t
531 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
540 "Non-nil means buffers visiting files read-only do so in view mode.
541 In fact, this means that all read-only buffers normally have
542 View mode enabled, including buffers that are read-only because
543 you visit a file you cannot alter, and buffers you make read-only
549 "History list of file names entered in the minibuffer.
551 Maximum length of the history list is determined by the value
553 \f
556 "Provides support for ange-ftp host name completion.
557 Runs the usual ange-ftp hook, but only for completion operations."
558 ;; Having this here avoids the need to load ange-ftp when it's not
559 ;; really in use.
565 inhibit-file-name-handlers)))
573 "Convert a standard file's name to something suitable for the OS.
574 This means to guarantee valid names and perhaps to canonicalize
575 certain patterns.
577 FILENAME should be an absolute file name since the conversion rules
578 sometimes vary depending on the position in the file name. E.g. c:/foo
579 is a valid DOS file name, but c:/bar/c:/foo is not.
581 This function's standard definition is trivial; it just returns
582 the argument. However, on Windows and DOS, replace invalid
583 characters. On DOS, make sure to obey the 8.3 limitations.
584 In the native Windows build, turn Cygwin names into native names,
585 and also turn slashes into backslashes if the shell requires it (see
586 `w32-shell-dos-semantics').
588 See Info node `(elisp)Standard File Names' for more details."
593 ;; Replace invalid filename characters with !
597 name))
605 "Read directory name, prompting with PROMPT and completing in directory DIR.
606 Value is not expanded---you must call `expand-file-name' yourself.
607 Default name to DEFAULT-DIRNAME if user exits with the same
608 non-empty string that was inserted by this function.
609 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
610 or just DIR if INITIAL is nil.)
611 If the user exits with an empty minibuffer, this function returns
612 an empty string. (This can only happen if the user erased the
613 pre-inserted contents or if `insert-default-directory' is nil.)
614 Fourth arg MUSTMATCH non-nil means require existing directory's name.
615 Non-nil and non-t means also require confirmation after completion.
616 Fifth arg INITIAL specifies text to start with.
617 DIR should be an absolute directory name. It defaults to
618 the value of `default-directory'."
623 dir))
624 mustmatch initial
627 \f
629 "Show the current default directory."
634 "Value of the CDPATH environment variable, as a list.
638 "Explode a search path into a list of directory names.
639 Directories are separated by occurrences of `path-separator'
640 \(which is colon in GNU and GNU-like systems)."
641 ;; We could use split-string here.
649 nil
654 cd-list)))
657 "Change current directory to given absolute file name DIR."
658 ;; Put the name into directory syntax now,
659 ;; because otherwise expand-file-name may give some bad results.
661 ;; We used to additionally call abbreviate-file-name here, for an
662 ;; unknown reason. Problem is that most buffers are setup
663 ;; without going through cd-absolute and don't call
664 ;; abbreviate-file-name on their default-directory, so the few that
665 ;; do end up using a superficially different directory.
677 "Make DIR become the current buffer's default directory.
678 If your environment includes a `CDPATH' variable, try each one of
679 that list of directories (separated by occurrences of
680 `path-separator') when resolving a relative directory name.
681 The path separator is colon in GNU and GNU-like systems."
684 default-directory default-directory
700 cd-path)
701 nil))
705 "Load the Lisp file named FILE."
706 ;; This is a case where .elc makes a lot of sense.
713 "Search for FILENAME through PATH.
714 If found, return the absolute file name of FILENAME, with its suffixes;
715 otherwise return nil.
716 PATH should be a list of directories to look in, like the lists in
717 `exec-path' or `load-path'.
718 If SUFFIXES is non-nil, it should be a list of suffixes to append to
721 If non-nil, PREDICATE is used instead of `file-readable-p'.
722 PREDICATE can also be an integer to pass to the `access' system call,
723 in which case file-name handlers are ignored. This usage is deprecated.
725 For compatibility, PREDICATE can also be one of the symbols
726 `executable', `readable', `writable', or `exists', or a list of
727 one or more of those symbols."
738 "Do completion for file names passed to `locate-file'."
741 ;; FIXME: maybe we should use completion-file-name-table instead,
742 ;; tho at least for `load', the arg is passed through
743 ;; substitute-in-file-name for historical reasons.
753 ;; If we have files like "foo.el" and "foo.elc", we could load one of
754 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
755 ;; preferred way. So if we list all 3, that gives a lot of redundant
756 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
757 ;; the user does want to pay attention to the extension. We try to
758 ;; diffuse this tension by stripping the suffix, except when the
759 ;; result is a single element (i.e. usually we only list "foo" unless
760 ;; it's the only remaining element in the list, in which case we do
761 ;; list "foo", "foo.elc" and "foo.el").
772 string-file dir))
777 ;; Switching from names to names+fullnames creates a non-monotonicity
778 ;; which can cause problems with things like partial-completion.
779 ;; To minimize the problem, filter out completion-regexp-list, so that
780 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
781 ;; from `names' which only matched `string' when they still had
782 ;; their suffix.
784 ;; Remove duplicates of the first element, so that we can easily check
785 ;; if `names' really only contains a single element.
788 ;; There's no more than one matching non-suffixed element, so expand
789 ;; the list by adding the suffixed elements as well.
792 string-dir names string-file pred action)))))
795 "Do completion for file names passed to `locate-file'.
796 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
799 string nil action))
804 "Regexp of directory names which stop the search in `locate-dominating-file'.
805 Any directory whose name matches this regexp will be treated like
806 a kind of root directory by `locate-dominating-file' which will stop its search
807 when it bumps into it.
808 The default regexp prevents fruitless and time-consuming attempts to find
809 special files in directories in which filenames are interpreted as hostnames,
812 ;; (defun locate-dominating-files (file regexp)
813 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
814 ;; Stop at the first parent where a matching file is found and return the list
815 ;; of files that that match in this directory."
816 ;; (catch 'found
817 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
818 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
819 ;; (let ((user nil)
820 ;; ;; Abbreviate, so as to stop when we cross ~/.
821 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
822 ;; files)
823 ;; (while (and dir
824 ;; ;; As a heuristic, we stop looking up the hierarchy of
825 ;; ;; directories as soon as we find a directory belonging to
826 ;; ;; another user. This should save us from looking in
827 ;; ;; things like /net and /afs. This assumes that all the
828 ;; ;; files inside a project belong to the same user.
829 ;; (let ((prev-user user))
830 ;; (setq user (nth 2 (file-attributes dir)))
831 ;; (or (null prev-user) (equal user prev-user))))
832 ;; (if (setq files (condition-case nil
833 ;; (directory-files dir 'full regexp 'nosort)
834 ;; (error nil)))
835 ;; (throw 'found files)
836 ;; (if (equal dir
837 ;; (setq dir (file-name-directory
838 ;; (directory-file-name dir))))
839 ;; (setq dir nil))))
840 ;; nil)))
843 "Look up the directory hierarchy from FILE for a file named NAME.
844 Stop at the first parent directory containing a file NAME,
845 and return the directory. Return nil if not found."
846 ;; We used to use the above locate-dominating-files code, but the
847 ;; directory-files call is very costly, so we're much better off doing
848 ;; multiple calls using the code in here.
849 ;;
850 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
851 ;; `name' in /home or in /.
855 ;; `user' is not initialized outside the loop because
856 ;; `file' may not exist, so we may have to walk up part of the
857 ;; hierarchy before we find the "initial UID".
859 try)
862 ;; FIXME: Disabled this heuristic because it is sometimes
863 ;; inappropriate.
864 ;; As a heuristic, we stop looking up the hierarchy of
865 ;; directories as soon as we find a directory belonging
866 ;; to another user. This should save us from looking in
867 ;; things like /net and /afs. This assumes that all the
868 ;; files inside a project belong to the same user.
869 ;; (let ((prev-user user))
870 ;; (setq user (nth 2 (file-attributes file)))
871 ;; (and prev-user (not (equal user prev-user))))
879 root))
883 "Search for COMMAND in `exec-path' and return the absolute file name.
884 Return nil if COMMAND is not found anywhere in `exec-path'."
885 ;; Use 1 rather than file-executable-p to better match the behavior of
886 ;; call-process.
890 "Load the Emacs Lisp library named LIBRARY.
891 This is an interface to the function `load'. LIBRARY is searched
892 for in `load-path', both with and without `load-suffixes' (as
893 well as `load-file-rep-suffixes').
895 See Info node `(emacs)Lisp Libraries' for more details.
896 See `load-file' for a different interface to `load'."
900 load-path
905 "Test whether FILE specifies a location on a remote system.
906 Returns nil or a string identifying the remote connection (ideally
907 a prefix of FILE). For example, the remote identification for filename
910 less reliable than accessing local files.
911 Furthermore, relative file names do not work across remote connections.
913 IDENTIFICATION specifies which part of the identification shall
914 be returned as string. IDENTIFICATION can be the symbol
915 `method', `user', `host' or `localname'; any other value is
916 handled like nil and means to return the complete identification
917 string.
919 If CONNECTED is non-nil, the function returns an identification only
920 if FILE is located on a remote system, and a connection is established
921 to that remote system.
923 `file-remote-p' will never open a connection on its own."
927 nil)))
930 "Whether to use the remote file-name cache for read access.
932 When `nil', always use the cached values.
933 When `t', never use them.
934 A number means use them for that amount of seconds since they were
935 cached.
937 File attributes of remote files are cached for better performance.
938 If they are changed out of Emacs' control, the cached values
939 become invalid, and must be invalidated.
941 In case a remote file is checked regularly, it might be
942 reasonable to let-bind this variable to a value less then the
943 time period between two checks.
944 Example:
946 \(defun display-time-file-nonempty-p \(file)
947 \(let \(\(remote-file-name-inhibit-cache \(- display-time-interval 5)))
948 \(and \(file-exists-p file)
949 \(< 0 \(nth 7 \(file-attributes \(file-chase-links file)))))))"
960 "Copy the file FILE into a temporary file on this machine.
961 Returns the name of the local copy, or nil, if FILE is directly
962 accessible."
963 ;; This formerly had an optional BUFFER argument that wasn't used by
964 ;; anything.
968 nil)))
971 "Return the truename of FILENAME, which should be absolute.
972 The truename of a file name is found by chasing symbolic links
973 both at the level of the file and at the level of the directories
974 containing it, until no links are left at any level.
977 ;; COUNTER and PREV-DIRS are only used in recursive calls.
978 ;; COUNTER can be a cons cell whose car is the count of how many
979 ;; more links to chase before getting an error.
980 ;; PREV-DIRS can be a cons cell whose car is an alist
981 ;; of truenames we've just recently computed.
995 ;; For speed, remove the ange-ftp completion handler from the list.
996 ;; We know it's not needed here.
997 ;; For even more speed, do this only on the outermost call.
1004 ;; andrewi@harlequin.co.uk - none of the following code (except for
1005 ;; invoking the file-name handler) currently applies on Windows
1006 ;; (ie. there are no native symlinks), but there is an issue with
1007 ;; case differences being ignored by the OS, and short "8.3 DOS"
1008 ;; name aliases existing for all files. (The short names are not
1009 ;; reported by directory-files, but can be used to refer to files.)
1010 ;; It seems appropriate for file-truename to resolve these issues in
1011 ;; the most natural way, which on Windows is to call the function
1012 ;; `w32-long-file-name' - this returns the exact name of a file as
1013 ;; it is stored on disk (expanding short name aliases with the full
1014 ;; name in the process).
1017 ;; For file name that has a special handler, call handler.
1018 ;; This is so that ange-ftp can save time by doing a no-op.
1021 ;; If filename contains a wildcard, newname will be the old name.
1023 ;; If filename exists, use the long name. If it doesn't exist,
1024 ;; drill down until we find a directory that exists, and use
1025 ;; the long name of that, with the extra non-existent path
1026 ;; components concatenated.
1028 missing rest)
1031 ;; Include the preceding directory separator in the missing
1032 ;; part so subsequent recursion on the rest works.
1037 ""
1042 ;; If this file directly leads to a link, process that iteratively
1043 ;; so that we don't use lots of stack.
1049 ;; For file name that has a special handler, call handler.
1050 ;; This is so that ange-ftp can save time by doing a no-op.
1053 done t)
1055 target dirfile)
1056 ;; Get the truename of the directory.
1058 ;; If these are equal, we have the (or a) root directory.
1060 ;; If this is the same dir we last got the truename for,
1061 ;; save time--don't recalculate.
1071 done t)
1074 done t)
1075 ;; Put it back on the file name.
1077 ;; Is the file name the name of a link?
1080 ;; Yes => chase that link, then start all over
1081 ;; since the link may point to a directory name that uses links.
1082 ;; We can't safely use expand-file-name here
1083 ;; since target might look like foo/../bar where foo
1084 ;; is itself a link. Instead, we handle . and .. above.
1087 target
1089 done nil)
1090 ;; No, we are done!
1092 filename))
1095 "Chase links in FILENAME until a name that is not a link.
1096 Unlike `file-truename', this does not check whether a parent
1097 directory name is a symbolic link.
1098 If the optional argument LIMIT is a number,
1099 it means chase no more than that many links and then stop."
1107 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1110 ;; Handle `..' by hand, since it needs to work in the
1111 ;; target of any directory symlink.
1112 ;; This code is not quite complete; it does not handle
1113 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1117 ;; Chase links in the default dir of the symlink.
1121 ;; Now find the parent of that dir.
1125 newname))
1128 "Create a temporary file.
1129 The returned file name (created by appending some random characters at the end
1130 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1131 is guaranteed to point to a newly created empty file.
1132 You can then use `write-region' to write new data into the file.
1134 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1136 If SUFFIX is non-nil, add that at the end of the file name."
1138 file)
1141 ;; Create temp files with strict access rights. It's easy to
1142 ;; loosen them later, whereas it's impossible to close the
1143 ;; time-window of loose permissions otherwise.
1151 temporary-file-directory)
1153 temporary-file-directory))))
1159 nil)
1161 ;; the file was somehow created by someone else between
1162 ;; `make-temp-name' and `write-region', let's try again.
1163 nil)
1164 file)
1165 ;; Reset the umask.
1169 "Change the encoding of FILE's name from CODING to NEW-CODING.
1170 The value is a new name of FILE.
1171 Signals a `file-already-exists' error if a file of the new name
1172 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1173 is non-nil. A number as fourth arg means request confirmation if
1174 the new name already exists. This is what happens in interactive
1175 use with M-x."
1178 default-file-name-coding-system))
1180 from-coding to-coding)
1182 ;; We provide the default coding only when it seems that
1183 ;; the filename is correctly decoded by the default
1184 ;; coding.
1190 filename default-coding)
1191 default-coding))
1195 ;; We provide the default coding only when a user is going to
1196 ;; change the encoding not from the default coding.
1200 filename from-coding)))
1203 filename from-coding default-coding)
1204 default-coding)))
1208 default-file-name-coding-system))
1209 ;; FILE should have been decoded by DEFAULT-CODING.
1213 ;; Suppress further encoding.
1218 newname))
1219 \f
1221 "Whether confirmation is requested before visiting a new file or buffer.
1222 If nil, confirmation is not requested.
1223 If the value is `after-completion', confirmation is only
1224 requested if the user called `minibuffer-complete' right before
1225 `minibuffer-complete-and-exit'.
1226 Any other non-nil value means to request confirmation.
1228 This affects commands like `switch-to-buffer' and `find-file'."
1236 "Whether to request confirmation before visiting a new file or buffer.
1237 The variable `confirm-nonexistent-file-or-buffer' determines the
1238 return value, which may be passed as the REQUIRE-MATCH arg to
1239 `read-buffer' or `find-file-read-args'."
1247 "Read the name of a buffer to switch to and return as a string.
1248 It is intended for `switch-to-buffer' family of commands since they
1249 need to omit the name of current buffer from the list of completions
1250 and default values."
1255 ;; Since rbts-completion-table is built dynamically, we
1256 ;; can't just add it to the default value of
1257 ;; icomplete-with-completion-tables, so we add it
1258 ;; here manually.
1263 icomplete-with-completion-tables))))
1268 "Select the buffer specified by BUFFER-OR-NAME in another window.
1269 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1270 nil. Return the buffer switched to.
1272 If called interactively, prompt for the buffer name using the
1273 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1274 determines whether to request confirmation before creating a new
1275 buffer.
1277 If BUFFER-OR-NAME is a string and does not identify an existing
1278 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1279 nil, switch to the buffer returned by `other-buffer'.
1281 Optional second argument NORECORD non-nil means do not put this
1282 buffer at the front of the list of recently selected ones.
1284 This uses the function `display-buffer' as a subroutine; see its
1285 documentation for additional customization information."
1289 same-window-buffer-names same-window-regexps)
1293 "Switch to buffer BUFFER-OR-NAME in another frame.
1294 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1295 nil. Return the buffer switched to.
1297 If called interactively, prompt for the buffer name using the
1298 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1299 determines whether to request confirmation before creating a new
1300 buffer.
1302 If BUFFER-OR-NAME is a string and does not identify an existing
1303 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1304 nil, switch to the buffer returned by `other-buffer'.
1306 Optional second arg NORECORD non-nil means do not put this
1307 buffer at the front of the list of recently selected ones.
1309 This uses the function `display-buffer' as a subroutine; see its
1310 documentation for additional customization information."
1314 same-window-buffer-names same-window-regexps)
1318 "Display buffer BUFFER in another frame.
1319 This uses the function `display-buffer' as a subroutine; see
1320 its documentation for additional customization information."
1323 same-window-buffer-names same-window-regexps
1325 new-window)
1327 ;; This may have been here in order to prevent the new frame from hiding
1328 ;; the old frame. But it does more harm than good.
1329 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1330 ;;(lower-frame (window-frame new-window))
1332 ;; This may have been here in order to make sure the old-frame gets the
1333 ;; focus. But not only can it cause an annoying flicker, with some
1334 ;; window-managers it just makes the window invisible, with no easy
1335 ;; way to recover it. --Stef
1336 ;;(make-frame-invisible (window-frame old-window))
1337 ;;(make-frame-visible (window-frame old-window))
1338 ))
1341 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1342 BODY should use the minibuffer at most once.
1343 Recursive uses of the minibuffer are unaffected (FUN is not
1344 called additional times).
1346 This macro actually adds an auxiliary function that calls FUN,
1347 rather than FUN itself, to `minibuffer-setup-hook'."
1353 ;; Clear out this hook so it does not interfere
1354 ;; with any recursive minibuffer usage.
1365 t))
1368 "Edit file FILENAME.
1369 Switch to a buffer visiting file FILENAME,
1370 creating one if none already exists.
1371 Interactively, the default if you just type RET is the current directory,
1372 but the visited file name is available through the minibuffer history:
1373 type M-n to pull it into the minibuffer.
1375 You can visit files on remote machines by specifying something
1376 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1377 also visit local files as a different user by specifying
1378 /sudo::FILE for the file name.
1379 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1380 manual, for more about this.
1382 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1383 expand wildcards (if any) and visit multiple files. You can
1384 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1386 To visit a file without any kind of conversion and without
1397 "Edit file FILENAME, in another window.
1400 an existing one. See the function `display-buffer'.
1402 Interactively, the default if you just type RET is the current directory,
1403 but the visited file name is available through the minibuffer history:
1404 type M-n to pull it into the minibuffer.
1406 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1407 expand wildcards (if any) and visit multiple files."
1420 "Edit file FILENAME, in another frame.
1423 an existing one. See the function `display-buffer'.
1425 Interactively, the default if you just type RET is the current directory,
1426 but the visited file name is available through the minibuffer history:
1427 type M-n to pull it into the minibuffer.
1429 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1430 expand wildcards (if any) and visit multiple files."
1443 "Edit the existing file FILENAME.
1445 file names with wildcards."
1454 "Edit file FILENAME but don't allow changes.
1468 value))
1471 "Edit file FILENAME in another window but don't allow changes.
1485 value))
1488 "Edit file FILENAME in another frame but don't allow changes.
1502 value))
1505 "Find file FILENAME as a replacement for the file in the next window.
1506 This command does not select that window.
1510 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1511 expand wildcards (if any) and replace the file with multiple files."
1522 "Find alternate file: " file-dir nil
1524 t))))
1532 "Find file FILENAME, select its buffer, kill previous buffer.
1533 If the current buffer now contains an empty file that you just visited
1534 \(presumably by mistake), use this command to visit the file you really want.
1538 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1539 expand wildcards (if any) and replace the file with multiple files.
1541 If the current buffer is an indirect buffer, or the base buffer
1542 for one or more indirect buffers, the other buffer(s) are not
1543 killed."
1552 "Find alternate file: " file-dir nil
1554 t)))
1569 ;; Run `kill-buffer-hook' here. It needs to happen before
1570 ;; variables like `buffer-file-name' etc are set to nil below,
1571 ;; because some of the hooks that could be invoked
1572 ;; (e.g., `save-place-to-alist') depend on those variables.
1573 ;;
1574 ;; Note that `kill-buffer-hook' is not what queries whether to
1575 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1576 ;; asks that itself. Thus, there's no need to temporarily do
1577 ;; `(set-buffer-modified-p nil)' before running this hook.
1579 ;; Okay, now we can end-of-life the old buffer.
1586 ;; This prevents us from finding the same buffer
1587 ;; if we specified the same file again.
1591 ;; Likewise for dired buffers.
1595 ;; This executes if find-file gets an error
1596 ;; and does not really find anything.
1597 ;; We put things back as they were.
1598 ;; If find-file actually finds something, we kill obuf below.
1607 ;; We already ran these; don't run them again.
1610 \f
1612 "Create a suitably named buffer for visiting FILENAME, and return it.
1613 FILENAME (sans directory) is used unchanged if that name is free;
1614 otherwise a string <2> or <3> or ... is appended to get an unused name.
1615 Spaces at the start of FILENAME (sans directory) are removed."
1624 "Create and return a buffer with a name based on NAME.
1625 Choose the buffer's name using `generate-new-buffer-name'."
1629 "Regexp to match the automounter prefix in a directory name."
1637 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1639 home directory is a root directory) and removes automounter prefixes
1640 \(see the variable `automount-dir-prefix')."
1641 ;; Get rid of the prefixes added by the automounter.
1648 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1649 ;; To fix this right, we need a `file-name-case-sensitive-p'
1650 ;; function, but we don't have that yet, so just guess.
1653 ;; If any elt of directory-abbrev-alist matches this name,
1654 ;; abbreviate accordingly.
1660 ;; Compute and save the abbreviated homedir name.
1661 ;; We defer computing this until the first time it's needed, to
1662 ;; give time for directory-abbrev-alist to be set properly.
1663 ;; We include a slash at the end, to avoid spurious matches
1664 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1671 ;; If FILENAME starts with the abbreviated homedir,
1672 ;; make it start with `~' instead.
1674 ;; If the home dir is just /, don't change it.
1677 ;; MS-DOS root directories can come with a drive letter;
1678 ;; Novell Netware allows drive letters beyond `Z:'.
1686 filename)))
1689 "List of logical names for which visiting shouldn't save the true dirname."
1694 "Return the buffer visiting file FILENAME (a string).
1695 This is like `get-file-buffer', except that it checks for any buffer
1696 visiting the same file, possibly under a different name.
1697 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1698 and others are ignored.
1699 If there is no such live buffer, return nil."
1712 found)
1722 ;; Verify this buffer's file number
1723 ;; still belongs to its file.
1726 attributes)
1730 found))))
1731 \f
1733 "Non-nil means file-visiting commands should handle wildcards.
1734 For example, if you specify `*.c', that would visit all the files
1735 whose names match the pattern."
1741 "Non-nil means suppress warning messages for symlinked files.
1742 When nil, Emacs prints a warning when visiting a file that is already
1743 visited, but with a different name. Setting this option to t
1744 suppresses this warning."
1750 "Maximum size of file above which a confirmation is requested.
1751 When nil, never request confirmation."
1758 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1759 OP-TYPE specifies the file operation being performed (for message to user)."
1769 "Read file FILENAME into a buffer and return the buffer.
1770 If a buffer exists visiting FILENAME, return that one, but
1771 verify that the file has not changed since visited or saved.
1772 The buffer is not selected, just returned to the caller.
1773 Optional second arg NOWARN non-nil means suppress any warning messages.
1774 Optional third arg RAWFILE non-nil means the file is read literally.
1775 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1776 and visit all the matching files. When wildcards are actually
1777 used and expanded, return a list of buffers that are visiting
1778 the various files."
1785 'find-directory-functions
1788 filename)))
1791 find-file-wildcards
1805 ;; Find any buffer for a file which has same truename.
1807 ;; Let user know if there is a buffer with the same truename.
1811 find-file-suppress-same-file-warnings
1815 ;; Optionally also find that buffer.
1818 ;; Check to see if the file looks uncommonly large.
1822 ;; We are using an existing buffer.
1829 ;; Certain files should be reverted automatically
1830 ;; if they have changed on disk and not in the buffer.
1838 found))
1848 "File %s changed on disk. Discard your edits? "
1853 "File %s changed on disk. Discard your edits in %s? "
1861 ;; Check if a formerly read-only file has become
1862 ;; writable and vice versa, but if the buffer agrees
1863 ;; with the new state of the file, that is ok too.
1871 buffer-file-name
1880 ;; It is confusing to ask whether to visit
1881 ;; non-literally if they have the file in
1882 ;; hexl-mode.
1888 "The file %s is already visited normally,
1889 and you have edited the buffer. Now you have asked to visit it literally,
1890 meaning no coding system handling, format conversion, or local variables.
1891 Emacs can only visit a file in one way at a time.
1893 Do you want to save the file, and visit it literally instead? "
1894 "The file %s is already visited literally,
1895 meaning no coding system handling, format conversion, or local variables.
1896 You have edited the buffer. Now you have asked to visit the file normally,
1897 but Emacs can only visit a file in one way at a time.
1904 rawfile truename number))
1908 "\
1909 Do you want to discard your changes, and visit the file literally now? "
1910 "\
1913 rawfile truename number)
1919 "The file %s is already visited normally.
1920 You have asked to visit it literally,
1921 meaning no coding system decoding, format conversion, or local variables.
1922 But Emacs can only visit a file in one way at a time.
1924 Do you want to revisit the file literally now? "
1925 "The file %s is already visited literally,
1926 meaning no coding system decoding, format conversion, or local variables.
1927 You have asked to visit it normally,
1928 but Emacs can only visit a file in one way at a time.
1933 rawfile truename number)
1936 ;; Return the buffer we are using.
1937 buf)
1938 ;; Create a new buffer.
1940 ;; find-file-noselect-1 may use a different buffer.
1942 rawfile truename number))))))
1948 ;; Needed in case we are re-visiting the file with a different
1949 ;; text representation.
1966 filename)))
1967 ;; Unconditionally set error
1977 filename)))
1978 ;; Run find-file-not-found-functions until one returns non-nil.
1980 ;; If they fail too, set error.
1982 ;; Record the file's truename, and maybe use that as visited name.
1990 ;; Set buffer's default directory to that of the file.
1992 ;; Turn off backup files for certain file names. Since
1993 ;; this is a permanent local, the major mode won't eliminate it.
2008 \f
2010 "Like `insert-file-contents', but only reads in the file literally.
2011 A buffer may be modified in several ways after reading into the buffer,
2012 to Emacs features such as format decoding, character code
2013 conversion, `find-file-hook', automatic uncompression, etc.
2015 This function ensures that none of these modifications will take place."
2023 nil))
2026 inhibit-file-name-handlers))
2039 filename)))
2040 ;; Check whether the file is uncommonly large
2051 "Insert contents of file FILENAME into buffer after point with no conversion.
2053 This function is meant for the user to run interactively.
2054 Don't call it from programs! Use `insert-file-contents-literally' instead.
2055 \(Its calling sequence is different; see its documentation)."
2060 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2065 "Visit file FILENAME with no conversion of any kind.
2066 Format conversion and character code conversion are both disabled,
2067 and multibyte characters are disabled in the resulting buffer.
2068 The major mode used is Fundamental mode regardless of the file name,
2069 and local variable specifications in the file are ignored.
2070 Automatic uncompression and adding a newline at the end of the
2071 file due to `require-final-newline' is also disabled.
2073 You cannot absolutely rely on this function to result in
2074 visiting the file literally. If Emacs already has a buffer
2075 which is visiting the file, you get the existing buffer,
2076 regardless of whether it was created literally or not.
2078 In a Lisp program, if you want to be sure of accessing a file's
2079 contents literally, you should create a temporary buffer and then read
2080 the file contents into it using `insert-file-contents-literally'."
2083 "Find file literally: " nil default-directory
2086 \f
2090 after-find-file-from-revert-buffer
2091 nomodes)
2092 "Called after finding a file and by the default revert function.
2093 Sets buffer mode, parses local variables.
2094 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2095 error in reading the file. WARN non-nil means warn if there
2096 exists an auto-save file more recent than the visited file.
2097 NOAUTO means don't mess with auto-save mode.
2098 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2099 means this call was from `revert-buffer'.
2100 Fifth arg NOMODES non-nil means don't alter the file's modes.
2101 Finishes by calling the functions in `find-file-hook'
2102 unless NOMODES is non-nil."
2105 nil
2115 ;; No need to warn if buffer is auto-saved
2116 ;; under the name of the visited file.
2118 auto-save-visited-file-name))
2121 buffer-file-name))
2141 ;; Make people do a little extra work (C-x C-q)
2142 ;; before altering a backup file.
2145 ;; When a file is marked read-only,
2146 ;; make the buffer read-only even if root is looking at it.
2154 ;; If requested, add a newline at the end of the file.
2164 view-read-only
2170 "Eval BODY and turn any error into a FORMAT message.
2171 FORMAT can have a %s escape which will be replaced with the actual error.
2172 If `debug-on-error' is set, errors are not caught, so that you can
2173 debug them.
2174 Avoid using a large BODY since it is duplicated."
2183 "Choose the major mode for this buffer automatically.
2184 Also sets up any specified local variables of the file.
2185 Uses the visited file name, the -*- line, and the local variables spec.
2187 This function is called automatically from `find-file'. In that case,
2188 we may set up the file-specified mode and local variables,
2189 depending on the value of `enable-local-variables'.
2190 In addition, if `local-enable-local-variables' is nil, we do
2191 not set local variables (though we do notice a mode specified with -*-.)
2193 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2194 or from Lisp without specifying the optional argument FIND-FILE;
2195 in that case, this function acts as if `enable-local-variables' were t."
2203 ;; Turn font lock off and on, to make sure it takes account of
2204 ;; whatever file local variables are relevant to it.
2206 ;; Font-lock-mode (now in font-core.el) can be ON when
2207 ;; font-lock.el still hasn't been loaded.
2217 "Non-nil means to try second pass through `auto-mode-alist'.
2218 This means that if the first case-sensitive search through the alist fails
2219 to find a matching major mode, a second case-insensitive search is made.
2220 On systems with case-insensitive file names, this variable is ignored,
2221 since only a single case-insensitive search through the alist is made."
2227 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2228 ;; c++-mode, java-mode and more) are added through autoload
2229 ;; directives in that file. That way is discouraged since it
2230 ;; spreads out the definition of the initial value.
2274 ;; Less common extensions come here
2275 ;; so more common ones above are found faster.
2283 ;; Besides .gdbinit, gdb documents other names to be usable for init
2284 ;; files, cross-debuggers can use something like
2285 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2286 ;; don't interfere with each other.
2324 ;; The list of archive file extensions should be in sync with
2325 ;; `auto-coding-alist' with `no-conversion' coding system.
2331 ;; Mailer puts message to be edited in
2332 ;; /tmp/Re.... or Message
2335 ;; some news reader is reported to use this
2344 ;; .emacs or .gnus or .viper following a directory delimiter in
2345 ;; Unix, MSDOG or VMS syntax.
2348 ;; _emacs following a directory delimiter
2349 ;; in MsDos syntax
2353 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2354 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2355 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2358 ;; .xs is also used for ld scripts, but seems to be more commonly
2359 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2361 ;; Explained in binutils ld/genscripts.sh. Eg:
2362 ;; A .x script file is the default script.
2363 ;; A .xr script is for linking without relocation (-r flag). Etc.
2367 ;; Common Lisp ASDF package system.
2385 ;; Windows candidates may be opened case sensitively on Unix
2391 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2393 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2394 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2395 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2396 ;; this has lower priority to avoid matching changelog.sgml etc.
2398 ;; either user's dot-files or under /etc or some such
2400 ;; alas not all ~/.*rc files are like this
2401 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2406 ;; this contains everything twice, with space and with colon :-(
2408 ;; Get rid of any trailing .n.m and try again.
2409 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2410 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2411 ;; Using mode nil rather than `ignore' would let the search continue
2412 ;; through this list (with the shortened name) rather than start over.
2414 ;; The following should come after the ChangeLog pattern
2415 ;; for the sake of ChangeLog.1, etc.
2416 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2419 "Alist of filename patterns vs corresponding major mode functions.
2420 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2421 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2422 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2423 mode function to use. FUNCTION will be called, unless it is nil.
2425 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2426 calling FUNCTION (if it's not nil), we delete the suffix that matched
2427 REGEXP and search the list again for another match.
2429 If the file name matches `inhibit-first-line-modes-regexps',
2430 then `auto-mode-alist' is not processed.
2432 The extensions whose FUNCTION is `archive-mode' should also
2433 appear in `auto-coding-alist' with `no-conversion' coding system.
2435 See also `interpreter-mode-alist', which detects executable script modes
2436 based on the interpreters they specify to run,
2441 "Select Conf mode or XML mode according to start of file."
2451 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2452 ;; and pike-mode) are added through autoload directives in that
2453 ;; file. That way is discouraged since it spreads out the
2454 ;; definition of the initial value.
2493 "Alist mapping interpreter names to major modes.
2494 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2495 Each element looks like (INTERPRETER . MODE).
2496 If INTERPRETER matches the name of the interpreter specified in the first line
2497 of a script, mode MODE is enabled.
2505 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2506 When checking `inhibit-first-line-modes-regexps', we first discard
2512 "Regexp matching interpreters, for file mode determination.
2513 This regular expression is matched against the first line of a file
2514 to determine the file's mode in `set-auto-mode'. If it matches, the file
2515 is assumed to be interpreted by the interpreter matched by the second group
2516 of the regular expression. The mode is then determined as the mode
2520 "Alist of buffer beginnings vs. corresponding major mode functions.
2521 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2522 After visiting a file, if REGEXP matches the text at the beginning of the
2523 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2524 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2525 major mode.
2527 If FUNCTION is nil, then it is not called. (That is a way of saying
2535 ;; The < comes before the groups (but the first) to reduce backtracking.
2536 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2537 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2541 comment-re "*"
2544 . html-mode)
2546 ;; These two must come after html, because they are more general:
2551 . sgml-mode)
2554 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2555 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2556 After visiting a file, if REGEXP matches the text at the beginning of the
2557 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2558 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2559 have not specified a mode for this file.
2565 "Upper limit on `magic-mode-alist' regexp matches.
2569 "Select major mode appropriate for current buffer.
2571 To find the right major mode, this function checks for a -*- mode tag,
2572 checks if it uses an interpreter listed in `interpreter-mode-alist',
2573 matches the buffer beginning against `magic-mode-alist',
2574 compares the filename against the entries in `auto-mode-alist',
2575 then matches the buffer beginning against `magic-fallback-mode-alist'.
2577 It does not check for the `mode:' local variable in the
2578 Local Variables section of the file; for that, use `hack-local-variables'.
2580 If `enable-local-variables' is nil, this function does not check for a
2581 -*- mode tag.
2583 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2584 set the major mode only if that would change it. In other words
2585 we don't actually set it to the same mode the buffer already has."
2586 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2588 ;; Find a -*- mode tag
2595 ;; Find all specifications for the `mode:' variable
2596 ;; and execute them left to right.
2608 modes)))
2609 ;; Simple -*-MODE-*- case.
2612 modes))))
2613 ;; If we found modes to use, invoke them now, outside the save-excursion.
2621 ;; continuing would call minor modes again, toggling them off
2623 ;; If we didn't, look for an interpreter specified in the first line.
2624 ;; As a special case, allow for things like "#!/bin/env perl", which
2625 ;; finds the interpreter anywhere in $PATH.
2632 ;; Map interpreter name to a mode, signalling we're done at the
2633 ;; same time.
2635 interpreter-mode-alist))
2636 ;; If we found an interpreter mode to use, invoke it now.
2639 ;; Next try matching the buffer beginning against magic-mode-alist.
2653 ;; Next compare the filename against the entries in auto-mode-alist.
2658 ;; Remove remote file name identification.
2662 ;; Remove backup-suffixes from file name.
2665 ;; Find first matching alist entry.
2668 ;; System is case-insensitive.
2672 ;; System is case-sensitive.
2674 ;; First match case-sensitively.
2678 ;; Fallback to case-insensitive match.
2692 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2707 ;; When `keep-mode-if-same' is set, we are working on behalf of
2708 ;; set-visited-file-name. In that case, if the major mode specified is the
2709 ;; same one we already have, don't actually reset it. We don't want to lose
2710 ;; minor modes such as Font Lock.
2712 "Apply MODE and return it.
2713 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2714 any aliases and compared to current major mode. If they are the
2715 same, do nothing and return nil."
2721 mode)))
2724 "Find the -*- spec in the buffer.
2725 Call with point at the place to start searching from.
2726 If one is found, set point to the beginning
2727 and return the position of the end.
2728 Otherwise, return nil; point may be changed."
2731 ;; Don't look for -*- if this file name matches any
2732 ;; of the regexps in inhibit-first-line-modes-regexps.
2740 sufs)
2748 ;; If the file begins with "#!"
2749 ;; (exec interpreter magic), look
2750 ;; for mode frobs in the first two
2751 ;; lines. You cannot necessarily
2752 ;; put them in the first line of
2753 ;; such a file without screwing up
2754 ;; the interpreter invocation.
2755 ;; The same holds for
2756 ;; '\"
2757 ;; in man pages (preprocessor
2758 ;; magic for the `man' program).
2769 end))))
2770 \f
2771 ;;; Handling file local variables
2775 file-local-variables-alist dir-local-variables-alist)
2780 "Normal hook run after processing a file's local variables specs.
2781 Major modes can use this to examine user-specified local variables
2785 "List variable-value pairs that are considered safe.
2786 Each element is a cons cell (VAR . VAL), where VAR is a variable
2787 symbol and VAL is a value that is considered safe."
2788 :risky t
2795 "Expressions that are considered safe in an `eval:' local variable.
2796 Add expressions to this list if you want Emacs to evaluate them, when
2797 they appear in an `eval' local variable specification, without first
2798 asking you for confirmation."
2799 :risky t
2804 ;; Risky local variables:
2807 buffer-auto-save-file-name
2808 buffer-file-name
2809 buffer-file-truename
2810 buffer-undo-list
2811 debugger
2812 default-text-properties
2813 eval
2814 exec-directory
2815 exec-path
2816 file-name-handler-alist
2817 frame-title-format
2818 global-mode-string
2819 header-line-format
2820 icon-title-format
2821 inhibit-quit
2822 load-path
2823 max-lisp-eval-depth
2824 max-specpdl-size
2825 minor-mode-map-alist
2826 minor-mode-overriding-map-alist
2827 mode-line-format
2828 mode-name
2829 overriding-local-map
2830 overriding-terminal-local-map
2831 process-environment
2832 standard-input
2833 standard-output
2834 unread-command-events))
2836 ;; Safe local variables:
2837 ;;
2838 ;; For variables defined by major modes, the safety declarations can go into
2839 ;; the major mode's file, since that will be loaded before file variables are
2840 ;; processed.
2841 ;;
2842 ;; For variables defined by minor modes, put the safety declarations in the
2843 ;; file defining the minor mode after the defcustom/defvar using an autoload
2844 ;; cookie, e.g.:
2845 ;;
2846 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2847 ;;
2848 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2849 ;; minor mode file may not be loaded yet.
2850 ;;
2851 ;; For variables defined in the C source code the declaration should go here:
2872 "Alist of file-local variable settings in the current buffer.
2873 Each element in this list has the form (VAR . VALUE), where VAR
2874 is a file-local variable (a symbol) and VALUE is the value
2875 specified. The actual value in the buffer may differ from VALUE,
2880 "Alist of directory-local variable settings in the current buffer.
2881 Each element in this list has the form (VAR . VALUE), where VAR
2882 is a directory-local variable (a symbol) and VALUE is the value
2883 specified in .dir-locals.el. The actual value in the buffer
2884 may differ from VALUE, if it is changed by the major or minor modes,
2889 "Normal hook run before setting file-local variables.
2890 It is called after checking for unsafe/risky variables and
2891 setting `file-local-variables-alist', and before applying the
2892 variables stored in `file-local-variables-alist'. A hook
2893 function is allowed to change the contents of this alist.
2895 This hook is called only if there is at least one file-local
2899 "Get confirmation before setting up local variable values.
2900 ALL-VARS is the list of all variables to be set up.
2901 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2902 RISKY-VARS is the list of those that are marked as risky.
2903 DIR-NAME is a directory name if these settings come from
2904 directory-local variables, or nil otherwise."
2906 nil
2912 prompt char)
2922 ", and variables that are risky (**)."
2929 y -- to apply the local variables list.
2933 ! -- to apply the local variables list, and permanently mark these
2945 ;; Make strings with embedded whitespace easier to read.
2953 ""
2960 done)
2969 ;; read-event returns -1 if we are in a kbd
2970 ;; macro and there are no more events in the
2971 ;; macro. In that case, attempt to get an
2972 ;; event interactively.
2980 ;; When this is called from desktop-restore-file-buffer,
2981 ;; coding-system-for-read may be non-nil. Reset it before
2982 ;; writing to .emacs.
2986 'safe-local-variable-values
2987 safe-local-variable-values))))
2994 "Return local variables specified in the -*- line.
2995 Ignore any specification for `mode:' and `coding:';
2996 `set-auto-mode' should already have handled `mode:',
2997 `set-auto-coding' should already have handled `coding:'.
2999 If MODE-ONLY is non-nil, all we do is check whether the major
3000 mode is specified, returning t if it is specified. Otherwise,
3001 return an alist of elements (VAR . VAL), where VAR is a variable
3002 and VAL is the specified value."
3006 result mode-specified)
3007 ;; Parse the -*- line into the RESULT alist.
3008 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
3010 nil)
3012 ;; Simple form: "-*- MODENAME -*-". Already handled.
3014 nil)
3016 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3017 ;; (last ";" is optional).
3022 ;; There used to be a downcase here,
3023 ;; but the manual didn't say so,
3024 ;; and people want to set var names that aren't all lc.
3030 ;; It is traditional to ignore
3031 ;; case when checking for `mode' in set-auto-mode,
3032 ;; so we must do that here as well.
3033 ;; That is inconsistent, but we're stuck with it.
3034 ;; The same can be said for `coding' in set-auto-coding.
3040 'eval
3047 mode-specified
3048 result))))
3051 "Filter local variable settings, querying the user if necessary.
3052 VARIABLES is the alist of variable-value settings. This alist is
3053 filtered based on the values of `ignored-local-variables',
3054 `enable-local-eval', `enable-local-variables', and (if necessary)
3055 user interaction. The results are added to
3056 `file-local-variables-alist', without applying them.
3057 DIR-NAME is a directory name if these settings come from
3058 directory-local variables, or nil otherwise."
3059 ;; Find those variables that we may want to save to
3060 ;; `safe-local-variable-values'.
3066 ;; Ignore any variable in `ignored-local-variables'.
3067 nil)
3068 ;; Obey `enable-local-eval'.
3076 ;; Ignore duplicates (except `mode') in the present list.
3078 ;; Accept known-safe variables.
3082 ;; The variable is either risky or unsafe:
3089 ;; Query, unless all vars are safe or user wants no querying.
3095 risky-vars dir-name))
3106 "Parse and put into effect this buffer's local variables spec.
3107 If MODE-ONLY is non-nil, all we do is check whether the major mode
3108 is specified, returning t if it is specified."
3111 result)
3118 ;; Look for "Local variables:" line in last page.
3126 ;; suffix is what comes after "local variables:" in its line.
3127 ;; prefix is what comes before "local variables:" in its line.
3137 beg)
3141 endpos
3147 nil t))
3148 ;; This used to be an error, but really all it means is
3149 ;; that this may simply not be a local-variables section,
3150 ;; so just ignore it.
3160 ;; Discard the prefix.
3165 ;; Discard the suffix.
3173 ;; Find the variable name; strip whitespace.
3182 val)
3183 ;; Read the variable value.
3194 'eval
3199 ;; Now we've read all the local variables.
3200 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3202 ;; Otherwise, set the variables.
3209 ;; Any 'evals must run in the Right sequence.
3218 "Non-nil if SYM is safe as a file-local variable with value VAL.
3219 It is safe if any of these conditions are met:
3221 * There is a matching entry (SYM . VAL) in the
3222 `safe-local-variable-values' user option.
3224 * The `safe-local-variable' property of SYM is a function that
3225 evaluates to a non-nil value with VAL as an argument."
3229 ;; If the function signals an error, that means it
3230 ;; can't assure us that the value is safe.
3234 "Non-nil if SYM could be dangerous as a file-local variable.
3235 It is dangerous if either of these conditions are met:
3237 * Its `risky-local-variable' property is non-nil.
3243 ;; If this is an alias, check the base name.
3263 "Return t if it is safe to eval EXP when it is found in a file."
3265 ;; Detect certain `put' expressions.
3272 lisp-indent-function
3273 scheme-indent-function))
3274 ;; Only allow safe values (not functions).
3279 ;; Only allow indirect form specs.
3280 ;; During bootstrapping, edebug-basic-spec might not be
3281 ;; defined yet.
3285 ;; Allow expressions that the user requested.
3287 ;; Certain functions can be allowed with safe arguments
3288 ;; or can specify verification functions to try.
3296 ok))
3304 ok)))))))
3307 "Set local variable VAR with value VAL.
3308 If VAR is `mode', call `VAL-mode' as a function unless it's
3309 already the major mode."
3316 ;; A minor mode must be passed an argument.
3317 ;; Otherwise, if the user enables the minor mode in a
3318 ;; major mode hook, this would toggle it off.
3324 ;; Make sure the string has no text properties.
3325 ;; Some text properties can get evaluated in various ways,
3326 ;; so it is risky to put them on with a local variable list.
3330 \f
3331 ;;; Handling directory-local variables, aka project settings.
3337 "List of cached directory roots for directory-local variable classes.
3338 Each element in this list has the form (DIR CLASS MTIME).
3339 DIR is the name of the directory.
3340 CLASS is the name of a variable class (a symbol).
3341 MTIME is the recorded modification time of the directory-local
3342 variables file associated with this entry. This time is a list
3343 of two integers (the same format as `file-attributes'), and is
3344 used to test whether the cache entry is still valid.
3345 Alternatively, MTIME can be nil, which means the entry is always
3349 "Return the variable list for CLASS."
3353 "Collect directory-local variables from MODE-VARIABLES.
3354 VARIABLES is the initial list of variables.
3355 Returns the new list."
3360 ;; If variables are specified more than once, only use the last. (Why?)
3361 ;; The pseudo-variables mode and eval are different (bug#3430).
3364 ;; Need a new cons in case we setcdr later.
3368 "Collect entries from CLASS-VARIABLES into VARIABLES.
3369 ROOT is the root directory of the project.
3370 Return the new variables list."
3378 ;; Don't include this in the previous condition, because we
3379 ;; want to filter all strings before the next condition.
3391 "Declare that the DIRECTORY root is an instance of CLASS.
3392 DIRECTORY is the name of a directory, a string.
3393 CLASS is the name of a project class, a symbol.
3394 MTIME is either the modification time of the directory-local
3395 variables file that defined this class, or nil.
3397 When a file beneath DIRECTORY is visited, the mode-specific
3398 variables from CLASS are applied to the buffer. The variables
3399 for a class are defined using `dir-locals-set-class-variables'."
3406 "Map the type CLASS to a list of variable settings.
3407 CLASS is the project class, a symbol. VARIABLES is a list
3408 that declares directory-local variables for the class.
3409 An element in VARIABLES is either of the form:
3410 (MAJOR-MODE . ALIST)
3411 or
3412 (DIRECTORY . LIST)
3414 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3415 whose elements are of the form (VARIABLE . VALUE).
3417 In the second form, DIRECTORY is a directory name (a string), and
3418 LIST is a list of the form accepted by the function.
3420 When a file is visited, the file's class is found. A directory
3421 may be assigned a class using `dir-locals-set-directory-class'.
3422 Then variables are set in the file's buffer according to the
3423 class' LIST. The list is processed in order.
3425 * If the element is of the form (MAJOR-MODE . ALIST), and the
3426 buffer's major mode is derived from MAJOR-MODE (as determined
3427 by `derived-mode-p'), then all the variables in ALIST are
3428 applied. A MAJOR-MODE of nil may be used to match any buffer.
3429 `make-local-variable' is called for each variable before it is
3430 set.
3432 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3433 is an initial substring of the file's directory, then LIST is
3434 applied by recursively following these rules."
3441 "File that contains directory-local variables.
3442 It has to be constant to enforce uniform values
3446 "Find the directory-local variables for FILE.
3447 This searches upward in the directory tree from FILE.
3448 If the directory root of FILE has been registered in
3449 `dir-locals-directory-cache' and the directory-local variables
3450 file has not been modified, return the matching entry in
3451 `dir-locals-directory-cache'.
3452 Otherwise, if a directory-local variables file is found, return
3453 the file name.
3454 Otherwise, return nil."
3459 dir-locals-file))
3462 ;; `locate-dominating-file' may have abbreviated the name.
3465 ;; Find the best cached value in `dir-locals-directory-cache'.
3478 ;; Check the validity of the cache.
3483 ;; This cache entry is OK.
3484 dir-elt
3485 ;; This cache entry is invalid; clear it.
3488 locals-file)
3489 locals-file))))
3492 "Load a variables FILE and register a new class and instance.
3493 FILE is the name of the file holding the variables to apply.
3494 The new class name is the same as the directory in which FILE
3495 is found. Returns the new class name."
3505 class-name)))
3508 "Read per-directory local variables for the current buffer.
3509 Store the directory-local variables in `dir-local-variables-alist'
3510 and `file-local-variables-alist', without applying them."
3513 ;; Find the variables file.
3519 (setq dir-name (if (buffer-file-name) (file-name-directory (buffer-file-name)) default-directory))
3540 \f
3543 However, the mode will not be changed if
3544 \(1) a local variables list or the `-*-' line specifies a major mode, or
3546 \ not suitable for ordinary files, or
3547 \(3) the new file name does not particularly specify any mode."
3552 "Change name of file visited in current buffer to FILENAME.
3553 This also renames the buffer to correspond to the new file.
3554 The next time the buffer is saved it will go in the newly specified file.
3555 FILENAME nil or an empty string means mark buffer as not visiting any file.
3556 Remember to delete the initial contents of the minibuffer
3557 if you wish to pass an empty string as the argument.
3559 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3560 confirmation in the case where another buffer is already visiting FILENAME.
3562 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3563 the old visited file has been renamed to the new name FILENAME."
3571 nil
3586 filename)))
3596 ;; If new-name == old-name, renaming would add a spurious <2>
3597 ;; and it's considered as a feature in rename-buffer.
3603 ;; Abbreviate the file names of the buffer.
3612 nil)))
3613 ;; write-file-functions is normally used for things like ftp-find-file
3614 ;; that visit things that are not local files as if they were files.
3615 ;; Changing to visit an ordinary local file instead should flush the hook.
3620 ;; If buffer was read-only because of version control,
3621 ;; that reason is gone now, so make it writable.
3625 ;; Turn off backup files for certain file names.
3626 ;; Since this is a permanent local, the major mode won't eliminate it.
3628 backup-enable-predicate
3634 ;; If auto-save was not already on, turn it on if appropriate.
3638 ;; If auto save is on, start using a new name.
3639 ;; We deliberately don't rename or delete the old auto save
3640 ;; for the old visited file name. This is because perhaps
3641 ;; the user wants to save the new state and then compare with the
3642 ;; previous state from the auto save file.
3645 ;; Rename the old auto save file if any.
3652 ;; Update the major mode, if the file name determines it.
3654 ;; Don't change the mode if it is special.
3657 ;; Don't change the mode if the local variable list specifies it.
3663 "Write current buffer into file FILENAME.
3664 This makes the buffer visit that file, and marks it as not modified.
3666 If you specify just a directory name as FILENAME, that means to use
3667 the default file name but in that directory. You can also yank
3668 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3670 If the buffer is not already visiting a file, the default file name
3671 for the output file is the buffer name.
3673 If optional second arg CONFIRM is non-nil, this function
3674 asks for confirmation before overwriting an existing file.
3675 Interactively, confirmation is required unless you supply a prefix argument."
3676 ;; (interactive "FWrite file: ")
3680 nil nil nil nil)
3684 default-directory)
3685 nil nil))
3689 ;; If arg is just a directory,
3690 ;; use the default file name, but in that directory.
3701 ;; Make buffer writable if file is writable.
3706 ;; It's likely that the VC status at the new location is different from
3707 ;; the one at the old location.
3709 \f
3711 "Make a backup of the disk file visited by the current buffer, if appropriate.
3712 This is normally done before saving the buffer the first time.
3714 A backup may be done by renaming or by copying; see documentation of
3715 variable `make-backup-files'. If it's done by renaming, then the file is
3716 no longer accessible under its old name.
3718 The value is non-nil after a backup was made by renaming.
3719 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3720 MODES is the result of `file-modes' on the original
3721 file; this means that the caller, after saving the buffer, should change
3722 the modes of the new file to agree with the old modes.
3723 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3724 file; this means that the caller, after saving the buffer, should change
3725 the SELinux context of the new file to agree with the old context.
3726 BACKUPNAME is the backup file name, which is the old file renamed."
3733 backup-info backupname targets setmodes)
3734 ;; If specified name is a symbolic link, chase it to the target.
3735 ;; Thus we make the backups in the directory where the real file is.
3740 ;; (if (file-directory-p buffer-file-name)
3741 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3745 ;; If have old versions to maybe delete,
3746 ;; ask the user to confirm now, before doing anything.
3747 ;; But don't actually delete til later.
3752 real-file-name)))))
3755 ;; Actually write the back up file.
3758 ; (file-symlink-p buffer-file-name)
3759 backup-by-copying
3760 ;; Don't rename a suid or sgid file.
3775 ;; rename-file should delete old backup.
3779 ;; If trouble writing the backup, write it in ~.
3784 backupname)
3788 ;; Now delete the old versions, if desired.
3795 setmodes)
3802 ;; Create temp files with strict access rights. It's easy to
3803 ;; loosen them later, whereas it's impossible to close the
3804 ;; time-window of loose permissions otherwise.
3807 ;; Try to overwrite old backup first.
3815 nil)
3817 ;; The file was somehow created by someone else between
3818 ;; `delete-file' and `copy-file', so let's try again.
3819 ;; rms says "I think there is also a possible race
3820 ;; condition for making backup files" (emacs-devel 20070821).
3821 nil)))
3822 ;; Reset the umask.
3830 "Return file NAME sans backup versions or strings.
3831 This is a separate procedure so your site-init or startup file can
3832 redefine it.
3833 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3834 we do not remove backup version numbers, only true file version numbers."
3846 "Return t if deleting FILE and rewriting it would preserve the owner."
3851 ;; Return t if the file doesn't exist, since it's true that no
3852 ;; information would be lost by an (attempted) delete and create.
3858 The extension, in a file name, is the part that follows the last `.',
3859 except that a leading `.', if any, doesn't count."
3862 directory)
3866 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3867 ;; we don't want to expand it.
3870 filename))))
3874 The extension, in a file name, is the part that follows the last `.',
3875 excluding version numbers and backup suffixes,
3876 except that a leading `.', if any, doesn't count.
3877 Return nil for extensionless file names such as `foo'.
3878 Return the empty string for file names such as `foo.'.
3880 If PERIOD is non-nil, then the returned value includes the period
3881 that delimits the extension, and if FILENAME has no extension,
3892 "A function to use instead of the default `make-backup-file-name'.
3893 A value of nil gives the default `make-backup-file-name' behavior.
3895 This could be buffer-local to do something special for specific
3896 files. If you define it, you may need to change `backup-file-name-p'
3897 and `file-name-sans-versions' too.
3899 See also `backup-directory-alist'."
3905 "Alist of filename patterns and backup directory names.
3906 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3907 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3908 relative or absolute. If it is absolute, so that all matching files
3909 are backed up into the same directory, the file names in this
3910 directory will be the full name of the file backed up with all
3911 directory separators changed to `!' to prevent clashes. This will not
3912 work correctly if your filesystem truncates the resulting name.
3914 For the common case of all backups going into one directory, the alist
3916 directory name.
3918 If this variable is nil, or it fails to match a filename, the backup
3919 is made in the original file's directory.
3921 On MS-DOS filesystems without long names this variable is always
3922 ignored."
3928 "Default `backup-enable-predicate' function.
3929 Checks for files in `temporary-file-directory',
3930 `small-temporary-file-directory', and /tmp."
3933 ;; Directory is under temporary-file-directory.
3938 ;; Directory is under /tmp.
3943 0 nil
3945 ;; Directory is under small-temporary-file-directory.
3950 "Create the non-numeric backup file name for FILE.
3951 Normally this will just be the file's name with `~' appended.
3952 Customization hooks are provided as follows.
3954 If the variable `make-backup-file-name-function' is non-nil, its value
3955 should be a function which will be called with FILE as its argument;
3956 the resulting name is used.
3958 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3959 the documentation of that variable. If the directory for the backup
3960 doesn't exist, it is created."
3974 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3976 elt backup-directory abs-backup-directory)
3981 alist nil)))
3982 ;; If backup-directory is relative, it should be relative to the
3983 ;; file's directory. By expanding explicitly here, we avoid
3984 ;; depending on default-directory.
3993 abs-backup-directory nil))))
3995 file
3999 ;; Normalize DOSish file names: downcase the drive
4000 ;; letter, if any, and replace the leading "x:" with
4001 ;; "/drive_x".
4004 ;; Replace any invalid file-name characters (for the
4005 ;; case of backing up remote files).
4009 "drive_"
4012 ""
4015 ;; Make the name unique by substituting directory
4016 ;; separators. It may not really be worth bothering about
4017 ;; doubling `!'s in the original name...
4022 backup-directory))
4027 "Return non-nil if FILE is a backup file name (numeric or not).
4028 This is a separate function so you can redefine it for customization.
4029 You may need to redefine `file-name-sans-versions' as well."
4034 ;; This is used in various files.
4035 ;; The usage of backup-extract-version-start is not very clean,
4036 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4038 "Given the name of a numeric backup file, FN, return the backup number.
4039 Uses the free variable `backup-extract-version-start', whose value should be
4040 the index in the name where the version number begins."
4047 "Find a file name for a backup file FN, and suggestions for deletions.
4048 Value is a list whose car is the name for the backup file
4049 and whose cdr is a list of old versions to consider deleting now.
4050 If the value is nil, don't make a backup.
4051 Uses `backup-directory-alist' in the same way as does
4052 `make-backup-file-name'."
4054 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4058 ;; We don't support numbered backups on plain MS-DOS
4059 ;; when long file names are unavailable.
4069 possibilities deserve-versions-p versions)
4072 base-versions
4075 possibilities)
4076 #'<)
4081 kept-old-versions
4082 kept-new-versions
4089 ;; Delete nothing if there is overflow
4090 ;; in the number of versions to keep.
4096 v))))))))))
4099 "Return number of names file FILENAME has."
4102 ;; (defun file-relative-name (filename &optional directory)
4103 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4104 ;; This function returns a relative file name which is equivalent to FILENAME
4105 ;; when used with that default directory as the default.
4106 ;; If this is impossible (which can happen on MSDOS and Windows
4107 ;; when the file name and directory use different drive names)
4108 ;; then it returns FILENAME."
4109 ;; (save-match-data
4110 ;; (let ((fname (expand-file-name filename)))
4111 ;; (setq directory (file-name-as-directory
4112 ;; (expand-file-name (or directory default-directory))))
4113 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4114 ;; ;; drive names, they can't be relative, so return the absolute name.
4115 ;; (if (and (or (eq system-type 'ms-dos)
4116 ;; (eq system-type 'cygwin)
4117 ;; (eq system-type 'windows-nt))
4118 ;; (not (string-equal (substring fname 0 2)
4119 ;; (substring directory 0 2))))
4120 ;; filename
4121 ;; (let ((ancestor ".")
4122 ;; (fname-dir (file-name-as-directory fname)))
4123 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4124 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4125 ;; (setq directory (file-name-directory (substring directory 0 -1))
4126 ;; ancestor (if (equal ancestor ".")
4127 ;; ".."
4128 ;; (concat "../" ancestor))))
4129 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4130 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4131 ;; ;; We matched within FNAME's directory part.
4132 ;; ;; Add the rest of FNAME onto ANCESTOR.
4133 ;; (let ((rest (substring fname (match-end 0))))
4134 ;; (if (and (equal ancestor ".")
4135 ;; (not (equal rest "")))
4136 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4137 ;; rest
4138 ;; (concat (file-name-as-directory ancestor) rest)))
4139 ;; ;; We matched FNAME's directory equivalent.
4140 ;; ancestor))))))
4143 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4144 This function returns a relative file name which is equivalent to FILENAME
4145 when used with that default directory as the default.
4146 If FILENAME and DIRECTORY lie on different machines or on different drives
4147 on a DOS/Windows machine, it returns FILENAME in expanded form."
4151 default-directory))))
4157 ;; Test for different drives on DOS/Windows
4159 ;; Should `cygwin' really be included here? --stef
4162 ;; Test for different remote file system identification
4164 filename
4170 directory nil nil case-fold-search))
4172 directory nil nil case-fold-search))))
4175 ".."
4177 ;; Now ancestor is empty, or .., or ../.., etc.
4179 directory nil nil case-fold-search))
4180 ;; We matched within FILENAME's directory part.
4181 ;; Add the rest of FILENAME onto ANCESTOR.
4184 ;; But don't bother with ANCESTOR if it would give us `./'.
4185 rest
4187 ;; We matched FILENAME's directory equivalent.
4188 ancestor))))))
4189 \f
4191 "Save current buffer in visited file if modified.
4192 Variations are described below.
4194 By default, makes the previous version into a backup file
4195 if previously requested or if this is the first save.
4197 to become a backup when the next save is done.
4199 unconditionally makes the previous version into a backup file.
4201 to become a backup when the next save is done,
4202 and unconditionally makes the previous version into a backup file.
4204 With a numeric argument of 0, never make the previous version
4205 into a backup file.
4207 If a file's name is FOO, the names of its numbered backup versions are
4208 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4209 Numeric backups (rather than FOO~) will be made if value of
4210 `version-control' is not the atom `never' and either there are already
4211 numeric versions of the file being backed up, or `version-control' is
4212 non-nil.
4213 We don't want excessive versions piling up, so there are variables
4214 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4215 and `kept-new-versions', which tells how many newest versions to keep.
4216 Defaults are 2 old versions and 2 new.
4217 `dired-kept-versions' controls dired's clean-directory (.) command.
4218 If `delete-old-versions' is nil, system will query user
4219 before trimming versions. Otherwise it does it silently.
4221 If `vc-make-backup-files' is nil, which is the default,
4222 no backup files are made for files managed by version control.
4223 (This is because the version control system itself records previous versions.)
4225 See the subroutine `basic-save-buffer' for more information."
4231 ;; We used to display the message below only for files > 50KB, but
4232 ;; then Rmail-mbox never displays it due to buffer swapping. If
4233 ;; the test is ever re-introduced, be sure to handle saving of
4234 ;; Rmail files.
4241 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4242 Normally delete only if the file was written by this Emacs since
4243 the last real save, but optional arg FORCE non-nil means delete anyway."
4257 "Normal hook that is run before a buffer is saved to its file."
4263 "Normal hook that is run after a buffer is saved to its file."
4269 "If non-nil, use this coding system for saving the buffer.
4270 More precisely, use this coding system in place of the
4271 value of `buffer-file-coding-system', when saving the buffer.
4272 Calling `write-region' for any purpose other than saving the buffer
4273 will still use `buffer-file-coding-system'; this variable has no effect
4280 "Save the current buffer in its visited file, if it has been modified.
4281 The hooks `write-contents-functions' and `write-file-functions' get a chance
4282 to do the job of saving; if they do not, then the buffer is saved in
4283 the visited file in the usual way.
4284 Before and after saving the buffer, this function runs
4285 `before-save-hook' and `after-save-hook', respectively."
4288 ;; In an indirect buffer, save its base buffer instead.
4293 setmodes)
4294 ;; If buffer has no file name, ask user for one.
4301 ;; Signal an error if the user specified the name of an
4302 ;; existing directory.
4305 filename))
4307 ;; Signal an error if the specified name refers to a
4308 ;; non-existing directory.
4338 ;; Support VC version backups.
4344 ;; If a hook returned t, file is already "written".
4345 ;; Otherwise, write it the usual way now.
4347 ;; Now we have saved the current buffer. Let's make sure
4348 ;; that buffer-file-coding-system is fixed to what
4349 ;; actually used for saving by binding it locally.
4361 ;; If the auto-save file was recent before this command,
4362 ;; delete it now.
4364 ;; Support VC `implicit' locking.
4369 ;; This does the "real job" of writing a buffer into its visited file
4370 ;; and making a backup file. This is what is normally done
4371 ;; but inhibited if one of write-file-functions returns non-nil.
4372 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4384 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4398 buffer-file-name)))
4412 ;; Write temp name, then rename it.
4413 ;; This requires write access to the containing dir,
4414 ;; which is why we don't try it if we don't have that access.
4416 tempname succeed
4419 ;; Create temp files with strict access rights. It's easy to
4420 ;; loosen them later, whereas it's impossible to close the
4421 ;; time-window of loose permissions otherwise.
4426 ;; Try various temporary names.
4427 ;; This code follows the example of make-temp-file,
4428 ;; but it calls write-region in the appropriate way
4429 ;; for saving the buffer.
4435 ;; Pass in nil&nil rather than point-min&max
4436 ;; cause we're saving the whole buffer.
4437 ;; write-region-annotate-functions may use it.
4439 tempname nil realname
4441 nil)
4443 ;; The file was somehow created by someone else between
4444 ;; `make-temp-name' and `write-region', let's try again.
4445 nil)
4447 ;; Reset the umask.
4449 ;; If we failed, restore the buffer's modtime.
4452 ;; Since we have created an entirely new file,
4453 ;; make sure it gets the right permission bits set.
4458 buffer-file-name)))
4459 ;; We succeeded in writing the temp file,
4460 ;; so rename it.
4462 ;; If file not writable, see if we can make it writable
4463 ;; temporarily while we write it.
4464 ;; But no need to do so if we have just backed it up
4465 ;; (setmodes is set) because that says we're superseding.
4467 ;; Change the mode back, after writing.
4470 buffer-file-name))
4476 ;; Pass in nil&nil rather than point-min&max to indicate
4477 ;; we're saving the buffer rather than just a region.
4478 ;; write-region-annotate-functions may make us of it.
4480 buffer-file-name nil t buffer-file-truename)
4482 ;; If we get an error writing the new file, and we made
4483 ;; the backup by renaming, undo the backing-up.
4488 setmodes))
4491 `((?\C-r
4498 ;; Return nil to ask about BUF again.
4499 nil)
4512 ;; Return nil to ask about BUF again.
4513 nil)
4523 "Save some modified file-visiting buffers. Asks user about each one.
4524 You can answer `y' to save, `n' not to save, `C-r' to look at the
4525 buffer in question with `view-buffer' before deciding or `d' to
4526 view the differences using `diff-buffer-with-file'.
4528 Optional argument (the prefix) non-nil means save all with no questions.
4529 Optional second argument PRED determines which buffers are considered:
4530 If PRED is nil, all the file-visiting buffers are considered.
4531 If PRED is t, then certain non-file buffers will also be considered.
4532 If PRED is a zero-argument function, it indicates for each buffer whether
4533 to consider it or not when called with that buffer current.
4535 See `save-some-buffers-action-alist' if you want to
4536 change the additional actions you can take on files."
4540 files-done abbrevs-done)
4542 ;; First save any buffers that we're supposed to save unconditionally.
4543 ;; That way the following code won't ask about them.
4548 ;; Ask about those buffers that merit it,
4549 ;; and record the number thus saved.
4553 ;; Note that killing some buffers may kill others via
4554 ;; hooks (e.g. Rmail and its viewing buffer).
4567 t
4579 save-some-buffers-action-alist))
4580 ;; Maybe to save abbrevs, and record whether
4581 ;; we either saved them or asked to.
4587 abbrev-file-name)))
4589 ;; Don't keep bothering user if he says no.
4594 "(Some special files were saved without asking)"
4596 \f
4598 "Mark current buffer as unmodified, not needing to be saved.
4601 It is not a good idea to use this function in Lisp programs, because it
4602 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4609 "Change whether this buffer is read-only.
4610 With prefix argument ARG, make the buffer read-only if ARG is
4611 positive, otherwise make it writable. If buffer is read-only
4612 and `view-read-only' is non-nil, enter view mode."
4617 nil ; do nothing.
4618 ;; Toggle.
4625 ;; If view-mode is already active, `view-mode-enter' is a nop.
4637 "Insert contents of file FILENAME into buffer after point.
4638 Set mark after the inserted text.
4640 This function is meant for the user to run interactively.
4641 Don't call it from programs! Use `insert-file-contents' instead.
4642 \(Its calling sequence is different; see its documentation)."
4647 "Append the contents of the region to the end of file FILENAME.
4648 When called from a function, expects three arguments,
4649 START, END and FILENAME. START and END are normally buffer positions
4650 specifying the part of the buffer to write.
4651 If START is nil, that means to use the entire buffer contents.
4652 If START is a string, then output that string to the file
4653 instead of any buffer contents; END is ignored.
4655 This does character code conversion and applies annotations
4656 like `write-region' does."
4661 "Return most recent backup file for FILENAME or nil if no backups exist."
4662 ;; `make-backup-file-name' will get us the right directory for
4663 ;; ordinary or numeric backups. It might create a directory for
4664 ;; backups as a side-effect, according to `backup-directory-alist'.
4671 tem)
4680 newest))
4683 "Rename current buffer to a similar name not already taken.
4684 This function is useful for creating multiple shell process buffers
4685 or multiple mail buffers, etc."
4693 ;; If the existing buffer name has a <NNN>,
4694 ;; which isn't part of the file name (if any),
4695 ;; then get rid of that.
4701 "Create the directory DIR and optionally any nonexistent parent dirs.
4702 If DIR already exists as a directory, signal an error, unless
4703 PARENTS is non-nil.
4705 Interactively, the default choice of directory to create is the
4706 current buffer's default directory. That is useful when you have
4707 visited a file in a nonexistent directory.
4709 Noninteractively, the second (optional) argument PARENTS, if
4710 non-nil, says whether to create parent directories that don't
4711 exist. Interactively, this happens by default."
4714 nil nil)
4715 t))
4716 ;; If default-directory is a remote directory,
4717 ;; make sure we find its make-directory handler.
4725 create-list)
4727 ;; If directory is its own parent, then we can't
4728 ;; keep looping forever
4743 "Delete the directory named DIRECTORY. Does not follow symlinks.
4744 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4745 TRASH non-nil means to trash the directory instead, provided
4746 `delete-by-moving-to-trash' is non-nil.
4748 When called interactively, TRASH is t if no prefix argument is
4749 given. With a prefix argument, TRASH is nil."
4756 "Move directory to trash: "
4758 default-directory default-directory nil nil))))
4764 nil)
4766 ;; If default-directory is a remote directory, make sure we find its
4767 ;; delete-directory handler.
4774 ;; Only move non-empty dir to trash if recursive deletion was
4775 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4776 ;; case, where the operation fails in delete-directory-internal.
4777 ;; As `move-file-to-trash' trashes directories (empty or
4778 ;; otherwise) as a unit, we do not need to recurse here.
4780 ;; Check if directory is empty apart from "." and "..".
4785 ;; Otherwise, call outselves recursively if needed.
4789 ;; This test is equivalent to
4790 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4791 ;; but more efficient
4795 ;; We do not want to delete "." and "..".
4801 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4802 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4804 This function always sets the file modes of the output files to match
4805 the corresponding input file.
4807 The third arg KEEP-TIME non-nil means give the output files the same
4808 last-modified time as the old ones. (This works on only some systems.)
4810 A prefix arg makes KEEP-TIME non-nil.
4812 Noninteractively, the last argument PARENTS says whether to
4813 create parent directories if they don't exist. Interactively,
4814 this happens by default."
4821 default-directory default-directory nil nil)
4822 current-prefix-arg t)))
4823 ;; If default-directory is a remote directory, make sure we find its
4824 ;; copy-directory handler.
4830 ;; Compute target name.
4835 ;; Copy recursively.
4847 ;; We do not want to copy "." and "..".
4850 ;; Set directory attributes.
4854 \f
4857 "Function to use to revert this buffer, or nil to do the default.
4858 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4863 "Function to use to insert contents when reverting this buffer.
4864 Gets two args, first the nominal file name to use,
4865 and second, t if reading the auto-save file.
4870 "Function to check whether a non-file buffer needs reverting.
4871 This should be a function with one optional argument NOCONFIRM.
4872 Auto Revert Mode passes t for NOCONFIRM. The function should return
4873 non-nil if the buffer should be reverted. A return value of
4874 `fast' means that the need for reverting was not checked, but
4875 that reverting the buffer is fast. The buffer is current when
4876 this function is called.
4878 The idea behind the NOCONFIRM argument is that it should be
4879 non-nil if the buffer is going to be reverted without asking the
4880 user. In such situations, one has to be careful with potentially
4881 time consuming operations.
4883 For more information on how this variable is used by Auto Revert mode,
4887 "Normal hook for `revert-buffer' to run before reverting.
4888 If `revert-buffer-function' is used to override the normal revert
4892 "Normal hook for `revert-buffer' to run after reverting.
4893 Note that the hook value that it runs is the value that was in effect
4894 before reverting; that makes a difference if you have buffer-local
4895 hook functions.
4897 If `revert-buffer-function' is used to override the normal revert
4903 "Replace current buffer text with the text of the visited file on disk.
4904 This undoes all changes since the file was visited or saved.
4905 With a prefix argument, offer to revert from latest auto-save file, if
4906 that is more recent than the visited file.
4908 This command also implements an interface for special buffers
4909 that contain text which doesn't come from a file, but reflects
4910 some other data instead (e.g. Dired buffers, `buffer-list'
4911 buffers). This is done via the variable `revert-buffer-function'.
4912 In these cases, it should reconstruct the buffer contents from the
4913 appropriate data.
4915 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4916 to revert from the auto-save file when this is nil. Note that the
4917 sense of this argument is the reverse of the prefix argument, for the
4918 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4919 to nil.
4921 Optional second argument NOCONFIRM means don't ask for confirmation
4922 at all. \(The variable `revert-without-query' offers another way to
4923 revert buffers without querying for confirmation.)
4925 Optional third argument PRESERVE-MODES non-nil means don't alter
4926 the files modes. Normally we reinitialize them using `normal-mode'.
4928 If the value of `revert-buffer-function' is non-nil, it is called to
4929 do all the work for this command. Otherwise, the hooks
4930 `before-revert-hook' and `after-revert-hook' are run at the beginning
4931 and the end, and if `revert-buffer-insert-file-contents-function' is
4932 non-nil, it is called instead of rereading visited file contents."
4934 ;; I admit it's odd to reverse the sense of the prefix argument, but
4935 ;; there is a lot of code out there which assumes that the first
4936 ;; argument should be t to avoid consulting the auto-save file, and
4937 ;; there's no straightforward way to encourage authors to notice a
4938 ;; reversal of the argument sense. So I'm just changing the user
4939 ;; interface, but leaving the programmatic interface the same.
4947 buffer-auto-save-file-name
4952 buffer-auto-save-file-name
4953 buffer-file-name)))
4963 file-name)))
4965 ;; If file was backed up but has changed since,
4966 ;; we should make another backup.
4970 ;; Effectively copy the after-revert-hook status,
4971 ;; since after-find-file will clobber it.
4974 after-revert-hook))
4979 ;; Get rid of all undo records for this buffer.
4981 ;; Don't make undo records for the reversion.
4984 file-name auto-save-p)))
4987 "File %s no longer exists!"
4989 file-name))
4992 "File %s no longer readable!"
4994 file-name))
4996 ;; Bind buffer-file-name to nil
4997 ;; so that we don't try to lock the file.
5003 ;; Auto-saved file should be read by Emacs'
5004 ;; internal coding.
5008 buffer-file-coding-system-explicit
5011 coding-system-for-read
5013 coding-system-for-read)
5015 ;; As a coding system suitable for multibyte
5016 ;; buffer is specified, make the current
5017 ;; buffer multibyte.
5020 ;; This force after-insert-file-set-coding
5021 ;; (called from insert-file-contents) to set
5022 ;; buffer-file-coding-system to a proper value.
5025 ;; Note that this preserves point in an intelligent way.
5029 nil nil t))
5031 nil nil t)))))
5032 ;; Recompute the truename in case changes in symlinks
5033 ;; have changed the truename.
5037 ;; Run after-revert-hook as it was before we reverted.
5041 local-hook)
5044 t))))))
5047 "Recover the visited file--get contents from its last auto-save file."
5052 "Visit file FILE, but get contents from its last auto-save file."
5053 ;; Actually putting the file name in the minibuffer should be used
5054 ;; only rarely.
5055 ;; Not just because users often use the default.
5075 ;; Use insert-directory-safely, not insert-directory,
5076 ;; because these files might not exist. In particular,
5077 ;; FILE might not exist if the auto-save file was for
5078 ;; a buffer that didn't visit a file, such as "*mail*".
5079 ;; The code in v20.x called `ls' directly, so we need
5080 ;; to emulate what `ls' did in that case.
5086 ;; Keep the current buffer-file-coding-system.
5088 ;; Auto-saved file should be read with special coding.
5097 "Recover auto save files from a previous Emacs session.
5098 This command first displays a Dired buffer showing you the
5099 previous sessions that you could recover from.
5100 To choose one, move point to the proper line and then type C-c C-c.
5101 Then you'll be asked about a number of files to recover."
5111 auto-save-list-file-prefix)))
5112 t)
5121 ;; Each line starts with a space
5122 ;; so that Font Lock mode won't highlight the first character.
5131 "Choose one saved session to recover auto-save files from.
5132 This command is used in the special Dired buffer created by
5135 ;; Get the name of the session file to recover from.
5137 files
5143 ;; Read in the auto-save-list file.
5146 ;; Loop thru the text of that file
5147 ;; and get out the names of the files to recover.
5151 ;; This is a pair of lines for a non-file-visiting buffer.
5152 ;; Get the auto-save file name and manufacture
5153 ;; a "visited file name" from that.
5156 ;; If there is no auto-save file name, the
5157 ;; auto-save-list file is probably corrupted.
5170 ;; This pair of lines is a file-visiting
5171 ;; buffer. Use the visited file name.
5181 ;; Ignore a file if its auto-save file does not exist now.
5185 ;; The file contains a pair of line for each auto-saved buffer.
5186 ;; The first line of the pair contains the visited file name
5187 ;; or is empty if the buffer was not visiting a file.
5188 ;; The second line is the auto-save file name.
5196 files
5202 "Kill BUFFER if confirmed."
5210 "Kill some buffers. Asks the user whether to kill each one of them.
5211 Non-interactively, if optional argument LIST is non-nil, it
5212 specifies the list of buffers to kill, asking for approval for each one."
5220 ; if we killed the base buffer.
5227 "Kill buffers whose name matches the specified REGEXP.
5228 The optional second argument indicates whether to kill internal buffers too."
5237 \f
5239 "Adjust current buffer's auto save file name for current conditions.
5240 Also rename any existing auto save file, if it was made in this session."
5252 "Return file name to use for auto-saves of current buffer.
5253 Does not consider `auto-save-visited-file-name' as that variable is checked
5254 before calling this function. You can redefine this for customization.
5255 See also `auto-save-file-name-p'."
5263 result uniq)
5264 ;; Apply user-specified translations
5265 ;; to the file name.
5269 filename)
5279 filename))))
5284 ;; We truncate the file name to DOS 8+3 limits
5285 ;; before doing anything else, because the regexp
5286 ;; passed to string-match below cannot handle
5287 ;; extensions longer than 3 characters, multiple
5288 ;; dots, and other atrocities.
5293 fn)
5298 "#"
5301 ;; Make sure auto-save file names don't contain characters
5302 ;; invalid for the underlying filesystem.
5304 ;; Don't modify remote (ange-ftp) filenames
5307 result))))
5309 ;; Deal with buffers that don't have any associated files. (Mail
5310 ;; mode tends to create a good number of these.)
5314 file-name)
5315 ;; Restrict the characters used in the file name to those which
5316 ;; are known to be safe on all filesystems, url-encoding the
5317 ;; rest.
5318 ;; We do this on all platforms, because even if we are not
5319 ;; running on DOS/Windows, the current directory may be on a
5320 ;; mounted VFAT filesystem, such as a USB memory stick.
5324 ;; For multibyte characters, this will produce more than
5325 ;; 2 hex digits, so is not true URL encoding.
5329 ;; Generate the file name.
5335 ;; Try a few alternative directories, to get one we can
5336 ;; write it.
5342 ;; Don't modify remote (ange-ftp) filenames
5344 ;; The call to convert-standard-filename is in case
5345 ;; buffer-name includes characters not allowed by the
5346 ;; DOS/Windows filesystems. make-temp-file writes to the
5347 ;; file it creates, so we must fix the file name _before_
5348 ;; make-temp-file is called.
5350 fname))
5352 ;; make-temp-file creates the file,
5353 ;; but we don't want it to exist until we do an auto-save.
5357 file-name)))
5360 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5361 FILENAME should lack slashes. You can redefine this for customization."
5363 \f
5365 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5366 The generated regexp will match a filename only if the filename
5367 matches that wildcard according to shell rules. Only wildcards known
5368 by `sh' are supported."
5370 ;; Copy the initial run of non-special characters.
5373 ;; If no special characters, we're almost done.
5377 j)
5379 result
5400 ;; Found "[^". Insert a `\0' character
5401 ;; (which cannot happen in a filename)
5402 ;; into the character class, so that `^'
5403 ;; is not the first character after `[',
5404 ;; and thus non-special in a regexp.
5409 ;; I don't think `]' can appear in a
5410 ;; character class in a wildcard, but
5411 ;; let's be general here.
5418 i
5431 ;; Shell wildcards should match the entire filename,
5432 ;; not its part. Make the regexp say so.
5434 \f
5437 "Switches for `list-directory' to pass to `ls' for brief listing."
5443 "Switches for `list-directory' to pass to `ls' for verbose listing."
5448 "Expand wildcard pattern PATTERN.
5449 This returns a list of file names which match the pattern.
5451 If PATTERN is written as an absolute file name,
5452 the values are absolute also.
5454 If PATTERN is written as a relative file name, it is interpreted
5455 relative to the current default directory, `default-directory'.
5456 The file names returned are normally also relative to the current
5457 default directory. However, if FULL is non-nil, they are absolute."
5461 ;; A list of all dirs that DIRPART specifies.
5462 ;; This can be more than one dir
5463 ;; if DIRPART contains wildcards.
5467 dirpart)))
5471 contents)
5476 ;; Filter out "." and ".."
5481 name))
5488 this-dir-contents)
5489 this-dir-contents)
5490 contents))))
5492 contents)))
5494 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5498 "Display a list of files in or matching DIRNAME, a la `ls'.
5499 DIRNAME is globbed by the shell if necessary.
5500 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5501 Actions controlled by variables `list-directory-brief-switches'
5502 and `list-directory-verbose-switches'."
5506 nil default-directory nil)
5507 pfx)))
5509 list-directory-brief-switches))
5510 buffer)
5522 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5530 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5532 PATTERN is assumed to represent a file-name wildcard suitable for the
5533 underlying filesystem. For Unix and GNU/Linux, each character from the
5535 the parts of the pattern which don't include wildcard characters are
5536 quoted with double quotes.
5539 on Windows), so PATTERN can use them to quote wildcard characters that
5540 need to be passed verbatim to shell commands."
5544 ;; DOS/Windows don't allow `"' in file names. So if the
5545 ;; argument has quotes, we can safely assume it is already
5546 ;; quoted by the caller.
5548 ;; We quote [&()#$'] in case their shell is a port of a
5549 ;; Unixy shell. We quote [,=+] because stock DOS and
5550 ;; Windows shells require that in some cases, such as
5551 ;; passing arguments to batch files that use positional
5552 ;; arguments like %1.
5554 pattern
5557 end)
5574 pattern))))
5581 "Program to get the amount of free space on a file system.
5582 We assume the output has the format of `df'.
5583 The value of this variable must be just a command name or file name;
5584 if you want to specify options, use `directory-free-space-args'.
5586 A value of nil disables this feature.
5588 If the function `file-system-info' is defined, it is always used in
5589 preference to the program given by this variable."
5595 "Options to use when running `directory-free-space-program'."
5600 "Return the amount of free space on directory DIR's file system.
5601 The return value is a string describing the amount of free
5602 space (normally, the number of free 1KB blocks).
5604 This function calls `file-system-info' if it is available, or
5605 invokes the program specified by `directory-free-space-program'
5606 and `directory-free-space-args'. If the system call or program
5607 is unsuccessful, or if DIR is a remote directory, this function
5608 returns nil."
5610 ;; Try to find the number of free blocks. Non-Posix systems don't
5611 ;; always have df, but might have an equivalent system call.
5620 ;; Avoid failure if the default directory does
5621 ;; not exist (Bug#2631, Bug#3911).
5624 nil t nil
5625 directory-free-space-args
5626 dir)
5628 ;; Assume that the "available" column is before the
5629 ;; "capacity" column. Find the "%" and scan backward.
5633 "[[:space:]]+[^[:space:]]+%[^%]*$"
5640 ;; The following expression replaces `dired-move-to-filename-regexp'.
5644 ;; In some locales, month abbreviations are as short as 2 letters,
5645 ;; and they can be followed by ".".
5646 ;; In Breton, a month name can include a quote character.
5659 s "+"
5662 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5663 ;; omits the Kanji characters after month and day-of-month.
5664 ;; On Mac OS X 10.3, the date format in East Asian locales is
5665 ;; day-of-month digits followed by month digits.
5671 ;; The "[0-9]" below requires the previous column to end in a digit.
5672 ;; This avoids recognizing `1 may 1997' as a date in the line:
5673 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5675 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5677 ;; For non-iso date formats, we add the ".*" in order to find
5678 ;; the last possible match. This avoids recognizing
5679 ;; `jservice 10 1024' as a date in the line:
5680 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5682 ;; vc dired listings provide the state or blanks between file
5683 ;; permissions and date. The state is always surrounded by
5684 ;; parantheses:
5685 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5686 ;; This is not supported yet.
5691 "Regular expression to match up to the file name in a directory listing.
5692 The default value is designed to recognize dates and times
5697 ;; insert-directory
5698 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5699 ;; FULL-DIRECTORY-P is nil.
5700 ;; The single line of output must display FILE's name as it was
5701 ;; given, namely, an absolute path name.
5702 ;; - must insert exactly one line for each file if WILDCARD or
5703 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5704 ;; before the file lines, plus optional text after the file lines.
5705 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5706 ;; allowed.
5707 ;; File lines should display the basename.
5708 ;; - must be consistent with
5709 ;; - functions dired-move-to-filename, (these two define what a file line is)
5710 ;; dired-move-to-end-of-filename,
5711 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5712 ;; dired-insert-headerline
5713 ;; dired-after-subdir-garbage (defines what a "total" line is)
5714 ;; - variable dired-subdir-regexp
5715 ;; - may be passed "--dired" as the first argument in SWITCHES.
5716 ;; Filename handlers might have to remove this switch if their
5717 ;; "ls" command does not support it.
5719 "Insert directory listing for FILE, formatted according to SWITCHES.
5720 Leaves point after the inserted text.
5721 SWITCHES may be a string of options, or a list of strings
5722 representing individual options.
5723 Optional third arg WILDCARD means treat FILE as shell wildcard.
5724 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5725 switches do not contain `d', so that a full listing is expected.
5727 This works by running a directory listing program
5728 whose name is in the variable `insert-directory-program'.
5729 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5731 When SWITCHES contains the long `--dired' option, this function
5732 treats it specially, for the sake of dired. However, the
5733 normally equivalent short `-D' option is just passed on to
5734 `insert-directory-program', as any other option."
5735 ;; We need the directory in order to find the right handler.
5740 wildcard full-directory-p)
5743 ;; Read the actual directory using `insert-directory-program'.
5744 ;; RESULT gets the status code.
5746 ;; putting text property `dired-filename, decode one
5747 ;; bunch by one to preserve that property.
5749 ;; This is to control encoding the arguments in call-process.
5753 default-file-name-coding-system))))
5756 ;; Run ls in the directory part of the file pattern
5757 ;; using the last component as argument.
5764 shell-file-name nil t nil
5765 "-c"
5767 ""
5769 insert-directory-program
5770 " -d "
5772 switches
5774 " -- "
5775 ;; Quote some characters that have
5776 ;; special meanings in shells; but
5777 ;; don't quote the wildcards--we want
5778 ;; them to be special. We also
5779 ;; currently don't quote the quoting
5780 ;; characters in case people want to
5781 ;; use them explicitly to quote
5782 ;; wildcard characters.
5784 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5785 ;; directory if FILE is a symbolic link.
5792 insert-directory-program nil t nil
5796 ;; Split the switches at any spaces so we can
5797 ;; pass separate options as separate args.
5799 ;; Avoid lossage if FILE starts with `-'.
5807 file))))))))
5809 ;; If we got "//DIRED//" in the output, it means we got a real
5810 ;; directory listing, even if `ls' returned nonzero.
5811 ;; So ignore any errors.
5824 ;; The first time ls returns an error,
5825 ;; find the version numbers of ls,
5826 ;; and set insert-directory-ls-version
5827 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5828 ;; is equal or if the info cannot be obtained.
5829 ;; (That can mean it isn't GNU ls.)
5839 comparison)
5855 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5859 ;; If `insert-directory-program' failed, signal an error.
5861 ;; Delete the error message it may have output.
5863 ;; On non-Posix systems, we cannot open a directory, so
5864 ;; don't even try, because that will always result in
5865 ;; the ubiquitous "Access denied". Instead, show the
5866 ;; command line so the user can try to guess what went wrong.
5871 insert-directory-program
5873 file result)
5874 ;; Unix. Access the file to get a suitable error.
5881 ;; The following overshoots by one line for an empty
5882 ;; directory listed with "--dired", but without "-a"
5883 ;; switch, where the ls output contains a
5884 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5885 ;; We take care of that case later.
5893 error-lines)
5894 ;; Find all the lines that are error messages,
5895 ;; and record the bounds of each one.
5902 ;; Now read the numeric positions of file names.
5909 error-lines))
5912 error-lines)))
5914 ;; End is followed by \n or by " -> ".
5916 ;; It seems that we can't trust ls's output as to
5917 ;; byte positions of filenames.
5923 ;; Take care of the case where the ls output contains a
5924 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5925 ;; and we went one line too far back (see above).
5930 ;; Now decode what read if necessary.
5932 file-name-coding-system
5933 default-file-name-coding-system
5935 coding-no-eol
5936 val pos)
5940 ;; If no coding system is specified or detection is
5941 ;; requested, detect the coding.
5955 ;; Force no eol conversion on a file name, so
5956 ;; that CR is preserved.
5964 ;; Try to insert the amount of free space.
5967 ;; First find the line to put it on.
5971 ;; Replace "total" with "used", to avoid confusion.
5977 "Convert `ls --dired' file name position value POS to a buffer position.
5978 File name position values returned in ls --dired output
5979 count only stdout; they don't count the error messages sent to stderr.
5980 So this function converts to them to real buffer positions.
5981 ERROR-LINES is a list of buffer positions of error message lines,
5982 of the form (START END)."
5986 pos)
5990 "Insert directory listing for FILE, formatted according to SWITCHES.
5992 Like `insert-directory', but if FILE does not exist, it inserts a
5993 message to that effect instead of signaling an error."
5996 ;; Simulate the message printed by `ls'.
6000 "Functions to call with no arguments to query about killing Emacs.
6001 If any of these functions returns nil, killing Emacs is cancelled.
6002 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6006 "How to ask for confirmation when leaving Emacs.
6007 If nil, the default, don't ask at all. If the value is non-nil, it should
6008 be a predicate function such as `yes-or-no-p'."
6016 "Offer to save each buffer, then kill this Emacs process.
6017 With prefix ARG, silently save all file-visiting buffers, then kill."
6026 ;; process-list is not defined on MSDOS.
6028 active)
6037 ;; Query the user for other things, perhaps.
6044 "Offer to save each buffer, then kill the current connection.
6045 If the current frame has no client, kill Emacs itself.
6047 With prefix ARG, silently save all file-visiting buffers, then kill.
6049 If emacsclient was started with a list of filenames to edit, then
6050 only these files will be asked to be saved."
6055 \f
6056 ;; We use /: as a prefix to "quote" a file name
6057 ;; so that magic file name handlers will not apply to it.
6061 file-name-handler-alist))
6063 ;; We depend on being the last handler on the list,
6064 ;; so that anything else which does need handling
6065 ;; has been handled already.
6066 ;; So it is safe for us to inhibit *all* magic file name handlers.
6075 default-directory))
6076 ;; Get a list of the indices of the args which are file names.
6079 ;; The first six are special because they
6080 ;; return a file name. We want to include the /:
6081 ;; in the return value.
6082 ;; So just avoid stripping it in the first place.
6089 ;; `identity' means just return the first arg
6090 ;; not stripped of its quoting.
6092 ;; `add' means add "/:" to the result.
6094 ;; `quote' means add "/:" to buffer-file-name.
6096 ;; `unquote-then-quote' means set buffer-file-name
6097 ;; temporarily to unquoted filename.
6099 ;; List the arguments which are filenames.
6107 ;; For all other operations, treat the first argument only
6108 ;; as the file name.
6110 method
6111 ;; Copy ARGUMENTS so we can replace elements in it.
6115 ;; Strip off the /: from the file names that have it.
6123 "/"
6139 res))
6142 \f
6143 ;; Symbolic modes and read-file-modes.
6146 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6147 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6148 Others, or All) for whom to produce the mask.
6149 The bit-mask that is returned extracts from mode bits the access rights
6150 for the specified category of users."
6158 "Convert CHAR to a numeric value of mode bits.
6159 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6160 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6167 ;; Rights relative to the previous file modes.
6178 "Convert a symbolic mode string specification to an equivalent number.
6180 WHO-MASK is the bit-mask specifying the category of users to which to
6181 apply the access permissions. See `file-modes-char-to-who'.
6182 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6183 RIGHTS request to add, remove, or set permissions based on existing ones,
6190 char-right)
6197 num-rights
6201 op char-right)))
6202 num-rights))
6205 "Convert symbolic file modes to numeric file modes.
6206 MODES is the string to convert, it should match
6209 notation.
6210 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6211 MODES request to add, remove, or set permissions based on existing ones,
6225 num-who num-modes)
6228 num-modes)))
6231 "Read file modes in octal or symbolic notation and return its numeric value.
6232 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6233 ORIG-FILE is the name of a file on whose mode bits to base returned
6234 permissions if what user types requests to add, remove, or set permissions
6250 nil nil default)))
6256 \f
6257 ;; Trashcan handling.
6259 "Directory for `move-file-to-trash' to move files and directories to.
6260 This directory is only used when the function `system-move-file-to-trash'
6261 is not defined.
6262 Relative paths are interpreted relative to `default-directory'.
6263 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6273 "Move the file (or directory) named FILENAME to the trash.
6274 When `delete-by-moving-to-trash' is non-nil, this function is
6275 called by `delete-file' and `delete-directory' instead of
6276 deleting files outright.
6278 If the function `system-move-file-to-trash' is defined, call it
6279 with FILENAME as an argument.
6280 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6281 directory.
6282 Otherwise, trash FILENAME using the freedesktop.org conventions,
6283 like the GNOME, KDE and XFCE desktop environments. Emacs only
6287 ;; If `trash-directory' is non-nil, move the file there.
6291 trash-dir)))
6292 ;; We can't trash a parent directory of trash-directory.
6295 trash-dir filename))
6298 ;; Ensure that the trashed file-name is unique.
6305 ;; If `system-move-file-to-trash' is defined, use it.
6308 ;; Otherwise, use the freedesktop.org method, as specified at
6309 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6320 ;; Check if we have permissions to delete.
6324 ;; The trashed file cannot be the trash dir or its parent.
6327 trash-files-dir filename))
6330 trash-info-dir filename))
6332 ;; Ensure that the trash directory exists; otherwise, create it.
6341 ;; Try to move to trash with .trashinfo undo information
6346 ;; Perform url-encoding on FN. For compatibility with
6347 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6348 ;; for path separators.
6353 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6354 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6367 fn))
6372 ;; Attempt to make .trashinfo file, trying up to 5
6373 ;; times. The .trashinfo file is opened with O_EXCL,
6374 ;; as per trash-spec 0.7, even if that can be a problem
6375 ;; on old NFS versions...
6379 trash-files-dir))
6381 success info-fn)
6386 trash-info-dir))
6394 ;; Uniqify new-fn. (Some file managers do not
6395 ;; like Emacs-style backup file names---e.g. bug
6396 ;; 170956 in Konqueror bug tracker.)
6401 ;; Finally, try to move the file to the trashcan.
6405 \f
6430 ;;; files.el ends here