| blob | 2c03d0fcadfc0f7301d717f943ea2c6846c2d9f3 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
4 ;;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
34 "Backups of edited data files."
38 "Finding files."
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
71 ;; Turn off backup files on VMS since it has version numbers.
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
137 "Predicate that looks at a file name and decides whether to make backups.
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
163 nil
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
195 "The directory for writing temporary files."
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil means make them for files that have some already.
243 `never' means do not make them."
251 "*When cleaning directory, number of versions to keep."
257 "*If t, delete excess backup versions silently.
258 If nil, ask confirmation. Any other value prevents any trimming."
265 "*Number of oldest versions to keep when a new numbered backup is made."
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
276 "*Value of t says silently ensure a file ends in a newline when it is saved.
277 Non-nil but not t says ask user whether to add a newline when there isn't one.
278 nil means don't add newlines."
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
291 Normally auto-save files are written under other names."
298 "*Transforms to apply to buffer file name before making auto-save file name.
299 Each transform is a list (REGEXP REPLACEMENT):
300 REGEXP is a regular expression to match against the file name.
301 If it matches, `replace-match' is used to replace the
302 matching part with REPLACEMENT.
303 All the transforms in the list are tried, in the order they are listed.
304 When one transform applies, its result is final;
305 no further transforms are tried.
307 The default value is set up to put the auto-save file into the
308 temporary directory (see the variable `temporary-file-directory') for
309 editing a remote file."
315 "*Non-nil means save word abbrevs too when files are saved.
316 If `silently', don't ask the user before saving."
321 "*Non-nil means allow `find-file' to visit directories.
322 To visit the directory, `find-file' runs `find-directory-functions'."
327 "*List of functions to try in sequence to visit a directory.
328 Each function is called with the directory name as the sole argument
329 and should return either a buffer or nil."
333 ;;;It is not useful to make this a local variable.
334 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
336 "List of functions to be called for `find-file' on nonexistent file.
337 These functions are called as soon as the error is detected.
338 Variable `buffer-file-name' is already set up.
341 ;;;It is not useful to make this a local variable.
342 ;;;(put 'find-file-hooks 'permanent-local t)
344 "List of functions to be called after a buffer is loaded from a file.
345 The buffer's local variables (if any) will have been processed before the
349 "List of functions to be called before writing out a buffer to a file.
350 If one of them returns non-nil, the file is considered already written
351 and the rest are not called.
352 These hooks are considered to pertain to the visited file.
353 So any buffer-local binding of `write-file-hooks' is
356 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
358 ;;; However, in case someone does make it local...
362 "Just like `write-file-hooks', except intended for per-buffer use.
363 The functions in this list are called before the ones in
364 `write-file-hooks'.
366 This variable is meant to be used for hooks that have to do with a
367 particular visited file. Therefore, it is a permanent local, so that
368 changing the major mode does not clear it. However, calling
374 "List of functions to be called before writing out a buffer to a file.
375 If one of them returns non-nil, the file is considered already written
376 and the rest are not called.
378 This variable is meant to be used for hooks that pertain to the
379 buffer's contents, not to the particular visited file; thus,
380 `set-visited-file-name' does not clear this variable; but changing the
381 major mode does clear it.
383 This variable automatically becomes buffer-local whenever it is set.
384 If you use `add-hook' to add elements to the list, use nil for the
385 LOCAL argument.
391 "*Control use of local variables in files you visit.
392 The value can be t, nil or something else.
393 A value of t means file local variables specifications are obeyed;
394 nil means they are ignored; anything else means query.
395 This variable also controls use of major modes specified in
396 a -*- line.
399 always obeys file local variable specifications and the -*- line,
400 and ignores this variable."
407 "Like `enable-local-variables' but meant for buffer-local bindings.
408 The meaningful values are nil and non-nil. The default is non-nil.
409 If a major mode sets this to nil, buffer-locally, then any local
410 variables list in the file will be ignored.
412 This variable does not affect the use of major modes
417 The value can be t, nil or something else.
418 A value of t means obey `eval' variables;
419 nil means ignore them; anything else means query.
422 and ignores this variable."
428 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
440 "Provides support for ange-ftp host name completion.
441 Runs the usual ange-ftp hook, but only for completion operations."
442 ;; Having this here avoids the need to load ange-ftp when it's not
443 ;; really in use.
449 inhibit-file-name-handlers)))
454 "Convert a standard file's name to something suitable for the current OS.
455 This function's standard definition is trivial; it just returns the argument.
456 However, on some systems, the function is redefined with a definition
457 that really does change some file names to canonicalize certain
458 patterns and to guarantee valid names."
459 filename)
460 \f
462 "Show the current default directory."
467 "Value of the CDPATH environment variable, as a list.
471 "Explode a colon-separated search path into a list of directory names.
472 \(For values of `colon' equal to `path-separator'.)"
473 ;; We could use split-string here.
481 nil
486 cd-list)))
489 "Change current directory to given absolute file name DIR."
490 ;; Put the name into directory syntax now,
491 ;; because otherwise expand-file-name may give some bad results.
504 "Make DIR become the current buffer's default directory.
505 If your environment includes a `CDPATH' variable, try each one of that
506 colon-separated list of directories when resolving a relative directory name."
509 default-directory default-directory
525 cd-path)
526 nil))
530 "Load the Lisp file named FILE."
531 ;; This is a case where .elc makes a lot of sense.
538 "Load the library named LIBRARY.
539 This is an interface to the function `load'."
544 "Copy the file FILE into a temporary file on this machine.
545 Returns the name of the local copy, or nil, if FILE is directly
546 accessible."
547 ;; This formerly had an optional BUFFER argument that wasn't used by
548 ;; anything.
552 nil)))
555 "Return the truename of FILENAME, which should be absolute.
556 The truename of a file name is found by chasing symbolic links
557 both at the level of the file and at the level of the directories
558 containing it, until no links are left at any level.
560 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
561 Do not specify them in other calls."
562 ;; COUNTER can be a cons cell whose car is the count of how many more links
563 ;; to chase before getting an error.
564 ;; PREV-DIRS can be a cons cell whose car is an alist
565 ;; of truenames we've just recently computed.
567 ;; The last test looks dubious, maybe `+' is meant here? --simon.
577 ;; For speed, remove the ange-ftp completion handler from the list.
578 ;; We know it's not needed here.
579 ;; For even more speed, do this only on the outermost call.
586 ;; andrewi@harlequin.co.uk - none of the following code (except for
587 ;; invoking the file-name handler) currently applies on Windows
588 ;; (ie. there are no native symlinks), but there is an issue with
589 ;; case differences being ignored by the OS, and short "8.3 DOS"
590 ;; name aliases existing for all files. (The short names are not
591 ;; reported by directory-files, but can be used to refer to files.)
592 ;; It seems appropriate for file-truename to resolve these issues in
593 ;; the most natural way, which on Windows is to call the function
594 ;; `w32-long-file-name' - this returns the exact name of a file as
595 ;; it is stored on disk (expanding short name aliases with the full
596 ;; name in the process).
599 newname)
600 ;; For file name that has a special handler, call handler.
601 ;; This is so that ange-ftp can save time by doing a no-op.
604 ;; If filename contains a wildcard, newname will be the old name.
607 ;; If filename doesn't exist, newname will be nil.
612 ;; If this file directly leads to a link, process that iteratively
613 ;; so that we don't use lots of stack.
619 ;; For file name that has a special handler, call handler.
620 ;; This is so that ange-ftp can save time by doing a no-op.
623 done t)
625 target dirfile)
626 ;; Get the truename of the directory.
628 ;; If these are equal, we have the (or a) root directory.
630 ;; If this is the same dir we last got the truename for,
631 ;; save time--don't recalculate.
641 done t)
644 done t)
645 ;; Put it back on the file name.
647 ;; Is the file name the name of a link?
650 ;; Yes => chase that link, then start all over
651 ;; since the link may point to a directory name that uses links.
652 ;; We can't safely use expand-file-name here
653 ;; since target might look like foo/../bar where foo
654 ;; is itself a link. Instead, we handle . and .. above.
657 target
659 done nil)
660 ;; No, we are done!
662 filename))
665 "Chase links in FILENAME until a name that is not a link.
666 Does not examine containing directories for links,
667 unlike `file-truename'."
673 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
676 ;; Handle `..' by hand, since it needs to work in the
677 ;; target of any directory symlink.
678 ;; This code is not quite complete; it does not handle
679 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
683 ;; Chase links in the default dir of the symlink.
687 ;; Now find the parent of that dir.
691 newname))
692 \f
694 "Select buffer BUFFER in another window.
695 Optional second arg NORECORD non-nil means
696 do not put this buffer at the front of the list of recently selected ones.
698 This uses the function `display-buffer' as a subroutine; see its
699 documentation for additional customization information."
705 "Switch to buffer BUFFER in another frame.
706 Optional second arg NORECORD non-nil means
707 do not put this buffer at the front of the list of recently selected ones.
709 This uses the function `display-buffer' as a subroutine; see its
710 documentation for additional customization information."
717 "Edit file FILENAME.
718 Switch to a buffer visiting file FILENAME,
719 creating one if none already exists.
720 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
721 expand wildcards (if any) and visit multiple files. Wildcard expansion
722 can be suppressed by setting `find-file-wildcards'."
730 "Edit file FILENAME, in another window.
731 May create a new window, or reuse an existing one.
732 See the function `display-buffer'.
733 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
734 expand wildcards (if any) and visit multiple files."
745 "Edit file FILENAME, in another frame.
746 May create a new frame, or reuse an existing one.
747 See the function `display-buffer'.
748 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
749 expand wildcards (if any) and visit multiple files."
760 "Edit file FILENAME but don't allow changes.
761 Like `find-file' but marks buffer as read-only.
769 "Edit file FILENAME in another window but don't allow changes.
778 "Edit file FILENAME in another frame but don't allow changes.
787 "Find file FILENAME as a replacement for the file in the next window.
788 This command does not select that window."
807 "Find file FILENAME, select its buffer, kill previous buffer.
808 If the current buffer now contains an empty file that you just visited
809 \(presumably by mistake), use this command to visit the file you really want."
820 ;; (not buffer-read-only)
847 \f
849 "Create a suitably named buffer for visiting FILENAME, and return it.
850 FILENAME (sans directory) is used unchanged if that name is free;
851 otherwise a string <2> or <3> or ... is appended to get an unused name."
858 "Create and return a buffer with a name based on NAME.
859 Choose the buffer's name using `generate-new-buffer-name'."
863 "Regexp to match the automounter prefix in a directory name."
871 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
874 ;; Get rid of the prefixes added by the automounter.
881 ;; If any elt of directory-abbrev-alist matches this name,
882 ;; abbreviate accordingly.
888 ;; Compute and save the abbreviated homedir name.
889 ;; We defer computing this until the first time it's needed, to
890 ;; give time for directory-abbrev-alist to be set properly.
891 ;; We include a slash at the end, to avoid spurious matches
892 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
899 ;; If FILENAME starts with the abbreviated homedir,
900 ;; make it start with `~' instead.
902 ;; If the home dir is just /, don't change it.
905 ;; MS-DOS root directories can come with a drive letter;
906 ;; Novell Netware allows drive letters beyond `Z:'.
915 filename))
918 "*List of logical names for which visiting shouldn't save the true dirname.
919 On VMS, when you visit a file using a logical name that searches a path,
920 you may or may not want the visited file name to record the specific
921 directory where the file was found. If you *do not* want that, add the logical
922 name to this list as a string."
927 "Return the buffer visiting file FILENAME (a string).
928 This is like `get-file-buffer', except that it checks for any buffer
929 visiting the same file, possibly under a different name.
930 If there is no such live buffer, return nil."
942 found)
947 number
952 ;; Verify this buffer's file number
953 ;; still belongs to its file.
956 attributes))
959 found))))
960 \f
962 "*Non-nil means file-visiting commands should handle wildcards.
963 For example, if you specify `*.c', that would visit all the files
964 whose names match the pattern."
970 "*Non-nil means suppress warning messages for symlinked files.
971 When nil, Emacs prints a warning when visiting a file that is already
972 visited, but with a different name. Setting this option to t
973 suppresses this warning."
979 "Read file FILENAME into a buffer and return the buffer.
980 If a buffer exists visiting FILENAME, return that one, but
981 verify that the file has not changed since visited or saved.
982 The buffer is not selected, just returned to the caller.
983 Optional first arg NOWARN non-nil means suppress any warning messages.
984 Optional second arg RAWFILE non-nil means the file is read literally.
985 Optional third arg WILDCARDS non-nil means do wildcard processing
986 and visit all the matching files. When wildcards are actually
987 used and expanded, the value is a list of buffers
988 that are visiting the various files."
995 'find-directory-functions
998 filename)))
1001 find-file-wildcards
1014 ;; Find any buffer for a file which has same truename.
1016 ;; Let user know if there is a buffer with the same truename.
1020 find-file-suppress-same-file-warnings
1024 ;; Optionally also find that buffer.
1028 ;; We are using an existing buffer.
1034 ;; Certain files should be reverted automatically
1035 ;; if they have changed on disk and not in the buffer.
1043 found))
1053 "File %s changed on disk. Discard your edits? "
1058 "File %s changed on disk. Discard your edits in %s? "
1066 ;; Check if a formerly read-only file has become
1067 ;; writable and vice versa, but if the buffer agrees
1068 ;; with the new state of the file, that is ok too.
1075 buffer-file-name
1085 "Save file and revisit literally? "
1090 rawfile truename number))
1092 "Discard your edits and revisit file literally? "
1095 rawfile truename number)
1099 "Revisit file literally? "
1102 rawfile truename number)
1105 ;; Return the buffer we are using.
1106 buf)
1107 ;; Create a new buffer.
1110 ;; find-file-noselect-1 may use a different buffer.
1112 rawfile truename number))))))
1116 error)
1119 ;; Needed in case we are re-visiting the file with a different
1120 ;; text representation.
1134 filename)))
1135 ;; Unconditionally set error
1144 filename)))
1145 ;; Run find-file-not-found-hooks until one returns non-nil.
1147 ;; If they fail too, set error.
1149 ;; Record the file's truename, and maybe use that as visited name.
1155 ;; On VMS, we may want to remember which directory in a search list
1156 ;; the file was found in.
1168 ;; Set buffer's default directory to that of the file.
1170 ;; Turn off backup files for certain file names. Since
1171 ;; this is a permanent local, the major mode won't eliminate it.
1184 \f
1186 "Like `insert-file-contents', but only reads in the file literally.
1187 A buffer may be modified in several ways after reading into the buffer,
1188 to Emacs features such as format decoding, character code
1189 conversion, `find-file-hooks', automatic uncompression, etc.
1191 This function ensures that none of these modifications will take place."
1199 nil))
1211 "Insert contents of file FILENAME into buffer after point with no conversion.
1213 This function is meant for the user to run interactively.
1214 Don't call it from programs! Use `insert-file-contents-literally' instead.
1215 \(Its calling sequence is different; see its documentation)."
1219 filename)))
1224 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1229 "Visit file FILENAME with no conversion of any kind.
1230 Format conversion and character code conversion are both disabled,
1231 and multibyte characters are disabled in the resulting buffer.
1232 The major mode used is Fundamental mode regardless of the file name,
1233 and local variable specifications in the file are ignored.
1234 Automatic uncompression and adding a newline at the end of the
1235 file due to `require-final-newline' is also disabled.
1237 You cannot absolutely rely on this function to result in
1238 visiting the file literally. If Emacs already has a buffer
1239 which is visiting the file, you get the existing buffer,
1240 regardless of whether it was created literally or not.
1242 In a Lisp program, if you want to be sure of accessing a file's
1243 contents literally, you should create a temporary buffer and then read
1244 the file contents into it using `insert-file-contents-literally'."
1247 \f
1251 after-find-file-from-revert-buffer
1252 nomodes)
1253 "Called after finding a file and by the default revert function.
1254 Sets buffer mode, parses local variables.
1255 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1256 error in reading the file. WARN non-nil means warn if there
1257 exists an auto-save file more recent than the visited file.
1258 NOAUTO means don't mess with auto-save mode.
1259 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1260 means this call was from `revert-buffer'.
1261 Fifth arg NOMODES non-nil means don't alter the file's modes.
1262 Finishes by calling the functions in `find-file-hooks'
1263 unless NOMODES is non-nil."
1266 nil
1276 ;; No need to warn if buffer is auto-saved
1277 ;; under the name of the visited file.
1279 auto-save-visited-file-name))
1282 buffer-file-name))
1296 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1297 "Use M-x make-directory RET RET to create the directory"
1304 ;; Make people do a little extra work (C-x C-q)
1305 ;; before altering a backup file.
1313 view-read-only
1319 "Choose the major mode for this buffer automatically.
1320 Also sets up any specified local variables of the file.
1321 Uses the visited file name, the -*- line, and the local variables spec.
1323 This function is called automatically from `find-file'. In that case,
1324 we may set up the file-specified mode and local variables,
1325 depending on the value of `enable-local-variables': if it is t, we do;
1326 if it is nil, we don't; otherwise, we query.
1327 In addition, if `local-enable-local-variables' is nil, we do
1328 not set local variables (though we do notice a mode specified with -*-.)
1330 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1331 or from Lisp without specifying the optional argument FIND-FILE;
1332 in that case, this function acts as if `enable-local-variables' were t."
1341 enable-local-variables)))
1382 ;; Less common extensions come here
1383 ;; so more common ones above are found faster.
1393 ;; for MSDOS and MS-Windows (which are case-insensitive)
1438 ;; Mailer puts message to be edited in
1439 ;; /tmp/Re.... or Message
1444 ;; some news reader is reported to use this
1454 ;; .emacs following a directory delimiter
1455 ;; in Unix, MSDOG or VMS syntax.
1458 ;; _emacs following a directory delimiter
1459 ;; in MsDos syntax
1472 ;; Get rid of any trailing .n.m and try again.
1473 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1474 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1475 ;; Using mode nil rather than `ignore' would let the search continue
1476 ;; through this list (with the shortened name) rather than start over.
1478 ;; The following should come after the ChangeLog pattern
1479 ;; for the sake of ChangeLog.1, etc.
1480 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1483 "Alist of filename patterns vs corresponding major mode functions.
1484 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1485 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1486 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1487 mode function to use. FUNCTION will be called, unless it is nil.
1489 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1490 calling FUNCTION (if it's not nil), we delete the suffix that matched
1536 "Alist mapping interpreter names to major modes.
1537 This alist applies to files whose first line starts with `#!'.
1538 Each element looks like (INTERPRETER . MODE).
1539 The car of each element is compared with
1540 the name of the interpreter specified in the first line.
1547 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1548 When checking `inhibit-first-line-modes-regexps', we first discard
1554 "Regular expression matching interpreters, for file mode determination.
1555 This regular expression is matched against the first line of a file
1556 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1557 a mode from the file's name. If it matches, the file is assumed to
1558 be interpreted by the interpreter matched by the second group of the
1559 regular expression. The mode is then determined as the mode associated
1563 "Select major mode appropriate for current buffer.
1564 This checks for a -*- mode tag in the buffer's text,
1565 compares the filename against the entries in `auto-mode-alist',
1566 or checks the interpreter that runs this file against
1567 `interpreter-mode-alist'.
1569 It does not check for the `mode:' local variable in the
1570 Local Variables section of the file; for that, use `hack-local-variables'.
1572 If `enable-local-variables' is nil, this function does not check for a
1573 -*- mode tag.
1575 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1576 then we do not set anything but the major mode,
1577 and we don't even do that unless it would come from the file name."
1578 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1584 ;; Don't look for -*- if this file name matches any
1585 ;; of the regexps in inhibit-first-line-modes-regexps.
1593 sufs)
1600 ;; If the file begins with "#!"
1601 ;; (exec interpreter magic), look
1602 ;; for mode frobs in the first two
1603 ;; lines. You cannot necessarily
1604 ;; put them in the first line of
1605 ;; such a file without screwing up
1606 ;; the interpreter invocation.
1614 t))
1621 ;; Find all specifications for the `mode:' variable
1622 ;; and execute them left to right.
1634 modes))
1635 ;; Simple -*-MODE-*- case.
1638 modes)))))
1639 ;; If we found modes to use, invoke them now,
1640 ;; outside the save-excursion.
1647 ;; If we didn't find a mode from a -*- line, try using the file name.
1651 ;; Remove backup-suffixes from file name.
1657 ;; Find first matching alist entry.
1666 keep-going t)
1668 keep-going nil)))
1671 ;; When JUST-FROM-FILE-NAME is set,
1672 ;; we are working on behalf of set-visited-file-name.
1673 ;; In that case, if the major mode specified is the
1674 ;; same one we already have, don't actually reset it.
1675 ;; We don't want to lose minor modes such as Font Lock.
1678 ;; If we can't deduce a mode from the file name,
1679 ;; look for an interpreter specified in the first line.
1680 ;; As a special case, allow for things like "#!/bin/env perl",
1681 ;; which finds the interpreter anywhere in $PATH.
1688 elt)
1689 ;; Map interpreter name to a mode.
1691 interpreter-mode-alist))
1697 "Set local variables specified in the -*- line.
1698 Ignore any specification for `mode:' and `coding:';
1699 `set-auto-mode' should already have handled `mode:',
1700 `set-auto-coding' should already have handled `coding:'."
1707 ;; Parse the -*- line into the `result' alist.
1709 ;; doesn't have one.
1710 nil)
1712 ;; Simple form: "-*- MODENAME -*-". Already handled.
1713 nil)
1715 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1716 ;; (last ";" is optional).
1725 ;; There used to be a downcase here,
1726 ;; but the manual didn't say so,
1727 ;; and people want to set var names that aren't all lc.
1734 ;; It is traditional to ignore
1735 ;; case when checking for `mode' in set-auto-mode,
1736 ;; so we must do that here as well.
1737 ;; That is inconsistent, but we're stuck with it.
1738 ;; The same can be said for `coding' in set-auto-coding.
1752 ;; If we fail to switch in the selected window,
1753 ;; it is probably a minibuffer.
1754 ;; So try another window.
1767 "Normal hook run after processing a file's local variables specs.
1768 Major modes can use this to examine user-specified local variables
1772 "Parse and put into effect this buffer's local variables spec.
1773 If MODE-ONLY is non-nil, all we do is check whether the major mode
1774 is specified, returning t if it is specified."
1777 ;; Look for "Local variables:" line in last page.
1787 mode-only
1797 buffer-file-name)
1801 prefix prefixlen suffix beg
1802 mode-specified
1804 ;; The prefix is what comes before "local variables:" in its line.
1805 ;; The suffix is what comes after "local variables:" in its line.
1820 ;; Look at next local variable spec.
1823 ;; Skip the prefix, if any.
1828 ;; Find the variable name; strip whitespace.
1836 val)
1837 ;; Setting variable named "end" means end of list.
1840 ;; Otherwise read the variable value.
1851 ;; Set the variable. "Variables" mode and eval are funny.
1855 mode-specified))
1861 ;; Get confirmation before setting these variables as locals in a file.
1878 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1882 ;; This one is safe because the user gets to check it before it is used.
1890 A few variable names are treated specially."
1895 ;; We have already handled coding: tag in set-auto-coding.
1896 nil)
1898 nil)
1899 ;; "Setting" eval means either eval it or do nothing.
1900 ;; Likewise for setting hook variables.
1906 ;; Permit evalling a put of a harmless property.
1907 ;; if the args do nothing tricky.
1913 ;; Only allow safe values of lisp-indent-hook;
1914 ;; not functions.
1919 ;; Permit eval if not root and user says ok.
1938 ;; Ordinary variable, really set it.
1942 \f
1945 However, the mode will not be changed if
1946 \(1) a local variables list or the `-*-' line specifies a major mode, or
1948 \ not suitable for ordinary files, or
1949 \(3) the new file name does not particularly specify any mode."
1954 "Change name of file visited in current buffer to FILENAME.
1955 The next time the buffer is saved it will go in the newly specified file.
1956 nil or empty string as argument means make buffer not be visiting any file.
1957 Remember to delete the initial contents of the minibuffer
1958 if you wish to pass an empty string as the argument.
1960 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1961 confirmation in the case where another buffer is already visiting FILENAME.
1963 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1964 the old visited file has been renamed to the new name FILENAME."
1972 nil
1983 filename)))
2002 ;; Abbreviate the file names of the buffer.
2011 nil)))
2012 ;; write-file-hooks is normally used for things like ftp-find-file
2013 ;; that visit things that are not local files as if they were files.
2014 ;; Changing to visit an ordinary local file instead should flush the hook.
2019 ;; If buffer was read-only because of version control,
2020 ;; that reason is gone now, so make it writable.
2024 ;; Turn off backup files for certain file names.
2025 ;; Since this is a permanent local, the major mode won't eliminate it.
2032 ;; If auto-save was not already on, turn it on if appropriate.
2036 ;; If auto save is on, start using a new name.
2037 ;; We deliberately don't rename or delete the old auto save
2038 ;; for the old visited file name. This is because perhaps
2039 ;; the user wants to save the new state and then compare with the
2040 ;; previous state from the auto save file.
2043 ;; Rename the old auto save file if any.
2050 ;; Update the major mode, if the file name determines it.
2052 ;; Don't change the mode if it is special.
2055 ;; Don't change the mode if the local variable list specifies it.
2061 "Write current buffer into file FILENAME.
2062 This makes the buffer visit that file, and marks it as not modified.
2064 If you specify just a directory name as FILENAME, that means to use
2065 the default file name but in that directory. You can also yank
2066 the default file name into the minibuffer to edit it, using M-n.
2068 If the buffer is not already visiting a file, the default file name
2069 for the output file is the buffer name.
2071 If optional second arg CONFIRM is non-nil, this function
2072 asks for confirmation before overwriting an existing file.
2073 Interactively, confirmation is required unless you supply a prefix argument."
2074 ;; (interactive "FWrite file: ")
2078 nil nil nil nil)
2082 default-directory)
2083 nil nil))
2087 ;; If arg is just a directory,
2088 ;; use the default file name, but in that directory.
2099 ;; Make buffer writable if file is writable.
2104 \f
2106 "Make a backup of the disk file visited by the current buffer, if appropriate.
2107 This is normally done before saving the buffer the first time.
2108 If the value is non-nil, it is the result of `file-modes' on the original
2109 file; this means that the caller, after saving the buffer, should change
2110 the modes of the new file to agree with the old modes.
2112 A backup may be done by renaming or by copying; see documentation of
2113 variable `make-backup-files'. If it's done by renaming, then the file is
2114 no longer accessible under its old name."
2121 backup-info backupname targets setmodes)
2122 ;; If specified name is a symbolic link, chase it to the target.
2123 ;; Thus we make the backups in the directory where the real file is.
2128 ;; (if (file-directory-p buffer-file-name)
2129 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2133 ;; If have old versions to maybe delete,
2134 ;; ask the user to confirm now, before doing anything.
2135 ;; But don't actually delete til later.
2140 real-file-name))))))
2141 ;; Actually write the back up file.
2144 ; (file-symlink-p buffer-file-name)
2145 backup-by-copying
2160 ;; If copying fails because file BACKUPNAME
2161 ;; is not writable, delete that file and try again.
2166 ;; rename-file should delete old backup.
2170 ;; If trouble writing the backup, write it in ~.
2180 ;; If copying fails because file BACKUPNAME
2181 ;; is not writable, delete that file and try again.
2187 ;; Now delete the old versions, if desired.
2194 setmodes)
2198 "Return file NAME sans backup versions or strings.
2199 This is a separate procedure so your site-init or startup file can
2200 redefine it.
2201 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2202 we do not remove backup version numbers, only true file version numbers."
2208 ;; VMS version number is (a) semicolon, optional
2209 ;; sign, zero or more digits or (b) period, option
2210 ;; sign, zero or more digits, provided this is the
2211 ;; second period encountered outside of the
2212 ;; device/directory part of the file name.
2215 name)
2225 "Return t if deleting FILE and rewriting it would preserve the owner."
2230 ;; Return t if the file doesn't exist, since it's true that no
2231 ;; information would be lost by an (attempted) delete and create.
2237 The extension, in a file name, is the part that follows the last `.',
2238 except that a leading `.', if any, doesn't count."
2241 directory)
2246 directory)
2248 filename))))
2252 The extension, in a file name, is the part that follows the last `.',
2253 except that a leading `.', if any, doesn't count.
2254 Return nil for extensionless file names such as `foo'.
2255 Return the empty string for file names such as `foo.'.
2257 If PERIOD is non-nil, then the returned value includes the period
2258 that delimits the extension, and if FILENAME has no extension,
2269 "A function to use instead of the default `make-backup-file-name'.
2270 A value of nil gives the default `make-backup-file-name' behaviour.
2272 This could be buffer-local to do something special for specific
2273 files. If you define it, you may need to change `backup-file-name-p'
2274 and `file-name-sans-versions' too.
2276 See also `backup-directory-alist'."
2282 "Alist of filename patterns and backup directory names.
2283 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2284 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2285 relative or absolute. If it is absolute, so that all matching files
2286 are backed up into the same directory, the file names in this
2287 directory will be the full name of the file backed up with all
2288 directory separators changed to `!' to prevent clashes. This will not
2289 work correctly if your filesystem truncates the resulting name.
2291 For the common case of all backups going into one directory, the alist
2293 directory name.
2295 If this variable is nil, or it fails to match a filename, the backup
2296 is made in the original file's directory.
2298 On MS-DOS filesystems without long names this variable is always
2299 ignored."
2305 "Default `backup-enable-predicate' function.
2306 Checks for files in `temporary-file-directory' or
2307 `small-temporary-file-directory'."
2310 ;; Directory is under temporary-file-directory.
2315 0 nil
2317 ;; Directory is under small-temporary-file-directory.
2322 "Create the non-numeric backup file name for FILE.
2323 Normally this will just be the file's name with `~' appended.
2324 Customization hooks are provided as follows.
2326 If the variable `make-backup-file-name-function' is non-nil, its value
2327 should be a function which will be called with FILE as its argument;
2328 the resulting name is used.
2330 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2331 the documentation of that variable. If the directory for the backup
2332 doesn't exist, it is created."
2346 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2348 elt backup-directory dir-sep-string)
2353 alist nil)))
2355 file
2363 ;; Normalize DOSish file names: convert all slashes to
2364 ;; directory-sep-char, downcase the drive letter, if any,
2365 ;; and replace the leading "x:" with "/drive_x".
2368 ;; Replace any invalid file-name characters (for the
2369 ;; case of backing up remote files).
2374 "drive_"
2377 ""
2378 dir-sep-string)
2380 ;; Make the name unique by substituting directory
2381 ;; separators. It may not really be worth bothering about
2382 ;; doubling `!'s in the original name...
2385 directory-sep-char ?!
2387 backup-directory))
2394 "Return non-nil if FILE is a backup file name (numeric or not).
2395 This is a separate function so you can redefine it for customization.
2396 You may need to redefine `file-name-sans-versions' as well."
2401 ;; This is used in various files.
2402 ;; The usage of backup-extract-version-start is not very clean,
2403 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2405 "Given the name of a numeric backup file, FN, return the backup number.
2406 Uses the free variable `backup-extract-version-start', whose value should be
2407 the index in the name where the version number begins."
2413 ;; I believe there is no need to alter this behavior for VMS;
2414 ;; since backup files are not made on VMS, it should not get called.
2416 "Find a file name for a backup file FN, and suggestions for deletions.
2417 Value is a list whose car is the name for the backup file
2418 and whose cdr is a list of old versions to consider deleting now.
2419 If the value is nil, don't make a backup.
2420 Uses `backup-directory-alist' in the same way as does
2421 `make-backup-file-name'."
2423 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2427 ;; We don't support numbered backups on plain MS-DOS
2428 ;; when long file names are unavailable.
2438 possibilities deserve-versions-p versions)
2441 base-versions
2444 possibilities)
2445 #'<)
2450 kept-old-versions
2451 kept-new-versions
2458 ;; Delete nothing if there is overflow
2459 ;; in the number of versions to keep.
2465 v))))))))))
2468 "Return number of names file FILENAME has."
2472 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2473 This function returns a relative file name which is equivalent to FILENAME
2474 when used with that default directory as the default.
2475 If this is impossible (which can happen on MSDOS and Windows
2476 when the file name and directory use different drive names)
2477 then it returns FILENAME."
2482 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2483 ;; drive names, they can't be relative, so return the absolute name.
2488 filename
2495 ".."
2497 ;; Now ancestor is empty, or .., or ../.., etc.
2499 ;; We matched within FNAME's directory part.
2500 ;; Add the rest of FNAME onto ANCESTOR.
2504 ;; But don't bother with ANCESTOR if it would give us `./'.
2505 rest
2507 ;; We matched FNAME's directory equivalent.
2508 ancestor))))))
2509 \f
2511 "Save current buffer in visited file if modified. Versions described below.
2512 By default, makes the previous version into a backup file
2513 if previously requested or if this is the first save.
2515 to become a backup when the next save is done.
2517 unconditionally makes the previous version into a backup file.
2519 to become a backup when the next save is done,
2520 and unconditionally makes the previous version into a backup file.
2522 With argument of 0, never make the previous version into a backup file.
2524 If a file's name is FOO, the names of its numbered backup versions are
2525 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2526 Numeric backups (rather than FOO~) will be made if value of
2527 `version-control' is not the atom `never' and either there are already
2528 numeric versions of the file being backed up, or `version-control' is
2529 non-nil.
2530 We don't want excessive versions piling up, so there are variables
2531 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2532 and `kept-new-versions', which tells how many newest versions to keep.
2533 Defaults are 2 old versions and 2 new.
2534 `dired-kept-versions' controls dired's clean-directory (.) command.
2535 If `delete-old-versions' is nil, system will query user
2536 before trimming versions. Otherwise it does it silently.
2538 If `vc-make-backup-files' is nil, which is the default,
2539 no backup files are made for files managed by version control.
2540 (This is because the version control system itself records previous versions.)
2542 See the subroutine `basic-save-buffer' for more information."
2555 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2556 Normally delete only if the file was written by this Emacs since
2557 the last real save, but optional arg FORCE non-nil means delete anyway."
2571 "Normal hook that is run after a buffer is saved to its file."
2577 "If non-nil, use this coding system for saving the buffer.
2578 More precisely, use this coding system in place of the
2579 value of `buffer-file-coding-system', when saving the buffer.
2580 Calling `write-region' for any purpose other than saving the buffer
2581 will still use `buffer-file-coding-system'; this variable has no effect
2588 "Save the current buffer in its visited file, if it has been modified.
2589 The hooks `write-contents-hooks', `local-write-file-hooks' and
2590 `write-file-hooks' get a chance to do the job of saving; if they do not,
2591 then the buffer is saved in the visited file file in the usual way.
2592 After saving the buffer, this function runs `after-save-hook'."
2595 ;; In an indirect buffer, save its base buffer instead.
2600 setmodes tempsetmodes)
2601 ;; On VMS, rename file and buffer to get rid of version number.
2606 ;; Strip VMS version number before save.
2609 ;; Construct a (unique) buffer name to correspond.
2614 ;; If buffer has no file name, ask user for one.
2621 filename))
2646 ;; Support VC version backups.
2651 ;; If a hook returned t, file is already "written".
2652 ;; Otherwise, write it the usual way now.
2654 ;; Now we have saved the current buffer. Let's make sure
2655 ;; that buffer-file-coding-system is fixed to what
2656 ;; actually used for saving by binding it locally.
2666 ;; If the auto-save file was recent before this command,
2667 ;; delete it now.
2669 ;; Support VC `implicit' locking.
2674 ;; This does the "real job" of writing a buffer into its visited file
2675 ;; and making a backup file. This is what is normally done
2676 ;; but inhibited if one of write-file-hooks returns non-nil.
2677 ;; It returns a value to store in setmodes.
2697 buffer-file-name)))
2705 ;; If file is precious, write temp name, then rename it.
2706 ;; This requires write access to the containing dir,
2707 ;; which is why we don't try it if we don't have that access.
2709 tempname temp nogood i succeed
2713 ;; Find the temporary name to write under.
2720 "%s$tmp$%d"
2722 dir i))
2728 tempname nil realname
2729 buffer-file-truename)
2731 ;; If writing the temp file fails,
2732 ;; delete the temp file.
2737 ;; Since we have created an entirely new file
2738 ;; and renamed it, make sure it gets the
2739 ;; right permission bits set.
2741 ;; We succeeded in writing the temp file,
2742 ;; so rename it.
2744 ;; If file not writable, see if we can make it writable
2745 ;; temporarily while we write it.
2746 ;; But no need to do so if we have just backed it up
2747 ;; (setmodes is set) because that says we're superseding.
2749 ;; Change the mode back, after writing.
2753 buffer-file-name nil t buffer-file-truename)))
2754 setmodes))
2757 "Save some modified file-visiting buffers. Asks user about each one.
2758 Optional argument (the prefix) non-nil means save all with no questions.
2759 Optional second argument PRED determines which buffers are considered:
2760 If PRED is nil, all the file-visiting buffers are considered.
2761 If PRED is t, then certain non-file buffers will also be considered.
2762 If PRED is a zero-argument function, it indicates for each buffer whether
2763 to consider it or not when called with that buffer current."
2782 t
2801 ;; Return nil to ask about BUF again.
2802 nil)
2810 abbrev-file-name)))
2812 ;; Don't keep bothering user if he says no.
2814 t))))
2817 \f
2819 "Mark current buffer as unmodified, not needing to be saved.
2822 It is not a good idea to use this function in Lisp programs, because it
2823 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2830 "Change whether this buffer is visiting its file read-only.
2831 With arg, set read-only iff arg is positive.
2832 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2838 ;; Toggle.
2850 "Insert contents of file FILENAME into buffer after point.
2851 Set mark after the inserted text.
2853 This function is meant for the user to run interactively.
2854 Don't call it from programs! Use `insert-file-contents' instead.
2855 \(Its calling sequence is different; see its documentation)."
2859 filename)))
2864 "Append the contents of the region to the end of file FILENAME.
2865 When called from a function, expects three arguments,
2866 START, END and FILENAME. START and END are buffer positions
2867 saying what text to write."
2872 "Return most recent backup file for FILENAME or nil if no backups exist."
2873 ;; `make-backup-file-name' will get us the right directory for
2874 ;; ordinary or numeric backups. It might create a directory for
2875 ;; backups as a side-effect, according to `backup-directory-alist'.
2881 tem)
2890 newest))
2893 "Rename current buffer to a similar name not already taken.
2894 This function is useful for creating multiple shell process buffers
2895 or multiple mail buffers, etc."
2903 ;; If the existing buffer name has a <NNN>,
2904 ;; which isn't part of the file name (if any),
2905 ;; then get rid of that.
2911 "Create the directory DIR and any nonexistent parent dirs.
2912 Interactively, the default choice of directory to create
2913 is the current default directory for file names.
2914 That is useful when you have visited a file in a nonexistent directory.
2916 Noninteractively, the second (optional) argument PARENTS says whether
2917 to create parent directories if they don't exist."
2920 nil nil)
2921 t))
2928 create-list)
2935 \f
2938 "Function to use to revert this buffer, or nil to do the default.
2939 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2944 "Function to use to insert contents when reverting this buffer.
2945 Gets two args, first the nominal file name to use,
2946 and second, t if reading the auto-save file.
2951 "Normal hook for `revert-buffer' to run before reverting.
2952 If `revert-buffer-function' is used to override the normal revert
2956 "Normal hook for `revert-buffer' to run after reverting.
2957 Note that the hook value that it runs is the value that was in effect
2958 before reverting; that makes a difference if you have buffer-local
2959 hook functions.
2961 If `revert-buffer-function' is used to override the normal revert
2967 "Replace current buffer text with the text of the visited file on disk.
2968 This undoes all changes since the file was visited or saved.
2969 With a prefix argument, offer to revert from latest auto-save file, if
2970 that is more recent than the visited file.
2972 This command also works for special buffers that contain text which
2973 doesn't come from a file, but reflects some other data base instead:
2974 for example, Dired buffers and buffer-list buffers. In these cases,
2975 it reconstructs the buffer contents from the appropriate data base.
2977 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2978 to revert from the auto-save file when this is nil. Note that the
2979 sense of this argument is the reverse of the prefix argument, for the
2980 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2981 to nil.
2983 Optional second argument NOCONFIRM means don't ask for confirmation at
2984 all. (The local variable `revert-without-query', if non-nil, prevents
2985 confirmation.)
2987 Optional third argument PRESERVE-MODES non-nil means don't alter
2988 the files modes. Normally we reinitialize them using `normal-mode'.
2990 If the value of `revert-buffer-function' is non-nil, it is called to
2991 do all the work for this command. Otherwise, the hooks
2992 `before-revert-hook' and `after-revert-hook' are run at the beginning
2993 and the end, and if `revert-buffer-insert-file-contents-function' is
2994 non-nil, it is called instead of rereading visited file contents."
2996 ;; I admit it's odd to reverse the sense of the prefix argument, but
2997 ;; there is a lot of code out there which assumes that the first
2998 ;; argument should be t to avoid consulting the auto-save file, and
2999 ;; there's no straightforward way to encourage authors to notice a
3000 ;; reversal of the argument sense. So I'm just changing the user
3001 ;; interface, but leaving the programmatic interface the same.
3007 buffer-auto-save-file-name
3012 buffer-auto-save-file-name
3013 buffer-file-name)))
3024 found))
3026 file-name)))
3028 ;; If file was backed up but has changed since,
3029 ;; we shd make another backup.
3033 ;; Get rid of all undo records for this buffer.
3036 ;; Effectively copy the after-revert-hook status,
3037 ;; since after-find-file will clobber it.
3041 after-revert-hook)))
3043 ;; Don't make undo records for the reversion.
3047 file-name auto-save-p)
3050 ;; Bind buffer-file-name to nil
3051 ;; so that we don't try to lock the file.
3057 ;; Auto-saved file shoule be read without
3058 ;; any code conversion.
3060 coding-system-for-read)))
3061 ;; Note that this preserves point in an intelligent way.
3063 nil nil t))))
3064 ;; Recompute the truename in case changes in symlinks
3065 ;; have changed the truename.
3069 ;; Run after-revert-hook as it was before we reverted.
3077 t)))))
3080 "Visit file FILE, but get contents from its last auto-save file."
3081 ;; Actually putting the file name in the minibuffer should be used
3082 ;; only rarely.
3083 ;; Not just because users often use the default.
3102 ;; Use insert-directory-safely, not insert-directory,
3103 ;; because these files might not exist. In particular,
3104 ;; FILE might not exist if the auto-save file was for
3105 ;; a buffer that didn't visit a file, such as "*mail*".
3106 ;; The code in v20.x called `ls' directly, so we need
3107 ;; to emulate what `ls' did in that case.
3113 ;; Keep the current buffer-file-coding-system.
3115 ;; Auto-saved file shoule be read without any code conversion.
3124 "Recover auto save files from a previous Emacs session.
3125 This command first displays a Dired buffer showing you the
3126 previous sessions that you could recover from.
3127 To choose one, move point to the proper line and then type C-c C-c.
3128 Then you'll be asked about a number of files to recover."
3142 ;; Each line starts with a space
3143 ;; so that Font Lock mode won't highlight the first character.
3152 "Choose one saved session to recover auto-save files from.
3153 This command is used in the special Dired buffer created by
3156 ;; Get the name of the session file to recover from.
3158 files
3164 ;; Read in the auto-save-list file.
3168 ;; Loop thru the text of that file
3169 ;; and get out the names of the files to recover.
3173 ;; This is a pair of lines for a non-file-visiting buffer.
3174 ;; Get the auto-save file name and manufacture
3175 ;; a "visited file name" from that.
3191 ;; This pair of lines is a file-visiting
3192 ;; buffer. Use the visited file name.
3202 ;; Ignore a file if its auto-save file does not exist now.
3206 ;; The file contains a pair of line for each auto-saved buffer.
3207 ;; The first line of the pair contains the visited file name
3208 ;; or is empty if the buffer was not visiting a file.
3209 ;; The second line is the auto-save file name.
3217 files
3223 "For each buffer in LIST, ask whether to kill it.
3224 LIST defaults to all existing live buffers."
3235 name
3240 \f
3242 "Toggle auto-saving of contents of current buffer.
3243 With prefix argument ARG, turn auto-saving on if positive, else off."
3248 ;; If auto-save is off because buffer has shrunk,
3249 ;; then toggling should turn it on.
3254 buffer-file-name
3256 ;; If -1 was stored here, to temporarily turn off saving,
3257 ;; turn it back on.
3263 buffer-auto-save-file-name)
3266 "Adjust current buffer's auto save file name for current conditions.
3267 Also rename any existing auto save file, if it was made in this session."
3279 "Return file name to use for auto-saves of current buffer.
3280 Does not consider `auto-save-visited-file-name' as that variable is checked
3281 before calling this function. You can redefine this for customization.
3282 See also `auto-save-file-name-p'."
3286 result)
3287 ;; Apply user-specified translations
3288 ;; to the file name.
3292 filename)))
3298 ;; We truncate the file name to DOS 8+3 limits before
3299 ;; doing anything else, because the regexp passed to
3300 ;; string-match below cannot handle extensions longer than
3301 ;; 3 characters, multiple dots, and other atrocities.
3309 "#"
3313 ;; Deal with buffers that don't have any associated files. (Mail
3314 ;; mode tends to create a good number of these.)
3318 ;; Eliminate all slashes and backslashes by
3319 ;; replacing them with sequences that start with %.
3320 ;; Quote % also, to keep distinct names distinct.
3329 ;; Generate the file name.
3332 ;; Try a few alternative directories, to get one we can write it.
3339 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3340 FILENAME should lack slashes. You can redefine this for customization."
3342 \f
3344 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3345 The generated regexp will match a filename iff the filename
3346 matches that wildcard according to shell rules. Only wildcards known
3347 by `sh' are supported."
3349 ;; Copy the initial run of non-special characters.
3352 ;; If no special characters, we're almost done.
3356 j)
3358 result
3379 ;; Found "[^". Insert a `\0' character
3380 ;; (which cannot happen in a filename)
3381 ;; into the character class, so that `^'
3382 ;; is not the first character after `[',
3383 ;; and thus non-special in a regexp.
3388 ;; I don't think `]' can appear in a
3389 ;; character class in a wildcard, but
3390 ;; let's be general here.
3397 i
3410 ;; Shell wildcards should match the entire filename,
3411 ;; not its part. Make the regexp say so.
3413 \f
3416 "*Switches for `list-directory' to pass to `ls' for brief listing."
3422 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3424 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3429 "Expand wildcard pattern PATTERN.
3430 This returns a list of file names which match the pattern.
3432 If PATTERN is written as an absolute relative file name,
3433 the values are absolute also.
3435 If PATTERN is written as a relative file name, it is interpreted
3436 relative to the current default directory, `default-directory'.
3437 The file names returned are normally also relative to the current
3438 default directory. However, if FULL is non-nil, they are absolute."
3441 ;; A list of all dirs that DIRPART specifies.
3442 ;; This can be more than one dir
3443 ;; if DIRPART contains wildcards.
3448 contents)
3453 ;; Filter out "." and ".."
3458 name))
3465 this-dir-contents)
3466 this-dir-contents)
3467 contents))))
3469 contents))
3472 "Display a list of files in or matching DIRNAME, a la `ls'.
3473 DIRNAME is globbed by the shell if necessary.
3474 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3475 Actions controlled by variables `list-directory-brief-switches'
3476 and `list-directory-verbose-switches'."
3480 nil default-directory nil)
3481 pfx)))
3483 list-directory-brief-switches)))
3501 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3503 PATTERN is assumed to represent a file-name wildcard suitable for the
3504 underlying filesystem. For Unix and GNU/Linux, the characters from the
3506 the parts of the pattern which don't include wildcard characters are
3507 quoted with double quotes.
3508 Existing quote characters in PATTERN are left alone, so you can pass
3509 PATTERN that already quotes some of the special characters."
3513 ;; DOS/Windows don't allow `"' in file names. So if the
3514 ;; argument has quotes, we can safely assume it is already
3515 ;; quoted by the caller.
3517 ;; We quote [&()#$'] in case their shell is a port of a
3518 ;; Unixy shell. We quote [,=+] because stock DOS and
3519 ;; Windows shells require that in some cases, such as
3520 ;; passing arguments to batch files that use positional
3521 ;; arguments like %1.
3523 pattern
3526 end)
3543 pattern))))
3549 ;; insert-directory
3550 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3551 ;; FULL-DIRECTORY-P is nil.
3552 ;; The single line of output must display FILE's name as it was
3553 ;; given, namely, an absolute path name.
3554 ;; - must insert exactly one line for each file if WILDCARD or
3555 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3556 ;; before the file lines, plus optional text after the file lines.
3557 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3558 ;; allowed.
3559 ;; File lines should display the basename.
3560 ;; - must be consistent with
3561 ;; - functions dired-move-to-filename, (these two define what a file line is)
3562 ;; dired-move-to-end-of-filename,
3563 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3564 ;; dired-insert-headerline
3565 ;; dired-after-subdir-garbage (defines what a "total" line is)
3566 ;; - variable dired-subdir-regexp
3568 "Insert directory listing for FILE, formatted according to SWITCHES.
3569 Leaves point after the inserted text.
3570 SWITCHES may be a string of options, or a list of strings.
3571 Optional third arg WILDCARD means treat FILE as shell wildcard.
3572 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3573 switches do not contain `d', so that a full listing is expected.
3575 This works by running a directory listing program
3576 whose name is in the variable `insert-directory-program'.
3577 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3578 ;; We need the directory in order to find the right handler.
3583 wildcard full-directory-p)
3588 ;; Read the actual directory using `insert-directory-program'.
3589 ;; RESULT gets the status code.
3593 default-file-name-coding-system)))
3594 ;; This is to control encoding the arguments in call-process.
3598 ;; Run ls in the directory part of the file pattern
3599 ;; using the last component as argument.
3606 shell-file-name nil t nil
3607 "-c"
3609 ""
3611 insert-directory-program
3612 " -d "
3614 switches
3616 " -- "
3617 ;; Quote some characters that have
3618 ;; special meanings in shells; but
3619 ;; don't quote the wildcards--we want
3620 ;; them to be special. We also
3621 ;; currently don't quote the quoting
3622 ;; characters in case people want to
3623 ;; use them explicitly to quote
3624 ;; wildcard characters.
3626 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3627 ;; directory if FILE is a symbolic link.
3629 insert-directory-program nil t nil
3633 ;; Split the switches at any spaces so we can
3634 ;; pass separate options as separate args.
3636 ;; Avoid lossage if FILE starts with `-'.
3644 file))))))))
3646 ;; If `insert-directory-program' failed, signal an error.
3648 ;; On non-Posix systems, we cannot open a directory, so
3649 ;; don't even try, because that will always result in
3650 ;; the ubiquitous "Access denied". Instead, show the
3651 ;; command line so the user can try to guess what went wrong.
3656 insert-directory-program
3658 file result)
3659 ;; Unix. Access the file to get a suitable error.
3663 ;; Try to insert the amount of free space.
3666 ;; First find the line to put it on.
3668 ;; Try to find the number of free blocks.
3672 ;; Usual format is a header line
3673 ;; followed by a line of numbers.
3678 ;; Move to the end of the "available blocks" number.
3681 ;; Copy it into AVAILABLE.
3686 ;; Replace "total" with "used", to avoid confusion.
3693 "Insert directory listing for FILE, formatted according to SWITCHES.
3695 Like `insert-directory', but if FILE does not exist, it inserts a
3696 message to that effect instead of signaling an error."
3699 ;; Simulate the message printed by `ls'.
3703 "Functions to call with no arguments to query about killing Emacs.
3704 If any of these functions returns nil, killing Emacs is cancelled.
3706 but `kill-emacs', the low level primitive, does not.
3710 "How to ask for confirmation when leaving Emacs.
3711 If nil, the default, don't ask at all. If the value is non-nil, it should
3712 be a predicate function such as `yes-or-no-p'."
3720 "Offer to save each buffer, then kill this Emacs process.
3721 With prefix arg, silently save all file-visiting buffers, then kill."
3730 ;; process-list is not defined on VMS.
3732 active)
3737 val)
3743 ;; Query the user for other things, perhaps.
3748 \f
3749 ;; We use /: as a prefix to "quote" a file name
3750 ;; so that magic file name handlers will not apply to it.
3754 file-name-handler-alist))
3756 ;; We depend on being the last handler on the list,
3757 ;; so that anything else which does need handling
3758 ;; has been handled already.
3759 ;; So it is safe for us to inhibit *all* magic file name handlers.
3768 default-directory))
3769 ;; Get a list of the indices of the args which are file names.
3772 ;; The first four are special because they
3773 ;; return a file name. We want to include the /:
3774 ;; in the return value.
3775 ;; So just avoid stripping it in the first place.
3777 ;; `identity' means just return the first arg
3778 ;; as stripped of its quoting.
3789 ;; For all other operations, treat the first argument only
3790 ;; as the file name.
3792 ;; Copy ARGUMENTS so we can replace elements in it.
3794 ;; Strip off the /: from the file names that have this handler.
3802 "/"
3808 \f
3831 ;;; files.el ends here