| blob | 3d6053843442c394d00f107dd0454299f13c8680 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93,
4 ;; 94, 95, 1996 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:
37 nil
38 "*Alist of abbreviations for file directories.
39 A list of elements of the form (FROM . TO), each meaning to replace
40 FROM with TO when it appears in a directory name. This replacement is
41 done when setting up the default directory of a newly visited file.
42 *Every* FROM string should start with `^'.
44 Do not use `~' in the TO strings.
45 They should be ordinary absolute directory names.
47 Use this feature when you have directories which you normally refer to
48 via absolute symbolic links. Make TO the name of the link, and FROM
51 ;;; Turn off backup files on VMS since it has version numbers.
53 "*Non-nil means make a backup of a file the first time it is saved.
54 This can be done by renaming the file or by copying.
56 Renaming means that Emacs renames the existing file so that it is a
57 backup file, then writes the buffer into a new file. Any other names
58 that the old file had will now refer to the backup file. The new file
59 is owned by you and its group is defaulted.
61 Copying means that Emacs copies the existing file into the backup
62 file, then writes the buffer on top of the existing file. Any other
63 names that the old file had will now refer to the new (edited) file.
64 The file's owner and group are unchanged.
66 The choice of renaming or copying is controlled by the variables
67 `backup-by-copying', `backup-by-copying-when-linked' and
70 ;; Do this so that local variables based on the file name
71 ;; are not overridden by the major mode.
73 "Non-nil means don't make a backup, regardless of the other parameters.
74 This variable is intended for use by making it local to a buffer.
79 "*Non-nil means always use copying to create backup files.
83 "*Non-nil means use copying to create backups for files with multiple names.
84 This causes the alternate names to refer to the latest version as edited.
88 "*Non-nil means create backups by copying if this preserves owner or group.
89 Renaming may still be used (subject to control of other variables)
90 when it would not result in changing the owner or group of the file;
91 that is, for files which are owned by you and whose group matches
92 the default for a new file created there by you.
99 "Predicate that looks at a file name and decides whether to make backups.
103 "*Non-nil in a buffer means offer to save the buffer on exit
104 even if the buffer is not visiting a file.
109 "*Non-nil means find a file under alternative names, in existing buffers.
110 This means if any existing buffer is visiting the file you want
114 "*Non-nil means visit a file under its truename.
115 The truename of a file is found by chasing all links
119 nil
120 "*Specify which files should be reverted without query.
121 The value is a list of regular expressions.
122 If the file name matches one of these regular expressions,
123 then `find-file' reverts the file without querying
127 "The device number and file number of the file visited in the current buffer.
128 The value is a list of the form (FILENUM DEVNUM).
129 This pair of numbers uniquely identifies the file.
138 "*Non-nil means protect against I/O errors while saving files.
139 Some modes set this non-nil in particular buffers.
141 This feature works by writing the new contents into a temporary file
142 and then renaming the temporary file to replace the original.
143 In this way, any I/O error in writing leaves the original untouched,
144 and there is never any instant where the file is nonexistent.
146 Note that this feature forces backups to be made by copying.
147 Yet, at the same time, saving a precious file
151 "*Control use of version numbers for backup files.
152 t means make numeric backup versions unconditionally.
153 nil means make them for files that have some already.
160 "*If t, delete excess backup versions silently.
167 "*Number of newest versions to keep when a new numbered backup is made.
171 "*Value of t says silently ensure a file ends in a newline when it is saved.
172 Non-nil but not t says ask user whether to add a newline when there isn't one.
179 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
183 "*Non-nil means save word abbrevs too when files are saved.
189 ;;;It is not useful to make this a local variable.
190 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
192 "List of functions to be called for `find-file' on nonexistent file.
193 These functions are called as soon as the error is detected.
194 `buffer-file-name' is already set up.
197 ;;;It is not useful to make this a local variable.
198 ;;;(put 'find-file-hooks 'permanent-local t)
200 "List of functions to be called after a buffer is loaded from a file.
201 The buffer's local variables (if any) will have been processed before the
205 "List of functions to be called before writing out a buffer to a file.
206 If one of them returns non-nil, the file is considered already written
207 and the rest are not called.
208 These hooks are considered to pertain to the visited file.
209 So this list is cleared if you change the visited file name.
211 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
213 ;;; However, in case someone does make it local...
217 "Just like `write-file-hooks', except intended for per-buffer use.
218 The functions in this list are called before the ones in
219 `write-file-hooks'.
221 This variable is meant to be used for hooks that have to do with a
222 particular visited file. Therefore, it is a permanent local, so that
223 changing the major mode does not clear it. However, calling
229 "List of functions to be called before writing out a buffer to a file.
230 If one of them returns non-nil, the file is considered already written
231 and the rest are not called.
233 This variable is meant to be used for hooks that pertain to the
234 buffer's contents, not to the particular visited file; thus,
235 `set-visited-file-name' does not clear this variable; but changing the
236 major mode does clear it.
238 This variable automatically becomes buffer-local whenever it is set.
239 If you use `add-hook' to add elements to the list, use nil for the
240 LOCAL argument.
246 "*Control use of local variables in files you visit.
247 The value can be t, nil or something else.
248 A value of t means file local variables specifications are obeyed;
249 nil means they are ignored; anything else means query.
256 The value can be t, nil or something else.
257 A value of t means obey `eval' variables;
258 nil means ignore them; anything else means query.
263 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
271 ;; This hook function provides support for ange-ftp host name
272 ;; completion. It runs the usual ange-ftp hook, but only for
273 ;; completion operations. Having this here avoids the need
274 ;; to load ange-ftp when it's not really in use.
281 inhibit-file-name-handlers)))
286 "Convert a standard file's name to something suitable for the current OS.
287 This function's standard definition is trivial; it just returns the argument.
288 However, on some systems, the function is redefined
289 with a definition that really does change some file names."
290 filename)
291 \f
293 "Show the current default directory."
298 "Value of the CDPATH environment variable, as a list.
305 "Explode a colon-separated list of paths into a string list."
313 nil
318 cd-list)))
321 "Change current directory to given absolute file name DIR."
322 ;; Put the name into directory syntax now,
323 ;; because otherwise expand-file-name may give some bad results.
334 "Make DIR become the current buffer's default directory.
335 If your environment includes a `CDPATH' variable, try each one of that
336 colon-separated list of directories when resolving a relative directory name."
339 default-directory default-directory
355 cd-path)
356 nil))
360 "Load the Lisp file named FILE."
365 "Load the library named LIBRARY.
366 This is an interface to the function `load'."
371 "Copy the file FILE into a temporary file on this machine.
372 Returns the name of the local copy, or nil, if FILE is directly
373 accessible."
377 nil)))
380 "Return the truename of FILENAME, which should be absolute.
381 The truename of a file name is found by chasing symbolic links
382 both at the level of the file and at the level of the directories
383 containing it, until no links are left at any level.
385 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
386 Do not specify them in other calls."
387 ;; COUNTER can be a cons cell whose car is the count of how many more links
388 ;; to chase before getting an error.
389 ;; PREV-DIRS can be a cons cell whose car is an alist
390 ;; of truenames we've just recently computed.
392 ;; The last test looks dubious, maybe `+' is meant here? --simon.
402 ;; For speed, remove the ange-ftp completion handler from the list.
403 ;; We know it's not needed here.
404 ;; For even more speed, do this only on the outermost call.
410 ;; If this file directly leads to a link, process that iteratively
411 ;; so that we don't use lots of stack.
417 ;; For file name that has a special handler, call handler.
418 ;; This is so that ange-ftp can save time by doing a no-op.
421 done t)
423 target dirfile)
424 ;; Get the truename of the directory.
426 ;; If these are equal, we have the (or a) root directory.
428 ;; If this is the same dir we last got the truename for,
429 ;; save time--don't recalculate.
439 done t)
442 done t)
443 ;; Put it back on the file name.
445 ;; Is the file name the name of a link?
448 ;; Yes => chase that link, then start all over
449 ;; since the link may point to a directory name that uses links.
450 ;; We can't safely use expand-file-name here
451 ;; since target might look like foo/../bar where foo
452 ;; is itself a link. Instead, we handle . and .. above.
455 target
457 done nil)
458 ;; No, we are done!
460 filename))
463 "Chase links in FILENAME until a name that is not a link.
464 Does not examine containing directories for links,
465 unlike `file-truename'."
470 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
474 ;; Handle `..' by hand, since it needs to work in the
475 ;; target of any directory symlink.
476 ;; This code is not quite complete; it does not handle
477 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
481 ;; Do the .. by hand.
484 ;; Chase links in the default dir of the symlink.
490 newname))
491 \f
493 "Select buffer BUFFER in another window.
494 Optional second arg NORECORD non-nil means
495 do not put this buffer at the front of the list of recently selected ones."
501 "Switch to buffer BUFFER in another frame.
502 Optional second arg NORECORD non-nil means
503 do not put this buffer at the front of the list of recently selected ones."
510 "Edit file FILENAME.
511 Switch to a buffer visiting file FILENAME,
512 creating one if none already exists."
517 "Edit file FILENAME, in another window.
518 May create a new window, or reuse an existing one.
519 See the function `display-buffer'."
524 "Edit file FILENAME, in another frame.
525 May create a new frame, or reuse an existing one.
526 See the function `display-buffer'."
531 "Edit file FILENAME but don't allow changes.
540 "Edit file FILENAME in another window but don't allow changes.
549 "Edit file FILENAME in another frame but don't allow changes.
558 "Find file FILENAME as a replacement for the file in the next window.
559 This command does not select that window."
578 "Find file FILENAME, select its buffer, kill previous buffer.
579 If the current buffer now contains an empty file that you just visited
580 \(presumably by mistake), use this command to visit the file you really want."
591 ;; (not buffer-read-only)
620 "Create a suitably named buffer for visiting FILENAME, and return it.
621 FILENAME (sans directory) is used unchanged if that name is free;
622 otherwise a string <2> or <3> or ... is appended to get an unused name."
629 "Create and return a buffer with a name based on NAME.
630 Choose the buffer's name using `generate-new-buffer-name'."
640 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
643 ;; Get rid of the prefixes added by the automounter.
650 ;; If any elt of directory-abbrev-alist matches this name,
651 ;; abbreviate accordingly.
657 ;; Compute and save the abbreviated homedir name.
658 ;; We defer computing this until the first time it's needed, to
659 ;; give time for directory-abbrev-alist to be set properly.
660 ;; We include a slash at the end, to avoid spurious matches
661 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
668 ;; If FILENAME starts with the abbreviated homedir,
669 ;; make it start with `~' instead.
671 ;; If the home dir is just /, don't change it.
674 ;; MS-DOS root directories can come with a drive letter;
675 ;; Novell Netware allows drive letters beyond `Z:'.
684 filename))
687 "*List of logical names for which visiting shouldn't save the true dirname.
688 On VMS, when you visit a file using a logical name that searches a path,
689 you may or may not want the visited file name to record the specific
690 directory where the file was found. If you *do not* want that, add the logical
694 "Return the buffer visiting file FILENAME (a string).
695 This is like `get-file-buffer', except that it checks for any buffer
696 visiting the same file, possibly under a different name.
697 If there is no such live buffer, return nil."
709 found)
713 number
719 ;; Verify this buffer's file number
720 ;; still belongs to its file.
723 number))
726 found))))
729 "Like `insert-file-contents', q.v., but only reads in the file.
730 A buffer may be modified in several ways after reading into the buffer due
731 to advanced Emacs features, such as file-name-handlers, format decoding,
732 find-file-hooks, etc.
733 This function ensures that none of these modifications will take place.
735 This function does not work for remote files, because it turns off
736 file name handlers and remote file access uses a file name handler."
743 nil)))
753 "Read file FILENAME into a buffer and return the buffer.
754 If a buffer exists visiting FILENAME, return that one, but
755 verify that the file has not changed since visited or saved.
756 The buffer is not selected, just returned to the caller."
764 filename))
769 ;; Find any buffer for a file which has same truename.
771 error)
772 ;; Let user know if there is a buffer with the same truename.
779 ;; Optionally also find that buffer.
787 ;; Certain files should be reverted automatically
788 ;; if they have changed on disk and not in the buffer.
796 found))
806 "File %s changed on disk. Discard your edits? "
811 "File %s changed on disk. Discard your edits in %s? "
818 ;;; The truename stuff makes this obsolete.
819 ;;; (let* ((link-name (car (file-attributes filename)))
820 ;;; (linked-buf (and (stringp link-name)
821 ;;; (get-file-buffer link-name))))
822 ;;; (if (bufferp linked-buf)
823 ;;; (message "Symbolic link to file in buffer %s"
824 ;;; (buffer-name linked-buf))))
833 ;; Unconditionally set error
838 ;; Run find-file-not-found-hooks until one returns non-nil.
840 ;; If they fail too, set error.
842 ;; Find the file's truename, and maybe use that as visited name.
845 ;; On VMS, we may want to remember which directory in a search list
846 ;; the file was found in.
858 ;; Set buffer's default directory to that of the file.
860 ;; Turn off backup files for certain file names. Since
861 ;; this is a permanent local, the major mode won't eliminate it.
867 nil
870 buf)))
871 \f
875 after-find-file-from-revert-buffer
876 nomodes)
877 "Called after finding a file and by the default revert function.
878 Sets buffer mode, parses local variables.
879 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
880 error in reading the file. WARN non-nil means warn if there
881 exists an auto-save file more recent than the visited file.
882 NOAUTO means don't mess with auto-save mode.
883 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
884 means this call was from `revert-buffer'.
885 Fifth arg NOMODES non-nil means don't alter the file's modes.
886 Finishes by calling the functions in `find-file-hooks'
887 unless NOMODES is non-nil."
890 nil
899 buffer-file-name))
913 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
914 "Use M-x make-dir RET RET to create the directory"
923 nil
928 "Choose the major mode for this buffer automatically.
929 Also sets up any specified local variables of the file.
930 Uses the visited file name, the -*- line, and the local variables spec.
932 This function is called automatically from `find-file'. In that case,
933 we may set up specified local variables depending on the value of
934 `enable-local-variables': if it is t, we do; if it is nil, we don't;
935 otherwise, we query. `enable-local-variables' is ignored if you
936 run `normal-mode' explicitly."
945 enable-local-variables)))
989 ;;; Less common extensions come here
990 ;;; so more common ones above are found faster.
1000 ;; for MSDOS and MS-Windows (which are case-insensitive)
1009 ;;; The following should come after the ChangeLog pattern
1010 ;;; for the sake of ChangeLog.1, etc.
1011 ;;; and after the .scm.[0-9] pattern too.
1031 ;; Mailer puts message to be edited in
1032 ;; /tmp/Re.... or Message
1036 ;; some news reader is reported to use this
1044 ;; .emacs following a directory delimiter
1045 ;; in either Unix or VMS syntax.
1047 ;; _emacs following a directory delimiter
1048 ;; in MsDos syntax
1051 "\
1052 Alist of filename patterns vs corresponding major mode functions.
1053 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1054 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1055 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1056 mode function to use. FUNCTION will be called, unless it is nil.
1058 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1059 calling FUNCTION (if it's not nil), we delete the suffix that matched
1095 "Alist mapping interpreter names to major modes.
1096 This alist applies to files whose first line starts with `#!'.
1097 Each element looks like (INTERPRETER . MODE).
1098 The car of each element is compared with
1099 the name of the interpreter specified in the first line.
1106 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1107 When checking `inhibit-first-line-modes-regexps', we first discard
1115 "Select major mode appropriate for current buffer.
1116 This checks for a -*- mode tag in the buffer's text,
1117 compares the filename against the entries in `auto-mode-alist',
1118 or checks the interpreter that runs this file against
1119 `interpreter-mode-alist'.
1121 It does not check for the `mode:' local variable in the
1122 Local Variables section of the file; for that, use `hack-local-variables'.
1124 If `enable-local-variables' is nil, this function does not check for a
1125 -*- mode tag."
1126 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1132 ;; Don't look for -*- if this file name matches any
1133 ;; of the regexps in inhibit-first-line-modes-regexps.
1141 sufs)
1148 ;; If the file begins with "#!"
1149 ;; (exec interpreter magic), look
1150 ;; for mode frobs in the first two
1151 ;; lines. You cannot necessarily
1152 ;; put them in the first line of
1153 ;; such a file without screwing up
1154 ;; the interpreter invocation.
1162 t))
1169 ;; Find all specifications for the `mode:' variable
1170 ;; and execute them left to right.
1182 modes)))
1183 ;; Simple -*-MODE-*- case.
1186 modes))))))
1187 ;; If we found modes to use, invoke them now,
1188 ;; outside the save-excursion.
1192 ;; If we didn't find a mode from a -*- line, try using the file name.
1196 ;; Remove backup-suffixes from file name.
1202 ;; Find first matching alist entry.
1212 keep-going t))
1214 keep-going nil)))
1218 ;; If we can't deduce a mode from the file name,
1219 ;; look for an interpreter specified in the first line.
1220 ;; As a special case, allow for things like "#!/bin/env perl",
1221 ;; which finds the interpreter anywhere in $PATH.
1229 elt)
1230 ;; Map interpreter name to a mode.
1232 interpreter-mode-alist))
1237 ;; Set local variables specified in the -*- line.
1238 ;; Ignore any specification for `mode:';
1239 ;; set-auto-mode should already have handled that.
1244 ;; Parse the -*- line into the `result' alist.
1246 ;; doesn't have one.
1247 nil)
1249 ;; Simple form: "-*- MODENAME -*-". Already handled.
1250 nil)
1252 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1253 ;; (last ";" is optional).
1262 ;; There used to be a downcase here,
1263 ;; but the manual didn't say so,
1264 ;; and people want to set var names that aren't all lc.
1271 ;; It is traditional to ignore
1272 ;; case when checking for `mode' in set-auto-mode,
1273 ;; so we must do that here as well.
1274 ;; That is inconsistent, but we're stuck with it.
1287 ;; If we fail to switch in the selected window,
1288 ;; it is probably a minibuffer.
1289 ;; So try another window.
1302 "Normal hook run after processing a file's local variables specs.
1303 Major modes can use this to examine user-specified local variables
1307 "Parse and put into effect this buffer's local variables spec."
1309 ;; Look for "Local variables:" line in last page.
1325 buffer-file-name)
1329 prefix prefixlen suffix beg
1331 ;; The prefix is what comes before "local variables:" in its line.
1332 ;; The suffix is what comes after "local variables:" in its line.
1347 ;; Look at next local variable spec.
1350 ;; Skip the prefix, if any.
1355 ;; Find the variable name; strip whitespace.
1363 val)
1364 ;; Setting variable named "end" means end of list.
1367 ;; Otherwise read the variable value.
1375 ;; Set the variable. "Variables" mode and eval are funny.
1383 ;; Get confirmation before setting these variables as locals in a file.
1400 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1404 ;; This one is safe because the user gets to check it before it is used.
1410 ;; "Set" one variable in a local variables spec.
1411 ;; A few variable names are treated specially.
1417 nil)
1418 ;; "Setting" eval means either eval it or do nothing.
1419 ;; Likewise for setting hook variables.
1425 ;; Permit evalling a put of a harmless property.
1426 ;; if the args do nothing tricky.
1432 ;; Only allow safe values of lisp-indent-hook;
1433 ;; not functions.
1438 ;; Permit eval if not root and user says ok.
1455 ;; Ordinary variable, really set it.
1459 \f
1461 "Change name of file visited in current buffer to FILENAME.
1462 The next time the buffer is saved it will go in the newly specified file.
1463 nil or empty string as argument means make buffer not be visiting any file.
1464 Remember to delete the initial contents of the minibuffer
1465 if you wish to pass an empty string as the argument.
1467 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1468 confirmation in the case where another buffer is already visiting FILENAME."
1476 nil
1487 filename)))
1505 ;; Abbreviate the file names of the buffer.
1514 nil)))
1515 ;; write-file-hooks is normally used for things like ftp-find-file
1516 ;; that visit things that are not local files as if they were files.
1517 ;; Changing to visit an ordinary local file instead should flush the hook.
1522 ;; If buffer was read-only because of version control,
1523 ;; that reason is gone now, so make it writable.
1527 ;; Turn off backup files for certain file names.
1528 ;; Since this is a permanent local, the major mode won't eliminate it.
1534 ;; If auto-save was not already on, turn it on if appropriate.
1538 ;; If auto save is on, start using a new name.
1539 ;; We deliberately don't rename or delete the old auto save
1540 ;; for the old visited file name. This is because perhaps
1541 ;; the user wants to save the new state and then compare with the
1542 ;; previous state from the auto save file.
1545 ;; Rename the old auto save file if any.
1553 "Write current buffer into file FILENAME.
1554 Makes buffer visit that file, and marks it not modified.
1555 If the buffer is already visiting a file, you can specify
1556 a directory name as FILENAME, to write a file of the same
1557 old name in that directory.
1559 If optional second arg CONFIRM is non-nil,
1560 ask for confirmation for overwriting an existing file.
1561 Interactively, confirmation is required unless you supply a prefix argument."
1562 ;; (interactive "FWrite file: ")
1566 nil nil nil nil)
1574 ;; If arg is just a directory,
1575 ;; use same file name, but in that directory.
1586 \f
1588 "Make a backup of the disk file visited by the current buffer, if appropriate.
1589 This is normally done before saving the buffer the first time.
1590 If the value is non-nil, it is the result of `file-modes' on the original
1591 file; this means that the caller, after saving the buffer, should change
1592 the modes of the new file to agree with the old modes.
1594 A backup may be done by renaming or by copying; see documentation of
1595 variable `make-backup-files'. If it's done by renaming, then the file is
1596 no longer accessible under its old name."
1603 backup-info backupname targets setmodes)
1604 ;; If specified name is a symbolic link, chase it to the target.
1605 ;; Thus we make the backups in the directory where the real file is.
1610 ;;; (if (file-directory-p buffer-file-name)
1611 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1615 ;; If have old versions to maybe delete,
1616 ;; ask the user to confirm now, before doing anything.
1617 ;; But don't actually delete til later.
1622 real-file-name))))))
1623 ;; Actually write the back up file.
1626 ; (file-symlink-p buffer-file-name)
1627 backup-by-copying
1637 ;; If copying fails because file BACKUPNAME
1638 ;; is not writable, delete that file and try again.
1643 ;; rename-file should delete old backup.
1647 ;; If trouble writing the backup, write it in ~.
1657 ;; If copying fails because file BACKUPNAME
1658 ;; is not writable, delete that file and try again.
1664 ;; Now delete the old versions, if desired.
1671 setmodes)
1675 "Return FILENAME sans backup versions or strings.
1676 This is a separate procedure so your site-init or startup file can
1677 redefine it.
1678 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1679 we do not remove backup version numbers, only true file version numbers."
1685 ;; VMS version number is (a) semicolon, optional
1686 ;; sign, zero or more digits or (b) period, option
1687 ;; sign, zero or more digits, provided this is the
1688 ;; second period encountered outside of the
1689 ;; device/directory part of the file name.
1692 name)
1702 "Returns t if deleting FILE and rewriting it would preserve the owner."
1707 ;; Return t if the file doesn't exist, since it's true that no
1708 ;; information would be lost by an (attempted) delete and create.
1714 The extension, in a file name, is the part that follows the last `.'."
1717 directory)
1721 directory)
1723 filename))))
1727 The extension, in a file name, is the part that follows the last `.'.
1728 Return nil for extensionless file names such as `foo'.
1729 Return the empty string for file names such as `foo.'.
1731 If PERIOD is non-nil, then the returned value includes the period
1732 that delimits the extension, and if FILENAME has no extension,
1742 "Create the non-numeric backup file name for FILE.
1743 This is a separate function so you can redefine it for customization."
1756 "Return non-nil if FILE is a backup file name (numeric or not).
1757 This is a separate function so you can redefine it for customization.
1758 You may need to redefine `file-name-sans-versions' as well."
1761 ;; This is used in various files.
1762 ;; The usage of bv-length is not very clean,
1763 ;; but I can't see a good alternative,
1764 ;; so as of now I am leaving it alone.
1766 "Given the name of a numeric backup file, return the backup number.
1767 Uses the free variable `bv-length', whose value should be
1768 the index in the name where the version number begins."
1774 ;; I believe there is no need to alter this behavior for VMS;
1775 ;; since backup files are not made on VMS, it should not get called.
1777 "Find a file name for a backup file, and suggestions for deletions.
1778 Value is a list whose car is the name for the backup file
1779 and whose cdr is a list of old versions to consider deleting now.
1780 If the value is nil, don't make a backup."
1782 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1789 possibilities
1796 base-versions
1800 possibilities)
1801 '<)
1813 ;; Delete nothing if there is overflow
1814 ;; in the number of versions to keep.
1820 v))))))))))
1823 "Return number of names file FILENAME has."
1827 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1836 \f
1838 "Save current buffer in visited file if modified. Versions described below.
1839 By default, makes the previous version into a backup file
1840 if previously requested or if this is the first save.
1842 to become a backup when the next save is done.
1844 unconditionally makes the previous version into a backup file.
1846 to become a backup when the next save is done,
1847 and unconditionally makes the previous version into a backup file.
1849 With argument of 0, never makes the previous version into a backup file.
1851 If a file's name is FOO, the names of its numbered backup versions are
1852 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1853 Numeric backups (rather than FOO~) will be made if value of
1854 `version-control' is not the atom `never' and either there are already
1855 numeric versions of the file being backed up, or `version-control' is
1856 non-nil.
1857 We don't want excessive versions piling up, so there are variables
1858 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1859 and `kept-new-versions', which tells how many newest versions to keep.
1860 Defaults are 2 old versions and 2 new.
1861 `dired-kept-versions' controls dired's clean-directory (.) command.
1862 If `delete-old-versions' is nil, system will query user
1863 before trimming versions. Otherwise it does it silently."
1875 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1876 Normally delete only if the file was written by this Emacs since
1877 the last real save, but optional arg FORCE non-nil means delete anyway."
1891 "Save the current buffer in its visited file, if it has been modified.
1892 After saving the buffer, run `after-save-hook'."
1895 ;; In an indirect buffer, save its base buffer instead.
1900 setmodes tempsetmodes)
1901 ;; On VMS, rename file and buffer to get rid of version number.
1906 ;; Strip VMS version number before save.
1909 ;; Construct a (unique) buffer name to correspond.
1914 ;; If buffer has no file name, ask user for one.
1921 filename))
1947 ;; If a hook returned t, file is already "written".
1948 ;; Otherwise, write it the usual way now.
1956 ;; If the auto-save file was recent before this command,
1957 ;; delete it now.
1959 ;; Support VC `implicit' locking.
1964 ;; This does the "real job" of writing a buffer into its visited file
1965 ;; and making a backup file. This is what is normally done
1966 ;; but inhibited if one of write-file-hooks returns non-nil.
1967 ;; It returns a value to store in setmodes.
1979 buffer-file-name)))
1987 ;; If file is precious, write temp name, then rename it.
1988 ;; This requires write access to the containing dir,
1989 ;; which is why we don't try it if we don't have that access.
1991 tempname temp nogood i succeed
1995 ;; Find the temporary name to write under.
2002 dir i))
2008 tempname nil realname
2009 buffer-file-truename)
2011 ;; If writing the temp file fails,
2012 ;; delete the temp file.
2017 ;; Since we have created an entirely new file
2018 ;; and renamed it, make sure it gets the
2019 ;; right permission bits set.
2021 ;; We succeeded in writing the temp file,
2022 ;; so rename it.
2024 ;; If file not writable, see if we can make it writable
2025 ;; temporarily while we write it.
2026 ;; But no need to do so if we have just backed it up
2027 ;; (setmodes is set) because that says we're superseding.
2029 ;; Change the mode back, after writing.
2033 buffer-file-name nil t buffer-file-truename)))
2034 setmodes))
2037 "Save some modified file-visiting buffers. Asks user about each one.
2038 Optional argument (the prefix) non-nil means save all with no questions.
2039 Optional second argument EXITING means ask about certain non-file buffers
2040 as well as about file buffers."
2057 t
2076 ;; Return nil to ask about BUF again.
2077 nil)
2084 abbrev-file-name)))
2086 ;; Don't keep bothering user if he says no.
2088 t))))
2091 \f
2093 "Mark current buffer as unmodified, not needing to be saved.
2096 It is not a good idea to use this function in Lisp programs, because it
2097 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2104 "Change whether this buffer is visiting its file read-only.
2105 With arg, set read-only iff arg is positive."
2114 "Insert contents of file FILENAME into buffer after point.
2115 Set mark after the inserted text.
2117 This function is meant for the user to run interactively.
2118 Don't call it from programs! Use `insert-file-contents' instead.
2119 \(Its calling sequence is different; see its documentation)."
2123 filename)))
2128 "Append the contents of the region to the end of file FILENAME.
2129 When called from a function, expects three arguments,
2130 START, END and FILENAME. START and END are buffer positions
2131 saying what text to write."
2136 "Return most recent backup file for FILENAME or nil if no backups exist."
2142 tem)
2152 newest))
2155 "Rename current buffer to a similar name not already taken.
2156 This function is useful for creating multiple shell process buffers
2157 or multiple mail buffers, etc."
2164 buffer-file-name)))))
2165 ;; If the existing buffer name has a <NNN>,
2166 ;; which isn't part of the file name (if any),
2167 ;; then get rid of that.
2177 "Create the directory DIR and any nonexistent parent dirs.
2178 Interactively, the default choice of directory to create
2179 is the current default directory for file names.
2180 That is useful when you have visited a file in a nonexistent directory.
2182 Noninteractively, the second (optional) argument PARENTS says whether
2183 to create parent directories if they don't exist."
2186 nil nil)
2187 t))
2194 create-list)
2201 \f
2204 "Function to use to revert this buffer, or nil to do the default.
2205 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2210 "Function to use to insert contents when reverting this buffer.
2211 Gets two args, first the nominal file name to use,
2215 "Normal hook for `revert-buffer' to run before reverting.
2216 If `revert-buffer-function' is used to override the normal revert
2220 "Normal hook for `revert-buffer' to run after reverting.
2221 Note that the hook value that it runs is the value that was in effect
2222 before reverting; that makes a difference if you have buffer-local
2223 hook functions.
2225 If `revert-buffer-function' is used to override the normal revert
2229 "Replace current buffer text with the text of the visited file on disk.
2230 This undoes all changes since the file was visited or saved.
2231 With a prefix argument, offer to revert from latest auto-save file, if
2232 that is more recent than the visited file.
2234 This command also works for special buffers that contain text which
2235 doesn't come from a file, but reflects some other data base instead:
2236 for example, Dired buffers and buffer-list buffers. In these cases,
2237 it reconstructs the buffer contents from the appropriate data base.
2239 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2240 to revert from the auto-save file when this is nil. Note that the
2241 sense of this argument is the reverse of the prefix argument, for the
2242 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2243 to nil.
2245 Optional second argument NOCONFIRM means don't ask for confirmation at
2246 all.
2248 Optional third argument PRESERVE-MODES non-nil means don't alter
2249 the files modes. Normally we reinitialize them using `normal-mode'.
2251 If the value of `revert-buffer-function' is non-nil, it is called to
2252 do all the work for this command. Otherwise, the hooks
2253 `before-revert-hook' and `after-revert-hook' are run at the beginning
2254 and the end, and if `revert-buffer-insert-file-contents-function' is
2255 non-nil, it is called instead of rereading visited file contents."
2257 ;; I admit it's odd to reverse the sense of the prefix argument, but
2258 ;; there is a lot of code out there which assumes that the first
2259 ;; argument should be t to avoid consulting the auto-save file, and
2260 ;; there's no straightforward way to encourage authors to notice a
2261 ;; reversal of the argument sense. So I'm just changing the user
2262 ;; interface, but leaving the programmatic interface the same.
2269 buffer-auto-save-file-name
2274 buffer-auto-save-file-name
2275 buffer-file-name)))
2280 file-name)))
2282 ;; If file was backed up but has changed since,
2283 ;; we shd make another backup.
2287 ;; Get rid of all undo records for this buffer.
2290 ;; Effectively copy the after-revert-hook status,
2291 ;; since after-find-file will clobber it.
2295 after-revert-hook)))
2297 ;; Don't make undo records for the reversion.
2301 file-name auto-save-p)
2304 ;; Bind buffer-file-name to nil
2305 ;; so that we don't try to lock the file.
2311 nil nil t)))
2313 ;; Recompute the truename in case changes in symlinks
2314 ;; have changed the truename.
2318 ;; Run after-revert-hook as it was before we reverted.
2326 t)))))
2329 "Visit file FILE, but get contents from its last auto-save file."
2330 ;; Actually putting the file name in the minibuffer should be used
2331 ;; only rarely.
2332 ;; Not just because users often use the default.
2349 file file-name)))
2359 "Recover auto save files from a previous Emacs session.
2360 This command first displays a Dired buffer showing you the
2361 previous sessions that you could recover from.
2362 To choose one, move point to the proper line and then type C-c C-c.
2363 Then you'll be asked about a number of files to recover."
2380 "Choose one saved session to recover auto-save files from.
2381 This command is used in the special Dired buffer created by
2384 ;; Get the name of the session file to recover from.
2386 files
2391 ;; Read in the auto-save-list file.
2395 ;; Loop thru the text of that file
2396 ;; and get out the names of the files to recover.
2400 ;; This is a pair of lines for a non-file-visiting buffer.
2401 ;; Get the auto-save file name and manufacture
2402 ;; a "visited file name" from that.
2418 ;; This pair of lines is a file-visiting
2419 ;; buffer. Use the visited file name.
2429 ;; Ignore a file if its auto-save file does not exist now.
2433 ;; The file contains a pair of line for each auto-saved buffer.
2434 ;; The first line of the pair contains the visited file name
2435 ;; or is empty if the buffer was not visiting a file.
2436 ;; The second line is the auto-save file name.
2444 files
2450 "For each buffer in LIST, ask whether to kill it.
2451 LIST defaults to all existing live buffers."
2462 name
2467 \f
2469 "Toggle auto-saving of contents of current buffer.
2470 With prefix argument ARG, turn auto-saving on if positive, else off."
2475 ;; If autosave is off because buffer has shrunk,
2476 ;; then toggling should turn it on.
2481 buffer-file-name
2483 ;; If -1 was stored here, to temporarily turn off saving,
2484 ;; turn it back on.
2490 buffer-auto-save-file-name)
2493 "Adjust current buffer's auto save file name for current conditions.
2494 Also rename any existing auto save file, if it was made in this session."
2506 "Return file name to use for auto-saves of current buffer.
2507 Does not consider `auto-save-visited-file-name' as that variable is checked
2508 before calling this function. You can redefine this for customization.
2509 See also `auto-save-file-name-p'."
2519 "#"
2523 ;; Deal with buffers that don't have any associated files. (Mail
2524 ;; mode tends to create a good number of these.)
2528 ;; Use technique from Sebastian Kremer's auto-save
2529 ;; package to turn slashes into \\!. This ensures that
2530 ;; the auto-save buffer name is unique.
2542 ;; Generate the file name.
2545 ;; Try a few alternative directories, to get one we can write it.
2552 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2553 FILENAME should lack slashes. You can redefine this for customization."
2555 \f
2557 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2558 The generated regexp will match a filename iff the filename
2559 matches that wildcard according to shell rules. Only wildcards known
2560 by `sh' are supported."
2562 ;; Copy the initial run of non-special characters.
2565 ;; If no special characters, we're almost done.
2569 j)
2571 result
2592 ;; Found "[^". Insert a `\0' character
2593 ;; (which cannot happen in a filename)
2594 ;; into the character class, so that `^'
2595 ;; is not the first character after `[',
2596 ;; and thus non-special in a regexp.
2601 ;; I don't think `]' can appear in a
2602 ;; character class in a wildcard, but
2603 ;; let's be general here.
2610 i
2623 ;; Shell wildcards should match the entire filename,
2624 ;; not its part. Make the regexp say so.
2626 \f
2633 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2638 "Display a list of files in or matching DIRNAME, a la `ls'.
2639 DIRNAME is globbed by the shell if necessary.
2640 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2641 Actions controlled by variables `list-directory-brief-switches'
2642 and `list-directory-verbose-switches'."
2646 nil default-directory nil)
2647 pfx)))
2649 list-directory-brief-switches)))
2669 ;; insert-directory
2670 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2671 ;; FULL-DIRECTORY-P is nil.
2672 ;; The single line of output must display FILE's name as it was
2673 ;; given, namely, an absolute path name.
2674 ;; - must insert exactly one line for each file if WILDCARD or
2675 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
2676 ;; before the file lines, plus optional text after the file lines.
2677 ;; Lines are delimited by "\n", so filenames containing "\n" are not
2678 ;; allowed.
2679 ;; File lines should display the basename.
2680 ;; - must be consistent with
2681 ;; - functions dired-move-to-filename, (these two define what a file line is)
2682 ;; dired-move-to-end-of-filename,
2683 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2684 ;; dired-insert-headerline
2685 ;; dired-after-subdir-garbage (defines what a "total" line is)
2686 ;; - variable dired-subdir-regexp
2688 "Insert directory listing for FILE, formatted according to SWITCHES.
2689 Leaves point after the inserted text.
2690 SWITCHES may be a string of options, or a list of strings.
2691 Optional third arg WILDCARD means treat FILE as shell wildcard.
2692 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2693 switches do not contain `d', so that a full listing is expected.
2695 This works by running a directory listing program
2696 whose name is in the variable `insert-directory-program'.
2697 If WILDCARD, it also runs the shell specified by `shell-file-name'."
2698 ;; We need the directory in order to find the right handler.
2703 wildcard full-directory-p)
2708 ;; Run ls in the directory of the file pattern we asked for.
2715 ;; Quote some characters that have special meanings in shells;
2716 ;; but don't quote the wildcards--we want them to be special.
2717 ;; We also currently don't quote the quoting characters
2718 ;; in case people want to use them explicitly to quote
2719 ;; wildcard characters.
2728 insert-directory-program
2729 " -d "
2731 switches
2733 " -- "
2734 pattern)))
2735 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2736 ;; directory if FILE is a symbolic link.
2738 insert-directory-program nil t nil
2744 ;; Split the switches at any spaces
2745 ;; so we can pass separate options as separate args.
2748 list)
2752 ;; Avoid lossage if FILE starts with `-'.
2757 file)))))))
2758 ;; We get here if ls failed.
2759 ;; Access the file to get a suitable error.
2763 "Functions to call with no arguments to query about killing Emacs.
2764 If any of these functions returns nil, killing Emacs is cancelled.
2766 but `kill-emacs', the low level primitive, does not.
2770 "Offer to save each buffer, then kill this Emacs process.
2771 With prefix arg, silently save all file-visiting buffers, then kill."
2780 ;; process-list is not defined on VMS.
2782 active)
2787 val)
2792 ;; Query the user for other things, perhaps.
2795 \f
2796 ;; We use /: as a prefix to "quote" a file name
2797 ;; so that magic file name handlers will not apply to it.
2801 file-name-handler-alist))
2803 ;; We depend on being the last handler on the list,
2804 ;; so that anything else which does need handling
2805 ;; has been handled already.
2806 ;; So it is safe for us to inhibit *all* magic file name handlers.
2810 ;; Get a list of the indices of the args which are file names.
2813 ;; The first four are special because they
2814 ;; return a file name. We want to include the /:
2815 ;; in the return value.
2816 ;; So just avoid stripping it in the first place.
2825 ;; For all other operations, treat the first argument only
2826 ;; as the file name.
2828 ;; Copy ARGUMENTS so we can replace elements in it.
2830 ;; Strip off the /: from the file names that have this handler.
2839 \f
2863 ;;; files.el ends here