| blob | 2223c1ae6b8278a9080ecc650395f1a8469371e0 |
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,
5 ;; 2006, 2007, 2008, 2009, 2010, 2011 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.
61 FROM is matched against directory names anchored at the first
65 FROM and TO should be equivalent names, which refer to the
66 same directory. Do not use `~' in the TO strings;
67 they should be ordinary absolute directory names.
69 Use this feature when you have directories which you normally refer to
70 via absolute symbolic links. Make TO the name of the link, and FROM
71 the name it is linked to."
80 "Non-nil means make a backup of a file the first time it is saved.
81 This can be done by renaming the file or by copying.
83 Renaming means that Emacs renames the existing file so that it is a
84 backup file, then writes the buffer into a new file. Any other names
85 that the old file had will now refer to the backup file. The new file
86 is owned by you and its group is defaulted.
88 Copying means that Emacs copies the existing file into the backup
89 file, then writes the buffer on top of the existing file. Any other
90 names that the old file had will now refer to the new (edited) file.
91 The file's owner and group are unchanged.
93 The choice of renaming or copying is controlled by the variables
94 `backup-by-copying', `backup-by-copying-when-linked',
95 `backup-by-copying-when-mismatch' and
96 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
100 ;; Do this so that local variables based on the file name
101 ;; are not overridden by the major mode.
103 "Non-nil means don't make a backup, regardless of the other parameters.
104 This variable is intended for use by making it local to a buffer.
109 "Non-nil means always use copying to create backup files.
110 See documentation of variable `make-backup-files'."
115 "Non-nil means use copying to create backups for files with multiple names.
116 This causes the alternate names to refer to the latest version as edited.
117 This variable is relevant only if `backup-by-copying' is nil."
122 "Non-nil means create backups by copying if this preserves owner or group.
123 Renaming may still be used (subject to control of other variables)
124 when it would not result in changing the owner or group of the file;
125 that is, for files which are owned by you and whose group matches
126 the default for a new file created there by you.
127 This variable is relevant only if `backup-by-copying' is nil."
134 "Non-nil means create backups by copying to preserve a privileged owner.
135 Renaming may still be used (subject to control of other variables)
136 when it would not result in changing the owner of the file or if the owner
137 has a user id greater than the value of this variable. This is useful
138 when low-numbered uid's are used for special system users (such as root)
139 that must maintain ownership of certain files.
140 This variable is relevant only if `backup-by-copying' and
141 `backup-by-copying-when-mismatch' are nil."
146 "Predicate that looks at a file name and decides whether to make backups.
150 "Non-nil in a buffer means always offer to save buffer on exit.
151 Do so even if the buffer is not visiting a file.
152 Automatically local in all buffers."
158 "Non-nil means find a file under alternative names, in existing buffers.
159 This means if any existing buffer is visiting the file you want
160 under another name, you get the existing buffer instead of a new buffer."
165 "Non-nil means visit a file under its truename.
166 The truename of a file is found by chasing all links
167 both at the file level and at the levels of the containing directories."
173 "Specify which files should be reverted without query.
174 The value is a list of regular expressions.
175 If the file name matches one of these regular expressions,
176 then `revert-buffer' reverts the file without querying
177 if the file has changed on disk and you have not edited the buffer."
182 "The device number and file number of the file visited in the current buffer.
183 The value is a list of the form (FILENUM DEVNUM).
184 This pair of numbers uniquely identifies the file.
198 "The directory for writing small temporary files.
199 If non-nil, this directory is used instead of `temporary-file-directory'
200 by programs that create small temporary files. This is for systems that
201 have fast storage with limited space, such as a RAM disk."
206 ;; The system null device. (Should reference NULL_DEVICE from C.)
234 "Non-nil means protect against I/O errors while saving files.
235 Some modes set this non-nil in particular buffers.
237 This feature works by writing the new contents into a temporary file
238 and then renaming the temporary file to replace the original.
239 In this way, any I/O error in writing leaves the original untouched,
240 and there is never any instant where the file is nonexistent.
242 Note that this feature forces backups to be made by copying.
243 Yet, at the same time, saving a precious file
244 breaks any hard links between it and other files.
246 This feature is advisory: for example, if the directory in which the
247 file is being saved is not writable, Emacs may ignore a non-nil value
248 of `file-precious-flag' and write directly into the file.
250 See also: `break-hardlink-on-save'."
255 "Non-nil means when saving a file that exists under several names
256 \(i.e., has multiple hardlinks), break the hardlink associated with
257 `buffer-file-name' and write to a new file, so that the other
258 instances of the file are not affected by the save.
260 If `buffer-file-name' refers to a symlink, do not break the symlink.
262 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
263 For example, if the directory in which a file is being saved is not
264 itself writable, then error instead of saving in some
265 hardlink-nonbreaking way.
267 See also `backup-by-copying' and `backup-by-copying-when-linked'."
273 "Control use of version numbers for backup files.
274 When t, make numeric backup versions unconditionally.
275 When nil, make them for files that have some already.
276 The value `never' means do not make them."
286 "When cleaning directory, number of versions to keep."
292 "If t, delete excess backup versions silently.
293 If nil, ask confirmation. Any other value prevents any trimming."
300 "Number of oldest versions to keep when a new numbered backup is made."
306 "Number of newest versions to keep when a new numbered backup is made.
307 Includes the new backup. Must be > 0"
313 "Whether to add a newline automatically at the end of the file.
315 A value of t means do this only when the file is about to be saved.
316 A value of `visit' means do this right after the file is visited.
317 A value of `visit-save' means do it at both of those times.
318 Any other non-nil value means ask user whether to add a newline, when saving.
319 A value of nil means don't add newlines.
321 Certain major modes set this locally to the value obtained
322 from `mode-require-final-newline'."
331 "Whether to add a newline at end of file, in certain major modes.
332 Those modes set `require-final-newline' to this value when you enable them.
333 They do so because they are often used for files that are supposed
334 to end in newlines, and the question is how to arrange that.
336 A value of t means do this only when the file is about to be saved.
337 A value of `visit' means do this right after the file is visited.
338 A value of `visit-save' means do it at both of those times.
339 Any other non-nil value means ask user whether to add a newline, when saving.
341 A value of nil means do not add newlines. That is a risky choice in this
342 variable since this value is used for modes for files that ought to have
343 final newlines. So if you set this to nil, you must explicitly check and
344 add a final newline, whenever you save a file that really needs one."
354 "Non-nil says by default do auto-saving of every file-visiting buffer."
360 ;; Don't put "\\2" inside expand-file-name, since it will be
361 ;; transformed to "/2" on DOS/Windows.
363 "Transforms to apply to buffer file name before making auto-save file name.
364 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
365 REGEXP is a regular expression to match against the file name.
366 If it matches, `replace-match' is used to replace the
367 matching part with REPLACEMENT.
368 If the optional element UNIQUIFY is non-nil, the auto-save file name is
369 constructed by taking the directory part of the replaced file-name,
370 concatenated with the buffer file name with all directory separators
371 changed to `!' to prevent clashes. This will not work
372 correctly if your filesystem truncates the resulting name.
374 All the transforms in the list are tried, in the order they are listed.
375 When one transform applies, its result is final;
376 no further transforms are tried.
378 The default value is set up to put the auto-save file into the
379 temporary directory (see the variable `temporary-file-directory') for
380 editing a remote file.
382 On MS-DOS filesystems without long names this variable is always
383 ignored."
391 "Non-nil means save word abbrevs too when files are saved.
392 If `silently', don't ask the user before saving."
397 "Non-nil means allow `find-file' to visit directories.
398 To visit the directory, `find-file' runs `find-directory-functions'."
403 "List of functions to try in sequence to visit a directory.
404 Each function is called with the directory name as the sole argument
405 and should return either a buffer or nil."
409 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
411 "List of functions to try in sequence to get a file name at point.
412 Each function should return either nil or a file name found at the
413 location of point in the current buffer."
417 ;;;It is not useful to make this a local variable.
418 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
420 "List of functions to be called for `find-file' on nonexistent file.
421 These functions are called as soon as the error is detected.
422 Variable `buffer-file-name' is already set up.
427 ;;;It is not useful to make this a local variable.
428 ;;;(put 'find-file-hooks 'permanent-local t)
431 "List of functions to be called after a buffer is loaded from a file.
432 The buffer's local variables (if any) will have been processed before the
433 functions are called."
440 "List of functions to be called before writing out a buffer to a file.
441 If one of them returns non-nil, the file is considered already written
442 and the rest are not called.
443 These hooks are considered to pertain to the visited file.
444 So any buffer-local binding of this variable is discarded if you change
446 change the major mode.
448 This hook is not run if any of the functions in
449 `write-contents-functions' returns non-nil. Both hooks pertain
450 to how to save a buffer to file, for instance, choosing a suitable
451 coding system and setting mode bits. (See Info
452 node `(elisp)Saving Buffers'.) To perform various checks or
463 "List of functions to be called before writing out a buffer to a file.
464 If one of them returns non-nil, the file is considered already written
465 and the rest are not called and neither are the functions in
466 `write-file-functions'.
468 This variable is meant to be used for hooks that pertain to the
469 buffer's contents, not to the particular visited file; thus,
470 `set-visited-file-name' does not clear this variable; but changing the
471 major mode does clear it.
473 For hooks that _do_ pertain to the particular visited file, use
474 `write-file-functions'. Both this variable and
475 `write-file-functions' relate to how a buffer is saved to file.
476 To perform various checks or updates before the buffer is saved,
483 "Control use of local variables in files you visit.
484 The value can be t, nil, :safe, :all, or something else.
486 A value of t means file local variables specifications are obeyed
487 if all the specified variable values are safe; if any values are
488 not safe, Emacs queries you, once, whether to set them all.
489 \(When you say yes to certain values, they are remembered as safe.)
491 :safe means set the safe variables, and ignore the rest.
492 :all means set all variables, whether safe or not.
493 (Don't set it permanently to :all.)
494 A value of nil means always ignore the file local variables.
496 Any other value means always query you once whether to set them all.
497 \(When you say yes to certain values, they are remembered as safe, but
500 This variable also controls use of major modes specified in
501 a -*- line.
504 always obeys file local variable specifications and the -*- line,
505 and ignores this variable."
506 :risky t
515 "Like `enable-local-variables' but meant for buffer-local bindings.
516 The meaningful values are nil and non-nil. The default is non-nil.
517 If a major mode sets this to nil, buffer-locally, then any local
518 variables list in the file will be ignored.
520 This variable does not affect the use of major modes
525 The value can be t, nil or something else.
526 A value of t means obey `eval' variables.
527 A value of nil means ignore them; anything else means query."
528 :risky t
534 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
543 "Non-nil means buffers visiting files read-only do so in view mode.
544 In fact, this means that all read-only buffers normally have
545 View mode enabled, including buffers that are read-only because
546 you visit a file you cannot alter, and buffers you make read-only
552 "History list of file names entered in the minibuffer.
554 Maximum length of the history list is determined by the value
556 \f
559 "Provides support for ange-ftp host name completion.
560 Runs the usual ange-ftp hook, but only for completion operations."
561 ;; Having this here avoids the need to load ange-ftp when it's not
562 ;; really in use.
568 inhibit-file-name-handlers)))
576 "Convert a standard file's name to something suitable for the OS.
577 This means to guarantee valid names and perhaps to canonicalize
578 certain patterns.
580 FILENAME should be an absolute file name since the conversion rules
581 sometimes vary depending on the position in the file name. E.g. c:/foo
582 is a valid DOS file name, but c:/bar/c:/foo is not.
584 This function's standard definition is trivial; it just returns
585 the argument. However, on Windows and DOS, replace invalid
586 characters. On DOS, make sure to obey the 8.3 limitations.
587 In the native Windows build, turn Cygwin names into native names,
588 and also turn slashes into backslashes if the shell requires it (see
589 `w32-shell-dos-semantics').
591 See Info node `(elisp)Standard File Names' for more details."
596 ;; Replace invalid filename characters with !
600 name))
608 "Read directory name, prompting with PROMPT and completing in directory DIR.
609 Value is not expanded---you must call `expand-file-name' yourself.
610 Default name to DEFAULT-DIRNAME if user exits with the same
611 non-empty string that was inserted by this function.
612 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
613 or just DIR if INITIAL is nil.)
614 If the user exits with an empty minibuffer, this function returns
615 an empty string. (This can only happen if the user erased the
616 pre-inserted contents or if `insert-default-directory' is nil.)
617 Fourth arg MUSTMATCH non-nil means require existing directory's name.
618 Non-nil and non-t means also require confirmation after completion.
619 Fifth arg INITIAL specifies text to start with.
620 DIR should be an absolute directory name. It defaults to
621 the value of `default-directory'."
626 dir))
627 mustmatch initial
630 \f
632 "Show the current default directory."
637 "Value of the CDPATH environment variable, as a list.
641 "Explode a search path into a list of directory names.
642 Directories are separated by occurrences of `path-separator'
643 \(which is colon in GNU and GNU-like systems)."
644 ;; We could use split-string here.
652 nil
657 cd-list)))
660 "Change current directory to given absolute file name DIR."
661 ;; Put the name into directory syntax now,
662 ;; because otherwise expand-file-name may give some bad results.
664 ;; We used to additionally call abbreviate-file-name here, for an
665 ;; unknown reason. Problem is that most buffers are setup
666 ;; without going through cd-absolute and don't call
667 ;; abbreviate-file-name on their default-directory, so the few that
668 ;; do end up using a superficially different directory.
680 "Make DIR become the current buffer's default directory.
681 If your environment includes a `CDPATH' variable, try each one of
682 that list of directories (separated by occurrences of
683 `path-separator') when resolving a relative directory name.
684 The path separator is colon in GNU and GNU-like systems."
687 default-directory default-directory
703 cd-path)
704 nil))
708 "Load the Lisp file named FILE."
709 ;; This is a case where .elc makes a lot of sense.
716 "Search for FILENAME through PATH.
717 If found, return the absolute file name of FILENAME, with its suffixes;
718 otherwise return nil.
719 PATH should be a list of directories to look in, like the lists in
720 `exec-path' or `load-path'.
721 If SUFFIXES is non-nil, it should be a list of suffixes to append to
724 If non-nil, PREDICATE is used instead of `file-readable-p'.
725 PREDICATE can also be an integer to pass to the `access' system call,
726 in which case file-name handlers are ignored. This usage is deprecated.
728 For compatibility, PREDICATE can also be one of the symbols
729 `executable', `readable', `writable', or `exists', or a list of
730 one or more of those symbols."
741 "Do completion for file names passed to `locate-file'."
744 ;; FIXME: maybe we should use completion-file-name-table instead,
745 ;; tho at least for `load', the arg is passed through
746 ;; substitute-in-file-name for historical reasons.
756 ;; If we have files like "foo.el" and "foo.elc", we could load one of
757 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
758 ;; preferred way. So if we list all 3, that gives a lot of redundant
759 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
760 ;; the user does want to pay attention to the extension. We try to
761 ;; diffuse this tension by stripping the suffix, except when the
762 ;; result is a single element (i.e. usually we only list "foo" unless
763 ;; it's the only remaining element in the list, in which case we do
764 ;; list "foo", "foo.elc" and "foo.el").
775 string-file dir))
780 ;; Switching from names to names+fullnames creates a non-monotonicity
781 ;; which can cause problems with things like partial-completion.
782 ;; To minimize the problem, filter out completion-regexp-list, so that
783 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
784 ;; from `names' which only matched `string' when they still had
785 ;; their suffix.
787 ;; Remove duplicates of the first element, so that we can easily check
788 ;; if `names' really only contains a single element.
791 ;; There's no more than one matching non-suffixed element, so expand
792 ;; the list by adding the suffixed elements as well.
795 string-dir names string-file pred action)))))
798 "Do completion for file names passed to `locate-file'.
799 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
802 string nil action))
807 "Regexp of directory names which stop the search in `locate-dominating-file'.
808 Any directory whose name matches this regexp will be treated like
809 a kind of root directory by `locate-dominating-file' which will stop its search
810 when it bumps into it.
811 The default regexp prevents fruitless and time-consuming attempts to find
812 special files in directories in which filenames are interpreted as hostnames,
815 ;; (defun locate-dominating-files (file regexp)
816 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
817 ;; Stop at the first parent where a matching file is found and return the list
818 ;; of files that that match in this directory."
819 ;; (catch 'found
820 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
821 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
822 ;; (let ((user nil)
823 ;; ;; Abbreviate, so as to stop when we cross ~/.
824 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
825 ;; files)
826 ;; (while (and dir
827 ;; ;; As a heuristic, we stop looking up the hierarchy of
828 ;; ;; directories as soon as we find a directory belonging to
829 ;; ;; another user. This should save us from looking in
830 ;; ;; things like /net and /afs. This assumes that all the
831 ;; ;; files inside a project belong to the same user.
832 ;; (let ((prev-user user))
833 ;; (setq user (nth 2 (file-attributes dir)))
834 ;; (or (null prev-user) (equal user prev-user))))
835 ;; (if (setq files (condition-case nil
836 ;; (directory-files dir 'full regexp 'nosort)
837 ;; (error nil)))
838 ;; (throw 'found files)
839 ;; (if (equal dir
840 ;; (setq dir (file-name-directory
841 ;; (directory-file-name dir))))
842 ;; (setq dir nil))))
843 ;; nil)))
846 "Look up the directory hierarchy from FILE for a file named NAME.
847 Stop at the first parent directory containing a file NAME,
848 and return the directory. Return nil if not found."
849 ;; We used to use the above locate-dominating-files code, but the
850 ;; directory-files call is very costly, so we're much better off doing
851 ;; multiple calls using the code in here.
852 ;;
853 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
854 ;; `name' in /home or in /.
858 ;; `user' is not initialized outside the loop because
859 ;; `file' may not exist, so we may have to walk up part of the
860 ;; hierarchy before we find the "initial UID".
862 try)
865 ;; FIXME: Disabled this heuristic because it is sometimes
866 ;; inappropriate.
867 ;; As a heuristic, we stop looking up the hierarchy of
868 ;; directories as soon as we find a directory belonging
869 ;; to another user. This should save us from looking in
870 ;; things like /net and /afs. This assumes that all the
871 ;; files inside a project belong to the same user.
872 ;; (let ((prev-user user))
873 ;; (setq user (nth 2 (file-attributes file)))
874 ;; (and prev-user (not (equal user prev-user))))
882 root))
886 "Search for COMMAND in `exec-path' and return the absolute file name.
887 Return nil if COMMAND is not found anywhere in `exec-path'."
888 ;; Use 1 rather than file-executable-p to better match the behavior of
889 ;; call-process.
893 "Load the Emacs Lisp library named LIBRARY.
894 This is an interface to the function `load'. LIBRARY is searched
895 for in `load-path', both with and without `load-suffixes' (as
896 well as `load-file-rep-suffixes').
898 See Info node `(emacs)Lisp Libraries' for more details.
899 See `load-file' for a different interface to `load'."
903 load-path
908 "Test whether FILE specifies a location on a remote system.
909 Returns nil or a string identifying the remote connection (ideally
910 a prefix of FILE). For example, the remote identification for filename
913 less reliable than accessing local files.
914 Furthermore, relative file names do not work across remote connections.
916 IDENTIFICATION specifies which part of the identification shall
917 be returned as string. IDENTIFICATION can be the symbol
918 `method', `user', `host' or `localname'; any other value is
919 handled like nil and means to return the complete identification
920 string.
922 If CONNECTED is non-nil, the function returns an identification only
923 if FILE is located on a remote system, and a connection is established
924 to that remote system.
926 `file-remote-p' will never open a connection on its own."
930 nil)))
933 "Whether to use the remote file-name cache for read access.
935 When `nil', always use the cached values.
936 When `t', never use them.
937 A number means use them for that amount of seconds since they were
938 cached.
940 File attributes of remote files are cached for better performance.
941 If they are changed out of Emacs' control, the cached values
942 become invalid, and must be invalidated.
944 In case a remote file is checked regularly, it might be
945 reasonable to let-bind this variable to a value less then the
946 time period between two checks.
947 Example:
949 \(defun display-time-file-nonempty-p \(file)
950 \(let \(\(remote-file-name-inhibit-cache \(- display-time-interval 5)))
951 \(and \(file-exists-p file)
952 \(< 0 \(nth 7 \(file-attributes \(file-chase-links file)))))))"
963 "Copy the file FILE into a temporary file on this machine.
964 Returns the name of the local copy, or nil, if FILE is directly
965 accessible."
966 ;; This formerly had an optional BUFFER argument that wasn't used by
967 ;; anything.
971 nil)))
974 "Return the truename of FILENAME, which should be absolute.
975 The truename of a file name is found by chasing symbolic links
976 both at the level of the file and at the level of the directories
977 containing it, until no links are left at any level.
980 ;; COUNTER and PREV-DIRS are only used in recursive calls.
981 ;; COUNTER can be a cons cell whose car is the count of how many
982 ;; more links to chase before getting an error.
983 ;; PREV-DIRS can be a cons cell whose car is an alist
984 ;; of truenames we've just recently computed.
998 ;; For speed, remove the ange-ftp completion handler from the list.
999 ;; We know it's not needed here.
1000 ;; For even more speed, do this only on the outermost call.
1007 ;; andrewi@harlequin.co.uk - none of the following code (except for
1008 ;; invoking the file-name handler) currently applies on Windows
1009 ;; (ie. there are no native symlinks), but there is an issue with
1010 ;; case differences being ignored by the OS, and short "8.3 DOS"
1011 ;; name aliases existing for all files. (The short names are not
1012 ;; reported by directory-files, but can be used to refer to files.)
1013 ;; It seems appropriate for file-truename to resolve these issues in
1014 ;; the most natural way, which on Windows is to call the function
1015 ;; `w32-long-file-name' - this returns the exact name of a file as
1016 ;; it is stored on disk (expanding short name aliases with the full
1017 ;; name in the process).
1020 ;; For file name that has a special handler, call handler.
1021 ;; This is so that ange-ftp can save time by doing a no-op.
1024 ;; If filename contains a wildcard, newname will be the old name.
1026 ;; If filename exists, use the long name. If it doesn't exist,
1027 ;; drill down until we find a directory that exists, and use
1028 ;; the long name of that, with the extra non-existent path
1029 ;; components concatenated.
1031 missing rest)
1034 ;; Include the preceding directory separator in the missing
1035 ;; part so subsequent recursion on the rest works.
1040 ""
1045 ;; If this file directly leads to a link, process that iteratively
1046 ;; so that we don't use lots of stack.
1052 ;; For file name that has a special handler, call handler.
1053 ;; This is so that ange-ftp can save time by doing a no-op.
1056 done t)
1058 target dirfile)
1059 ;; Get the truename of the directory.
1061 ;; If these are equal, we have the (or a) root directory.
1063 ;; If this is the same dir we last got the truename for,
1064 ;; save time--don't recalculate.
1074 done t)
1077 done t)
1078 ;; Put it back on the file name.
1080 ;; Is the file name the name of a link?
1083 ;; Yes => chase that link, then start all over
1084 ;; since the link may point to a directory name that uses links.
1085 ;; We can't safely use expand-file-name here
1086 ;; since target might look like foo/../bar where foo
1087 ;; is itself a link. Instead, we handle . and .. above.
1090 target
1092 done nil)
1093 ;; No, we are done!
1095 filename))
1098 "Chase links in FILENAME until a name that is not a link.
1099 Unlike `file-truename', this does not check whether a parent
1100 directory name is a symbolic link.
1101 If the optional argument LIMIT is a number,
1102 it means chase no more than that many links and then stop."
1110 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1113 ;; Handle `..' by hand, since it needs to work in the
1114 ;; target of any directory symlink.
1115 ;; This code is not quite complete; it does not handle
1116 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1120 ;; Chase links in the default dir of the symlink.
1124 ;; Now find the parent of that dir.
1128 newname))
1131 "Create a temporary file.
1132 The returned file name (created by appending some random characters at the end
1133 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1134 is guaranteed to point to a newly created empty file.
1135 You can then use `write-region' to write new data into the file.
1137 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1139 If SUFFIX is non-nil, add that at the end of the file name."
1141 file)
1144 ;; Create temp files with strict access rights. It's easy to
1145 ;; loosen them later, whereas it's impossible to close the
1146 ;; time-window of loose permissions otherwise.
1154 temporary-file-directory)
1156 temporary-file-directory))))
1162 nil)
1164 ;; the file was somehow created by someone else between
1165 ;; `make-temp-name' and `write-region', let's try again.
1166 nil)
1167 file)
1168 ;; Reset the umask.
1172 "Change the encoding of FILE's name from CODING to NEW-CODING.
1173 The value is a new name of FILE.
1174 Signals a `file-already-exists' error if a file of the new name
1175 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1176 is non-nil. A number as fourth arg means request confirmation if
1177 the new name already exists. This is what happens in interactive
1178 use with M-x."
1181 default-file-name-coding-system))
1183 from-coding to-coding)
1185 ;; We provide the default coding only when it seems that
1186 ;; the filename is correctly decoded by the default
1187 ;; coding.
1193 filename default-coding)
1194 default-coding))
1198 ;; We provide the default coding only when a user is going to
1199 ;; change the encoding not from the default coding.
1203 filename from-coding)))
1206 filename from-coding default-coding)
1207 default-coding)))
1211 default-file-name-coding-system))
1212 ;; FILE should have been decoded by DEFAULT-CODING.
1216 ;; Suppress further encoding.
1221 newname))
1222 \f
1224 "Whether confirmation is requested before visiting a new file or buffer.
1225 If nil, confirmation is not requested.
1226 If the value is `after-completion', confirmation is only
1227 requested if the user called `minibuffer-complete' right before
1228 `minibuffer-complete-and-exit'.
1229 Any other non-nil value means to request confirmation.
1231 This affects commands like `switch-to-buffer' and `find-file'."
1239 "Whether to request confirmation before visiting a new file or buffer.
1240 The variable `confirm-nonexistent-file-or-buffer' determines the
1241 return value, which may be passed as the REQUIRE-MATCH arg to
1242 `read-buffer' or `find-file-read-args'."
1250 "Read the name of a buffer to switch to and return as a string.
1251 It is intended for `switch-to-buffer' family of commands since they
1252 need to omit the name of current buffer from the list of completions
1253 and default values."
1258 ;; Since rbts-completion-table is built dynamically, we
1259 ;; can't just add it to the default value of
1260 ;; icomplete-with-completion-tables, so we add it
1261 ;; here manually.
1266 icomplete-with-completion-tables))))
1271 "Select the buffer specified by BUFFER-OR-NAME in another window.
1272 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1273 nil. Return the buffer switched to.
1275 If called interactively, prompt for the buffer name using the
1276 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1277 determines whether to request confirmation before creating a new
1278 buffer.
1280 If BUFFER-OR-NAME is a string and does not identify an existing
1281 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1282 nil, switch to the buffer returned by `other-buffer'.
1284 Optional second argument NORECORD non-nil means do not put this
1285 buffer at the front of the list of recently selected ones.
1287 This uses the function `display-buffer' as a subroutine; see its
1288 documentation for additional customization information."
1292 same-window-buffer-names same-window-regexps)
1296 "Switch to buffer BUFFER-OR-NAME in another frame.
1297 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1298 nil. Return the buffer switched to.
1300 If called interactively, prompt for the buffer name using the
1301 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1302 determines whether to request confirmation before creating a new
1303 buffer.
1305 If BUFFER-OR-NAME is a string and does not identify an existing
1306 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1307 nil, switch to the buffer returned by `other-buffer'.
1309 Optional second arg NORECORD non-nil means do not put this
1310 buffer at the front of the list of recently selected ones.
1312 This uses the function `display-buffer' as a subroutine; see its
1313 documentation for additional customization information."
1317 same-window-buffer-names same-window-regexps)
1321 "Display buffer BUFFER in another frame.
1322 This uses the function `display-buffer' as a subroutine; see
1323 its documentation for additional customization information."
1326 same-window-buffer-names same-window-regexps
1328 new-window)
1330 ;; This may have been here in order to prevent the new frame from hiding
1331 ;; the old frame. But it does more harm than good.
1332 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1333 ;;(lower-frame (window-frame new-window))
1335 ;; This may have been here in order to make sure the old-frame gets the
1336 ;; focus. But not only can it cause an annoying flicker, with some
1337 ;; window-managers it just makes the window invisible, with no easy
1338 ;; way to recover it. --Stef
1339 ;;(make-frame-invisible (window-frame old-window))
1340 ;;(make-frame-visible (window-frame old-window))
1341 ))
1344 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1345 BODY should use the minibuffer at most once.
1346 Recursive uses of the minibuffer are unaffected (FUN is not
1347 called additional times).
1349 This macro actually adds an auxiliary function that calls FUN,
1350 rather than FUN itself, to `minibuffer-setup-hook'."
1356 ;; Clear out this hook so it does not interfere
1357 ;; with any recursive minibuffer usage.
1368 t))
1371 "Edit file FILENAME.
1372 Switch to a buffer visiting file FILENAME,
1373 creating one if none already exists.
1374 Interactively, the default if you just type RET is the current directory,
1375 but the visited file name is available through the minibuffer history:
1376 type M-n to pull it into the minibuffer.
1378 You can visit files on remote machines by specifying something
1379 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1380 also visit local files as a different user by specifying
1381 /sudo::FILE for the file name.
1382 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1383 manual, for more about this.
1385 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1386 expand wildcards (if any) and visit multiple files. You can
1387 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1389 To visit a file without any kind of conversion and without
1400 "Edit file FILENAME, in another window.
1403 an existing one. See the function `display-buffer'.
1405 Interactively, the default if you just type RET is the current directory,
1406 but the visited file name is available through the minibuffer history:
1407 type M-n to pull it into the minibuffer.
1409 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1410 expand wildcards (if any) and visit multiple files."
1423 "Edit file FILENAME, in another frame.
1426 an existing one. See the function `display-buffer'.
1428 Interactively, the default if you just type RET is the current directory,
1429 but the visited file name is available through the minibuffer history:
1430 type M-n to pull it into the minibuffer.
1432 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1433 expand wildcards (if any) and visit multiple files."
1446 "Edit the existing file FILENAME.
1448 file names with wildcards."
1457 "Edit file FILENAME but don't allow changes.
1471 value))
1474 "Edit file FILENAME in another window but don't allow changes.
1488 value))
1491 "Edit file FILENAME in another frame but don't allow changes.
1505 value))
1508 "Find file FILENAME as a replacement for the file in the next window.
1509 This command does not select that window.
1513 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1514 expand wildcards (if any) and replace the file with multiple files."
1525 "Find alternate file: " file-dir nil
1527 t))))
1535 "Find file FILENAME, select its buffer, kill previous buffer.
1536 If the current buffer now contains an empty file that you just visited
1537 \(presumably by mistake), use this command to visit the file you really want.
1541 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1542 expand wildcards (if any) and replace the file with multiple files.
1544 If the current buffer is an indirect buffer, or the base buffer
1545 for one or more indirect buffers, the other buffer(s) are not
1546 killed."
1555 "Find alternate file: " file-dir nil
1557 t)))
1572 ;; Run `kill-buffer-hook' here. It needs to happen before
1573 ;; variables like `buffer-file-name' etc are set to nil below,
1574 ;; because some of the hooks that could be invoked
1575 ;; (e.g., `save-place-to-alist') depend on those variables.
1576 ;;
1577 ;; Note that `kill-buffer-hook' is not what queries whether to
1578 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1579 ;; asks that itself. Thus, there's no need to temporarily do
1580 ;; `(set-buffer-modified-p nil)' before running this hook.
1582 ;; Okay, now we can end-of-life the old buffer.
1589 ;; This prevents us from finding the same buffer
1590 ;; if we specified the same file again.
1594 ;; Likewise for dired buffers.
1598 ;; This executes if find-file gets an error
1599 ;; and does not really find anything.
1600 ;; We put things back as they were.
1601 ;; If find-file actually finds something, we kill obuf below.
1610 ;; We already ran these; don't run them again.
1613 \f
1615 "Create a suitably named buffer for visiting FILENAME, and return it.
1616 FILENAME (sans directory) is used unchanged if that name is free;
1617 otherwise a string <2> or <3> or ... is appended to get an unused name.
1618 Spaces at the start of FILENAME (sans directory) are removed."
1627 "Create and return a buffer with a name based on NAME.
1628 Choose the buffer's name using `generate-new-buffer-name'."
1632 "Regexp to match the automounter prefix in a directory name."
1640 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1642 home directory is a root directory) and removes automounter prefixes
1643 \(see the variable `automount-dir-prefix')."
1644 ;; Get rid of the prefixes added by the automounter.
1651 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1652 ;; To fix this right, we need a `file-name-case-sensitive-p'
1653 ;; function, but we don't have that yet, so just guess.
1656 ;; If any elt of directory-abbrev-alist matches this name,
1657 ;; abbreviate accordingly.
1663 ;; Compute and save the abbreviated homedir name.
1664 ;; We defer computing this until the first time it's needed, to
1665 ;; give time for directory-abbrev-alist to be set properly.
1666 ;; We include a slash at the end, to avoid spurious matches
1667 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1674 ;; If FILENAME starts with the abbreviated homedir,
1675 ;; make it start with `~' instead.
1677 ;; If the home dir is just /, don't change it.
1680 ;; MS-DOS root directories can come with a drive letter;
1681 ;; Novell Netware allows drive letters beyond `Z:'.
1689 filename)))
1692 "List of logical names for which visiting shouldn't save the true dirname."
1697 "Return the buffer visiting file FILENAME (a string).
1698 This is like `get-file-buffer', except that it checks for any buffer
1699 visiting the same file, possibly under a different name.
1700 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1701 and others are ignored.
1702 If there is no such live buffer, return nil."
1715 found)
1725 ;; Verify this buffer's file number
1726 ;; still belongs to its file.
1729 attributes)
1733 found))))
1734 \f
1736 "Non-nil means file-visiting commands should handle wildcards.
1737 For example, if you specify `*.c', that would visit all the files
1738 whose names match the pattern."
1744 "Non-nil means suppress warning messages for symlinked files.
1745 When nil, Emacs prints a warning when visiting a file that is already
1746 visited, but with a different name. Setting this option to t
1747 suppresses this warning."
1753 "Maximum size of file above which a confirmation is requested.
1754 When nil, never request confirmation."
1761 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1762 OP-TYPE specifies the file operation being performed (for message to user)."
1771 "Read file FILENAME into a buffer and return the buffer.
1772 If a buffer exists visiting FILENAME, return that one, but
1773 verify that the file has not changed since visited or saved.
1774 The buffer is not selected, just returned to the caller.
1775 Optional second arg NOWARN non-nil means suppress any warning messages.
1776 Optional third arg RAWFILE non-nil means the file is read literally.
1777 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1778 and visit all the matching files. When wildcards are actually
1779 used and expanded, return a list of buffers that are visiting
1780 the various files."
1787 'find-directory-functions
1790 filename)))
1793 find-file-wildcards
1807 ;; Find any buffer for a file which has same truename.
1809 ;; Let user know if there is a buffer with the same truename.
1813 find-file-suppress-same-file-warnings
1817 ;; Optionally also find that buffer.
1820 ;; Check to see if the file looks uncommonly large.
1824 ;; We are using an existing buffer.
1831 ;; Certain files should be reverted automatically
1832 ;; if they have changed on disk and not in the buffer.
1840 found))
1850 "File %s changed on disk. Discard your edits? "
1855 "File %s changed on disk. Discard your edits in %s? "
1863 ;; Check if a formerly read-only file has become
1864 ;; writable and vice versa, but if the buffer agrees
1865 ;; with the new state of the file, that is ok too.
1873 buffer-file-name
1882 ;; It is confusing to ask whether to visit
1883 ;; non-literally if they have the file in
1884 ;; hexl-mode.
1890 "The file %s is already visited normally,
1891 and you have edited the buffer. Now you have asked to visit it literally,
1892 meaning no coding system handling, format conversion, or local variables.
1893 Emacs can only visit a file in one way at a time.
1895 Do you want to save the file, and visit it literally instead? "
1896 "The file %s is already visited literally,
1897 meaning no coding system handling, format conversion, or local variables.
1898 You have edited the buffer. Now you have asked to visit the file normally,
1899 but Emacs can only visit a file in one way at a time.
1906 rawfile truename number))
1910 "\
1911 Do you want to discard your changes, and visit the file literally now? "
1912 "\
1915 rawfile truename number)
1921 "The file %s is already visited normally.
1922 You have asked to visit it literally,
1923 meaning no coding system decoding, format conversion, or local variables.
1924 But Emacs can only visit a file in one way at a time.
1926 Do you want to revisit the file literally now? "
1927 "The file %s is already visited literally,
1928 meaning no coding system decoding, format conversion, or local variables.
1929 You have asked to visit it normally,
1930 but Emacs can only visit a file in one way at a time.
1935 rawfile truename number)
1938 ;; Return the buffer we are using.
1939 buf)
1940 ;; Create a new buffer.
1942 ;; find-file-noselect-1 may use a different buffer.
1944 rawfile truename number))))))
1950 ;; Needed in case we are re-visiting the file with a different
1951 ;; text representation.
1968 filename)))
1969 ;; Unconditionally set error
1979 filename)))
1980 ;; Run find-file-not-found-functions until one returns non-nil.
1982 ;; If they fail too, set error.
1984 ;; Record the file's truename, and maybe use that as visited name.
1992 ;; Set buffer's default directory to that of the file.
1994 ;; Turn off backup files for certain file names. Since
1995 ;; this is a permanent local, the major mode won't eliminate it.
2010 \f
2012 "Like `insert-file-contents', but only reads in the file literally.
2013 A buffer may be modified in several ways after reading into the buffer,
2014 to Emacs features such as format decoding, character code
2015 conversion, `find-file-hook', automatic uncompression, etc.
2017 This function ensures that none of these modifications will take place."
2025 nil))
2028 inhibit-file-name-handlers))
2041 filename)))
2042 ;; Check whether the file is uncommonly large
2053 "Insert contents of file FILENAME into buffer after point with no conversion.
2055 This function is meant for the user to run interactively.
2056 Don't call it from programs! Use `insert-file-contents-literally' instead.
2057 \(Its calling sequence is different; see its documentation)."
2062 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2067 "Visit file FILENAME with no conversion of any kind.
2068 Format conversion and character code conversion are both disabled,
2069 and multibyte characters are disabled in the resulting buffer.
2070 The major mode used is Fundamental mode regardless of the file name,
2071 and local variable specifications in the file are ignored.
2072 Automatic uncompression and adding a newline at the end of the
2073 file due to `require-final-newline' is also disabled.
2075 You cannot absolutely rely on this function to result in
2076 visiting the file literally. If Emacs already has a buffer
2077 which is visiting the file, you get the existing buffer,
2078 regardless of whether it was created literally or not.
2080 In a Lisp program, if you want to be sure of accessing a file's
2081 contents literally, you should create a temporary buffer and then read
2082 the file contents into it using `insert-file-contents-literally'."
2085 "Find file literally: " nil default-directory
2088 \f
2092 after-find-file-from-revert-buffer
2093 nomodes)
2094 "Called after finding a file and by the default revert function.
2095 Sets buffer mode, parses local variables.
2096 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2097 error in reading the file. WARN non-nil means warn if there
2098 exists an auto-save file more recent than the visited file.
2099 NOAUTO means don't mess with auto-save mode.
2100 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2101 means this call was from `revert-buffer'.
2102 Fifth arg NOMODES non-nil means don't alter the file's modes.
2103 Finishes by calling the functions in `find-file-hook'
2104 unless NOMODES is non-nil."
2107 nil
2117 ;; No need to warn if buffer is auto-saved
2118 ;; under the name of the visited file.
2120 auto-save-visited-file-name))
2123 buffer-file-name))
2143 ;; Make people do a little extra work (C-x C-q)
2144 ;; before altering a backup file.
2147 ;; When a file is marked read-only,
2148 ;; make the buffer read-only even if root is looking at it.
2156 ;; If requested, add a newline at the end of the file.
2166 view-read-only
2172 "Eval BODY and turn any error into a FORMAT message.
2173 FORMAT can have a %s escape which will be replaced with the actual error.
2174 If `debug-on-error' is set, errors are not caught, so that you can
2175 debug them.
2176 Avoid using a large BODY since it is duplicated."
2185 "Choose the major mode for this buffer automatically.
2186 Also sets up any specified local variables of the file.
2187 Uses the visited file name, the -*- line, and the local variables spec.
2189 This function is called automatically from `find-file'. In that case,
2190 we may set up the file-specified mode and local variables,
2191 depending on the value of `enable-local-variables'.
2192 In addition, if `local-enable-local-variables' is nil, we do
2193 not set local variables (though we do notice a mode specified with -*-.)
2195 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2196 or from Lisp without specifying the optional argument FIND-FILE;
2197 in that case, this function acts as if `enable-local-variables' were t."
2205 ;; Turn font lock off and on, to make sure it takes account of
2206 ;; whatever file local variables are relevant to it.
2208 ;; Font-lock-mode (now in font-core.el) can be ON when
2209 ;; font-lock.el still hasn't been loaded.
2219 "Non-nil means to try second pass through `auto-mode-alist'.
2220 This means that if the first case-sensitive search through the alist fails
2221 to find a matching major mode, a second case-insensitive search is made.
2222 On systems with case-insensitive file names, this variable is ignored,
2223 since only a single case-insensitive search through the alist is made."
2229 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2230 ;; c++-mode, java-mode and more) are added through autoload
2231 ;; directives in that file. That way is discouraged since it
2232 ;; spreads out the definition of the initial value.
2276 ;; Less common extensions come here
2277 ;; so more common ones above are found faster.
2285 ;; Besides .gdbinit, gdb documents other names to be usable for init
2286 ;; files, cross-debuggers can use something like
2287 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2288 ;; don't interfere with each other.
2326 ;; The list of archive file extensions should be in sync with
2327 ;; `auto-coding-alist' with `no-conversion' coding system.
2333 ;; Mailer puts message to be edited in
2334 ;; /tmp/Re.... or Message
2337 ;; some news reader is reported to use this
2347 ;; .emacs or .gnus or .viper following a directory delimiter in
2348 ;; Unix, MSDOG or VMS syntax.
2351 ;; _emacs following a directory delimiter
2352 ;; in MsDos syntax
2356 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2357 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2358 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2361 ;; .xs is also used for ld scripts, but seems to be more commonly
2362 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2364 ;; Explained in binutils ld/genscripts.sh. Eg:
2365 ;; A .x script file is the default script.
2366 ;; A .xr script is for linking without relocation (-r flag). Etc.
2370 ;; Common Lisp ASDF package system.
2377 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2388 ;; Windows candidates may be opened case sensitively on Unix
2394 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2396 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2397 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2398 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2399 ;; this has lower priority to avoid matching changelog.sgml etc.
2401 ;; either user's dot-files or under /etc or some such
2403 ;; alas not all ~/.*rc files are like this
2404 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2409 ;; this contains everything twice, with space and with colon :-(
2411 ;; Get rid of any trailing .n.m and try again.
2412 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2413 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2414 ;; Using mode nil rather than `ignore' would let the search continue
2415 ;; through this list (with the shortened name) rather than start over.
2417 ;; The following should come after the ChangeLog pattern
2418 ;; for the sake of ChangeLog.1, etc.
2419 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2422 "Alist of filename patterns vs corresponding major mode functions.
2423 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2424 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2425 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2426 mode function to use. FUNCTION will be called, unless it is nil.
2428 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2429 calling FUNCTION (if it's not nil), we delete the suffix that matched
2430 REGEXP and search the list again for another match.
2432 If the file name matches `inhibit-first-line-modes-regexps',
2433 then `auto-mode-alist' is not processed.
2435 The extensions whose FUNCTION is `archive-mode' should also
2436 appear in `auto-coding-alist' with `no-conversion' coding system.
2438 See also `interpreter-mode-alist', which detects executable script modes
2439 based on the interpreters they specify to run,
2444 "Select Conf mode or XML mode according to start of file."
2454 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2455 ;; and pike-mode) are added through autoload directives in that
2456 ;; file. That way is discouraged since it spreads out the
2457 ;; definition of the initial value.
2496 "Alist mapping interpreter names to major modes.
2497 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2498 Each element looks like (INTERPRETER . MODE).
2499 If INTERPRETER matches the name of the interpreter specified in the first line
2500 of a script, mode MODE is enabled.
2508 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2509 When checking `inhibit-first-line-modes-regexps', we first discard
2515 "Regexp matching interpreters, for file mode determination.
2516 This regular expression is matched against the first line of a file
2517 to determine the file's mode in `set-auto-mode'. If it matches, the file
2518 is assumed to be interpreted by the interpreter matched by the second group
2519 of the regular expression. The mode is then determined as the mode
2523 "Alist of buffer beginnings vs. corresponding major mode functions.
2524 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2525 After visiting a file, if REGEXP matches the text at the beginning of the
2526 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2527 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2528 major mode.
2530 If FUNCTION is nil, then it is not called. (That is a way of saying
2538 ;; The < comes before the groups (but the first) to reduce backtracking.
2539 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2540 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2544 comment-re "*"
2547 . html-mode)
2549 ;; These two must come after html, because they are more general:
2554 . sgml-mode)
2557 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2558 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2559 After visiting a file, if REGEXP matches the text at the beginning of the
2560 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2561 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2562 have not specified a mode for this file.
2568 "Upper limit on `magic-mode-alist' regexp matches.
2572 "Select major mode appropriate for current buffer.
2574 To find the right major mode, this function checks for a -*- mode tag,
2575 checks if it uses an interpreter listed in `interpreter-mode-alist',
2576 matches the buffer beginning against `magic-mode-alist',
2577 compares the filename against the entries in `auto-mode-alist',
2578 then matches the buffer beginning against `magic-fallback-mode-alist'.
2580 It does not check for the `mode:' local variable in the
2581 Local Variables section of the file; for that, use `hack-local-variables'.
2583 If `enable-local-variables' is nil, this function does not check for a
2584 -*- mode tag.
2586 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2587 set the major mode only if that would change it. In other words
2588 we don't actually set it to the same mode the buffer already has."
2589 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2591 ;; Find a -*- mode tag
2598 ;; Find all specifications for the `mode:' variable
2599 ;; and execute them left to right.
2611 modes)))
2612 ;; Simple -*-MODE-*- case.
2615 modes))))
2616 ;; If we found modes to use, invoke them now, outside the save-excursion.
2624 ;; continuing would call minor modes again, toggling them off
2626 ;; If we didn't, look for an interpreter specified in the first line.
2627 ;; As a special case, allow for things like "#!/bin/env perl", which
2628 ;; finds the interpreter anywhere in $PATH.
2635 ;; Map interpreter name to a mode, signalling we're done at the
2636 ;; same time.
2638 interpreter-mode-alist))
2639 ;; If we found an interpreter mode to use, invoke it now.
2642 ;; Next try matching the buffer beginning against magic-mode-alist.
2656 ;; Next compare the filename against the entries in auto-mode-alist.
2661 ;; Remove remote file name identification.
2665 ;; Remove backup-suffixes from file name.
2668 ;; Find first matching alist entry.
2671 ;; System is case-insensitive.
2675 ;; System is case-sensitive.
2677 ;; First match case-sensitively.
2681 ;; Fallback to case-insensitive match.
2695 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2710 ;; When `keep-mode-if-same' is set, we are working on behalf of
2711 ;; set-visited-file-name. In that case, if the major mode specified is the
2712 ;; same one we already have, don't actually reset it. We don't want to lose
2713 ;; minor modes such as Font Lock.
2715 "Apply MODE and return it.
2716 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2717 any aliases and compared to current major mode. If they are the
2718 same, do nothing and return nil."
2724 mode)))
2727 "Find the -*- spec in the buffer.
2728 Call with point at the place to start searching from.
2729 If one is found, set point to the beginning
2730 and return the position of the end.
2731 Otherwise, return nil; point may be changed."
2734 ;; Don't look for -*- if this file name matches any
2735 ;; of the regexps in inhibit-first-line-modes-regexps.
2743 sufs)
2751 ;; If the file begins with "#!"
2752 ;; (exec interpreter magic), look
2753 ;; for mode frobs in the first two
2754 ;; lines. You cannot necessarily
2755 ;; put them in the first line of
2756 ;; such a file without screwing up
2757 ;; the interpreter invocation.
2758 ;; The same holds for
2759 ;; '\"
2760 ;; in man pages (preprocessor
2761 ;; magic for the `man' program).
2772 end))))
2773 \f
2774 ;;; Handling file local variables
2778 file-local-variables-alist dir-local-variables-alist)
2783 "Normal hook run after processing a file's local variables specs.
2784 Major modes can use this to examine user-specified local variables
2788 "List variable-value pairs that are considered safe.
2789 Each element is a cons cell (VAR . VAL), where VAR is a variable
2790 symbol and VAL is a value that is considered safe."
2791 :risky t
2798 "Expressions that are considered safe in an `eval:' local variable.
2799 Add expressions to this list if you want Emacs to evaluate them, when
2800 they appear in an `eval' local variable specification, without first
2801 asking you for confirmation."
2802 :risky t
2807 ;; Risky local variables:
2810 buffer-auto-save-file-name
2811 buffer-file-name
2812 buffer-file-truename
2813 buffer-undo-list
2814 debugger
2815 default-text-properties
2816 eval
2817 exec-directory
2818 exec-path
2819 file-name-handler-alist
2820 frame-title-format
2821 global-mode-string
2822 header-line-format
2823 icon-title-format
2824 inhibit-quit
2825 load-path
2826 max-lisp-eval-depth
2827 max-specpdl-size
2828 minor-mode-map-alist
2829 minor-mode-overriding-map-alist
2830 mode-line-format
2831 mode-name
2832 overriding-local-map
2833 overriding-terminal-local-map
2834 process-environment
2835 standard-input
2836 standard-output
2837 unread-command-events))
2839 ;; Safe local variables:
2840 ;;
2841 ;; For variables defined by major modes, the safety declarations can go into
2842 ;; the major mode's file, since that will be loaded before file variables are
2843 ;; processed.
2844 ;;
2845 ;; For variables defined by minor modes, put the safety declarations in the
2846 ;; file defining the minor mode after the defcustom/defvar using an autoload
2847 ;; cookie, e.g.:
2848 ;;
2849 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2850 ;;
2851 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2852 ;; minor mode file may not be loaded yet.
2853 ;;
2854 ;; For variables defined in the C source code the declaration should go here:
2875 "Alist of file-local variable settings in the current buffer.
2876 Each element in this list has the form (VAR . VALUE), where VAR
2877 is a file-local variable (a symbol) and VALUE is the value
2878 specified. The actual value in the buffer may differ from VALUE,
2884 "Alist of directory-local variable settings in the current buffer.
2885 Each element in this list has the form (VAR . VALUE), where VAR
2886 is a directory-local variable (a symbol) and VALUE is the value
2887 specified in .dir-locals.el. The actual value in the buffer
2888 may differ from VALUE, if it is changed by the major or minor modes,
2893 "Normal hook run before setting file-local variables.
2894 It is called after checking for unsafe/risky variables and
2895 setting `file-local-variables-alist', and before applying the
2896 variables stored in `file-local-variables-alist'. A hook
2897 function is allowed to change the contents of this alist.
2899 This hook is called only if there is at least one file-local
2903 "Get confirmation before setting up local variable values.
2904 ALL-VARS is the list of all variables to be set up.
2905 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2906 RISKY-VARS is the list of those that are marked as risky.
2907 DIR-NAME is a directory name if these settings come from
2908 directory-local variables, or nil otherwise."
2910 nil
2917 unsafe-vars))
2921 prompt char)
2929 ", and variables that are risky (**)."
2937 y -- to apply the local variables list.
2941 ! -- to apply the local variables list, and permanently mark these
2953 ;; Make strings with embedded whitespace easier to read.
2961 ""
2976 ;; When this is called from desktop-restore-file-buffer,
2977 ;; coding-system-for-read may be non-nil. Reset it before
2978 ;; writing to .emacs.
2982 'safe-local-variable-values
2983 safe-local-variable-values))))
2987 "Return local variables specified in the -*- line.
2988 Ignore any specification for `mode:' and `coding:';
2989 `set-auto-mode' should already have handled `mode:',
2990 `set-auto-coding' should already have handled `coding:'.
2992 If MODE-ONLY is non-nil, all we do is check whether the major
2993 mode is specified, returning t if it is specified. Otherwise,
2994 return an alist of elements (VAR . VAL), where VAR is a variable
2995 and VAL is the specified value."
2999 result mode-specified)
3000 ;; Parse the -*- line into the RESULT alist.
3001 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
3003 nil)
3005 ;; Simple form: "-*- MODENAME -*-". Already handled.
3007 nil)
3009 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3010 ;; (last ";" is optional).
3015 ;; There used to be a downcase here,
3016 ;; but the manual didn't say so,
3017 ;; and people want to set var names that aren't all lc.
3023 ;; It is traditional to ignore
3024 ;; case when checking for `mode' in set-auto-mode,
3025 ;; so we must do that here as well.
3026 ;; That is inconsistent, but we're stuck with it.
3027 ;; The same can be said for `coding' in set-auto-coding.
3033 'eval
3040 mode-specified
3041 result))))
3044 "Filter local variable settings, querying the user if necessary.
3045 VARIABLES is the alist of variable-value settings. This alist is
3046 filtered based on the values of `ignored-local-variables',
3047 `enable-local-eval', `enable-local-variables', and (if necessary)
3048 user interaction. The results are added to
3049 `file-local-variables-alist', without applying them.
3050 DIR-NAME is a directory name if these settings come from
3051 directory-local variables, or nil otherwise."
3052 ;; Find those variables that we may want to save to
3053 ;; `safe-local-variable-values'.
3059 ;; Ignore any variable in `ignored-local-variables'.
3060 nil)
3061 ;; Obey `enable-local-eval'.
3069 ;; Ignore duplicates (except `mode') in the present list.
3071 ;; Accept known-safe variables.
3075 ;; The variable is either risky or unsafe:
3082 ;; Query, unless all vars are safe or user wants no querying.
3088 risky-vars dir-name))
3099 "Parse and put into effect this buffer's local variables spec.
3100 If MODE-ONLY is non-nil, all we do is check whether the major mode
3101 is specified, returning t if it is specified."
3104 result)
3111 ;; Look for "Local variables:" line in last page.
3119 ;; suffix is what comes after "local variables:" in its line.
3120 ;; prefix is what comes before "local variables:" in its line.
3130 beg)
3134 endpos
3140 nil t))
3141 ;; This used to be an error, but really all it means is
3142 ;; that this may simply not be a local-variables section,
3143 ;; so just ignore it.
3153 ;; Discard the prefix.
3158 ;; Discard the suffix.
3166 ;; Find the variable name; strip whitespace.
3175 val)
3176 ;; Read the variable value.
3187 'eval
3192 ;; Now we've read all the local variables.
3193 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3195 ;; Otherwise, set the variables.
3202 ;; Any 'evals must run in the Right sequence.
3211 "Non-nil if SYM is safe as a file-local variable with value VAL.
3212 It is safe if any of these conditions are met:
3214 * There is a matching entry (SYM . VAL) in the
3215 `safe-local-variable-values' user option.
3217 * The `safe-local-variable' property of SYM is a function that
3218 evaluates to a non-nil value with VAL as an argument."
3222 ;; If the function signals an error, that means it
3223 ;; can't assure us that the value is safe.
3227 "Non-nil if SYM could be dangerous as a file-local variable.
3228 It is dangerous if either of these conditions are met:
3230 * Its `risky-local-variable' property is non-nil.
3236 ;; If this is an alias, check the base name.
3256 "Return t if it is safe to eval EXP when it is found in a file."
3258 ;; Detect certain `put' expressions.
3265 lisp-indent-function
3266 scheme-indent-function))
3267 ;; Only allow safe values (not functions).
3272 ;; Only allow indirect form specs.
3273 ;; During bootstrapping, edebug-basic-spec might not be
3274 ;; defined yet.
3278 ;; Allow expressions that the user requested.
3280 ;; Certain functions can be allowed with safe arguments
3281 ;; or can specify verification functions to try.
3289 ok))
3297 ok)))))))
3300 "Set local variable VAR with value VAL.
3301 If VAR is `mode', call `VAL-mode' as a function unless it's
3302 already the major mode."
3309 ;; A minor mode must be passed an argument.
3310 ;; Otherwise, if the user enables the minor mode in a
3311 ;; major mode hook, this would toggle it off.
3317 ;; Make sure the string has no text properties.
3318 ;; Some text properties can get evaluated in various ways,
3319 ;; so it is risky to put them on with a local variable list.
3323 \f
3324 ;;; Handling directory-local variables, aka project settings.
3330 "List of cached directory roots for directory-local variable classes.
3331 Each element in this list has the form (DIR CLASS MTIME).
3332 DIR is the name of the directory.
3333 CLASS is the name of a variable class (a symbol).
3334 MTIME is the recorded modification time of the directory-local
3335 variables file associated with this entry. This time is a list
3336 of two integers (the same format as `file-attributes'), and is
3337 used to test whether the cache entry is still valid.
3338 Alternatively, MTIME can be nil, which means the entry is always
3342 "Return the variable list for CLASS."
3346 "Collect directory-local variables from MODE-VARIABLES.
3347 VARIABLES is the initial list of variables.
3348 Returns the new list."
3353 ;; If variables are specified more than once, only use the last. (Why?)
3354 ;; The pseudo-variables mode and eval are different (bug#3430).
3357 ;; Need a new cons in case we setcdr later.
3361 "Collect entries from CLASS-VARIABLES into VARIABLES.
3362 ROOT is the root directory of the project.
3363 Return the new variables list."
3366 ;; FIXME: Why not use file-relative-name?
3373 ;; Don't include this in the previous condition, because we
3374 ;; want to filter all strings before the next condition.
3385 ;; The file's content might be invalid (e.g. have a merge conflict), but
3386 ;; that shouldn't prevent the user from opening the file.
3388 nil))))
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.
3521 default-directory))
3542 \f
3545 However, the mode will not be changed if
3546 \(1) a local variables list or the `-*-' line specifies a major mode, or
3548 \ not suitable for ordinary files, or
3549 \(3) the new file name does not particularly specify any mode."
3554 "Change name of file visited in current buffer to FILENAME.
3555 This also renames the buffer to correspond to the new file.
3556 The next time the buffer is saved it will go in the newly specified file.
3557 FILENAME nil or an empty string means mark buffer as not visiting any file.
3558 Remember to delete the initial contents of the minibuffer
3559 if you wish to pass an empty string as the argument.
3561 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3562 confirmation in the case where another buffer is already visiting FILENAME.
3564 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3565 the old visited file has been renamed to the new name FILENAME."
3573 nil
3588 filename))
3598 ;; If new-name == old-name, renaming would add a spurious <2>
3599 ;; and it's considered as a feature in rename-buffer.
3605 ;; Abbreviate the file names of the buffer.
3614 nil)))
3615 ;; write-file-functions is normally used for things like ftp-find-file
3616 ;; that visit things that are not local files as if they were files.
3617 ;; Changing to visit an ordinary local file instead should flush the hook.
3622 ;; If buffer was read-only because of version control,
3623 ;; that reason is gone now, so make it writable.
3627 ;; Turn off backup files for certain file names.
3628 ;; Since this is a permanent local, the major mode won't eliminate it.
3630 backup-enable-predicate
3636 ;; If auto-save was not already on, turn it on if appropriate.
3640 ;; If auto save is on, start using a new name.
3641 ;; We deliberately don't rename or delete the old auto save
3642 ;; for the old visited file name. This is because perhaps
3643 ;; the user wants to save the new state and then compare with the
3644 ;; previous state from the auto save file.
3647 ;; Rename the old auto save file if any.
3654 ;; Update the major mode, if the file name determines it.
3656 ;; Don't change the mode if it is special.
3659 ;; Don't change the mode if the local variable list specifies it.
3665 "Write current buffer into file FILENAME.
3666 This makes the buffer visit that file, and marks it as not modified.
3668 If you specify just a directory name as FILENAME, that means to use
3669 the default file name but in that directory. You can also yank
3670 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3672 If the buffer is not already visiting a file, the default file name
3673 for the output file is the buffer name.
3675 If optional second arg CONFIRM is non-nil, this function
3676 asks for confirmation before overwriting an existing file.
3677 Interactively, confirmation is required unless you supply a prefix argument."
3678 ;; (interactive "FWrite file: ")
3682 nil nil nil nil)
3686 default-directory)
3687 nil nil))
3691 ;; If arg is just a directory,
3692 ;; use the default file name, but in that directory.
3703 ;; Make buffer writable if file is writable.
3708 ;; It's likely that the VC status at the new location is different from
3709 ;; the one at the old location.
3711 \f
3713 "Make a backup of the disk file visited by the current buffer, if appropriate.
3714 This is normally done before saving the buffer the first time.
3716 A backup may be done by renaming or by copying; see documentation of
3717 variable `make-backup-files'. If it's done by renaming, then the file is
3718 no longer accessible under its old name.
3720 The value is non-nil after a backup was made by renaming.
3721 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3722 MODES is the result of `file-modes' on the original
3723 file; this means that the caller, after saving the buffer, should change
3724 the modes of the new file to agree with the old modes.
3725 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3726 file; this means that the caller, after saving the buffer, should change
3727 the SELinux context of the new file to agree with the old context.
3728 BACKUPNAME is the backup file name, which is the old file renamed."
3735 backup-info backupname targets setmodes)
3736 ;; If specified name is a symbolic link, chase it to the target.
3737 ;; Thus we make the backups in the directory where the real file is.
3742 ;; (if (file-directory-p buffer-file-name)
3743 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3747 ;; If have old versions to maybe delete,
3748 ;; ask the user to confirm now, before doing anything.
3749 ;; But don't actually delete til later.
3754 real-file-name))))
3757 ;; Actually write the back up file.
3760 ; (file-symlink-p buffer-file-name)
3761 backup-by-copying
3762 ;; Don't rename a suid or sgid file.
3777 ;; rename-file should delete old backup.
3781 ;; If trouble writing the backup, write it in ~.
3786 backupname)
3790 ;; Now delete the old versions, if desired.
3797 setmodes)
3804 ;; Create temp files with strict access rights. It's easy to
3805 ;; loosen them later, whereas it's impossible to close the
3806 ;; time-window of loose permissions otherwise.
3809 ;; Try to overwrite old backup first.
3817 nil)
3819 ;; The file was somehow created by someone else between
3820 ;; `delete-file' and `copy-file', so let's try again.
3821 ;; rms says "I think there is also a possible race
3822 ;; condition for making backup files" (emacs-devel 20070821).
3823 nil)))
3824 ;; Reset the umask.
3833 "Regular expression matching the backup/version part of a file name.
3837 "Return file NAME sans backup versions or strings.
3838 This is a separate procedure so your site-init or startup file can
3839 redefine it.
3840 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3841 we do not remove backup version numbers, only true file version numbers.
3842 See also `file-name-version-regexp'."
3849 name))))))
3852 "Return t if deleting FILE and rewriting it would preserve the owner."
3857 ;; Return t if the file doesn't exist, since it's true that no
3858 ;; information would be lost by an (attempted) delete and create.
3864 The extension, in a file name, is the part that follows the last `.',
3865 except that a leading `.', if any, doesn't count."
3868 directory)
3872 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3873 ;; we don't want to expand it.
3876 filename))))
3880 The extension, in a file name, is the part that follows the last `.',
3881 excluding version numbers and backup suffixes,
3882 except that a leading `.', if any, doesn't count.
3883 Return nil for extensionless file names such as `foo'.
3884 Return the empty string for file names such as `foo.'.
3886 If PERIOD is non-nil, then the returned value includes the period
3887 that delimits the extension, and if FILENAME has no extension,
3898 "A function to use instead of the default `make-backup-file-name'.
3899 A value of nil gives the default `make-backup-file-name' behavior.
3901 This could be buffer-local to do something special for specific
3902 files. If you define it, you may need to change `backup-file-name-p'
3903 and `file-name-sans-versions' too.
3905 See also `backup-directory-alist'."
3911 "Alist of filename patterns and backup directory names.
3912 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3913 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3914 relative or absolute. If it is absolute, so that all matching files
3915 are backed up into the same directory, the file names in this
3916 directory will be the full name of the file backed up with all
3917 directory separators changed to `!' to prevent clashes. This will not
3918 work correctly if your filesystem truncates the resulting name.
3920 For the common case of all backups going into one directory, the alist
3922 directory name.
3924 If this variable is nil, or it fails to match a filename, the backup
3925 is made in the original file's directory.
3927 On MS-DOS filesystems without long names this variable is always
3928 ignored."
3934 "Default `backup-enable-predicate' function.
3935 Checks for files in `temporary-file-directory',
3936 `small-temporary-file-directory', and /tmp."
3939 ;; Directory is under temporary-file-directory.
3944 ;; Directory is under /tmp.
3949 0 nil
3951 ;; Directory is under small-temporary-file-directory.
3956 "Create the non-numeric backup file name for FILE.
3957 Normally this will just be the file's name with `~' appended.
3958 Customization hooks are provided as follows.
3960 If the variable `make-backup-file-name-function' is non-nil, its value
3961 should be a function which will be called with FILE as its argument;
3962 the resulting name is used.
3964 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3965 the documentation of that variable. If the directory for the backup
3966 doesn't exist, it is created."
3980 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3982 elt backup-directory abs-backup-directory)
3987 alist nil)))
3988 ;; If backup-directory is relative, it should be relative to the
3989 ;; file's directory. By expanding explicitly here, we avoid
3990 ;; depending on default-directory.
3999 abs-backup-directory nil))))
4001 file
4005 ;; Normalize DOSish file names: downcase the drive
4006 ;; letter, if any, and replace the leading "x:" with
4007 ;; "/drive_x".
4010 ;; Replace any invalid file-name characters (for the
4011 ;; case of backing up remote files).
4015 "drive_"
4018 ""
4021 ;; Make the name unique by substituting directory
4022 ;; separators. It may not really be worth bothering about
4023 ;; doubling `!'s in the original name...
4028 backup-directory))
4033 "Return non-nil if FILE is a backup file name (numeric or not).
4034 This is a separate function so you can redefine it for customization.
4035 You may need to redefine `file-name-sans-versions' as well."
4040 ;; This is used in various files.
4041 ;; The usage of backup-extract-version-start is not very clean,
4042 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4044 "Given the name of a numeric backup file, FN, return the backup number.
4045 Uses the free variable `backup-extract-version-start', whose value should be
4046 the index in the name where the version number begins."
4053 "Find a file name for a backup file FN, and suggestions for deletions.
4054 Value is a list whose car is the name for the backup file
4055 and whose cdr is a list of old versions to consider deleting now.
4056 If the value is nil, don't make a backup.
4057 Uses `backup-directory-alist' in the same way as does
4058 `make-backup-file-name'."
4060 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4064 ;; We don't support numbered backups on plain MS-DOS
4065 ;; when long file names are unavailable.
4075 possibilities deserve-versions-p versions)
4078 base-versions
4081 possibilities)
4082 #'<)
4087 kept-old-versions
4088 kept-new-versions
4095 ;; Delete nothing if there is overflow
4096 ;; in the number of versions to keep.
4102 v))))))))))
4105 "Return number of names file FILENAME has."
4108 ;; (defun file-relative-name (filename &optional directory)
4109 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4110 ;; This function returns a relative file name which is equivalent to FILENAME
4111 ;; when used with that default directory as the default.
4112 ;; If this is impossible (which can happen on MSDOS and Windows
4113 ;; when the file name and directory use different drive names)
4114 ;; then it returns FILENAME."
4115 ;; (save-match-data
4116 ;; (let ((fname (expand-file-name filename)))
4117 ;; (setq directory (file-name-as-directory
4118 ;; (expand-file-name (or directory default-directory))))
4119 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4120 ;; ;; drive names, they can't be relative, so return the absolute name.
4121 ;; (if (and (or (eq system-type 'ms-dos)
4122 ;; (eq system-type 'cygwin)
4123 ;; (eq system-type 'windows-nt))
4124 ;; (not (string-equal (substring fname 0 2)
4125 ;; (substring directory 0 2))))
4126 ;; filename
4127 ;; (let ((ancestor ".")
4128 ;; (fname-dir (file-name-as-directory fname)))
4129 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4130 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4131 ;; (setq directory (file-name-directory (substring directory 0 -1))
4132 ;; ancestor (if (equal ancestor ".")
4133 ;; ".."
4134 ;; (concat "../" ancestor))))
4135 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4136 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4137 ;; ;; We matched within FNAME's directory part.
4138 ;; ;; Add the rest of FNAME onto ANCESTOR.
4139 ;; (let ((rest (substring fname (match-end 0))))
4140 ;; (if (and (equal ancestor ".")
4141 ;; (not (equal rest "")))
4142 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4143 ;; rest
4144 ;; (concat (file-name-as-directory ancestor) rest)))
4145 ;; ;; We matched FNAME's directory equivalent.
4146 ;; ancestor))))))
4149 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4150 This function returns a relative file name which is equivalent to FILENAME
4151 when used with that default directory as the default.
4152 If FILENAME and DIRECTORY lie on different machines or on different drives
4153 on a DOS/Windows machine, it returns FILENAME in expanded form."
4157 default-directory))))
4163 ;; Test for different filesystems on DOS/Windows
4165 ;; Should `cygwin' really be included here? --stef
4168 ;; Test for different drive letters
4170 ;; Test for UNCs on different servers
4175 ;; Windows file names cannot have ? in
4176 ;; them, so use that to detect when
4177 ;; neither FILENAME nor DIRECTORY is a
4178 ;; UNC.
4180 0 nil
4186 ;; Test for different remote file system identification
4188 filename
4194 directory nil nil case-fold-search))
4196 directory nil nil case-fold-search))))
4199 ".."
4201 ;; Now ancestor is empty, or .., or ../.., etc.
4203 directory nil nil case-fold-search))
4204 ;; We matched within FILENAME's directory part.
4205 ;; Add the rest of FILENAME onto ANCESTOR.
4208 ;; But don't bother with ANCESTOR if it would give us `./'.
4209 rest
4211 ;; We matched FILENAME's directory equivalent.
4212 ancestor))))))
4213 \f
4215 "Save current buffer in visited file if modified.
4216 Variations are described below.
4218 By default, makes the previous version into a backup file
4219 if previously requested or if this is the first save.
4221 to become a backup when the next save is done.
4223 unconditionally makes the previous version into a backup file.
4225 to become a backup when the next save is done,
4226 and unconditionally makes the previous version into a backup file.
4228 With a numeric argument of 0, never make the previous version
4229 into a backup file.
4231 If a file's name is FOO, the names of its numbered backup versions are
4232 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4233 Numeric backups (rather than FOO~) will be made if value of
4234 `version-control' is not the atom `never' and either there are already
4235 numeric versions of the file being backed up, or `version-control' is
4236 non-nil.
4237 We don't want excessive versions piling up, so there are variables
4238 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4239 and `kept-new-versions', which tells how many newest versions to keep.
4240 Defaults are 2 old versions and 2 new.
4241 `dired-kept-versions' controls dired's clean-directory (.) command.
4242 If `delete-old-versions' is nil, system will query user
4243 before trimming versions. Otherwise it does it silently.
4245 If `vc-make-backup-files' is nil, which is the default,
4246 no backup files are made for files managed by version control.
4247 (This is because the version control system itself records previous versions.)
4249 See the subroutine `basic-save-buffer' for more information."
4255 ;; We used to display the message below only for files > 50KB, but
4256 ;; then Rmail-mbox never displays it due to buffer swapping. If
4257 ;; the test is ever re-introduced, be sure to handle saving of
4258 ;; Rmail files.
4265 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4266 Normally delete only if the file was written by this Emacs since
4267 the last real save, but optional arg FORCE non-nil means delete anyway."
4281 "Normal hook that is run before a buffer is saved to its file."
4287 "Normal hook that is run after a buffer is saved to its file."
4293 "If non-nil, use this coding system for saving the buffer.
4294 More precisely, use this coding system in place of the
4295 value of `buffer-file-coding-system', when saving the buffer.
4296 Calling `write-region' for any purpose other than saving the buffer
4297 will still use `buffer-file-coding-system'; this variable has no effect
4304 "Save the current buffer in its visited file, if it has been modified.
4305 The hooks `write-contents-functions' and `write-file-functions' get a chance
4306 to do the job of saving; if they do not, then the buffer is saved in
4307 the visited file in the usual way.
4308 Before and after saving the buffer, this function runs
4309 `before-save-hook' and `after-save-hook', respectively."
4312 ;; In an indirect buffer, save its base buffer instead.
4317 setmodes)
4318 ;; If buffer has no file name, ask user for one.
4325 ;; Signal an error if the user specified the name of an
4326 ;; existing directory.
4329 filename)
4331 ;; Signal an error if the specified name refers to a
4332 ;; non-existing directory.
4342 "%s has changed since visited or saved. Save anyway? "
4357 "Buffer %s does not end in newline. Add one? "
4362 ;; Support VC version backups.
4368 ;; If a hook returned t, file is already "written".
4369 ;; Otherwise, write it the usual way now.
4371 ;; Now we have saved the current buffer. Let's make sure
4372 ;; that buffer-file-coding-system is fixed to what
4373 ;; actually used for saving by binding it locally.
4385 ;; If the auto-save file was recent before this command,
4386 ;; delete it now.
4388 ;; Support VC `implicit' locking.
4393 ;; This does the "real job" of writing a buffer into its visited file
4394 ;; and making a backup file. This is what is normally done
4395 ;; but inhibited if one of write-file-functions returns non-nil.
4396 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4408 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4420 "File %s is write-protected; try to save anyway? "
4422 buffer-file-name))
4436 ;; Write temp name, then rename it.
4437 ;; This requires write access to the containing dir,
4438 ;; which is why we don't try it if we don't have that access.
4440 tempname succeed
4443 ;; Create temp files with strict access rights. It's easy to
4444 ;; loosen them later, whereas it's impossible to close the
4445 ;; time-window of loose permissions otherwise.
4450 ;; Try various temporary names.
4451 ;; This code follows the example of make-temp-file,
4452 ;; but it calls write-region in the appropriate way
4453 ;; for saving the buffer.
4459 ;; Pass in nil&nil rather than point-min&max
4460 ;; cause we're saving the whole buffer.
4461 ;; write-region-annotate-functions may use it.
4463 tempname nil realname
4465 nil)
4467 ;; The file was somehow created by someone else between
4468 ;; `make-temp-name' and `write-region', let's try again.
4469 nil)
4471 ;; Reset the umask.
4473 ;; If we failed, restore the buffer's modtime.
4476 ;; Since we have created an entirely new file,
4477 ;; make sure it gets the right permission bits set.
4482 buffer-file-name)))
4483 ;; We succeeded in writing the temp file,
4484 ;; so rename it.
4486 ;; If file not writable, see if we can make it writable
4487 ;; temporarily while we write it.
4488 ;; But no need to do so if we have just backed it up
4489 ;; (setmodes is set) because that says we're superseding.
4491 ;; Change the mode back, after writing.
4494 buffer-file-name))
4500 ;; Pass in nil&nil rather than point-min&max to indicate
4501 ;; we're saving the buffer rather than just a region.
4502 ;; write-region-annotate-functions may make us of it.
4504 buffer-file-name nil t buffer-file-truename)
4506 ;; If we get an error writing the new file, and we made
4507 ;; the backup by renaming, undo the backing-up.
4512 setmodes))
4518 `((?\C-r
4525 ;; Return nil to ask about BUF again.
4526 nil)
4539 ;; Return nil to ask about BUF again.
4540 nil)
4550 "Save some modified file-visiting buffers. Asks user about each one.
4551 You can answer `y' to save, `n' not to save, `C-r' to look at the
4552 buffer in question with `view-buffer' before deciding or `d' to
4553 view the differences using `diff-buffer-with-file'.
4555 Optional argument (the prefix) non-nil means save all with no questions.
4556 Optional second argument PRED determines which buffers are considered:
4557 If PRED is nil, all the file-visiting buffers are considered.
4558 If PRED is t, then certain non-file buffers will also be considered.
4559 If PRED is a zero-argument function, it indicates for each buffer whether
4560 to consider it or not when called with that buffer current.
4562 See `save-some-buffers-action-alist' if you want to
4563 change the additional actions you can take on files."
4567 files-done abbrevs-done)
4569 ;; First save any buffers that we're supposed to save unconditionally.
4570 ;; That way the following code won't ask about them.
4575 ;; Ask about those buffers that merit it,
4576 ;; and record the number thus saved.
4580 ;; Note that killing some buffers may kill others via
4581 ;; hooks (e.g. Rmail and its viewing buffer).
4594 t
4606 save-some-buffers-action-alist))
4607 ;; Maybe to save abbrevs, and record whether
4608 ;; we either saved them or asked to.
4615 ;; Don't keep bothering user if he says no.
4620 "(Some special files were saved without asking)"
4622 \f
4624 "Mark current buffer as unmodified, not needing to be saved.
4627 It is not a good idea to use this function in Lisp programs, because it
4628 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4635 "Change whether this buffer is read-only.
4636 With prefix argument ARG, make the buffer read-only if ARG is
4637 positive, otherwise make it writable. If buffer is read-only
4638 and `view-read-only' is non-nil, enter view mode."
4643 nil ; do nothing.
4644 ;; Toggle.
4651 ;; If view-mode is already active, `view-mode-enter' is a nop.
4663 "Insert contents of file FILENAME into buffer after point.
4664 Set mark after the inserted text.
4666 This function is meant for the user to run interactively.
4667 Don't call it from programs! Use `insert-file-contents' instead.
4668 \(Its calling sequence is different; see its documentation)."
4673 "Append the contents of the region to the end of file FILENAME.
4674 When called from a function, expects three arguments,
4675 START, END and FILENAME. START and END are normally buffer positions
4676 specifying the part of the buffer to write.
4677 If START is nil, that means to use the entire buffer contents.
4678 If START is a string, then output that string to the file
4679 instead of any buffer contents; END is ignored.
4681 This does character code conversion and applies annotations
4682 like `write-region' does."
4687 "Return most recent backup file for FILENAME or nil if no backups exist."
4688 ;; `make-backup-file-name' will get us the right directory for
4689 ;; ordinary or numeric backups. It might create a directory for
4690 ;; backups as a side-effect, according to `backup-directory-alist'.
4697 tem)
4706 newest))
4709 "Rename current buffer to a similar name not already taken.
4710 This function is useful for creating multiple shell process buffers
4711 or multiple mail buffers, etc."
4719 ;; If the existing buffer name has a <NNN>,
4720 ;; which isn't part of the file name (if any),
4721 ;; then get rid of that.
4727 "Create the directory DIR and optionally any nonexistent parent dirs.
4728 If DIR already exists as a directory, signal an error, unless
4729 PARENTS is non-nil.
4731 Interactively, the default choice of directory to create is the
4732 current buffer's default directory. That is useful when you have
4733 visited a file in a nonexistent directory.
4735 Noninteractively, the second (optional) argument PARENTS, if
4736 non-nil, says whether to create parent directories that don't
4737 exist. Interactively, this happens by default."
4740 nil nil)
4741 t))
4742 ;; If default-directory is a remote directory,
4743 ;; make sure we find its make-directory handler.
4751 create-list)
4753 ;; If directory is its own parent, then we can't
4754 ;; keep looping forever
4769 "Delete the directory named DIRECTORY. Does not follow symlinks.
4770 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4771 TRASH non-nil means to trash the directory instead, provided
4772 `delete-by-moving-to-trash' is non-nil.
4774 When called interactively, TRASH is t if no prefix argument is
4775 given. With a prefix argument, TRASH is nil."
4782 "Move directory to trash: "
4784 default-directory default-directory nil nil))))
4788 "Directory `%s' is not empty, really %s? "
4790 nil)
4792 ;; If default-directory is a remote directory, make sure we find its
4793 ;; delete-directory handler.
4800 ;; Only move non-empty dir to trash if recursive deletion was
4801 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4802 ;; case, where the operation fails in delete-directory-internal.
4803 ;; As `move-file-to-trash' trashes directories (empty or
4804 ;; otherwise) as a unit, we do not need to recurse here.
4806 ;; Check if directory is empty apart from "." and "..".
4811 ;; Otherwise, call outselves recursively if needed.
4815 ;; This test is equivalent to
4816 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4817 ;; but more efficient
4821 ;; We do not want to delete "." and "..".
4827 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4828 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4830 This function always sets the file modes of the output files to match
4831 the corresponding input file.
4833 The third arg KEEP-TIME non-nil means give the output files the same
4834 last-modified time as the old ones. (This works on only some systems.)
4836 A prefix arg makes KEEP-TIME non-nil.
4838 Noninteractively, the last argument PARENTS says whether to
4839 create parent directories if they don't exist. Interactively,
4840 this happens by default."
4847 default-directory default-directory nil nil)
4848 current-prefix-arg t)))
4849 ;; If default-directory is a remote directory, make sure we find its
4850 ;; copy-directory handler.
4856 ;; Compute target name.
4861 ;; Copy recursively.
4873 ;; We do not want to copy "." and "..".
4876 ;; Set directory attributes.
4880 \f
4883 "Function to use to revert this buffer, or nil to do the default.
4884 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4889 "Function to use to insert contents when reverting this buffer.
4890 Gets two args, first the nominal file name to use,
4891 and second, t if reading the auto-save file.
4896 "Function to check whether a non-file buffer needs reverting.
4897 This should be a function with one optional argument NOCONFIRM.
4898 Auto Revert Mode passes t for NOCONFIRM. The function should return
4899 non-nil if the buffer should be reverted. A return value of
4900 `fast' means that the need for reverting was not checked, but
4901 that reverting the buffer is fast. The buffer is current when
4902 this function is called.
4904 The idea behind the NOCONFIRM argument is that it should be
4905 non-nil if the buffer is going to be reverted without asking the
4906 user. In such situations, one has to be careful with potentially
4907 time consuming operations.
4909 For more information on how this variable is used by Auto Revert mode,
4913 "Normal hook for `revert-buffer' to run before reverting.
4914 If `revert-buffer-function' is used to override the normal revert
4918 "Normal hook for `revert-buffer' to run after reverting.
4919 Note that the hook value that it runs is the value that was in effect
4920 before reverting; that makes a difference if you have buffer-local
4921 hook functions.
4923 If `revert-buffer-function' is used to override the normal revert
4929 "Replace current buffer text with the text of the visited file on disk.
4930 This undoes all changes since the file was visited or saved.
4931 With a prefix argument, offer to revert from latest auto-save file, if
4932 that is more recent than the visited file.
4934 This command also implements an interface for special buffers
4935 that contain text which doesn't come from a file, but reflects
4936 some other data instead (e.g. Dired buffers, `buffer-list'
4937 buffers). This is done via the variable `revert-buffer-function'.
4938 In these cases, it should reconstruct the buffer contents from the
4939 appropriate data.
4941 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4942 to revert from the auto-save file when this is nil. Note that the
4943 sense of this argument is the reverse of the prefix argument, for the
4944 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4945 to nil.
4947 Optional second argument NOCONFIRM means don't ask for confirmation
4948 at all. \(The variable `revert-without-query' offers another way to
4949 revert buffers without querying for confirmation.)
4951 Optional third argument PRESERVE-MODES non-nil means don't alter
4952 the files modes. Normally we reinitialize them using `normal-mode'.
4954 If the value of `revert-buffer-function' is non-nil, it is called to
4955 do all the work for this command. Otherwise, the hooks
4956 `before-revert-hook' and `after-revert-hook' are run at the beginning
4957 and the end, and if `revert-buffer-insert-file-contents-function' is
4958 non-nil, it is called instead of rereading visited file contents."
4960 ;; I admit it's odd to reverse the sense of the prefix argument, but
4961 ;; there is a lot of code out there which assumes that the first
4962 ;; argument should be t to avoid consulting the auto-save file, and
4963 ;; there's no straightforward way to encourage authors to notice a
4964 ;; reversal of the argument sense. So I'm just changing the user
4965 ;; interface, but leaving the programmatic interface the same.
4973 buffer-auto-save-file-name
4978 buffer-auto-save-file-name
4979 buffer-file-name)))
4989 file-name))
4991 ;; If file was backed up but has changed since,
4992 ;; we should make another backup.
4996 ;; Effectively copy the after-revert-hook status,
4997 ;; since after-find-file will clobber it.
5000 after-revert-hook))
5005 ;; Get rid of all undo records for this buffer.
5007 ;; Don't make undo records for the reversion.
5010 file-name auto-save-p)))
5013 "File %s no longer exists!"
5015 file-name))
5018 "File %s no longer readable!"
5020 file-name))
5022 ;; Bind buffer-file-name to nil
5023 ;; so that we don't try to lock the file.
5029 ;; Auto-saved file should be read by Emacs'
5030 ;; internal coding.
5034 buffer-file-coding-system-explicit
5037 coding-system-for-read
5039 coding-system-for-read)
5041 ;; As a coding system suitable for multibyte
5042 ;; buffer is specified, make the current
5043 ;; buffer multibyte.
5046 ;; This force after-insert-file-set-coding
5047 ;; (called from insert-file-contents) to set
5048 ;; buffer-file-coding-system to a proper value.
5051 ;; Note that this preserves point in an intelligent way.
5055 nil nil t))
5057 nil nil t)))))
5058 ;; Recompute the truename in case changes in symlinks
5059 ;; have changed the truename.
5063 ;; Run after-revert-hook as it was before we reverted.
5067 local-hook)
5070 t))))))
5073 "Recover the visited file--get contents from its last auto-save file."
5078 "Visit file FILE, but get contents from its last auto-save file."
5079 ;; Actually putting the file name in the minibuffer should be used
5080 ;; only rarely.
5081 ;; Not just because users often use the default.
5101 ;; Use insert-directory-safely, not insert-directory,
5102 ;; because these files might not exist. In particular,
5103 ;; FILE might not exist if the auto-save file was for
5104 ;; a buffer that didn't visit a file, such as "*mail*".
5105 ;; The code in v20.x called `ls' directly, so we need
5106 ;; to emulate what `ls' did in that case.
5112 ;; Keep the current buffer-file-coding-system.
5114 ;; Auto-saved file should be read with special coding.
5123 "Recover auto save files from a previous Emacs session.
5124 This command first displays a Dired buffer showing you the
5125 previous sessions that you could recover from.
5126 To choose one, move point to the proper line and then type C-c C-c.
5127 Then you'll be asked about a number of files to recover."
5137 auto-save-list-file-prefix)))
5138 t)
5147 ;; Each line starts with a space
5148 ;; so that Font Lock mode won't highlight the first character.
5157 "Choose one saved session to recover auto-save files from.
5158 This command is used in the special Dired buffer created by
5161 ;; Get the name of the session file to recover from.
5163 files
5169 ;; Read in the auto-save-list file.
5172 ;; Loop thru the text of that file
5173 ;; and get out the names of the files to recover.
5177 ;; This is a pair of lines for a non-file-visiting buffer.
5178 ;; Get the auto-save file name and manufacture
5179 ;; a "visited file name" from that.
5182 ;; If there is no auto-save file name, the
5183 ;; auto-save-list file is probably corrupted.
5196 ;; This pair of lines is a file-visiting
5197 ;; buffer. Use the visited file name.
5207 ;; Ignore a file if its auto-save file does not exist now.
5211 ;; The file contains a pair of line for each auto-saved buffer.
5212 ;; The first line of the pair contains the visited file name
5213 ;; or is empty if the buffer was not visiting a file.
5214 ;; The second line is the auto-save file name.
5222 files
5228 "Kill BUFFER if confirmed."
5236 "Kill some buffers. Asks the user whether to kill each one of them.
5237 Non-interactively, if optional argument LIST is non-nil, it
5238 specifies the list of buffers to kill, asking for approval for each one."
5246 ; if we killed the base buffer.
5253 "Kill buffers whose name matches the specified REGEXP.
5254 The optional second argument indicates whether to kill internal buffers too."
5263 \f
5265 "Adjust current buffer's auto save file name for current conditions.
5266 Also rename any existing auto save file, if it was made in this session."
5278 "Return file name to use for auto-saves of current buffer.
5279 Does not consider `auto-save-visited-file-name' as that variable is checked
5280 before calling this function. You can redefine this for customization.
5281 See also `auto-save-file-name-p'."
5289 result uniq)
5290 ;; Apply user-specified translations
5291 ;; to the file name.
5295 filename)
5305 filename))))
5310 ;; We truncate the file name to DOS 8+3 limits
5311 ;; before doing anything else, because the regexp
5312 ;; passed to string-match below cannot handle
5313 ;; extensions longer than 3 characters, multiple
5314 ;; dots, and other atrocities.
5319 fn)
5324 "#"
5327 ;; Make sure auto-save file names don't contain characters
5328 ;; invalid for the underlying filesystem.
5330 ;; Don't modify remote (ange-ftp) filenames
5333 result))))
5335 ;; Deal with buffers that don't have any associated files. (Mail
5336 ;; mode tends to create a good number of these.)
5340 file-name)
5341 ;; Restrict the characters used in the file name to those which
5342 ;; are known to be safe on all filesystems, url-encoding the
5343 ;; rest.
5344 ;; We do this on all platforms, because even if we are not
5345 ;; running on DOS/Windows, the current directory may be on a
5346 ;; mounted VFAT filesystem, such as a USB memory stick.
5350 ;; For multibyte characters, this will produce more than
5351 ;; 2 hex digits, so is not true URL encoding.
5355 ;; Generate the file name.
5361 ;; Try a few alternative directories, to get one we can
5362 ;; write it.
5368 ;; Don't modify remote (ange-ftp) filenames
5370 ;; The call to convert-standard-filename is in case
5371 ;; buffer-name includes characters not allowed by the
5372 ;; DOS/Windows filesystems. make-temp-file writes to the
5373 ;; file it creates, so we must fix the file name _before_
5374 ;; make-temp-file is called.
5376 fname))
5378 ;; make-temp-file creates the file,
5379 ;; but we don't want it to exist until we do an auto-save.
5383 file-name)))
5386 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5387 FILENAME should lack slashes. You can redefine this for customization."
5389 \f
5391 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5392 The generated regexp will match a filename only if the filename
5393 matches that wildcard according to shell rules. Only wildcards known
5394 by `sh' are supported."
5396 ;; Copy the initial run of non-special characters.
5399 ;; If no special characters, we're almost done.
5403 j)
5405 result
5426 ;; Found "[^". Insert a `\0' character
5427 ;; (which cannot happen in a filename)
5428 ;; into the character class, so that `^'
5429 ;; is not the first character after `[',
5430 ;; and thus non-special in a regexp.
5435 ;; I don't think `]' can appear in a
5436 ;; character class in a wildcard, but
5437 ;; let's be general here.
5444 i
5457 ;; Shell wildcards should match the entire filename,
5458 ;; not its part. Make the regexp say so.
5460 \f
5463 "Switches for `list-directory' to pass to `ls' for brief listing."
5469 "Switches for `list-directory' to pass to `ls' for verbose listing."
5474 "Expand wildcard pattern PATTERN.
5475 This returns a list of file names which match the pattern.
5477 If PATTERN is written as an absolute file name,
5478 the values are absolute also.
5480 If PATTERN is written as a relative file name, it is interpreted
5481 relative to the current default directory, `default-directory'.
5482 The file names returned are normally also relative to the current
5483 default directory. However, if FULL is non-nil, they are absolute."
5487 ;; A list of all dirs that DIRPART specifies.
5488 ;; This can be more than one dir
5489 ;; if DIRPART contains wildcards.
5493 dirpart)))
5497 contents)
5502 ;; Filter out "." and ".."
5507 name))
5514 this-dir-contents)
5515 this-dir-contents)
5516 contents))))
5518 contents)))
5520 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5524 "Display a list of files in or matching DIRNAME, a la `ls'.
5525 DIRNAME is globbed by the shell if necessary.
5526 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5527 Actions controlled by variables `list-directory-brief-switches'
5528 and `list-directory-verbose-switches'."
5532 nil default-directory nil)
5533 pfx)))
5535 list-directory-brief-switches))
5536 buffer)
5548 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5556 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5558 PATTERN is assumed to represent a file-name wildcard suitable for the
5559 underlying filesystem. For Unix and GNU/Linux, each character from the
5561 the parts of the pattern which don't include wildcard characters are
5562 quoted with double quotes.
5565 on Windows), so PATTERN can use them to quote wildcard characters that
5566 need to be passed verbatim to shell commands."
5570 ;; DOS/Windows don't allow `"' in file names. So if the
5571 ;; argument has quotes, we can safely assume it is already
5572 ;; quoted by the caller.
5574 ;; We quote [&()#$'] in case their shell is a port of a
5575 ;; Unixy shell. We quote [,=+] because stock DOS and
5576 ;; Windows shells require that in some cases, such as
5577 ;; passing arguments to batch files that use positional
5578 ;; arguments like %1.
5580 pattern
5583 end)
5600 pattern))))
5607 "Program to get the amount of free space on a file system.
5608 We assume the output has the format of `df'.
5609 The value of this variable must be just a command name or file name;
5610 if you want to specify options, use `directory-free-space-args'.
5612 A value of nil disables this feature.
5614 If the function `file-system-info' is defined, it is always used in
5615 preference to the program given by this variable."
5621 "Options to use when running `directory-free-space-program'."
5626 "Return the amount of free space on directory DIR's file system.
5627 The return value is a string describing the amount of free
5628 space (normally, the number of free 1KB blocks).
5630 This function calls `file-system-info' if it is available, or
5631 invokes the program specified by `directory-free-space-program'
5632 and `directory-free-space-args'. If the system call or program
5633 is unsuccessful, or if DIR is a remote directory, this function
5634 returns nil."
5636 ;; Try to find the number of free blocks. Non-Posix systems don't
5637 ;; always have df, but might have an equivalent system call.
5646 ;; Avoid failure if the default directory does
5647 ;; not exist (Bug#2631, Bug#3911).
5650 nil t nil
5651 directory-free-space-args
5652 dir)
5654 ;; Assume that the "available" column is before the
5655 ;; "capacity" column. Find the "%" and scan backward.
5659 "[[:space:]]+[^[:space:]]+%[^%]*$"
5666 ;; The following expression replaces `dired-move-to-filename-regexp'.
5670 ;; In some locales, month abbreviations are as short as 2 letters,
5671 ;; and they can be followed by ".".
5672 ;; In Breton, a month name can include a quote character.
5685 s "+"
5688 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5689 ;; omits the Kanji characters after month and day-of-month.
5690 ;; On Mac OS X 10.3, the date format in East Asian locales is
5691 ;; day-of-month digits followed by month digits.
5697 ;; The "[0-9]" below requires the previous column to end in a digit.
5698 ;; This avoids recognizing `1 may 1997' as a date in the line:
5699 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5701 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5703 ;; For non-iso date formats, we add the ".*" in order to find
5704 ;; the last possible match. This avoids recognizing
5705 ;; `jservice 10 1024' as a date in the line:
5706 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5708 ;; vc dired listings provide the state or blanks between file
5709 ;; permissions and date. The state is always surrounded by
5710 ;; parantheses:
5711 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5712 ;; This is not supported yet.
5717 "Regular expression to match up to the file name in a directory listing.
5718 The default value is designed to recognize dates and times
5723 ;; insert-directory
5724 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5725 ;; FULL-DIRECTORY-P is nil.
5726 ;; The single line of output must display FILE's name as it was
5727 ;; given, namely, an absolute path name.
5728 ;; - must insert exactly one line for each file if WILDCARD or
5729 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5730 ;; before the file lines, plus optional text after the file lines.
5731 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5732 ;; allowed.
5733 ;; File lines should display the basename.
5734 ;; - must be consistent with
5735 ;; - functions dired-move-to-filename, (these two define what a file line is)
5736 ;; dired-move-to-end-of-filename,
5737 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5738 ;; dired-insert-headerline
5739 ;; dired-after-subdir-garbage (defines what a "total" line is)
5740 ;; - variable dired-subdir-regexp
5741 ;; - may be passed "--dired" as the first argument in SWITCHES.
5742 ;; Filename handlers might have to remove this switch if their
5743 ;; "ls" command does not support it.
5745 "Insert directory listing for FILE, formatted according to SWITCHES.
5746 Leaves point after the inserted text.
5747 SWITCHES may be a string of options, or a list of strings
5748 representing individual options.
5749 Optional third arg WILDCARD means treat FILE as shell wildcard.
5750 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5751 switches do not contain `d', so that a full listing is expected.
5753 This works by running a directory listing program
5754 whose name is in the variable `insert-directory-program'.
5755 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5757 When SWITCHES contains the long `--dired' option, this function
5758 treats it specially, for the sake of dired. However, the
5759 normally equivalent short `-D' option is just passed on to
5760 `insert-directory-program', as any other option."
5761 ;; We need the directory in order to find the right handler.
5766 wildcard full-directory-p)
5769 ;; Read the actual directory using `insert-directory-program'.
5770 ;; RESULT gets the status code.
5772 ;; putting text property `dired-filename, decode one
5773 ;; bunch by one to preserve that property.
5775 ;; This is to control encoding the arguments in call-process.
5779 default-file-name-coding-system))))
5782 ;; Run ls in the directory part of the file pattern
5783 ;; using the last component as argument.
5790 shell-file-name nil t nil
5791 "-c"
5793 ""
5795 insert-directory-program
5796 " -d "
5798 switches
5800 " -- "
5801 ;; Quote some characters that have
5802 ;; special meanings in shells; but
5803 ;; don't quote the wildcards--we want
5804 ;; them to be special. We also
5805 ;; currently don't quote the quoting
5806 ;; characters in case people want to
5807 ;; use them explicitly to quote
5808 ;; wildcard characters.
5810 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5811 ;; directory if FILE is a symbolic link.
5818 insert-directory-program nil t nil
5822 ;; Split the switches at any spaces so we can
5823 ;; pass separate options as separate args.
5825 ;; Avoid lossage if FILE starts with `-'.
5833 file))))))))
5835 ;; If we got "//DIRED//" in the output, it means we got a real
5836 ;; directory listing, even if `ls' returned nonzero.
5837 ;; So ignore any errors.
5850 ;; The first time ls returns an error,
5851 ;; find the version numbers of ls,
5852 ;; and set insert-directory-ls-version
5853 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5854 ;; is equal or if the info cannot be obtained.
5855 ;; (That can mean it isn't GNU ls.)
5865 comparison)
5881 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5885 ;; If `insert-directory-program' failed, signal an error.
5887 ;; Delete the error message it may have output.
5889 ;; On non-Posix systems, we cannot open a directory, so
5890 ;; don't even try, because that will always result in
5891 ;; the ubiquitous "Access denied". Instead, show the
5892 ;; command line so the user can try to guess what went wrong.
5897 insert-directory-program
5899 file result)
5900 ;; Unix. Access the file to get a suitable error.
5907 ;; The following overshoots by one line for an empty
5908 ;; directory listed with "--dired", but without "-a"
5909 ;; switch, where the ls output contains a
5910 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5911 ;; We take care of that case later.
5919 error-lines)
5920 ;; Find all the lines that are error messages,
5921 ;; and record the bounds of each one.
5928 ;; Now read the numeric positions of file names.
5935 error-lines))
5938 error-lines)))
5940 ;; End is followed by \n or by " -> ".
5942 ;; It seems that we can't trust ls's output as to
5943 ;; byte positions of filenames.
5949 ;; Take care of the case where the ls output contains a
5950 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5951 ;; and we went one line too far back (see above).
5956 ;; Now decode what read if necessary.
5958 file-name-coding-system
5959 default-file-name-coding-system
5961 coding-no-eol
5962 val pos)
5966 ;; If no coding system is specified or detection is
5967 ;; requested, detect the coding.
5981 ;; Force no eol conversion on a file name, so
5982 ;; that CR is preserved.
5990 ;; Try to insert the amount of free space.
5993 ;; First find the line to put it on.
5997 ;; Replace "total" with "used", to avoid confusion.
6003 "Convert `ls --dired' file name position value POS to a buffer position.
6004 File name position values returned in ls --dired output
6005 count only stdout; they don't count the error messages sent to stderr.
6006 So this function converts to them to real buffer positions.
6007 ERROR-LINES is a list of buffer positions of error message lines,
6008 of the form (START END)."
6012 pos)
6016 "Insert directory listing for FILE, formatted according to SWITCHES.
6018 Like `insert-directory', but if FILE does not exist, it inserts a
6019 message to that effect instead of signaling an error."
6022 ;; Simulate the message printed by `ls'.
6026 "Functions to call with no arguments to query about killing Emacs.
6027 If any of these functions returns nil, killing Emacs is cancelled.
6028 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6032 "How to ask for confirmation when leaving Emacs.
6033 If nil, the default, don't ask at all. If the value is non-nil, it should
6034 be a predicate function such as `yes-or-no-p'."
6042 "Offer to save each buffer, then kill this Emacs process.
6043 With prefix ARG, silently save all file-visiting buffers, then kill."
6052 ;; process-list is not defined on MSDOS.
6054 active)
6063 ;; Query the user for other things, perhaps.
6070 "Offer to save each buffer, then kill the current connection.
6071 If the current frame has no client, kill Emacs itself.
6073 With prefix ARG, silently save all file-visiting buffers, then kill.
6075 If emacsclient was started with a list of filenames to edit, then
6076 only these files will be asked to be saved."
6081 \f
6082 ;; We use /: as a prefix to "quote" a file name
6083 ;; so that magic file name handlers will not apply to it.
6087 file-name-handler-alist))
6089 ;; We depend on being the last handler on the list,
6090 ;; so that anything else which does need handling
6091 ;; has been handled already.
6092 ;; So it is safe for us to inhibit *all* magic file name handlers.
6101 default-directory))
6102 ;; Get a list of the indices of the args which are file names.
6105 ;; The first six are special because they
6106 ;; return a file name. We want to include the /:
6107 ;; in the return value.
6108 ;; So just avoid stripping it in the first place.
6115 ;; `identity' means just return the first arg
6116 ;; not stripped of its quoting.
6118 ;; `add' means add "/:" to the result.
6120 ;; `quote' means add "/:" to buffer-file-name.
6122 ;; `unquote-then-quote' means set buffer-file-name
6123 ;; temporarily to unquoted filename.
6125 ;; List the arguments which are filenames.
6133 ;; For all other operations, treat the first argument only
6134 ;; as the file name.
6136 method
6137 ;; Copy ARGUMENTS so we can replace elements in it.
6141 ;; Strip off the /: from the file names that have it.
6149 "/"
6165 res))
6168 \f
6169 ;; Symbolic modes and read-file-modes.
6172 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6173 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6174 Others, or All) for whom to produce the mask.
6175 The bit-mask that is returned extracts from mode bits the access rights
6176 for the specified category of users."
6184 "Convert CHAR to a numeric value of mode bits.
6185 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6186 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6193 ;; Rights relative to the previous file modes.
6204 "Convert a symbolic mode string specification to an equivalent number.
6206 WHO-MASK is the bit-mask specifying the category of users to which to
6207 apply the access permissions. See `file-modes-char-to-who'.
6208 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6209 RIGHTS request to add, remove, or set permissions based on existing ones,
6216 char-right)
6223 num-rights
6227 op char-right)))
6228 num-rights))
6231 "Convert symbolic file modes to numeric file modes.
6232 MODES is the string to convert, it should match
6235 notation.
6236 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6237 MODES request to add, remove, or set permissions based on existing ones,
6251 num-who num-modes)
6254 num-modes)))
6257 "Read file modes in octal or symbolic notation and return its numeric value.
6258 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6259 ORIG-FILE is the name of a file on whose mode bits to base returned
6260 permissions if what user types requests to add, remove, or set permissions
6276 nil nil default)))
6282 \f
6283 ;; Trashcan handling.
6285 "Directory for `move-file-to-trash' to move files and directories to.
6286 This directory is only used when the function `system-move-file-to-trash'
6287 is not defined.
6288 Relative paths are interpreted relative to `default-directory'.
6289 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6299 "Move the file (or directory) named FILENAME to the trash.
6300 When `delete-by-moving-to-trash' is non-nil, this function is
6301 called by `delete-file' and `delete-directory' instead of
6302 deleting files outright.
6304 If the function `system-move-file-to-trash' is defined, call it
6305 with FILENAME as an argument.
6306 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6307 directory.
6308 Otherwise, trash FILENAME using the freedesktop.org conventions,
6309 like the GNOME, KDE and XFCE desktop environments. Emacs only
6313 ;; If `trash-directory' is non-nil, move the file there.
6317 trash-dir)))
6318 ;; We can't trash a parent directory of trash-directory.
6321 trash-dir filename))
6324 ;; Ensure that the trashed file-name is unique.
6331 ;; If `system-move-file-to-trash' is defined, use it.
6334 ;; Otherwise, use the freedesktop.org method, as specified at
6335 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6346 ;; Check if we have permissions to delete.
6350 ;; The trashed file cannot be the trash dir or its parent.
6353 trash-files-dir filename))
6356 trash-info-dir filename))
6358 ;; Ensure that the trash directory exists; otherwise, create it.
6367 ;; Try to move to trash with .trashinfo undo information
6372 ;; Perform url-encoding on FN. For compatibility with
6373 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6374 ;; for path separators.
6379 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6380 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6393 fn))
6398 ;; Attempt to make .trashinfo file, trying up to 5
6399 ;; times. The .trashinfo file is opened with O_EXCL,
6400 ;; as per trash-spec 0.7, even if that can be a problem
6401 ;; on old NFS versions...
6405 trash-files-dir))
6407 success info-fn)
6412 trash-info-dir))
6420 ;; Uniqify new-fn. (Some file managers do not
6421 ;; like Emacs-style backup file names---e.g. bug
6422 ;; 170956 in Konqueror bug tracker.)
6427 ;; Finally, try to move the file to the trashcan.
6431 \f
6456 ;;; files.el ends here