| blob | ecaab4e83cac3a1cead7414bc43e3d1e6d268b79 |
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.
513 A prefix argument enables user to specify the coding-system interactively."
521 "Edit file FILENAME, in another window.
522 May create a new window, or reuse an existing one.
523 A prefix argument enables user to specify the coding-system interactively.
524 See the function `display-buffer'."
532 "Edit file FILENAME, in another frame.
533 May create a new frame, or reuse an existing one.
534 A prefix argument enables user to specify the coding-system interactively.
535 See the function `display-buffer'."
543 "Edit file FILENAME but don't allow changes.
545 A prefix argument enables user to specify the coding-system interactively.
553 "Edit file FILENAME in another window but don't allow changes.
555 A prefix argument enables user to specify the coding-system interactively.
563 "Edit file FILENAME in another frame but don't allow changes.
565 A prefix argument enables user to specify the coding-system interactively.
573 "Find file FILENAME as a replacement for the file in the next window.
574 This command does not select that window.
575 A prefix argument enables user to specify the coding-system interactively."
596 "Find file FILENAME, select its buffer, kill previous buffer.
597 If the current buffer now contains an empty file that you just visited
598 \(presumably by mistake), use this command to visit the file you really want.
599 A prefix argument enables user to specify the coding-system interactively."
612 ;; (not buffer-read-only)
641 "Create a suitably named buffer for visiting FILENAME, and return it.
642 FILENAME (sans directory) is used unchanged if that name is free;
643 otherwise a string <2> or <3> or ... is appended to get an unused name."
650 "Create and return a buffer with a name based on NAME.
651 Choose the buffer's name using `generate-new-buffer-name'."
661 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
664 ;; Get rid of the prefixes added by the automounter.
671 ;; If any elt of directory-abbrev-alist matches this name,
672 ;; abbreviate accordingly.
678 ;; Compute and save the abbreviated homedir name.
679 ;; We defer computing this until the first time it's needed, to
680 ;; give time for directory-abbrev-alist to be set properly.
681 ;; We include a slash at the end, to avoid spurious matches
682 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
689 ;; If FILENAME starts with the abbreviated homedir,
690 ;; make it start with `~' instead.
692 ;; If the home dir is just /, don't change it.
695 ;; MS-DOS root directories can come with a drive letter;
696 ;; Novell Netware allows drive letters beyond `Z:'.
705 filename))
708 "*List of logical names for which visiting shouldn't save the true dirname.
709 On VMS, when you visit a file using a logical name that searches a path,
710 you may or may not want the visited file name to record the specific
711 directory where the file was found. If you *do not* want that, add the logical
715 "Return the buffer visiting file FILENAME (a string).
716 This is like `get-file-buffer', except that it checks for any buffer
717 visiting the same file, possibly under a different name.
718 If there is no such live buffer, return nil."
730 found)
734 number
740 ;; Verify this buffer's file number
741 ;; still belongs to its file.
744 number))
747 found))))
750 "Like `insert-file-contents', q.v., but only reads in the file.
751 A buffer may be modified in several ways after reading into the buffer due
752 to advanced Emacs features, such as file-name-handlers, format decoding,
753 find-file-hooks, etc.
754 This function ensures that none of these modifications will take place.
756 This function does not work for remote files, because it turns off
757 file name handlers and remote file access uses a file name handler."
764 nil)))
774 "Read file FILENAME into a buffer and return the buffer.
775 If a buffer exists visiting FILENAME, return that one, but
776 verify that the file has not changed since visited or saved.
777 The buffer is not selected, just returned to the caller.
778 Optional first arg NOWARN non-nil means suppress any warning messages.
779 Optional second arg RAWFILE non-nil means the file is read literally"
787 filename))
792 ;; Find any buffer for a file which has same truename.
794 error)
795 ;; Let user know if there is a buffer with the same truename.
802 ;; Optionally also find that buffer.
810 ;; Certain files should be reverted automatically
811 ;; if they have changed on disk and not in the buffer.
819 found))
829 "File %s changed on disk. Discard your edits? "
834 "File %s changed on disk. Discard your edits in %s? "
841 ;;; The truename stuff makes this obsolete.
842 ;;; (let* ((link-name (car (file-attributes filename)))
843 ;;; (linked-buf (and (stringp link-name)
844 ;;; (get-file-buffer link-name))))
845 ;;; (if (bufferp linked-buf)
846 ;;; (message "Symbolic link to file in buffer %s"
847 ;;; (buffer-name linked-buf))))
856 ;; Unconditionally set error
861 ;; Run find-file-not-found-hooks until one returns non-nil.
863 ;; If they fail too, set error.
865 ;; Find the file's truename, and maybe use that as visited name.
868 ;; On VMS, we may want to remember which directory in a search list
869 ;; the file was found in.
881 ;; Set buffer's default directory to that of the file.
883 ;; Turn off backup files for certain file names. Since
884 ;; this is a permanent local, the major mode won't eliminate it.
890 nil
893 buf)))
894 \f
898 after-find-file-from-revert-buffer
899 nomodes)
900 "Called after finding a file and by the default revert function.
901 Sets buffer mode, parses local variables.
902 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
903 error in reading the file. WARN non-nil means warn if there
904 exists an auto-save file more recent than the visited file.
905 NOAUTO means don't mess with auto-save mode.
906 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
907 means this call was from `revert-buffer'.
908 Fifth arg NOMODES non-nil means don't alter the file's modes.
909 Finishes by calling the functions in `find-file-hooks'
910 unless NOMODES is non-nil."
913 nil
922 buffer-file-name))
936 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
937 "Use M-x make-dir RET RET to create the directory"
946 nil
951 "Choose the major mode for this buffer automatically.
952 Also sets up any specified local variables of the file.
953 Uses the visited file name, the -*- line, and the local variables spec.
955 This function is called automatically from `find-file'. In that case,
956 we may set up specified local variables depending on the value of
957 `enable-local-variables': if it is t, we do; if it is nil, we don't;
958 otherwise, we query. `enable-local-variables' is ignored if you
959 run `normal-mode' explicitly."
968 enable-local-variables)))
1012 ;;; Less common extensions come here
1013 ;;; so more common ones above are found faster.
1023 ;; for MSDOS and MS-Windows (which are case-insensitive)
1032 ;;; The following should come after the ChangeLog pattern
1033 ;;; for the sake of ChangeLog.1, etc.
1034 ;;; and after the .scm.[0-9] pattern too.
1054 ;; Mailer puts message to be edited in
1055 ;; /tmp/Re.... or Message
1059 ;; some news reader is reported to use this
1068 ;; .emacs following a directory delimiter
1069 ;; in either Unix or VMS syntax.
1071 ;; _emacs following a directory delimiter
1072 ;; in MsDos syntax
1075 "\
1076 Alist of filename patterns vs corresponding major mode functions.
1077 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1078 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1079 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1080 mode function to use. FUNCTION will be called, unless it is nil.
1082 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1083 calling FUNCTION (if it's not nil), we delete the suffix that matched
1119 "Alist mapping interpreter names to major modes.
1120 This alist applies to files whose first line starts with `#!'.
1121 Each element looks like (INTERPRETER . MODE).
1122 The car of each element is compared with
1123 the name of the interpreter specified in the first line.
1130 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1131 When checking `inhibit-first-line-modes-regexps', we first discard
1139 "Select major mode appropriate for current buffer.
1140 This checks for a -*- mode tag in the buffer's text,
1141 compares the filename against the entries in `auto-mode-alist',
1142 or checks the interpreter that runs this file against
1143 `interpreter-mode-alist'.
1145 It does not check for the `mode:' local variable in the
1146 Local Variables section of the file; for that, use `hack-local-variables'.
1148 If `enable-local-variables' is nil, this function does not check for a
1149 -*- mode tag."
1150 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1156 ;; Don't look for -*- if this file name matches any
1157 ;; of the regexps in inhibit-first-line-modes-regexps.
1165 sufs)
1172 ;; If the file begins with "#!"
1173 ;; (exec interpreter magic), look
1174 ;; for mode frobs in the first two
1175 ;; lines. You cannot necessarily
1176 ;; put them in the first line of
1177 ;; such a file without screwing up
1178 ;; the interpreter invocation.
1186 t))
1193 ;; Find all specifications for the `mode:' variable
1194 ;; and execute them left to right.
1206 modes)))
1207 ;; Simple -*-MODE-*- case.
1210 modes))))))
1211 ;; If we found modes to use, invoke them now,
1212 ;; outside the save-excursion.
1216 ;; If we didn't find a mode from a -*- line, try using the file name.
1220 ;; Remove backup-suffixes from file name.
1226 ;; Find first matching alist entry.
1236 keep-going t))
1238 keep-going nil)))
1242 ;; If we can't deduce a mode from the file name,
1243 ;; look for an interpreter specified in the first line.
1244 ;; As a special case, allow for things like "#!/bin/env perl",
1245 ;; which finds the interpreter anywhere in $PATH.
1253 elt)
1254 ;; Map interpreter name to a mode.
1256 interpreter-mode-alist))
1261 ;; Set local variables specified in the -*- line.
1262 ;; Ignore any specification for `mode:';
1263 ;; set-auto-mode should already have handled that.
1268 ;; Parse the -*- line into the `result' alist.
1270 ;; doesn't have one.
1271 nil)
1273 ;; Simple form: "-*- MODENAME -*-". Already handled.
1274 nil)
1276 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1277 ;; (last ";" is optional).
1286 ;; There used to be a downcase here,
1287 ;; but the manual didn't say so,
1288 ;; and people want to set var names that aren't all lc.
1295 ;; It is traditional to ignore
1296 ;; case when checking for `mode' in set-auto-mode,
1297 ;; so we must do that here as well.
1298 ;; That is inconsistent, but we're stuck with it.
1311 ;; If we fail to switch in the selected window,
1312 ;; it is probably a minibuffer.
1313 ;; So try another window.
1326 "Normal hook run after processing a file's local variables specs.
1327 Major modes can use this to examine user-specified local variables
1331 "Parse and put into effect this buffer's local variables spec."
1333 ;; Look for "Local variables:" line in last page.
1349 buffer-file-name)
1353 prefix prefixlen suffix beg
1355 ;; The prefix is what comes before "local variables:" in its line.
1356 ;; The suffix is what comes after "local variables:" in its line.
1371 ;; Look at next local variable spec.
1374 ;; Skip the prefix, if any.
1379 ;; Find the variable name; strip whitespace.
1387 val)
1388 ;; Setting variable named "end" means end of list.
1391 ;; Otherwise read the variable value.
1399 ;; Set the variable. "Variables" mode and eval are funny.
1407 ;; Get confirmation before setting these variables as locals in a file.
1424 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1428 ;; This one is safe because the user gets to check it before it is used.
1434 ;; "Set" one variable in a local variables spec.
1435 ;; A few variable names are treated specially.
1441 nil)
1442 ;; "Setting" eval means either eval it or do nothing.
1443 ;; Likewise for setting hook variables.
1449 ;; Permit evalling a put of a harmless property.
1450 ;; if the args do nothing tricky.
1456 ;; Only allow safe values of lisp-indent-hook;
1457 ;; not functions.
1462 ;; Permit eval if not root and user says ok.
1479 ;; Ordinary variable, really set it.
1483 \f
1485 "Change name of file visited in current buffer to FILENAME.
1486 The next time the buffer is saved it will go in the newly specified file.
1487 nil or empty string as argument means make buffer not be visiting any file.
1488 Remember to delete the initial contents of the minibuffer
1489 if you wish to pass an empty string as the argument.
1491 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1492 confirmation in the case where another buffer is already visiting FILENAME.
1494 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1495 the old visited file has been renamed to the new name FILENAME."
1503 nil
1514 filename)))
1533 ;; Abbreviate the file names of the buffer.
1542 nil)))
1543 ;; write-file-hooks is normally used for things like ftp-find-file
1544 ;; that visit things that are not local files as if they were files.
1545 ;; Changing to visit an ordinary local file instead should flush the hook.
1550 ;; If buffer was read-only because of version control,
1551 ;; that reason is gone now, so make it writable.
1555 ;; Turn off backup files for certain file names.
1556 ;; Since this is a permanent local, the major mode won't eliminate it.
1562 ;; If auto-save was not already on, turn it on if appropriate.
1566 ;; If auto save is on, start using a new name.
1567 ;; We deliberately don't rename or delete the old auto save
1568 ;; for the old visited file name. This is because perhaps
1569 ;; the user wants to save the new state and then compare with the
1570 ;; previous state from the auto save file.
1573 ;; Rename the old auto save file if any.
1582 "Write current buffer into file FILENAME.
1583 Makes buffer visit that file, and marks it not modified.
1584 If the buffer is already visiting a file, you can specify
1585 a directory name as FILENAME, to write a file of the same
1586 old name in that directory.
1588 If optional second arg CONFIRM is non-nil,
1589 ask for confirmation for overwriting an existing file.
1590 Interactively, confirmation is required unless you supply a prefix argument.
1592 A prefix argument also enables user to interactively specify a
1593 coding-system for encoding the file."
1594 ;; (interactive "FWrite file: ")
1598 nil nil nil nil)
1606 ))
1609 ;; If arg is just a directory,
1610 ;; use same file name, but in that directory.
1622 ;; It is convenient to change buffer-file-coding-system to the
1623 ;; specified one.
1627 \f
1629 "Make a backup of the disk file visited by the current buffer, if appropriate.
1630 This is normally done before saving the buffer the first time.
1631 If the value is non-nil, it is the result of `file-modes' on the original
1632 file; this means that the caller, after saving the buffer, should change
1633 the modes of the new file to agree with the old modes.
1635 A backup may be done by renaming or by copying; see documentation of
1636 variable `make-backup-files'. If it's done by renaming, then the file is
1637 no longer accessible under its old name."
1644 backup-info backupname targets setmodes)
1645 ;; If specified name is a symbolic link, chase it to the target.
1646 ;; Thus we make the backups in the directory where the real file is.
1651 ;;; (if (file-directory-p buffer-file-name)
1652 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1656 ;; If have old versions to maybe delete,
1657 ;; ask the user to confirm now, before doing anything.
1658 ;; But don't actually delete til later.
1663 real-file-name))))))
1664 ;; Actually write the back up file.
1667 ; (file-symlink-p buffer-file-name)
1668 backup-by-copying
1678 ;; If copying fails because file BACKUPNAME
1679 ;; is not writable, delete that file and try again.
1684 ;; rename-file should delete old backup.
1688 ;; If trouble writing the backup, write it in ~.
1698 ;; If copying fails because file BACKUPNAME
1699 ;; is not writable, delete that file and try again.
1705 ;; Now delete the old versions, if desired.
1712 setmodes)
1716 "Return FILENAME sans backup versions or strings.
1717 This is a separate procedure so your site-init or startup file can
1718 redefine it.
1719 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1720 we do not remove backup version numbers, only true file version numbers."
1726 ;; VMS version number is (a) semicolon, optional
1727 ;; sign, zero or more digits or (b) period, option
1728 ;; sign, zero or more digits, provided this is the
1729 ;; second period encountered outside of the
1730 ;; device/directory part of the file name.
1733 name)
1743 "Returns t if deleting FILE and rewriting it would preserve the owner."
1748 ;; Return t if the file doesn't exist, since it's true that no
1749 ;; information would be lost by an (attempted) delete and create.
1755 The extension, in a file name, is the part that follows the last `.'."
1758 directory)
1762 directory)
1764 filename))))
1768 The extension, in a file name, is the part that follows the last `.'.
1769 Return nil for extensionless file names such as `foo'.
1770 Return the empty string for file names such as `foo.'.
1772 If PERIOD is non-nil, then the returned value includes the period
1773 that delimits the extension, and if FILENAME has no extension,
1783 "Create the non-numeric backup file name for FILE.
1784 This is a separate function so you can redefine it for customization."
1797 "Return non-nil if FILE is a backup file name (numeric or not).
1798 This is a separate function so you can redefine it for customization.
1799 You may need to redefine `file-name-sans-versions' as well."
1802 ;; This is used in various files.
1803 ;; The usage of bv-length is not very clean,
1804 ;; but I can't see a good alternative,
1805 ;; so as of now I am leaving it alone.
1807 "Given the name of a numeric backup file, return the backup number.
1808 Uses the free variable `bv-length', whose value should be
1809 the index in the name where the version number begins."
1815 ;; I believe there is no need to alter this behavior for VMS;
1816 ;; since backup files are not made on VMS, it should not get called.
1818 "Find a file name for a backup file, and suggestions for deletions.
1819 Value is a list whose car is the name for the backup file
1820 and whose cdr is a list of old versions to consider deleting now.
1821 If the value is nil, don't make a backup."
1823 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1830 possibilities
1837 base-versions
1841 possibilities)
1842 '<)
1854 ;; Delete nothing if there is overflow
1855 ;; in the number of versions to keep.
1861 v))))))))))
1864 "Return number of names file FILENAME has."
1868 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
1869 This function returns a relative file name which is equivalent to FILENAME
1870 when used with that default directory as the default.
1871 If this is impossible (which can happen on MSDOS and Windows
1872 when the file name and directory use different drive names)
1873 then it returns FILENAME."
1878 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
1879 ;; drive names, they can't be relative, so return the absolute name.
1884 filename
1890 \f
1892 "Save current buffer in visited file if modified. Versions described below.
1893 By default, makes the previous version into a backup file
1894 if previously requested or if this is the first save.
1896 to become a backup when the next save is done.
1898 unconditionally makes the previous version into a backup file.
1900 to become a backup when the next save is done,
1901 and unconditionally makes the previous version into a backup file.
1903 With argument of 0, never makes the previous version into a backup file.
1905 If a file's name is FOO, the names of its numbered backup versions are
1906 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1907 Numeric backups (rather than FOO~) will be made if value of
1908 `version-control' is not the atom `never' and either there are already
1909 numeric versions of the file being backed up, or `version-control' is
1910 non-nil.
1911 We don't want excessive versions piling up, so there are variables
1912 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1913 and `kept-new-versions', which tells how many newest versions to keep.
1914 Defaults are 2 old versions and 2 new.
1915 `dired-kept-versions' controls dired's clean-directory (.) command.
1916 If `delete-old-versions' is nil, system will query user
1917 before trimming versions. Otherwise it does it silently."
1929 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1930 Normally delete only if the file was written by this Emacs since
1931 the last real save, but optional arg FORCE non-nil means delete anyway."
1945 "Save the current buffer in its visited file, if it has been modified.
1946 After saving the buffer, run `after-save-hook'."
1949 ;; In an indirect buffer, save its base buffer instead.
1954 setmodes tempsetmodes)
1955 ;; On VMS, rename file and buffer to get rid of version number.
1960 ;; Strip VMS version number before save.
1963 ;; Construct a (unique) buffer name to correspond.
1968 ;; If buffer has no file name, ask user for one.
1975 filename))
2001 ;; If a hook returned t, file is already "written".
2002 ;; Otherwise, write it the usual way now.
2010 ;; If the auto-save file was recent before this command,
2011 ;; delete it now.
2013 ;; Support VC `implicit' locking.
2018 ;; This does the "real job" of writing a buffer into its visited file
2019 ;; and making a backup file. This is what is normally done
2020 ;; but inhibited if one of write-file-hooks returns non-nil.
2021 ;; It returns a value to store in setmodes.
2033 buffer-file-name)))
2041 ;; If file is precious, write temp name, then rename it.
2042 ;; This requires write access to the containing dir,
2043 ;; which is why we don't try it if we don't have that access.
2045 tempname temp nogood i succeed
2049 ;; Find the temporary name to write under.
2056 dir i))
2062 tempname nil realname
2063 buffer-file-truename)
2065 ;; If writing the temp file fails,
2066 ;; delete the temp file.
2071 ;; Since we have created an entirely new file
2072 ;; and renamed it, make sure it gets the
2073 ;; right permission bits set.
2075 ;; We succeeded in writing the temp file,
2076 ;; so rename it.
2078 ;; If file not writable, see if we can make it writable
2079 ;; temporarily while we write it.
2080 ;; But no need to do so if we have just backed it up
2081 ;; (setmodes is set) because that says we're superseding.
2083 ;; Change the mode back, after writing.
2087 buffer-file-name nil t buffer-file-truename)))
2088 setmodes))
2091 "Save some modified file-visiting buffers. Asks user about each one.
2092 Optional argument (the prefix) non-nil means save all with no questions.
2093 Optional second argument EXITING means ask about certain non-file buffers
2094 as well as about file buffers."
2111 t
2130 ;; Return nil to ask about BUF again.
2131 nil)
2138 abbrev-file-name)))
2140 ;; Don't keep bothering user if he says no.
2142 t))))
2145 \f
2147 "Mark current buffer as unmodified, not needing to be saved.
2150 It is not a good idea to use this function in Lisp programs, because it
2151 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2158 "Change whether this buffer is visiting its file read-only.
2159 With arg, set read-only iff arg is positive."
2168 "Insert contents of file FILENAME into buffer after point.
2169 Set mark after the inserted text.
2170 A prefix argument enables user to specify the coding-system interactively.
2172 This function is meant for the user to run interactively.
2173 Don't call it from programs! Use `insert-file-contents' instead.
2174 \(Its calling sequence is different; see its documentation)."
2178 filename)))
2187 "Append the contents of the region to the end of file FILENAME.
2188 When called from a function, expects three arguments,
2189 START, END and FILENAME. START and END are buffer positions
2190 saying what text to write.
2191 A prefix argument enables user to specify the coding-system interactively."
2199 "Return most recent backup file for FILENAME or nil if no backups exist."
2205 tem)
2215 newest))
2218 "Rename current buffer to a similar name not already taken.
2219 This function is useful for creating multiple shell process buffers
2220 or multiple mail buffers, etc."
2227 buffer-file-name)))))
2228 ;; If the existing buffer name has a <NNN>,
2229 ;; which isn't part of the file name (if any),
2230 ;; then get rid of that.
2240 "Create the directory DIR and any nonexistent parent dirs.
2241 Interactively, the default choice of directory to create
2242 is the current default directory for file names.
2243 That is useful when you have visited a file in a nonexistent directory.
2245 Noninteractively, the second (optional) argument PARENTS says whether
2246 to create parent directories if they don't exist."
2249 nil nil)
2250 t))
2257 create-list)
2264 \f
2267 "Function to use to revert this buffer, or nil to do the default.
2268 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2273 "Function to use to insert contents when reverting this buffer.
2274 Gets two args, first the nominal file name to use,
2278 "Normal hook for `revert-buffer' to run before reverting.
2279 If `revert-buffer-function' is used to override the normal revert
2283 "Normal hook for `revert-buffer' to run after reverting.
2284 Note that the hook value that it runs is the value that was in effect
2285 before reverting; that makes a difference if you have buffer-local
2286 hook functions.
2288 If `revert-buffer-function' is used to override the normal revert
2292 "Replace current buffer text with the text of the visited file on disk.
2293 This undoes all changes since the file was visited or saved.
2294 With a prefix argument, offer to revert from latest auto-save file, if
2295 that is more recent than the visited file.
2297 This command also works for special buffers that contain text which
2298 doesn't come from a file, but reflects some other data base instead:
2299 for example, Dired buffers and buffer-list buffers. In these cases,
2300 it reconstructs the buffer contents from the appropriate data base.
2302 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2303 to revert from the auto-save file when this is nil. Note that the
2304 sense of this argument is the reverse of the prefix argument, for the
2305 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2306 to nil.
2308 Optional second argument NOCONFIRM means don't ask for confirmation at
2309 all.
2311 Optional third argument PRESERVE-MODES non-nil means don't alter
2312 the files modes. Normally we reinitialize them using `normal-mode'.
2314 If the value of `revert-buffer-function' is non-nil, it is called to
2315 do all the work for this command. Otherwise, the hooks
2316 `before-revert-hook' and `after-revert-hook' are run at the beginning
2317 and the end, and if `revert-buffer-insert-file-contents-function' is
2318 non-nil, it is called instead of rereading visited file contents."
2320 ;; I admit it's odd to reverse the sense of the prefix argument, but
2321 ;; there is a lot of code out there which assumes that the first
2322 ;; argument should be t to avoid consulting the auto-save file, and
2323 ;; there's no straightforward way to encourage authors to notice a
2324 ;; reversal of the argument sense. So I'm just changing the user
2325 ;; interface, but leaving the programmatic interface the same.
2332 buffer-auto-save-file-name
2337 buffer-auto-save-file-name
2338 buffer-file-name)))
2343 file-name)))
2345 ;; If file was backed up but has changed since,
2346 ;; we shd make another backup.
2350 ;; Get rid of all undo records for this buffer.
2353 ;; Effectively copy the after-revert-hook status,
2354 ;; since after-find-file will clobber it.
2358 after-revert-hook)))
2360 ;; Don't make undo records for the reversion.
2364 file-name auto-save-p)
2367 ;; Bind buffer-file-name to nil
2368 ;; so that we don't try to lock the file.
2374 nil nil t)))
2376 ;; Recompute the truename in case changes in symlinks
2377 ;; have changed the truename.
2381 ;; Run after-revert-hook as it was before we reverted.
2389 t)))))
2392 "Visit file FILE, but get contents from its last auto-save file."
2393 ;; Actually putting the file name in the minibuffer should be used
2394 ;; only rarely.
2395 ;; Not just because users often use the default.
2412 file file-name)))
2416 ;; Auto-saved file shoule be read without any code conversion.
2424 "Recover auto save files from a previous Emacs session.
2425 This command first displays a Dired buffer showing you the
2426 previous sessions that you could recover from.
2427 To choose one, move point to the proper line and then type C-c C-c.
2428 Then you'll be asked about a number of files to recover."
2446 "Choose one saved session to recover auto-save files from.
2447 This command is used in the special Dired buffer created by
2450 ;; Get the name of the session file to recover from.
2452 files
2457 ;; Read in the auto-save-list file.
2461 ;; Loop thru the text of that file
2462 ;; and get out the names of the files to recover.
2466 ;; This is a pair of lines for a non-file-visiting buffer.
2467 ;; Get the auto-save file name and manufacture
2468 ;; a "visited file name" from that.
2484 ;; This pair of lines is a file-visiting
2485 ;; buffer. Use the visited file name.
2495 ;; Ignore a file if its auto-save file does not exist now.
2499 ;; The file contains a pair of line for each auto-saved buffer.
2500 ;; The first line of the pair contains the visited file name
2501 ;; or is empty if the buffer was not visiting a file.
2502 ;; The second line is the auto-save file name.
2510 files
2516 "For each buffer in LIST, ask whether to kill it.
2517 LIST defaults to all existing live buffers."
2528 name
2533 \f
2535 "Toggle auto-saving of contents of current buffer.
2536 With prefix argument ARG, turn auto-saving on if positive, else off."
2541 ;; If autosave is off because buffer has shrunk,
2542 ;; then toggling should turn it on.
2547 buffer-file-name
2549 ;; If -1 was stored here, to temporarily turn off saving,
2550 ;; turn it back on.
2556 buffer-auto-save-file-name)
2559 "Adjust current buffer's auto save file name for current conditions.
2560 Also rename any existing auto save file, if it was made in this session."
2572 "Return file name to use for auto-saves of current buffer.
2573 Does not consider `auto-save-visited-file-name' as that variable is checked
2574 before calling this function. You can redefine this for customization.
2575 See also `auto-save-file-name-p'."
2585 "#"
2589 ;; Deal with buffers that don't have any associated files. (Mail
2590 ;; mode tends to create a good number of these.)
2594 ;; Eliminate all slashes and backslashes by
2595 ;; replacing them with sequences that start with %.
2596 ;; Quote % also, to keep distinct names distinct.
2605 ;; Generate the file name.
2608 ;; Try a few alternative directories, to get one we can write it.
2615 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2616 FILENAME should lack slashes. You can redefine this for customization."
2618 \f
2620 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2621 The generated regexp will match a filename iff the filename
2622 matches that wildcard according to shell rules. Only wildcards known
2623 by `sh' are supported."
2625 ;; Copy the initial run of non-special characters.
2628 ;; If no special characters, we're almost done.
2632 j)
2634 result
2655 ;; Found "[^". Insert a `\0' character
2656 ;; (which cannot happen in a filename)
2657 ;; into the character class, so that `^'
2658 ;; is not the first character after `[',
2659 ;; and thus non-special in a regexp.
2664 ;; I don't think `]' can appear in a
2665 ;; character class in a wildcard, but
2666 ;; let's be general here.
2673 i
2686 ;; Shell wildcards should match the entire filename,
2687 ;; not its part. Make the regexp say so.
2689 \f
2696 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2701 "Display a list of files in or matching DIRNAME, a la `ls'.
2702 DIRNAME is globbed by the shell if necessary.
2703 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2704 Actions controlled by variables `list-directory-brief-switches'
2705 and `list-directory-verbose-switches'."
2709 nil default-directory nil)
2710 pfx)))
2712 list-directory-brief-switches)))
2732 ;; insert-directory
2733 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2734 ;; FULL-DIRECTORY-P is nil.
2735 ;; The single line of output must display FILE's name as it was
2736 ;; given, namely, an absolute path name.
2737 ;; - must insert exactly one line for each file if WILDCARD or
2738 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
2739 ;; before the file lines, plus optional text after the file lines.
2740 ;; Lines are delimited by "\n", so filenames containing "\n" are not
2741 ;; allowed.
2742 ;; File lines should display the basename.
2743 ;; - must be consistent with
2744 ;; - functions dired-move-to-filename, (these two define what a file line is)
2745 ;; dired-move-to-end-of-filename,
2746 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2747 ;; dired-insert-headerline
2748 ;; dired-after-subdir-garbage (defines what a "total" line is)
2749 ;; - variable dired-subdir-regexp
2751 "Insert directory listing for FILE, formatted according to SWITCHES.
2752 Leaves point after the inserted text.
2753 SWITCHES may be a string of options, or a list of strings.
2754 Optional third arg WILDCARD means treat FILE as shell wildcard.
2755 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2756 switches do not contain `d', so that a full listing is expected.
2758 This works by running a directory listing program
2759 whose name is in the variable `insert-directory-program'.
2760 If WILDCARD, it also runs the shell specified by `shell-file-name'."
2761 ;; We need the directory in order to find the right handler.
2766 wildcard full-directory-p)
2771 ;; Run ls in the directory of the file pattern we asked for.
2778 ;; Quote some characters that have special meanings in shells;
2779 ;; but don't quote the wildcards--we want them to be special.
2780 ;; We also currently don't quote the quoting characters
2781 ;; in case people want to use them explicitly to quote
2782 ;; wildcard characters.
2791 insert-directory-program
2792 " -d "
2794 switches
2796 " -- "
2797 pattern)))
2798 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2799 ;; directory if FILE is a symbolic link.
2801 insert-directory-program nil t nil
2807 ;; Split the switches at any spaces
2808 ;; so we can pass separate options as separate args.
2811 list)
2815 ;; Avoid lossage if FILE starts with `-'.
2820 file)))))))
2821 ;; We get here if ls failed.
2822 ;; Access the file to get a suitable error.
2826 "Functions to call with no arguments to query about killing Emacs.
2827 If any of these functions returns nil, killing Emacs is cancelled.
2829 but `kill-emacs', the low level primitive, does not.
2833 "Offer to save each buffer, then kill this Emacs process.
2834 With prefix arg, silently save all file-visiting buffers, then kill."
2843 ;; process-list is not defined on VMS.
2845 active)
2850 val)
2855 ;; Query the user for other things, perhaps.
2858 \f
2859 ;; We use /: as a prefix to "quote" a file name
2860 ;; so that magic file name handlers will not apply to it.
2864 file-name-handler-alist))
2866 ;; We depend on being the last handler on the list,
2867 ;; so that anything else which does need handling
2868 ;; has been handled already.
2869 ;; So it is safe for us to inhibit *all* magic file name handlers.
2873 ;; Get a list of the indices of the args which are file names.
2876 ;; The first four are special because they
2877 ;; return a file name. We want to include the /:
2878 ;; in the return value.
2879 ;; So just avoid stripping it in the first place.
2888 ;; For all other operations, treat the first argument only
2889 ;; as the file name.
2891 ;; Copy ARGUMENTS so we can replace elements in it.
2893 ;; Strip off the /: from the file names that have this handler.
2902 \f
2926 ;;; files.el ends here