| blob | 0c5640d13a406101ce3bf96f44ff31813bd44eb5 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
5 ;; 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
62 FROM and TO should be equivalent names, which refer to the
63 same directory. Do not use `~' in the TO strings;
64 they should be ordinary absolute directory names.
66 Use this feature when you have directories which you normally refer to
67 via absolute symbolic links. Make TO the name of the link, and FROM
68 the name it is linked to."
77 "Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
106 "Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
112 "Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
119 "Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
129 "Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
141 "Predicate that looks at a file name and decides whether to make backups.
145 "Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
153 "Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
160 "Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
168 "Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
193 "The directory for writing small temporary files.
194 If non-nil, this directory is used instead of `temporary-file-directory'
195 by programs that create small temporary files. This is for systems that
196 have fast storage with limited space, such as a RAM disk."
201 ;; The system null device. (Should reference NULL_DEVICE from C.)
229 "Non-nil means protect against I/O errors while saving files.
230 Some modes set this non-nil in particular buffers.
232 This feature works by writing the new contents into a temporary file
233 and then renaming the temporary file to replace the original.
234 In this way, any I/O error in writing leaves the original untouched,
235 and there is never any instant where the file is nonexistent.
237 Note that this feature forces backups to be made by copying.
238 Yet, at the same time, saving a precious file
239 breaks any hard links between it and other files.
241 This feature is advisory: for example, if the directory in which the
242 file is being saved is not writable, Emacs may ignore a non-nil value
243 of `file-precious-flag' and write directly into the file.
245 See also: `break-hardlink-on-save'."
250 "Non-nil means when saving a file that exists under several names
251 \(i.e., has multiple hardlinks), break the hardlink associated with
252 `buffer-file-name' and write to a new file, so that the other
253 instances of the file are not affected by the save.
255 If `buffer-file-name' refers to a symlink, do not break the symlink.
257 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
258 For example, if the directory in which a file is being saved is not
259 itself writable, then error instead of saving in some
260 hardlink-nonbreaking way.
262 See also `backup-by-copying' and `backup-by-copying-when-linked'."
268 "Control use of version numbers for backup files.
269 When t, make numeric backup versions unconditionally.
270 When nil, make them for files that have some already.
271 The value `never' means do not make them."
281 "When cleaning directory, number of versions to keep."
287 "If t, delete excess backup versions silently.
288 If nil, ask confirmation. Any other value prevents any trimming."
295 "Number of oldest versions to keep when a new numbered backup is made."
301 "Number of newest versions to keep when a new numbered backup is made.
302 Includes the new backup. Must be > 0"
308 "Whether to add a newline automatically at the end of the file.
310 A value of t means do this only when the file is about to be saved.
311 A value of `visit' means do this right after the file is visited.
312 A value of `visit-save' means do it at both of those times.
313 Any other non-nil value means ask user whether to add a newline, when saving.
314 A value of nil means don't add newlines.
316 Certain major modes set this locally to the value obtained
317 from `mode-require-final-newline'."
326 "Whether to add a newline at end of file, in certain major modes.
327 Those modes set `require-final-newline' to this value when you enable them.
328 They do so because they are often used for files that are supposed
329 to end in newlines, and the question is how to arrange that.
331 A value of t means do this only when the file is about to be saved.
332 A value of `visit' means do this right after the file is visited.
333 A value of `visit-save' means do it at both of those times.
334 Any other non-nil value means ask user whether to add a newline, when saving.
336 A value of nil means do not add newlines. That is a risky choice in this
337 variable since this value is used for modes for files that ought to have
338 final newlines. So if you set this to nil, you must explicitly check and
339 add a final newline, whenever you save a file that really needs one."
349 "Non-nil says by default do auto-saving of every file-visiting buffer."
355 ;; Don't put "\\2" inside expand-file-name, since it will be
356 ;; transformed to "/2" on DOS/Windows.
358 "Transforms to apply to buffer file name before making auto-save file name.
359 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
360 REGEXP is a regular expression to match against the file name.
361 If it matches, `replace-match' is used to replace the
362 matching part with REPLACEMENT.
363 If the optional element UNIQUIFY is non-nil, the auto-save file name is
364 constructed by taking the directory part of the replaced file-name,
365 concatenated with the buffer file name with all directory separators
366 changed to `!' to prevent clashes. This will not work
367 correctly if your filesystem truncates the resulting name.
369 All the transforms in the list are tried, in the order they are listed.
370 When one transform applies, its result is final;
371 no further transforms are tried.
373 The default value is set up to put the auto-save file into the
374 temporary directory (see the variable `temporary-file-directory') for
375 editing a remote file.
377 On MS-DOS filesystems without long names this variable is always
378 ignored."
386 "Non-nil means save word abbrevs too when files are saved.
387 If `silently', don't ask the user before saving."
392 "Non-nil means allow `find-file' to visit directories.
393 To visit the directory, `find-file' runs `find-directory-functions'."
398 "List of functions to try in sequence to visit a directory.
399 Each function is called with the directory name as the sole argument
400 and should return either a buffer or nil."
404 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
406 "List of functions to try in sequence to get a file name at point.
407 Each function should return either nil or a file name found at the
408 location of point in the current buffer."
412 ;;;It is not useful to make this a local variable.
413 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
415 "List of functions to be called for `find-file' on nonexistent file.
416 These functions are called as soon as the error is detected.
417 Variable `buffer-file-name' is already set up.
422 ;;;It is not useful to make this a local variable.
423 ;;;(put 'find-file-hooks 'permanent-local t)
426 "List of functions to be called after a buffer is loaded from a file.
427 The buffer's local variables (if any) will have been processed before the
428 functions are called."
435 "List of functions to be called before writing out a buffer to a file.
436 If one of them returns non-nil, the file is considered already written
437 and the rest are not called.
438 These hooks are considered to pertain to the visited file.
439 So any buffer-local binding of this variable is discarded if you change
441 change the major mode.
443 This hook is not run if any of the functions in
444 `write-contents-functions' returns non-nil. Both hooks pertain
445 to how to save a buffer to file, for instance, choosing a suitable
446 coding system and setting mode bits. (See Info
447 node `(elisp)Saving Buffers'.) To perform various checks or
458 "List of functions to be called before writing out a buffer to a file.
459 If one of them returns non-nil, the file is considered already written
460 and the rest are not called and neither are the functions in
461 `write-file-functions'.
463 This variable is meant to be used for hooks that pertain to the
464 buffer's contents, not to the particular visited file; thus,
465 `set-visited-file-name' does not clear this variable; but changing the
466 major mode does clear it.
468 For hooks that _do_ pertain to the particular visited file, use
469 `write-file-functions'. Both this variable and
470 `write-file-functions' relate to how a buffer is saved to file.
471 To perform various checks or updates before the buffer is saved,
478 "Control use of local variables in files you visit.
479 The value can be t, nil, :safe, :all, or something else.
481 A value of t means file local variables specifications are obeyed
482 if all the specified variable values are safe; if any values are
483 not safe, Emacs queries you, once, whether to set them all.
484 \(When you say yes to certain values, they are remembered as safe.)
486 :safe means set the safe variables, and ignore the rest.
487 :all means set all variables, whether safe or not.
488 (Don't set it permanently to :all.)
489 A value of nil means always ignore the file local variables.
491 Any other value means always query you once whether to set them all.
492 \(When you say yes to certain values, they are remembered as safe, but
495 This variable also controls use of major modes specified in
496 a -*- line.
499 always obeys file local variable specifications and the -*- line,
500 and ignores this variable."
501 :risky t
510 "Like `enable-local-variables' but meant for buffer-local bindings.
511 The meaningful values are nil and non-nil. The default is non-nil.
512 If a major mode sets this to nil, buffer-locally, then any local
513 variables list in the file will be ignored.
515 This variable does not affect the use of major modes
520 The value can be t, nil or something else.
521 A value of t means obey `eval' variables.
522 A value of nil means ignore them; anything else means query."
523 :risky t
529 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
538 "Non-nil means buffers visiting files read-only do so in view mode.
539 In fact, this means that all read-only buffers normally have
540 View mode enabled, including buffers that are read-only because
541 you visit a file you cannot alter, and buffers you make read-only
547 "History list of file names entered in the minibuffer.
549 Maximum length of the history list is determined by the value
551 \f
554 "Provides support for ange-ftp host name completion.
555 Runs the usual ange-ftp hook, but only for completion operations."
556 ;; Having this here avoids the need to load ange-ftp when it's not
557 ;; really in use.
563 inhibit-file-name-handlers)))
571 "Convert a standard file's name to something suitable for the OS.
572 This means to guarantee valid names and perhaps to canonicalize
573 certain patterns.
575 FILENAME should be an absolute file name since the conversion rules
576 sometimes vary depending on the position in the file name. E.g. c:/foo
577 is a valid DOS file name, but c:/bar/c:/foo is not.
579 This function's standard definition is trivial; it just returns
580 the argument. However, on Windows and DOS, replace invalid
581 characters. On DOS, make sure to obey the 8.3 limitations.
582 In the native Windows build, turn Cygwin names into native names,
583 and also turn slashes into backslashes if the shell requires it (see
584 `w32-shell-dos-semantics').
586 See Info node `(elisp)Standard File Names' for more details."
591 ;; Replace invalid filename characters with !
595 name))
603 "Read directory name, prompting with PROMPT and completing in directory DIR.
604 Value is not expanded---you must call `expand-file-name' yourself.
605 Default name to DEFAULT-DIRNAME if user exits with the same
606 non-empty string that was inserted by this function.
607 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
608 or just DIR if INITIAL is nil.)
609 If the user exits with an empty minibuffer, this function returns
610 an empty string. (This can only happen if the user erased the
611 pre-inserted contents or if `insert-default-directory' is nil.)
612 Fourth arg MUSTMATCH non-nil means require existing directory's name.
613 Non-nil and non-t means also require confirmation after completion.
614 Fifth arg INITIAL specifies text to start with.
615 DIR should be an absolute directory name. It defaults to
616 the value of `default-directory'."
621 dir))
622 mustmatch initial
625 \f
627 "Show the current default directory."
632 "Value of the CDPATH environment variable, as a list.
636 "Explode a search path into a list of directory names.
637 Directories are separated by occurrences of `path-separator'
638 \(which is colon in GNU and GNU-like systems)."
639 ;; We could use split-string here.
647 nil
652 cd-list)))
655 "Change current directory to given absolute file name DIR."
656 ;; Put the name into directory syntax now,
657 ;; because otherwise expand-file-name may give some bad results.
659 ;; We used to additionally call abbreviate-file-name here, for an
660 ;; unknown reason. Problem is that most buffers are setup
661 ;; without going through cd-absolute and don't call
662 ;; abbreviate-file-name on their default-directory, so the few that
663 ;; do end up using a superficially different directory.
675 "Make DIR become the current buffer's default directory.
676 If your environment includes a `CDPATH' variable, try each one of
677 that list of directories (separated by occurrences of
678 `path-separator') when resolving a relative directory name.
679 The path separator is colon in GNU and GNU-like systems."
682 default-directory default-directory
698 cd-path)
699 nil))
703 "Load the Lisp file named FILE."
704 ;; This is a case where .elc makes a lot of sense.
711 "Search for FILENAME through PATH.
712 If found, return the absolute file name of FILENAME, with its suffixes;
713 otherwise return nil.
714 PATH should be a list of directories to look in, like the lists in
715 `exec-path' or `load-path'.
716 If SUFFIXES is non-nil, it should be a list of suffixes to append to
719 If non-nil, PREDICATE is used instead of `file-readable-p'.
720 PREDICATE can also be an integer to pass to the `access' system call,
721 in which case file-name handlers are ignored. This usage is deprecated.
723 For compatibility, PREDICATE can also be one of the symbols
724 `executable', `readable', `writable', or `exists', or a list of
725 one or more of those symbols."
736 "Do completion for file names passed to `locate-file'."
739 ;; FIXME: maybe we should use completion-file-name-table instead,
740 ;; tho at least for `load', the arg is passed through
741 ;; substitute-in-file-name for historical reasons.
751 ;; If we have files like "foo.el" and "foo.elc", we could load one of
752 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
753 ;; preferred way. So if we list all 3, that gives a lot of redundant
754 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
755 ;; the user does want to pay attention to the extension. We try to
756 ;; diffuse this tension by stripping the suffix, except when the
757 ;; result is a single element (i.e. usually we only list "foo" unless
758 ;; it's the only remaining element in the list, in which case we do
759 ;; list "foo", "foo.elc" and "foo.el").
770 string-file dir))
775 ;; Switching from names to names+fullnames creates a non-monotonicity
776 ;; which can cause problems with things like partial-completion.
777 ;; To minimize the problem, filter out completion-regexp-list, so that
778 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
779 ;; from `names' which only matched `string' when they still had
780 ;; their suffix.
782 ;; Remove duplicates of the first element, so that we can easily check
783 ;; if `names' really only contains a single element.
786 ;; There's no more than one matching non-suffixed element, so expand
787 ;; the list by adding the suffixed elements as well.
790 string-dir names string-file pred action)))))
793 "Do completion for file names passed to `locate-file'.
794 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
797 string nil action))
802 "Regexp of directory names which stop the search in `locate-dominating-file'.
803 Any directory whose name matches this regexp will be treated like
804 a kind of root directory by `locate-dominating-file' which will stop its search
805 when it bumps into it.
806 The default regexp prevents fruitless and time-consuming attempts to find
807 special files in directories in which filenames are interpreted as hostnames,
810 ;; (defun locate-dominating-files (file regexp)
811 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
812 ;; Stop at the first parent where a matching file is found and return the list
813 ;; of files that that match in this directory."
814 ;; (catch 'found
815 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
816 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
817 ;; (let ((user nil)
818 ;; ;; Abbreviate, so as to stop when we cross ~/.
819 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
820 ;; files)
821 ;; (while (and dir
822 ;; ;; As a heuristic, we stop looking up the hierarchy of
823 ;; ;; directories as soon as we find a directory belonging to
824 ;; ;; another user. This should save us from looking in
825 ;; ;; things like /net and /afs. This assumes that all the
826 ;; ;; files inside a project belong to the same user.
827 ;; (let ((prev-user user))
828 ;; (setq user (nth 2 (file-attributes dir)))
829 ;; (or (null prev-user) (equal user prev-user))))
830 ;; (if (setq files (condition-case nil
831 ;; (directory-files dir 'full regexp 'nosort)
832 ;; (error nil)))
833 ;; (throw 'found files)
834 ;; (if (equal dir
835 ;; (setq dir (file-name-directory
836 ;; (directory-file-name dir))))
837 ;; (setq dir nil))))
838 ;; nil)))
841 "Look up the directory hierarchy from FILE for a file named NAME.
842 Stop at the first parent directory containing a file NAME,
843 and return the directory. Return nil if not found."
844 ;; We used to use the above locate-dominating-files code, but the
845 ;; directory-files call is very costly, so we're much better off doing
846 ;; multiple calls using the code in here.
847 ;;
848 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
849 ;; `name' in /home or in /.
853 ;; `user' is not initialized outside the loop because
854 ;; `file' may not exist, so we may have to walk up part of the
855 ;; hierarchy before we find the "initial UID".
857 try)
860 ;; FIXME: Disabled this heuristic because it is sometimes
861 ;; inappropriate.
862 ;; As a heuristic, we stop looking up the hierarchy of
863 ;; directories as soon as we find a directory belonging
864 ;; to another user. This should save us from looking in
865 ;; things like /net and /afs. This assumes that all the
866 ;; files inside a project belong to the same user.
867 ;; (let ((prev-user user))
868 ;; (setq user (nth 2 (file-attributes file)))
869 ;; (and prev-user (not (equal user prev-user))))
877 root))
881 "Search for COMMAND in `exec-path' and return the absolute file name.
882 Return nil if COMMAND is not found anywhere in `exec-path'."
883 ;; Use 1 rather than file-executable-p to better match the behavior of
884 ;; call-process.
888 "Load the Emacs Lisp library named LIBRARY.
889 This is an interface to the function `load'. LIBRARY is searched
890 for in `load-path', both with and without `load-suffixes' (as
891 well as `load-file-rep-suffixes').
893 See Info node `(emacs)Lisp Libraries' for more details.
894 See `load-file' for a different interface to `load'."
898 load-path
903 "Test whether FILE specifies a location on a remote system.
904 Returns nil or a string identifying the remote connection (ideally
905 a prefix of FILE). For example, the remote identification for filename
908 less reliable than accessing local files.
909 Furthermore, relative file names do not work across remote connections.
911 IDENTIFICATION specifies which part of the identification shall
912 be returned as string. IDENTIFICATION can be the symbol
913 `method', `user', `host' or `localname'; any other value is
914 handled like nil and means to return the complete identification
915 string.
917 If CONNECTED is non-nil, the function returns an identification only
918 if FILE is located on a remote system, and a connection is established
919 to that remote system.
921 `file-remote-p' will never open a connection on its own."
925 nil)))
928 "Whether to use the remote file-name cache for read access.
930 When `nil', always use the cached values.
931 When `t', never use them.
932 A number means use them for that amount of seconds since they were
933 cached.
935 File attributes of remote files are cached for better performance.
936 If they are changed out of Emacs' control, the cached values
937 become invalid, and must be invalidated.
939 In case a remote file is checked regularly, it might be
940 reasonable to let-bind this variable to a value less then the
941 time period between two checks.
942 Example:
944 \(defun display-time-file-nonempty-p \(file)
945 \(let \(\(remote-file-name-inhibit-cache \(- display-time-interval 5)))
946 \(and \(file-exists-p file)
947 \(< 0 \(nth 7 \(file-attributes \(file-chase-links file)))))))"
958 "Copy the file FILE into a temporary file on this machine.
959 Returns the name of the local copy, or nil, if FILE is directly
960 accessible."
961 ;; This formerly had an optional BUFFER argument that wasn't used by
962 ;; anything.
966 nil)))
969 "Return the truename of FILENAME, which should be absolute.
970 The truename of a file name is found by chasing symbolic links
971 both at the level of the file and at the level of the directories
972 containing it, until no links are left at any level.
975 ;; COUNTER and PREV-DIRS are only used in recursive calls.
976 ;; COUNTER can be a cons cell whose car is the count of how many
977 ;; more links to chase before getting an error.
978 ;; PREV-DIRS can be a cons cell whose car is an alist
979 ;; of truenames we've just recently computed.
993 ;; For speed, remove the ange-ftp completion handler from the list.
994 ;; We know it's not needed here.
995 ;; For even more speed, do this only on the outermost call.
1002 ;; andrewi@harlequin.co.uk - none of the following code (except for
1003 ;; invoking the file-name handler) currently applies on Windows
1004 ;; (ie. there are no native symlinks), but there is an issue with
1005 ;; case differences being ignored by the OS, and short "8.3 DOS"
1006 ;; name aliases existing for all files. (The short names are not
1007 ;; reported by directory-files, but can be used to refer to files.)
1008 ;; It seems appropriate for file-truename to resolve these issues in
1009 ;; the most natural way, which on Windows is to call the function
1010 ;; `w32-long-file-name' - this returns the exact name of a file as
1011 ;; it is stored on disk (expanding short name aliases with the full
1012 ;; name in the process).
1015 ;; For file name that has a special handler, call handler.
1016 ;; This is so that ange-ftp can save time by doing a no-op.
1019 ;; If filename contains a wildcard, newname will be the old name.
1021 ;; If filename exists, use the long name. If it doesn't exist,
1022 ;; drill down until we find a directory that exists, and use
1023 ;; the long name of that, with the extra non-existent path
1024 ;; components concatenated.
1026 missing rest)
1029 ;; Include the preceding directory separator in the missing
1030 ;; part so subsequent recursion on the rest works.
1035 ""
1040 ;; If this file directly leads to a link, process that iteratively
1041 ;; so that we don't use lots of stack.
1047 ;; For file name that has a special handler, call handler.
1048 ;; This is so that ange-ftp can save time by doing a no-op.
1051 done t)
1053 target dirfile)
1054 ;; Get the truename of the directory.
1056 ;; If these are equal, we have the (or a) root directory.
1058 ;; If this is the same dir we last got the truename for,
1059 ;; save time--don't recalculate.
1069 done t)
1072 done t)
1073 ;; Put it back on the file name.
1075 ;; Is the file name the name of a link?
1078 ;; Yes => chase that link, then start all over
1079 ;; since the link may point to a directory name that uses links.
1080 ;; We can't safely use expand-file-name here
1081 ;; since target might look like foo/../bar where foo
1082 ;; is itself a link. Instead, we handle . and .. above.
1085 target
1087 done nil)
1088 ;; No, we are done!
1090 filename))
1093 "Chase links in FILENAME until a name that is not a link.
1094 Unlike `file-truename', this does not check whether a parent
1095 directory name is a symbolic link.
1096 If the optional argument LIMIT is a number,
1097 it means chase no more than that many links and then stop."
1105 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1108 ;; Handle `..' by hand, since it needs to work in the
1109 ;; target of any directory symlink.
1110 ;; This code is not quite complete; it does not handle
1111 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1115 ;; Chase links in the default dir of the symlink.
1119 ;; Now find the parent of that dir.
1123 newname))
1126 "Create a temporary file.
1127 The returned file name (created by appending some random characters at the end
1128 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1129 is guaranteed to point to a newly created empty file.
1130 You can then use `write-region' to write new data into the file.
1132 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1134 If SUFFIX is non-nil, add that at the end of the file name."
1136 file)
1139 ;; Create temp files with strict access rights. It's easy to
1140 ;; loosen them later, whereas it's impossible to close the
1141 ;; time-window of loose permissions otherwise.
1149 temporary-file-directory)
1151 temporary-file-directory))))
1157 nil)
1159 ;; the file was somehow created by someone else between
1160 ;; `make-temp-name' and `write-region', let's try again.
1161 nil)
1162 file)
1163 ;; Reset the umask.
1167 "Change the encoding of FILE's name from CODING to NEW-CODING.
1168 The value is a new name of FILE.
1169 Signals a `file-already-exists' error if a file of the new name
1170 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1171 is non-nil. A number as fourth arg means request confirmation if
1172 the new name already exists. This is what happens in interactive
1173 use with M-x."
1176 default-file-name-coding-system))
1178 from-coding to-coding)
1180 ;; We provide the default coding only when it seems that
1181 ;; the filename is correctly decoded by the default
1182 ;; coding.
1188 filename default-coding)
1189 default-coding))
1193 ;; We provide the default coding only when a user is going to
1194 ;; change the encoding not from the default coding.
1198 filename from-coding)))
1201 filename from-coding default-coding)
1202 default-coding)))
1206 default-file-name-coding-system))
1207 ;; FILE should have been decoded by DEFAULT-CODING.
1211 ;; Suppress further encoding.
1216 newname))
1217 \f
1219 "Whether confirmation is requested before visiting a new file or buffer.
1220 If nil, confirmation is not requested.
1221 If the value is `after-completion', confirmation is only
1222 requested if the user called `minibuffer-complete' right before
1223 `minibuffer-complete-and-exit'.
1224 Any other non-nil value means to request confirmation.
1226 This affects commands like `switch-to-buffer' and `find-file'."
1234 "Whether to request confirmation before visiting a new file or buffer.
1235 The variable `confirm-nonexistent-file-or-buffer' determines the
1236 return value, which may be passed as the REQUIRE-MATCH arg to
1237 `read-buffer' or `find-file-read-args'."
1245 "Read the name of a buffer to switch to and return as a string.
1246 It is intended for `switch-to-buffer' family of commands since they
1247 need to omit the name of current buffer from the list of completions
1248 and default values."
1253 ;; Since rbts-completion-table is built dynamically, we
1254 ;; can't just add it to the default value of
1255 ;; icomplete-with-completion-tables, so we add it
1256 ;; here manually.
1261 icomplete-with-completion-tables))))
1266 "Select the buffer specified by BUFFER-OR-NAME in another window.
1267 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1268 nil. Return the buffer switched to.
1270 If called interactively, prompt for the buffer name using the
1271 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1272 determines whether to request confirmation before creating a new
1273 buffer.
1275 If BUFFER-OR-NAME is a string and does not identify an existing
1276 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1277 nil, switch to the buffer returned by `other-buffer'.
1279 Optional second argument NORECORD non-nil means do not put this
1280 buffer at the front of the list of recently selected ones.
1282 This uses the function `display-buffer' as a subroutine; see its
1283 documentation for additional customization information."
1287 same-window-buffer-names same-window-regexps)
1291 "Switch to buffer BUFFER-OR-NAME in another frame.
1292 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1293 nil. Return the buffer switched to.
1295 If called interactively, prompt for the buffer name using the
1296 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1297 determines whether to request confirmation before creating a new
1298 buffer.
1300 If BUFFER-OR-NAME is a string and does not identify an existing
1301 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1302 nil, switch to the buffer returned by `other-buffer'.
1304 Optional second arg NORECORD non-nil means do not put this
1305 buffer at the front of the list of recently selected ones.
1307 This uses the function `display-buffer' as a subroutine; see its
1308 documentation for additional customization information."
1312 same-window-buffer-names same-window-regexps)
1316 "Display buffer BUFFER in another frame.
1317 This uses the function `display-buffer' as a subroutine; see
1318 its documentation for additional customization information."
1321 same-window-buffer-names same-window-regexps
1323 new-window)
1325 ;; This may have been here in order to prevent the new frame from hiding
1326 ;; the old frame. But it does more harm than good.
1327 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1328 ;;(lower-frame (window-frame new-window))
1330 ;; This may have been here in order to make sure the old-frame gets the
1331 ;; focus. But not only can it cause an annoying flicker, with some
1332 ;; window-managers it just makes the window invisible, with no easy
1333 ;; way to recover it. --Stef
1334 ;;(make-frame-invisible (window-frame old-window))
1335 ;;(make-frame-visible (window-frame old-window))
1336 ))
1339 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1340 BODY should use the minibuffer at most once.
1341 Recursive uses of the minibuffer are unaffected (FUN is not
1342 called additional times).
1344 This macro actually adds an auxiliary function that calls FUN,
1345 rather than FUN itself, to `minibuffer-setup-hook'."
1351 ;; Clear out this hook so it does not interfere
1352 ;; with any recursive minibuffer usage.
1363 t))
1366 "Edit file FILENAME.
1367 Switch to a buffer visiting file FILENAME,
1368 creating one if none already exists.
1369 Interactively, the default if you just type RET is the current directory,
1370 but the visited file name is available through the minibuffer history:
1371 type M-n to pull it into the minibuffer.
1373 You can visit files on remote machines by specifying something
1374 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1375 also visit local files as a different user by specifying
1376 /sudo::FILE for the file name.
1377 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1378 manual, for more about this.
1380 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1381 expand wildcards (if any) and visit multiple files. You can
1382 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1384 To visit a file without any kind of conversion and without
1395 "Edit file FILENAME, in another window.
1398 an existing one. See the function `display-buffer'.
1400 Interactively, the default if you just type RET is the current directory,
1401 but the visited file name is available through the minibuffer history:
1402 type M-n to pull it into the minibuffer.
1404 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1405 expand wildcards (if any) and visit multiple files."
1418 "Edit file FILENAME, in another frame.
1421 an existing one. See the function `display-buffer'.
1423 Interactively, the default if you just type RET is the current directory,
1424 but the visited file name is available through the minibuffer history:
1425 type M-n to pull it into the minibuffer.
1427 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1428 expand wildcards (if any) and visit multiple files."
1441 "Edit the existing file FILENAME.
1443 file names with wildcards."
1452 "Edit file FILENAME but don't allow changes.
1466 value))
1469 "Edit file FILENAME in another window but don't allow changes.
1483 value))
1486 "Edit file FILENAME in another frame but don't allow changes.
1500 value))
1503 "Find file FILENAME as a replacement for the file in the next window.
1504 This command does not select that window.
1508 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1509 expand wildcards (if any) and replace the file with multiple files."
1520 "Find alternate file: " file-dir nil
1522 t))))
1530 "Find file FILENAME, select its buffer, kill previous buffer.
1531 If the current buffer now contains an empty file that you just visited
1532 \(presumably by mistake), use this command to visit the file you really want.
1536 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1537 expand wildcards (if any) and replace the file with multiple files.
1539 If the current buffer is an indirect buffer, or the base buffer
1540 for one or more indirect buffers, the other buffer(s) are not
1541 killed."
1550 "Find alternate file: " file-dir nil
1552 t)))
1567 ;; Run `kill-buffer-hook' here. It needs to happen before
1568 ;; variables like `buffer-file-name' etc are set to nil below,
1569 ;; because some of the hooks that could be invoked
1570 ;; (e.g., `save-place-to-alist') depend on those variables.
1571 ;;
1572 ;; Note that `kill-buffer-hook' is not what queries whether to
1573 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1574 ;; asks that itself. Thus, there's no need to temporarily do
1575 ;; `(set-buffer-modified-p nil)' before running this hook.
1577 ;; Okay, now we can end-of-life the old buffer.
1584 ;; This prevents us from finding the same buffer
1585 ;; if we specified the same file again.
1589 ;; Likewise for dired buffers.
1593 ;; This executes if find-file gets an error
1594 ;; and does not really find anything.
1595 ;; We put things back as they were.
1596 ;; If find-file actually finds something, we kill obuf below.
1605 ;; We already ran these; don't run them again.
1608 \f
1610 "Create a suitably named buffer for visiting FILENAME, and return it.
1611 FILENAME (sans directory) is used unchanged if that name is free;
1612 otherwise a string <2> or <3> or ... is appended to get an unused name.
1613 Spaces at the start of FILENAME (sans directory) are removed."
1622 "Create and return a buffer with a name based on NAME.
1623 Choose the buffer's name using `generate-new-buffer-name'."
1627 "Regexp to match the automounter prefix in a directory name."
1635 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1637 home directory is a root directory) and removes automounter prefixes
1638 \(see the variable `automount-dir-prefix')."
1639 ;; Get rid of the prefixes added by the automounter.
1646 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1647 ;; To fix this right, we need a `file-name-case-sensitive-p'
1648 ;; function, but we don't have that yet, so just guess.
1651 ;; If any elt of directory-abbrev-alist matches this name,
1652 ;; abbreviate accordingly.
1658 ;; Compute and save the abbreviated homedir name.
1659 ;; We defer computing this until the first time it's needed, to
1660 ;; give time for directory-abbrev-alist to be set properly.
1661 ;; We include a slash at the end, to avoid spurious matches
1662 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1669 ;; If FILENAME starts with the abbreviated homedir,
1670 ;; make it start with `~' instead.
1672 ;; If the home dir is just /, don't change it.
1675 ;; MS-DOS root directories can come with a drive letter;
1676 ;; Novell Netware allows drive letters beyond `Z:'.
1684 filename)))
1687 "List of logical names for which visiting shouldn't save the true dirname."
1692 "Return the buffer visiting file FILENAME (a string).
1693 This is like `get-file-buffer', except that it checks for any buffer
1694 visiting the same file, possibly under a different name.
1695 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1696 and others are ignored.
1697 If there is no such live buffer, return nil."
1710 found)
1720 ;; Verify this buffer's file number
1721 ;; still belongs to its file.
1724 attributes)
1728 found))))
1729 \f
1731 "Non-nil means file-visiting commands should handle wildcards.
1732 For example, if you specify `*.c', that would visit all the files
1733 whose names match the pattern."
1739 "Non-nil means suppress warning messages for symlinked files.
1740 When nil, Emacs prints a warning when visiting a file that is already
1741 visited, but with a different name. Setting this option to t
1742 suppresses this warning."
1748 "Maximum size of file above which a confirmation is requested.
1749 When nil, never request confirmation."
1756 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1757 OP-TYPE specifies the file operation being performed (for message to user)."
1767 "Read file FILENAME into a buffer and return the buffer.
1768 If a buffer exists visiting FILENAME, return that one, but
1769 verify that the file has not changed since visited or saved.
1770 The buffer is not selected, just returned to the caller.
1771 Optional second arg NOWARN non-nil means suppress any warning messages.
1772 Optional third arg RAWFILE non-nil means the file is read literally.
1773 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1774 and visit all the matching files. When wildcards are actually
1775 used and expanded, return a list of buffers that are visiting
1776 the various files."
1783 'find-directory-functions
1786 filename)))
1789 find-file-wildcards
1803 ;; Find any buffer for a file which has same truename.
1805 ;; Let user know if there is a buffer with the same truename.
1809 find-file-suppress-same-file-warnings
1813 ;; Optionally also find that buffer.
1816 ;; Check to see if the file looks uncommonly large.
1820 ;; We are using an existing buffer.
1827 ;; Certain files should be reverted automatically
1828 ;; if they have changed on disk and not in the buffer.
1836 found))
1846 "File %s changed on disk. Discard your edits? "
1851 "File %s changed on disk. Discard your edits in %s? "
1859 ;; Check if a formerly read-only file has become
1860 ;; writable and vice versa, but if the buffer agrees
1861 ;; with the new state of the file, that is ok too.
1869 buffer-file-name
1878 ;; It is confusing to ask whether to visit
1879 ;; non-literally if they have the file in
1880 ;; hexl-mode.
1886 "The file %s is already visited normally,
1887 and you have edited the buffer. Now you have asked to visit it literally,
1888 meaning no coding system handling, format conversion, or local variables.
1889 Emacs can only visit a file in one way at a time.
1891 Do you want to save the file, and visit it literally instead? "
1892 "The file %s is already visited literally,
1893 meaning no coding system handling, format conversion, or local variables.
1894 You have edited the buffer. Now you have asked to visit the file normally,
1895 but Emacs can only visit a file in one way at a time.
1902 rawfile truename number))
1906 "\
1907 Do you want to discard your changes, and visit the file literally now? "
1908 "\
1911 rawfile truename number)
1917 "The file %s is already visited normally.
1918 You have asked to visit it literally,
1919 meaning no coding system decoding, format conversion, or local variables.
1920 But Emacs can only visit a file in one way at a time.
1922 Do you want to revisit the file literally now? "
1923 "The file %s is already visited literally,
1924 meaning no coding system decoding, format conversion, or local variables.
1925 You have asked to visit it normally,
1926 but Emacs can only visit a file in one way at a time.
1931 rawfile truename number)
1934 ;; Return the buffer we are using.
1935 buf)
1936 ;; Create a new buffer.
1938 ;; find-file-noselect-1 may use a different buffer.
1940 rawfile truename number))))))
1946 ;; Needed in case we are re-visiting the file with a different
1947 ;; text representation.
1964 filename)))
1965 ;; Unconditionally set error
1975 filename)))
1976 ;; Run find-file-not-found-functions until one returns non-nil.
1978 ;; If they fail too, set error.
1980 ;; Record the file's truename, and maybe use that as visited name.
1988 ;; Set buffer's default directory to that of the file.
1990 ;; Turn off backup files for certain file names. Since
1991 ;; this is a permanent local, the major mode won't eliminate it.
2006 \f
2008 "Like `insert-file-contents', but only reads in the file literally.
2009 A buffer may be modified in several ways after reading into the buffer,
2010 to Emacs features such as format decoding, character code
2011 conversion, `find-file-hook', automatic uncompression, etc.
2013 This function ensures that none of these modifications will take place."
2021 nil))
2024 inhibit-file-name-handlers))
2037 filename)))
2038 ;; Check whether the file is uncommonly large
2049 "Insert contents of file FILENAME into buffer after point with no conversion.
2051 This function is meant for the user to run interactively.
2052 Don't call it from programs! Use `insert-file-contents-literally' instead.
2053 \(Its calling sequence is different; see its documentation)."
2058 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2063 "Visit file FILENAME with no conversion of any kind.
2064 Format conversion and character code conversion are both disabled,
2065 and multibyte characters are disabled in the resulting buffer.
2066 The major mode used is Fundamental mode regardless of the file name,
2067 and local variable specifications in the file are ignored.
2068 Automatic uncompression and adding a newline at the end of the
2069 file due to `require-final-newline' is also disabled.
2071 You cannot absolutely rely on this function to result in
2072 visiting the file literally. If Emacs already has a buffer
2073 which is visiting the file, you get the existing buffer,
2074 regardless of whether it was created literally or not.
2076 In a Lisp program, if you want to be sure of accessing a file's
2077 contents literally, you should create a temporary buffer and then read
2078 the file contents into it using `insert-file-contents-literally'."
2081 "Find file literally: " nil default-directory
2084 \f
2088 after-find-file-from-revert-buffer
2089 nomodes)
2090 "Called after finding a file and by the default revert function.
2091 Sets buffer mode, parses local variables.
2092 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2093 error in reading the file. WARN non-nil means warn if there
2094 exists an auto-save file more recent than the visited file.
2095 NOAUTO means don't mess with auto-save mode.
2096 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2097 means this call was from `revert-buffer'.
2098 Fifth arg NOMODES non-nil means don't alter the file's modes.
2099 Finishes by calling the functions in `find-file-hook'
2100 unless NOMODES is non-nil."
2103 nil
2113 ;; No need to warn if buffer is auto-saved
2114 ;; under the name of the visited file.
2116 auto-save-visited-file-name))
2119 buffer-file-name))
2139 ;; Make people do a little extra work (C-x C-q)
2140 ;; before altering a backup file.
2143 ;; When a file is marked read-only,
2144 ;; make the buffer read-only even if root is looking at it.
2152 ;; If requested, add a newline at the end of the file.
2162 view-read-only
2168 "Eval BODY and turn any error into a FORMAT message.
2169 FORMAT can have a %s escape which will be replaced with the actual error.
2170 If `debug-on-error' is set, errors are not caught, so that you can
2171 debug them.
2172 Avoid using a large BODY since it is duplicated."
2181 "Choose the major mode for this buffer automatically.
2182 Also sets up any specified local variables of the file.
2183 Uses the visited file name, the -*- line, and the local variables spec.
2185 This function is called automatically from `find-file'. In that case,
2186 we may set up the file-specified mode and local variables,
2187 depending on the value of `enable-local-variables'.
2188 In addition, if `local-enable-local-variables' is nil, we do
2189 not set local variables (though we do notice a mode specified with -*-.)
2191 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2192 or from Lisp without specifying the optional argument FIND-FILE;
2193 in that case, this function acts as if `enable-local-variables' were t."
2201 ;; Turn font lock off and on, to make sure it takes account of
2202 ;; whatever file local variables are relevant to it.
2204 ;; Font-lock-mode (now in font-core.el) can be ON when
2205 ;; font-lock.el still hasn't been loaded.
2215 "Non-nil means to try second pass through `auto-mode-alist'.
2216 This means that if the first case-sensitive search through the alist fails
2217 to find a matching major mode, a second case-insensitive search is made.
2218 On systems with case-insensitive file names, this variable is ignored,
2219 since only a single case-insensitive search through the alist is made."
2225 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2226 ;; c++-mode, java-mode and more) are added through autoload
2227 ;; directives in that file. That way is discouraged since it
2228 ;; spreads out the definition of the initial value.
2272 ;; Less common extensions come here
2273 ;; so more common ones above are found faster.
2281 ;; Besides .gdbinit, gdb documents other names to be usable for init
2282 ;; files, cross-debuggers can use something like
2283 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2284 ;; don't interfere with each other.
2322 ;; The list of archive file extensions should be in sync with
2323 ;; `auto-coding-alist' with `no-conversion' coding system.
2329 ;; Mailer puts message to be edited in
2330 ;; /tmp/Re.... or Message
2333 ;; some news reader is reported to use this
2342 ;; .emacs or .gnus or .viper following a directory delimiter in
2343 ;; Unix, MSDOG or VMS syntax.
2346 ;; _emacs following a directory delimiter
2347 ;; in MsDos syntax
2351 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2352 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2353 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2356 ;; .xs is also used for ld scripts, but seems to be more commonly
2357 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2359 ;; Explained in binutils ld/genscripts.sh. Eg:
2360 ;; A .x script file is the default script.
2361 ;; A .xr script is for linking without relocation (-r flag). Etc.
2365 ;; Common Lisp ASDF package system.
2383 ;; Windows candidates may be opened case sensitively on Unix
2389 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2391 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2392 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2393 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2394 ;; this has lower priority to avoid matching changelog.sgml etc.
2396 ;; either user's dot-files or under /etc or some such
2398 ;; alas not all ~/.*rc files are like this
2399 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2404 ;; this contains everything twice, with space and with colon :-(
2406 ;; Get rid of any trailing .n.m and try again.
2407 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2408 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2409 ;; Using mode nil rather than `ignore' would let the search continue
2410 ;; through this list (with the shortened name) rather than start over.
2412 ;; The following should come after the ChangeLog pattern
2413 ;; for the sake of ChangeLog.1, etc.
2414 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2417 "Alist of filename patterns vs corresponding major mode functions.
2418 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2419 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2420 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2421 mode function to use. FUNCTION will be called, unless it is nil.
2423 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2424 calling FUNCTION (if it's not nil), we delete the suffix that matched
2425 REGEXP and search the list again for another match.
2427 If the file name matches `inhibit-first-line-modes-regexps',
2428 then `auto-mode-alist' is not processed.
2430 The extensions whose FUNCTION is `archive-mode' should also
2431 appear in `auto-coding-alist' with `no-conversion' coding system.
2433 See also `interpreter-mode-alist', which detects executable script modes
2434 based on the interpreters they specify to run,
2439 "Select Conf mode or XML mode according to start of file."
2449 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2450 ;; and pike-mode) are added through autoload directives in that
2451 ;; file. That way is discouraged since it spreads out the
2452 ;; definition of the initial value.
2491 "Alist mapping interpreter names to major modes.
2492 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2493 Each element looks like (INTERPRETER . MODE).
2494 If INTERPRETER matches the name of the interpreter specified in the first line
2495 of a script, mode MODE is enabled.
2503 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2504 When checking `inhibit-first-line-modes-regexps', we first discard
2510 "Regexp matching interpreters, for file mode determination.
2511 This regular expression is matched against the first line of a file
2512 to determine the file's mode in `set-auto-mode'. If it matches, the file
2513 is assumed to be interpreted by the interpreter matched by the second group
2514 of the regular expression. The mode is then determined as the mode
2518 "Alist of buffer beginnings vs. corresponding major mode functions.
2519 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2520 After visiting a file, if REGEXP matches the text at the beginning of the
2521 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2522 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2523 major mode.
2525 If FUNCTION is nil, then it is not called. (That is a way of saying
2533 ;; The < comes before the groups (but the first) to reduce backtracking.
2534 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2535 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2539 comment-re "*"
2542 . html-mode)
2544 ;; These two must come after html, because they are more general:
2549 . sgml-mode)
2552 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2553 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2554 After visiting a file, if REGEXP matches the text at the beginning of the
2555 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2556 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2557 have not specified a mode for this file.
2563 "Upper limit on `magic-mode-alist' regexp matches.
2567 "Select major mode appropriate for current buffer.
2569 To find the right major mode, this function checks for a -*- mode tag,
2570 checks if it uses an interpreter listed in `interpreter-mode-alist',
2571 matches the buffer beginning against `magic-mode-alist',
2572 compares the filename against the entries in `auto-mode-alist',
2573 then matches the buffer beginning against `magic-fallback-mode-alist'.
2575 It does not check for the `mode:' local variable in the
2576 Local Variables section of the file; for that, use `hack-local-variables'.
2578 If `enable-local-variables' is nil, this function does not check for a
2579 -*- mode tag.
2581 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2582 set the major mode only if that would change it. In other words
2583 we don't actually set it to the same mode the buffer already has."
2584 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2586 ;; Find a -*- mode tag
2593 ;; Find all specifications for the `mode:' variable
2594 ;; and execute them left to right.
2606 modes)))
2607 ;; Simple -*-MODE-*- case.
2610 modes))))
2611 ;; If we found modes to use, invoke them now, outside the save-excursion.
2619 ;; continuing would call minor modes again, toggling them off
2621 ;; If we didn't, look for an interpreter specified in the first line.
2622 ;; As a special case, allow for things like "#!/bin/env perl", which
2623 ;; finds the interpreter anywhere in $PATH.
2630 ;; Map interpreter name to a mode, signalling we're done at the
2631 ;; same time.
2633 interpreter-mode-alist))
2634 ;; If we found an interpreter mode to use, invoke it now.
2637 ;; Next try matching the buffer beginning against magic-mode-alist.
2651 ;; Next compare the filename against the entries in auto-mode-alist.
2656 ;; Remove remote file name identification.
2660 ;; Remove backup-suffixes from file name.
2663 ;; Find first matching alist entry.
2666 ;; System is case-insensitive.
2670 ;; System is case-sensitive.
2672 ;; First match case-sensitively.
2676 ;; Fallback to case-insensitive match.
2690 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2705 ;; When `keep-mode-if-same' is set, we are working on behalf of
2706 ;; set-visited-file-name. In that case, if the major mode specified is the
2707 ;; same one we already have, don't actually reset it. We don't want to lose
2708 ;; minor modes such as Font Lock.
2710 "Apply MODE and return it.
2711 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2712 any aliases and compared to current major mode. If they are the
2713 same, do nothing and return nil."
2719 mode)))
2722 "Find the -*- spec in the buffer.
2723 Call with point at the place to start searching from.
2724 If one is found, set point to the beginning
2725 and return the position of the end.
2726 Otherwise, return nil; point may be changed."
2729 ;; Don't look for -*- if this file name matches any
2730 ;; of the regexps in inhibit-first-line-modes-regexps.
2738 sufs)
2746 ;; If the file begins with "#!"
2747 ;; (exec interpreter magic), look
2748 ;; for mode frobs in the first two
2749 ;; lines. You cannot necessarily
2750 ;; put them in the first line of
2751 ;; such a file without screwing up
2752 ;; the interpreter invocation.
2753 ;; The same holds for
2754 ;; '\"
2755 ;; in man pages (preprocessor
2756 ;; magic for the `man' program).
2767 end))))
2768 \f
2769 ;;; Handling file local variables
2773 file-local-variables-alist dir-local-variables-alist)
2778 "Normal hook run after processing a file's local variables specs.
2779 Major modes can use this to examine user-specified local variables
2783 "List variable-value pairs that are considered safe.
2784 Each element is a cons cell (VAR . VAL), where VAR is a variable
2785 symbol and VAL is a value that is considered safe."
2786 :risky t
2793 "Expressions that are considered safe in an `eval:' local variable.
2794 Add expressions to this list if you want Emacs to evaluate them, when
2795 they appear in an `eval' local variable specification, without first
2796 asking you for confirmation."
2797 :risky t
2802 ;; Risky local variables:
2805 buffer-auto-save-file-name
2806 buffer-file-name
2807 buffer-file-truename
2808 buffer-undo-list
2809 debugger
2810 default-text-properties
2811 eval
2812 exec-directory
2813 exec-path
2814 file-name-handler-alist
2815 frame-title-format
2816 global-mode-string
2817 header-line-format
2818 icon-title-format
2819 inhibit-quit
2820 load-path
2821 max-lisp-eval-depth
2822 max-specpdl-size
2823 minor-mode-map-alist
2824 minor-mode-overriding-map-alist
2825 mode-line-format
2826 mode-name
2827 overriding-local-map
2828 overriding-terminal-local-map
2829 process-environment
2830 standard-input
2831 standard-output
2832 unread-command-events))
2834 ;; Safe local variables:
2835 ;;
2836 ;; For variables defined by major modes, the safety declarations can go into
2837 ;; the major mode's file, since that will be loaded before file variables are
2838 ;; processed.
2839 ;;
2840 ;; For variables defined by minor modes, put the safety declarations in the
2841 ;; file defining the minor mode after the defcustom/defvar using an autoload
2842 ;; cookie, e.g.:
2843 ;;
2844 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2845 ;;
2846 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2847 ;; minor mode file may not be loaded yet.
2848 ;;
2849 ;; For variables defined in the C source code the declaration should go here:
2870 "Alist of file-local variable settings in the current buffer.
2871 Each element in this list has the form (VAR . VALUE), where VAR
2872 is a file-local variable (a symbol) and VALUE is the value
2873 specified. The actual value in the buffer may differ from VALUE,
2878 "Alist of directory-local variable settings in the current buffer.
2879 Each element in this list has the form (VAR . VALUE), where VAR
2880 is a directory-local variable (a symbol) and VALUE is the value
2881 specified in .dir-locals.el. The actual value in the buffer
2882 may differ from VALUE, if it is changed by the major or minor modes,
2887 "Normal hook run before setting file-local variables.
2888 It is called after checking for unsafe/risky variables and
2889 setting `file-local-variables-alist', and before applying the
2890 variables stored in `file-local-variables-alist'. A hook
2891 function is allowed to change the contents of this alist.
2893 This hook is called only if there is at least one file-local
2897 "Get confirmation before setting up local variable values.
2898 ALL-VARS is the list of all variables to be set up.
2899 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2900 RISKY-VARS is the list of those that are marked as risky.
2901 DIR-NAME is a directory name if these settings come from
2902 directory-local variables, or nil otherwise."
2904 nil
2910 prompt char)
2920 ", and variables that are risky (**)."
2927 y -- to apply the local variables list.
2931 ! -- to apply the local variables list, and permanently mark these
2943 ;; Make strings with embedded whitespace easier to read.
2951 ""
2958 done)
2967 ;; read-event returns -1 if we are in a kbd
2968 ;; macro and there are no more events in the
2969 ;; macro. In that case, attempt to get an
2970 ;; event interactively.
2978 ;; When this is called from desktop-restore-file-buffer,
2979 ;; coding-system-for-read may be non-nil. Reset it before
2980 ;; writing to .emacs.
2984 'safe-local-variable-values
2985 safe-local-variable-values))))
2992 "Return local variables specified in the -*- line.
2993 Ignore any specification for `mode:' and `coding:';
2994 `set-auto-mode' should already have handled `mode:',
2995 `set-auto-coding' should already have handled `coding:'.
2997 If MODE-ONLY is non-nil, all we do is check whether the major
2998 mode is specified, returning t if it is specified. Otherwise,
2999 return an alist of elements (VAR . VAL), where VAR is a variable
3000 and VAL is the specified value."
3004 result mode-specified)
3005 ;; Parse the -*- line into the RESULT alist.
3006 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
3008 nil)
3010 ;; Simple form: "-*- MODENAME -*-". Already handled.
3012 nil)
3014 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3015 ;; (last ";" is optional).
3020 ;; There used to be a downcase here,
3021 ;; but the manual didn't say so,
3022 ;; and people want to set var names that aren't all lc.
3028 ;; It is traditional to ignore
3029 ;; case when checking for `mode' in set-auto-mode,
3030 ;; so we must do that here as well.
3031 ;; That is inconsistent, but we're stuck with it.
3032 ;; The same can be said for `coding' in set-auto-coding.
3038 'eval
3045 mode-specified
3046 result))))
3049 "Filter local variable settings, querying the user if necessary.
3050 VARIABLES is the alist of variable-value settings. This alist is
3051 filtered based on the values of `ignored-local-variables',
3052 `enable-local-eval', `enable-local-variables', and (if necessary)
3053 user interaction. The results are added to
3054 `file-local-variables-alist', without applying them.
3055 DIR-NAME is a directory name if these settings come from
3056 directory-local variables, or nil otherwise."
3057 ;; Find those variables that we may want to save to
3058 ;; `safe-local-variable-values'.
3064 ;; Ignore any variable in `ignored-local-variables'.
3065 nil)
3066 ;; Obey `enable-local-eval'.
3074 ;; Ignore duplicates (except `mode') in the present list.
3076 ;; Accept known-safe variables.
3080 ;; The variable is either risky or unsafe:
3087 ;; Query, unless all vars are safe or user wants no querying.
3093 risky-vars dir-name))
3104 "Parse and put into effect this buffer's local variables spec.
3105 If MODE-ONLY is non-nil, all we do is check whether the major mode
3106 is specified, returning t if it is specified."
3109 result)
3116 ;; Look for "Local variables:" line in last page.
3124 ;; suffix is what comes after "local variables:" in its line.
3125 ;; prefix is what comes before "local variables:" in its line.
3135 beg)
3139 endpos
3145 nil t))
3146 ;; This used to be an error, but really all it means is
3147 ;; that this may simply not be a local-variables section,
3148 ;; so just ignore it.
3158 ;; Discard the prefix.
3163 ;; Discard the suffix.
3171 ;; Find the variable name; strip whitespace.
3180 val)
3181 ;; Read the variable value.
3192 'eval
3197 ;; Now we've read all the local variables.
3198 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3200 ;; Otherwise, set the variables.
3207 ;; Any 'evals must run in the Right sequence.
3216 "Non-nil if SYM is safe as a file-local variable with value VAL.
3217 It is safe if any of these conditions are met:
3219 * There is a matching entry (SYM . VAL) in the
3220 `safe-local-variable-values' user option.
3222 * The `safe-local-variable' property of SYM is a function that
3223 evaluates to a non-nil value with VAL as an argument."
3229 "Non-nil if SYM could be dangerous as a file-local variable.
3230 It is dangerous if either of these conditions are met:
3232 * Its `risky-local-variable' property is non-nil.
3238 ;; If this is an alias, check the base name.
3258 "Return t if it is safe to eval EXP when it is found in a file."
3260 ;; Detect certain `put' expressions.
3267 lisp-indent-function
3268 scheme-indent-function))
3269 ;; Only allow safe values (not functions).
3274 ;; Only allow indirect form specs.
3275 ;; During bootstrapping, edebug-basic-spec might not be
3276 ;; defined yet.
3280 ;; Allow expressions that the user requested.
3282 ;; Certain functions can be allowed with safe arguments
3283 ;; or can specify verification functions to try.
3291 ok))
3299 ok)))))))
3302 "Set local variable VAR with value VAL.
3303 If VAR is `mode', call `VAL-mode' as a function unless it's
3304 already the major mode."
3311 ;; A minor mode must be passed an argument.
3312 ;; Otherwise, if the user enables the minor mode in a
3313 ;; major mode hook, this would toggle it off.
3319 ;; Make sure the string has no text properties.
3320 ;; Some text properties can get evaluated in various ways,
3321 ;; so it is risky to put them on with a local variable list.
3325 \f
3326 ;;; Handling directory-local variables, aka project settings.
3332 "List of cached directory roots for directory-local variable classes.
3333 Each element in this list has the form (DIR CLASS MTIME).
3334 DIR is the name of the directory.
3335 CLASS is the name of a variable class (a symbol).
3336 MTIME is the recorded modification time of the directory-local
3337 variables file associated with this entry. This time is a list
3338 of two integers (the same format as `file-attributes'), and is
3339 used to test whether the cache entry is still valid.
3340 Alternatively, MTIME can be nil, which means the entry is always
3344 "Return the variable list for CLASS."
3348 "Collect directory-local variables from MODE-VARIABLES.
3349 VARIABLES is the initial list of variables.
3350 Returns the new list."
3355 ;; If variables are specified more than once, only use the last. (Why?)
3356 ;; The pseudo-variables mode and eval are different (bug#3430).
3359 ;; Need a new cons in case we setcdr later.
3363 "Collect entries from CLASS-VARIABLES into VARIABLES.
3364 ROOT is the root directory of the project.
3365 Return the new variables list."
3373 ;; Don't include this in the previous condition, because we
3374 ;; want to filter all strings before the next condition.
3386 "Declare that the DIRECTORY root is an instance of CLASS.
3387 DIRECTORY is the name of a directory, a string.
3388 CLASS is the name of a project class, a symbol.
3389 MTIME is either the modification time of the directory-local
3390 variables file that defined this class, or nil.
3392 When a file beneath DIRECTORY is visited, the mode-specific
3393 variables from CLASS are applied to the buffer. The variables
3394 for a class are defined using `dir-locals-set-class-variables'."
3401 "Map the type CLASS to a list of variable settings.
3402 CLASS is the project class, a symbol. VARIABLES is a list
3403 that declares directory-local variables for the class.
3404 An element in VARIABLES is either of the form:
3405 (MAJOR-MODE . ALIST)
3406 or
3407 (DIRECTORY . LIST)
3409 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3410 whose elements are of the form (VARIABLE . VALUE).
3412 In the second form, DIRECTORY is a directory name (a string), and
3413 LIST is a list of the form accepted by the function.
3415 When a file is visited, the file's class is found. A directory
3416 may be assigned a class using `dir-locals-set-directory-class'.
3417 Then variables are set in the file's buffer according to the
3418 class' LIST. The list is processed in order.
3420 * If the element is of the form (MAJOR-MODE . ALIST), and the
3421 buffer's major mode is derived from MAJOR-MODE (as determined
3422 by `derived-mode-p'), then all the variables in ALIST are
3423 applied. A MAJOR-MODE of nil may be used to match any buffer.
3424 `make-local-variable' is called for each variable before it is
3425 set.
3427 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3428 is an initial substring of the file's directory, then LIST is
3429 applied by recursively following these rules."
3436 "File that contains directory-local variables.
3437 It has to be constant to enforce uniform values
3441 "Find the directory-local variables for FILE.
3442 This searches upward in the directory tree from FILE.
3443 If the directory root of FILE has been registered in
3444 `dir-locals-directory-cache' and the directory-local variables
3445 file has not been modified, return the matching entry in
3446 `dir-locals-directory-cache'.
3447 Otherwise, if a directory-local variables file is found, return
3448 the file name.
3449 Otherwise, return nil."
3454 dir-locals-file))
3457 ;; `locate-dominating-file' may have abbreviated the name.
3460 ;; Find the best cached value in `dir-locals-directory-cache'.
3473 ;; Check the validity of the cache.
3478 ;; This cache entry is OK.
3479 dir-elt
3480 ;; This cache entry is invalid; clear it.
3483 locals-file)
3484 locals-file))))
3487 "Load a variables FILE and register a new class and instance.
3488 FILE is the name of the file holding the variables to apply.
3489 The new class name is the same as the directory in which FILE
3490 is found. Returns the new class name."
3500 class-name)))
3503 "Read per-directory local variables for the current buffer.
3504 Store the directory-local variables in `dir-local-variables-alist'
3505 and `file-local-variables-alist', without applying them."
3508 ;; Find the variables file.
3514 (setq dir-name (if (buffer-file-name) (file-name-directory (buffer-file-name)) default-directory))
3535 \f
3538 However, the mode will not be changed if
3539 \(1) a local variables list or the `-*-' line specifies a major mode, or
3541 \ not suitable for ordinary files, or
3542 \(3) the new file name does not particularly specify any mode."
3547 "Change name of file visited in current buffer to FILENAME.
3548 This also renames the buffer to correspond to the new file.
3549 The next time the buffer is saved it will go in the newly specified file.
3550 FILENAME nil or an empty string means mark buffer as not visiting any file.
3551 Remember to delete the initial contents of the minibuffer
3552 if you wish to pass an empty string as the argument.
3554 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3555 confirmation in the case where another buffer is already visiting FILENAME.
3557 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3558 the old visited file has been renamed to the new name FILENAME."
3566 nil
3581 filename)))
3591 ;; If new-name == old-name, renaming would add a spurious <2>
3592 ;; and it's considered as a feature in rename-buffer.
3598 ;; Abbreviate the file names of the buffer.
3607 nil)))
3608 ;; write-file-functions is normally used for things like ftp-find-file
3609 ;; that visit things that are not local files as if they were files.
3610 ;; Changing to visit an ordinary local file instead should flush the hook.
3615 ;; If buffer was read-only because of version control,
3616 ;; that reason is gone now, so make it writable.
3620 ;; Turn off backup files for certain file names.
3621 ;; Since this is a permanent local, the major mode won't eliminate it.
3623 backup-enable-predicate
3629 ;; If auto-save was not already on, turn it on if appropriate.
3633 ;; If auto save is on, start using a new name.
3634 ;; We deliberately don't rename or delete the old auto save
3635 ;; for the old visited file name. This is because perhaps
3636 ;; the user wants to save the new state and then compare with the
3637 ;; previous state from the auto save file.
3640 ;; Rename the old auto save file if any.
3647 ;; Update the major mode, if the file name determines it.
3649 ;; Don't change the mode if it is special.
3652 ;; Don't change the mode if the local variable list specifies it.
3658 "Write current buffer into file FILENAME.
3659 This makes the buffer visit that file, and marks it as not modified.
3661 If you specify just a directory name as FILENAME, that means to use
3662 the default file name but in that directory. You can also yank
3663 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3665 If the buffer is not already visiting a file, the default file name
3666 for the output file is the buffer name.
3668 If optional second arg CONFIRM is non-nil, this function
3669 asks for confirmation before overwriting an existing file.
3670 Interactively, confirmation is required unless you supply a prefix argument."
3671 ;; (interactive "FWrite file: ")
3675 nil nil nil nil)
3679 default-directory)
3680 nil nil))
3684 ;; If arg is just a directory,
3685 ;; use the default file name, but in that directory.
3696 ;; Make buffer writable if file is writable.
3701 ;; It's likely that the VC status at the new location is different from
3702 ;; the one at the old location.
3704 \f
3706 "Make a backup of the disk file visited by the current buffer, if appropriate.
3707 This is normally done before saving the buffer the first time.
3709 A backup may be done by renaming or by copying; see documentation of
3710 variable `make-backup-files'. If it's done by renaming, then the file is
3711 no longer accessible under its old name.
3713 The value is non-nil after a backup was made by renaming.
3714 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3715 MODES is the result of `file-modes' on the original
3716 file; this means that the caller, after saving the buffer, should change
3717 the modes of the new file to agree with the old modes.
3718 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3719 file; this means that the caller, after saving the buffer, should change
3720 the SELinux context of the new file to agree with the old context.
3721 BACKUPNAME is the backup file name, which is the old file renamed."
3728 backup-info backupname targets setmodes)
3729 ;; If specified name is a symbolic link, chase it to the target.
3730 ;; Thus we make the backups in the directory where the real file is.
3735 ;; (if (file-directory-p buffer-file-name)
3736 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3740 ;; If have old versions to maybe delete,
3741 ;; ask the user to confirm now, before doing anything.
3742 ;; But don't actually delete til later.
3747 real-file-name)))))
3750 ;; Actually write the back up file.
3753 ; (file-symlink-p buffer-file-name)
3754 backup-by-copying
3755 ;; Don't rename a suid or sgid file.
3770 ;; rename-file should delete old backup.
3774 ;; If trouble writing the backup, write it in ~.
3779 backupname)
3783 ;; Now delete the old versions, if desired.
3790 setmodes)
3797 ;; Create temp files with strict access rights. It's easy to
3798 ;; loosen them later, whereas it's impossible to close the
3799 ;; time-window of loose permissions otherwise.
3802 ;; Try to overwrite old backup first.
3810 nil)
3812 ;; The file was somehow created by someone else between
3813 ;; `delete-file' and `copy-file', so let's try again.
3814 ;; rms says "I think there is also a possible race
3815 ;; condition for making backup files" (emacs-devel 20070821).
3816 nil)))
3817 ;; Reset the umask.
3825 "Return file NAME sans backup versions or strings.
3826 This is a separate procedure so your site-init or startup file can
3827 redefine it.
3828 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3829 we do not remove backup version numbers, only true file version numbers."
3841 "Return t if deleting FILE and rewriting it would preserve the owner."
3846 ;; Return t if the file doesn't exist, since it's true that no
3847 ;; information would be lost by an (attempted) delete and create.
3853 The extension, in a file name, is the part that follows the last `.',
3854 except that a leading `.', if any, doesn't count."
3857 directory)
3861 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3862 ;; we don't want to expand it.
3865 filename))))
3869 The extension, in a file name, is the part that follows the last `.',
3870 excluding version numbers and backup suffixes,
3871 except that a leading `.', if any, doesn't count.
3872 Return nil for extensionless file names such as `foo'.
3873 Return the empty string for file names such as `foo.'.
3875 If PERIOD is non-nil, then the returned value includes the period
3876 that delimits the extension, and if FILENAME has no extension,
3887 "A function to use instead of the default `make-backup-file-name'.
3888 A value of nil gives the default `make-backup-file-name' behavior.
3890 This could be buffer-local to do something special for specific
3891 files. If you define it, you may need to change `backup-file-name-p'
3892 and `file-name-sans-versions' too.
3894 See also `backup-directory-alist'."
3900 "Alist of filename patterns and backup directory names.
3901 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3902 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3903 relative or absolute. If it is absolute, so that all matching files
3904 are backed up into the same directory, the file names in this
3905 directory will be the full name of the file backed up with all
3906 directory separators changed to `!' to prevent clashes. This will not
3907 work correctly if your filesystem truncates the resulting name.
3909 For the common case of all backups going into one directory, the alist
3911 directory name.
3913 If this variable is nil, or it fails to match a filename, the backup
3914 is made in the original file's directory.
3916 On MS-DOS filesystems without long names this variable is always
3917 ignored."
3923 "Default `backup-enable-predicate' function.
3924 Checks for files in `temporary-file-directory',
3925 `small-temporary-file-directory', and /tmp."
3928 ;; Directory is under temporary-file-directory.
3933 ;; Directory is under /tmp.
3938 0 nil
3940 ;; Directory is under small-temporary-file-directory.
3945 "Create the non-numeric backup file name for FILE.
3946 Normally this will just be the file's name with `~' appended.
3947 Customization hooks are provided as follows.
3949 If the variable `make-backup-file-name-function' is non-nil, its value
3950 should be a function which will be called with FILE as its argument;
3951 the resulting name is used.
3953 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3954 the documentation of that variable. If the directory for the backup
3955 doesn't exist, it is created."
3969 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3971 elt backup-directory abs-backup-directory)
3976 alist nil)))
3977 ;; If backup-directory is relative, it should be relative to the
3978 ;; file's directory. By expanding explicitly here, we avoid
3979 ;; depending on default-directory.
3988 abs-backup-directory nil))))
3990 file
3994 ;; Normalize DOSish file names: downcase the drive
3995 ;; letter, if any, and replace the leading "x:" with
3996 ;; "/drive_x".
3999 ;; Replace any invalid file-name characters (for the
4000 ;; case of backing up remote files).
4004 "drive_"
4007 ""
4010 ;; Make the name unique by substituting directory
4011 ;; separators. It may not really be worth bothering about
4012 ;; doubling `!'s in the original name...
4017 backup-directory))
4022 "Return non-nil if FILE is a backup file name (numeric or not).
4023 This is a separate function so you can redefine it for customization.
4024 You may need to redefine `file-name-sans-versions' as well."
4029 ;; This is used in various files.
4030 ;; The usage of backup-extract-version-start is not very clean,
4031 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4033 "Given the name of a numeric backup file, FN, return the backup number.
4034 Uses the free variable `backup-extract-version-start', whose value should be
4035 the index in the name where the version number begins."
4042 "Find a file name for a backup file FN, and suggestions for deletions.
4043 Value is a list whose car is the name for the backup file
4044 and whose cdr is a list of old versions to consider deleting now.
4045 If the value is nil, don't make a backup.
4046 Uses `backup-directory-alist' in the same way as does
4047 `make-backup-file-name'."
4049 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4053 ;; We don't support numbered backups on plain MS-DOS
4054 ;; when long file names are unavailable.
4064 possibilities deserve-versions-p versions)
4067 base-versions
4070 possibilities)
4071 #'<)
4076 kept-old-versions
4077 kept-new-versions
4084 ;; Delete nothing if there is overflow
4085 ;; in the number of versions to keep.
4091 v))))))))))
4094 "Return number of names file FILENAME has."
4097 ;; (defun file-relative-name (filename &optional directory)
4098 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4099 ;; This function returns a relative file name which is equivalent to FILENAME
4100 ;; when used with that default directory as the default.
4101 ;; If this is impossible (which can happen on MSDOS and Windows
4102 ;; when the file name and directory use different drive names)
4103 ;; then it returns FILENAME."
4104 ;; (save-match-data
4105 ;; (let ((fname (expand-file-name filename)))
4106 ;; (setq directory (file-name-as-directory
4107 ;; (expand-file-name (or directory default-directory))))
4108 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4109 ;; ;; drive names, they can't be relative, so return the absolute name.
4110 ;; (if (and (or (eq system-type 'ms-dos)
4111 ;; (eq system-type 'cygwin)
4112 ;; (eq system-type 'windows-nt))
4113 ;; (not (string-equal (substring fname 0 2)
4114 ;; (substring directory 0 2))))
4115 ;; filename
4116 ;; (let ((ancestor ".")
4117 ;; (fname-dir (file-name-as-directory fname)))
4118 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4119 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4120 ;; (setq directory (file-name-directory (substring directory 0 -1))
4121 ;; ancestor (if (equal ancestor ".")
4122 ;; ".."
4123 ;; (concat "../" ancestor))))
4124 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4125 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4126 ;; ;; We matched within FNAME's directory part.
4127 ;; ;; Add the rest of FNAME onto ANCESTOR.
4128 ;; (let ((rest (substring fname (match-end 0))))
4129 ;; (if (and (equal ancestor ".")
4130 ;; (not (equal rest "")))
4131 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4132 ;; rest
4133 ;; (concat (file-name-as-directory ancestor) rest)))
4134 ;; ;; We matched FNAME's directory equivalent.
4135 ;; ancestor))))))
4138 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4139 This function returns a relative file name which is equivalent to FILENAME
4140 when used with that default directory as the default.
4141 If FILENAME and DIRECTORY lie on different machines or on different drives
4142 on a DOS/Windows machine, it returns FILENAME in expanded form."
4146 default-directory))))
4152 ;; Test for different drives on DOS/Windows
4154 ;; Should `cygwin' really be included here? --stef
4157 ;; Test for different remote file system identification
4159 filename
4165 directory nil nil case-fold-search))
4167 directory nil nil case-fold-search))))
4170 ".."
4172 ;; Now ancestor is empty, or .., or ../.., etc.
4174 directory nil nil case-fold-search))
4175 ;; We matched within FILENAME's directory part.
4176 ;; Add the rest of FILENAME onto ANCESTOR.
4179 ;; But don't bother with ANCESTOR if it would give us `./'.
4180 rest
4182 ;; We matched FILENAME's directory equivalent.
4183 ancestor))))))
4184 \f
4186 "Save current buffer in visited file if modified.
4187 Variations are described below.
4189 By default, makes the previous version into a backup file
4190 if previously requested or if this is the first save.
4192 to become a backup when the next save is done.
4194 unconditionally makes the previous version into a backup file.
4196 to become a backup when the next save is done,
4197 and unconditionally makes the previous version into a backup file.
4199 With a numeric argument of 0, never make the previous version
4200 into a backup file.
4202 If a file's name is FOO, the names of its numbered backup versions are
4203 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4204 Numeric backups (rather than FOO~) will be made if value of
4205 `version-control' is not the atom `never' and either there are already
4206 numeric versions of the file being backed up, or `version-control' is
4207 non-nil.
4208 We don't want excessive versions piling up, so there are variables
4209 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4210 and `kept-new-versions', which tells how many newest versions to keep.
4211 Defaults are 2 old versions and 2 new.
4212 `dired-kept-versions' controls dired's clean-directory (.) command.
4213 If `delete-old-versions' is nil, system will query user
4214 before trimming versions. Otherwise it does it silently.
4216 If `vc-make-backup-files' is nil, which is the default,
4217 no backup files are made for files managed by version control.
4218 (This is because the version control system itself records previous versions.)
4220 See the subroutine `basic-save-buffer' for more information."
4226 ;; We used to display the message below only for files > 50KB, but
4227 ;; then Rmail-mbox never displays it due to buffer swapping. If
4228 ;; the test is ever re-introduced, be sure to handle saving of
4229 ;; Rmail files.
4236 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4237 Normally delete only if the file was written by this Emacs since
4238 the last real save, but optional arg FORCE non-nil means delete anyway."
4252 "Normal hook that is run before a buffer is saved to its file."
4258 "Normal hook that is run after a buffer is saved to its file."
4264 "If non-nil, use this coding system for saving the buffer.
4265 More precisely, use this coding system in place of the
4266 value of `buffer-file-coding-system', when saving the buffer.
4267 Calling `write-region' for any purpose other than saving the buffer
4268 will still use `buffer-file-coding-system'; this variable has no effect
4275 "Save the current buffer in its visited file, if it has been modified.
4276 The hooks `write-contents-functions' and `write-file-functions' get a chance
4277 to do the job of saving; if they do not, then the buffer is saved in
4278 the visited file in the usual way.
4279 Before and after saving the buffer, this function runs
4280 `before-save-hook' and `after-save-hook', respectively."
4283 ;; In an indirect buffer, save its base buffer instead.
4288 setmodes)
4289 ;; If buffer has no file name, ask user for one.
4296 ;; Signal an error if the user specified the name of an
4297 ;; existing directory.
4300 filename))
4302 ;; Signal an error if the specified name refers to a
4303 ;; non-existing directory.
4333 ;; Support VC version backups.
4339 ;; If a hook returned t, file is already "written".
4340 ;; Otherwise, write it the usual way now.
4342 ;; Now we have saved the current buffer. Let's make sure
4343 ;; that buffer-file-coding-system is fixed to what
4344 ;; actually used for saving by binding it locally.
4356 ;; If the auto-save file was recent before this command,
4357 ;; delete it now.
4359 ;; Support VC `implicit' locking.
4364 ;; This does the "real job" of writing a buffer into its visited file
4365 ;; and making a backup file. This is what is normally done
4366 ;; but inhibited if one of write-file-functions returns non-nil.
4367 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4379 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4393 buffer-file-name)))
4407 ;; Write temp name, then rename it.
4408 ;; This requires write access to the containing dir,
4409 ;; which is why we don't try it if we don't have that access.
4411 tempname succeed
4414 ;; Create temp files with strict access rights. It's easy to
4415 ;; loosen them later, whereas it's impossible to close the
4416 ;; time-window of loose permissions otherwise.
4421 ;; Try various temporary names.
4422 ;; This code follows the example of make-temp-file,
4423 ;; but it calls write-region in the appropriate way
4424 ;; for saving the buffer.
4430 ;; Pass in nil&nil rather than point-min&max
4431 ;; cause we're saving the whole buffer.
4432 ;; write-region-annotate-functions may use it.
4434 tempname nil realname
4436 nil)
4438 ;; The file was somehow created by someone else between
4439 ;; `make-temp-name' and `write-region', let's try again.
4440 nil)
4442 ;; Reset the umask.
4444 ;; If we failed, restore the buffer's modtime.
4447 ;; Since we have created an entirely new file,
4448 ;; make sure it gets the right permission bits set.
4453 buffer-file-name)))
4454 ;; We succeeded in writing the temp file,
4455 ;; so rename it.
4457 ;; If file not writable, see if we can make it writable
4458 ;; temporarily while we write it.
4459 ;; But no need to do so if we have just backed it up
4460 ;; (setmodes is set) because that says we're superseding.
4462 ;; Change the mode back, after writing.
4465 buffer-file-name))
4471 ;; Pass in nil&nil rather than point-min&max to indicate
4472 ;; we're saving the buffer rather than just a region.
4473 ;; write-region-annotate-functions may make us of it.
4475 buffer-file-name nil t buffer-file-truename)
4477 ;; If we get an error writing the new file, and we made
4478 ;; the backup by renaming, undo the backing-up.
4483 setmodes))
4486 "View the differences between BUFFER and its associated file.
4487 This requires the external program `diff' to be in your `exec-path'."
4501 ;; Display that message for 1 second so that user can read it
4502 ;; in the minibuffer.
4504 ;; return always nil, so that save-buffers-kill-emacs will not move
4505 ;; over to the next unsaved buffer when calling `d'.
4506 nil)
4509 `((?\C-r
4516 ;; Return nil to ask about BUF again.
4517 nil)
4529 ;; Return nil to ask about BUF again.
4530 nil)
4540 "Save some modified file-visiting buffers. Asks user about each one.
4541 You can answer `y' to save, `n' not to save, `C-r' to look at the
4542 buffer in question with `view-buffer' before deciding or `d' to
4543 view the differences using `diff-buffer-with-file'.
4545 Optional argument (the prefix) non-nil means save all with no questions.
4546 Optional second argument PRED determines which buffers are considered:
4547 If PRED is nil, all the file-visiting buffers are considered.
4548 If PRED is t, then certain non-file buffers will also be considered.
4549 If PRED is a zero-argument function, it indicates for each buffer whether
4550 to consider it or not when called with that buffer current.
4552 See `save-some-buffers-action-alist' if you want to
4553 change the additional actions you can take on files."
4557 files-done abbrevs-done)
4559 ;; First save any buffers that we're supposed to save unconditionally.
4560 ;; That way the following code won't ask about them.
4565 ;; Ask about those buffers that merit it,
4566 ;; and record the number thus saved.
4570 ;; Note that killing some buffers may kill others via
4571 ;; hooks (e.g. Rmail and its viewing buffer).
4584 t
4596 save-some-buffers-action-alist))
4597 ;; Maybe to save abbrevs, and record whether
4598 ;; we either saved them or asked to.
4604 abbrev-file-name)))
4606 ;; Don't keep bothering user if he says no.
4611 "(Some special files were saved without asking)"
4613 \f
4615 "Mark current buffer as unmodified, not needing to be saved.
4618 It is not a good idea to use this function in Lisp programs, because it
4619 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4626 "Change whether this buffer is read-only.
4627 With prefix argument ARG, make the buffer read-only if ARG is
4628 positive, otherwise make it writable. If buffer is read-only
4629 and `view-read-only' is non-nil, enter view mode."
4634 nil ; do nothing.
4635 ;; Toggle.
4642 ;; If view-mode is already active, `view-mode-enter' is a nop.
4654 "Insert contents of file FILENAME into buffer after point.
4655 Set mark after the inserted text.
4657 This function is meant for the user to run interactively.
4658 Don't call it from programs! Use `insert-file-contents' instead.
4659 \(Its calling sequence is different; see its documentation)."
4664 "Append the contents of the region to the end of file FILENAME.
4665 When called from a function, expects three arguments,
4666 START, END and FILENAME. START and END are normally buffer positions
4667 specifying the part of the buffer to write.
4668 If START is nil, that means to use the entire buffer contents.
4669 If START is a string, then output that string to the file
4670 instead of any buffer contents; END is ignored.
4672 This does character code conversion and applies annotations
4673 like `write-region' does."
4678 "Return most recent backup file for FILENAME or nil if no backups exist."
4679 ;; `make-backup-file-name' will get us the right directory for
4680 ;; ordinary or numeric backups. It might create a directory for
4681 ;; backups as a side-effect, according to `backup-directory-alist'.
4688 tem)
4697 newest))
4700 "Rename current buffer to a similar name not already taken.
4701 This function is useful for creating multiple shell process buffers
4702 or multiple mail buffers, etc."
4710 ;; If the existing buffer name has a <NNN>,
4711 ;; which isn't part of the file name (if any),
4712 ;; then get rid of that.
4718 "Create the directory DIR and optionally any nonexistent parent dirs.
4719 If DIR already exists as a directory, signal an error, unless
4720 PARENTS is non-nil.
4722 Interactively, the default choice of directory to create is the
4723 current buffer's default directory. That is useful when you have
4724 visited a file in a nonexistent directory.
4726 Noninteractively, the second (optional) argument PARENTS, if
4727 non-nil, says whether to create parent directories that don't
4728 exist. Interactively, this happens by default."
4731 nil nil)
4732 t))
4733 ;; If default-directory is a remote directory,
4734 ;; make sure we find its make-directory handler.
4742 create-list)
4744 ;; If directory is its own parent, then we can't
4745 ;; keep looping forever
4760 "Delete the directory named DIRECTORY. Does not follow symlinks.
4761 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4762 TRASH non-nil means to trash the directory instead, provided
4763 `delete-by-moving-to-trash' is non-nil.
4765 When called interactively, TRASH is t if no prefix argument is
4766 given. With a prefix argument, TRASH is nil."
4773 "Move directory to trash: "
4775 default-directory default-directory nil nil))))
4781 nil)
4783 ;; If default-directory is a remote directory, make sure we find its
4784 ;; delete-directory handler.
4791 ;; Only move non-empty dir to trash if recursive deletion was
4792 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4793 ;; case, where the operation fails in delete-directory-internal.
4794 ;; As `move-file-to-trash' trashes directories (empty or
4795 ;; otherwise) as a unit, we do not need to recurse here.
4797 ;; Check if directory is empty apart from "." and "..".
4802 ;; Otherwise, call outselves recursively if needed.
4806 ;; This test is equivalent to
4807 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4808 ;; but more efficient
4812 ;; We do not want to delete "." and "..".
4818 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4819 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4821 This function always sets the file modes of the output files to match
4822 the corresponding input file.
4824 The third arg KEEP-TIME non-nil means give the output files the same
4825 last-modified time as the old ones. (This works on only some systems.)
4827 A prefix arg makes KEEP-TIME non-nil.
4829 Noninteractively, the last argument PARENTS says whether to
4830 create parent directories if they don't exist. Interactively,
4831 this happens by default."
4838 default-directory default-directory nil nil)
4839 current-prefix-arg t)))
4840 ;; If default-directory is a remote directory, make sure we find its
4841 ;; copy-directory handler.
4847 ;; Compute target name.
4852 ;; Copy recursively.
4864 ;; We do not want to copy "." and "..".
4867 ;; Set directory attributes.
4871 \f
4874 "Function to use to revert this buffer, or nil to do the default.
4875 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4880 "Function to use to insert contents when reverting this buffer.
4881 Gets two args, first the nominal file name to use,
4882 and second, t if reading the auto-save file.
4887 "Function to check whether a non-file buffer needs reverting.
4888 This should be a function with one optional argument NOCONFIRM.
4889 Auto Revert Mode passes t for NOCONFIRM. The function should return
4890 non-nil if the buffer should be reverted. A return value of
4891 `fast' means that the need for reverting was not checked, but
4892 that reverting the buffer is fast. The buffer is current when
4893 this function is called.
4895 The idea behind the NOCONFIRM argument is that it should be
4896 non-nil if the buffer is going to be reverted without asking the
4897 user. In such situations, one has to be careful with potentially
4898 time consuming operations.
4900 For more information on how this variable is used by Auto Revert mode,
4904 "Normal hook for `revert-buffer' to run before reverting.
4905 If `revert-buffer-function' is used to override the normal revert
4909 "Normal hook for `revert-buffer' to run after reverting.
4910 Note that the hook value that it runs is the value that was in effect
4911 before reverting; that makes a difference if you have buffer-local
4912 hook functions.
4914 If `revert-buffer-function' is used to override the normal revert
4920 "Replace current buffer text with the text of the visited file on disk.
4921 This undoes all changes since the file was visited or saved.
4922 With a prefix argument, offer to revert from latest auto-save file, if
4923 that is more recent than the visited file.
4925 This command also implements an interface for special buffers
4926 that contain text which doesn't come from a file, but reflects
4927 some other data instead (e.g. Dired buffers, `buffer-list'
4928 buffers). This is done via the variable `revert-buffer-function'.
4929 In these cases, it should reconstruct the buffer contents from the
4930 appropriate data.
4932 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4933 to revert from the auto-save file when this is nil. Note that the
4934 sense of this argument is the reverse of the prefix argument, for the
4935 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4936 to nil.
4938 Optional second argument NOCONFIRM means don't ask for confirmation
4939 at all. \(The variable `revert-without-query' offers another way to
4940 revert buffers without querying for confirmation.)
4942 Optional third argument PRESERVE-MODES non-nil means don't alter
4943 the files modes. Normally we reinitialize them using `normal-mode'.
4945 If the value of `revert-buffer-function' is non-nil, it is called to
4946 do all the work for this command. Otherwise, the hooks
4947 `before-revert-hook' and `after-revert-hook' are run at the beginning
4948 and the end, and if `revert-buffer-insert-file-contents-function' is
4949 non-nil, it is called instead of rereading visited file contents."
4951 ;; I admit it's odd to reverse the sense of the prefix argument, but
4952 ;; there is a lot of code out there which assumes that the first
4953 ;; argument should be t to avoid consulting the auto-save file, and
4954 ;; there's no straightforward way to encourage authors to notice a
4955 ;; reversal of the argument sense. So I'm just changing the user
4956 ;; interface, but leaving the programmatic interface the same.
4964 buffer-auto-save-file-name
4969 buffer-auto-save-file-name
4970 buffer-file-name)))
4980 file-name)))
4982 ;; If file was backed up but has changed since,
4983 ;; we should make another backup.
4987 ;; Effectively copy the after-revert-hook status,
4988 ;; since after-find-file will clobber it.
4991 after-revert-hook))
4996 ;; Get rid of all undo records for this buffer.
4998 ;; Don't make undo records for the reversion.
5001 file-name auto-save-p)))
5004 "File %s no longer exists!"
5006 file-name))
5009 "File %s no longer readable!"
5011 file-name))
5013 ;; Bind buffer-file-name to nil
5014 ;; so that we don't try to lock the file.
5020 ;; Auto-saved file should be read by Emacs'
5021 ;; internal coding.
5025 buffer-file-coding-system-explicit
5028 coding-system-for-read
5030 coding-system-for-read)
5032 ;; As a coding system suitable for multibyte
5033 ;; buffer is specified, make the current
5034 ;; buffer multibyte.
5037 ;; This force after-insert-file-set-coding
5038 ;; (called from insert-file-contents) to set
5039 ;; buffer-file-coding-system to a proper value.
5042 ;; Note that this preserves point in an intelligent way.
5046 nil nil t))
5048 nil nil t)))))
5049 ;; Recompute the truename in case changes in symlinks
5050 ;; have changed the truename.
5054 ;; Run after-revert-hook as it was before we reverted.
5058 local-hook)
5061 t))))))
5064 "Recover the visited file--get contents from its last auto-save file."
5069 "Visit file FILE, but get contents from its last auto-save file."
5070 ;; Actually putting the file name in the minibuffer should be used
5071 ;; only rarely.
5072 ;; Not just because users often use the default.
5092 ;; Use insert-directory-safely, not insert-directory,
5093 ;; because these files might not exist. In particular,
5094 ;; FILE might not exist if the auto-save file was for
5095 ;; a buffer that didn't visit a file, such as "*mail*".
5096 ;; The code in v20.x called `ls' directly, so we need
5097 ;; to emulate what `ls' did in that case.
5103 ;; Keep the current buffer-file-coding-system.
5105 ;; Auto-saved file should be read with special coding.
5114 "Recover auto save files from a previous Emacs session.
5115 This command first displays a Dired buffer showing you the
5116 previous sessions that you could recover from.
5117 To choose one, move point to the proper line and then type C-c C-c.
5118 Then you'll be asked about a number of files to recover."
5128 auto-save-list-file-prefix)))
5129 t)
5138 ;; Each line starts with a space
5139 ;; so that Font Lock mode won't highlight the first character.
5148 "Choose one saved session to recover auto-save files from.
5149 This command is used in the special Dired buffer created by
5152 ;; Get the name of the session file to recover from.
5154 files
5160 ;; Read in the auto-save-list file.
5163 ;; Loop thru the text of that file
5164 ;; and get out the names of the files to recover.
5168 ;; This is a pair of lines for a non-file-visiting buffer.
5169 ;; Get the auto-save file name and manufacture
5170 ;; a "visited file name" from that.
5173 ;; If there is no auto-save file name, the
5174 ;; auto-save-list file is probably corrupted.
5187 ;; This pair of lines is a file-visiting
5188 ;; buffer. Use the visited file name.
5198 ;; Ignore a file if its auto-save file does not exist now.
5202 ;; The file contains a pair of line for each auto-saved buffer.
5203 ;; The first line of the pair contains the visited file name
5204 ;; or is empty if the buffer was not visiting a file.
5205 ;; The second line is the auto-save file name.
5213 files
5219 "Kill BUFFER if confirmed."
5227 "Kill some buffers. Asks the user whether to kill each one of them.
5228 Non-interactively, if optional argument LIST is non-nil, it
5229 specifies the list of buffers to kill, asking for approval for each one."
5237 ; if we killed the base buffer.
5244 "Kill buffers whose name matches the specified REGEXP.
5245 The optional second argument indicates whether to kill internal buffers too."
5254 \f
5256 "Adjust current buffer's auto save file name for current conditions.
5257 Also rename any existing auto save file, if it was made in this session."
5269 "Return file name to use for auto-saves of current buffer.
5270 Does not consider `auto-save-visited-file-name' as that variable is checked
5271 before calling this function. You can redefine this for customization.
5272 See also `auto-save-file-name-p'."
5280 result uniq)
5281 ;; Apply user-specified translations
5282 ;; to the file name.
5286 filename)
5296 filename))))
5301 ;; We truncate the file name to DOS 8+3 limits
5302 ;; before doing anything else, because the regexp
5303 ;; passed to string-match below cannot handle
5304 ;; extensions longer than 3 characters, multiple
5305 ;; dots, and other atrocities.
5310 fn)
5315 "#"
5318 ;; Make sure auto-save file names don't contain characters
5319 ;; invalid for the underlying filesystem.
5321 ;; Don't modify remote (ange-ftp) filenames
5324 result))))
5326 ;; Deal with buffers that don't have any associated files. (Mail
5327 ;; mode tends to create a good number of these.)
5331 file-name)
5332 ;; Restrict the characters used in the file name to those which
5333 ;; are known to be safe on all filesystems, url-encoding the
5334 ;; rest.
5335 ;; We do this on all platforms, because even if we are not
5336 ;; running on DOS/Windows, the current directory may be on a
5337 ;; mounted VFAT filesystem, such as a USB memory stick.
5341 ;; For multibyte characters, this will produce more than
5342 ;; 2 hex digits, so is not true URL encoding.
5346 ;; Generate the file name.
5352 ;; Try a few alternative directories, to get one we can
5353 ;; write it.
5359 ;; Don't modify remote (ange-ftp) filenames
5361 ;; The call to convert-standard-filename is in case
5362 ;; buffer-name includes characters not allowed by the
5363 ;; DOS/Windows filesystems. make-temp-file writes to the
5364 ;; file it creates, so we must fix the file name _before_
5365 ;; make-temp-file is called.
5367 fname))
5369 ;; make-temp-file creates the file,
5370 ;; but we don't want it to exist until we do an auto-save.
5374 file-name)))
5377 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5378 FILENAME should lack slashes. You can redefine this for customization."
5380 \f
5382 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5383 The generated regexp will match a filename only if the filename
5384 matches that wildcard according to shell rules. Only wildcards known
5385 by `sh' are supported."
5387 ;; Copy the initial run of non-special characters.
5390 ;; If no special characters, we're almost done.
5394 j)
5396 result
5417 ;; Found "[^". Insert a `\0' character
5418 ;; (which cannot happen in a filename)
5419 ;; into the character class, so that `^'
5420 ;; is not the first character after `[',
5421 ;; and thus non-special in a regexp.
5426 ;; I don't think `]' can appear in a
5427 ;; character class in a wildcard, but
5428 ;; let's be general here.
5435 i
5448 ;; Shell wildcards should match the entire filename,
5449 ;; not its part. Make the regexp say so.
5451 \f
5454 "Switches for `list-directory' to pass to `ls' for brief listing."
5460 "Switches for `list-directory' to pass to `ls' for verbose listing."
5465 "Expand wildcard pattern PATTERN.
5466 This returns a list of file names which match the pattern.
5468 If PATTERN is written as an absolute file name,
5469 the values are absolute also.
5471 If PATTERN is written as a relative file name, it is interpreted
5472 relative to the current default directory, `default-directory'.
5473 The file names returned are normally also relative to the current
5474 default directory. However, if FULL is non-nil, they are absolute."
5478 ;; A list of all dirs that DIRPART specifies.
5479 ;; This can be more than one dir
5480 ;; if DIRPART contains wildcards.
5484 dirpart)))
5488 contents)
5493 ;; Filter out "." and ".."
5498 name))
5505 this-dir-contents)
5506 this-dir-contents)
5507 contents))))
5509 contents)))
5511 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5515 "Display a list of files in or matching DIRNAME, a la `ls'.
5516 DIRNAME is globbed by the shell if necessary.
5517 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5518 Actions controlled by variables `list-directory-brief-switches'
5519 and `list-directory-verbose-switches'."
5523 nil default-directory nil)
5524 pfx)))
5526 list-directory-brief-switches))
5527 buffer)
5539 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5547 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5549 PATTERN is assumed to represent a file-name wildcard suitable for the
5550 underlying filesystem. For Unix and GNU/Linux, each character from the
5552 the parts of the pattern which don't include wildcard characters are
5553 quoted with double quotes.
5556 on Windows), so PATTERN can use them to quote wildcard characters that
5557 need to be passed verbatim to shell commands."
5561 ;; DOS/Windows don't allow `"' in file names. So if the
5562 ;; argument has quotes, we can safely assume it is already
5563 ;; quoted by the caller.
5565 ;; We quote [&()#$'] in case their shell is a port of a
5566 ;; Unixy shell. We quote [,=+] because stock DOS and
5567 ;; Windows shells require that in some cases, such as
5568 ;; passing arguments to batch files that use positional
5569 ;; arguments like %1.
5571 pattern
5574 end)
5591 pattern))))
5598 "Program to get the amount of free space on a file system.
5599 We assume the output has the format of `df'.
5600 The value of this variable must be just a command name or file name;
5601 if you want to specify options, use `directory-free-space-args'.
5603 A value of nil disables this feature.
5605 If the function `file-system-info' is defined, it is always used in
5606 preference to the program given by this variable."
5612 "Options to use when running `directory-free-space-program'."
5617 "Return the amount of free space on directory DIR's file system.
5618 The return value is a string describing the amount of free
5619 space (normally, the number of free 1KB blocks).
5621 This function calls `file-system-info' if it is available, or
5622 invokes the program specified by `directory-free-space-program'
5623 and `directory-free-space-args'. If the system call or program
5624 is unsuccessful, or if DIR is a remote directory, this function
5625 returns nil."
5627 ;; Try to find the number of free blocks. Non-Posix systems don't
5628 ;; always have df, but might have an equivalent system call.
5637 ;; Avoid failure if the default directory does
5638 ;; not exist (Bug#2631, Bug#3911).
5641 nil t nil
5642 directory-free-space-args
5643 dir)
5645 ;; Assume that the "available" column is before the
5646 ;; "capacity" column. Find the "%" and scan backward.
5650 "[[:space:]]+[^[:space:]]+%[^%]*$"
5657 ;; The following expression replaces `dired-move-to-filename-regexp'.
5661 ;; In some locales, month abbreviations are as short as 2 letters,
5662 ;; and they can be followed by ".".
5663 ;; In Breton, a month name can include a quote character.
5676 s "+"
5679 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5680 ;; omits the Kanji characters after month and day-of-month.
5681 ;; On Mac OS X 10.3, the date format in East Asian locales is
5682 ;; day-of-month digits followed by month digits.
5688 ;; The "[0-9]" below requires the previous column to end in a digit.
5689 ;; This avoids recognizing `1 may 1997' as a date in the line:
5690 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5692 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5694 ;; For non-iso date formats, we add the ".*" in order to find
5695 ;; the last possible match. This avoids recognizing
5696 ;; `jservice 10 1024' as a date in the line:
5697 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5699 ;; vc dired listings provide the state or blanks between file
5700 ;; permissions and date. The state is always surrounded by
5701 ;; parantheses:
5702 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5703 ;; This is not supported yet.
5708 "Regular expression to match up to the file name in a directory listing.
5709 The default value is designed to recognize dates and times
5714 ;; insert-directory
5715 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5716 ;; FULL-DIRECTORY-P is nil.
5717 ;; The single line of output must display FILE's name as it was
5718 ;; given, namely, an absolute path name.
5719 ;; - must insert exactly one line for each file if WILDCARD or
5720 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5721 ;; before the file lines, plus optional text after the file lines.
5722 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5723 ;; allowed.
5724 ;; File lines should display the basename.
5725 ;; - must be consistent with
5726 ;; - functions dired-move-to-filename, (these two define what a file line is)
5727 ;; dired-move-to-end-of-filename,
5728 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5729 ;; dired-insert-headerline
5730 ;; dired-after-subdir-garbage (defines what a "total" line is)
5731 ;; - variable dired-subdir-regexp
5732 ;; - may be passed "--dired" as the first argument in SWITCHES.
5733 ;; Filename handlers might have to remove this switch if their
5734 ;; "ls" command does not support it.
5736 "Insert directory listing for FILE, formatted according to SWITCHES.
5737 Leaves point after the inserted text.
5738 SWITCHES may be a string of options, or a list of strings
5739 representing individual options.
5740 Optional third arg WILDCARD means treat FILE as shell wildcard.
5741 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5742 switches do not contain `d', so that a full listing is expected.
5744 This works by running a directory listing program
5745 whose name is in the variable `insert-directory-program'.
5746 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5748 When SWITCHES contains the long `--dired' option, this function
5749 treats it specially, for the sake of dired. However, the
5750 normally equivalent short `-D' option is just passed on to
5751 `insert-directory-program', as any other option."
5752 ;; We need the directory in order to find the right handler.
5757 wildcard full-directory-p)
5760 ;; Read the actual directory using `insert-directory-program'.
5761 ;; RESULT gets the status code.
5763 ;; putting text property `dired-filename, decode one
5764 ;; bunch by one to preserve that property.
5766 ;; This is to control encoding the arguments in call-process.
5770 default-file-name-coding-system))))
5773 ;; Run ls in the directory part of the file pattern
5774 ;; using the last component as argument.
5781 shell-file-name nil t nil
5782 "-c"
5784 ""
5786 insert-directory-program
5787 " -d "
5789 switches
5791 " -- "
5792 ;; Quote some characters that have
5793 ;; special meanings in shells; but
5794 ;; don't quote the wildcards--we want
5795 ;; them to be special. We also
5796 ;; currently don't quote the quoting
5797 ;; characters in case people want to
5798 ;; use them explicitly to quote
5799 ;; wildcard characters.
5801 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5802 ;; directory if FILE is a symbolic link.
5809 insert-directory-program nil t nil
5813 ;; Split the switches at any spaces so we can
5814 ;; pass separate options as separate args.
5816 ;; Avoid lossage if FILE starts with `-'.
5824 file))))))))
5826 ;; If we got "//DIRED//" in the output, it means we got a real
5827 ;; directory listing, even if `ls' returned nonzero.
5828 ;; So ignore any errors.
5841 ;; The first time ls returns an error,
5842 ;; find the version numbers of ls,
5843 ;; and set insert-directory-ls-version
5844 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5845 ;; is equal or if the info cannot be obtained.
5846 ;; (That can mean it isn't GNU ls.)
5856 comparison)
5872 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5876 ;; If `insert-directory-program' failed, signal an error.
5878 ;; Delete the error message it may have output.
5880 ;; On non-Posix systems, we cannot open a directory, so
5881 ;; don't even try, because that will always result in
5882 ;; the ubiquitous "Access denied". Instead, show the
5883 ;; command line so the user can try to guess what went wrong.
5888 insert-directory-program
5890 file result)
5891 ;; Unix. Access the file to get a suitable error.
5898 ;; The following overshoots by one line for an empty
5899 ;; directory listed with "--dired", but without "-a"
5900 ;; switch, where the ls output contains a
5901 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5902 ;; We take care of that case later.
5910 error-lines)
5911 ;; Find all the lines that are error messages,
5912 ;; and record the bounds of each one.
5919 ;; Now read the numeric positions of file names.
5926 error-lines))
5929 error-lines)))
5931 ;; End is followed by \n or by " -> ".
5933 ;; It seems that we can't trust ls's output as to
5934 ;; byte positions of filenames.
5940 ;; Take care of the case where the ls output contains a
5941 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5942 ;; and we went one line too far back (see above).
5947 ;; Now decode what read if necessary.
5949 file-name-coding-system
5950 default-file-name-coding-system
5952 coding-no-eol
5953 val pos)
5957 ;; If no coding system is specified or detection is
5958 ;; requested, detect the coding.
5972 ;; Force no eol conversion on a file name, so
5973 ;; that CR is preserved.
5981 ;; Try to insert the amount of free space.
5984 ;; First find the line to put it on.
5988 ;; Replace "total" with "used", to avoid confusion.
5994 "Convert `ls --dired' file name position value POS to a buffer position.
5995 File name position values returned in ls --dired output
5996 count only stdout; they don't count the error messages sent to stderr.
5997 So this function converts to them to real buffer positions.
5998 ERROR-LINES is a list of buffer positions of error message lines,
5999 of the form (START END)."
6003 pos)
6007 "Insert directory listing for FILE, formatted according to SWITCHES.
6009 Like `insert-directory', but if FILE does not exist, it inserts a
6010 message to that effect instead of signaling an error."
6013 ;; Simulate the message printed by `ls'.
6017 "Functions to call with no arguments to query about killing Emacs.
6018 If any of these functions returns nil, killing Emacs is cancelled.
6019 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6023 "How to ask for confirmation when leaving Emacs.
6024 If nil, the default, don't ask at all. If the value is non-nil, it should
6025 be a predicate function such as `yes-or-no-p'."
6033 "Offer to save each buffer, then kill this Emacs process.
6034 With prefix ARG, silently save all file-visiting buffers, then kill."
6043 ;; process-list is not defined on MSDOS.
6045 active)
6054 ;; Query the user for other things, perhaps.
6061 "Offer to save each buffer, then kill the current connection.
6062 If the current frame has no client, kill Emacs itself.
6064 With prefix ARG, silently save all file-visiting buffers, then kill.
6066 If emacsclient was started with a list of filenames to edit, then
6067 only these files will be asked to be saved."
6072 \f
6073 ;; We use /: as a prefix to "quote" a file name
6074 ;; so that magic file name handlers will not apply to it.
6078 file-name-handler-alist))
6080 ;; We depend on being the last handler on the list,
6081 ;; so that anything else which does need handling
6082 ;; has been handled already.
6083 ;; So it is safe for us to inhibit *all* magic file name handlers.
6092 default-directory))
6093 ;; Get a list of the indices of the args which are file names.
6096 ;; The first six are special because they
6097 ;; return a file name. We want to include the /:
6098 ;; in the return value.
6099 ;; So just avoid stripping it in the first place.
6106 ;; `identity' means just return the first arg
6107 ;; not stripped of its quoting.
6109 ;; `add' means add "/:" to the result.
6111 ;; `quote' means add "/:" to buffer-file-name.
6113 ;; `unquote-then-quote' means set buffer-file-name
6114 ;; temporarily to unquoted filename.
6116 ;; List the arguments which are filenames.
6124 ;; For all other operations, treat the first argument only
6125 ;; as the file name.
6127 method
6128 ;; Copy ARGUMENTS so we can replace elements in it.
6132 ;; Strip off the /: from the file names that have it.
6140 "/"
6156 res))
6159 \f
6160 ;; Symbolic modes and read-file-modes.
6163 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6164 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6165 Others, or All) for whom to produce the mask.
6166 The bit-mask that is returned extracts from mode bits the access rights
6167 for the specified category of users."
6175 "Convert CHAR to a numeric value of mode bits.
6176 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6177 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6184 ;; Rights relative to the previous file modes.
6195 "Convert a symbolic mode string specification to an equivalent number.
6197 WHO-MASK is the bit-mask specifying the category of users to which to
6198 apply the access permissions. See `file-modes-char-to-who'.
6199 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6200 RIGHTS request to add, remove, or set permissions based on existing ones,
6207 char-right)
6214 num-rights
6218 op char-right)))
6219 num-rights))
6222 "Convert symbolic file modes to numeric file modes.
6223 MODES is the string to convert, it should match
6226 notation.
6227 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6228 MODES request to add, remove, or set permissions based on existing ones,
6242 num-who num-modes)
6245 num-modes)))
6248 "Read file modes in octal or symbolic notation and return its numeric value.
6249 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6250 ORIG-FILE is the name of a file on whose mode bits to base returned
6251 permissions if what user types requests to add, remove, or set permissions
6267 nil nil default)))
6273 \f
6274 ;; Trashcan handling.
6276 "Directory for `move-file-to-trash' to move files and directories to.
6277 This directory is only used when the function `system-move-file-to-trash'
6278 is not defined.
6279 Relative paths are interpreted relative to `default-directory'.
6280 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6290 "Move the file (or directory) named FILENAME to the trash.
6291 When `delete-by-moving-to-trash' is non-nil, this function is
6292 called by `delete-file' and `delete-directory' instead of
6293 deleting files outright.
6295 If the function `system-move-file-to-trash' is defined, call it
6296 with FILENAME as an argument.
6297 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6298 directory.
6299 Otherwise, trash FILENAME using the freedesktop.org conventions,
6300 like the GNOME, KDE and XFCE desktop environments. Emacs only
6304 ;; If `trash-directory' is non-nil, move the file there.
6308 trash-dir)))
6309 ;; We can't trash a parent directory of trash-directory.
6312 trash-dir filename))
6315 ;; Ensure that the trashed file-name is unique.
6322 ;; If `system-move-file-to-trash' is defined, use it.
6325 ;; Otherwise, use the freedesktop.org method, as specified at
6326 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6337 ;; Check if we have permissions to delete.
6341 ;; The trashed file cannot be the trash dir or its parent.
6344 trash-files-dir filename))
6347 trash-info-dir filename))
6349 ;; Ensure that the trash directory exists; otherwise, create it.
6358 ;; Try to move to trash with .trashinfo undo information
6363 ;; Perform url-encoding on FN. For compatibility with
6364 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6365 ;; for path separators.
6370 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6371 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6384 fn))
6389 ;; Attempt to make .trashinfo file, trying up to 5
6390 ;; times. The .trashinfo file is opened with O_EXCL,
6391 ;; as per trash-spec 0.7, even if that can be a problem
6392 ;; on old NFS versions...
6396 trash-files-dir))
6398 success info-fn)
6403 trash-info-dir))
6411 ;; Uniqify new-fn. (Some file managers do not
6412 ;; like Emacs-style backup file names---e.g. bug
6413 ;; 170956 in Konqueror bug tracker.)
6418 ;; Finally, try to move the file to the trashcan.
6422 \f
6447 ;;; files.el ends here