| blob | 91fed0d1274a1f971a3ea70e2c83c8f5777d127b |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
30 ;;; Code:
37 "Backups of edited data files."
41 "Finding files."
46 "Non-nil means delete auto-save file when a buffer is saved or killed.
48 Note that the auto-save file will not be deleted if the buffer is killed
49 when it has unsaved changes."
54 nil
55 "Alist of abbreviations for file directories.
56 A list of elements of the form (FROM . TO), each meaning to replace
57 FROM with TO when it appears in a directory name. This replacement is
58 done when setting up the default directory of a newly visited file.
60 FROM is matched against directory names anchored at the first
64 FROM and TO should be equivalent names, which refer to the
65 same directory. Do not use `~' in the TO strings;
66 they should be ordinary absolute directory names.
68 Use this feature when you have directories which you normally refer to
69 via absolute symbolic links. Make TO the name of the link, and FROM
70 the name it is linked to."
79 "Non-nil means make a backup of a file the first time it is saved.
80 This can be done by renaming the file or by copying.
82 Renaming means that Emacs renames the existing file so that it is a
83 backup file, then writes the buffer into a new file. Any other names
84 that the old file had will now refer to the backup file. The new file
85 is owned by you and its group is defaulted.
87 Copying means that Emacs copies the existing file into the backup
88 file, then writes the buffer on top of the existing file. Any other
89 names that the old file had will now refer to the new (edited) file.
90 The file's owner and group are unchanged.
92 The choice of renaming or copying is controlled by the variables
93 `backup-by-copying', `backup-by-copying-when-linked',
94 `backup-by-copying-when-mismatch' and
95 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
99 ;; Do this so that local variables based on the file name
100 ;; are not overridden by the major mode.
102 "Non-nil means don't make a backup, regardless of the other parameters.
103 This variable is intended for use by making it local to a buffer.
108 "Non-nil means always use copying to create backup files.
109 See documentation of variable `make-backup-files'."
114 "Non-nil means use copying to create backups for files with multiple names.
115 This causes the alternate names to refer to the latest version as edited.
116 This variable is relevant only if `backup-by-copying' is nil."
121 "Non-nil means create backups by copying if this preserves owner or group.
122 Renaming may still be used (subject to control of other variables)
123 when it would not result in changing the owner or group of the file;
124 that is, for files which are owned by you and whose group matches
125 the default for a new file created there by you.
126 This variable is relevant only if `backup-by-copying' is nil."
132 "Non-nil means create backups by copying to preserve a privileged owner.
133 Renaming may still be used (subject to control of other variables)
134 when it would not result in changing the owner of the file or if the owner
135 has a user id greater than the value of this variable. This is useful
136 when low-numbered uid's are used for special system users (such as root)
137 that must maintain ownership of certain files.
138 This variable is relevant only if `backup-by-copying' and
139 `backup-by-copying-when-mismatch' are nil."
144 "Predicate that looks at a file name and decides whether to make backups.
148 "Non-nil in a buffer means always offer to save buffer on exit.
149 Do so even if the buffer is not visiting a file.
150 Automatically local in all buffers."
156 "Non-nil means find a file under alternative names, in existing buffers.
157 This means if any existing buffer is visiting the file you want
158 under another name, you get the existing buffer instead of a new buffer."
163 "Non-nil means visit a file under its truename.
164 The truename of a file is found by chasing all links
165 both at the file level and at the levels of the containing directories."
171 "Specify which files should be reverted without query.
172 The value is a list of regular expressions.
173 If the file name matches one of these regular expressions,
174 then `revert-buffer' reverts the file without querying
175 if the file has changed on disk and you have not edited the buffer."
180 "The device number and file number of the file visited in the current buffer.
181 The value is a list of the form (FILENUM DEVNUM).
182 This pair of numbers uniquely identifies the file.
200 "The directory for writing temporary files."
207 "The directory for writing small temporary files.
208 If non-nil, this directory is used instead of `temporary-file-directory'
209 by programs that create small temporary files. This is for systems that
210 have fast storage with limited space, such as a RAM disk."
215 ;; The system null device. (Should reference NULL_DEVICE from C.)
243 "Non-nil means protect against I/O errors while saving files.
244 Some modes set this non-nil in particular buffers.
246 This feature works by writing the new contents into a temporary file
247 and then renaming the temporary file to replace the original.
248 In this way, any I/O error in writing leaves the original untouched,
249 and there is never any instant where the file is nonexistent.
251 Note that this feature forces backups to be made by copying.
252 Yet, at the same time, saving a precious file
253 breaks any hard links between it and other files.
255 This feature is advisory: for example, if the directory in which the
256 file is being saved is not writable, Emacs may ignore a non-nil value
257 of `file-precious-flag' and write directly into the file.
259 See also: `break-hardlink-on-save'."
264 "Non-nil means when saving a file that exists under several names
265 \(i.e., has multiple hardlinks), break the hardlink associated with
266 `buffer-file-name' and write to a new file, so that the other
267 instances of the file are not affected by the save.
269 If `buffer-file-name' refers to a symlink, do not break the symlink.
271 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
272 For example, if the directory in which a file is being saved is not
273 itself writable, then error instead of saving in some
274 hardlink-nonbreaking way.
276 See also `backup-by-copying' and `backup-by-copying-when-linked'."
282 "Control use of version numbers for backup files.
283 When t, make numeric backup versions unconditionally.
284 When nil, make them for files that have some already.
285 The value `never' means do not make them."
295 "When cleaning directory, number of versions to keep."
301 "If t, delete excess backup versions silently.
302 If nil, ask confirmation. Any other value prevents any trimming."
309 "Number of oldest versions to keep when a new numbered backup is made."
315 "Number of newest versions to keep when a new numbered backup is made.
316 Includes the new backup. Must be > 0"
322 "Whether to add a newline automatically at the end of the file.
324 A value of t means do this only when the file is about to be saved.
325 A value of `visit' means do this right after the file is visited.
326 A value of `visit-save' means do it at both of those times.
327 Any other non-nil value means ask user whether to add a newline, when saving.
328 A value of nil means don't add newlines.
330 Certain major modes set this locally to the value obtained
331 from `mode-require-final-newline'."
340 "Whether to add a newline at end of file, in certain major modes.
341 Those modes set `require-final-newline' to this value when you enable them.
342 They do so because they are often used for files that are supposed
343 to end in newlines, and the question is how to arrange that.
345 A value of t means do this only when the file is about to be saved.
346 A value of `visit' means do this right after the file is visited.
347 A value of `visit-save' means do it at both of those times.
348 Any other non-nil value means ask user whether to add a newline, when saving.
350 A value of nil means do not add newlines. That is a risky choice in this
351 variable since this value is used for modes for files that ought to have
352 final newlines. So if you set this to nil, you must explicitly check and
353 add a final newline, whenever you save a file that really needs one."
363 "Non-nil says by default do auto-saving of every file-visiting buffer."
369 ;; Don't put "\\2" inside expand-file-name, since it will be
370 ;; transformed to "/2" on DOS/Windows.
372 "Transforms to apply to buffer file name before making auto-save file name.
373 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
374 REGEXP is a regular expression to match against the file name.
375 If it matches, `replace-match' is used to replace the
376 matching part with REPLACEMENT.
377 If the optional element UNIQUIFY is non-nil, the auto-save file name is
378 constructed by taking the directory part of the replaced file-name,
379 concatenated with the buffer file name with all directory separators
380 changed to `!' to prevent clashes. This will not work
381 correctly if your filesystem truncates the resulting name.
383 All the transforms in the list are tried, in the order they are listed.
384 When one transform applies, its result is final;
385 no further transforms are tried.
387 The default value is set up to put the auto-save file into the
388 temporary directory (see the variable `temporary-file-directory') for
389 editing a remote file.
391 On MS-DOS filesystems without long names this variable is always
392 ignored."
400 "Non-nil means save word abbrevs too when files are saved.
401 If `silently', don't ask the user before saving."
406 "Non-nil means allow `find-file' to visit directories.
407 To visit the directory, `find-file' runs `find-directory-functions'."
412 "List of functions to try in sequence to visit a directory.
413 Each function is called with the directory name as the sole argument
414 and should return either a buffer or nil."
418 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
420 "List of functions to try in sequence to get a file name at point.
421 Each function should return either nil or a file name found at the
422 location of point in the current buffer."
426 ;;;It is not useful to make this a local variable.
427 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
429 "List of functions to be called for `find-file' on nonexistent file.
430 These functions are called as soon as the error is detected.
431 Variable `buffer-file-name' is already set up.
436 ;;;It is not useful to make this a local variable.
437 ;;;(put 'find-file-hooks 'permanent-local t)
440 "List of functions to be called after a buffer is loaded from a file.
441 The buffer's local variables (if any) will have been processed before the
442 functions are called."
449 "List of functions to be called before writing out a buffer to a file.
450 If one of them returns non-nil, the file is considered already written
451 and the rest are not called.
452 These hooks are considered to pertain to the visited file.
453 So any buffer-local binding of this variable is discarded if you change
455 change the major mode.
457 This hook is not run if any of the functions in
458 `write-contents-functions' returns non-nil. Both hooks pertain
459 to how to save a buffer to file, for instance, choosing a suitable
460 coding system and setting mode bits. (See Info
461 node `(elisp)Saving Buffers'.) To perform various checks or
472 "List of functions to be called before writing out a buffer to a file.
473 If one of them returns non-nil, the file is considered already written
474 and the rest are not called and neither are the functions in
475 `write-file-functions'.
477 This variable is meant to be used for hooks that pertain to the
478 buffer's contents, not to the particular visited file; thus,
479 `set-visited-file-name' does not clear this variable; but changing the
480 major mode does clear it.
482 For hooks that _do_ pertain to the particular visited file, use
483 `write-file-functions'. Both this variable and
484 `write-file-functions' relate to how a buffer is saved to file.
485 To perform various checks or updates before the buffer is saved,
492 "Control use of local variables in files you visit.
493 The value can be t, nil, :safe, :all, or something else.
495 A value of t means file local variables specifications are obeyed
496 if all the specified variable values are safe; if any values are
497 not safe, Emacs queries you, once, whether to set them all.
498 \(When you say yes to certain values, they are remembered as safe.)
500 :safe means set the safe variables, and ignore the rest.
501 :all means set all variables, whether safe or not.
502 (Don't set it permanently to :all.)
503 A value of nil means always ignore the file local variables.
505 Any other value means always query you once whether to set them all.
506 \(When you say yes to certain values, they are remembered as safe, but
509 This variable also controls use of major modes specified in
510 a -*- line.
513 always obeys file local variable specifications and the -*- line,
514 and ignores this variable."
515 :risky t
524 "Like `enable-local-variables' but meant for buffer-local bindings.
525 The meaningful values are nil and non-nil. The default is non-nil.
526 If a major mode sets this to nil, buffer-locally, then any local
527 variables list in the file will be ignored.
529 This variable does not affect the use of major modes
534 The value can be t, nil or something else.
535 A value of t means obey `eval' variables.
536 A value of nil means ignore them; anything else means query."
537 :risky t
543 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
552 "Non-nil means buffers visiting files read-only do so in view mode.
553 In fact, this means that all read-only buffers normally have
554 View mode enabled, including buffers that are read-only because
555 you visit a file you cannot alter, and buffers you make read-only
561 "History list of file names entered in the minibuffer.
563 Maximum length of the history list is determined by the value
565 \f
568 "Provides support for ange-ftp host name completion.
569 Runs the usual ange-ftp hook, but only for completion operations."
570 ;; Having this here avoids the need to load ange-ftp when it's not
571 ;; really in use.
577 inhibit-file-name-handlers)))
582 "Convert a standard file's name to something suitable for the OS.
583 This means to guarantee valid names and perhaps to canonicalize
584 certain patterns.
586 FILENAME should be an absolute file name since the conversion rules
587 sometimes vary depending on the position in the file name. E.g. c:/foo
588 is a valid DOS file name, but c:/bar/c:/foo is not.
590 This function's standard definition is trivial; it just returns
591 the argument. However, on Windows and DOS, replace invalid
592 characters. On DOS, make sure to obey the 8.3 limitations.
593 In the native Windows build, turn Cygwin names into native names,
594 and also turn slashes into backslashes if the shell requires it (see
595 `w32-shell-dos-semantics').
597 See Info node `(elisp)Standard File Names' for more details."
601 ;; Replace invalid filename characters with !
605 name)
606 filename))
609 "Read directory name, prompting with PROMPT and completing in directory DIR.
610 Value is not expanded---you must call `expand-file-name' yourself.
611 Default name to DEFAULT-DIRNAME if user exits with the same
612 non-empty string that was inserted by this function.
613 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
614 or just DIR if INITIAL is nil.)
615 If the user exits with an empty minibuffer, this function returns
616 an empty string. (This can only happen if the user erased the
617 pre-inserted contents or if `insert-default-directory' is nil.)
618 Fourth arg MUSTMATCH non-nil means require existing directory's name.
619 Non-nil and non-t means also require confirmation after completion.
620 Fifth arg INITIAL specifies text to start with.
621 DIR should be an absolute directory name. It defaults to
622 the value of `default-directory'."
627 dir))
628 mustmatch initial
631 \f
633 "Show the current default directory."
638 "Value of the CDPATH environment variable, as a list.
642 "Explode a search path into a list of directory names.
643 Directories are separated by occurrences of `path-separator'
644 \(which is colon in GNU and GNU-like systems)."
645 ;; We could use split-string here.
653 nil
658 cd-list)))
661 "Change current directory to given absolute file name DIR."
662 ;; Put the name into directory syntax now,
663 ;; because otherwise expand-file-name may give some bad results.
665 ;; We used to additionally call abbreviate-file-name here, for an
666 ;; unknown reason. Problem is that most buffers are setup
667 ;; without going through cd-absolute and don't call
668 ;; abbreviate-file-name on their default-directory, so the few that
669 ;; do end up using a superficially different directory.
681 "Make DIR become the current buffer's default directory.
682 If your environment includes a `CDPATH' variable, try each one of
683 that list of directories (separated by occurrences of
684 `path-separator') when resolving a relative directory name.
685 The path separator is colon in GNU and GNU-like systems."
688 default-directory default-directory
704 cd-path)
705 nil))
709 "Load the Lisp file named FILE."
710 ;; This is a case where .elc makes a lot of sense.
717 "Search for FILENAME through PATH.
718 If found, return the absolute file name of FILENAME, with its suffixes;
719 otherwise return nil.
720 PATH should be a list of directories to look in, like the lists in
721 `exec-path' or `load-path'.
722 If SUFFIXES is non-nil, it should be a list of suffixes to append to
725 If non-nil, PREDICATE is used instead of `file-readable-p'.
726 PREDICATE can also be an integer to pass to the `access' system call,
727 in which case file-name handlers are ignored. This usage is deprecated.
729 For compatibility, PREDICATE can also be one of the symbols
730 `executable', `readable', `writable', or `exists', or a list of
731 one or more of those symbols."
742 "Do completion for file names passed to `locate-file'."
745 ;; FIXME: maybe we should use completion-file-name-table instead,
746 ;; tho at least for `load', the arg is passed through
747 ;; substitute-in-file-name for historical reasons.
766 string-file dir))
772 string-dir names string-file pred action)))))
775 "Do completion for file names passed to `locate-file'.
776 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
779 string nil action))
784 "Regexp of directory names which stop the search in `locate-dominating-file'.
785 Any directory whose name matches this regexp will be treated like
786 a kind of root directory by `locate-dominating-file' which will stop its search
787 when it bumps into it.
788 The default regexp prevents fruitless and time-consuming attempts to find
789 special files in directories in which filenames are interpreted as hostnames,
792 ;; (defun locate-dominating-files (file regexp)
793 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
794 ;; Stop at the first parent where a matching file is found and return the list
795 ;; of files that that match in this directory."
796 ;; (catch 'found
797 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
798 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
799 ;; (let ((user nil)
800 ;; ;; Abbreviate, so as to stop when we cross ~/.
801 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
802 ;; files)
803 ;; (while (and dir
804 ;; ;; As a heuristic, we stop looking up the hierarchy of
805 ;; ;; directories as soon as we find a directory belonging to
806 ;; ;; another user. This should save us from looking in
807 ;; ;; things like /net and /afs. This assumes that all the
808 ;; ;; files inside a project belong to the same user.
809 ;; (let ((prev-user user))
810 ;; (setq user (nth 2 (file-attributes dir)))
811 ;; (or (null prev-user) (equal user prev-user))))
812 ;; (if (setq files (condition-case nil
813 ;; (directory-files dir 'full regexp 'nosort)
814 ;; (error nil)))
815 ;; (throw 'found files)
816 ;; (if (equal dir
817 ;; (setq dir (file-name-directory
818 ;; (directory-file-name dir))))
819 ;; (setq dir nil))))
820 ;; nil)))
823 "Look up the directory hierarchy from FILE for a file named NAME.
824 Stop at the first parent directory containing a file NAME,
825 and return the directory. Return nil if not found."
826 ;; We used to use the above locate-dominating-files code, but the
827 ;; directory-files call is very costly, so we're much better off doing
828 ;; multiple calls using the code in here.
829 ;;
830 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
831 ;; `name' in /home or in /.
835 ;; `user' is not initialized outside the loop because
836 ;; `file' may not exist, so we may have to walk up part of the
837 ;; hierarchy before we find the "initial UID".
839 try)
842 ;; FIXME: Disabled this heuristic because it is sometimes
843 ;; inappropriate.
844 ;; As a heuristic, we stop looking up the hierarchy of
845 ;; directories as soon as we find a directory belonging
846 ;; to another user. This should save us from looking in
847 ;; things like /net and /afs. This assumes that all the
848 ;; files inside a project belong to the same user.
849 ;; (let ((prev-user user))
850 ;; (setq user (nth 2 (file-attributes file)))
851 ;; (and prev-user (not (equal user prev-user))))
859 root))
863 "Search for COMMAND in `exec-path' and return the absolute file name.
864 Return nil if COMMAND is not found anywhere in `exec-path'."
865 ;; Use 1 rather than file-executable-p to better match the behavior of
866 ;; call-process.
870 "Load the Emacs Lisp library named LIBRARY.
871 This is an interface to the function `load'. LIBRARY is searched
872 for in `load-path', both with and without `load-suffixes' (as
873 well as `load-file-rep-suffixes').
875 See Info node `(emacs)Lisp Libraries' for more details.
876 See `load-file' for a different interface to `load'."
880 load-path
885 "Test whether FILE specifies a location on a remote system.
886 Returns nil or a string identifying the remote connection (ideally
887 a prefix of FILE). For example, the remote identification for filename
890 less reliable than accessing local files.
891 Furthermore, relative file names do not work across remote connections.
893 IDENTIFICATION specifies which part of the identification shall
894 be returned as string. IDENTIFICATION can be the symbol
895 `method', `user', `host' or `localname'; any other value is
896 handled like nil and means to return the complete identification
897 string.
899 If CONNECTED is non-nil, the function returns an identification only
900 if FILE is located on a remote system, and a connection is established
901 to that remote system.
903 `file-remote-p' will never open a connection on its own."
907 nil)))
910 "Copy the file FILE into a temporary file on this machine.
911 Returns the name of the local copy, or nil, if FILE is directly
912 accessible."
913 ;; This formerly had an optional BUFFER argument that wasn't used by
914 ;; anything.
918 nil)))
921 "Return the truename of FILENAME, which should be absolute.
922 The truename of a file name is found by chasing symbolic links
923 both at the level of the file and at the level of the directories
924 containing it, until no links are left at any level.
927 ;; COUNTER and PREV-DIRS are only used in recursive calls.
928 ;; COUNTER can be a cons cell whose car is the count of how many
929 ;; more links to chase before getting an error.
930 ;; PREV-DIRS can be a cons cell whose car is an alist
931 ;; of truenames we've just recently computed.
945 ;; For speed, remove the ange-ftp completion handler from the list.
946 ;; We know it's not needed here.
947 ;; For even more speed, do this only on the outermost call.
954 ;; andrewi@harlequin.co.uk - none of the following code (except for
955 ;; invoking the file-name handler) currently applies on Windows
956 ;; (ie. there are no native symlinks), but there is an issue with
957 ;; case differences being ignored by the OS, and short "8.3 DOS"
958 ;; name aliases existing for all files. (The short names are not
959 ;; reported by directory-files, but can be used to refer to files.)
960 ;; It seems appropriate for file-truename to resolve these issues in
961 ;; the most natural way, which on Windows is to call the function
962 ;; `w32-long-file-name' - this returns the exact name of a file as
963 ;; it is stored on disk (expanding short name aliases with the full
964 ;; name in the process).
967 ;; For file name that has a special handler, call handler.
968 ;; This is so that ange-ftp can save time by doing a no-op.
971 ;; If filename contains a wildcard, newname will be the old name.
973 ;; If filename exists, use the long name. If it doesn't exist,
974 ;; drill down until we find a directory that exists, and use
975 ;; the long name of that, with the extra non-existent path
976 ;; components concatenated.
978 missing rest)
981 ;; Include the preceding directory separator in the missing
982 ;; part so subsequent recursion on the rest works.
987 ""
992 ;; If this file directly leads to a link, process that iteratively
993 ;; so that we don't use lots of stack.
999 ;; For file name that has a special handler, call handler.
1000 ;; This is so that ange-ftp can save time by doing a no-op.
1003 done t)
1005 target dirfile)
1006 ;; Get the truename of the directory.
1008 ;; If these are equal, we have the (or a) root directory.
1010 ;; If this is the same dir we last got the truename for,
1011 ;; save time--don't recalculate.
1021 done t)
1024 done t)
1025 ;; Put it back on the file name.
1027 ;; Is the file name the name of a link?
1030 ;; Yes => chase that link, then start all over
1031 ;; since the link may point to a directory name that uses links.
1032 ;; We can't safely use expand-file-name here
1033 ;; since target might look like foo/../bar where foo
1034 ;; is itself a link. Instead, we handle . and .. above.
1037 target
1039 done nil)
1040 ;; No, we are done!
1042 filename))
1045 "Chase links in FILENAME until a name that is not a link.
1046 Unlike `file-truename', this does not check whether a parent
1047 directory name is a symbolic link.
1048 If the optional argument LIMIT is a number,
1049 it means chase no more than that many links and then stop."
1057 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1060 ;; Handle `..' by hand, since it needs to work in the
1061 ;; target of any directory symlink.
1062 ;; This code is not quite complete; it does not handle
1063 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1067 ;; Chase links in the default dir of the symlink.
1071 ;; Now find the parent of that dir.
1075 newname))
1078 "Create a temporary file.
1079 The returned file name (created by appending some random characters at the end
1080 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1081 is guaranteed to point to a newly created empty file.
1082 You can then use `write-region' to write new data into the file.
1084 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1086 If SUFFIX is non-nil, add that at the end of the file name."
1088 file)
1091 ;; Create temp files with strict access rights. It's easy to
1092 ;; loosen them later, whereas it's impossible to close the
1093 ;; time-window of loose permissions otherwise.
1101 temporary-file-directory)
1103 temporary-file-directory))))
1109 nil)
1111 ;; the file was somehow created by someone else between
1112 ;; `make-temp-name' and `write-region', let's try again.
1113 nil)
1114 file)
1115 ;; Reset the umask.
1119 "Change the encoding of FILE's name from CODING to NEW-CODING.
1120 The value is a new name of FILE.
1121 Signals a `file-already-exists' error if a file of the new name
1122 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1123 is non-nil. A number as fourth arg means request confirmation if
1124 the new name already exists. This is what happens in interactive
1125 use with M-x."
1128 default-file-name-coding-system))
1130 from-coding to-coding)
1132 ;; We provide the default coding only when it seems that
1133 ;; the filename is correctly decoded by the default
1134 ;; coding.
1140 filename default-coding)
1141 default-coding))
1145 ;; We provide the default coding only when a user is going to
1146 ;; change the encoding not from the default coding.
1150 filename from-coding)))
1153 filename from-coding default-coding)
1154 default-coding)))
1158 default-file-name-coding-system))
1159 ;; FILE should have been decoded by DEFAULT-CODING.
1163 ;; Suppress further encoding.
1168 newname))
1169 \f
1171 "Whether confirmation is requested before visiting a new file or buffer.
1172 If nil, confirmation is not requested.
1173 If the value is `after-completion', confirmation is only
1174 requested if the user called `minibuffer-complete' right before
1175 `minibuffer-complete-and-exit'.
1176 Any other non-nil value means to request confirmation.
1178 This affects commands like `switch-to-buffer' and `find-file'."
1186 "Whether to request confirmation before visiting a new file or buffer.
1187 The variable `confirm-nonexistent-file-or-buffer' determines the
1188 return value, which may be passed as the REQUIRE-MATCH arg to
1189 `read-buffer' or `find-file-read-args'."
1197 "Read the name of a buffer to switch to and return as a string.
1198 It is intended for `switch-to-buffer' family of commands since they
1199 need to omit the name of current buffer from the list of completions
1200 and default values."
1205 ;; Since rbts-completion-table is built dynamically, we
1206 ;; can't just add it to the default value of
1207 ;; icomplete-with-completion-tables, so we add it
1208 ;; here manually.
1213 icomplete-with-completion-tables))))
1218 "Select the buffer specified by BUFFER-OR-NAME in another window.
1219 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1220 nil. Return the buffer switched to.
1222 If called interactively, prompt for the buffer name using the
1223 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1224 determines whether to request confirmation before creating a new
1225 buffer.
1227 If BUFFER-OR-NAME is a string and does not identify an existing
1228 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1229 nil, switch to the buffer returned by `other-buffer'.
1231 Optional second argument NORECORD non-nil means do not put this
1232 buffer at the front of the list of recently selected ones.
1234 This uses the function `display-buffer' as a subroutine; see its
1235 documentation for additional customization information."
1239 same-window-buffer-names same-window-regexps)
1243 "Switch to buffer BUFFER-OR-NAME in another frame.
1244 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1245 nil. Return the buffer switched to.
1247 If called interactively, prompt for the buffer name using the
1248 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1249 determines whether to request confirmation before creating a new
1250 buffer.
1252 If BUFFER-OR-NAME is a string and does not identify an existing
1253 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1254 nil, switch to the buffer returned by `other-buffer'.
1256 Optional second arg NORECORD non-nil means do not put this
1257 buffer at the front of the list of recently selected ones.
1259 This uses the function `display-buffer' as a subroutine; see its
1260 documentation for additional customization information."
1264 same-window-buffer-names same-window-regexps)
1268 "Display buffer BUFFER in another frame.
1269 This uses the function `display-buffer' as a subroutine; see
1270 its documentation for additional customization information."
1273 same-window-buffer-names same-window-regexps
1275 new-window)
1277 ;; This may have been here in order to prevent the new frame from hiding
1278 ;; the old frame. But it does more harm than good.
1279 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1280 ;;(lower-frame (window-frame new-window))
1282 ;; This may have been here in order to make sure the old-frame gets the
1283 ;; focus. But not only can it cause an annoying flicker, with some
1284 ;; window-managers it just makes the window invisible, with no easy
1285 ;; way to recover it. --Stef
1286 ;;(make-frame-invisible (window-frame old-window))
1287 ;;(make-frame-visible (window-frame old-window))
1288 ))
1291 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1292 BODY should use the minibuffer at most once.
1293 Recursive uses of the minibuffer are unaffected (FUN is not
1294 called additional times).
1296 This macro actually adds an auxiliary function that calls FUN,
1297 rather than FUN itself, to `minibuffer-setup-hook'."
1303 ;; Clear out this hook so it does not interfere
1304 ;; with any recursive minibuffer usage.
1315 t))
1318 "Edit file FILENAME.
1319 Switch to a buffer visiting file FILENAME,
1320 creating one if none already exists.
1321 Interactively, the default if you just type RET is the current directory,
1322 but the visited file name is available through the minibuffer history:
1323 type M-n to pull it into the minibuffer.
1325 You can visit files on remote machines by specifying something
1326 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1327 also visit local files as a different user by specifying
1328 /sudo::FILE for the file name.
1329 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1330 manual, for more about this.
1332 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1333 expand wildcards (if any) and visit multiple files. You can
1334 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1336 To visit a file without any kind of conversion and without
1347 "Edit file FILENAME, in another window.
1350 an existing one. See the function `display-buffer'.
1352 Interactively, the default if you just type RET is the current directory,
1353 but the visited file name is available through the minibuffer history:
1354 type M-n to pull it into the minibuffer.
1356 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1357 expand wildcards (if any) and visit multiple files."
1370 "Edit file FILENAME, in another frame.
1373 an existing one. See the function `display-buffer'.
1375 Interactively, the default if you just type RET is the current directory,
1376 but the visited file name is available through the minibuffer history:
1377 type M-n to pull it into the minibuffer.
1379 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1380 expand wildcards (if any) and visit multiple files."
1393 "Edit the existing file FILENAME.
1395 file names with wildcards."
1404 "Edit file FILENAME but don't allow changes.
1418 value))
1421 "Edit file FILENAME in another window but don't allow changes.
1435 value))
1438 "Edit file FILENAME in another frame but don't allow changes.
1452 value))
1455 "Find file FILENAME as a replacement for the file in the next window.
1456 This command does not select that window.
1460 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1461 expand wildcards (if any) and replace the file with multiple files."
1472 "Find alternate file: " file-dir nil
1474 t))))
1482 "Find file FILENAME, select its buffer, kill previous buffer.
1483 If the current buffer now contains an empty file that you just visited
1484 \(presumably by mistake), use this command to visit the file you really want.
1488 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1489 expand wildcards (if any) and replace the file with multiple files.
1491 If the current buffer is an indirect buffer, or the base buffer
1492 for one or more indirect buffers, the other buffer(s) are not
1493 killed."
1502 "Find alternate file: " file-dir nil
1504 t)))
1519 ;; Run `kill-buffer-hook' here. It needs to happen before
1520 ;; variables like `buffer-file-name' etc are set to nil below,
1521 ;; because some of the hooks that could be invoked
1522 ;; (e.g., `save-place-to-alist') depend on those variables.
1523 ;;
1524 ;; Note that `kill-buffer-hook' is not what queries whether to
1525 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1526 ;; asks that itself. Thus, there's no need to temporarily do
1527 ;; `(set-buffer-modified-p nil)' before running this hook.
1529 ;; Okay, now we can end-of-life the old buffer.
1536 ;; This prevents us from finding the same buffer
1537 ;; if we specified the same file again.
1541 ;; Likewise for dired buffers.
1545 ;; This executes if find-file gets an error
1546 ;; and does not really find anything.
1547 ;; We put things back as they were.
1548 ;; If find-file actually finds something, we kill obuf below.
1557 ;; We already ran these; don't run them again.
1560 \f
1562 "Create a suitably named buffer for visiting FILENAME, and return it.
1563 FILENAME (sans directory) is used unchanged if that name is free;
1564 otherwise a string <2> or <3> or ... is appended to get an unused name.
1565 Spaces at the start of FILENAME (sans directory) are removed."
1574 "Create and return a buffer with a name based on NAME.
1575 Choose the buffer's name using `generate-new-buffer-name'."
1579 "Regexp to match the automounter prefix in a directory name."
1587 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1589 home directory is a root directory) and removes automounter prefixes
1590 \(see the variable `automount-dir-prefix')."
1591 ;; Get rid of the prefixes added by the automounter.
1598 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1599 ;; To fix this right, we need a `file-name-case-sensitive-p'
1600 ;; function, but we don't have that yet, so just guess.
1603 ;; If any elt of directory-abbrev-alist matches this name,
1604 ;; abbreviate accordingly.
1610 ;; Compute and save the abbreviated homedir name.
1611 ;; We defer computing this until the first time it's needed, to
1612 ;; give time for directory-abbrev-alist to be set properly.
1613 ;; We include a slash at the end, to avoid spurious matches
1614 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1621 ;; If FILENAME starts with the abbreviated homedir,
1622 ;; make it start with `~' instead.
1624 ;; If the home dir is just /, don't change it.
1627 ;; MS-DOS root directories can come with a drive letter;
1628 ;; Novell Netware allows drive letters beyond `Z:'.
1636 filename)))
1639 "List of logical names for which visiting shouldn't save the true dirname."
1644 "Return the buffer visiting file FILENAME (a string).
1645 This is like `get-file-buffer', except that it checks for any buffer
1646 visiting the same file, possibly under a different name.
1647 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1648 and others are ignored.
1649 If there is no such live buffer, return nil."
1662 found)
1672 ;; Verify this buffer's file number
1673 ;; still belongs to its file.
1676 attributes)
1680 found))))
1681 \f
1683 "Non-nil means file-visiting commands should handle wildcards.
1684 For example, if you specify `*.c', that would visit all the files
1685 whose names match the pattern."
1691 "Non-nil means suppress warning messages for symlinked files.
1692 When nil, Emacs prints a warning when visiting a file that is already
1693 visited, but with a different name. Setting this option to t
1694 suppresses this warning."
1700 "Maximum size of file above which a confirmation is requested.
1701 When nil, never request confirmation."
1708 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1709 OP-TYPE specifies the file operation being performed (for message to user)."
1719 "Read file FILENAME into a buffer and return the buffer.
1720 If a buffer exists visiting FILENAME, return that one, but
1721 verify that the file has not changed since visited or saved.
1722 The buffer is not selected, just returned to the caller.
1723 Optional second arg NOWARN non-nil means suppress any warning messages.
1724 Optional third arg RAWFILE non-nil means the file is read literally.
1725 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1726 and visit all the matching files. When wildcards are actually
1727 used and expanded, return a list of buffers that are visiting
1728 the various files."
1735 'find-directory-functions
1738 filename)))
1741 find-file-wildcards
1755 ;; Find any buffer for a file which has same truename.
1757 ;; Let user know if there is a buffer with the same truename.
1761 find-file-suppress-same-file-warnings
1765 ;; Optionally also find that buffer.
1768 ;; Check to see if the file looks uncommonly large.
1772 ;; We are using an existing buffer.
1779 ;; Certain files should be reverted automatically
1780 ;; if they have changed on disk and not in the buffer.
1788 found))
1798 "File %s changed on disk. Discard your edits? "
1803 "File %s changed on disk. Discard your edits in %s? "
1811 ;; Check if a formerly read-only file has become
1812 ;; writable and vice versa, but if the buffer agrees
1813 ;; with the new state of the file, that is ok too.
1821 buffer-file-name
1830 ;; It is confusing to ask whether to visit
1831 ;; non-literally if they have the file in
1832 ;; hexl-mode.
1838 "The file %s is already visited normally,
1839 and you have edited the buffer. Now you have asked to visit it literally,
1840 meaning no coding system handling, format conversion, or local variables.
1841 Emacs can only visit a file in one way at a time.
1843 Do you want to save the file, and visit it literally instead? "
1844 "The file %s is already visited literally,
1845 meaning no coding system handling, format conversion, or local variables.
1846 You have edited the buffer. Now you have asked to visit the file normally,
1847 but Emacs can only visit a file in one way at a time.
1854 rawfile truename number))
1858 "\
1859 Do you want to discard your changes, and visit the file literally now? "
1860 "\
1863 rawfile truename number)
1869 "The file %s is already visited normally.
1870 You have asked to visit it literally,
1871 meaning no coding system decoding, format conversion, or local variables.
1872 But Emacs can only visit a file in one way at a time.
1874 Do you want to revisit the file literally now? "
1875 "The file %s is already visited literally,
1876 meaning no coding system decoding, format conversion, or local variables.
1877 You have asked to visit it normally,
1878 but Emacs can only visit a file in one way at a time.
1883 rawfile truename number)
1886 ;; Return the buffer we are using.
1887 buf)
1888 ;; Create a new buffer.
1890 ;; find-file-noselect-1 may use a different buffer.
1892 rawfile truename number))))))
1898 ;; Needed in case we are re-visiting the file with a different
1899 ;; text representation.
1916 filename)))
1917 ;; Unconditionally set error
1927 filename)))
1928 ;; Run find-file-not-found-functions until one returns non-nil.
1930 ;; If they fail too, set error.
1932 ;; Record the file's truename, and maybe use that as visited name.
1940 ;; Set buffer's default directory to that of the file.
1942 ;; Turn off backup files for certain file names. Since
1943 ;; this is a permanent local, the major mode won't eliminate it.
1958 \f
1960 "Like `insert-file-contents', but only reads in the file literally.
1961 A buffer may be modified in several ways after reading into the buffer,
1962 to Emacs features such as format decoding, character code
1963 conversion, `find-file-hook', automatic uncompression, etc.
1965 This function ensures that none of these modifications will take place."
1973 nil))
1976 inhibit-file-name-handlers))
1989 filename)))
1990 ;; Check whether the file is uncommonly large
2001 "Insert contents of file FILENAME into buffer after point with no conversion.
2003 This function is meant for the user to run interactively.
2004 Don't call it from programs! Use `insert-file-contents-literally' instead.
2005 \(Its calling sequence is different; see its documentation)."
2010 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2011 This has the `permanent-local' property, which takes effect if you
2016 "Visit file FILENAME with no conversion of any kind.
2017 Format conversion and character code conversion are both disabled,
2018 and multibyte characters are disabled in the resulting buffer.
2019 The major mode used is Fundamental mode regardless of the file name,
2020 and local variable specifications in the file are ignored.
2021 Automatic uncompression and adding a newline at the end of the
2022 file due to `require-final-newline' is also disabled.
2024 You cannot absolutely rely on this function to result in
2025 visiting the file literally. If Emacs already has a buffer
2026 which is visiting the file, you get the existing buffer,
2027 regardless of whether it was created literally or not.
2029 In a Lisp program, if you want to be sure of accessing a file's
2030 contents literally, you should create a temporary buffer and then read
2031 the file contents into it using `insert-file-contents-literally'."
2034 "Find file literally: " nil default-directory
2037 \f
2041 after-find-file-from-revert-buffer
2042 nomodes)
2043 "Called after finding a file and by the default revert function.
2044 Sets buffer mode, parses local variables.
2045 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2046 error in reading the file. WARN non-nil means warn if there
2047 exists an auto-save file more recent than the visited file.
2048 NOAUTO means don't mess with auto-save mode.
2049 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2050 means this call was from `revert-buffer'.
2051 Fifth arg NOMODES non-nil means don't alter the file's modes.
2052 Finishes by calling the functions in `find-file-hook'
2053 unless NOMODES is non-nil."
2056 nil
2066 ;; No need to warn if buffer is auto-saved
2067 ;; under the name of the visited file.
2069 auto-save-visited-file-name))
2072 buffer-file-name))
2092 ;; Make people do a little extra work (C-x C-q)
2093 ;; before altering a backup file.
2096 ;; When a file is marked read-only,
2097 ;; make the buffer read-only even if root is looking at it.
2105 ;; If requested, add a newline at the end of the file.
2115 view-read-only
2121 "Eval BODY and turn any error into a FORMAT message.
2122 FORMAT can have a %s escape which will be replaced with the actual error.
2123 If `debug-on-error' is set, errors are not caught, so that you can
2124 debug them.
2125 Avoid using a large BODY since it is duplicated."
2134 "Choose the major mode for this buffer automatically.
2135 Also sets up any specified local variables of the file.
2136 Uses the visited file name, the -*- line, and the local variables spec.
2138 This function is called automatically from `find-file'. In that case,
2139 we may set up the file-specified mode and local variables,
2140 depending on the value of `enable-local-variables'.
2141 In addition, if `local-enable-local-variables' is nil, we do
2142 not set local variables (though we do notice a mode specified with -*-.)
2144 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2145 or from Lisp without specifying the optional argument FIND-FILE;
2146 in that case, this function acts as if `enable-local-variables' were t."
2154 ;; Turn font lock off and on, to make sure it takes account of
2155 ;; whatever file local variables are relevant to it.
2157 ;; Font-lock-mode (now in font-core.el) can be ON when
2158 ;; font-lock.el still hasn't been loaded.
2168 "Non-nil means to try second pass through `auto-mode-alist'.
2169 This means that if the first case-sensitive search through the alist fails
2170 to find a matching major mode, a second case-insensitive search is made.
2171 On systems with case-insensitive file names, this variable is ignored,
2172 since only a single case-insensitive search through the alist is made."
2178 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2179 ;; c++-mode, java-mode and more) are added through autoload
2180 ;; directives in that file. That way is discouraged since it
2181 ;; spreads out the definition of the initial value.
2216 ;; Less common extensions come here
2217 ;; so more common ones above are found faster.
2257 ;; The list of archive file extensions should be in sync with
2258 ;; `auto-coding-alist' with `no-conversion' coding system.
2264 ;; Mailer puts message to be edited in
2265 ;; /tmp/Re.... or Message
2269 ;; some news reader is reported to use this
2279 ;; .emacs or .gnus or .viper following a directory delimiter in
2280 ;; Unix, MSDOG or VMS syntax.
2283 ;; _emacs following a directory delimiter
2284 ;; in MsDos syntax
2288 ;; Common Lisp ASDF package system.
2307 ;; Windows candidates may be opened case sensitively on Unix
2313 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2315 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2316 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2317 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2318 ;; this has lower priority to avoid matching changelog.sgml etc.
2320 ;; either user's dot-files or under /etc or some such
2322 ;; alas not all ~/.*rc files are like this
2323 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2328 ;; this contains everything twice, with space and with colon :-(
2330 ;; Get rid of any trailing .n.m and try again.
2331 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2332 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2333 ;; Using mode nil rather than `ignore' would let the search continue
2334 ;; through this list (with the shortened name) rather than start over.
2336 ;; The following should come after the ChangeLog pattern
2337 ;; for the sake of ChangeLog.1, etc.
2338 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2341 "Alist of filename patterns vs corresponding major mode functions.
2342 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2343 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2344 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2345 mode function to use. FUNCTION will be called, unless it is nil.
2347 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2348 calling FUNCTION (if it's not nil), we delete the suffix that matched
2349 REGEXP and search the list again for another match.
2351 If the file name matches `inhibit-first-line-modes-regexps',
2352 then `auto-mode-alist' is not processed.
2354 The extensions whose FUNCTION is `archive-mode' should also
2355 appear in `auto-coding-alist' with `no-conversion' coding system.
2357 See also `interpreter-mode-alist', which detects executable script modes
2358 based on the interpreters they specify to run,
2363 "Select Conf mode or XML mode according to start of file."
2373 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2374 ;; and pike-mode) are added through autoload directives in that
2375 ;; file. That way is discouraged since it spreads out the
2376 ;; definition of the initial value.
2414 "Alist mapping interpreter names to major modes.
2415 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2416 Each element looks like (INTERPRETER . MODE).
2417 If INTERPRETER matches the name of the interpreter specified in the first line
2418 of a script, mode MODE is enabled.
2426 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2427 When checking `inhibit-first-line-modes-regexps', we first discard
2433 "Regexp matching interpreters, for file mode determination.
2434 This regular expression is matched against the first line of a file
2435 to determine the file's mode in `set-auto-mode'. If it matches, the file
2436 is assumed to be interpreted by the interpreter matched by the second group
2437 of the regular expression. The mode is then determined as the mode
2441 "Alist of buffer beginnings vs. corresponding major mode functions.
2442 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2443 After visiting a file, if REGEXP matches the text at the beginning of the
2444 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2445 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2446 major mode.
2448 If FUNCTION is nil, then it is not called. (That is a way of saying
2456 ;; The < comes before the groups (but the first) to reduce backtracking.
2457 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2458 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2462 comment-re "*"
2465 . html-mode)
2467 ;; These two must come after html, because they are more general:
2472 . sgml-mode)
2475 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2476 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2477 After visiting a file, if REGEXP matches the text at the beginning of the
2478 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2479 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2480 have not specified a mode for this file.
2486 "Upper limit on `magic-mode-alist' regexp matches.
2490 "Select major mode appropriate for current buffer.
2492 To find the right major mode, this function checks for a -*- mode tag,
2493 checks if it uses an interpreter listed in `interpreter-mode-alist',
2494 matches the buffer beginning against `magic-mode-alist',
2495 compares the filename against the entries in `auto-mode-alist',
2496 then matches the buffer beginning against `magic-fallback-mode-alist'.
2498 It does not check for the `mode:' local variable in the
2499 Local Variables section of the file; for that, use `hack-local-variables'.
2501 If `enable-local-variables' is nil, this function does not check for a
2502 -*- mode tag.
2504 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2505 set the major mode only if that would change it. In other words
2506 we don't actually set it to the same mode the buffer already has."
2507 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2509 ;; Find a -*- mode tag
2516 ;; Find all specifications for the `mode:' variable
2517 ;; and execute them left to right.
2529 modes)))
2530 ;; Simple -*-MODE-*- case.
2533 modes))))
2534 ;; If we found modes to use, invoke them now, outside the save-excursion.
2542 ;; continuing would call minor modes again, toggling them off
2544 ;; If we didn't, look for an interpreter specified in the first line.
2545 ;; As a special case, allow for things like "#!/bin/env perl", which
2546 ;; finds the interpreter anywhere in $PATH.
2553 ;; Map interpreter name to a mode, signalling we're done at the
2554 ;; same time.
2556 interpreter-mode-alist))
2557 ;; If we found an interpreter mode to use, invoke it now.
2560 ;; Next try matching the buffer beginning against magic-mode-alist.
2574 ;; Next compare the filename against the entries in auto-mode-alist.
2579 ;; Remove remote file name identification.
2583 ;; Remove backup-suffixes from file name.
2586 ;; Find first matching alist entry.
2589 ;; System is case-insensitive.
2593 ;; System is case-sensitive.
2595 ;; First match case-sensitively.
2599 ;; Fallback to case-insensitive match.
2613 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2628 ;; When `keep-mode-if-same' is set, we are working on behalf of
2629 ;; set-visited-file-name. In that case, if the major mode specified is the
2630 ;; same one we already have, don't actually reset it. We don't want to lose
2631 ;; minor modes such as Font Lock.
2633 "Apply MODE and return it.
2634 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2635 any aliases and compared to current major mode. If they are the
2636 same, do nothing and return nil."
2642 mode)))
2645 "Find the -*- spec in the buffer.
2646 Call with point at the place to start searching from.
2647 If one is found, set point to the beginning
2648 and return the position of the end.
2649 Otherwise, return nil; point may be changed."
2652 ;; Don't look for -*- if this file name matches any
2653 ;; of the regexps in inhibit-first-line-modes-regexps.
2661 sufs)
2669 ;; If the file begins with "#!"
2670 ;; (exec interpreter magic), look
2671 ;; for mode frobs in the first two
2672 ;; lines. You cannot necessarily
2673 ;; put them in the first line of
2674 ;; such a file without screwing up
2675 ;; the interpreter invocation.
2676 ;; The same holds for
2677 ;; '\"
2678 ;; in man pages (preprocessor
2679 ;; magic for the `man' program).
2690 end))))
2691 \f
2692 ;;; Handling file local variables
2696 file-local-variables-alist dir-local-variables-alist)
2701 "Normal hook run after processing a file's local variables specs.
2702 Major modes can use this to examine user-specified local variables
2706 "List variable-value pairs that are considered safe.
2707 Each element is a cons cell (VAR . VAL), where VAR is a variable
2708 symbol and VAL is a value that is considered safe."
2709 :risky t
2716 "Expressions that are considered safe in an `eval:' local variable.
2717 Add expressions to this list if you want Emacs to evaluate them, when
2718 they appear in an `eval' local variable specification, without first
2719 asking you for confirmation."
2720 :risky t
2725 ;; Risky local variables:
2728 buffer-auto-save-file-name
2729 buffer-file-name
2730 buffer-file-truename
2731 buffer-undo-list
2732 debugger
2733 default-text-properties
2734 eval
2735 exec-directory
2736 exec-path
2737 file-name-handler-alist
2738 frame-title-format
2739 global-mode-string
2740 header-line-format
2741 icon-title-format
2742 inhibit-quit
2743 load-path
2744 max-lisp-eval-depth
2745 max-specpdl-size
2746 minor-mode-map-alist
2747 minor-mode-overriding-map-alist
2748 mode-line-format
2749 mode-name
2750 overriding-local-map
2751 overriding-terminal-local-map
2752 process-environment
2753 standard-input
2754 standard-output
2755 unread-command-events))
2757 ;; Safe local variables:
2758 ;;
2759 ;; For variables defined by major modes, the safety declarations can go into
2760 ;; the major mode's file, since that will be loaded before file variables are
2761 ;; processed.
2762 ;;
2763 ;; For variables defined by minor modes, put the safety declarations in the
2764 ;; file defining the minor mode after the defcustom/defvar using an autoload
2765 ;; cookie, e.g.:
2766 ;;
2767 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2768 ;;
2769 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2770 ;; minor mode file may not be loaded yet.
2771 ;;
2772 ;; For variables defined in the C source code the declaration should go here:
2789 "Alist of file-local variable settings in the current buffer.
2790 Each element in this list has the form (VAR . VALUE), where VAR
2791 is a file-local variable (a symbol) and VALUE is the value
2792 specified. The actual value in the buffer may differ from VALUE,
2798 "Alist of directory-local variable settings in the current buffer.
2799 Each element in this list has the form (VAR . VALUE), where VAR
2800 is a directory-local variable (a symbol) and VALUE is the value
2801 specified in .dir-locals.el. The actual value in the buffer
2802 may differ from VALUE, if it is changed by the major or minor modes,
2807 "Normal hook run before setting file-local variables.
2808 It is called after checking for unsafe/risky variables and
2809 setting `file-local-variables-alist', and before applying the
2810 variables stored in `file-local-variables-alist'. A hook
2811 function is allowed to change the contents of this alist.
2813 This hook is called only if there is at least one file-local
2817 "Get confirmation before setting up local variable values.
2818 ALL-VARS is the list of all variables to be set up.
2819 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2820 RISKY-VARS is the list of those that are marked as risky.
2821 DIR-NAME is a directory name if these settings come from
2822 directory-local variables, or nil otherwise."
2824 nil
2830 prompt char)
2840 ", and variables that are risky (**)."
2847 y -- to apply the local variables list.
2851 ! -- to apply the local variables list, and permanently mark these
2863 ;; Make strings with embedded whitespace easier to read.
2871 ""
2878 done)
2887 ;; read-event returns -1 if we are in a kbd
2888 ;; macro and there are no more events in the
2889 ;; macro. In that case, attempt to get an
2890 ;; event interactively.
2898 ;; When this is called from desktop-restore-file-buffer,
2899 ;; coding-system-for-read may be non-nil. Reset it before
2900 ;; writing to .emacs.
2904 'safe-local-variable-values
2905 safe-local-variable-values))))
2912 "Return local variables specified in the -*- line.
2913 Ignore any specification for `mode:' and `coding:';
2914 `set-auto-mode' should already have handled `mode:',
2915 `set-auto-coding' should already have handled `coding:'.
2917 If MODE-ONLY is non-nil, all we do is check whether the major
2918 mode is specified, returning t if it is specified. Otherwise,
2919 return an alist of elements (VAR . VAL), where VAR is a variable
2920 and VAL is the specified value."
2924 result mode-specified)
2925 ;; Parse the -*- line into the RESULT alist.
2926 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2928 nil)
2930 ;; Simple form: "-*- MODENAME -*-". Already handled.
2932 nil)
2934 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2935 ;; (last ";" is optional).
2940 ;; There used to be a downcase here,
2941 ;; but the manual didn't say so,
2942 ;; and people want to set var names that aren't all lc.
2948 ;; It is traditional to ignore
2949 ;; case when checking for `mode' in set-auto-mode,
2950 ;; so we must do that here as well.
2951 ;; That is inconsistent, but we're stuck with it.
2952 ;; The same can be said for `coding' in set-auto-coding.
2958 'eval
2965 mode-specified
2966 result))))
2969 "Filter local variable settings, querying the user if necessary.
2970 VARIABLES is the alist of variable-value settings. This alist is
2971 filtered based on the values of `ignored-local-variables',
2972 `enable-local-eval', `enable-local-variables', and (if necessary)
2973 user interaction. The results are added to
2974 `file-local-variables-alist', without applying them.
2975 DIR-NAME is a directory name if these settings come from
2976 directory-local variables, or nil otherwise."
2977 ;; Find those variables that we may want to save to
2978 ;; `safe-local-variable-values'.
2984 ;; Ignore any variable in `ignored-local-variables'.
2985 nil)
2986 ;; Obey `enable-local-eval'.
2994 ;; Ignore duplicates (except `mode') in the present list.
2996 ;; Accept known-safe variables.
3000 ;; The variable is either risky or unsafe:
3007 ;; Query, unless all vars are safe or user wants no querying.
3013 risky-vars dir-name))
3024 "Parse and put into effect this buffer's local variables spec.
3025 If MODE-ONLY is non-nil, all we do is check whether the major mode
3026 is specified, returning t if it is specified."
3029 result)
3036 ;; Look for "Local variables:" line in last page.
3044 ;; suffix is what comes after "local variables:" in its line.
3045 ;; prefix is what comes before "local variables:" in its line.
3055 beg)
3059 endpos
3065 nil t))
3066 ;; This used to be an error, but really all it means is
3067 ;; that this may simply not be a local-variables section,
3068 ;; so just ignore it.
3078 ;; Discard the prefix.
3083 ;; Discard the suffix.
3091 ;; Find the variable name; strip whitespace.
3100 val)
3101 ;; Read the variable value.
3112 'eval
3117 ;; Now we've read all the local variables.
3118 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3120 ;; Otherwise, set the variables.
3124 ;; Any 'evals must run in the Right sequence.
3133 "Non-nil if SYM is safe as a file-local variable with value VAL.
3134 It is safe if any of these conditions are met:
3136 * There is a matching entry (SYM . VAL) in the
3137 `safe-local-variable-values' user option.
3139 * The `safe-local-variable' property of SYM is a function that
3140 evaluates to a non-nil value with VAL as an argument."
3144 ;; If the function signals an error, that means it
3145 ;; can't assure us that the value is safe.
3149 "Non-nil if SYM could be dangerous as a file-local variable.
3150 It is dangerous if either of these conditions are met:
3152 * Its `risky-local-variable' property is non-nil.
3158 ;; If this is an alias, check the base name.
3178 "Return t if it is safe to eval EXP when it is found in a file."
3180 ;; Detect certain `put' expressions.
3187 lisp-indent-function
3188 scheme-indent-function))
3189 ;; Only allow safe values (not functions).
3194 ;; Only allow indirect form specs.
3195 ;; During bootstrapping, edebug-basic-spec might not be
3196 ;; defined yet.
3200 ;; Allow expressions that the user requested.
3202 ;; Certain functions can be allowed with safe arguments
3203 ;; or can specify verification functions to try.
3211 ok))
3219 ok)))))))
3222 "Set local variable VAR with value VAL.
3223 If VAR is `mode', call `VAL-mode' as a function unless it's
3224 already the major mode."
3231 ;; A minor mode must be passed an argument.
3232 ;; Otherwise, if the user enables the minor mode in a
3233 ;; major mode hook, this would toggle it off.
3239 ;; Make sure the string has no text properties.
3240 ;; Some text properties can get evaluated in various ways,
3241 ;; so it is risky to put them on with a local variable list.
3245 \f
3246 ;;; Handling directory-local variables, aka project settings.
3252 "List of cached directory roots for directory-local variable classes.
3253 Each element in this list has the form (DIR CLASS MTIME).
3254 DIR is the name of the directory.
3255 CLASS is the name of a variable class (a symbol).
3256 MTIME is the recorded modification time of the directory-local
3257 variables file associated with this entry. This time is a list
3258 of two integers (the same format as `file-attributes'), and is
3259 used to test whether the cache entry is still valid.
3260 Alternatively, MTIME can be nil, which means the entry is always
3264 "Return the variable list for CLASS."
3268 "Collect directory-local variables from MODE-VARIABLES.
3269 VARIABLES is the initial list of variables.
3270 Returns the new list."
3275 ;; If variables are specified more than once, only use the last. (Why?)
3276 ;; The pseudo-variables mode and eval are different (bug#3430).
3279 ;; Need a new cons in case we setcdr later.
3283 "Collect entries from CLASS-VARIABLES into VARIABLES.
3284 ROOT is the root directory of the project.
3285 Return the new variables list."
3293 ;; Don't include this in the previous condition, because we
3294 ;; want to filter all strings before the next condition.
3306 "Declare that the DIRECTORY root is an instance of CLASS.
3307 DIRECTORY is the name of a directory, a string.
3308 CLASS is the name of a project class, a symbol.
3309 MTIME is either the modification time of the directory-local
3310 variables file that defined this class, or nil.
3312 When a file beneath DIRECTORY is visited, the mode-specific
3313 variables from CLASS are applied to the buffer. The variables
3314 for a class are defined using `dir-locals-set-class-variables'."
3321 "Map the type CLASS to a list of variable settings.
3322 CLASS is the project class, a symbol. VARIABLES is a list
3323 that declares directory-local variables for the class.
3324 An element in VARIABLES is either of the form:
3325 (MAJOR-MODE . ALIST)
3326 or
3327 (DIRECTORY . LIST)
3329 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3330 whose elements are of the form (VARIABLE . VALUE).
3332 In the second form, DIRECTORY is a directory name (a string), and
3333 LIST is a list of the form accepted by the function.
3335 When a file is visited, the file's class is found. A directory
3336 may be assigned a class using `dir-locals-set-directory-class'.
3337 Then variables are set in the file's buffer according to the
3338 class' LIST. The list is processed in order.
3340 * If the element is of the form (MAJOR-MODE . ALIST), and the
3341 buffer's major mode is derived from MAJOR-MODE (as determined
3342 by `derived-mode-p'), then all the variables in ALIST are
3343 applied. A MAJOR-MODE of nil may be used to match any buffer.
3344 `make-local-variable' is called for each variable before it is
3345 set.
3347 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3348 is an initial substring of the file's directory, then LIST is
3349 applied by recursively following these rules."
3356 "File that contains directory-local variables.
3357 It has to be constant to enforce uniform values
3361 "Find the directory-local variables for FILE.
3362 This searches upward in the directory tree from FILE.
3363 If the directory root of FILE has been registered in
3364 `dir-locals-directory-cache' and the directory-local variables
3365 file has not been modified, return the matching entry in
3366 `dir-locals-directory-cache'.
3367 Otherwise, if a directory-local variables file is found, return
3368 the file name.
3369 Otherwise, return nil."
3374 dir-locals-file))
3377 ;; `locate-dominating-file' may have abbreviated the name.
3380 ;; Find the best cached value in `dir-locals-directory-cache'.
3393 ;; Check the validity of the cache.
3398 ;; This cache entry is OK.
3399 dir-elt
3400 ;; This cache entry is invalid; clear it.
3403 locals-file)
3404 locals-file))))
3407 "Load a variables FILE and register a new class and instance.
3408 FILE is the name of the file holding the variables to apply.
3409 The new class name is the same as the directory in which FILE
3410 is found. Returns the new class name."
3420 class-name)))
3423 "Read per-directory local variables for the current buffer.
3424 Store the directory-local variables in `dir-local-variables-alist'
3425 and `file-local-variables-alist', without applying them."
3429 ;; Find the variables file.
3452 \f
3455 However, the mode will not be changed if
3456 \(1) a local variables list or the `-*-' line specifies a major mode, or
3458 \ not suitable for ordinary files, or
3459 \(3) the new file name does not particularly specify any mode."
3464 "Change name of file visited in current buffer to FILENAME.
3465 This also renames the buffer to correspond to the new file.
3466 The next time the buffer is saved it will go in the newly specified file.
3467 FILENAME nil or an empty string means mark buffer as not visiting any file.
3468 Remember to delete the initial contents of the minibuffer
3469 if you wish to pass an empty string as the argument.
3471 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3472 confirmation in the case where another buffer is already visiting FILENAME.
3474 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3475 the old visited file has been renamed to the new name FILENAME."
3483 nil
3498 filename)))
3508 ;; If new-name == old-name, renaming would add a spurious <2>
3509 ;; and it's considered as a feature in rename-buffer.
3515 ;; Abbreviate the file names of the buffer.
3524 nil)))
3525 ;; write-file-functions is normally used for things like ftp-find-file
3526 ;; that visit things that are not local files as if they were files.
3527 ;; Changing to visit an ordinary local file instead should flush the hook.
3532 ;; If buffer was read-only because of version control,
3533 ;; that reason is gone now, so make it writable.
3537 ;; Turn off backup files for certain file names.
3538 ;; Since this is a permanent local, the major mode won't eliminate it.
3540 backup-enable-predicate
3546 ;; If auto-save was not already on, turn it on if appropriate.
3550 ;; If auto save is on, start using a new name.
3551 ;; We deliberately don't rename or delete the old auto save
3552 ;; for the old visited file name. This is because perhaps
3553 ;; the user wants to save the new state and then compare with the
3554 ;; previous state from the auto save file.
3557 ;; Rename the old auto save file if any.
3564 ;; Update the major mode, if the file name determines it.
3566 ;; Don't change the mode if it is special.
3569 ;; Don't change the mode if the local variable list specifies it.
3575 "Write current buffer into file FILENAME.
3576 This makes the buffer visit that file, and marks it as not modified.
3578 If you specify just a directory name as FILENAME, that means to use
3579 the default file name but in that directory. You can also yank
3580 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3582 If the buffer is not already visiting a file, the default file name
3583 for the output file is the buffer name.
3585 If optional second arg CONFIRM is non-nil, this function
3586 asks for confirmation before overwriting an existing file.
3587 Interactively, confirmation is required unless you supply a prefix argument."
3588 ;; (interactive "FWrite file: ")
3592 nil nil nil nil)
3596 default-directory)
3597 nil nil))
3601 ;; If arg is just a directory,
3602 ;; use the default file name, but in that directory.
3613 ;; Make buffer writable if file is writable.
3618 ;; It's likely that the VC status at the new location is different from
3619 ;; the one at the old location.
3621 \f
3623 "Make a backup of the disk file visited by the current buffer, if appropriate.
3624 This is normally done before saving the buffer the first time.
3626 A backup may be done by renaming or by copying; see documentation of
3627 variable `make-backup-files'. If it's done by renaming, then the file is
3628 no longer accessible under its old name.
3630 The value is non-nil after a backup was made by renaming.
3631 It has the form (MODES . BACKUPNAME).
3632 MODES is the result of `file-modes' on the original
3633 file; this means that the caller, after saving the buffer, should change
3634 the modes of the new file to agree with the old modes.
3635 BACKUPNAME is the backup file name, which is the old file renamed."
3642 backup-info backupname targets setmodes)
3643 ;; If specified name is a symbolic link, chase it to the target.
3644 ;; Thus we make the backups in the directory where the real file is.
3649 ;; (if (file-directory-p buffer-file-name)
3650 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3654 ;; If have old versions to maybe delete,
3655 ;; ask the user to confirm now, before doing anything.
3656 ;; But don't actually delete til later.
3661 real-file-name)))))
3663 ;; Actually write the back up file.
3666 ; (file-symlink-p buffer-file-name)
3667 backup-by-copying
3668 ;; Don't rename a suid or sgid file.
3683 ;; rename-file should delete old backup.
3687 ;; If trouble writing the backup, write it in
3688 ;; .emacs.d/%backup%.
3691 backupname)
3695 ;; Now delete the old versions, if desired.
3702 setmodes)
3709 ;; Create temp files with strict access rights. It's easy to
3710 ;; loosen them later, whereas it's impossible to close the
3711 ;; time-window of loose permissions otherwise.
3714 ;; Try to overwrite old backup first.
3722 nil)
3724 ;; The file was somehow created by someone else between
3725 ;; `delete-file' and `copy-file', so let's try again.
3726 ;; rms says "I think there is also a possible race
3727 ;; condition for making backup files" (emacs-devel 20070821).
3728 nil)))
3729 ;; Reset the umask.
3735 "Return file NAME sans backup versions or strings.
3736 This is a separate procedure so your site-init or startup file can
3737 redefine it.
3738 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3739 we do not remove backup version numbers, only true file version numbers."
3751 "Return t if deleting FILE and rewriting it would preserve the owner."
3756 ;; Return t if the file doesn't exist, since it's true that no
3757 ;; information would be lost by an (attempted) delete and create.
3760 ;; Files created on Windows by Administrator (RID=500)
3761 ;; have the Administrators group (RID=544) recorded as
3762 ;; their owner. Rewriting them will still preserve the
3763 ;; owner.
3769 The extension, in a file name, is the part that follows the last `.',
3770 except that a leading `.', if any, doesn't count."
3773 directory)
3777 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3778 ;; we don't want to expand it.
3781 filename))))
3785 The extension, in a file name, is the part that follows the last `.',
3786 excluding version numbers and backup suffixes,
3787 except that a leading `.', if any, doesn't count.
3788 Return nil for extensionless file names such as `foo'.
3789 Return the empty string for file names such as `foo.'.
3791 If PERIOD is non-nil, then the returned value includes the period
3792 that delimits the extension, and if FILENAME has no extension,
3803 "A function to use instead of the default `make-backup-file-name'.
3804 A value of nil gives the default `make-backup-file-name' behavior.
3806 This could be buffer-local to do something special for specific
3807 files. If you define it, you may need to change `backup-file-name-p'
3808 and `file-name-sans-versions' too.
3810 See also `backup-directory-alist'."
3816 "Alist of filename patterns and backup directory names.
3817 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3818 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3819 relative or absolute. If it is absolute, so that all matching files
3820 are backed up into the same directory, the file names in this
3821 directory will be the full name of the file backed up with all
3822 directory separators changed to `!' to prevent clashes. This will not
3823 work correctly if your filesystem truncates the resulting name.
3825 For the common case of all backups going into one directory, the alist
3827 directory name.
3829 If this variable is nil, or it fails to match a filename, the backup
3830 is made in the original file's directory.
3832 On MS-DOS filesystems without long names this variable is always
3833 ignored."
3839 "Default `backup-enable-predicate' function.
3840 Checks for files in `temporary-file-directory',
3841 `small-temporary-file-directory', and /tmp."
3844 ;; Directory is under temporary-file-directory.
3849 ;; Directory is under /tmp.
3854 0 nil
3856 ;; Directory is under small-temporary-file-directory.
3861 "Create the non-numeric backup file name for FILE.
3862 Normally this will just be the file's name with `~' appended.
3863 Customization hooks are provided as follows.
3865 If the variable `make-backup-file-name-function' is non-nil, its value
3866 should be a function which will be called with FILE as its argument;
3867 the resulting name is used.
3869 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3870 the documentation of that variable. If the directory for the backup
3871 doesn't exist, it is created."
3885 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3887 elt backup-directory abs-backup-directory)
3892 alist nil)))
3893 ;; If backup-directory is relative, it should be relative to the
3894 ;; file's directory. By expanding explicitly here, we avoid
3895 ;; depending on default-directory.
3904 abs-backup-directory nil))))
3906 file
3910 ;; Normalize DOSish file names: downcase the drive
3911 ;; letter, if any, and replace the leading "x:" with
3912 ;; "/drive_x".
3915 ;; Replace any invalid file-name characters (for the
3916 ;; case of backing up remote files).
3920 "drive_"
3923 ""
3926 ;; Make the name unique by substituting directory
3927 ;; separators. It may not really be worth bothering about
3928 ;; doubling `!'s in the original name...
3933 backup-directory))
3938 "Return non-nil if FILE is a backup file name (numeric or not).
3939 This is a separate function so you can redefine it for customization.
3940 You may need to redefine `file-name-sans-versions' as well."
3945 ;; This is used in various files.
3946 ;; The usage of backup-extract-version-start is not very clean,
3947 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3949 "Given the name of a numeric backup file, FN, return the backup number.
3950 Uses the free variable `backup-extract-version-start', whose value should be
3951 the index in the name where the version number begins."
3958 "Find a file name for a backup file FN, and suggestions for deletions.
3959 Value is a list whose car is the name for the backup file
3960 and whose cdr is a list of old versions to consider deleting now.
3961 If the value is nil, don't make a backup.
3962 Uses `backup-directory-alist' in the same way as does
3963 `make-backup-file-name'."
3965 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3969 ;; We don't support numbered backups on plain MS-DOS
3970 ;; when long file names are unavailable.
3980 possibilities deserve-versions-p versions)
3983 base-versions
3986 possibilities)
3987 #'<)
3992 kept-old-versions
3993 kept-new-versions
4000 ;; Delete nothing if there is overflow
4001 ;; in the number of versions to keep.
4007 v))))))))))
4010 "Return number of names file FILENAME has."
4013 ;; (defun file-relative-name (filename &optional directory)
4014 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4015 ;; This function returns a relative file name which is equivalent to FILENAME
4016 ;; when used with that default directory as the default.
4017 ;; If this is impossible (which can happen on MSDOS and Windows
4018 ;; when the file name and directory use different drive names)
4019 ;; then it returns FILENAME."
4020 ;; (save-match-data
4021 ;; (let ((fname (expand-file-name filename)))
4022 ;; (setq directory (file-name-as-directory
4023 ;; (expand-file-name (or directory default-directory))))
4024 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4025 ;; ;; drive names, they can't be relative, so return the absolute name.
4026 ;; (if (and (or (eq system-type 'ms-dos)
4027 ;; (eq system-type 'cygwin)
4028 ;; (eq system-type 'windows-nt))
4029 ;; (not (string-equal (substring fname 0 2)
4030 ;; (substring directory 0 2))))
4031 ;; filename
4032 ;; (let ((ancestor ".")
4033 ;; (fname-dir (file-name-as-directory fname)))
4034 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4035 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4036 ;; (setq directory (file-name-directory (substring directory 0 -1))
4037 ;; ancestor (if (equal ancestor ".")
4038 ;; ".."
4039 ;; (concat "../" ancestor))))
4040 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4041 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4042 ;; ;; We matched within FNAME's directory part.
4043 ;; ;; Add the rest of FNAME onto ANCESTOR.
4044 ;; (let ((rest (substring fname (match-end 0))))
4045 ;; (if (and (equal ancestor ".")
4046 ;; (not (equal rest "")))
4047 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4048 ;; rest
4049 ;; (concat (file-name-as-directory ancestor) rest)))
4050 ;; ;; We matched FNAME's directory equivalent.
4051 ;; ancestor))))))
4054 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4055 This function returns a relative file name which is equivalent to FILENAME
4056 when used with that default directory as the default.
4057 If FILENAME and DIRECTORY lie on different machines or on different drives
4058 on a DOS/Windows machine, it returns FILENAME in expanded form."
4062 default-directory))))
4068 ;; Test for different filesystems on DOS/Windows
4070 ;; Should `cygwin' really be included here? --stef
4073 ;; Test for different drive letters
4075 ;; Test for UNCs on different servers
4080 ;; Windows file names cannot have ? in
4081 ;; them, so use that to detect when
4082 ;; neither FILENAME nor DIRECTORY is a
4083 ;; UNC.
4085 0 nil
4091 ;; Test for different remote file system identification
4093 filename
4099 directory nil nil case-fold-search))
4101 directory nil nil case-fold-search))))
4104 ".."
4106 ;; Now ancestor is empty, or .., or ../.., etc.
4108 directory nil nil case-fold-search))
4109 ;; We matched within FILENAME's directory part.
4110 ;; Add the rest of FILENAME onto ANCESTOR.
4113 ;; But don't bother with ANCESTOR if it would give us `./'.
4114 rest
4116 ;; We matched FILENAME's directory equivalent.
4117 ancestor))))))
4118 \f
4120 "Save current buffer in visited file if modified.
4121 Variations are described below.
4123 By default, makes the previous version into a backup file
4124 if previously requested or if this is the first save.
4126 to become a backup when the next save is done.
4128 unconditionally makes the previous version into a backup file.
4130 to become a backup when the next save is done,
4131 and unconditionally makes the previous version into a backup file.
4133 With a numeric argument of 0, never make the previous version
4134 into a backup file.
4136 If a file's name is FOO, the names of its numbered backup versions are
4137 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4138 Numeric backups (rather than FOO~) will be made if value of
4139 `version-control' is not the atom `never' and either there are already
4140 numeric versions of the file being backed up, or `version-control' is
4141 non-nil.
4142 We don't want excessive versions piling up, so there are variables
4143 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4144 and `kept-new-versions', which tells how many newest versions to keep.
4145 Defaults are 2 old versions and 2 new.
4146 `dired-kept-versions' controls dired's clean-directory (.) command.
4147 If `delete-old-versions' is nil, system will query user
4148 before trimming versions. Otherwise it does it silently.
4150 If `vc-make-backup-files' is nil, which is the default,
4151 no backup files are made for files managed by version control.
4152 (This is because the version control system itself records previous versions.)
4154 See the subroutine `basic-save-buffer' for more information."
4160 ;; We used to display the message below only for files > 50KB, but
4161 ;; then Rmail-mbox never displays it due to buffer swapping. If
4162 ;; the test is ever re-introduced, be sure to handle saving of
4163 ;; Rmail files.
4170 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4171 Normally delete only if the file was written by this Emacs since
4172 the last real save, but optional arg FORCE non-nil means delete anyway."
4186 "Normal hook that is run before a buffer is saved to its file."
4192 "Normal hook that is run after a buffer is saved to its file."
4198 "If non-nil, use this coding system for saving the buffer.
4199 More precisely, use this coding system in place of the
4200 value of `buffer-file-coding-system', when saving the buffer.
4201 Calling `write-region' for any purpose other than saving the buffer
4202 will still use `buffer-file-coding-system'; this variable has no effect
4209 "Save the current buffer in its visited file, if it has been modified.
4210 The hooks `write-contents-functions' and `write-file-functions' get a chance
4211 to do the job of saving; if they do not, then the buffer is saved in
4212 the visited file in the usual way.
4213 Before and after saving the buffer, this function runs
4214 `before-save-hook' and `after-save-hook', respectively."
4217 ;; In an indirect buffer, save its base buffer instead.
4222 setmodes)
4223 ;; If buffer has no file name, ask user for one.
4230 ;; Signal an error if the user specified the name of an
4231 ;; existing directory.
4234 filename))
4236 ;; Signal an error if the specified name refers to a
4237 ;; non-existing directory.
4267 ;; Support VC version backups.
4273 ;; If a hook returned t, file is already "written".
4274 ;; Otherwise, write it the usual way now.
4276 ;; Now we have saved the current buffer. Let's make sure
4277 ;; that buffer-file-coding-system is fixed to what
4278 ;; actually used for saving by binding it locally.
4288 ;; If the auto-save file was recent before this command,
4289 ;; delete it now.
4291 ;; Support VC `implicit' locking.
4296 ;; This does the "real job" of writing a buffer into its visited file
4297 ;; and making a backup file. This is what is normally done
4298 ;; but inhibited if one of write-file-functions returns non-nil.
4299 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4311 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4325 buffer-file-name)))
4339 ;; Write temp name, then rename it.
4340 ;; This requires write access to the containing dir,
4341 ;; which is why we don't try it if we don't have that access.
4343 tempname succeed
4346 ;; Create temp files with strict access rights. It's easy to
4347 ;; loosen them later, whereas it's impossible to close the
4348 ;; time-window of loose permissions otherwise.
4353 ;; Try various temporary names.
4354 ;; This code follows the example of make-temp-file,
4355 ;; but it calls write-region in the appropriate way
4356 ;; for saving the buffer.
4362 ;; Pass in nil&nil rather than point-min&max
4363 ;; cause we're saving the whole buffer.
4364 ;; write-region-annotate-functions may use it.
4366 tempname nil realname
4368 nil)
4370 ;; The file was somehow created by someone else between
4371 ;; `make-temp-name' and `write-region', let's try again.
4372 nil)
4374 ;; Reset the umask.
4376 ;; If we failed, restore the buffer's modtime.
4379 ;; Since we have created an entirely new file,
4380 ;; make sure it gets the right permission bits set.
4384 buffer-file-name)))
4385 ;; We succeeded in writing the temp file,
4386 ;; so rename it.
4388 ;; If file not writable, see if we can make it writable
4389 ;; temporarily while we write it.
4390 ;; But no need to do so if we have just backed it up
4391 ;; (setmodes is set) because that says we're superseding.
4393 ;; Change the mode back, after writing.
4399 ;; Pass in nil&nil rather than point-min&max to indicate
4400 ;; we're saving the buffer rather than just a region.
4401 ;; write-region-annotate-functions may make us of it.
4403 buffer-file-name nil t buffer-file-truename)
4405 ;; If we get an error writing the new file, and we made
4406 ;; the backup by renaming, undo the backing-up.
4411 setmodes))
4414 "View the differences between BUFFER and its associated file.
4415 This requires the external program `diff' to be in your `exec-path'."
4429 ;; Display that message for 1 second so that user can read it
4430 ;; in the minibuffer.
4432 ;; return always nil, so that save-buffers-kill-emacs will not move
4433 ;; over to the next unsaved buffer when calling `d'.
4434 nil)
4437 `((?\C-r
4444 ;; Return nil to ask about BUF again.
4445 nil)
4457 ;; Return nil to ask about BUF again.
4458 nil)
4468 "Save some modified file-visiting buffers. Asks user about each one.
4469 You can answer `y' to save, `n' not to save, `C-r' to look at the
4470 buffer in question with `view-buffer' before deciding or `d' to
4471 view the differences using `diff-buffer-with-file'.
4473 Optional argument (the prefix) non-nil means save all with no questions.
4474 Optional second argument PRED determines which buffers are considered:
4475 If PRED is nil, all the file-visiting buffers are considered.
4476 If PRED is t, then certain non-file buffers will also be considered.
4477 If PRED is a zero-argument function, it indicates for each buffer whether
4478 to consider it or not when called with that buffer current.
4480 See `save-some-buffers-action-alist' if you want to
4481 change the additional actions you can take on files."
4485 files-done abbrevs-done)
4487 ;; First save any buffers that we're supposed to save unconditionally.
4488 ;; That way the following code won't ask about them.
4493 ;; Ask about those buffers that merit it,
4494 ;; and record the number thus saved.
4498 ;; Note that killing some buffers may kill others via
4499 ;; hooks (e.g. Rmail and its viewing buffer).
4512 t
4524 save-some-buffers-action-alist))
4525 ;; Maybe to save abbrevs, and record whether
4526 ;; we either saved them or asked to.
4532 abbrev-file-name)))
4534 ;; Don't keep bothering user if he says no.
4539 "(Some special files were saved without asking)"
4541 \f
4543 "Mark current buffer as unmodified, not needing to be saved.
4546 It is not a good idea to use this function in Lisp programs, because it
4547 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4554 "Change whether this buffer is read-only.
4555 With prefix argument ARG, make the buffer read-only if ARG is
4556 positive, otherwise make it writable. If buffer is read-only
4557 and `view-read-only' is non-nil, enter view mode."
4562 nil ; do nothing.
4563 ;; Toggle.
4570 ;; If view-mode is already active, `view-mode-enter' is a nop.
4582 "Insert contents of file FILENAME into buffer after point.
4583 Set mark after the inserted text.
4585 This function is meant for the user to run interactively.
4586 Don't call it from programs! Use `insert-file-contents' instead.
4587 \(Its calling sequence is different; see its documentation)."
4592 "Append the contents of the region to the end of file FILENAME.
4593 When called from a function, expects three arguments,
4594 START, END and FILENAME. START and END are normally buffer positions
4595 specifying the part of the buffer to write.
4596 If START is nil, that means to use the entire buffer contents.
4597 If START is a string, then output that string to the file
4598 instead of any buffer contents; END is ignored.
4600 This does character code conversion and applies annotations
4601 like `write-region' does."
4606 "Return most recent backup file for FILENAME or nil if no backups exist."
4607 ;; `make-backup-file-name' will get us the right directory for
4608 ;; ordinary or numeric backups. It might create a directory for
4609 ;; backups as a side-effect, according to `backup-directory-alist'.
4616 tem)
4625 newest))
4628 "Rename current buffer to a similar name not already taken.
4629 This function is useful for creating multiple shell process buffers
4630 or multiple mail buffers, etc."
4638 ;; If the existing buffer name has a <NNN>,
4639 ;; which isn't part of the file name (if any),
4640 ;; then get rid of that.
4646 "Create the directory DIR and any nonexistent parent dirs.
4647 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4649 Interactively, the default choice of directory to create
4650 is the current default directory for file names.
4651 That is useful when you have visited a file in a nonexistent directory.
4653 Noninteractively, the second (optional) argument PARENTS says whether
4654 to create parent directories if they don't exist. Interactively,
4655 this happens by default."
4658 nil nil)
4659 t))
4660 ;; If default-directory is a remote directory,
4661 ;; make sure we find its make-directory handler.
4669 create-list)
4671 ;; If directory is its own parent, then we can't
4672 ;; keep looping forever
4687 "Delete the directory named DIRECTORY. Does not follow symlinks.
4688 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well."
4692 "Delete directory: "
4693 default-directory default-directory nil nil))))
4698 nil))))
4699 ;; If default-directory is a remote directory, make sure we find its
4700 ;; delete-directory handler.
4707 ;; Only move non-empty dir to trash if recursive deletion was
4708 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4709 ;; case, where the operation fails in delete-directory-internal.
4710 ;; As `move-file-to-trash' trashes directories (empty or
4711 ;; otherwise) as a unit, we do not need to recurse here.
4713 ;; Check if directory is empty apart from "." and "..".
4718 ;; Otherwise, call outselves recursively if needed.
4722 ;; This test is equivalent to
4723 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4724 ;; but more efficient
4728 ;; We do not want to delete "." and "..".
4734 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4735 This function always sets the file modes of the output files to match
4736 the corresponding input file.
4738 The third arg KEEP-TIME non-nil means give the output files the same
4739 last-modified time as the old ones. (This works on only some systems.)
4741 A prefix arg makes KEEP-TIME non-nil.
4743 Noninteractively, the last argument PARENTS says whether to
4744 create parent directories if they don't exist. Interactively,
4745 this happens by default."
4752 default-directory default-directory nil nil)
4753 current-prefix-arg t)))
4754 ;; If default-directory is a remote directory, make sure we find its
4755 ;; copy-directory handler.
4761 ;; Compute target name.
4766 ;; Copy recursively.
4778 ;; We do not want to copy "." and "..".
4781 ;; Set directory attributes.
4785 \f
4788 "Function to use to revert this buffer, or nil to do the default.
4789 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4794 "Function to use to insert contents when reverting this buffer.
4795 Gets two args, first the nominal file name to use,
4796 and second, t if reading the auto-save file.
4801 "Function to check whether a non-file buffer needs reverting.
4802 This should be a function with one optional argument NOCONFIRM.
4803 Auto Revert Mode passes t for NOCONFIRM. The function should return
4804 non-nil if the buffer should be reverted. A return value of
4805 `fast' means that the need for reverting was not checked, but
4806 that reverting the buffer is fast. The buffer is current when
4807 this function is called.
4809 The idea behind the NOCONFIRM argument is that it should be
4810 non-nil if the buffer is going to be reverted without asking the
4811 user. In such situations, one has to be careful with potentially
4812 time consuming operations.
4814 For more information on how this variable is used by Auto Revert mode,
4818 "Normal hook for `revert-buffer' to run before reverting.
4819 If `revert-buffer-function' is used to override the normal revert
4823 "Normal hook for `revert-buffer' to run after reverting.
4824 Note that the hook value that it runs is the value that was in effect
4825 before reverting; that makes a difference if you have buffer-local
4826 hook functions.
4828 If `revert-buffer-function' is used to override the normal revert
4834 "Replace current buffer text with the text of the visited file on disk.
4835 This undoes all changes since the file was visited or saved.
4836 With a prefix argument, offer to revert from latest auto-save file, if
4837 that is more recent than the visited file.
4839 This command also implements an interface for special buffers
4840 that contain text which doesn't come from a file, but reflects
4841 some other data instead (e.g. Dired buffers, `buffer-list'
4842 buffers). This is done via the variable `revert-buffer-function'.
4843 In these cases, it should reconstruct the buffer contents from the
4844 appropriate data.
4846 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4847 to revert from the auto-save file when this is nil. Note that the
4848 sense of this argument is the reverse of the prefix argument, for the
4849 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4850 to nil.
4852 Optional second argument NOCONFIRM means don't ask for confirmation
4853 at all. \(The variable `revert-without-query' offers another way to
4854 revert buffers without querying for confirmation.)
4856 Optional third argument PRESERVE-MODES non-nil means don't alter
4857 the files modes. Normally we reinitialize them using `normal-mode'.
4859 If the value of `revert-buffer-function' is non-nil, it is called to
4860 do all the work for this command. Otherwise, the hooks
4861 `before-revert-hook' and `after-revert-hook' are run at the beginning
4862 and the end, and if `revert-buffer-insert-file-contents-function' is
4863 non-nil, it is called instead of rereading visited file contents."
4865 ;; I admit it's odd to reverse the sense of the prefix argument, but
4866 ;; there is a lot of code out there which assumes that the first
4867 ;; argument should be t to avoid consulting the auto-save file, and
4868 ;; there's no straightforward way to encourage authors to notice a
4869 ;; reversal of the argument sense. So I'm just changing the user
4870 ;; interface, but leaving the programmatic interface the same.
4878 buffer-auto-save-file-name
4883 buffer-auto-save-file-name
4884 buffer-file-name)))
4894 file-name)))
4896 ;; If file was backed up but has changed since,
4897 ;; we should make another backup.
4901 ;; Effectively copy the after-revert-hook status,
4902 ;; since after-find-file will clobber it.
4905 after-revert-hook))
4910 ;; Get rid of all undo records for this buffer.
4912 ;; Don't make undo records for the reversion.
4915 file-name auto-save-p)))
4918 "File %s no longer exists!"
4920 file-name))
4923 "File %s no longer readable!"
4925 file-name))
4927 ;; Bind buffer-file-name to nil
4928 ;; so that we don't try to lock the file.
4934 ;; Auto-saved file should be read by Emacs'
4935 ;; internal coding.
4939 buffer-file-coding-system-explicit
4942 coding-system-for-read
4944 coding-system-for-read)
4946 ;; As a coding system suitable for multibyte
4947 ;; buffer is specified, make the current
4948 ;; buffer multibyte.
4951 ;; This force after-insert-file-set-coding
4952 ;; (called from insert-file-contents) to set
4953 ;; buffer-file-coding-system to a proper value.
4956 ;; Note that this preserves point in an intelligent way.
4960 nil nil t))
4962 nil nil t)))))
4963 ;; Recompute the truename in case changes in symlinks
4964 ;; have changed the truename.
4968 ;; Run after-revert-hook as it was before we reverted.
4972 local-hook)
4975 t))))))
4978 "Recover the visited file--get contents from its last auto-save file."
4983 "Visit file FILE, but get contents from its last auto-save file."
4984 ;; Actually putting the file name in the minibuffer should be used
4985 ;; only rarely.
4986 ;; Not just because users often use the default.
5006 ;; Use insert-directory-safely, not insert-directory,
5007 ;; because these files might not exist. In particular,
5008 ;; FILE might not exist if the auto-save file was for
5009 ;; a buffer that didn't visit a file, such as "*mail*".
5010 ;; The code in v20.x called `ls' directly, so we need
5011 ;; to emulate what `ls' did in that case.
5017 ;; Keep the current buffer-file-coding-system.
5019 ;; Auto-saved file should be read with special coding.
5028 "Recover auto save files from a previous Emacs session.
5029 This command first displays a Dired buffer showing you the
5030 previous sessions that you could recover from.
5031 To choose one, move point to the proper line and then type C-c C-c.
5032 Then you'll be asked about a number of files to recover."
5042 auto-save-list-file-prefix)))
5043 t)
5052 ;; Each line starts with a space
5053 ;; so that Font Lock mode won't highlight the first character.
5062 "Choose one saved session to recover auto-save files from.
5063 This command is used in the special Dired buffer created by
5066 ;; Get the name of the session file to recover from.
5068 files
5074 ;; Read in the auto-save-list file.
5077 ;; Loop thru the text of that file
5078 ;; and get out the names of the files to recover.
5082 ;; This is a pair of lines for a non-file-visiting buffer.
5083 ;; Get the auto-save file name and manufacture
5084 ;; a "visited file name" from that.
5087 ;; If there is no auto-save file name, the
5088 ;; auto-save-list file is probably corrupted.
5101 ;; This pair of lines is a file-visiting
5102 ;; buffer. Use the visited file name.
5112 ;; Ignore a file if its auto-save file does not exist now.
5116 ;; The file contains a pair of line for each auto-saved buffer.
5117 ;; The first line of the pair contains the visited file name
5118 ;; or is empty if the buffer was not visiting a file.
5119 ;; The second line is the auto-save file name.
5127 files
5133 "Kill BUFFER if confirmed."
5141 "Kill some buffers. Asks the user whether to kill each one of them.
5142 Non-interactively, if optional argument LIST is non-nil, it
5143 specifies the list of buffers to kill, asking for approval for each one."
5151 ; if we killed the base buffer.
5158 "Kill buffers whose name matches the specified REGEXP.
5159 The optional second argument indicates whether to kill internal buffers too."
5168 \f
5170 "Toggle auto-saving of contents of current buffer.
5171 With prefix argument ARG, turn auto-saving on if positive, else off."
5176 ;; If auto-save is off because buffer has shrunk,
5177 ;; then toggling should turn it on.
5182 buffer-file-name
5184 ;; If -1 was stored here, to temporarily turn off saving,
5185 ;; turn it back on.
5191 buffer-auto-save-file-name)
5194 "Adjust current buffer's auto save file name for current conditions.
5195 Also rename any existing auto save file, if it was made in this session."
5207 "Return file name to use for auto-saves of current buffer.
5208 Does not consider `auto-save-visited-file-name' as that variable is checked
5209 before calling this function. You can redefine this for customization.
5210 See also `auto-save-file-name-p'."
5218 result uniq)
5219 ;; Apply user-specified translations
5220 ;; to the file name.
5224 filename)
5234 filename))))
5239 ;; We truncate the file name to DOS 8+3 limits
5240 ;; before doing anything else, because the regexp
5241 ;; passed to string-match below cannot handle
5242 ;; extensions longer than 3 characters, multiple
5243 ;; dots, and other atrocities.
5248 fn)
5253 "#"
5256 ;; Make sure auto-save file names don't contain characters
5257 ;; invalid for the underlying filesystem.
5259 ;; Don't modify remote (ange-ftp) filenames
5262 result))))
5264 ;; Deal with buffers that don't have any associated files. (Mail
5265 ;; mode tends to create a good number of these.)
5269 file-name)
5270 ;; Restrict the characters used in the file name to those which
5271 ;; are known to be safe on all filesystems, url-encoding the
5272 ;; rest.
5273 ;; We do this on all platforms, because even if we are not
5274 ;; running on DOS/Windows, the current directory may be on a
5275 ;; mounted VFAT filesystem, such as a USB memory stick.
5279 ;; For multibyte characters, this will produce more than
5280 ;; 2 hex digits, so is not true URL encoding.
5284 ;; Generate the file name.
5290 ;; Try a few alternative directories, to get one we can
5291 ;; write it.
5297 ;; Don't modify remote (ange-ftp) filenames
5299 ;; The call to convert-standard-filename is in case
5300 ;; buffer-name includes characters not allowed by the
5301 ;; DOS/Windows filesystems. make-temp-file writes to the
5302 ;; file it creates, so we must fix the file name _before_
5303 ;; make-temp-file is called.
5305 fname))
5307 ;; make-temp-file creates the file,
5308 ;; but we don't want it to exist until we do an auto-save.
5312 file-name)))
5315 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5316 FILENAME should lack slashes. You can redefine this for customization."
5318 \f
5320 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5321 The generated regexp will match a filename only if the filename
5322 matches that wildcard according to shell rules. Only wildcards known
5323 by `sh' are supported."
5325 ;; Copy the initial run of non-special characters.
5328 ;; If no special characters, we're almost done.
5332 j)
5334 result
5355 ;; Found "[^". Insert a `\0' character
5356 ;; (which cannot happen in a filename)
5357 ;; into the character class, so that `^'
5358 ;; is not the first character after `[',
5359 ;; and thus non-special in a regexp.
5364 ;; I don't think `]' can appear in a
5365 ;; character class in a wildcard, but
5366 ;; let's be general here.
5373 i
5386 ;; Shell wildcards should match the entire filename,
5387 ;; not its part. Make the regexp say so.
5389 \f
5392 "Switches for `list-directory' to pass to `ls' for brief listing."
5398 "Switches for `list-directory' to pass to `ls' for verbose listing."
5403 "Expand wildcard pattern PATTERN.
5404 This returns a list of file names which match the pattern.
5406 If PATTERN is written as an absolute file name,
5407 the values are absolute also.
5409 If PATTERN is written as a relative file name, it is interpreted
5410 relative to the current default directory, `default-directory'.
5411 The file names returned are normally also relative to the current
5412 default directory. However, if FULL is non-nil, they are absolute."
5416 ;; A list of all dirs that DIRPART specifies.
5417 ;; This can be more than one dir
5418 ;; if DIRPART contains wildcards.
5422 dirpart)))
5426 contents)
5431 ;; Filter out "." and ".."
5436 name))
5443 this-dir-contents)
5444 this-dir-contents)
5445 contents))))
5447 contents)))
5449 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5453 "Display a list of files in or matching DIRNAME, a la `ls'.
5454 DIRNAME is globbed by the shell if necessary.
5455 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5456 Actions controlled by variables `list-directory-brief-switches'
5457 and `list-directory-verbose-switches'."
5461 nil default-directory nil)
5462 pfx)))
5464 list-directory-brief-switches))
5465 buffer)
5477 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5485 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5487 PATTERN is assumed to represent a file-name wildcard suitable for the
5488 underlying filesystem. For Unix and GNU/Linux, each character from the
5490 the parts of the pattern which don't include wildcard characters are
5491 quoted with double quotes.
5494 on Windows), so PATTERN can use them to quote wildcard characters that
5495 need to be passed verbatim to shell commands."
5499 ;; DOS/Windows don't allow `"' in file names. So if the
5500 ;; argument has quotes, we can safely assume it is already
5501 ;; quoted by the caller.
5503 ;; We quote [&()#$'] in case their shell is a port of a
5504 ;; Unixy shell. We quote [,=+] because stock DOS and
5505 ;; Windows shells require that in some cases, such as
5506 ;; passing arguments to batch files that use positional
5507 ;; arguments like %1.
5509 pattern
5512 end)
5529 pattern))))
5536 "Program to get the amount of free space on a file system.
5537 We assume the output has the format of `df'.
5538 The value of this variable must be just a command name or file name;
5539 if you want to specify options, use `directory-free-space-args'.
5541 A value of nil disables this feature.
5543 If the function `file-system-info' is defined, it is always used in
5544 preference to the program given by this variable."
5550 "Options to use when running `directory-free-space-program'."
5555 "Return the amount of free space on directory DIR's file system.
5556 The result is a string that gives the number of free 1KB blocks,
5557 or nil if the system call or the program which retrieve the information
5558 fail. It returns also nil when DIR is a remote directory.
5560 This function calls `file-system-info' if it is available, or invokes the
5561 program specified by `directory-free-space-program' if that is non-nil."
5563 ;; Try to find the number of free blocks. Non-Posix systems don't
5564 ;; always have df, but might have an equivalent system call.
5573 ;; Avoid failure if the default directory does
5574 ;; not exist (Bug#2631, Bug#3911).
5577 nil t nil
5578 directory-free-space-args
5579 dir)
5581 ;; Usual format is a header line followed by a line of
5582 ;; numbers.
5587 ;; Move to the end of the "available blocks" number.
5590 ;; Copy it into AVAILABLE.
5595 ;; The following expression replaces `dired-move-to-filename-regexp'.
5599 ;; In some locales, month abbreviations are as short as 2 letters,
5600 ;; and they can be followed by ".".
5601 ;; In Breton, a month name can include a quote character.
5614 s "+"
5617 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5618 ;; omits the Kanji characters after month and day-of-month.
5619 ;; On Mac OS X 10.3, the date format in East Asian locales is
5620 ;; day-of-month digits followed by month digits.
5626 ;; The "[0-9]" below requires the previous column to end in a digit.
5627 ;; This avoids recognizing `1 may 1997' as a date in the line:
5628 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5630 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5632 ;; For non-iso date formats, we add the ".*" in order to find
5633 ;; the last possible match. This avoids recognizing
5634 ;; `jservice 10 1024' as a date in the line:
5635 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5637 ;; vc dired listings provide the state or blanks between file
5638 ;; permissions and date. The state is always surrounded by
5639 ;; parantheses:
5640 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5641 ;; This is not supported yet.
5646 "Regular expression to match up to the file name in a directory listing.
5647 The default value is designed to recognize dates and times
5652 ;; insert-directory
5653 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5654 ;; FULL-DIRECTORY-P is nil.
5655 ;; The single line of output must display FILE's name as it was
5656 ;; given, namely, an absolute path name.
5657 ;; - must insert exactly one line for each file if WILDCARD or
5658 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5659 ;; before the file lines, plus optional text after the file lines.
5660 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5661 ;; allowed.
5662 ;; File lines should display the basename.
5663 ;; - must be consistent with
5664 ;; - functions dired-move-to-filename, (these two define what a file line is)
5665 ;; dired-move-to-end-of-filename,
5666 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5667 ;; dired-insert-headerline
5668 ;; dired-after-subdir-garbage (defines what a "total" line is)
5669 ;; - variable dired-subdir-regexp
5670 ;; - may be passed "--dired" as the first argument in SWITCHES.
5671 ;; Filename handlers might have to remove this switch if their
5672 ;; "ls" command does not support it.
5674 "Insert directory listing for FILE, formatted according to SWITCHES.
5675 Leaves point after the inserted text.
5676 SWITCHES may be a string of options, or a list of strings
5677 representing individual options.
5678 Optional third arg WILDCARD means treat FILE as shell wildcard.
5679 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5680 switches do not contain `d', so that a full listing is expected.
5682 This works by running a directory listing program
5683 whose name is in the variable `insert-directory-program'.
5684 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5686 When SWITCHES contains the long `--dired' option, this function
5687 treats it specially, for the sake of dired. However, the
5688 normally equivalent short `-D' option is just passed on to
5689 `insert-directory-program', as any other option."
5690 ;; We need the directory in order to find the right handler.
5695 wildcard full-directory-p)
5698 ;; Read the actual directory using `insert-directory-program'.
5699 ;; RESULT gets the status code.
5701 ;; putting text property `dired-filename, decode one
5702 ;; bunch by one to preserve that property.
5704 ;; This is to control encoding the arguments in call-process.
5708 default-file-name-coding-system))))
5711 ;; Run ls in the directory part of the file pattern
5712 ;; using the last component as argument.
5719 shell-file-name nil t nil
5720 "-c"
5722 ""
5724 insert-directory-program
5725 " -d "
5727 switches
5729 " -- "
5730 ;; Quote some characters that have
5731 ;; special meanings in shells; but
5732 ;; don't quote the wildcards--we want
5733 ;; them to be special. We also
5734 ;; currently don't quote the quoting
5735 ;; characters in case people want to
5736 ;; use them explicitly to quote
5737 ;; wildcard characters.
5739 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5740 ;; directory if FILE is a symbolic link.
5747 insert-directory-program nil t nil
5751 ;; Split the switches at any spaces so we can
5752 ;; pass separate options as separate args.
5754 ;; Avoid lossage if FILE starts with `-'.
5762 file))))))))
5764 ;; If we got "//DIRED//" in the output, it means we got a real
5765 ;; directory listing, even if `ls' returned nonzero.
5766 ;; So ignore any errors.
5779 ;; The first time ls returns an error,
5780 ;; find the version numbers of ls,
5781 ;; and set insert-directory-ls-version
5782 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5783 ;; is equal or if the info cannot be obtained.
5784 ;; (That can mean it isn't GNU ls.)
5794 comparison)
5810 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5814 ;; If `insert-directory-program' failed, signal an error.
5816 ;; Delete the error message it may have output.
5818 ;; On non-Posix systems, we cannot open a directory, so
5819 ;; don't even try, because that will always result in
5820 ;; the ubiquitous "Access denied". Instead, show the
5821 ;; command line so the user can try to guess what went wrong.
5826 insert-directory-program
5828 file result)
5829 ;; Unix. Access the file to get a suitable error.
5836 ;; The following overshoots by one line for an empty
5837 ;; directory listed with "--dired", but without "-a"
5838 ;; switch, where the ls output contains a
5839 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5840 ;; We take care of that case later.
5848 error-lines)
5849 ;; Find all the lines that are error messages,
5850 ;; and record the bounds of each one.
5857 ;; Now read the numeric positions of file names.
5864 error-lines))
5867 error-lines)))
5869 ;; End is followed by \n or by " -> ".
5871 ;; It seems that we can't trust ls's output as to
5872 ;; byte positions of filenames.
5878 ;; Take care of the case where the ls output contains a
5879 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5880 ;; and we went one line too far back (see above).
5885 ;; Now decode what read if necessary.
5887 file-name-coding-system
5888 default-file-name-coding-system
5890 coding-no-eol
5891 val pos)
5895 ;; If no coding system is specified or detection is
5896 ;; requested, detect the coding.
5910 ;; Force no eol conversion on a file name, so
5911 ;; that CR is preserved.
5919 ;; Try to insert the amount of free space.
5922 ;; First find the line to put it on.
5926 ;; Replace "total" with "used", to avoid confusion.
5932 "Convert `ls --dired' file name position value POS to a buffer position.
5933 File name position values returned in ls --dired output
5934 count only stdout; they don't count the error messages sent to stderr.
5935 So this function converts to them to real buffer positions.
5936 ERROR-LINES is a list of buffer positions of error message lines,
5937 of the form (START END)."
5941 pos)
5945 "Insert directory listing for FILE, formatted according to SWITCHES.
5947 Like `insert-directory', but if FILE does not exist, it inserts a
5948 message to that effect instead of signaling an error."
5951 ;; Simulate the message printed by `ls'.
5955 "Functions to call with no arguments to query about killing Emacs.
5956 If any of these functions returns nil, killing Emacs is cancelled.
5957 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5961 "How to ask for confirmation when leaving Emacs.
5962 If nil, the default, don't ask at all. If the value is non-nil, it should
5963 be a predicate function such as `yes-or-no-p'."
5971 "Offer to save each buffer, then kill this Emacs process.
5972 With prefix ARG, silently save all file-visiting buffers, then kill."
5981 ;; process-list is not defined on MSDOS.
5983 active)
5992 ;; Query the user for other things, perhaps.
5999 "Offer to save each buffer, then kill the current connection.
6000 If the current frame has no client, kill Emacs itself.
6002 With prefix ARG, silently save all file-visiting buffers, then kill.
6004 If emacsclient was started with a list of filenames to edit, then
6005 only these files will be asked to be saved."
6010 \f
6011 ;; We use /: as a prefix to "quote" a file name
6012 ;; so that magic file name handlers will not apply to it.
6016 file-name-handler-alist))
6018 ;; We depend on being the last handler on the list,
6019 ;; so that anything else which does need handling
6020 ;; has been handled already.
6021 ;; So it is safe for us to inhibit *all* magic file name handlers.
6030 default-directory))
6031 ;; Get a list of the indices of the args which are file names.
6034 ;; The first six are special because they
6035 ;; return a file name. We want to include the /:
6036 ;; in the return value.
6037 ;; So just avoid stripping it in the first place.
6044 ;; `identity' means just return the first arg
6045 ;; not stripped of its quoting.
6047 ;; `add' means add "/:" to the result.
6050 ;; `unquote-then-quote' means set buffer-file-name
6051 ;; temporarily to unquoted filename.
6053 ;; List the arguments which are filenames.
6061 ;; For all other operations, treat the first argument only
6062 ;; as the file name.
6064 method
6065 ;; Copy ARGUMENTS so we can replace elements in it.
6069 ;; Strip off the /: from the file names that have it.
6077 "/"
6094 \f
6095 ;; Symbolic modes and read-file-modes.
6098 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6099 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6100 Others, or All) for whom to produce the mask.
6101 The bit-mask that is returned extracts from mode bits the access rights
6102 for the specified category of users."
6110 "Convert CHAR to a numeric value of mode bits.
6111 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6112 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6119 ;; Rights relative to the previous file modes.
6130 "Convert a symbolic mode string specification to an equivalent number.
6132 WHO-MASK is the bit-mask specifying the category of users to which to
6133 apply the access permissions. See `file-modes-char-to-who'.
6134 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6135 RIGHTS request to add, remove, or set permissions based on existing ones,
6142 char-right)
6149 num-rights
6153 op char-right)))
6154 num-rights))
6157 "Convert symbolic file modes to numeric file modes.
6158 MODES is the string to convert, it should match
6161 notation.
6162 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6163 MODES request to add, remove, or set permissions based on existing ones,
6177 num-who num-modes)
6180 num-modes)))
6183 "Read file modes in octal or symbolic notation and return its numeric value.
6184 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6185 ORIG-FILE is the name of a file on whose mode bits to base returned
6186 permissions if what user types requests to add, remove, or set permissions
6202 nil nil default)))
6208 \f
6209 ;; Trashcan handling.
6211 "Directory for `move-file-to-trash' to move files and directories to.
6212 This directory is only used when the function `system-move-file-to-trash'
6213 is not defined.
6214 Relative paths are interpreted relative to `default-directory'.
6215 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6225 "Move the file (or directory) named FILENAME to the trash.
6226 When `delete-by-moving-to-trash' is non-nil, this function is
6227 called by `delete-file' and `delete-directory' instead of
6228 deleting files outright.
6230 If the function `system-move-file-to-trash' is defined, call it
6231 with FILENAME as an argument.
6232 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6233 directory.
6234 Otherwise, trash FILENAME using the freedesktop.org conventions,
6235 like the GNOME, KDE and XFCE desktop environments. Emacs only
6239 ;; If `trash-directory' is non-nil, move the file there.
6243 trash-dir)))
6244 ;; We can't trash a parent directory of trash-directory.
6247 trash-dir filename))
6250 ;; Ensure that the trashed file-name is unique.
6257 ;; If `system-move-file-to-trash' is defined, use it.
6260 ;; Otherwise, use the freedesktop.org method, as specified at
6261 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6272 ;; Check if we have permissions to delete.
6276 ;; The trashed file cannot be the trash dir or its parent.
6279 trash-files-dir filename))
6282 trash-info-dir filename))
6284 ;; Ensure that the trash directory exists; otherwise, create it.
6293 ;; Try to move to trash with .trashinfo undo information
6298 ;; Perform url-encoding on FN. For compatibility with
6299 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6300 ;; for path separators.
6305 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6306 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6319 fn))
6324 ;; Attempt to make .trashinfo file, trying up to 5
6325 ;; times. The .trashinfo file is opened with O_EXCL,
6326 ;; as per trash-spec 0.7, even if that can be a problem
6327 ;; on old NFS versions...
6331 trash-files-dir))
6333 success info-fn)
6338 trash-info-dir))
6346 ;; Uniqify new-fn. (Some file managers do not
6347 ;; like Emacs-style backup file names---e.g. bug
6348 ;; 170956 in Konqueror bug tracker.)
6353 ;; Finally, try to move the file to the trashcan.
6357 \f
6382 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6383 ;;; files.el ends here