| blob | 309410ba9923f080f8c1c4633ef75ab14d72ef67 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 1995 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
24 ;;; Commentary:
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
30 ;;; Code:
36 nil
37 "*Alist of abbreviations for file directories.
38 A list of elements of the form (FROM . TO), each meaning to replace
39 FROM with TO when it appears in a directory name. This replacement is
40 done when setting up the default directory of a newly visited file.
41 *Every* FROM string should start with `^'.
43 Do not use `~' in the TO strings.
44 They should be ordinary absolute directory names.
46 Use this feature when you have directories which you normally refer to
47 via absolute symbolic links. Make TO the name of the link, and FROM
50 ;;; Turn off backup files on VMS since it has version numbers.
52 "*Non-nil means make a backup of a file the first time it is saved.
53 This can be done by renaming the file or by copying.
55 Renaming means that Emacs renames the existing file so that it is a
56 backup file, then writes the buffer into a new file. Any other names
57 that the old file had will now refer to the backup file. The new file
58 is owned by you and its group is defaulted.
60 Copying means that Emacs copies the existing file into the backup
61 file, then writes the buffer on top of the existing file. Any other
62 names that the old file had will now refer to the new (edited) file.
63 The file's owner and group are unchanged.
65 The choice of renaming or copying is controlled by the variables
66 `backup-by-copying', `backup-by-copying-when-linked' and
69 ;; Do this so that local variables based on the file name
70 ;; are not overridden by the major mode.
72 "Non-nil means don't make a backup, regardless of the other parameters.
73 This variable is intended for use by making it local to a buffer.
78 "*Non-nil means always use copying to create backup files.
82 "*Non-nil means use copying to create backups for files with multiple names.
83 This causes the alternate names to refer to the latest version as edited.
87 "*Non-nil means create backups by copying if this preserves owner or group.
88 Renaming may still be used (subject to control of other variables)
89 when it would not result in changing the owner or group of the file;
90 that is, for files which are owned by you and whose group matches
91 the default for a new file created there by you.
98 "Predicate that looks at a file name and decides whether to make backups.
102 "*Non-nil in a buffer means offer to save the buffer on exit
103 even if the buffer is not visiting a file.
108 "*Non-nil means find a file under alternative names, in existing buffers.
109 This means if any existing buffer is visiting the file you want
113 "*Non-nil means visit a file under its truename.
114 The truename of a file is found by chasing all links
118 "The device number and file number of the file visited in the current buffer.
119 The value is a list of the form (FILENUM DEVNUM).
120 This pair of numbers uniquely identifies the file.
126 "*Non-nil means protect against I/O errors while saving files.
127 Some modes set this non-nil in particular buffers.
129 This feature works by writing the new contents into a temporary file
130 and then renaming the temporary file to replace the original.
131 In this way, any I/O error in writing leaves the original untouched,
132 and there is never any instant where the file is nonexistent.
134 Note that this feature forces backups to be made by copying.
135 Yet, at the same time, saving a precious file
139 "*Control use of version numbers for backup files.
140 t means make numeric backup versions unconditionally.
141 nil means make them for files that have some already.
148 "*If t, delete excess backup versions silently.
155 "*Number of newest versions to keep when a new numbered backup is made.
159 "*Value of t says silently ensure a file ends in a newline when it is saved.
160 Non-nil but not t says ask user whether to add a newline when there isn't one.
167 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
171 "*Non-nil means save word abbrevs too when files are saved.
177 ;;;It is not useful to make this a local variable.
178 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
180 "List of functions to be called for `find-file' on nonexistent file.
181 These functions are called as soon as the error is detected.
182 `buffer-file-name' is already set up.
185 ;;;It is not useful to make this a local variable.
186 ;;;(put 'find-file-hooks 'permanent-local t)
188 "List of functions to be called after a buffer is loaded from a file.
189 The buffer's local variables (if any) will have been processed before the
193 "List of functions to be called before writing out a buffer to a file.
194 If one of them returns non-nil, the file is considered already written
195 and the rest are not called.
196 These hooks are considered to pertain to the visited file.
197 So this list is cleared if you change the visited file name.
199 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
201 ;;; However, in case someone does make it local...
205 "Just like `write-file-hooks', except intended for per-buffer use.
206 The functions in this list are called before the ones in
207 `write-file-hooks'.
209 This variable is meant to be used for hooks that have to do with a
210 particular visited file. Therefore, it is a permanent local, so that
211 changing the major mode does not clear it. However, calling
217 "List of functions to be called before writing out a buffer to a file.
218 If one of them returns non-nil, the file is considered already written
219 and the rest are not called.
221 This variable is meant to be used for hooks that pertain to the
222 buffer's contents, not to the particular visited file; thus,
223 `set-visited-file-name' does not clear this variable; but changing the
224 major mode does clear it.
226 This variable automatically becomes buffer-local whenever it is set.
227 If you use `add-hooks' to add elements to the list, use nil for the
228 LOCAL argument.
234 "*Control use of local-variables lists in files you visit.
235 The value can be t, nil or something else.
236 A value of t means local-variables lists are obeyed;
237 nil means they are ignored; anything else means query.
244 The value can be t, nil or something else.
245 A value of t means obey `eval' variables;
246 nil means ignore them; anything else means query.
251 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
257 ;; This hook function provides support for ange-ftp host name
258 ;; completion. It runs the usual ange-ftp hook, but only for
259 ;; completion operations. Having this here avoids the need
260 ;; to load ange-ftp when it's not really in use.
267 inhibit-file-name-handlers)))
272 "Convert a standard file's name to something suitable for the current OS.
273 This function's standard definition is trivial; it just returns the argument.
274 However, on some systems, the function is redefined
275 with a definition that really does change some file names."
276 filename)
277 \f
279 "Show the current default directory."
284 "Value of the CDPATH environment variable, as a list.
291 "Explode a colon-separated list of paths into a string list."
299 nil
304 cd-list)))
307 "Change current directory to given absolute file name DIR."
308 ;; Put the name into directory syntax now,
309 ;; because otherwise expand-file-name may give some bad results.
320 "Make DIR become the current buffer's default directory.
321 If your environment includes a `CDPATH' variable, try each one of that
322 colon-separated list of directories when resolving a relative directory name."
325 default-directory default-directory
341 cd-path)
342 nil))
346 "Load the Lisp file named FILE."
351 "Load the library named LIBRARY.
352 This is an interface to the function `load'."
357 "Copy the file FILE into a temporary file on this machine.
358 Returns the name of the local copy, or nil, if FILE is directly
359 accessible."
363 nil)))
366 "Return the truename of FILENAME, which should be absolute.
367 The truename of a file name is found by chasing symbolic links
368 both at the level of the file and at the level of the directories
369 containing it, until no links are left at any level.
371 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
372 Do not specify them in other calls."
373 ;; COUNTER can be a cons cell whose car is the count of how many more links
374 ;; to chase before getting an error.
375 ;; PREV-DIRS can be a cons cell whose car is an alist
376 ;; of truenames we've just recently computed.
378 ;; The last test looks dubious, maybe `+' is meant here? --simon.
388 ;; For speed, remove the ange-ftp completion handler from the list.
389 ;; We know it's not needed here.
390 ;; For even more speed, do this only on the outermost call.
396 ;; If this file directly leads to a link, process that iteratively
397 ;; so that we don't use lots of stack.
403 ;; For file name that has a special handler, call handler.
404 ;; This is so that ange-ftp can save time by doing a no-op.
407 done t)
409 target dirfile)
410 ;; Get the truename of the directory.
412 ;; If these are equal, we have the (or a) root directory.
414 ;; If this is the same dir we last got the truename for,
415 ;; save time--don't recalculate.
425 done t)
428 done t)
429 ;; Put it back on the file name.
431 ;; Is the file name the name of a link?
434 ;; Yes => chase that link, then start all over
435 ;; since the link may point to a directory name that uses links.
436 ;; We can't safely use expand-file-name here
437 ;; since target might look like foo/../bar where foo
438 ;; is itself a link. Instead, we handle . and .. above.
441 target
443 done nil)
444 ;; No, we are done!
446 filename))
449 "Chase links in FILENAME until a name that is not a link.
450 Does not examine containing directories for links,
451 unlike `file-truename'."
456 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
460 ;; Handle `..' by hand, since it needs to work in the
461 ;; target of any directory symlink.
462 ;; This code is not quite complete; it does not handle
463 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
467 ;; Do the .. by hand.
470 ;; Chase links in the default dir of the symlink.
476 newname))
477 \f
479 "Select buffer BUFFER in another window."
485 "Switch to buffer BUFFER in another frame."
492 "Edit file FILENAME.
493 Switch to a buffer visiting file FILENAME,
494 creating one if none already exists."
499 "Edit file FILENAME, in another window.
500 May create a new window, or reuse an existing one.
501 See the function `display-buffer'."
506 "Edit file FILENAME, in another frame.
507 May create a new frame, or reuse an existing one.
508 See the function `display-buffer'."
513 "Edit file FILENAME but don't allow changes.
522 "Edit file FILENAME in another window but don't allow changes.
531 "Edit file FILENAME in another frame but don't allow changes.
540 "Find file FILENAME as a replacement for the file in the next window.
541 This command does not select that window."
560 "Find file FILENAME, select its buffer, kill previous buffer.
561 If the current buffer now contains an empty file that you just visited
562 \(presumably by mistake), use this command to visit the file you really want."
573 ;; (not buffer-read-only)
602 "Create a suitably named buffer for visiting FILENAME, and return it.
603 FILENAME (sans directory) is used unchanged if that name is free;
604 otherwise a string <2> or <3> or ... is appended to get an unused name."
611 "Create and return a buffer with a name based on NAME.
612 Choose the buffer's name using `generate-new-buffer-name'."
622 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
625 ;; Get rid of the prefixes added by the automounter.
631 ;; If any elt of directory-abbrev-alist matches this name,
632 ;; abbreviate accordingly.
638 ;; Compute and save the abbreviated homedir name.
639 ;; We defer computing this until the first time it's needed, to
640 ;; give time for directory-abbrev-alist to be set properly.
641 ;; We include a slash at the end, to avoid spurious matches
642 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
649 ;; If FILENAME starts with the abbreviated homedir,
650 ;; make it start with `~' instead.
652 ;; If the home dir is just /, don't change it.
655 ;; MS-DOS root directories can come with a drive letter;
656 ;; Novell Netware allows drive letters beyond `Z:'.
665 filename))
668 "*List of logical names for which visiting shouldn't save the true dirname.
669 On VMS, when you visit a file using a logical name that searches a path,
670 you may or may not want the visited file name to record the specific
671 directory where the file was found. If you *do not* want that, add the logical
675 "Return the buffer visiting file FILENAME (a string).
676 This is like `get-file-buffer', except that it checks for any buffer
677 visiting the same file, possibly under a different name.
678 If there is no such live buffer, return nil."
690 found)
699 ;; Verify this buffer's file number
700 ;; still belongs to its file.
703 number))
706 found))))
709 "Like `insert-file-contents', q.v., but only reads in the file.
710 A buffer may be modified in several ways after reading into the buffer due
711 to advanced Emacs features, such as file-name-handlers, format decoding,
712 find-file-hooks, etc.
713 This function ensures that none of these modifications will take place."
720 nil)))
730 "Read file FILENAME into a buffer and return the buffer.
731 If a buffer exists visiting FILENAME, return that one, but
732 verify that the file has not changed since visited or saved.
733 The buffer is not selected, just returned to the caller."
741 filename))
746 ;; Find any buffer for a file which has same truename.
748 error)
749 ;; Let user know if there is a buffer with the same truename.
756 ;; Optionally also find that buffer.
769 "File %s changed on disk. Discard your edits? "
774 "File %s changed on disk. Discard your edits in %s? "
782 ;;; The truename stuff makes this obsolete.
783 ;;; (let* ((link-name (car (file-attributes filename)))
784 ;;; (linked-buf (and (stringp link-name)
785 ;;; (get-file-buffer link-name))))
786 ;;; (if (bufferp linked-buf)
787 ;;; (message "Symbolic link to file in buffer %s"
788 ;;; (buffer-name linked-buf))))
797 ;; Unconditionally set error
802 ;; Run find-file-not-found-hooks until one returns non-nil.
804 ;; If they fail too, set error.
806 ;; Find the file's truename, and maybe use that as visited name.
809 ;; On VMS, we may want to remember which directory in a search list
810 ;; the file was found in.
822 ;; Set buffer's default directory to that of the file.
824 ;; Turn off backup files for certain file names. Since
825 ;; this is a permanent local, the major mode won't eliminate it.
831 nil
834 buf)))
835 \f
839 after-find-file-from-revert-buffer
840 nomodes)
841 "Called after finding a file and by the default revert function.
842 Sets buffer mode, parses local variables.
843 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
844 error in reading the file. WARN non-nil means warn if there
845 exists an auto-save file more recent than the visited file.
846 NOAUTO means don't mess with auto-save mode.
847 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
848 means this call was from `revert-buffer'.
849 Fifth arg NOMODES non-nil means don't alter the file's modes.
850 Finishes by calling the functions in `find-file-hooks'
851 unless NOMODES is non-nil."
854 nil
863 buffer-file-name))
864 "Auto save file is newer; consider M-x recover-file"
876 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
877 "Use M-x make-dir RET RET to create the directory"
886 nil
891 "Choose the major mode for this buffer automatically.
892 Also sets up any specified local variables of the file.
893 Uses the visited file name, the -*- line, and the local variables spec.
895 This function is called automatically from `find-file'. In that case,
896 we may set up specified local variables depending on the value of
897 `enable-local-variables': if it is t, we do; if it is nil, we don't;
898 otherwise, we query. `enable-local-variables' is ignored if you
899 run `normal-mode' explicitly."
908 enable-local-variables)))
946 ;;; Less common extensions come here
947 ;;; so more common ones above are found faster.
963 ;;; The following should come after the ChangeLog pattern
964 ;;; for the sake of ChangeLog.1, etc.
965 ;;; and after the .scm.[0-9] pattern too.
984 ;; Mailer puts message to be edited in
985 ;; /tmp/Re.... or Message
989 ;; some news reader is reported to use this
997 ;; .emacs following a directory delimiter
998 ;; in either Unix or VMS syntax.
1000 ;; _emacs following a directory delimiter
1001 ;; in MsDos syntax
1004 "\
1005 Alist of filename patterns vs corresponding major mode functions.
1006 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1007 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1008 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1009 mode function to use. FUNCTION will be called, unless it is nil.
1011 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1012 calling FUNCTION (if it's not nil), we delete the suffix that matched
1047 "Alist mapping interpreter names to major modes.
1048 This alist applies to files whose first line starts with `#!'.
1049 Each element looks like (INTERPRETER . MODE).
1050 The car of each element is compared with
1051 the name of the interpreter specified in the first line.
1058 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1059 When checking `inhibit-first-line-modes-regexps', we first discard
1067 "Select major mode appropriate for current buffer.
1068 This checks for a -*- mode tag in the buffer's text,
1069 compares the filename against the entries in `auto-mode-alist',
1070 or checks the interpreter that runs this file against
1071 `interpreter-mode-alist'.
1073 It does not check for the `mode:' local variable in the
1074 Local Variables section of the file; for that, use `hack-local-variables'.
1076 If `enable-local-variables' is nil, this function does not check for a
1077 -*- mode tag."
1078 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1084 ;; Don't look for -*- if this file name matches any
1085 ;; of the regexps in inhibit-first-line-modes-regexps.
1093 sufs)
1100 ;; If the file begins with "#!"
1101 ;; (exec interpreter magic), look
1102 ;; for mode frobs in the first two
1103 ;; lines. You cannot necessarily
1104 ;; put them in the first line of
1105 ;; such a file without screwing up
1106 ;; the interpreter invocation.
1114 t))
1121 ;; Find all specifications for the `mode:' variable
1122 ;; and execute them left to right.
1134 modes)))
1135 ;; Simple -*-MODE-*- case.
1138 modes))))))
1139 ;; If we found modes to use, invoke them now,
1140 ;; outside the save-excursion.
1144 ;; If we didn't find a mode from a -*- line, try using the file name.
1148 ;; Remove backup-suffixes from file name.
1154 ;; Find first matching alist entry.
1164 keep-going t))
1166 keep-going nil)))
1170 ;; If we can't deduce a mode from the file name,
1171 ;; look for an interpreter specified in the first line.
1172 ;; As a special case, allow for things like "#!/bin/env perl",
1173 ;; which finds the interpreter anywhere in $PATH.
1181 elt)
1182 ;; Map interpreter name to a mode.
1184 interpreter-mode-alist))
1189 ;; Set local variables specified in the -*- line.
1190 ;; Ignore any specification for `mode:';
1191 ;; set-auto-mode should already have handled that.
1196 ;; Parse the -*- line into the `result' alist.
1198 ;; doesn't have one.
1199 nil)
1201 ;; Simple form: "-*- MODENAME -*-". Already handled.
1202 nil)
1204 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1205 ;; (last ";" is optional).
1214 ;; There used to be a downcase here,
1215 ;; but the manual didn't say so,
1216 ;; and people want to set var names that aren't all lc.
1235 ;; If we fail to switch in the selected window,
1236 ;; it is probably a minibuffer.
1237 ;; So try another window.
1249 "Normal hook run after processing a file's local variables specs.
1250 Major modes can use this to examine user-specified local variables
1254 "Parse and put into effect this buffer's local variables spec."
1256 ;; Look for "Local variables:" line in last page.
1272 buffer-file-name)
1276 prefix prefixlen suffix beg
1278 ;; The prefix is what comes before "local variables:" in its line.
1279 ;; The suffix is what comes after "local variables:" in its line.
1294 ;; Look at next local variable spec.
1297 ;; Skip the prefix, if any.
1302 ;; Find the variable name; strip whitespace.
1310 val)
1311 ;; Setting variable named "end" means end of list.
1314 ;; Otherwise read the variable value.
1322 ;; Set the variable. "Variables" mode and eval are funny.
1330 ;; Get confirmation before setting these variables as locals in a file.
1345 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1349 ;; This one is safe because the user gets to check it before it is used.
1355 ;; "Set" one variable in a local variables spec.
1356 ;; A few variable names are treated specially.
1362 nil)
1363 ;; "Setting" eval means either eval it or do nothing.
1364 ;; Likewise for setting hook variables.
1370 ;; Permit evalling a put of a harmless property.
1371 ;; if the args do nothing tricky.
1377 ;; Only allow safe values of lisp-indent-hook;
1378 ;; not functions.
1383 ;; Permit eval if not root and user says ok.
1400 ;; Ordinary variable, really set it.
1404 \f
1406 "Change name of file visited in current buffer to FILENAME.
1407 The next time the buffer is saved it will go in the newly specified file.
1408 nil or empty string as argument means make buffer not be visiting any file.
1409 Remember to delete the initial contents of the minibuffer
1410 if you wish to pass an empty string as the argument."
1418 nil
1441 ;; Abbreviate the file names of the buffer.
1450 nil)))
1451 ;; write-file-hooks is normally used for things like ftp-find-file
1452 ;; that visit things that are not local files as if they were files.
1453 ;; Changing to visit an ordinary local file instead should flush the hook.
1458 ;; If buffer was read-only because of version control,
1459 ;; that reason is gone now, so make it writable.
1463 ;; Turn off backup files for certain file names.
1464 ;; Since this is a permanent local, the major mode won't eliminate it.
1470 ;; If auto-save was not already on, turn it on if appropriate.
1474 ;; If auto save is on, start using a new name.
1475 ;; We deliberately don't rename or delete the old auto save
1476 ;; for the old visited file name. This is because perhaps
1477 ;; the user wants to save the new state and then compare with the
1478 ;; previous state from the auto save file.
1481 ;; Rename the old auto save file if any.
1489 "Write current buffer into file FILENAME.
1490 Makes buffer visit that file, and marks it not modified.
1491 If the buffer is already visiting a file, you can specify
1492 a directory name as FILENAME, to write a file of the same
1493 old name in that directory.
1495 If optional second arg CONFIRM is non-nil,
1496 ask for confirmation for overwriting an existing file.
1497 Interactively, confirmation is required unless you supply a prefix argument."
1498 ;; (interactive "FWrite file: ")
1502 nil nil nil nil)
1510 ;; If arg is just a directory,
1511 ;; use same file name, but in that directory.
1522 \f
1524 "Make a backup of the disk file visited by the current buffer, if appropriate.
1525 This is normally done before saving the buffer the first time.
1526 If the value is non-nil, it is the result of `file-modes' on the original
1527 file; this means that the caller, after saving the buffer, should change
1528 the modes of the new file to agree with the old modes."
1535 backup-info backupname targets setmodes)
1536 ;; If specified name is a symbolic link, chase it to the target.
1537 ;; Thus we make the backups in the directory where the real file is.
1542 ;;; (if (file-directory-p buffer-file-name)
1543 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1547 ;; If have old versions to maybe delete,
1548 ;; ask the user to confirm now, before doing anything.
1549 ;; But don't actually delete til later.
1554 real-file-name))))))
1555 ;; Actually write the back up file.
1558 ; (file-symlink-p buffer-file-name)
1559 backup-by-copying
1569 ;; If copying fails because file BACKUPNAME
1570 ;; is not writable, delete that file and try again.
1575 ;; rename-file should delete old backup.
1579 ;; If trouble writing the backup, write it in ~.
1589 ;; If copying fails because file BACKUPNAME
1590 ;; is not writable, delete that file and try again.
1596 ;; Now delete the old versions, if desired.
1603 setmodes)
1607 "Return FILENAME sans backup versions or strings.
1608 This is a separate procedure so your site-init or startup file can
1609 redefine it.
1610 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1611 we do not remove backup version numbers, only true file version numbers."
1617 ;; VMS version number is (a) semicolon, optional
1618 ;; sign, zero or more digits or (b) period, option
1619 ;; sign, zero or more digits, provided this is the
1620 ;; second period encountered outside of the
1621 ;; device/directory part of the file name.
1624 name)
1634 "Returns t if deleting FILE and rewriting it would preserve the owner."
1639 ;; Return t if the file doesn't exist, since it's true that no
1640 ;; information would be lost by an (attempted) delete and create.
1646 The extension, in a file name, is the part that follows the last `.'."
1649 directory)
1653 directory)
1655 filename))))
1658 "Create the non-numeric backup file name for FILE.
1659 This is a separate function so you can redefine it for customization."
1671 "Return non-nil if FILE is a backup file name (numeric or not).
1672 This is a separate function so you can redefine it for customization.
1673 You may need to redefine `file-name-sans-versions' as well."
1676 ;; This is used in various files.
1677 ;; The usage of bv-length is not very clean,
1678 ;; but I can't see a good alternative,
1679 ;; so as of now I am leaving it alone.
1681 "Given the name of a numeric backup file, return the backup number.
1682 Uses the free variable `bv-length', whose value should be
1683 the index in the name where the version number begins."
1689 ;; I believe there is no need to alter this behavior for VMS;
1690 ;; since backup files are not made on VMS, it should not get called.
1692 "Find a file name for a backup file, and suggestions for deletions.
1693 Value is a list whose car is the name for the backup file
1694 and whose cdr is a list of old versions to consider deleting now.
1695 If the value is nil, don't make a backup."
1697 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1704 possibilities
1711 base-versions
1715 possibilities)
1716 '<)
1728 ;; Delete nothing if there is overflow
1729 ;; in the number of versions to keep.
1735 v))))))))))
1738 "Return number of names file FILENAME has."
1742 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1751 \f
1753 "Save current buffer in visited file if modified. Versions described below.
1754 By default, makes the previous version into a backup file
1755 if previously requested or if this is the first save.
1757 to become a backup when the next save is done.
1759 unconditionally makes the previous version into a backup file.
1761 to become a backup when the next save is done,
1762 and unconditionally makes the previous version into a backup file.
1764 With argument of 0, never makes the previous version into a backup file.
1766 If a file's name is FOO, the names of its numbered backup versions are
1767 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1768 Numeric backups (rather than FOO~) will be made if value of
1769 `version-control' is not the atom `never' and either there are already
1770 numeric versions of the file being backed up, or `version-control' is
1771 non-nil.
1772 We don't want excessive versions piling up, so there are variables
1773 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1774 and `kept-new-versions', which tells how many newest versions to keep.
1775 Defaults are 2 old versions and 2 new.
1776 `dired-kept-versions' controls dired's clean-directory (.) command.
1777 If `delete-old-versions' is nil, system will query user
1778 before trimming versions. Otherwise it does it silently."
1790 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1791 Normally delete only if the file was written by this Emacs since
1792 the last real save, but optional arg FORCE non-nil means delete anyway."
1806 "Save the current buffer in its visited file, if it has been modified.
1807 After saving the buffer, run `after-save-hook'."
1810 ;; In an indirect buffer, save its base buffer instead.
1815 setmodes tempsetmodes)
1816 ;; On VMS, rename file and buffer to get rid of version number.
1821 ;; Strip VMS version number before save.
1824 ;; Construct a (unique) buffer name to correspond.
1829 ;; If buffer has no file name, ask user for one.
1836 filename))
1862 ;; If a hook returned t, file is already "written".
1863 ;; Otherwise, write it the usual way now.
1871 ;; If the auto-save file was recent before this command,
1872 ;; delete it now.
1874 ;; Support VC `implicit' locking.
1879 ;; This does the "real job" of writing a buffer into its visited file
1880 ;; and making a backup file. This is what is normally done
1881 ;; but inhibited if one of write-file-hooks returns non-nil.
1882 ;; It returns a value to store in setmodes.
1894 buffer-file-name)))
1902 ;; If file is precious, write temp name, then rename it.
1903 ;; This requires write access to the containing dir,
1904 ;; which is why we don't try it if we don't have that access.
1906 tempname temp nogood i succeed
1910 ;; Find the temporary name to write under.
1916 dir i))
1922 tempname nil realname
1923 buffer-file-truename)
1925 ;; If writing the temp file fails,
1926 ;; delete the temp file.
1931 ;; Since we have created an entirely new file
1932 ;; and renamed it, make sure it gets the
1933 ;; right permission bits set.
1935 ;; We succeeded in writing the temp file,
1936 ;; so rename it.
1938 ;; If file not writable, see if we can make it writable
1939 ;; temporarily while we write it.
1940 ;; But no need to do so if we have just backed it up
1941 ;; (setmodes is set) because that says we're superseding.
1943 ;; Change the mode back, after writing.
1947 buffer-file-name nil t buffer-file-truename)))
1948 setmodes))
1951 "Save some modified file-visiting buffers. Asks user about each one.
1952 Optional argument (the prefix) non-nil means save all with no questions.
1953 Optional second argument EXITING means ask about certain non-file buffers
1954 as well as about file buffers."
1971 t
1990 ;; Return nil to ask about BUF again.
1991 nil)
1998 abbrev-file-name)))
2000 ;; Don't keep bothering user if he says no.
2002 t))))
2005 \f
2007 "Mark current buffer as unmodified, not needing to be saved.
2010 It is not a good idea to use this function in Lisp programs, because it
2011 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2018 "Change whether this buffer is visiting its file read-only.
2019 With arg, set read-only iff arg is positive."
2028 "Insert contents of file FILENAME into buffer after point.
2029 Set mark after the inserted text.
2031 This function is meant for the user to run interactively.
2032 Don't call it from programs! Use `insert-file-contents' instead.
2033 \(Its calling sequence is different; see its documentation)."
2037 filename)))
2042 "Append the contents of the region to the end of file FILENAME.
2043 When called from a function, expects three arguments,
2044 START, END and FILENAME. START and END are buffer positions
2045 saying what text to write."
2050 "Return most recent backup file for FILENAME or nil if no backups exist."
2055 newest)
2062 newest))
2065 "Rename current buffer to a similar name not already taken.
2066 This function is useful for creating multiple shell process buffers
2067 or multiple mail buffers, etc."
2074 buffer-file-name)))))
2075 ;; If the existing buffer name has a <NNN>,
2076 ;; which isn't part of the file name (if any),
2077 ;; then get rid of that.
2087 "Create the directory DIR and any nonexistent parent dirs.
2088 Interactively, the default choice of directory to create
2089 is the current default directory for file names.
2090 That is useful when you have visited a file in a nonexistent directory.
2092 Noninteractively, the second (optional) argument PARENTS says whether
2093 to create parent directories if they don't exist."
2096 nil nil)
2097 t))
2104 create-list)
2111 \f
2114 "Function to use to revert this buffer, or nil to do the default.
2115 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2120 "Function to use to insert contents when reverting this buffer.
2121 Gets two args, first the nominal file name to use,
2125 "Normal hook for `revert-buffer' to run before reverting.
2126 If `revert-buffer-function' is used to override the normal revert
2130 "Normal hook for `revert-buffer' to run after reverting.
2131 Note that the hook value that it runs is the value that was in effect
2132 before reverting; that makes a difference if you have buffer-local
2133 hook functions.
2135 If `revert-buffer-function' is used to override the normal revert
2139 "Replace the buffer text with the text of the visited file on disk.
2140 This undoes all changes since the file was visited or saved.
2141 With a prefix argument, offer to revert from latest auto-save file, if
2142 that is more recent than the visited file.
2144 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2145 to revert from the auto-save file when this is nil. Note that the
2146 sense of this argument is the reverse of the prefix argument, for the
2147 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2148 to nil.
2150 Optional second argument NOCONFIRM means don't ask for confirmation at
2151 all.
2153 If the value of `revert-buffer-function' is non-nil, it is called to
2154 do the work.
2156 The default revert function runs the hook `before-revert-hook' at the
2157 beginning and `after-revert-hook' at the end."
2158 ;; I admit it's odd to reverse the sense of the prefix argument, but
2159 ;; there is a lot of code out there which assumes that the first
2160 ;; argument should be t to avoid consulting the auto-save file, and
2161 ;; there's no straightforward way to encourage authors to notice a
2162 ;; reversal of the argument sense. So I'm just changing the user
2163 ;; interface, but leaving the programmatic interface the same.
2170 buffer-auto-save-file-name
2175 buffer-auto-save-file-name
2176 buffer-file-name)))
2181 file-name)))
2183 ;; If file was backed up but has changed since,
2184 ;; we shd make another backup.
2188 ;; Get rid of all undo records for this buffer.
2191 ;; Effectively copy the after-revert-hook status,
2192 ;; since after-find-file will clobber it.
2196 after-revert-hook)))
2198 ;; Don't make undo records for the reversion.
2202 file-name auto-save-p)
2205 ;; Bind buffer-file-name to nil
2206 ;; so that we don't try to lock the file.
2212 nil nil t)))
2214 ;; Recompute the truename in case changes in symlinks
2215 ;; have changed the truename.
2219 ;; Run after-revert-hook as it was before we reverted.
2227 t)))))
2230 "Visit file FILE, but get contents from its last auto-save file."
2231 ;; Actually putting the file name in the minibuffer should be used
2232 ;; only rarely.
2233 ;; Not just because users often use the default.
2250 file file-name)))
2260 "Recover auto save files from a previous Emacs session.
2261 This command first displays a Dired buffer showing you the
2262 previous sessions that you could recover from.
2263 To choose one, move point to the proper line and then type C-c C-c.
2264 Then you'll be asked about a number of files to recover."
2279 "Choose one saved session to recover auto-save files from.
2280 This command is used in the special Dired buffer created by
2283 ;; Get the name of the session file to recover from.
2285 files
2290 ;; Read in the auto-save-list file.
2294 ;; Loop thru the text of that file
2295 ;; and get out the names of the files to recover.
2299 ;; This is a pair of lines for a non-file-visiting buffer.
2300 ;; Get the auto-save file name and manufacture
2301 ;; a "visited file name" from that.
2317 ;; This pair of lines is a file-visiting
2318 ;; buffer. Use the visited file name.
2328 ;; Ignore a file if its auto-save file does not exist now.
2332 ;; The file contains a pair of line for each auto-saved buffer.
2333 ;; The first line of the pair contains the visited file name
2334 ;; or is empty if the buffer was not visiting a file.
2335 ;; The second line is the auto-save file name.
2343 files
2349 "For each buffer, ask whether to kill it."
2359 name
2364 \f
2366 "Toggle auto-saving of contents of current buffer.
2367 With prefix argument ARG, turn auto-saving on if positive, else off."
2372 ;; If autosave is off because buffer has shrunk,
2373 ;; then toggling should turn it on.
2378 buffer-file-name
2380 ;; If -1 was stored here, to temporarily turn off saving,
2381 ;; turn it back on.
2387 buffer-auto-save-file-name)
2390 "Adjust current buffer's auto save file name for current conditions.
2391 Also rename any existing auto save file, if it was made in this session."
2403 "Return file name to use for auto-saves of current buffer.
2404 Does not consider `auto-save-visited-file-name' as that variable is checked
2405 before calling this function. You can redefine this for customization.
2406 See also `auto-save-file-name-p'."
2415 "#"
2419 ;; Deal with buffers that don't have any associated files. (Mail
2420 ;; mode tends to create a good number of these.)
2424 ;; Use technique from Sebastian Kremer's auto-save
2425 ;; package to turn slashes into \\!. This ensures that
2426 ;; the auto-save buffer name is unique.
2442 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2443 FILENAME should lack slashes. You can redefine this for customization."
2445 \f
2447 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2448 The generated regexp will match a filename iff the filename
2449 matches that wildcard according to shell rules. Only wildcards known
2450 by `sh' are supported."
2452 ;; Copy the initial run of non-special characters.
2455 ;; If no special characters, we're almost done.
2459 j)
2461 result
2478 ;; Found "[^". Insert a `\0' character
2479 ;; (which cannot happen in a filename)
2480 ;; into the character class, so that `^'
2481 ;; is not the first character after `[',
2482 ;; and thus non-special in a regexp.
2487 ;; I don't think `]' can appear in a
2488 ;; character class in a wildcard, but
2489 ;; let's be general here.
2496 i
2509 ;; Shell wildcards should match the entire filename,
2510 ;; not its part. Make the regexp say so.
2512 \f
2519 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2524 "Display a list of files in or matching DIRNAME, a la `ls'.
2525 DIRNAME is globbed by the shell if necessary.
2526 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2527 Actions controlled by variables `list-directory-brief-switches'
2528 and `list-directory-verbose-switches'."
2532 nil default-directory nil)
2533 pfx)))
2535 list-directory-brief-switches)))
2555 ;; insert-directory
2556 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2557 ;; FULL-DIRECTORY-P is nil.
2558 ;; The single line of output must display FILE's name as it was
2559 ;; given, namely, an absolute path name.
2560 ;; - must insert exactly one line for each file if WILDCARD or
2561 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
2562 ;; before the file lines, plus optional text after the file lines.
2563 ;; Lines are delimited by "\n", so filenames containing "\n" are not
2564 ;; allowed.
2565 ;; File lines should display the basename.
2566 ;; - must be consistent with
2567 ;; - functions dired-move-to-filename, (these two define what a file line is)
2568 ;; dired-move-to-end-of-filename,
2569 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2570 ;; dired-insert-headerline
2571 ;; dired-after-subdir-garbage (defines what a "total" line is)
2572 ;; - variable dired-subdir-regexp
2574 "Insert directory listing for FILE, formatted according to SWITCHES.
2575 Leaves point after the inserted text.
2576 SWITCHES may be a string of options, or a list of strings.
2577 Optional third arg WILDCARD means treat FILE as shell wildcard.
2578 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2579 switches do not contain `d', so that a full listing is expected.
2581 This works by running a directory listing program
2582 whose name is in the variable `insert-directory-program'.
2583 If WILDCARD, it also runs the shell specified by `shell-file-name'."
2584 ;; We need the directory in order to find the right handler.
2589 wildcard full-directory-p)
2593 ;; Run ls in the directory of the file pattern we asked for.
2600 ;; Quote some characters that have special meanings in shells;
2601 ;; but don't quote the wildcards--we want them to be special.
2602 ;; We also currently don't quote the quoting characters
2603 ;; in case people want to use them explicitly to quote
2604 ;; wildcard characters.
2613 insert-directory-program
2614 " -d "
2616 switches
2618 " "
2619 pattern)))
2620 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2621 ;; directory if FILE is a symbolic link.
2623 insert-directory-program nil t nil
2629 ;; Split the switches at any spaces
2630 ;; so we can pass separate options as separate args.
2633 list)
2640 file))))))))))
2643 "Functions to call with no arguments to query about killing Emacs.
2644 If any of these functions returns nil, killing Emacs is cancelled.
2646 but `kill-emacs', the low level primitive, does not.
2650 "Offer to save each buffer, then kill this Emacs process.
2651 With prefix arg, silently save all file-visiting buffers, then kill."
2660 ;; process-list is not defined on VMS.
2662 active)
2667 val)
2672 ;; Query the user for other things, perhaps.
2675 \f
2699 ;;; files.el ends here