| blob | fc44193838dd9da9aa30cbc3cf1611c5bd98e91f |
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 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 2, or (at your option)
14 ;; 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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
32 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "*Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "*Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 Do not use `~' in the TO strings.
63 They should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
75 ;; Turn off backup files on VMS since it has version numbers.
77 "*Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
106 "*Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
112 "*Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
119 "*Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
129 "*Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
141 "Predicate that looks at a file name and decides whether to make backups.
145 "*Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
153 "*Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
160 "*Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
167 "*Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
198 "The directory for writing temporary files."
204 "The directory for writing small temporary files.
205 If non-nil, this directory is used instead of `temporary-file-directory'
206 by programs that create small temporary files. This is for systems that
207 have fast storage with limited space, such as a RAM disk."
211 ;; The system null device. (Should reference NULL_DEVICE from C.)
228 "*Non-nil means protect against I/O errors while saving files.
229 Some modes set this non-nil in particular buffers.
231 This feature works by writing the new contents into a temporary file
232 and then renaming the temporary file to replace the original.
233 In this way, any I/O error in writing leaves the original untouched,
234 and there is never any instant where the file is nonexistent.
236 Note that this feature forces backups to be made by copying.
237 Yet, at the same time, saving a precious file
238 breaks any hard links between it and other files."
243 "*Control use of version numbers for backup files.
244 t means make numeric backup versions unconditionally.
245 nil means make them for files that have some already.
246 `never' means do not make them."
254 "*When cleaning directory, number of versions to keep."
260 "*If t, delete excess backup versions silently.
261 If nil, ask confirmation. Any other value prevents any trimming."
268 "*Number of oldest versions to keep when a new numbered backup is made."
273 "*Number of newest versions to keep when a new numbered backup is made.
274 Includes the new backup. Must be > 0"
279 "*Whether to add a newline automatically at the end of the file.
281 A value of t means do this only when the file is about to be saved.
282 A value of `visit' means do this right after the file is visited.
283 A value of `visit-save' means do it at both of those times.
284 Any other non-nil value means ask user whether to add a newline, when saving.
285 nil means don't add newlines.
287 Certain major modes set this locally to the value obtained
288 from `mode-require-final-newline'."
297 "*Whether to add a newline at end of file, in certain major modes.
298 Those modes set `require-final-newline' to this value when you enable them.
299 They do so because they are often used for files that are supposed
300 to end in newlines, and the question is how to arrange that.
302 A value of t means do this only when the file is about to be saved.
303 A value of `visit' means do this right after the file is visited.
304 A value of `visit-save' means do it at both of those times.
305 Any other non-nil value means ask user whether to add a newline, when saving.
307 nil means do not add newlines. That is a risky choice in this variable
308 since this value is used for modes for files that ought to have final newlines.
309 So if you set this to nil, you must explicitly check and add
310 a final newline, whenever you save a file that really needs one."
320 "*Non-nil says by default do auto-saving of every file-visiting buffer."
325 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
326 Normally auto-save files are written under other names."
332 ;; Don't put "\\2" inside expand-file-name, since it will be
333 ;; transformed to "/2" on DOS/Windows.
335 "*Transforms to apply to buffer file name before making auto-save file name.
336 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
337 REGEXP is a regular expression to match against the file name.
338 If it matches, `replace-match' is used to replace the
339 matching part with REPLACEMENT.
340 If the optional element UNIQUIFY is non-nil, the auto-save file name is
341 constructed by taking the directory part of the replaced file-name,
342 concatenated with the buffer file name with all directory separators
343 changed to `!' to prevent clashes. This will not work
344 correctly if your filesystem truncates the resulting name.
346 All the transforms in the list are tried, in the order they are listed.
347 When one transform applies, its result is final;
348 no further transforms are tried.
350 The default value is set up to put the auto-save file into the
351 temporary directory (see the variable `temporary-file-directory') for
352 editing a remote file.
354 On MS-DOS filesystems without long names this variable is always
355 ignored."
362 "*Non-nil means save word abbrevs too when files are saved.
363 If `silently', don't ask the user before saving."
368 "*Non-nil means allow `find-file' to visit directories.
369 To visit the directory, `find-file' runs `find-directory-functions'."
374 "*List of functions to try in sequence to visit a directory.
375 Each function is called with the directory name as the sole argument
376 and should return either a buffer or nil."
380 ;;;It is not useful to make this a local variable.
381 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
383 "List of functions to be called for `find-file' on nonexistent file.
384 These functions are called as soon as the error is detected.
385 Variable `buffer-file-name' is already set up.
390 ;;;It is not useful to make this a local variable.
391 ;;;(put 'find-file-hooks 'permanent-local t)
393 "List of functions to be called after a buffer is loaded from a file.
394 The buffer's local variables (if any) will have been processed before the
395 functions are called."
403 "List of functions to be called before writing out a buffer to a file.
404 If one of them returns non-nil, the file is considered already written
405 and the rest are not called.
406 These hooks are considered to pertain to the visited file.
407 So any buffer-local binding of this variable is discarded if you change
409 change the major mode.
411 This hook is not run if any of the functions in
412 `write-contents-functions' returns non-nil. Both hooks pertain
413 to how to save a buffer to file, for instance, choosing a suitable
414 coding system and setting mode bits. (See Info
415 node `(elisp)Saving Buffers'.) To perform various checks or
426 "List of functions to be called before writing out a buffer to a file.
427 If one of them returns non-nil, the file is considered already written
428 and the rest are not called and neither are the functions in
429 `write-file-functions'.
431 This variable is meant to be used for hooks that pertain to the
432 buffer's contents, not to the particular visited file; thus,
433 `set-visited-file-name' does not clear this variable; but changing the
434 major mode does clear it.
436 For hooks that _do_ pertain to the particular visited file, use
437 `write-file-functions'. Both this variable and
438 `write-file-functions' relate to how a buffer is saved to file.
439 To perform various checks or updates before the buffer is saved,
446 "*Control use of local variables in files you visit.
447 The value can be t, nil or something else.
449 A value of t means file local variables specifications are obeyed
450 if all the specified variable values are safe; if any values are
451 not safe, Emacs queries you, once, whether to set them all.
453 A value of nil means always ignore the file local variables.
454 Any other value means always query you once whether to set them all.
456 This variable also controls use of major modes specified in
457 a -*- line.
460 always obeys file local variable specifications and the -*- line,
461 and ignores this variable."
468 "Like `enable-local-variables' but meant for buffer-local bindings.
469 The meaningful values are nil and non-nil. The default is non-nil.
470 If a major mode sets this to nil, buffer-locally, then any local
471 variables list in the file will be ignored.
473 This variable does not affect the use of major modes
478 The value can be t, nil or something else.
479 A value of t means obey `eval' variables;
480 nil means ignore them; anything else means query."
486 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
495 "*Non-nil means buffers visiting files read-only do so in view mode.
496 In fact, this means that all read-only buffers normally have
497 View mode enabled, including buffers that are read-only because
498 you visit a file you cannot alter, and buffers you make read-only
505 "Provides support for ange-ftp host name completion.
506 Runs the usual ange-ftp hook, but only for completion operations."
507 ;; Having this here avoids the need to load ange-ftp when it's not
508 ;; really in use.
514 inhibit-file-name-handlers)))
519 "Convert a standard file's name to something suitable for the OS.
520 This means to guarantee valid names and perhaps to canonicalize
521 certain patterns.
523 FILENAME should be an absolute file name since the conversion rules
524 sometimes vary depending on the position in the file name. E.g. c:/foo
525 is a valid DOS file name, but c:/bar/c:/foo is not.
527 This function's standard definition is trivial; it just returns
528 the argument. However, on Windows and DOS, replace invalid
529 characters. On DOS, make sure to obey the 8.3 limitations. On
530 Windows, turn Cygwin names into native names, and also turn
531 slashes into backslashes if the shell requires it (see
532 `w32-shell-dos-semantics').
534 See Info node `(elisp)Standard File Names' for more details."
535 filename)
538 "Read directory name, prompting with PROMPT and completing in directory DIR.
539 Value is not expanded---you must call `expand-file-name' yourself.
540 Default name to DEFAULT-DIRNAME if user exits with the same
541 non-empty string that was inserted by this function.
542 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
543 or just DIR if INITIAL is nil.)
544 If the user exits with an empty minibuffer, this function returns
545 an empty string. (This can only happen if the user erased the
546 pre-inserted contents or if `insert-default-directory' is nil.)
547 Fourth arg MUSTMATCH non-nil means require existing directory's name.
548 Non-nil and non-t means also require confirmation after completion.
549 Fifth arg INITIAL specifies text to start with.
550 DIR should be an absolute directory name. It defaults to
551 the value of `default-directory'."
556 dir))
557 mustmatch initial
560 \f
562 "Show the current default directory."
567 "Value of the CDPATH environment variable, as a list.
571 "Explode a search path into a list of directory names.
572 Directories are separated by occurrences of `path-separator'
573 \(which is colon in GNU and GNU-like systems)."
574 ;; We could use split-string here.
582 nil
587 cd-list)))
590 "Change current directory to given absolute file name DIR."
591 ;; Put the name into directory syntax now,
592 ;; because otherwise expand-file-name may give some bad results.
605 "Make DIR become the current buffer's default directory.
606 If your environment includes a `CDPATH' variable, try each one of
607 that list of directories (separated by occurrences of
608 `path-separator') when resolving a relative directory name.
609 The path separator is colon in GNU and GNU-like systems."
612 default-directory default-directory
628 cd-path)
629 nil))
633 "Load the Lisp file named FILE."
634 ;; This is a case where .elc makes a lot of sense.
641 "Search for FILENAME through PATH.
642 If found, return the absolute file name of FILENAME, with its suffixes;
643 otherwise return nil.
644 PATH should be a list of directories to look in, like the lists in
645 `exec-path' or `load-path'.
646 If SUFFIXES is non-nil, it should be a list of suffixes to append to
649 If non-nil, PREDICATE is used instead of `file-readable-p'.
650 PREDICATE can also be an integer to pass to the `access' system call,
651 in which case file-name handlers are ignored. This usage is deprecated.
653 For compatibility, PREDICATE can also be one of the symbols
654 `executable', `readable', `writable', or `exists', or a list of
655 one or more of those symbols."
666 "Do completion for file names passed to `locate-file'.
667 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
690 "Search for COMMAND in `exec-path' and return the absolute file name.
691 Return nil if COMMAND is not found anywhere in `exec-path'."
692 ;; Use 1 rather than file-executable-p to better match the behavior of
693 ;; call-process.
697 "Load the library named LIBRARY.
698 This is an interface to the function `load'."
701 'locate-file-completion
706 "Test whether FILE specifies a location on a remote system.
707 Return an identification of the system if the location is indeed
708 remote. The identification of the system may comprise a method
709 to access the system and its hostname, amongst other things.
716 nil)))
719 "Copy the file FILE into a temporary file on this machine.
720 Returns the name of the local copy, or nil, if FILE is directly
721 accessible."
722 ;; This formerly had an optional BUFFER argument that wasn't used by
723 ;; anything.
727 nil)))
730 "Return the truename of FILENAME, which should be absolute.
731 The truename of a file name is found by chasing symbolic links
732 both at the level of the file and at the level of the directories
733 containing it, until no links are left at any level.
736 ;; COUNTER and PREV-DIRS are only used in recursive calls.
737 ;; COUNTER can be a cons cell whose car is the count of how many
738 ;; more links to chase before getting an error.
739 ;; PREV-DIRS can be a cons cell whose car is an alist
740 ;; of truenames we've just recently computed.
754 ;; For speed, remove the ange-ftp completion handler from the list.
755 ;; We know it's not needed here.
756 ;; For even more speed, do this only on the outermost call.
763 ;; andrewi@harlequin.co.uk - none of the following code (except for
764 ;; invoking the file-name handler) currently applies on Windows
765 ;; (ie. there are no native symlinks), but there is an issue with
766 ;; case differences being ignored by the OS, and short "8.3 DOS"
767 ;; name aliases existing for all files. (The short names are not
768 ;; reported by directory-files, but can be used to refer to files.)
769 ;; It seems appropriate for file-truename to resolve these issues in
770 ;; the most natural way, which on Windows is to call the function
771 ;; `w32-long-file-name' - this returns the exact name of a file as
772 ;; it is stored on disk (expanding short name aliases with the full
773 ;; name in the process).
776 ;; For file name that has a special handler, call handler.
777 ;; This is so that ange-ftp can save time by doing a no-op.
780 ;; If filename contains a wildcard, newname will be the old name.
782 ;; If filename exists, use the long name
786 ;; If this file directly leads to a link, process that iteratively
787 ;; so that we don't use lots of stack.
793 ;; For file name that has a special handler, call handler.
794 ;; This is so that ange-ftp can save time by doing a no-op.
797 done t)
799 target dirfile)
800 ;; Get the truename of the directory.
802 ;; If these are equal, we have the (or a) root directory.
804 ;; If this is the same dir we last got the truename for,
805 ;; save time--don't recalculate.
815 done t)
818 done t)
819 ;; Put it back on the file name.
821 ;; Is the file name the name of a link?
824 ;; Yes => chase that link, then start all over
825 ;; since the link may point to a directory name that uses links.
826 ;; We can't safely use expand-file-name here
827 ;; since target might look like foo/../bar where foo
828 ;; is itself a link. Instead, we handle . and .. above.
831 target
833 done nil)
834 ;; No, we are done!
836 filename))
839 "Chase links in FILENAME until a name that is not a link.
840 Unlike `file-truename', this does not check whether a parent
841 directory name is a symbolic link.
842 If the optional argument LIMIT is a number,
843 it means chase no more than that many links and then stop."
851 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
854 ;; Handle `..' by hand, since it needs to work in the
855 ;; target of any directory symlink.
856 ;; This code is not quite complete; it does not handle
857 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
861 ;; Chase links in the default dir of the symlink.
865 ;; Now find the parent of that dir.
869 newname))
872 "Create a temporary file.
873 The returned file name (created by appending some random characters at the end
874 of PREFIX, and expanding against `temporary-file-directory' if necessary),
875 is guaranteed to point to a newly created empty file.
876 You can then use `write-region' to write new data into the file.
878 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
880 If SUFFIX is non-nil, add that at the end of the file name."
882 file)
885 ;; Create temp files with strict access rights. It's easy to
886 ;; loosen them later, whereas it's impossible to close the
887 ;; time-window of loose permissions otherwise.
899 nil)
901 ;; the file was somehow created by someone else between
902 ;; `make-temp-name' and `write-region', let's try again.
903 nil)
904 file)
905 ;; Reset the umask.
909 "Change the encoding of FILE's name from CODING to NEW-CODING.
910 The value is a new name of FILE.
911 Signals a `file-already-exists' error if a file of the new name
912 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
913 is non-nil. A number as fourth arg means request confirmation if
914 the new name already exists. This is what happens in interactive
915 use with M-x."
918 default-file-name-coding-system))
920 from-coding to-coding)
922 ;; We provide the default coding only when it seems that
923 ;; the filename is correctly decoded by the default
924 ;; coding.
930 filename default-coding)
931 default-coding))
935 ;; We provide the default coding only when a user is going to
936 ;; change the encoding not from the default coding.
940 filename from-coding)))
943 filename from-coding default-coding)
944 default-coding)))
948 default-file-name-coding-system))
949 ;; FILE should have been decoded by DEFAULT-CODING.
953 ;; Suppress further encoding.
958 newname))
959 \f
961 "Select buffer BUFFER in another window.
962 If BUFFER does not identify an existing buffer, then this function
963 creates a buffer with that name.
965 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
966 or nil. If BUFFER is nil, then this function chooses a buffer
967 using `other-buffer'.
968 Optional second arg NORECORD non-nil means
969 do not put this buffer at the front of the list of recently selected ones.
970 This function returns the buffer it switched to.
972 This uses the function `display-buffer' as a subroutine; see its
973 documentation for additional customization information."
976 ;; Don't let these interfere.
977 same-window-buffer-names same-window-regexps)
981 "Switch to buffer BUFFER in another frame.
982 Optional second arg NORECORD non-nil means
983 do not put this buffer at the front of the list of recently selected ones.
985 This uses the function `display-buffer' as a subroutine; see its
986 documentation for additional customization information."
989 same-window-buffer-names same-window-regexps)
994 "Switch to buffer BUFFER in another frame.
995 This uses the function `display-buffer' as a subroutine; see its
996 documentation for additional customization information."
999 same-window-buffer-names same-window-regexps
1001 new-window)
1011 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1012 BODY should use the minibuffer at most once.
1013 Recursive uses of the minibuffer will not be affected."
1019 ;; Clear out this hook so it does not interfere
1020 ;; with any recursive minibuffer usage.
1036 t))
1039 "Edit file FILENAME.
1040 Switch to a buffer visiting file FILENAME,
1041 creating one if none already exists.
1042 Interactively, the default if you just type RET is the current directory,
1043 but the visited file name is available through the minibuffer history:
1044 type M-n to pull it into the minibuffer.
1046 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1047 expand wildcards (if any) and visit multiple files. You can
1048 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1050 To visit a file without any kind of conversion and without
1059 "Edit file FILENAME, in another window.
1060 May create a new window, or reuse an existing one.
1061 See the function `display-buffer'.
1063 Interactively, the default if you just type RET is the current directory,
1064 but the visited file name is available through the minibuffer history:
1065 type M-n to pull it into the minibuffer.
1067 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1068 expand wildcards (if any) and visit multiple files."
1079 "Edit file FILENAME, in another frame.
1080 May create a new frame, or reuse an existing one.
1081 See the function `display-buffer'.
1083 Interactively, the default if you just type RET is the current directory,
1084 but the visited file name is available through the minibuffer history:
1085 type M-n to pull it into the minibuffer.
1087 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1088 expand wildcards (if any) and visit multiple files."
1099 "Edit the existing file FILENAME.
1107 "Edit file FILENAME but don't allow changes.
1119 value))
1122 "Edit file FILENAME in another window but don't allow changes.
1134 value))
1137 "Edit file FILENAME in another frame but don't allow changes.
1149 value))
1152 "Find file FILENAME as a replacement for the file in the next window.
1153 This command does not select that window.
1155 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1156 expand wildcards (if any) and replace the file with multiple files."
1168 t))))
1176 "Find file FILENAME, select its buffer, kill previous buffer.
1177 If the current buffer now contains an empty file that you just visited
1178 \(presumably by mistake), use this command to visit the file you really want.
1180 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1181 expand wildcards (if any) and replace the file with multiple files."
1191 t)))
1212 ;; This prevents us from finding the same buffer
1213 ;; if we specified the same file again.
1217 ;; Likewise for dired buffers.
1221 ;; This executes if find-file gets an error
1222 ;; and does not really find anything.
1223 ;; We put things back as they were.
1224 ;; If find-file actually finds something, we kill obuf below.
1233 ;; We already asked; don't ask again.
1236 \f
1238 "Create a suitably named buffer for visiting FILENAME, and return it.
1239 FILENAME (sans directory) is used unchanged if that name is free;
1240 otherwise a string <2> or <3> or ... is appended to get an unused name."
1247 "Create and return a buffer with a name based on NAME.
1248 Choose the buffer's name using `generate-new-buffer-name'."
1252 "Regexp to match the automounter prefix in a directory name."
1260 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1262 removes automounter prefixes (see the variable `automount-dir-prefix')."
1263 ;; Get rid of the prefixes added by the automounter.
1270 ;; If any elt of directory-abbrev-alist matches this name,
1271 ;; abbreviate accordingly.
1277 ;; Compute and save the abbreviated homedir name.
1278 ;; We defer computing this until the first time it's needed, to
1279 ;; give time for directory-abbrev-alist to be set properly.
1280 ;; We include a slash at the end, to avoid spurious matches
1281 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1288 ;; If FILENAME starts with the abbreviated homedir,
1289 ;; make it start with `~' instead.
1291 ;; If the home dir is just /, don't change it.
1294 ;; MS-DOS root directories can come with a drive letter;
1295 ;; Novell Netware allows drive letters beyond `Z:'.
1305 filename))
1308 "*List of logical names for which visiting shouldn't save the true dirname.
1309 On VMS, when you visit a file using a logical name that searches a path,
1310 you may or may not want the visited file name to record the specific
1311 directory where the file was found. If you *do not* want that, add the logical
1312 name to this list as a string."
1317 "Return the buffer visiting file FILENAME (a string).
1318 This is like `get-file-buffer', except that it checks for any buffer
1319 visiting the same file, possibly under a different name.
1320 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1321 and others are ignored.
1322 If there is no such live buffer, return nil."
1336 found)
1341 number
1346 ;; Verify this buffer's file number
1347 ;; still belongs to its file.
1350 attributes)
1354 found))))
1355 \f
1357 "*Non-nil means file-visiting commands should handle wildcards.
1358 For example, if you specify `*.c', that would visit all the files
1359 whose names match the pattern."
1365 "*Non-nil means suppress warning messages for symlinked files.
1366 When nil, Emacs prints a warning when visiting a file that is already
1367 visited, but with a different name. Setting this option to t
1368 suppresses this warning."
1374 "Maximum size of file above which a confirmation is requested.
1375 When nil, never request confirmation."
1382 "Read file FILENAME into a buffer and return the buffer.
1383 If a buffer exists visiting FILENAME, return that one, but
1384 verify that the file has not changed since visited or saved.
1385 The buffer is not selected, just returned to the caller.
1386 Optional second arg NOWARN non-nil means suppress any warning messages.
1387 Optional third arg RAWFILE non-nil means the file is read literally.
1388 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1389 and visit all the matching files. When wildcards are actually
1390 used and expanded, return a list of buffers that are visiting
1391 the various files."
1398 'find-directory-functions
1401 filename)))
1404 find-file-wildcards
1418 ;; Find any buffer for a file which has same truename.
1420 ;; Let user know if there is a buffer with the same truename.
1424 find-file-suppress-same-file-warnings
1428 ;; Optionally also find that buffer.
1431 ;; Check to see if the file looks uncommonly large.
1433 ;; Don't ask again if we already have the file or
1434 ;; if we're asked to be quiet.
1443 ;; We are using an existing buffer.
1449 ;; Certain files should be reverted automatically
1450 ;; if they have changed on disk and not in the buffer.
1458 found))
1468 "File %s changed on disk. Discard your edits? "
1473 "File %s changed on disk. Discard your edits in %s? "
1481 ;; Check if a formerly read-only file has become
1482 ;; writable and vice versa, but if the buffer agrees
1483 ;; with the new state of the file, that is ok too.
1490 buffer-file-name
1498 ;; It is confusing to ask whether to visit
1499 ;; non-literally if they have the file in
1500 ;; hexl-mode.
1504 "Save file and revisit literally? "
1509 rawfile truename number))
1511 "Discard your edits and revisit file literally? "
1514 rawfile truename number)
1518 "Revisit file literally? "
1521 rawfile truename number)
1524 ;; Return the buffer we are using.
1525 buf)
1526 ;; Create a new buffer.
1528 ;; find-file-noselect-1 may use a different buffer.
1530 rawfile truename number))))))
1536 ;; Needed in case we are re-visiting the file with a different
1537 ;; text representation.
1554 filename)))
1555 ;; Unconditionally set error
1565 filename)))
1566 ;; Run find-file-not-found-hooks until one returns non-nil.
1568 ;; If they fail too, set error.
1570 ;; Record the file's truename, and maybe use that as visited name.
1576 ;; On VMS, we may want to remember which directory in a search list
1577 ;; the file was found in.
1589 ;; Set buffer's default directory to that of the file.
1591 ;; Turn off backup files for certain file names. Since
1592 ;; this is a permanent local, the major mode won't eliminate it.
1606 \f
1608 "Like `insert-file-contents', but only reads in the file literally.
1609 A buffer may be modified in several ways after reading into the buffer,
1610 to Emacs features such as format decoding, character code
1611 conversion, `find-file-hook', automatic uncompression, etc.
1613 This function ensures that none of these modifications will take place."
1621 nil))
1624 inhibit-file-name-handlers))
1637 filename)))
1647 "Insert contents of file FILENAME into buffer after point with no conversion.
1649 This function is meant for the user to run interactively.
1650 Don't call it from programs! Use `insert-file-contents-literally' instead.
1651 \(Its calling sequence is different; see its documentation)."
1656 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1661 "Visit file FILENAME with no conversion of any kind.
1662 Format conversion and character code conversion are both disabled,
1663 and multibyte characters are disabled in the resulting buffer.
1664 The major mode used is Fundamental mode regardless of the file name,
1665 and local variable specifications in the file are ignored.
1666 Automatic uncompression and adding a newline at the end of the
1667 file due to `require-final-newline' is also disabled.
1669 You cannot absolutely rely on this function to result in
1670 visiting the file literally. If Emacs already has a buffer
1671 which is visiting the file, you get the existing buffer,
1672 regardless of whether it was created literally or not.
1674 In a Lisp program, if you want to be sure of accessing a file's
1675 contents literally, you should create a temporary buffer and then read
1676 the file contents into it using `insert-file-contents-literally'."
1679 \f
1683 after-find-file-from-revert-buffer
1684 nomodes)
1685 "Called after finding a file and by the default revert function.
1686 Sets buffer mode, parses local variables.
1687 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1688 error in reading the file. WARN non-nil means warn if there
1689 exists an auto-save file more recent than the visited file.
1690 NOAUTO means don't mess with auto-save mode.
1691 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1692 means this call was from `revert-buffer'.
1693 Fifth arg NOMODES non-nil means don't alter the file's modes.
1694 Finishes by calling the functions in `find-file-hook'
1695 unless NOMODES is non-nil."
1698 nil
1708 ;; No need to warn if buffer is auto-saved
1709 ;; under the name of the visited file.
1711 auto-save-visited-file-name))
1714 buffer-file-name))
1734 ;; Make people do a little extra work (C-x C-q)
1735 ;; before altering a backup file.
1738 ;; When a file is marked read-only,
1739 ;; make the buffer read-only even if root is looking at it.
1747 ;; If requested, add a newline at the end of the file.
1757 view-read-only
1763 "Eval BODY and turn any error into a FORMAT message.
1764 FORMAT can have a %s escape which will be replaced with the actual error.
1765 If `debug-on-error' is set, errors are not caught, so that you can
1766 debug them.
1767 Avoid using a large BODY since it is duplicated."
1776 "Choose the major mode for this buffer automatically.
1777 Also sets up any specified local variables of the file.
1778 Uses the visited file name, the -*- line, and the local variables spec.
1780 This function is called automatically from `find-file'. In that case,
1781 we may set up the file-specified mode and local variables,
1782 depending on the value of `enable-local-variables': if it is t, we do;
1783 if it is nil, we don't; otherwise, we query.
1784 In addition, if `local-enable-local-variables' is nil, we do
1785 not set local variables (though we do notice a mode specified with -*-.)
1787 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1788 or from Lisp without specifying the optional argument FIND-FILE;
1789 in that case, this function acts as if `enable-local-variables' were t."
1797 ;; Turn font lock off and on, to make sure it takes account of
1798 ;; whatever file local variables are relevant to it.
1800 ;; Font-lock-mode (now in font-core.el) can be ON when
1801 ;; font-lock.el still hasn't been loaded.
1811 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1812 ;; c++-mode, java-mode and more) are added through autoload
1813 ;; directives in that file. That way is discouraged since it
1814 ;; spreads out the definition of the initial value.
1845 ;; Less common extensions come here
1846 ;; so more common ones above are found faster.
1885 ;; The list of archive file extensions should be in sync with
1886 ;; `auto-coding-alist' with `no-conversion' coding system.
1890 ;; Mailer puts message to be edited in
1891 ;; /tmp/Re.... or Message
1895 ;; some news reader is reported to use this
1904 ;; .emacs or .gnus or .viper following a directory delimiter in
1905 ;; Unix, MSDOG or VMS syntax.
1908 ;; _emacs following a directory delimiter
1909 ;; in MsDos syntax
1928 ;; Windows candidates may be opened case sensitively on Unix
1934 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1936 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1937 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
1938 ;; either user's dot-files or under /etc or some such
1940 ;; alas not all ~/.*rc files are like this
1941 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1946 ;; this contains everything twice, with space and with colon :-(
1948 ;; Get rid of any trailing .n.m and try again.
1949 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1950 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1951 ;; Using mode nil rather than `ignore' would let the search continue
1952 ;; through this list (with the shortened name) rather than start over.
1954 ;; The following should come after the ChangeLog pattern
1955 ;; for the sake of ChangeLog.1, etc.
1956 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1959 "Alist of filename patterns vs corresponding major mode functions.
1960 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1961 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1962 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1963 mode function to use. FUNCTION will be called, unless it is nil.
1965 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1966 calling FUNCTION (if it's not nil), we delete the suffix that matched
1967 REGEXP and search the list again for another match.
1969 If the file name matches `inhibit-first-line-modes-regexps',
1970 then `auto-mode-alist' is not processed.
1972 The extensions whose FUNCTION is `archive-mode' should also
1973 appear in `auto-coding-alist' with `no-conversion' coding system.
1975 See also `interpreter-mode-alist', which detects executable script modes
1976 based on the interpreters they specify to run,
1980 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1981 ;; and pike-mode) are added through autoload directives in that
1982 ;; file. That way is discouraged since it spreads out the
1983 ;; definition of the initial value.
2021 "Alist mapping interpreter names to major modes.
2022 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2023 Each element looks like (INTERPRETER . MODE).
2024 If INTERPRETER matches the name of the interpreter specified in the first line
2025 of a script, mode MODE is enabled.
2033 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2034 When checking `inhibit-first-line-modes-regexps', we first discard
2040 "Regexp matching interpreters, for file mode determination.
2041 This regular expression is matched against the first line of a file
2042 to determine the file's mode in `set-auto-mode'. If it matches, the file
2043 is assumed to be interpreted by the interpreter matched by the second group
2044 of the regular expression. The mode is then determined as the mode
2049 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2050 ;; We use [ \t\n] instead of `\\s ' to make regex overflow less likely.
2054 comment-re "*"
2057 . html-mode)
2058 ;; These two must come after html, because they are more general:
2063 . sgml-mode)
2066 "Alist of buffer beginnings vs. corresponding major mode functions.
2067 Each element looks like (REGEXP . FUNCTION). After visiting a file,
2068 if REGEXP matches the text at the beginning of the buffer,
2069 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
2070 to decide the buffer's major mode.
2072 If FUNCTION is nil, then it is not called. (That is a way of saying
2079 "Select major mode appropriate for current buffer.
2081 This checks for a -*- mode tag in the buffer's text, checks the
2082 interpreter that runs this file against `interpreter-mode-alist',
2083 compares the buffer beginning against `magic-mode-alist', or
2084 compares the filename against the entries in `auto-mode-alist'.
2086 It does not check for the `mode:' local variable in the
2087 Local Variables section of the file; for that, use `hack-local-variables'.
2089 If `enable-local-variables' is nil, this function does not check for a
2090 -*- mode tag.
2092 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2093 only set the major mode, if that would change it."
2094 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2096 ;; Find a -*- mode tag
2103 ;; Find all specifications for the `mode:' variable
2104 ;; and execute them left to right.
2116 modes)))
2117 ;; Simple -*-MODE-*- case.
2120 modes))))
2121 ;; If we found modes to use, invoke them now, outside the save-excursion.
2129 ;; continuing would call minor modes again, toggling them off
2132 ;; If we didn't, look for an interpreter specified in the first line.
2133 ;; As a special case, allow for things like "#!/bin/env perl", which
2134 ;; finds the interpreter anywhere in $PATH.
2140 ;; Map interpreter name to a mode, signalling we're done at the
2141 ;; same time.
2143 interpreter-mode-alist))
2144 ;; If we found an interpreter mode to use, invoke it now.
2147 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2159 ;; Compare the filename against the entries in auto-mode-alist.
2162 ;; Remove backup-suffixes from file name.
2165 ;; Find first matching alist entry.
2178 ;; When `keep-mode-if-same' is set, we are working on behalf of
2179 ;; set-visited-file-name. In that case, if the major mode specified is the
2180 ;; same one we already have, don't actually reset it. We don't want to lose
2181 ;; minor modes such as Font Lock.
2183 "Apply MODE and return it.
2184 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2185 any aliases and compared to current major mode. If they are the
2186 same, do nothing and return nil."
2194 mode))
2197 "Find the -*- spec in the buffer.
2198 Call with point at the place to start searching from.
2199 If one is found, set point to the beginning
2200 and return the position of the end.
2201 Otherwise, return nil; point may be changed."
2204 ;; Don't look for -*- if this file name matches any
2205 ;; of the regexps in inhibit-first-line-modes-regexps.
2213 sufs)
2221 ;; If the file begins with "#!"
2222 ;; (exec interpreter magic), look
2223 ;; for mode frobs in the first two
2224 ;; lines. You cannot necessarily
2225 ;; put them in the first line of
2226 ;; such a file without screwing up
2227 ;; the interpreter invocation.
2238 end))))
2239 \f
2240 ;;; Handling file local variables
2247 "Normal hook run after processing a file's local variables specs.
2248 Major modes can use this to examine user-specified local variables
2252 "List variable-value pairs that are considered safe.
2253 Each element is a cons cell (VAR . VAL), where VAR is a variable
2254 symbol and VAL is a value that is considered safe."
2259 "*Expressions that are considered safe in an `eval:' local variable.
2260 Add expressions to this list if you want Emacs to evaluate them, when
2261 they appear in an `eval' local variable specification, without first
2262 asking you for confirmation."
2267 ;; Risky local variables:
2270 auto-mode-alist
2271 buffer-auto-save-file-name
2272 buffer-file-name
2273 buffer-file-truename
2274 buffer-undo-list
2275 dabbrev-case-fold-search
2276 dabbrev-case-replace
2277 debugger
2278 default-text-properties
2279 display-time-string
2280 enable-local-eval
2281 eval
2282 exec-directory
2283 exec-path
2284 file-name-handler-alist
2285 font-lock-defaults
2286 format-alist
2287 frame-title-format
2288 global-mode-string
2289 header-line-format
2290 icon-title-format
2291 ignored-local-variables
2292 imenu--index-alist
2293 imenu-generic-expression
2294 inhibit-quit
2295 input-method-alist
2296 load-path
2297 max-lisp-eval-depth
2298 max-specpdl-size
2299 minor-mode-alist
2300 minor-mode-map-alist
2301 minor-mode-overriding-map-alist
2302 mode-line-buffer-identification
2303 mode-line-format
2304 mode-line-modes
2305 mode-line-modified
2306 mode-line-mule-info
2307 mode-line-position
2308 mode-line-process
2309 mode-name
2310 outline-level
2311 overriding-local-map
2312 overriding-terminal-local-map
2313 parse-time-rules
2314 process-environment
2315 rmail-output-file-alist
2316 save-some-buffers-action-alist
2317 special-display-buffer-names
2318 standard-input
2319 standard-output
2320 unread-command-events
2321 vc-mode))
2323 ;; Safe local variables:
2324 ;;
2325 ;; For variables defined by minor modes, put the safety declarations
2326 ;; here, not in the file defining the minor mode (when Emacs visits a
2327 ;; file specifying that local variable, the minor mode file may not be
2328 ;; loaded yet). For variables defined by major modes, the safety
2329 ;; declarations can go into the major mode's file, since that will be
2330 ;; loaded before file variables are processed.
2365 nil
2370 prompt char)
2380 ", and variables that are risky (**)."
2387 y -- to apply the local variables list.
2391 ! -- to apply the local variables list, and mark these values (*) as
2409 ""
2416 done)
2432 ;; When this is called from desktop-restore-file-buffer,
2433 ;; coding-system-for-read may be non-nil. Reset it before
2434 ;; writing to .emacs.
2438 'safe-local-variable-values
2439 safe-local-variable-values))))
2446 "Return local variables specified in the -*- line.
2447 Ignore any specification for `mode:' and `coding:';
2448 `set-auto-mode' should already have handled `mode:',
2449 `set-auto-coding' should already have handled `coding:'.
2451 If MODE-ONLY is non-nil, all we do is check whether the major
2452 mode is specified, returning t if it is specified. Otherwise,
2453 return an alist of elements (VAR . VAL), where VAR is a variable
2454 and VAL is the specified value."
2458 result mode-specified)
2459 ;; Parse the -*- line into the RESULT alist.
2460 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2462 nil)
2464 ;; Simple form: "-*- MODENAME -*-". Already handled.
2466 nil)
2468 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2469 ;; (last ";" is optional).
2474 ;; There used to be a downcase here,
2475 ;; but the manual didn't say so,
2476 ;; and people want to set var names that aren't all lc.
2483 ;; It is traditional to ignore
2484 ;; case when checking for `mode' in set-auto-mode,
2485 ;; so we must do that here as well.
2486 ;; That is inconsistent, but we're stuck with it.
2487 ;; The same can be said for `coding' in set-auto-coding.
2493 'eval
2500 mode-specified
2501 result))))
2504 "Parse and put into effect this buffer's local variables spec.
2505 If MODE-ONLY is non-nil, all we do is check whether the major mode
2506 is specified, returning t if it is specified."
2509 result)
2512 ;; Look for "Local variables:" line in last page.
2520 ;; suffix is what comes after "local variables:" in its line.
2521 ;; prefix is what comes before "local variables:" in its line.
2531 beg)
2535 endpos
2541 nil t))
2551 ;; Discard the prefix.
2556 ;; Discard the suffix.
2564 ;; Find the variable name; strip whitespace.
2572 val)
2573 ;; Read the variable value.
2583 'eval
2589 ;; We've read all the local variables. Now, return whether the
2590 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2591 ;; variables (if MODE-ONLY is nil.)
2593 result
2600 ;; Find those variables that we may want to save to
2601 ;; `safe-local-variable-values'.
2619 result unsafe-vars risky-vars))
2625 "Non-nil if SYM is safe as a file-local variable with value VAL.
2626 It is safe if any of these conditions are met:
2628 * There is a matching entry (SYM . VAL) in the
2629 `safe-local-variable-values' user option.
2631 * The `safe-local-variable' property of SYM is t.
2633 * The `safe-local-variable' property of SYM is a function that
2634 evaluates to a non-nil value with VAL as an argument."
2642 "Non-nil if SYM could be dangerous as a file-local variable.
2643 It is dangerous if either of these conditions are met:
2645 * Its `risky-local-variable' property is non-nil.
2651 ;; If this is an alias, check the base name.
2671 "Return t if it is safe to eval EXP when it is found in a file."
2673 ;; Detect certain `put' expressions.
2679 ;; Only allow safe values of lisp-indent-hook;
2680 ;; not functions.
2683 ;; Allow expressions that the user requested.
2685 ;; Certain functions can be allowed with safe arguments
2686 ;; or can specify verification functions to try.
2694 ok))
2702 ok)))))))
2705 "Set local variable VAR with value VAL."
2712 ;; Make sure the string has no text properties.
2713 ;; Some text properties can get evaluated in various ways,
2714 ;; so it is risky to put them on with a local variable list.
2719 \f
2722 However, the mode will not be changed if
2723 \(1) a local variables list or the `-*-' line specifies a major mode, or
2725 \ not suitable for ordinary files, or
2726 \(3) the new file name does not particularly specify any mode."
2731 "Change name of file visited in current buffer to FILENAME.
2732 This also renames the buffer to correspond to the new file.
2733 The next time the buffer is saved it will go in the newly specified file.
2734 FILENAME nil or an empty string means mark buffer as not visiting any file.
2735 Remember to delete the initial contents of the minibuffer
2736 if you wish to pass an empty string as the argument.
2738 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2739 confirmation in the case where another buffer is already visiting FILENAME.
2741 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2742 the old visited file has been renamed to the new name FILENAME."
2750 nil
2765 filename)))
2777 ;; If new-name == old-name, renaming would add a spurious <2>
2778 ;; and it's considered as a feature in rename-buffer.
2784 ;; Abbreviate the file names of the buffer.
2793 nil)))
2794 ;; write-file-functions is normally used for things like ftp-find-file
2795 ;; that visit things that are not local files as if they were files.
2796 ;; Changing to visit an ordinary local file instead should flush the hook.
2801 ;; If buffer was read-only because of version control,
2802 ;; that reason is gone now, so make it writable.
2806 ;; Turn off backup files for certain file names.
2807 ;; Since this is a permanent local, the major mode won't eliminate it.
2814 ;; If auto-save was not already on, turn it on if appropriate.
2818 ;; If auto save is on, start using a new name.
2819 ;; We deliberately don't rename or delete the old auto save
2820 ;; for the old visited file name. This is because perhaps
2821 ;; the user wants to save the new state and then compare with the
2822 ;; previous state from the auto save file.
2825 ;; Rename the old auto save file if any.
2832 ;; Update the major mode, if the file name determines it.
2834 ;; Don't change the mode if it is special.
2837 ;; Don't change the mode if the local variable list specifies it.
2843 "Write current buffer into file FILENAME.
2844 This makes the buffer visit that file, and marks it as not modified.
2846 If you specify just a directory name as FILENAME, that means to use
2847 the default file name but in that directory. You can also yank
2848 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2850 If the buffer is not already visiting a file, the default file name
2851 for the output file is the buffer name.
2853 If optional second arg CONFIRM is non-nil, this function
2854 asks for confirmation before overwriting an existing file.
2855 Interactively, confirmation is required unless you supply a prefix argument."
2856 ;; (interactive "FWrite file: ")
2860 nil nil nil nil)
2864 default-directory)
2865 nil nil))
2869 ;; If arg is just a directory,
2870 ;; use the default file name, but in that directory.
2881 ;; Make buffer writable if file is writable.
2886 ;; It's likely that the VC status at the new location is different from
2887 ;; the one at the old location.
2889 \f
2891 "Make a backup of the disk file visited by the current buffer, if appropriate.
2892 This is normally done before saving the buffer the first time.
2894 A backup may be done by renaming or by copying; see documentation of
2895 variable `make-backup-files'. If it's done by renaming, then the file is
2896 no longer accessible under its old name.
2898 The value is non-nil after a backup was made by renaming.
2899 It has the form (MODES . BACKUPNAME).
2900 MODES is the result of `file-modes' on the original
2901 file; this means that the caller, after saving the buffer, should change
2902 the modes of the new file to agree with the old modes.
2903 BACKUPNAME is the backup file name, which is the old file renamed."
2910 backup-info backupname targets setmodes)
2911 ;; If specified name is a symbolic link, chase it to the target.
2912 ;; Thus we make the backups in the directory where the real file is.
2917 ;; (if (file-directory-p buffer-file-name)
2918 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2922 ;; If have old versions to maybe delete,
2923 ;; ask the user to confirm now, before doing anything.
2924 ;; But don't actually delete til later.
2929 real-file-name)))))
2931 ;; Actually write the back up file.
2934 ; (file-symlink-p buffer-file-name)
2935 backup-by-copying
2936 ;; Don't rename a suid or sgid file.
2951 ;; rename-file should delete old backup.
2955 ;; If trouble writing the backup, write it in ~.
2964 ;; Now delete the old versions, if desired.
2971 setmodes)
2978 ;; Create temp files with strict access rights. It's easy to
2979 ;; loosen them later, whereas it's impossible to close the
2980 ;; time-window of loose permissions otherwise.
2988 nil)
2990 ;; The file was somehow created by someone else between
2991 ;; `delete-file' and `copy-file', so let's try again.
2992 nil))
2993 ;; Reset the umask.
2999 "Return file NAME sans backup versions or strings.
3000 This is a separate procedure so your site-init or startup file can
3001 redefine it.
3002 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3003 we do not remove backup version numbers, only true file version numbers."
3009 ;; VMS version number is (a) semicolon, optional
3010 ;; sign, zero or more digits or (b) period, option
3011 ;; sign, zero or more digits, provided this is the
3012 ;; second period encountered outside of the
3013 ;; device/directory part of the file name.
3016 name)
3026 "Return t if deleting FILE and rewriting it would preserve the owner."
3031 ;; Return t if the file doesn't exist, since it's true that no
3032 ;; information would be lost by an (attempted) delete and create.
3038 The extension, in a file name, is the part that follows the last `.',
3039 except that a leading `.', if any, doesn't count."
3042 directory)
3046 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3047 ;; we don't want to expand it.
3050 filename))))
3054 The extension, in a file name, is the part that follows the last `.',
3055 except that a leading `.', if any, doesn't count.
3056 Return nil for extensionless file names such as `foo'.
3057 Return the empty string for file names such as `foo.'.
3059 If PERIOD is non-nil, then the returned value includes the period
3060 that delimits the extension, and if FILENAME has no extension,
3071 "A function to use instead of the default `make-backup-file-name'.
3072 A value of nil gives the default `make-backup-file-name' behavior.
3074 This could be buffer-local to do something special for specific
3075 files. If you define it, you may need to change `backup-file-name-p'
3076 and `file-name-sans-versions' too.
3078 See also `backup-directory-alist'."
3084 "Alist of filename patterns and backup directory names.
3085 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3086 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3087 relative or absolute. If it is absolute, so that all matching files
3088 are backed up into the same directory, the file names in this
3089 directory will be the full name of the file backed up with all
3090 directory separators changed to `!' to prevent clashes. This will not
3091 work correctly if your filesystem truncates the resulting name.
3093 For the common case of all backups going into one directory, the alist
3095 directory name.
3097 If this variable is nil, or it fails to match a filename, the backup
3098 is made in the original file's directory.
3100 On MS-DOS filesystems without long names this variable is always
3101 ignored."
3107 "Default `backup-enable-predicate' function.
3108 Checks for files in `temporary-file-directory',
3109 `small-temporary-file-directory', and /tmp."
3112 ;; Directory is under temporary-file-directory.
3117 ;; Directory is under /tmp.
3122 0 nil
3124 ;; Directory is under small-temporary-file-directory.
3129 "Create the non-numeric backup file name for FILE.
3130 Normally this will just be the file's name with `~' appended.
3131 Customization hooks are provided as follows.
3133 If the variable `make-backup-file-name-function' is non-nil, its value
3134 should be a function which will be called with FILE as its argument;
3135 the resulting name is used.
3137 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3138 the documentation of that variable. If the directory for the backup
3139 doesn't exist, it is created."
3153 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3155 elt backup-directory)
3160 alist nil)))
3166 file
3170 ;; Normalize DOSish file names: downcase the drive
3171 ;; letter, if any, and replace the leading "x:" with
3172 ;; "/drive_x".
3175 ;; Replace any invalid file-name characters (for the
3176 ;; case of backing up remote files).
3180 "drive_"
3183 ""
3186 ;; Make the name unique by substituting directory
3187 ;; separators. It may not really be worth bothering about
3188 ;; doubling `!'s in the original name...
3193 backup-directory))
3200 "Return non-nil if FILE is a backup file name (numeric or not).
3201 This is a separate function so you can redefine it for customization.
3202 You may need to redefine `file-name-sans-versions' as well."
3207 ;; This is used in various files.
3208 ;; The usage of backup-extract-version-start is not very clean,
3209 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3211 "Given the name of a numeric backup file, FN, return the backup number.
3212 Uses the free variable `backup-extract-version-start', whose value should be
3213 the index in the name where the version number begins."
3219 ;; I believe there is no need to alter this behavior for VMS;
3220 ;; since backup files are not made on VMS, it should not get called.
3222 "Find a file name for a backup file FN, and suggestions for deletions.
3223 Value is a list whose car is the name for the backup file
3224 and whose cdr is a list of old versions to consider deleting now.
3225 If the value is nil, don't make a backup.
3226 Uses `backup-directory-alist' in the same way as does
3227 `make-backup-file-name'."
3229 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3233 ;; We don't support numbered backups on plain MS-DOS
3234 ;; when long file names are unavailable.
3244 possibilities deserve-versions-p versions)
3247 base-versions
3250 possibilities)
3251 #'<)
3256 kept-old-versions
3257 kept-new-versions
3264 ;; Delete nothing if there is overflow
3265 ;; in the number of versions to keep.
3271 v))))))))))
3274 "Return number of names file FILENAME has."
3277 ;; (defun file-relative-name (filename &optional directory)
3278 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3279 ;; This function returns a relative file name which is equivalent to FILENAME
3280 ;; when used with that default directory as the default.
3281 ;; If this is impossible (which can happen on MSDOS and Windows
3282 ;; when the file name and directory use different drive names)
3283 ;; then it returns FILENAME."
3284 ;; (save-match-data
3285 ;; (let ((fname (expand-file-name filename)))
3286 ;; (setq directory (file-name-as-directory
3287 ;; (expand-file-name (or directory default-directory))))
3288 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3289 ;; ;; drive names, they can't be relative, so return the absolute name.
3290 ;; (if (and (or (eq system-type 'ms-dos)
3291 ;; (eq system-type 'cygwin)
3292 ;; (eq system-type 'windows-nt))
3293 ;; (not (string-equal (substring fname 0 2)
3294 ;; (substring directory 0 2))))
3295 ;; filename
3296 ;; (let ((ancestor ".")
3297 ;; (fname-dir (file-name-as-directory fname)))
3298 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3299 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3300 ;; (setq directory (file-name-directory (substring directory 0 -1))
3301 ;; ancestor (if (equal ancestor ".")
3302 ;; ".."
3303 ;; (concat "../" ancestor))))
3304 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3305 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3306 ;; ;; We matched within FNAME's directory part.
3307 ;; ;; Add the rest of FNAME onto ANCESTOR.
3308 ;; (let ((rest (substring fname (match-end 0))))
3309 ;; (if (and (equal ancestor ".")
3310 ;; (not (equal rest "")))
3311 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3312 ;; rest
3313 ;; (concat (file-name-as-directory ancestor) rest)))
3314 ;; ;; We matched FNAME's directory equivalent.
3315 ;; ancestor))))))
3318 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3319 This function returns a relative file name which is equivalent to FILENAME
3320 when used with that default directory as the default.
3321 If FILENAME and DIRECTORY lie on different machines or on different drives
3322 on a DOS/Windows machine, it returns FILENAME in expanded form."
3326 default-directory))))
3332 ;; Test for different drives on DOS/Windows
3334 ;; Should `cygwin' really be included here? --stef
3337 ;; Test for different remote file system identification
3339 filename
3345 directory nil nil case-fold-search))
3347 directory nil nil case-fold-search))))
3350 ".."
3352 ;; Now ancestor is empty, or .., or ../.., etc.
3354 directory nil nil case-fold-search))
3355 ;; We matched within FILENAME's directory part.
3356 ;; Add the rest of FILENAME onto ANCESTOR.
3359 ;; But don't bother with ANCESTOR if it would give us `./'.
3360 rest
3362 ;; We matched FILENAME's directory equivalent.
3363 ancestor))))))
3364 \f
3366 "Save current buffer in visited file if modified.
3367 Variations are described below.
3369 By default, makes the previous version into a backup file
3370 if previously requested or if this is the first save.
3372 to become a backup when the next save is done.
3374 unconditionally makes the previous version into a backup file.
3376 to become a backup when the next save is done,
3377 and unconditionally makes the previous version into a backup file.
3379 With a numeric argument of 0, never make the previous version
3380 into a backup file.
3382 If a file's name is FOO, the names of its numbered backup versions are
3383 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3384 Numeric backups (rather than FOO~) will be made if value of
3385 `version-control' is not the atom `never' and either there are already
3386 numeric versions of the file being backed up, or `version-control' is
3387 non-nil.
3388 We don't want excessive versions piling up, so there are variables
3389 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3390 and `kept-new-versions', which tells how many newest versions to keep.
3391 Defaults are 2 old versions and 2 new.
3392 `dired-kept-versions' controls dired's clean-directory (.) command.
3393 If `delete-old-versions' is nil, system will query user
3394 before trimming versions. Otherwise it does it silently.
3396 If `vc-make-backup-files' is nil, which is the default,
3397 no backup files are made for files managed by version control.
3398 (This is because the version control system itself records previous versions.)
3400 See the subroutine `basic-save-buffer' for more information."
3413 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3414 Normally delete only if the file was written by this Emacs since
3415 the last real save, but optional arg FORCE non-nil means delete anyway."
3429 "Normal hook that is run before a buffer is saved to its file."
3435 "Normal hook that is run after a buffer is saved to its file."
3441 "If non-nil, use this coding system for saving the buffer.
3442 More precisely, use this coding system in place of the
3443 value of `buffer-file-coding-system', when saving the buffer.
3444 Calling `write-region' for any purpose other than saving the buffer
3445 will still use `buffer-file-coding-system'; this variable has no effect
3452 "Save the current buffer in its visited file, if it has been modified.
3453 The hooks `write-contents-functions' and `write-file-functions' get a chance
3454 to do the job of saving; if they do not, then the buffer is saved in
3455 the visited file in the usual way.
3456 Before and after saving the buffer, this function runs
3457 `before-save-hook' and `after-save-hook', respectively."
3460 ;; In an indirect buffer, save its base buffer instead.
3465 setmodes)
3466 ;; On VMS, rename file and buffer to get rid of version number.
3471 ;; Strip VMS version number before save.
3474 ;; Construct a (unique) buffer name to correspond.
3479 ;; If buffer has no file name, ask user for one.
3486 filename))
3512 ;; Support VC version backups.
3518 ;; If a hook returned t, file is already "written".
3519 ;; Otherwise, write it the usual way now.
3521 ;; Now we have saved the current buffer. Let's make sure
3522 ;; that buffer-file-coding-system is fixed to what
3523 ;; actually used for saving by binding it locally.
3533 ;; If the auto-save file was recent before this command,
3534 ;; delete it now.
3536 ;; Support VC `implicit' locking.
3541 ;; This does the "real job" of writing a buffer into its visited file
3542 ;; and making a backup file. This is what is normally done
3543 ;; but inhibited if one of write-file-functions returns non-nil.
3544 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3553 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3567 buffer-file-name)))
3575 ;; If file is precious, write temp name, then rename it.
3576 ;; This requires write access to the containing dir,
3577 ;; which is why we don't try it if we don't have that access.
3579 tempname succeed
3582 ;; Create temp files with strict access rights. It's easy to
3583 ;; loosen them later, whereas it's impossible to close the
3584 ;; time-window of loose permissions otherwise.
3589 ;; Try various temporary names.
3590 ;; This code follows the example of make-temp-file,
3591 ;; but it calls write-region in the appropriate way
3592 ;; for saving the buffer.
3599 tempname nil realname
3601 nil)
3603 ;; The file was somehow created by someone else between
3604 ;; `make-temp-name' and `write-region', let's try again.
3605 nil)
3607 ;; Reset the umask.
3609 ;; If we failed, restore the buffer's modtime.
3612 ;; Since we have created an entirely new file,
3613 ;; make sure it gets the right permission bits set.
3615 buffer-file-name)))
3616 ;; We succeeded in writing the temp file,
3617 ;; so rename it.
3619 ;; If file not writable, see if we can make it writable
3620 ;; temporarily while we write it.
3621 ;; But no need to do so if we have just backed it up
3622 ;; (setmodes is set) because that says we're superseding.
3624 ;; Change the mode back, after writing.
3631 buffer-file-name nil t buffer-file-truename)
3633 ;; If we get an error writing the new file, and we made
3634 ;; the backup by renaming, undo the backing-up.
3639 setmodes))
3642 "View the differences between BUFFER and its associated file.
3643 This requires the external program `diff' to be in your `exec-path'."
3658 ;; Display that message for 1 second so that user can read it
3659 ;; in the minibuffer.
3661 ;; return always nil, so that save-buffers-kill-emacs will not move
3662 ;; over to the next unsaved buffer when calling `d'.
3663 nil)
3666 '((?\C-r
3672 ;; Return nil to ask about BUF again.
3673 nil)
3675 (?d diff-buffer-with-file
3684 "Save some modified file-visiting buffers. Asks user about each one.
3685 You can answer `y' to save, `n' not to save, `C-r' to look at the
3686 buffer in question with `view-buffer' before deciding or `d' to
3687 view the differences using `diff-buffer-with-file'.
3689 Optional argument (the prefix) non-nil means save all with no questions.
3690 Optional second argument PRED determines which buffers are considered:
3691 If PRED is nil, all the file-visiting buffers are considered.
3692 If PRED is t, then certain non-file buffers will also be considered.
3693 If PRED is a zero-argument function, it indicates for each buffer whether
3694 to consider it or not when called with that buffer current.
3696 See `save-some-buffers-action-alist' if you want to
3697 change the additional actions you can take on files."
3701 files-done abbrevs-done)
3703 ;; First save any buffers that we're supposed to save unconditionally.
3704 ;; That way the following code won't ask about them.
3709 ;; Ask about those buffers that merit it,
3710 ;; and record the number thus saved.
3726 t
3739 save-some-buffers-action-alist))
3740 ;; Maybe to save abbrevs, and record whether
3741 ;; we either saved them or asked to.
3747 abbrev-file-name)))
3749 ;; Don't keep bothering user if he says no.
3754 "(Some special files were saved without asking)"
3756 \f
3758 "Mark current buffer as unmodified, not needing to be saved.
3761 It is not a good idea to use this function in Lisp programs, because it
3762 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3769 "Change whether this buffer is visiting its file read-only.
3770 With arg, set read-only iff arg is positive.
3771 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3776 nil ; do nothing.
3777 ;; Toggle.
3784 ;; If view-mode is already active, `view-mode-enter' is a nop.
3796 "Insert contents of file FILENAME into buffer after point.
3797 Set mark after the inserted text.
3799 This function is meant for the user to run interactively.
3800 Don't call it from programs! Use `insert-file-contents' instead.
3801 \(Its calling sequence is different; see its documentation)."
3806 "Append the contents of the region to the end of file FILENAME.
3807 When called from a function, expects three arguments,
3808 START, END and FILENAME. START and END are buffer positions
3809 saying what text to write."
3814 "Return most recent backup file for FILENAME or nil if no backups exist."
3815 ;; `make-backup-file-name' will get us the right directory for
3816 ;; ordinary or numeric backups. It might create a directory for
3817 ;; backups as a side-effect, according to `backup-directory-alist'.
3824 tem)
3833 newest))
3836 "Rename current buffer to a similar name not already taken.
3837 This function is useful for creating multiple shell process buffers
3838 or multiple mail buffers, etc."
3846 ;; If the existing buffer name has a <NNN>,
3847 ;; which isn't part of the file name (if any),
3848 ;; then get rid of that.
3854 "Create the directory DIR and any nonexistent parent dirs.
3855 Interactively, the default choice of directory to create
3856 is the current default directory for file names.
3857 That is useful when you have visited a file in a nonexistent directory.
3859 Noninteractively, the second (optional) argument PARENTS says whether
3860 to create parent directories if they don't exist. Interactively,
3861 this happens by default."
3864 nil nil)
3865 t))
3866 ;; If default-directory is a remote directory,
3867 ;; make sure we find its make-directory handler.
3875 create-list)
3882 \f
3885 "Function to use to revert this buffer, or nil to do the default.
3886 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3891 "Function to use to insert contents when reverting this buffer.
3892 Gets two args, first the nominal file name to use,
3893 and second, t if reading the auto-save file.
3898 "Function to check whether a non-file buffer needs reverting.
3899 This should be a function with one optional argument NOCONFIRM.
3900 Auto Revert Mode passes t for NOCONFIRM. The function should return
3901 non-nil if the buffer should be reverted. A return value of
3902 `fast' means that the need for reverting was not checked, but
3903 that reverting the buffer is fast. The buffer is current when
3904 this function is called.
3906 The idea behind the NOCONFIRM argument is that it should be
3907 non-nil if the buffer is going to be reverted without asking the
3908 user. In such situations, one has to be careful with potentially
3909 time consuming operations.
3911 For more information on how this variable is used by Auto Revert mode,
3915 "Normal hook for `revert-buffer' to run before reverting.
3916 If `revert-buffer-function' is used to override the normal revert
3920 "Normal hook for `revert-buffer' to run after reverting.
3921 Note that the hook value that it runs is the value that was in effect
3922 before reverting; that makes a difference if you have buffer-local
3923 hook functions.
3925 If `revert-buffer-function' is used to override the normal revert
3931 "Replace current buffer text with the text of the visited file on disk.
3932 This undoes all changes since the file was visited or saved.
3933 With a prefix argument, offer to revert from latest auto-save file, if
3934 that is more recent than the visited file.
3936 This command also works for special buffers that contain text which
3937 doesn't come from a file, but reflects some other data base instead:
3938 for example, Dired buffers and `buffer-list' buffers. In these cases,
3939 it reconstructs the buffer contents from the appropriate data base.
3941 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3942 to revert from the auto-save file when this is nil. Note that the
3943 sense of this argument is the reverse of the prefix argument, for the
3944 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3945 to nil.
3947 Optional second argument NOCONFIRM means don't ask for confirmation at
3948 all. \(The variable `revert-without-query' offers another way to
3949 revert buffers without querying for confirmation.)
3951 Optional third argument PRESERVE-MODES non-nil means don't alter
3952 the files modes. Normally we reinitialize them using `normal-mode'.
3954 If the value of `revert-buffer-function' is non-nil, it is called to
3955 do all the work for this command. Otherwise, the hooks
3956 `before-revert-hook' and `after-revert-hook' are run at the beginning
3957 and the end, and if `revert-buffer-insert-file-contents-function' is
3958 non-nil, it is called instead of rereading visited file contents."
3960 ;; I admit it's odd to reverse the sense of the prefix argument, but
3961 ;; there is a lot of code out there which assumes that the first
3962 ;; argument should be t to avoid consulting the auto-save file, and
3963 ;; there's no straightforward way to encourage authors to notice a
3964 ;; reversal of the argument sense. So I'm just changing the user
3965 ;; interface, but leaving the programmatic interface the same.
3973 buffer-auto-save-file-name
3978 buffer-auto-save-file-name
3979 buffer-file-name)))
3989 file-name)))
3991 ;; If file was backed up but has changed since,
3992 ;; we shd make another backup.
3996 ;; Effectively copy the after-revert-hook status,
3997 ;; since after-find-file will clobber it.
4000 after-revert-hook))
4005 ;; Get rid of all undo records for this buffer.
4007 ;; Don't make undo records for the reversion.
4010 file-name auto-save-p)))
4013 "File %s no longer exists!"
4015 file-name))
4017 ;; Bind buffer-file-name to nil
4018 ;; so that we don't try to lock the file.
4024 ;; Auto-saved file should be read by Emacs'
4025 ;; internal coding.
4028 buffer-file-coding-system-explicit))))
4029 ;; This force after-insert-file-set-coding
4030 ;; (called from insert-file-contents) to set
4031 ;; buffer-file-coding-system to a proper value.
4034 ;; Note that this preserves point in an intelligent way.
4038 nil nil t))
4040 nil nil t)))))
4041 ;; Recompute the truename in case changes in symlinks
4042 ;; have changed the truename.
4046 ;; Run after-revert-hook as it was before we reverted.
4050 local-hook)
4053 t))))))
4056 "Recover the visited file--get contents from its last auto-save file."
4061 "Visit file FILE, but get contents from its last auto-save file."
4062 ;; Actually putting the file name in the minibuffer should be used
4063 ;; only rarely.
4064 ;; Not just because users often use the default.
4084 ;; Use insert-directory-safely, not insert-directory,
4085 ;; because these files might not exist. In particular,
4086 ;; FILE might not exist if the auto-save file was for
4087 ;; a buffer that didn't visit a file, such as "*mail*".
4088 ;; The code in v20.x called `ls' directly, so we need
4089 ;; to emulate what `ls' did in that case.
4095 ;; Keep the current buffer-file-coding-system.
4097 ;; Auto-saved file shoule be read with special coding.
4106 "Recover auto save files from a previous Emacs session.
4107 This command first displays a Dired buffer showing you the
4108 previous sessions that you could recover from.
4109 To choose one, move point to the proper line and then type C-c C-c.
4110 Then you'll be asked about a number of files to recover."
4120 auto-save-list-file-prefix)))
4121 t)
4130 ;; Each line starts with a space
4131 ;; so that Font Lock mode won't highlight the first character.
4140 "Choose one saved session to recover auto-save files from.
4141 This command is used in the special Dired buffer created by
4144 ;; Get the name of the session file to recover from.
4146 files
4152 ;; Read in the auto-save-list file.
4156 ;; Loop thru the text of that file
4157 ;; and get out the names of the files to recover.
4161 ;; This is a pair of lines for a non-file-visiting buffer.
4162 ;; Get the auto-save file name and manufacture
4163 ;; a "visited file name" from that.
4166 ;; If there is no auto-save file name, the
4167 ;; auto-save-list file is probably corrupted.
4182 ;; This pair of lines is a file-visiting
4183 ;; buffer. Use the visited file name.
4193 ;; Ignore a file if its auto-save file does not exist now.
4197 ;; The file contains a pair of line for each auto-saved buffer.
4198 ;; The first line of the pair contains the visited file name
4199 ;; or is empty if the buffer was not visiting a file.
4200 ;; The second line is the auto-save file name.
4208 files
4214 "Kill some buffers. Asks the user whether to kill each one of them.
4215 Non-interactively, if optional argument LIST is non-nil, it
4216 specifies the list of buffers to kill, asking for approval for each one."
4224 ; if we killed the base buffer.
4229 name
4234 \f
4236 "Toggle auto-saving of contents of current buffer.
4237 With prefix argument ARG, turn auto-saving on if positive, else off."
4242 ;; If auto-save is off because buffer has shrunk,
4243 ;; then toggling should turn it on.
4248 buffer-file-name
4250 ;; If -1 was stored here, to temporarily turn off saving,
4251 ;; turn it back on.
4257 buffer-auto-save-file-name)
4260 "Adjust current buffer's auto save file name for current conditions.
4261 Also rename any existing auto save file, if it was made in this session."
4273 "Return file name to use for auto-saves of current buffer.
4274 Does not consider `auto-save-visited-file-name' as that variable is checked
4275 before calling this function. You can redefine this for customization.
4276 See also `auto-save-file-name-p'."
4284 result uniq)
4285 ;; Apply user-specified translations
4286 ;; to the file name.
4290 filename)
4300 filename))))
4305 ;; We truncate the file name to DOS 8+3 limits
4306 ;; before doing anything else, because the regexp
4307 ;; passed to string-match below cannot handle
4308 ;; extensions longer than 3 characters, multiple
4309 ;; dots, and other atrocities.
4314 fn)
4319 "#"
4322 ;; Make sure auto-save file names don't contain characters
4323 ;; invalid for the underlying filesystem.
4325 ;; Don't modify remote (ange-ftp) filenames
4328 result))))
4330 ;; Deal with buffers that don't have any associated files. (Mail
4331 ;; mode tends to create a good number of these.)
4335 file-name)
4336 ;; Eliminate all slashes and backslashes by
4337 ;; replacing them with sequences that start with %.
4338 ;; Quote % also, to keep distinct names distinct.
4347 ;; Generate the file name.
4353 ;; Try a few alternative directories, to get one we can
4354 ;; write it.
4360 ;; Don't modify remote (ange-ftp) filenames
4362 ;; The call to convert-standard-filename is in case
4363 ;; buffer-name includes characters not allowed by the
4364 ;; DOS/Windows filesystems. make-temp-file writes to the
4365 ;; file it creates, so we must fix the file name _before_
4366 ;; make-temp-file is called.
4368 fname))
4370 ;; make-temp-file creates the file,
4371 ;; but we don't want it to exist until we do an auto-save.
4375 file-name)))
4378 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4379 FILENAME should lack slashes. You can redefine this for customization."
4381 \f
4383 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4384 The generated regexp will match a filename iff the filename
4385 matches that wildcard according to shell rules. Only wildcards known
4386 by `sh' are supported."
4388 ;; Copy the initial run of non-special characters.
4391 ;; If no special characters, we're almost done.
4395 j)
4397 result
4418 ;; Found "[^". Insert a `\0' character
4419 ;; (which cannot happen in a filename)
4420 ;; into the character class, so that `^'
4421 ;; is not the first character after `[',
4422 ;; and thus non-special in a regexp.
4427 ;; I don't think `]' can appear in a
4428 ;; character class in a wildcard, but
4429 ;; let's be general here.
4436 i
4449 ;; Shell wildcards should match the entire filename,
4450 ;; not its part. Make the regexp say so.
4452 \f
4455 "*Switches for `list-directory' to pass to `ls' for brief listing."
4461 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4463 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4468 "Expand wildcard pattern PATTERN.
4469 This returns a list of file names which match the pattern.
4471 If PATTERN is written as an absolute file name,
4472 the values are absolute also.
4474 If PATTERN is written as a relative file name, it is interpreted
4475 relative to the current default directory, `default-directory'.
4476 The file names returned are normally also relative to the current
4477 default directory. However, if FULL is non-nil, they are absolute."
4481 ;; A list of all dirs that DIRPART specifies.
4482 ;; This can be more than one dir
4483 ;; if DIRPART contains wildcards.
4488 contents)
4493 ;; Filter out "." and ".."
4498 name))
4505 this-dir-contents)
4506 this-dir-contents)
4507 contents))))
4509 contents)))
4512 "Display a list of files in or matching DIRNAME, a la `ls'.
4513 DIRNAME is globbed by the shell if necessary.
4514 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4515 Actions controlled by variables `list-directory-brief-switches'
4516 and `list-directory-verbose-switches'."
4520 nil default-directory nil)
4521 pfx)))
4523 list-directory-brief-switches))
4524 buffer)
4537 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4545 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4547 PATTERN is assumed to represent a file-name wildcard suitable for the
4548 underlying filesystem. For Unix and GNU/Linux, the characters from the
4550 the parts of the pattern which don't include wildcard characters are
4551 quoted with double quotes.
4552 Existing quote characters in PATTERN are left alone, so you can pass
4553 PATTERN that already quotes some of the special characters."
4557 ;; DOS/Windows don't allow `"' in file names. So if the
4558 ;; argument has quotes, we can safely assume it is already
4559 ;; quoted by the caller.
4561 ;; We quote [&()#$'] in case their shell is a port of a
4562 ;; Unixy shell. We quote [,=+] because stock DOS and
4563 ;; Windows shells require that in some cases, such as
4564 ;; passing arguments to batch files that use positional
4565 ;; arguments like %1.
4567 pattern
4570 end)
4587 pattern))))
4594 "*Program to get the amount of free space on a file system.
4595 We assume the output has the format of `df'.
4596 The value of this variable must be just a command name or file name;
4597 if you want to specify options, use `directory-free-space-args'.
4599 A value of nil disables this feature.
4601 If the function `file-system-info' is defined, it is always used in
4602 preference to the program given by this variable."
4608 "*Options to use when running `directory-free-space-program'."
4613 "Return the amount of free space on directory DIR's file system.
4614 The result is a string that gives the number of free 1KB blocks,
4615 or nil if the system call or the program which retrieve the information
4616 fail.
4618 This function calls `file-system-info' if it is available, or invokes the
4619 program specified by `directory-free-space-program' if that is non-nil."
4620 ;; Try to find the number of free blocks. Non-Posix systems don't
4621 ;; always have df, but might have an equivalent system call.
4630 nil t nil
4631 directory-free-space-args
4632 dir)))
4633 ;; Usual format is a header line followed by a line of
4634 ;; numbers.
4639 ;; Move to the end of the "available blocks" number.
4642 ;; Copy it into AVAILABLE.
4647 ;; The following expression replaces `dired-move-to-filename-regexp'.
4651 ;; In some locales, month abbreviations are as short as 2 letters,
4652 ;; and they can be followed by ".".
4653 ;; In Breton, a month name can include a quote character.
4666 s "+"
4669 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4670 ;; omits the Kanji characters after month and day-of-month.
4671 ;; On Mac OS X 10.3, the date format in East Asian locales is
4672 ;; day-of-month digits followed by month digits.
4678 ;; The "[0-9]" below requires the previous column to end in a digit.
4679 ;; This avoids recognizing `1 may 1997' as a date in the line:
4680 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4682 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4683 ;; The ".*" below finds the last match if there are multiple matches.
4684 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4685 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4687 ;; vc dired listings provide the state or blanks between file
4688 ;; permissions and date. The state is always surrounded by
4689 ;; parantheses:
4690 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4691 ;; This is not supported yet.
4695 "Regular expression to match up to the file name in a directory listing.
4696 The default value is designed to recognize dates and times
4701 ;; insert-directory
4702 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4703 ;; FULL-DIRECTORY-P is nil.
4704 ;; The single line of output must display FILE's name as it was
4705 ;; given, namely, an absolute path name.
4706 ;; - must insert exactly one line for each file if WILDCARD or
4707 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4708 ;; before the file lines, plus optional text after the file lines.
4709 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4710 ;; allowed.
4711 ;; File lines should display the basename.
4712 ;; - must be consistent with
4713 ;; - functions dired-move-to-filename, (these two define what a file line is)
4714 ;; dired-move-to-end-of-filename,
4715 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4716 ;; dired-insert-headerline
4717 ;; dired-after-subdir-garbage (defines what a "total" line is)
4718 ;; - variable dired-subdir-regexp
4719 ;; - may be passed "--dired" as the first argument in SWITCHES.
4720 ;; Filename handlers might have to remove this switch if their
4721 ;; "ls" command does not support it.
4723 "Insert directory listing for FILE, formatted according to SWITCHES.
4724 Leaves point after the inserted text.
4725 SWITCHES may be a string of options, or a list of strings
4726 representing individual options.
4727 Optional third arg WILDCARD means treat FILE as shell wildcard.
4728 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4729 switches do not contain `d', so that a full listing is expected.
4731 This works by running a directory listing program
4732 whose name is in the variable `insert-directory-program'.
4733 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4735 When SWITCHES contains the long `--dired' option, this function
4736 treats it specially, for the sake of dired. However, the
4737 normally equivalent short `-D' option is just passed on to
4738 `insert-directory-program', as any other option."
4739 ;; We need the directory in order to find the right handler.
4744 wildcard full-directory-p)
4749 ;; Read the actual directory using `insert-directory-program'.
4750 ;; RESULT gets the status code.
4752 ;; putting text property `dired-filename, decode one
4753 ;; bunch by one to preserve that property.
4755 ;; This is to control encoding the arguments in call-process.
4759 default-file-name-coding-system))))
4762 ;; Run ls in the directory part of the file pattern
4763 ;; using the last component as argument.
4770 shell-file-name nil t nil
4771 "-c"
4773 ""
4775 insert-directory-program
4776 " -d "
4778 switches
4780 " -- "
4781 ;; Quote some characters that have
4782 ;; special meanings in shells; but
4783 ;; don't quote the wildcards--we want
4784 ;; them to be special. We also
4785 ;; currently don't quote the quoting
4786 ;; characters in case people want to
4787 ;; use them explicitly to quote
4788 ;; wildcard characters.
4790 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4791 ;; directory if FILE is a symbolic link.
4793 insert-directory-program nil t nil
4797 ;; Split the switches at any spaces so we can
4798 ;; pass separate options as separate args.
4800 ;; Avoid lossage if FILE starts with `-'.
4808 file))))))))
4810 ;; If we got "//DIRED//" in the output, it means we got a real
4811 ;; directory listing, even if `ls' returned nonzero.
4812 ;; So ignore any errors.
4825 ;; The first time ls returns an error,
4826 ;; find the version numbers of ls,
4827 ;; and set insert-directory-ls-version
4828 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4829 ;; is equal or if the info cannot be obtained.
4830 ;; (That can mean it isn't GNU ls.)
4840 comparison)
4856 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4860 ;; If `insert-directory-program' failed, signal an error.
4862 ;; Delete the error message it may have output.
4864 ;; On non-Posix systems, we cannot open a directory, so
4865 ;; don't even try, because that will always result in
4866 ;; the ubiquitous "Access denied". Instead, show the
4867 ;; command line so the user can try to guess what went wrong.
4872 insert-directory-program
4874 file result)
4875 ;; Unix. Access the file to get a suitable error.
4882 ;; The following overshoots by one line for an empty
4883 ;; directory listed with "--dired", but without "-a"
4884 ;; switch, where the ls output contains a
4885 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4886 ;; We take care of that case later.
4894 error-lines)
4895 ;; Find all the lines that are error messages,
4896 ;; and record the bounds of each one.
4903 ;; Now read the numeric positions of file names.
4910 error-lines))
4913 error-lines)))
4915 ;; End is followed by \n or by " -> ".
4917 ;; It seems that we can't trust ls's output as to
4918 ;; byte positions of filenames.
4924 ;; Take care of the case where the ls output contains a
4925 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4926 ;; and we went one line too far back (see above).
4931 ;; Now decode what read if necessary.
4933 file-name-coding-system
4934 default-file-name-coding-system
4936 coding-no-eol
4937 val pos)
4941 ;; If no coding system is specified or detection is
4942 ;; requested, detect the coding.
4956 ;; Force no eol conversion on a file name, so
4957 ;; that CR is preserved.
4965 ;; Try to insert the amount of free space.
4968 ;; First find the line to put it on.
4972 ;; Replace "total" with "used", to avoid confusion.
4978 "Convert `ls --dired' file name position value POS to a buffer position.
4979 File name position values returned in ls --dired output
4980 count only stdout; they don't count the error messages sent to stderr.
4981 So this function converts to them to real buffer positions.
4982 ERROR-LINES is a list of buffer positions of error message lines,
4983 of the form (START END)."
4987 pos)
4991 "Insert directory listing for FILE, formatted according to SWITCHES.
4993 Like `insert-directory', but if FILE does not exist, it inserts a
4994 message to that effect instead of signaling an error."
4997 ;; Simulate the message printed by `ls'.
5001 "Functions to call with no arguments to query about killing Emacs.
5002 If any of these functions returns nil, killing Emacs is cancelled.
5004 but `kill-emacs', the low level primitive, does not.
5008 "How to ask for confirmation when leaving Emacs.
5009 If nil, the default, don't ask at all. If the value is non-nil, it should
5010 be a predicate function such as `yes-or-no-p'."
5018 "Offer to save each buffer, then kill this Emacs process.
5019 With prefix arg, silently save all file-visiting buffers, then kill."
5028 ;; process-list is not defined on VMS.
5030 active)
5039 ;; Query the user for other things, perhaps.
5044 \f
5045 ;; We use /: as a prefix to "quote" a file name
5046 ;; so that magic file name handlers will not apply to it.
5050 file-name-handler-alist))
5052 ;; We depend on being the last handler on the list,
5053 ;; so that anything else which does need handling
5054 ;; has been handled already.
5055 ;; So it is safe for us to inhibit *all* magic file name handlers.
5064 default-directory))
5065 ;; Get a list of the indices of the args which are file names.
5068 ;; The first six are special because they
5069 ;; return a file name. We want to include the /:
5070 ;; in the return value.
5071 ;; So just avoid stripping it in the first place.
5078 ;; `identity' means just return the first arg
5079 ;; not stripped of its quoting.
5081 ;; `add' means add "/:" to the result.
5083 ;; `quote' means add "/:" to buffer-file-name.
5085 ;; `unquote-then-quote' means set buffer-file-name
5086 ;; temporarily to unquoted filename.
5088 ;; List the arguments which are filenames.
5096 ;; For all other operations, treat the first argument only
5097 ;; as the file name.
5099 method
5100 ;; Copy ARGUMENTS so we can replace elements in it.
5104 ;; Strip off the /: from the file names that have it.
5112 "/"
5128 res))
5131 \f
5156 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5157 ;;; files.el ends here