| blob | 3fa55ac80ad1084ba6f60f0468a7287abf194d56 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93,
4 ;; 94, 95, 96, 97, 98, 99, 2000 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 "Default `backup-enable-predicate' function.
138 Checks for files in `temporary-file-directory' or
139 `small-temporary-file-directory'."
142 ;; Directory is under temporary-file-directory.
147 0 nil
149 ;; Directory is under small-temporary-file-directory.
154 "Predicate that looks at a file name and decides whether to make backups.
158 "*Non-nil in a buffer means always offer to save buffer on exit.
159 Do so even if the buffer is not visiting a file.
160 Automatically local in all buffers."
166 "*Non-nil means find a file under alternative names, in existing buffers.
167 This means if any existing buffer is visiting the file you want
168 under another name, you get the existing buffer instead of a new buffer."
173 "*Non-nil means visit a file under its truename.
174 The truename of a file is found by chasing all links
175 both at the file level and at the levels of the containing directories."
180 nil
181 "*Specify which files should be reverted without query.
182 The value is a list of regular expressions.
183 If the file name matches one of these regular expressions,
184 then `revert-buffer' reverts the file without querying
185 if the file has changed on disk and you have not edited the buffer."
190 "The device number and file number of the file visited in the current buffer.
191 The value is a list of the form (FILENUM DEVNUM).
192 This pair of numbers uniquely identifies the file.
214 "*Non-nil means protect against I/O errors while saving files.
215 Some modes set this non-nil in particular buffers.
217 This feature works by writing the new contents into a temporary file
218 and then renaming the temporary file to replace the original.
219 In this way, any I/O error in writing leaves the original untouched,
220 and there is never any instant where the file is nonexistent.
222 Note that this feature forces backups to be made by copying.
223 Yet, at the same time, saving a precious file
224 breaks any hard links between it and other files."
229 "*Control use of version numbers for backup files.
230 t means make numeric backup versions unconditionally.
231 nil means make them for files that have some already.
232 `never' means do not make them."
240 "*When cleaning directory, number of versions to keep."
246 "*If t, delete excess backup versions silently.
247 If nil, ask confirmation. Any other value prevents any trimming."
254 "*Number of oldest versions to keep when a new numbered backup is made."
259 "*Number of newest versions to keep when a new numbered backup is made.
260 Includes the new backup. Must be > 0"
265 "*Value of t says silently ensure a file ends in a newline when it is saved.
266 Non-nil but not t says ask user whether to add a newline when there isn't one.
267 nil means don't add newlines."
274 "*Non-nil says by default do auto-saving of every file-visiting buffer."
279 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
280 Normally auto-save files are written under other names."
286 "*Transforms to apply to buffer file name before making auto-save file name.
287 Each transform is a list (REGEXP REPLACEMENT):
288 REGEXP is a regular expression to match against the file name.
289 If it matches, `replace-match' is used to replace the
290 matching part with REPLACEMENT.
291 All the transforms in the list are tried, in the order they are listed.
292 When one transform applies, its result is final;
293 no further transforms are tried.
295 The default value is set up to put the auto-save file into `/tmp'
296 for editing a remote file."
302 "*Non-nil means save word abbrevs too when files are saved.
303 Loading an abbrev file sets this to t."
308 "*Non-nil means allow `find-file' to visit directories.
309 To visit the directory, `find-file' runs `find-directory-functions'."
314 "*List of functions to try in sequence to visit a directory.
315 Each function is called with the directory name as the sole argument
316 and should return either a buffer or nil."
320 ;;;It is not useful to make this a local variable.
321 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
323 "List of functions to be called for `find-file' on nonexistent file.
324 These functions are called as soon as the error is detected.
325 Variable `buffer-file-name' is already set up.
328 ;;;It is not useful to make this a local variable.
329 ;;;(put 'find-file-hooks 'permanent-local t)
331 "List of functions to be called after a buffer is loaded from a file.
332 The buffer's local variables (if any) will have been processed before the
336 "List of functions to be called before writing out a buffer to a file.
337 If one of them returns non-nil, the file is considered already written
338 and the rest are not called.
339 These hooks are considered to pertain to the visited file.
340 So any buffer-local binding of `write-file-hooks' is
343 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
345 ;;; However, in case someone does make it local...
349 "Just like `write-file-hooks', except intended for per-buffer use.
350 The functions in this list are called before the ones in
351 `write-file-hooks'.
353 This variable is meant to be used for hooks that have to do with a
354 particular visited file. Therefore, it is a permanent local, so that
355 changing the major mode does not clear it. However, calling
361 "List of functions to be called before writing out a buffer to a file.
362 If one of them returns non-nil, the file is considered already written
363 and the rest are not called.
365 This variable is meant to be used for hooks that pertain to the
366 buffer's contents, not to the particular visited file; thus,
367 `set-visited-file-name' does not clear this variable; but changing the
368 major mode does clear it.
370 This variable automatically becomes buffer-local whenever it is set.
371 If you use `add-hook' to add elements to the list, use nil for the
372 LOCAL argument.
378 "*Control use of local variables in files you visit.
379 The value can be t, nil or something else.
380 A value of t means file local variables specifications are obeyed;
381 nil means they are ignored; anything else means query.
382 This variable also controls use of major modes specified in
383 a -*- line.
386 always obeys file local variable specifications and the -*- line,
387 and ignores this variable."
394 "Like `enable-local-variables' but meant for buffer-local bindings.
395 The meaningful values are nil and non-nil. The default is non-nil.
396 If a major mode sets this to nil, buffer-locally, then any local
397 variables list in the file will be ignored.
399 This variable does not affect the use of major modes
404 The value can be t, nil or something else.
405 A value of t means obey `eval' variables;
406 nil means ignore them; anything else means query.
409 and ignores this variable."
415 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
438 "The directory for writing small temporary files.
439 If non-nil, this directory is used instead of `temporary-file-directory'
440 by programs that create small temporary files. This is for systems that
443 ;; The system null device. (Should reference NULL_DEVICE from C.)
447 "Provides support for ange-ftp host name completion.
448 Runs the usual ange-ftp hook, but only for completion operations."
449 ;; Having this here avoids the need to load ange-ftp when it's not
450 ;; really in use.
456 inhibit-file-name-handlers)))
461 "Convert a standard file's name to something suitable for the current OS.
462 This function's standard definition is trivial; it just returns the argument.
463 However, on some systems, the function is redefined with a definition
464 that really does change some file names to canonicalize certain
465 patterns and to guarantee valid names."
466 filename)
467 \f
469 "Show the current default directory."
474 "Value of the CDPATH environment variable, as a list.
478 "Explode a colon-separated search path into a list of directory names.
479 \(For values of `colon' equal to `path-separator'.)"
480 ;; We could use split-string here.
488 nil
493 cd-list)))
496 "Change current directory to given absolute file name DIR."
497 ;; Put the name into directory syntax now,
498 ;; because otherwise expand-file-name may give some bad results.
511 "Make DIR become the current buffer's default directory.
512 If your environment includes a `CDPATH' variable, try each one of that
513 colon-separated list of directories when resolving a relative directory name."
516 default-directory default-directory
532 cd-path)
533 nil))
537 "Load the Lisp file named FILE."
544 "Load the library named LIBRARY.
545 This is an interface to the function `load'."
550 "Copy the file FILE into a temporary file on this machine.
551 Returns the name of the local copy, or nil, if FILE is directly
552 accessible."
553 ;; This formerly had an optional BUFFER argument that wasn't used by
554 ;; anything.
558 nil)))
561 "Return the truename of FILENAME, which should be absolute.
562 The truename of a file name is found by chasing symbolic links
563 both at the level of the file and at the level of the directories
564 containing it, until no links are left at any level.
566 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
567 Do not specify them in other calls."
568 ;; COUNTER can be a cons cell whose car is the count of how many more links
569 ;; to chase before getting an error.
570 ;; PREV-DIRS can be a cons cell whose car is an alist
571 ;; of truenames we've just recently computed.
573 ;; The last test looks dubious, maybe `+' is meant here? --simon.
583 ;; For speed, remove the ange-ftp completion handler from the list.
584 ;; We know it's not needed here.
585 ;; For even more speed, do this only on the outermost call.
592 ;; andrewi@harlequin.co.uk - none of the following code (except for
593 ;; invoking the file-name handler) currently applies on Windows
594 ;; (ie. there are no native symlinks), but there is an issue with
595 ;; case differences being ignored by the OS, and short "8.3 DOS"
596 ;; name aliases existing for all files. (The short names are not
597 ;; reported by directory-files, but can be used to refer to files.)
598 ;; It seems appropriate for file-truename to resolve these issues in
599 ;; the most natural way, which on Windows is to call the function
600 ;; `w32-long-file-name' - this returns the exact name of a file as
601 ;; it is stored on disk (expanding short name aliases with the full
602 ;; name in the process).
605 newname)
606 ;; For file name that has a special handler, call handler.
607 ;; This is so that ange-ftp can save time by doing a no-op.
610 ;; If filename contains a wildcard, newname will be the old name.
613 ;; If filename doesn't exist, newname will be nil.
618 ;; If this file directly leads to a link, process that iteratively
619 ;; so that we don't use lots of stack.
625 ;; For file name that has a special handler, call handler.
626 ;; This is so that ange-ftp can save time by doing a no-op.
629 done t)
631 target dirfile)
632 ;; Get the truename of the directory.
634 ;; If these are equal, we have the (or a) root directory.
636 ;; If this is the same dir we last got the truename for,
637 ;; save time--don't recalculate.
647 done t)
650 done t)
651 ;; Put it back on the file name.
653 ;; Is the file name the name of a link?
656 ;; Yes => chase that link, then start all over
657 ;; since the link may point to a directory name that uses links.
658 ;; We can't safely use expand-file-name here
659 ;; since target might look like foo/../bar where foo
660 ;; is itself a link. Instead, we handle . and .. above.
663 target
665 done nil)
666 ;; No, we are done!
668 filename))
671 "Chase links in FILENAME until a name that is not a link.
672 Does not examine containing directories for links,
673 unlike `file-truename'."
679 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
682 ;; Handle `..' by hand, since it needs to work in the
683 ;; target of any directory symlink.
684 ;; This code is not quite complete; it does not handle
685 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
689 ;; Chase links in the default dir of the symlink.
693 ;; Now find the parent of that dir.
697 newname))
698 \f
700 "Select buffer BUFFER in another window.
701 Optional second arg NORECORD non-nil means
702 do not put this buffer at the front of the list of recently selected ones."
708 "Switch to buffer BUFFER in another frame.
709 Optional second arg NORECORD non-nil means
710 do not put this buffer at the front of the list of recently selected ones."
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)
946 number
952 ;; Verify this buffer's file number
953 ;; still belongs to its file.
956 number))
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? "
1069 "Save file and revisit literally? "
1074 rawfile truename number))
1076 "Discard your edits and revisit file literally? "
1079 rawfile truename number)
1083 "Revisit file literally? "
1086 rawfile truename number)
1089 ;; Return the buffer we are using.
1090 buf)
1091 ;; Create a new buffer.
1094 ;; find-file-noselect-1 may use a different buffer.
1096 rawfile truename number))))))
1100 error)
1103 ;; Needed in case we are re-visiting the file with a different
1104 ;; text representation.
1118 filename)))
1119 ;; Unconditionally set error
1128 filename)))
1129 ;; Run find-file-not-found-hooks until one returns non-nil.
1131 ;; If they fail too, set error.
1133 ;; Record the file's truename, and maybe use that as visited name.
1139 ;; On VMS, we may want to remember which directory in a search list
1140 ;; the file was found in.
1152 ;; Set buffer's default directory to that of the file.
1154 ;; Turn off backup files for certain file names. Since
1155 ;; this is a permanent local, the major mode won't eliminate it.
1168 \f
1170 "Like `insert-file-contents', but only reads in the file literally.
1171 A buffer may be modified in several ways after reading into the buffer,
1172 to Emacs features such as format decoding, character code
1173 conversion, find-file-hooks, automatic uncompression, etc.
1175 This function ensures that none of these modifications will take place."
1184 nil)))
1194 "Insert contents of file FILENAME into buffer after point with no conversion.
1196 This function is meant for the user to run interactively.
1197 Don't call it from programs! Use `insert-file-contents-literally' instead.
1198 \(Its calling sequence is different; see its documentation)."
1202 filename)))
1207 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1212 "Visit file FILENAME with no conversion of any kind.
1213 Format conversion and character code conversion are both disabled,
1214 and multibyte characters are disabled in the resulting buffer.
1215 The major mode used is Fundamental mode regardless of the file name,
1216 and local variable specifications in the file are ignored.
1217 Automatic uncompression is also disabled.
1219 You cannot absolutely rely on this function to result in
1220 visiting the file literally. If Emacs already has a buffer
1221 which is visiting the file, you get the existing buffer,
1222 regardless of whether it was created literally or not.
1224 In a Lisp program, if you want to be sure of accessing a file's
1225 contents literally, you should create a temporary buffer and then read
1226 the file contents into it using `insert-file-contents-literally'."
1229 \f
1233 after-find-file-from-revert-buffer
1234 nomodes)
1235 "Called after finding a file and by the default revert function.
1236 Sets buffer mode, parses local variables.
1237 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1238 error in reading the file. WARN non-nil means warn if there
1239 exists an auto-save file more recent than the visited file.
1240 NOAUTO means don't mess with auto-save mode.
1241 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1242 means this call was from `revert-buffer'.
1243 Fifth arg NOMODES non-nil means don't alter the file's modes.
1244 Finishes by calling the functions in `find-file-hooks'
1245 unless NOMODES is non-nil."
1248 nil
1258 ;; No need to warn if buffer is auto-saved
1259 ;; under the name of the visited file.
1261 auto-save-visited-file-name))
1264 buffer-file-name))
1278 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1279 "Use M-x make-directory RET RET to create the directory"
1286 ;; Make people do a little extra work (C-x C-q)
1287 ;; before altering a backup file.
1295 view-read-only
1301 "Choose the major mode for this buffer automatically.
1302 Also sets up any specified local variables of the file.
1303 Uses the visited file name, the -*- line, and the local variables spec.
1305 This function is called automatically from `find-file'. In that case,
1306 we may set up the file-specified mode and local variables,
1307 depending on the value of `enable-local-variables': if it is t, we do;
1308 if it is nil, we don't; otherwise, we query.
1309 In addition, if `local-enable-local-variables' is nil, we do
1310 not set local variables (though we do notice a mode specified with -*-.)
1312 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1313 or from Lisp without specifying the optional argument FIND-FILE;
1314 in that case, this function acts as if `enable-local-variables' were t."
1323 enable-local-variables)))
1364 ;;; Less common extensions come here
1365 ;;; so more common ones above are found faster.
1375 ;; for MSDOS and MS-Windows (which are case-insensitive)
1419 ;; Mailer puts message to be edited in
1420 ;; /tmp/Re.... or Message
1425 ;; some news reader is reported to use this
1435 ;; .emacs following a directory delimiter
1436 ;; in Unix, MSDOG or VMS syntax.
1439 ;; _emacs following a directory delimiter
1440 ;; in MsDos syntax
1457 ;; Get rid of any trailing .n.m and try again.
1458 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1459 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~
1461 ;;; The following should come after the ChangeLog pattern
1462 ;;; for the sake of ChangeLog.1, etc.
1463 ;;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1465 "Alist of filename patterns vs corresponding major mode functions.
1466 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1467 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1468 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1469 mode function to use. FUNCTION will be called, unless it is nil.
1471 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1472 calling FUNCTION (if it's not nil), we delete the suffix that matched
1518 "Alist mapping interpreter names to major modes.
1519 This alist applies to files whose first line starts with `#!'.
1520 Each element looks like (INTERPRETER . MODE).
1521 The car of each element is compared with
1522 the name of the interpreter specified in the first line.
1529 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1530 When checking `inhibit-first-line-modes-regexps', we first discard
1536 "Regular expression matching interpreters, for file mode determination.
1537 This regular expression is matched against the first line of a file
1538 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1539 a mode from the file's name. If it matches, the file is assumed to
1540 be interpreted by the interpreter matched by the second group of the
1541 regular expression. The mode is then determined as the mode associated
1545 "Select major mode appropriate for current buffer.
1546 This checks for a -*- mode tag in the buffer's text,
1547 compares the filename against the entries in `auto-mode-alist',
1548 or checks the interpreter that runs this file against
1549 `interpreter-mode-alist'.
1551 It does not check for the `mode:' local variable in the
1552 Local Variables section of the file; for that, use `hack-local-variables'.
1554 If `enable-local-variables' is nil, this function does not check for a
1555 -*- mode tag.
1557 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1558 then we do not set anything but the major mode,
1559 and we don't even do that unless it would come from the file name."
1560 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1566 ;; Don't look for -*- if this file name matches any
1567 ;; of the regexps in inhibit-first-line-modes-regexps.
1575 sufs)
1582 ;; If the file begins with "#!"
1583 ;; (exec interpreter magic), look
1584 ;; for mode frobs in the first two
1585 ;; lines. You cannot necessarily
1586 ;; put them in the first line of
1587 ;; such a file without screwing up
1588 ;; the interpreter invocation.
1596 t))
1603 ;; Find all specifications for the `mode:' variable
1604 ;; and execute them left to right.
1616 modes))
1617 ;; Simple -*-MODE-*- case.
1620 modes)))))
1621 ;; If we found modes to use, invoke them now,
1622 ;; outside the save-excursion.
1629 ;; If we didn't find a mode from a -*- line, try using the file name.
1633 ;; Remove backup-suffixes from file name.
1639 ;; Find first matching alist entry.
1648 keep-going t)
1650 keep-going nil)))
1653 ;; When JUST-FROM-FILE-NAME is set,
1654 ;; we are working on behalf of set-visited-file-name.
1655 ;; In that case, if the major mode specified is the
1656 ;; same one we already have, don't actually reset it.
1657 ;; We don't want to lose minor modes such as Font Lock.
1660 ;; If we can't deduce a mode from the file name,
1661 ;; look for an interpreter specified in the first line.
1662 ;; As a special case, allow for things like "#!/bin/env perl",
1663 ;; which finds the interpreter anywhere in $PATH.
1670 elt)
1671 ;; Map interpreter name to a mode.
1673 interpreter-mode-alist))
1679 "Set local variables specified in the -*- line.
1680 Ignore any specification for `mode:' and `coding:';
1681 `set-auto-mode' should already have handled `mode:',
1682 `set-auto-coding' should already have handled `coding:'."
1689 ;; Parse the -*- line into the `result' alist.
1691 ;; doesn't have one.
1692 nil)
1694 ;; Simple form: "-*- MODENAME -*-". Already handled.
1695 nil)
1697 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1698 ;; (last ";" is optional).
1707 ;; There used to be a downcase here,
1708 ;; but the manual didn't say so,
1709 ;; and people want to set var names that aren't all lc.
1716 ;; It is traditional to ignore
1717 ;; case when checking for `mode' in set-auto-mode,
1718 ;; so we must do that here as well.
1719 ;; That is inconsistent, but we're stuck with it.
1720 ;; The same can be said for `coding' in set-auto-coding.
1734 ;; If we fail to switch in the selected window,
1735 ;; it is probably a minibuffer.
1736 ;; So try another window.
1749 "Normal hook run after processing a file's local variables specs.
1750 Major modes can use this to examine user-specified local variables
1754 "Parse and put into effect this buffer's local variables spec.
1755 If MODE-ONLY is non-nil, all we do is check whether the major mode
1756 is specified, returning t if it is specified."
1759 ;; Look for "Local variables:" line in last page.
1769 mode-only
1779 buffer-file-name)
1783 prefix prefixlen suffix beg
1784 mode-specified
1786 ;; The prefix is what comes before "local variables:" in its line.
1787 ;; The suffix is what comes after "local variables:" in its line.
1802 ;; Look at next local variable spec.
1805 ;; Skip the prefix, if any.
1810 ;; Find the variable name; strip whitespace.
1818 val)
1819 ;; Setting variable named "end" means end of list.
1822 ;; Otherwise read the variable value.
1833 ;; Set the variable. "Variables" mode and eval are funny.
1837 mode-specified))
1843 ;; Get confirmation before setting these variables as locals in a file.
1860 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1864 ;; This one is safe because the user gets to check it before it is used.
1872 A few variable names are treated specially."
1877 ;; We have already handled coding: tag in set-auto-coding.
1878 nil)
1880 nil)
1881 ;; "Setting" eval means either eval it or do nothing.
1882 ;; Likewise for setting hook variables.
1888 ;; Permit evalling a put of a harmless property.
1889 ;; if the args do nothing tricky.
1895 ;; Only allow safe values of lisp-indent-hook;
1896 ;; not functions.
1901 ;; Permit eval if not root and user says ok.
1920 ;; Ordinary variable, really set it.
1924 \f
1927 However, the mode will not be changed if
1928 \(1) a local variables list or the `-*-' line specifies a major mode, or
1930 \ not suitable for ordinary files, or
1931 \(3) the new file name does not particularly specify any mode."
1936 "Change name of file visited in current buffer to FILENAME.
1937 The next time the buffer is saved it will go in the newly specified file.
1938 nil or empty string as argument means make buffer not be visiting any file.
1939 Remember to delete the initial contents of the minibuffer
1940 if you wish to pass an empty string as the argument.
1942 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1943 confirmation in the case where another buffer is already visiting FILENAME.
1945 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1946 the old visited file has been renamed to the new name FILENAME."
1954 nil
1965 filename)))
1984 ;; Abbreviate the file names of the buffer.
1993 nil)))
1994 ;; write-file-hooks is normally used for things like ftp-find-file
1995 ;; that visit things that are not local files as if they were files.
1996 ;; Changing to visit an ordinary local file instead should flush the hook.
2001 ;; If buffer was read-only because of version control,
2002 ;; that reason is gone now, so make it writable.
2006 ;; Turn off backup files for certain file names.
2007 ;; Since this is a permanent local, the major mode won't eliminate it.
2014 ;; If auto-save was not already on, turn it on if appropriate.
2018 ;; If auto save is on, start using a new name.
2019 ;; We deliberately don't rename or delete the old auto save
2020 ;; for the old visited file name. This is because perhaps
2021 ;; the user wants to save the new state and then compare with the
2022 ;; previous state from the auto save file.
2025 ;; Rename the old auto save file if any.
2032 ;; Update the major mode, if the file name determines it.
2034 ;; Don't change the mode if it is special.
2037 ;; Don't change the mode if the local variable list specifies it.
2043 "Write current buffer into file FILENAME.
2044 This makes the buffer visit that file, and marks it as not modified.
2046 If you specify just a directory name as FILENAME, that means to use
2047 the default file name but in that directory. You can also yank
2048 the default file name into the minibuffer to edit it, using M-n.
2050 If the buffer is not already visiting a file, the default file name
2051 for the output file is the buffer name.
2053 If optional second arg CONFIRM is non-nil, this function
2054 asks for confirmation before overwriting an existing file.
2055 Interactively, confirmation is required unless you supply a prefix argument."
2056 ;; (interactive "FWrite file: ")
2060 nil nil nil nil)
2064 default-directory)
2065 nil nil))
2069 ;; If arg is just a directory,
2070 ;; use the default file name, but in that directory.
2081 ;; Make buffer writable if file is writable.
2086 \f
2088 "Make a backup of the disk file visited by the current buffer, if appropriate.
2089 This is normally done before saving the buffer the first time.
2090 If the value is non-nil, it is the result of `file-modes' on the original
2091 file; this means that the caller, after saving the buffer, should change
2092 the modes of the new file to agree with the old modes.
2094 A backup may be done by renaming or by copying; see documentation of
2095 variable `make-backup-files'. If it's done by renaming, then the file is
2096 no longer accessible under its old name."
2103 backup-info backupname targets setmodes)
2104 ;; If specified name is a symbolic link, chase it to the target.
2105 ;; Thus we make the backups in the directory where the real file is.
2110 ;;; (if (file-directory-p buffer-file-name)
2111 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
2115 ;; If have old versions to maybe delete,
2116 ;; ask the user to confirm now, before doing anything.
2117 ;; But don't actually delete til later.
2122 real-file-name))))))
2123 ;; Actually write the back up file.
2126 ; (file-symlink-p buffer-file-name)
2127 backup-by-copying
2142 ;; If copying fails because file BACKUPNAME
2143 ;; is not writable, delete that file and try again.
2148 ;; rename-file should delete old backup.
2152 ;; If trouble writing the backup, write it in ~.
2162 ;; If copying fails because file BACKUPNAME
2163 ;; is not writable, delete that file and try again.
2169 ;; Now delete the old versions, if desired.
2176 setmodes)
2180 "Return file NAME sans backup versions or strings.
2181 This is a separate procedure so your site-init or startup file can
2182 redefine it.
2183 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2184 we do not remove backup version numbers, only true file version numbers."
2190 ;; VMS version number is (a) semicolon, optional
2191 ;; sign, zero or more digits or (b) period, option
2192 ;; sign, zero or more digits, provided this is the
2193 ;; second period encountered outside of the
2194 ;; device/directory part of the file name.
2197 name)
2207 "Return t if deleting FILE and rewriting it would preserve the owner."
2212 ;; Return t if the file doesn't exist, since it's true that no
2213 ;; information would be lost by an (attempted) delete and create.
2219 The extension, in a file name, is the part that follows the last `.'."
2222 directory)
2226 directory)
2228 filename))))
2232 The extension, in a file name, is the part that follows the last `.'.
2233 Return nil for extensionless file names such as `foo'.
2234 Return the empty string for file names such as `foo.'.
2236 If PERIOD is non-nil, then the returned value includes the period
2237 that delimits the extension, and if FILENAME has no extension,
2247 "A function to use instead of the default `make-backup-file-name'.
2248 A value of nil gives the default `make-backup-file-name' behaviour.
2250 This could be buffer-local to do something special for for specific
2251 files. If you define it, you may need to change `backup-file-name-p'
2252 and `file-name-sans-versions' too.
2254 See also `backup-directory-alist'."
2260 "Alist of filename patterns and backup directory names.
2261 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2262 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2263 relative or absolute. If it is absolute, so that all matching files
2264 are backed up into the same directory, the file names in this
2265 directory will be the full name of the file backed up with all
2266 directory separators changed to `!' to prevent clashes. This will not
2267 work correctly if your filesystem truncates the resulting name.
2269 For the common case of all backups going into one directory, the alist
2271 directory name.
2273 If this variable is nil, or it fails to match a filename, the backup
2274 is made in the original file's directory.
2276 On MS-DOS filesystems without long names this variable is always
2277 ignored."
2283 "Create the non-numeric backup file name for FILE.
2284 Normally this will just be the file's name with `~' appended.
2285 Customization hooks are provided as follows.
2287 If the variable `make-backup-file-name-function' is non-nil, its value
2288 should be a function which will be called with FILE as its argument;
2289 the resulting name is used.
2291 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2292 the documentation of that variable. If the directory for the backup
2293 doesn't exist, it is created."
2307 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2309 elt backup-directory dir-sep-string)
2314 alist nil)))
2316 file
2324 ;; Normalize DOSish file names: convert all slashes to
2325 ;; directory-sep-char, downcase the drive letter, if any,
2326 ;; and replace the leading "x:" with "/drive_x".
2329 ;; Replace any invalid file-name characters (for the
2330 ;; case of backing up remote files).
2335 "drive_"
2338 ""
2339 dir-sep-string)
2341 ;; Make the name unique by substituting directory
2342 ;; separators. It may not really be worth bothering about
2343 ;; doubling `!'s in the original name...
2346 directory-sep-char ?!
2348 backup-directory))
2355 "Return non-nil if FILE is a backup file name (numeric or not).
2356 This is a separate function so you can redefine it for customization.
2357 You may need to redefine `file-name-sans-versions' as well."
2362 ;; This is used in various files.
2363 ;; The usage of backup-extract-version-start is not very clean,
2364 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2366 "Given the name of a numeric backup file, FN, return the backup number.
2367 Uses the free variable `backup-extract-version-start', whose value should be
2368 the index in the name where the version number begins."
2374 ;; I believe there is no need to alter this behavior for VMS;
2375 ;; since backup files are not made on VMS, it should not get called.
2377 "Find a file name for a backup file FN, and suggestions for deletions.
2378 Value is a list whose car is the name for the backup file
2379 and whose cdr is a list of old versions to consider deleting now.
2380 If the value is nil, don't make a backup.
2381 Uses `backup-directory-alist' in the same way as does
2382 `make-backup-file-name'."
2384 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2388 ;; We don't support numbered backups on plain MS-DOS
2389 ;; when long file names are unavailable.
2399 possibilities deserve-versions-p versions)
2402 base-versions
2405 possibilities)
2406 #'<)
2411 kept-old-versions
2412 kept-new-versions
2419 ;; Delete nothing if there is overflow
2420 ;; in the number of versions to keep.
2426 v))))))))))
2429 "Return number of names file FILENAME has."
2433 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2434 This function returns a relative file name which is equivalent to FILENAME
2435 when used with that default directory as the default.
2436 If this is impossible (which can happen on MSDOS and Windows
2437 when the file name and directory use different drive names)
2438 then it returns FILENAME."
2443 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2444 ;; drive names, they can't be relative, so return the absolute name.
2449 filename
2456 ".."
2458 ;; Now ancestor is empty, or .., or ../.., etc.
2460 ;; We matched within FNAME's directory part.
2461 ;; Add the rest of FNAME onto ANCESTOR.
2465 ;; But don't bother with ANCESTOR if it would give us `./'.
2466 rest
2468 ;; We matched FNAME's directory equivalent.
2469 ancestor))))))
2470 \f
2472 "Save current buffer in visited file if modified. Versions described below.
2473 By default, makes the previous version into a backup file
2474 if previously requested or if this is the first save.
2476 to become a backup when the next save is done.
2478 unconditionally makes the previous version into a backup file.
2480 to become a backup when the next save is done,
2481 and unconditionally makes the previous version into a backup file.
2483 With argument of 0, never make the previous version into a backup file.
2485 If a file's name is FOO, the names of its numbered backup versions are
2486 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2487 Numeric backups (rather than FOO~) will be made if value of
2488 `version-control' is not the atom `never' and either there are already
2489 numeric versions of the file being backed up, or `version-control' is
2490 non-nil.
2491 We don't want excessive versions piling up, so there are variables
2492 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2493 and `kept-new-versions', which tells how many newest versions to keep.
2494 Defaults are 2 old versions and 2 new.
2495 `dired-kept-versions' controls dired's clean-directory (.) command.
2496 If `delete-old-versions' is nil, system will query user
2497 before trimming versions. Otherwise it does it silently.
2499 If `vc-make-backup-files' is nil, which is the default,
2500 no backup files are made for files managed by version control.
2501 (This is because the version control system itself records previous versions.)
2503 See the subroutine `basic-save-buffer' for more information."
2515 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2516 Normally delete only if the file was written by this Emacs since
2517 the last real save, but optional arg FORCE non-nil means delete anyway."
2531 "Normal hook that is run after a buffer is saved to its file."
2537 "If non-nil, use this coding system for saving the buffer.
2538 More precisely, use this coding system in place of the
2539 value of `buffer-file-coding-system', when saving the buffer.
2540 Calling `write-region' for any purpose other than saving the buffer
2541 will still use `buffer-file-coding-system'; this variable has no effect
2548 "Save the current buffer in its visited file, if it has been modified.
2549 The hooks `write-contents-hooks', `local-write-file-hooks' and
2550 `write-file-hooks' get a chance to do the job of saving; if they do not,
2551 then the buffer is saved in the visited file file in the usual way.
2552 After saving the buffer, this function runs `after-save-hook'."
2555 ;; In an indirect buffer, save its base buffer instead.
2560 setmodes tempsetmodes)
2561 ;; On VMS, rename file and buffer to get rid of version number.
2566 ;; Strip VMS version number before save.
2569 ;; Construct a (unique) buffer name to correspond.
2574 ;; If buffer has no file name, ask user for one.
2581 filename))
2605 ;; Support VC version backups.
2610 ;; If a hook returned t, file is already "written".
2611 ;; Otherwise, write it the usual way now.
2613 ;; Now we have saved the current buffer. Let's make sure
2614 ;; that buffer-file-coding-system is fixed to what
2615 ;; actually used for saving by binding it locally.
2625 ;; If the auto-save file was recent before this command,
2626 ;; delete it now.
2628 ;; Support VC `implicit' locking.
2633 ;; This does the "real job" of writing a buffer into its visited file
2634 ;; and making a backup file. This is what is normally done
2635 ;; but inhibited if one of write-file-hooks returns non-nil.
2636 ;; It returns a value to store in setmodes.
2656 buffer-file-name)))
2664 ;; If file is precious, write temp name, then rename it.
2665 ;; This requires write access to the containing dir,
2666 ;; which is why we don't try it if we don't have that access.
2668 tempname temp nogood i succeed
2672 ;; Find the temporary name to write under.
2679 "%s$tmp$%d"
2681 dir i))
2687 tempname nil realname
2688 buffer-file-truename)
2690 ;; If writing the temp file fails,
2691 ;; delete the temp file.
2696 ;; Since we have created an entirely new file
2697 ;; and renamed it, make sure it gets the
2698 ;; right permission bits set.
2700 ;; We succeeded in writing the temp file,
2701 ;; so rename it.
2703 ;; If file not writable, see if we can make it writable
2704 ;; temporarily while we write it.
2705 ;; But no need to do so if we have just backed it up
2706 ;; (setmodes is set) because that says we're superseding.
2708 ;; Change the mode back, after writing.
2712 buffer-file-name nil t buffer-file-truename)))
2713 setmodes))
2716 "Save some modified file-visiting buffers. Asks user about each one.
2717 Optional argument (the prefix) non-nil means save all with no questions.
2718 Optional second argument PRED determines which buffers are considered:
2719 If PRED is nil, all the file-visiting buffers are considered.
2720 If PRED is t, then certain non-file buffers will also be considered.
2721 If PRED is a zero-argument function, it indicates for each buffer whether
2722 to consider it or not when called with that buffer current."
2741 t
2760 ;; Return nil to ask about BUF again.
2761 nil)
2768 abbrev-file-name)))
2770 ;; Don't keep bothering user if he says no.
2772 t))))
2775 \f
2777 "Mark current buffer as unmodified, not needing to be saved.
2780 It is not a good idea to use this function in Lisp programs, because it
2781 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2788 "Change whether this buffer is visiting its file read-only.
2789 With arg, set read-only iff arg is positive.
2790 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2796 ;; Toggle.
2808 "Insert contents of file FILENAME into buffer after point.
2809 Set mark after the inserted text.
2811 This function is meant for the user to run interactively.
2812 Don't call it from programs! Use `insert-file-contents' instead.
2813 \(Its calling sequence is different; see its documentation)."
2817 filename)))
2822 "Append the contents of the region to the end of file FILENAME.
2823 When called from a function, expects three arguments,
2824 START, END and FILENAME. START and END are buffer positions
2825 saying what text to write."
2830 "Return most recent backup file for FILENAME or nil if no backups exist."
2831 ;; `make-backup-file-name' will get us the right directory for
2832 ;; ordinary or numeric backups. It might create a directory for
2833 ;; backups as a side-effect, according to `backup-directory-alist'.
2840 tem)
2849 newest))
2852 "Rename current buffer to a similar name not already taken.
2853 This function is useful for creating multiple shell process buffers
2854 or multiple mail buffers, etc."
2862 ;; If the existing buffer name has a <NNN>,
2863 ;; which isn't part of the file name (if any),
2864 ;; then get rid of that.
2870 "Create the directory DIR and any nonexistent parent dirs.
2871 Interactively, the default choice of directory to create
2872 is the current default directory for file names.
2873 That is useful when you have visited a file in a nonexistent directory.
2875 Noninteractively, the second (optional) argument PARENTS says whether
2876 to create parent directories if they don't exist."
2879 nil nil)
2880 t))
2887 create-list)
2894 \f
2897 "Function to use to revert this buffer, or nil to do the default.
2898 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2903 "Function to use to insert contents when reverting this buffer.
2904 Gets two args, first the nominal file name to use,
2905 and second, t if reading the auto-save file.
2910 "Normal hook for `revert-buffer' to run before reverting.
2911 If `revert-buffer-function' is used to override the normal revert
2915 "Normal hook for `revert-buffer' to run after reverting.
2916 Note that the hook value that it runs is the value that was in effect
2917 before reverting; that makes a difference if you have buffer-local
2918 hook functions.
2920 If `revert-buffer-function' is used to override the normal revert
2926 "Replace current buffer text with the text of the visited file on disk.
2927 This undoes all changes since the file was visited or saved.
2928 With a prefix argument, offer to revert from latest auto-save file, if
2929 that is more recent than the visited file.
2931 This command also works for special buffers that contain text which
2932 doesn't come from a file, but reflects some other data base instead:
2933 for example, Dired buffers and buffer-list buffers. In these cases,
2934 it reconstructs the buffer contents from the appropriate data base.
2936 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2937 to revert from the auto-save file when this is nil. Note that the
2938 sense of this argument is the reverse of the prefix argument, for the
2939 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2940 to nil.
2942 Optional second argument NOCONFIRM means don't ask for confirmation at
2943 all. (The local variable `revert-without-query', if non-nil, prevents
2944 confirmation.)
2946 Optional third argument PRESERVE-MODES non-nil means don't alter
2947 the files modes. Normally we reinitialize them using `normal-mode'.
2949 If the value of `revert-buffer-function' is non-nil, it is called to
2950 do all the work for this command. Otherwise, the hooks
2951 `before-revert-hook' and `after-revert-hook' are run at the beginning
2952 and the end, and if `revert-buffer-insert-file-contents-function' is
2953 non-nil, it is called instead of rereading visited file contents."
2955 ;; I admit it's odd to reverse the sense of the prefix argument, but
2956 ;; there is a lot of code out there which assumes that the first
2957 ;; argument should be t to avoid consulting the auto-save file, and
2958 ;; there's no straightforward way to encourage authors to notice a
2959 ;; reversal of the argument sense. So I'm just changing the user
2960 ;; interface, but leaving the programmatic interface the same.
2966 buffer-auto-save-file-name
2971 buffer-auto-save-file-name
2972 buffer-file-name)))
2983 found))
2985 file-name)))
2987 ;; If file was backed up but has changed since,
2988 ;; we shd make another backup.
2992 ;; Get rid of all undo records for this buffer.
2995 ;; Effectively copy the after-revert-hook status,
2996 ;; since after-find-file will clobber it.
3000 after-revert-hook)))
3002 ;; Don't make undo records for the reversion.
3006 file-name auto-save-p)
3009 ;; Bind buffer-file-name to nil
3010 ;; so that we don't try to lock the file.
3016 ;; Auto-saved file shoule be read without
3017 ;; any code conversion.
3019 coding-system-for-read)))
3020 ;; Note that this preserves point in an intelligent way.
3022 nil nil t))))
3023 ;; Recompute the truename in case changes in symlinks
3024 ;; have changed the truename.
3028 ;; Run after-revert-hook as it was before we reverted.
3036 t)))))
3039 "Visit file FILE, but get contents from its last auto-save file."
3040 ;; Actually putting the file name in the minibuffer should be used
3041 ;; only rarely.
3042 ;; Not just because users often use the default.
3066 ;; Keep the current buffer-file-coding-system.
3068 ;; Auto-saved file shoule be read without any code conversion.
3077 "Recover auto save files from a previous Emacs session.
3078 This command first displays a Dired buffer showing you the
3079 previous sessions that you could recover from.
3080 To choose one, move point to the proper line and then type C-c C-c.
3081 Then you'll be asked about a number of files to recover."
3095 ;; Each line starts with a space
3096 ;; so that Font Lock mode won't highlight the first character.
3105 "Choose one saved session to recover auto-save files from.
3106 This command is used in the special Dired buffer created by
3109 ;; Get the name of the session file to recover from.
3111 files
3117 ;; Read in the auto-save-list file.
3121 ;; Loop thru the text of that file
3122 ;; and get out the names of the files to recover.
3126 ;; This is a pair of lines for a non-file-visiting buffer.
3127 ;; Get the auto-save file name and manufacture
3128 ;; a "visited file name" from that.
3144 ;; This pair of lines is a file-visiting
3145 ;; buffer. Use the visited file name.
3155 ;; Ignore a file if its auto-save file does not exist now.
3159 ;; The file contains a pair of line for each auto-saved buffer.
3160 ;; The first line of the pair contains the visited file name
3161 ;; or is empty if the buffer was not visiting a file.
3162 ;; The second line is the auto-save file name.
3170 files
3176 "For each buffer in LIST, ask whether to kill it.
3177 LIST defaults to all existing live buffers."
3188 name
3193 \f
3195 "Toggle auto-saving of contents of current buffer.
3196 With prefix argument ARG, turn auto-saving on if positive, else off."
3201 ;; If auto-save is off because buffer has shrunk,
3202 ;; then toggling should turn it on.
3207 buffer-file-name
3209 ;; If -1 was stored here, to temporarily turn off saving,
3210 ;; turn it back on.
3216 buffer-auto-save-file-name)
3219 "Adjust current buffer's auto save file name for current conditions.
3220 Also rename any existing auto save file, if it was made in this session."
3232 "Return file name to use for auto-saves of current buffer.
3233 Does not consider `auto-save-visited-file-name' as that variable is checked
3234 before calling this function. You can redefine this for customization.
3235 See also `auto-save-file-name-p'."
3239 result)
3240 ;; Apply user-specified translations
3241 ;; to the file name.
3245 filename)))
3257 "#"
3261 ;; Deal with buffers that don't have any associated files. (Mail
3262 ;; mode tends to create a good number of these.)
3266 ;; Eliminate all slashes and backslashes by
3267 ;; replacing them with sequences that start with %.
3268 ;; Quote % also, to keep distinct names distinct.
3277 ;; Generate the file name.
3280 ;; Try a few alternative directories, to get one we can write it.
3287 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3288 FILENAME should lack slashes. You can redefine this for customization."
3290 \f
3292 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3293 The generated regexp will match a filename iff the filename
3294 matches that wildcard according to shell rules. Only wildcards known
3295 by `sh' are supported."
3297 ;; Copy the initial run of non-special characters.
3300 ;; If no special characters, we're almost done.
3304 j)
3306 result
3327 ;; Found "[^". Insert a `\0' character
3328 ;; (which cannot happen in a filename)
3329 ;; into the character class, so that `^'
3330 ;; is not the first character after `[',
3331 ;; and thus non-special in a regexp.
3336 ;; I don't think `]' can appear in a
3337 ;; character class in a wildcard, but
3338 ;; let's be general here.
3345 i
3358 ;; Shell wildcards should match the entire filename,
3359 ;; not its part. Make the regexp say so.
3361 \f
3364 "*Switches for `list-directory' to pass to `ls' for brief listing."
3370 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3372 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3377 "Expand wildcard pattern PATTERN.
3378 This returns a list of file names which match the pattern.
3380 If PATTERN is written as an absolute relative file name,
3381 the values are absolute also.
3383 If PATTERN is written as a relative file name, it is interpreted
3384 relative to the current default directory, `default-directory'.
3385 The file names returned are normally also relative to the current
3386 default directory. However, if FULL is non-nil, they are absolute."
3389 ;; A list of all dirs that DIRPART specifies.
3390 ;; This can be more than one dir
3391 ;; if DIRPART contains wildcards.
3396 contents)
3401 ;; Filter out "." and ".."
3406 name))
3413 this-dir-contents)
3414 this-dir-contents)
3415 contents))))
3417 contents))
3420 "Display a list of files in or matching DIRNAME, a la `ls'.
3421 DIRNAME is globbed by the shell if necessary.
3422 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3423 Actions controlled by variables `list-directory-brief-switches'
3424 and `list-directory-verbose-switches'."
3428 nil default-directory nil)
3429 pfx)))
3431 list-directory-brief-switches)))
3449 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3451 PATTERN is assumed to represent a file-name wildcard suitable for the
3452 underlying filesystem. For Unix and GNU/Linux, the characters from the
3454 the parts of the pattern which don't include wildcard characters are
3455 quoted with double quotes.
3456 Existing quote characters in PATTERN are left alone, so you can pass
3457 PATTERN that already quotes some of the special characters."
3461 ;; DOS/Windows don't allow `"' in file names. So if the
3462 ;; argument has quotes, we can safely assume it is already
3463 ;; quoted by the caller.
3465 ;; We quote [&()#$'] in case their shell is a port of a
3466 ;; Unixy shell. We quote [,=+] because stock DOS and
3467 ;; Windows shells require that in some cases, such as
3468 ;; passing arguments to batch files that use positional
3469 ;; arguments like %1.
3471 pattern
3474 end)
3491 pattern))))
3497 ;; insert-directory
3498 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3499 ;; FULL-DIRECTORY-P is nil.
3500 ;; The single line of output must display FILE's name as it was
3501 ;; given, namely, an absolute path name.
3502 ;; - must insert exactly one line for each file if WILDCARD or
3503 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3504 ;; before the file lines, plus optional text after the file lines.
3505 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3506 ;; allowed.
3507 ;; File lines should display the basename.
3508 ;; - must be consistent with
3509 ;; - functions dired-move-to-filename, (these two define what a file line is)
3510 ;; dired-move-to-end-of-filename,
3511 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3512 ;; dired-insert-headerline
3513 ;; dired-after-subdir-garbage (defines what a "total" line is)
3514 ;; - variable dired-subdir-regexp
3516 "Insert directory listing for FILE, formatted according to SWITCHES.
3517 Leaves point after the inserted text.
3518 SWITCHES may be a string of options, or a list of strings.
3519 Optional third arg WILDCARD means treat FILE as shell wildcard.
3520 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3521 switches do not contain `d', so that a full listing is expected.
3523 This works by running a directory listing program
3524 whose name is in the variable `insert-directory-program'.
3525 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3526 ;; We need the directory in order to find the right handler.
3531 wildcard full-directory-p)
3537 default-file-name-coding-system)))
3538 ;; This is to control encoding the arguments in call-process.
3542 ;; Run ls in the directory of the file pattern we asked for
3549 shell-file-name nil t nil
3551 ""
3553 insert-directory-program
3554 " -d "
3556 switches
3558 " -- "
3559 ;; Quote some characters that have
3560 ;; special meanings in shells; but
3561 ;; don't quote the wildcards--we
3562 ;; want them to be special. We
3563 ;; also currently don't quote the
3564 ;; quoting characters in case
3565 ;; people want to use them
3566 ;; explicitly to quote wildcard
3567 ;; characters.
3569 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3570 ;; directory if FILE is a symbolic link.
3572 insert-directory-program nil t nil
3576 ;; Split the switches at any spaces so we can
3577 ;; pass separate options as separate args.
3579 ;; Avoid lossage if FILE starts with `-'.
3587 file))))))))
3589 ;; We get here if `insert-directory-program' failed.
3590 ;; On non-Posix systems, we cannot open a directory, so
3591 ;; don't even try, because that will always result in
3592 ;; the ubiquitous "Access denied". Instead, show them
3593 ;; the `ls' command line and let them guess what went
3594 ;; wrong.
3599 insert-directory-program
3601 file result)
3602 ;; Unix. Access the file to get a suitable error.
3604 ;; Replace "total" with "used", to avoid confusion.
3605 ;; Add in the amount of free space.
3624 "Functions to call with no arguments to query about killing Emacs.
3625 If any of these functions returns nil, killing Emacs is cancelled.
3627 but `kill-emacs', the low level primitive, does not.
3631 "Offer to save each buffer, then kill this Emacs process.
3632 With prefix arg, silently save all file-visiting buffers, then kill."
3641 ;; process-list is not defined on VMS.
3643 active)
3648 val)
3654 ;; Query the user for other things, perhaps.
3657 \f
3658 ;; We use /: as a prefix to "quote" a file name
3659 ;; so that magic file name handlers will not apply to it.
3663 file-name-handler-alist))
3665 ;; We depend on being the last handler on the list,
3666 ;; so that anything else which does need handling
3667 ;; has been handled already.
3668 ;; So it is safe for us to inhibit *all* magic file name handlers.
3677 default-directory))
3678 ;; Get a list of the indices of the args which are file names.
3681 ;; The first four are special because they
3682 ;; return a file name. We want to include the /:
3683 ;; in the return value.
3684 ;; So just avoid stripping it in the first place.
3686 ;; `identity' means just return the first arg
3687 ;; as stripped of its quoting.
3698 ;; For all other operations, treat the first argument only
3699 ;; as the file name.
3701 ;; Copy ARGUMENTS so we can replace elements in it.
3703 ;; Strip off the /: from the file names that have this handler.
3711 "/"
3717 \f
3740 ;;; files.el ends here