| blob | d481f3370ed37498224bb53f7b76574e14535e88 |
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:
34 "Backups of edited data files."
38 "Finding and editing files."
43 "*Non-nil means delete auto-save file when a buffer is saved or killed."
48 nil
49 "*Alist of abbreviations for file directories.
50 A list of elements of the form (FROM . TO), each meaning to replace
51 FROM with TO when it appears in a directory name. This replacement is
52 done when setting up the default directory of a newly visited file.
53 *Every* FROM string should start with `^'.
55 Do not use `~' in the TO strings.
56 They should be ordinary absolute directory names.
58 Use this feature when you have directories which you normally refer to
59 via absolute symbolic links. Make TO the name of the link, and FROM
60 the name it is linked to."
68 ;;; Turn off backup files on VMS since it has version numbers.
70 "*Non-nil means make a backup of a file the first time it is saved.
71 This can be done by renaming the file or by copying.
73 Renaming means that Emacs renames the existing file so that it is a
74 backup file, then writes the buffer into a new file. Any other names
75 that the old file had will now refer to the backup file. The new file
76 is owned by you and its group is defaulted.
78 Copying means that Emacs copies the existing file into the backup
79 file, then writes the buffer on top of the existing file. Any other
80 names that the old file had will now refer to the new (edited) file.
81 The file's owner and group are unchanged.
83 The choice of renaming or copying is controlled by the variables
84 `backup-by-copying', `backup-by-copying-when-linked' and
85 `backup-by-copying-when-mismatch'. See also `backup-inhibited'."
89 ;; Do this so that local variables based on the file name
90 ;; are not overridden by the major mode.
92 "Non-nil means don't make a backup, regardless of the other parameters.
93 This variable is intended for use by making it local to a buffer.
98 "*Non-nil means always use copying to create backup files.
99 See documentation of variable `make-backup-files'."
104 "*Non-nil means use copying to create backups for files with multiple names.
105 This causes the alternate names to refer to the latest version as edited.
106 This variable is relevant only if `backup-by-copying' is nil."
111 "*Non-nil means create backups by copying if this preserves owner or group.
112 Renaming may still be used (subject to control of other variables)
113 when it would not result in changing the owner or group of the file;
114 that is, for files which are owned by you and whose group matches
115 the default for a new file created there by you.
116 This variable is relevant only if `backup-by-copying' is nil."
124 "Predicate that looks at a file name and decides whether to make backups.
128 "*Non-nil in a buffer means offer to save the buffer on exit
129 even if the buffer is not visiting a file.
130 Automatically local in all buffers."
136 "*Non-nil means find a file under alternative names, in existing buffers.
137 This means if any existing buffer is visiting the file you want
138 under another name, you get the existing buffer instead of a new buffer."
143 "*Non-nil means visit a file under its truename.
144 The truename of a file is found by chasing all links
145 both at the file level and at the levels of the containing directories."
150 nil
151 "*Specify which files should be reverted without query.
152 The value is a list of regular expressions.
153 If the file name matches one of these regular expressions,
154 then `revert-buffer' reverts the file without querying
155 if the file has changed on disk and you have not edited the buffer."
160 "The device number and file number of the file visited in the current buffer.
161 The value is a list of the form (FILENUM DEVNUM).
162 This pair of numbers uniquely identifies the file.
171 "*Non-nil means protect against I/O errors while saving files.
172 Some modes set this non-nil in particular buffers.
174 This feature works by writing the new contents into a temporary file
175 and then renaming the temporary file to replace the original.
176 In this way, any I/O error in writing leaves the original untouched,
177 and there is never any instant where the file is nonexistent.
179 Note that this feature forces backups to be made by copying.
180 Yet, at the same time, saving a precious file
181 breaks any hard links between it and other files."
186 "*Control use of version numbers for backup files.
187 t means make numeric backup versions unconditionally.
188 nil means make them for files that have some already.
189 `never' means do not make them."
195 "*When cleaning directory, number of versions to keep."
201 "*If t, delete excess backup versions silently.
202 If nil, ask confirmation. Any other value prevents any trimming."
209 "*Number of oldest versions to keep when a new numbered backup is made."
214 "*Number of newest versions to keep when a new numbered backup is made.
215 Includes the new backup. Must be > 0"
220 "*Value of t says silently ensure a file ends in a newline when it is saved.
221 Non-nil but not t says ask user whether to add a newline when there isn't one.
222 nil means don't add newlines."
227 "*Non-nil says by default do auto-saving of every file-visiting buffer."
232 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
233 Normally auto-save files are written under other names."
238 "*Non-nil means save word abbrevs too when files are saved.
239 Loading an abbrev file sets this to t."
244 "*Non-nil says run dired if `find-file' is given the name of a directory."
248 ;;;It is not useful to make this a local variable.
249 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
251 "List of functions to be called for `find-file' on nonexistent file.
252 These functions are called as soon as the error is detected.
253 `buffer-file-name' is already set up.
256 ;;;It is not useful to make this a local variable.
257 ;;;(put 'find-file-hooks 'permanent-local t)
259 "List of functions to be called after a buffer is loaded from a file.
260 The buffer's local variables (if any) will have been processed before the
264 "List of functions to be called before writing out a buffer to a file.
265 If one of them returns non-nil, the file is considered already written
266 and the rest are not called.
267 These hooks are considered to pertain to the visited file.
268 So this list is cleared if you change the visited file name.
270 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
272 ;;; However, in case someone does make it local...
276 "Just like `write-file-hooks', except intended for per-buffer use.
277 The functions in this list are called before the ones in
278 `write-file-hooks'.
280 This variable is meant to be used for hooks that have to do with a
281 particular visited file. Therefore, it is a permanent local, so that
282 changing the major mode does not clear it. However, calling
288 "List of functions to be called before writing out a buffer to a file.
289 If one of them returns non-nil, the file is considered already written
290 and the rest are not called.
292 This variable is meant to be used for hooks that pertain to the
293 buffer's contents, not to the particular visited file; thus,
294 `set-visited-file-name' does not clear this variable; but changing the
295 major mode does clear it.
297 This variable automatically becomes buffer-local whenever it is set.
298 If you use `add-hook' to add elements to the list, use nil for the
299 LOCAL argument.
305 "*Control use of local variables in files you visit.
306 The value can be t, nil or something else.
307 A value of t means file local variables specifications are obeyed;
308 nil means they are ignored; anything else means query.
311 specifications and ignores this variable."
319 The value can be t, nil or something else.
320 A value of t means obey `eval' variables;
321 nil means ignore them; anything else means query.
324 and ignores this variable."
330 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
338 ;; This hook function provides support for ange-ftp host name
339 ;; completion. It runs the usual ange-ftp hook, but only for
340 ;; completion operations. Having this here avoids the need
341 ;; to load ange-ftp when it's not really in use.
348 inhibit-file-name-handlers)))
353 "Convert a standard file's name to something suitable for the current OS.
354 This function's standard definition is trivial; it just returns the argument.
355 However, on some systems, the function is redefined
356 with a definition that really does change some file names."
357 filename)
358 \f
360 "Show the current default directory."
365 "Value of the CDPATH environment variable, as a list.
372 "Explode a colon-separated search path into a list of directory names."
380 nil
385 cd-list)))
388 "Change current directory to given absolute file name DIR."
389 ;; Put the name into directory syntax now,
390 ;; because otherwise expand-file-name may give some bad results.
401 "Make DIR become the current buffer's default directory.
402 If your environment includes a `CDPATH' variable, try each one of that
403 colon-separated list of directories when resolving a relative directory name."
406 default-directory default-directory
422 cd-path)
423 nil))
427 "Load the Lisp file named FILE."
432 "Load the library named LIBRARY.
433 This is an interface to the function `load'."
438 "Copy the file FILE into a temporary file on this machine.
439 Returns the name of the local copy, or nil, if FILE is directly
440 accessible."
444 nil)))
447 "Return the truename of FILENAME, which should be absolute.
448 The truename of a file name is found by chasing symbolic links
449 both at the level of the file and at the level of the directories
450 containing it, until no links are left at any level.
452 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
453 Do not specify them in other calls."
454 ;; COUNTER can be a cons cell whose car is the count of how many more links
455 ;; to chase before getting an error.
456 ;; PREV-DIRS can be a cons cell whose car is an alist
457 ;; of truenames we've just recently computed.
459 ;; The last test looks dubious, maybe `+' is meant here? --simon.
469 ;; For speed, remove the ange-ftp completion handler from the list.
470 ;; We know it's not needed here.
471 ;; For even more speed, do this only on the outermost call.
477 ;; If this file directly leads to a link, process that iteratively
478 ;; so that we don't use lots of stack.
484 ;; For file name that has a special handler, call handler.
485 ;; This is so that ange-ftp can save time by doing a no-op.
488 done t)
490 target dirfile)
491 ;; Get the truename of the directory.
493 ;; If these are equal, we have the (or a) root directory.
495 ;; If this is the same dir we last got the truename for,
496 ;; save time--don't recalculate.
506 done t)
509 done t)
510 ;; Put it back on the file name.
512 ;; Is the file name the name of a link?
515 ;; Yes => chase that link, then start all over
516 ;; since the link may point to a directory name that uses links.
517 ;; We can't safely use expand-file-name here
518 ;; since target might look like foo/../bar where foo
519 ;; is itself a link. Instead, we handle . and .. above.
522 target
524 done nil)
525 ;; No, we are done!
527 filename))
530 "Chase links in FILENAME until a name that is not a link.
531 Does not examine containing directories for links,
532 unlike `file-truename'."
537 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
541 ;; Handle `..' by hand, since it needs to work in the
542 ;; target of any directory symlink.
543 ;; This code is not quite complete; it does not handle
544 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
548 ;; Do the .. by hand.
551 ;; Chase links in the default dir of the symlink.
557 newname))
558 \f
560 "Select buffer BUFFER in another window.
561 Optional second arg NORECORD non-nil means
562 do not put this buffer at the front of the list of recently selected ones."
568 "Switch to buffer BUFFER in another frame.
569 Optional second arg NORECORD non-nil means
570 do not put this buffer at the front of the list of recently selected ones."
577 "Edit file FILENAME.
578 Switch to a buffer visiting file FILENAME,
579 creating one if none already exists."
584 "Edit file FILENAME, in another window.
585 May create a new window, or reuse an existing one.
586 See the function `display-buffer'."
591 "Edit file FILENAME, in another frame.
592 May create a new frame, or reuse an existing one.
593 See the function `display-buffer'."
598 "Edit file FILENAME but don't allow changes.
607 "Edit file FILENAME in another window but don't allow changes.
616 "Edit file FILENAME in another frame but don't allow changes.
625 "Find file FILENAME as a replacement for the file in the next window.
626 This command does not select that window."
645 "Find file FILENAME, select its buffer, kill previous buffer.
646 If the current buffer now contains an empty file that you just visited
647 \(presumably by mistake), use this command to visit the file you really want."
658 ;; (not buffer-read-only)
687 "Create a suitably named buffer for visiting FILENAME, and return it.
688 FILENAME (sans directory) is used unchanged if that name is free;
689 otherwise a string <2> or <3> or ... is appended to get an unused name."
696 "Create and return a buffer with a name based on NAME.
697 Choose the buffer's name using `generate-new-buffer-name'."
707 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
710 ;; Get rid of the prefixes added by the automounter.
717 ;; If any elt of directory-abbrev-alist matches this name,
718 ;; abbreviate accordingly.
724 ;; Compute and save the abbreviated homedir name.
725 ;; We defer computing this until the first time it's needed, to
726 ;; give time for directory-abbrev-alist to be set properly.
727 ;; We include a slash at the end, to avoid spurious matches
728 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
735 ;; If FILENAME starts with the abbreviated homedir,
736 ;; make it start with `~' instead.
738 ;; If the home dir is just /, don't change it.
741 ;; MS-DOS root directories can come with a drive letter;
742 ;; Novell Netware allows drive letters beyond `Z:'.
751 filename))
754 "*List of logical names for which visiting shouldn't save the true dirname.
755 On VMS, when you visit a file using a logical name that searches a path,
756 you may or may not want the visited file name to record the specific
757 directory where the file was found. If you *do not* want that, add the logical
758 name to this list as a string."
763 "Return the buffer visiting file FILENAME (a string).
764 This is like `get-file-buffer', except that it checks for any buffer
765 visiting the same file, possibly under a different name.
766 If there is no such live buffer, return nil."
778 found)
782 number
788 ;; Verify this buffer's file number
789 ;; still belongs to its file.
792 number))
795 found))))
798 "Like `insert-file-contents', q.v., but only reads in the file.
799 A buffer may be modified in several ways after reading into the buffer due
800 to advanced Emacs features, such as file-name-handlers, format decoding,
801 find-file-hooks, etc.
802 This function ensures that none of these modifications will take place.
804 This function does not work for remote files, because it turns off
805 file name handlers and remote file access uses a file name handler."
812 nil)))
822 "Read file FILENAME into a buffer and return the buffer.
823 If a buffer exists visiting FILENAME, return that one, but
824 verify that the file has not changed since visited or saved.
825 The buffer is not selected, just returned to the caller.
826 Optional first arg NOWARN non-nil means suppress any warning messages.
827 Optional second arg RAWFILE non-nil means the file is read literally"
835 filename))
840 ;; Find any buffer for a file which has same truename.
842 error)
843 ;; Let user know if there is a buffer with the same truename.
850 ;; Optionally also find that buffer.
858 ;; Certain files should be reverted automatically
859 ;; if they have changed on disk and not in the buffer.
867 found))
877 "File %s changed on disk. Discard your edits? "
882 "File %s changed on disk. Discard your edits in %s? "
889 ;;; The truename stuff makes this obsolete.
890 ;;; (let* ((link-name (car (file-attributes filename)))
891 ;;; (linked-buf (and (stringp link-name)
892 ;;; (get-file-buffer link-name))))
893 ;;; (if (bufferp linked-buf)
894 ;;; (message "Symbolic link to file in buffer %s"
895 ;;; (buffer-name linked-buf))))
904 ;; Unconditionally set error
909 ;; Run find-file-not-found-hooks until one returns non-nil.
911 ;; If they fail too, set error.
913 ;; Find the file's truename, and maybe use that as visited name.
916 ;; On VMS, we may want to remember which directory in a search list
917 ;; the file was found in.
929 ;; Set buffer's default directory to that of the file.
931 ;; Turn off backup files for certain file names. Since
932 ;; this is a permanent local, the major mode won't eliminate it.
938 nil
941 buf)))
942 \f
946 after-find-file-from-revert-buffer
947 nomodes)
948 "Called after finding a file and by the default revert function.
949 Sets buffer mode, parses local variables.
950 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
951 error in reading the file. WARN non-nil means warn if there
952 exists an auto-save file more recent than the visited file.
953 NOAUTO means don't mess with auto-save mode.
954 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
955 means this call was from `revert-buffer'.
956 Fifth arg NOMODES non-nil means don't alter the file's modes.
957 Finishes by calling the functions in `find-file-hooks'
958 unless NOMODES is non-nil."
961 nil
970 buffer-file-name))
984 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
985 "Use M-x make-dir RET RET to create the directory"
994 nil
999 "Choose the major mode for this buffer automatically.
1000 Also sets up any specified local variables of the file.
1001 Uses the visited file name, the -*- line, and the local variables spec.
1003 This function is called automatically from `find-file'. In that case,
1004 we may set up specified local variables depending on the value of
1005 `enable-local-variables': if it is t, we do; if it is nil, we don't;
1006 otherwise, we query. `enable-local-variables' is ignored if you
1007 run `normal-mode' explicitly."
1016 enable-local-variables)))
1058 ;;; Less common extensions come here
1059 ;;; so more common ones above are found faster.
1069 ;; for MSDOS and MS-Windows (which are case-insensitive)
1078 ;;; The following should come after the ChangeLog pattern
1079 ;;; for the sake of ChangeLog.1, etc.
1080 ;;; and after the .scm.[0-9] pattern too.
1103 ;; Mailer puts message to be edited in
1104 ;; /tmp/Re.... or Message
1108 ;; some news reader is reported to use this
1116 ;; .emacs following a directory delimiter
1117 ;; in either Unix or VMS syntax.
1119 ;; _emacs following a directory delimiter
1120 ;; in MsDos syntax
1123 "\
1124 Alist of filename patterns vs corresponding major mode functions.
1125 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1126 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1127 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1128 mode function to use. FUNCTION will be called, unless it is nil.
1130 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1131 calling FUNCTION (if it's not nil), we delete the suffix that matched
1167 "Alist mapping interpreter names to major modes.
1168 This alist applies to files whose first line starts with `#!'.
1169 Each element looks like (INTERPRETER . MODE).
1170 The car of each element is compared with
1171 the name of the interpreter specified in the first line.
1178 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1179 When checking `inhibit-first-line-modes-regexps', we first discard
1187 "Select major mode appropriate for current buffer.
1188 This checks for a -*- mode tag in the buffer's text,
1189 compares the filename against the entries in `auto-mode-alist',
1190 or checks the interpreter that runs this file against
1191 `interpreter-mode-alist'.
1193 It does not check for the `mode:' local variable in the
1194 Local Variables section of the file; for that, use `hack-local-variables'.
1196 If `enable-local-variables' is nil, this function does not check for a
1197 -*- mode tag.
1199 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1200 then we do not set anything but the major mode,
1201 and we don't even do that unless it would come from the file name."
1202 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1208 ;; Don't look for -*- if this file name matches any
1209 ;; of the regexps in inhibit-first-line-modes-regexps.
1217 sufs)
1224 ;; If the file begins with "#!"
1225 ;; (exec interpreter magic), look
1226 ;; for mode frobs in the first two
1227 ;; lines. You cannot necessarily
1228 ;; put them in the first line of
1229 ;; such a file without screwing up
1230 ;; the interpreter invocation.
1238 t))
1245 ;; Find all specifications for the `mode:' variable
1246 ;; and execute them left to right.
1258 modes)))
1259 ;; Simple -*-MODE-*- case.
1262 modes))))))
1263 ;; If we found modes to use, invoke them now,
1264 ;; outside the save-excursion.
1269 ;; If we didn't find a mode from a -*- line, try using the file name.
1273 ;; Remove backup-suffixes from file name.
1279 ;; Find first matching alist entry.
1289 keep-going t))
1291 keep-going nil)))
1295 ;; If we can't deduce a mode from the file name,
1296 ;; look for an interpreter specified in the first line.
1297 ;; As a special case, allow for things like "#!/bin/env perl",
1298 ;; which finds the interpreter anywhere in $PATH.
1306 elt)
1307 ;; Map interpreter name to a mode.
1309 interpreter-mode-alist))
1315 ;; Set local variables specified in the -*- line.
1316 ;; Ignore any specification for `mode:';
1317 ;; set-auto-mode should already have handled that.
1322 ;; Parse the -*- line into the `result' alist.
1324 ;; doesn't have one.
1325 nil)
1327 ;; Simple form: "-*- MODENAME -*-". Already handled.
1328 nil)
1330 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1331 ;; (last ";" is optional).
1340 ;; There used to be a downcase here,
1341 ;; but the manual didn't say so,
1342 ;; and people want to set var names that aren't all lc.
1349 ;; It is traditional to ignore
1350 ;; case when checking for `mode' in set-auto-mode,
1351 ;; so we must do that here as well.
1352 ;; That is inconsistent, but we're stuck with it.
1365 ;; If we fail to switch in the selected window,
1366 ;; it is probably a minibuffer.
1367 ;; So try another window.
1380 "Normal hook run after processing a file's local variables specs.
1381 Major modes can use this to examine user-specified local variables
1385 "Parse and put into effect this buffer's local variables spec.
1386 If MODE-ONLY is non-nil, all we do is check whether the major mode
1387 is specified, returning t if it is specified."
1390 ;; Look for "Local variables:" line in last page.
1398 mode-only
1408 buffer-file-name)
1412 prefix prefixlen suffix beg
1413 mode-specified
1415 ;; The prefix is what comes before "local variables:" in its line.
1416 ;; The suffix is what comes after "local variables:" in its line.
1431 ;; Look at next local variable spec.
1434 ;; Skip the prefix, if any.
1439 ;; Find the variable name; strip whitespace.
1447 val)
1448 ;; Setting variable named "end" means end of list.
1451 ;; Otherwise read the variable value.
1462 ;; Set the variable. "Variables" mode and eval are funny.
1466 mode-specified))
1472 ;; Get confirmation before setting these variables as locals in a file.
1489 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1493 ;; This one is safe because the user gets to check it before it is used.
1499 ;; "Set" one variable in a local variables spec.
1500 ;; A few variable names are treated specially.
1506 nil)
1507 ;; "Setting" eval means either eval it or do nothing.
1508 ;; Likewise for setting hook variables.
1514 ;; Permit evalling a put of a harmless property.
1515 ;; if the args do nothing tricky.
1521 ;; Only allow safe values of lisp-indent-hook;
1522 ;; not functions.
1527 ;; Permit eval if not root and user says ok.
1544 ;; Ordinary variable, really set it.
1548 \f
1551 However, the mode will not be changed if
1552 \(1) a local variables list or the `-*-' line specifies a major mode, or
1554 \ not suitable for ordinary files, or
1555 \(3) the new file name does not particularly specify any mode."
1560 "Change name of file visited in current buffer to FILENAME.
1561 The next time the buffer is saved it will go in the newly specified file.
1562 nil or empty string as argument means make buffer not be visiting any file.
1563 Remember to delete the initial contents of the minibuffer
1564 if you wish to pass an empty string as the argument.
1566 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1567 confirmation in the case where another buffer is already visiting FILENAME.
1569 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1570 the old visited file has been renamed to the new name FILENAME."
1578 nil
1589 filename)))
1608 ;; Abbreviate the file names of the buffer.
1617 nil)))
1618 ;; write-file-hooks is normally used for things like ftp-find-file
1619 ;; that visit things that are not local files as if they were files.
1620 ;; Changing to visit an ordinary local file instead should flush the hook.
1625 ;; If buffer was read-only because of version control,
1626 ;; that reason is gone now, so make it writable.
1630 ;; Turn off backup files for certain file names.
1631 ;; Since this is a permanent local, the major mode won't eliminate it.
1637 ;; If auto-save was not already on, turn it on if appropriate.
1641 ;; If auto save is on, start using a new name.
1642 ;; We deliberately don't rename or delete the old auto save
1643 ;; for the old visited file name. This is because perhaps
1644 ;; the user wants to save the new state and then compare with the
1645 ;; previous state from the auto save file.
1648 ;; Rename the old auto save file if any.
1655 ;; Update the major mode, if the file name determines it.
1657 ;; Don't change the mode if it is special.
1660 ;; Don't change the mode if the local variable list specifies it.
1666 "Write current buffer into file FILENAME.
1667 Makes buffer visit that file, and marks it not modified.
1668 If the buffer is already visiting a file, you can specify
1669 a directory name as FILENAME, to write a file of the same
1670 old name in that directory.
1672 If optional second arg CONFIRM is non-nil,
1673 ask for confirmation for overwriting an existing file.
1674 Interactively, confirmation is required unless you supply a prefix argument."
1675 ;; (interactive "FWrite file: ")
1679 nil nil nil nil)
1687 ;; If arg is just a directory,
1688 ;; use same file name, but in that directory.
1699 \f
1701 "Make a backup of the disk file visited by the current buffer, if appropriate.
1702 This is normally done before saving the buffer the first time.
1703 If the value is non-nil, it is the result of `file-modes' on the original
1704 file; this means that the caller, after saving the buffer, should change
1705 the modes of the new file to agree with the old modes.
1707 A backup may be done by renaming or by copying; see documentation of
1708 variable `make-backup-files'. If it's done by renaming, then the file is
1709 no longer accessible under its old name."
1716 backup-info backupname targets setmodes)
1717 ;; If specified name is a symbolic link, chase it to the target.
1718 ;; Thus we make the backups in the directory where the real file is.
1723 ;;; (if (file-directory-p buffer-file-name)
1724 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1728 ;; If have old versions to maybe delete,
1729 ;; ask the user to confirm now, before doing anything.
1730 ;; But don't actually delete til later.
1735 real-file-name))))))
1736 ;; Actually write the back up file.
1739 ; (file-symlink-p buffer-file-name)
1740 backup-by-copying
1750 ;; If copying fails because file BACKUPNAME
1751 ;; is not writable, delete that file and try again.
1756 ;; rename-file should delete old backup.
1760 ;; If trouble writing the backup, write it in ~.
1770 ;; If copying fails because file BACKUPNAME
1771 ;; is not writable, delete that file and try again.
1777 ;; Now delete the old versions, if desired.
1784 setmodes)
1788 "Return FILENAME sans backup versions or strings.
1789 This is a separate procedure so your site-init or startup file can
1790 redefine it.
1791 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1792 we do not remove backup version numbers, only true file version numbers."
1798 ;; VMS version number is (a) semicolon, optional
1799 ;; sign, zero or more digits or (b) period, option
1800 ;; sign, zero or more digits, provided this is the
1801 ;; second period encountered outside of the
1802 ;; device/directory part of the file name.
1805 name)
1815 "Returns t if deleting FILE and rewriting it would preserve the owner."
1820 ;; Return t if the file doesn't exist, since it's true that no
1821 ;; information would be lost by an (attempted) delete and create.
1827 The extension, in a file name, is the part that follows the last `.'."
1830 directory)
1834 directory)
1836 filename))))
1840 The extension, in a file name, is the part that follows the last `.'.
1841 Return nil for extensionless file names such as `foo'.
1842 Return the empty string for file names such as `foo.'.
1844 If PERIOD is non-nil, then the returned value includes the period
1845 that delimits the extension, and if FILENAME has no extension,
1855 "Create the non-numeric backup file name for FILE.
1856 This is a separate function so you can redefine it for customization."
1869 "Return non-nil if FILE is a backup file name (numeric or not).
1870 This is a separate function so you can redefine it for customization.
1871 You may need to redefine `file-name-sans-versions' as well."
1876 ;; This is used in various files.
1877 ;; The usage of bv-length is not very clean,
1878 ;; but I can't see a good alternative,
1879 ;; so as of now I am leaving it alone.
1881 "Given the name of a numeric backup file, return the backup number.
1882 Uses the free variable `backup-extract-version-start', whose value should be
1883 the index in the name where the version number begins."
1889 ;; I believe there is no need to alter this behavior for VMS;
1890 ;; since backup files are not made on VMS, it should not get called.
1892 "Find a file name for a backup file, and suggestions for deletions.
1893 Value is a list whose car is the name for the backup file
1894 and whose cdr is a list of old versions to consider deleting now.
1895 If the value is nil, don't make a backup."
1897 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1904 possibilities
1911 base-versions
1915 possibilities)
1916 '<)
1928 ;; Delete nothing if there is overflow
1929 ;; in the number of versions to keep.
1935 v))))))))))
1938 "Return number of names file FILENAME has."
1942 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
1943 This function returns a relative file name which is equivalent to FILENAME
1944 when used with that default directory as the default.
1945 If this is impossible (which can happen on MSDOS and Windows
1946 when the file name and directory use different drive names)
1947 then it returns FILENAME."
1952 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
1953 ;; drive names, they can't be relative, so return the absolute name.
1958 filename
1964 \f
1966 "Save current buffer in visited file if modified. Versions described below.
1967 By default, makes the previous version into a backup file
1968 if previously requested or if this is the first save.
1970 to become a backup when the next save is done.
1972 unconditionally makes the previous version into a backup file.
1974 to become a backup when the next save is done,
1975 and unconditionally makes the previous version into a backup file.
1977 With argument of 0, never makes the previous version into a backup file.
1979 If a file's name is FOO, the names of its numbered backup versions are
1980 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1981 Numeric backups (rather than FOO~) will be made if value of
1982 `version-control' is not the atom `never' and either there are already
1983 numeric versions of the file being backed up, or `version-control' is
1984 non-nil.
1985 We don't want excessive versions piling up, so there are variables
1986 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1987 and `kept-new-versions', which tells how many newest versions to keep.
1988 Defaults are 2 old versions and 2 new.
1989 `dired-kept-versions' controls dired's clean-directory (.) command.
1990 If `delete-old-versions' is nil, system will query user
1991 before trimming versions. Otherwise it does it silently."
2003 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2004 Normally delete only if the file was written by this Emacs since
2005 the last real save, but optional arg FORCE non-nil means delete anyway."
2019 "Save the current buffer in its visited file, if it has been modified.
2020 After saving the buffer, run `after-save-hook'."
2023 ;; In an indirect buffer, save its base buffer instead.
2028 setmodes tempsetmodes)
2029 ;; On VMS, rename file and buffer to get rid of version number.
2034 ;; Strip VMS version number before save.
2037 ;; Construct a (unique) buffer name to correspond.
2042 ;; If buffer has no file name, ask user for one.
2049 filename))
2075 ;; If a hook returned t, file is already "written".
2076 ;; Otherwise, write it the usual way now.
2084 ;; If the auto-save file was recent before this command,
2085 ;; delete it now.
2087 ;; Support VC `implicit' locking.
2092 ;; This does the "real job" of writing a buffer into its visited file
2093 ;; and making a backup file. This is what is normally done
2094 ;; but inhibited if one of write-file-hooks returns non-nil.
2095 ;; It returns a value to store in setmodes.
2107 buffer-file-name)))
2115 ;; If file is precious, write temp name, then rename it.
2116 ;; This requires write access to the containing dir,
2117 ;; which is why we don't try it if we don't have that access.
2119 tempname temp nogood i succeed
2123 ;; Find the temporary name to write under.
2130 dir i))
2136 tempname nil realname
2137 buffer-file-truename)
2139 ;; If writing the temp file fails,
2140 ;; delete the temp file.
2145 ;; Since we have created an entirely new file
2146 ;; and renamed it, make sure it gets the
2147 ;; right permission bits set.
2149 ;; We succeeded in writing the temp file,
2150 ;; so rename it.
2152 ;; If file not writable, see if we can make it writable
2153 ;; temporarily while we write it.
2154 ;; But no need to do so if we have just backed it up
2155 ;; (setmodes is set) because that says we're superseding.
2157 ;; Change the mode back, after writing.
2161 buffer-file-name nil t buffer-file-truename)))
2162 setmodes))
2165 "Save some modified file-visiting buffers. Asks user about each one.
2166 Optional argument (the prefix) non-nil means save all with no questions.
2167 Optional second argument EXITING means ask about certain non-file buffers
2168 as well as about file buffers."
2185 t
2204 ;; Return nil to ask about BUF again.
2205 nil)
2212 abbrev-file-name)))
2214 ;; Don't keep bothering user if he says no.
2216 t))))
2219 \f
2221 "Mark current buffer as unmodified, not needing to be saved.
2224 It is not a good idea to use this function in Lisp programs, because it
2225 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2232 "Change whether this buffer is visiting its file read-only.
2233 With arg, set read-only iff arg is positive."
2242 "Insert contents of file FILENAME into buffer after point.
2243 Set mark after the inserted text.
2245 This function is meant for the user to run interactively.
2246 Don't call it from programs! Use `insert-file-contents' instead.
2247 \(Its calling sequence is different; see its documentation)."
2251 filename)))
2256 "Append the contents of the region to the end of file FILENAME.
2257 When called from a function, expects three arguments,
2258 START, END and FILENAME. START and END are buffer positions
2259 saying what text to write.
2260 A prefix argument enables user to specify the coding-system interactively."
2265 "Return most recent backup file for FILENAME or nil if no backups exist."
2271 tem)
2281 newest))
2284 "Rename current buffer to a similar name not already taken.
2285 This function is useful for creating multiple shell process buffers
2286 or multiple mail buffers, etc."
2293 buffer-file-name)))))
2294 ;; If the existing buffer name has a <NNN>,
2295 ;; which isn't part of the file name (if any),
2296 ;; then get rid of that.
2306 "Create the directory DIR and any nonexistent parent dirs.
2307 Interactively, the default choice of directory to create
2308 is the current default directory for file names.
2309 That is useful when you have visited a file in a nonexistent directory.
2311 Noninteractively, the second (optional) argument PARENTS says whether
2312 to create parent directories if they don't exist."
2315 nil nil)
2316 t))
2323 create-list)
2330 \f
2333 "Function to use to revert this buffer, or nil to do the default.
2334 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2339 "Function to use to insert contents when reverting this buffer.
2340 Gets two args, first the nominal file name to use,
2344 "Normal hook for `revert-buffer' to run before reverting.
2345 If `revert-buffer-function' is used to override the normal revert
2349 "Normal hook for `revert-buffer' to run after reverting.
2350 Note that the hook value that it runs is the value that was in effect
2351 before reverting; that makes a difference if you have buffer-local
2352 hook functions.
2354 If `revert-buffer-function' is used to override the normal revert
2358 "Replace current buffer text with the text of the visited file on disk.
2359 This undoes all changes since the file was visited or saved.
2360 With a prefix argument, offer to revert from latest auto-save file, if
2361 that is more recent than the visited file.
2363 This command also works for special buffers that contain text which
2364 doesn't come from a file, but reflects some other data base instead:
2365 for example, Dired buffers and buffer-list buffers. In these cases,
2366 it reconstructs the buffer contents from the appropriate data base.
2368 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2369 to revert from the auto-save file when this is nil. Note that the
2370 sense of this argument is the reverse of the prefix argument, for the
2371 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2372 to nil.
2374 Optional second argument NOCONFIRM means don't ask for confirmation at
2375 all.
2377 Optional third argument PRESERVE-MODES non-nil means don't alter
2378 the files modes. Normally we reinitialize them using `normal-mode'.
2380 If the value of `revert-buffer-function' is non-nil, it is called to
2381 do all the work for this command. Otherwise, the hooks
2382 `before-revert-hook' and `after-revert-hook' are run at the beginning
2383 and the end, and if `revert-buffer-insert-file-contents-function' is
2384 non-nil, it is called instead of rereading visited file contents."
2386 ;; I admit it's odd to reverse the sense of the prefix argument, but
2387 ;; there is a lot of code out there which assumes that the first
2388 ;; argument should be t to avoid consulting the auto-save file, and
2389 ;; there's no straightforward way to encourage authors to notice a
2390 ;; reversal of the argument sense. So I'm just changing the user
2391 ;; interface, but leaving the programmatic interface the same.
2398 buffer-auto-save-file-name
2403 buffer-auto-save-file-name
2404 buffer-file-name)))
2415 found))
2417 file-name)))
2419 ;; If file was backed up but has changed since,
2420 ;; we shd make another backup.
2424 ;; Get rid of all undo records for this buffer.
2427 ;; Effectively copy the after-revert-hook status,
2428 ;; since after-find-file will clobber it.
2432 after-revert-hook)))
2434 ;; Don't make undo records for the reversion.
2438 file-name auto-save-p)
2441 ;; Bind buffer-file-name to nil
2442 ;; so that we don't try to lock the file.
2448 nil nil t)))
2450 ;; Recompute the truename in case changes in symlinks
2451 ;; have changed the truename.
2455 ;; Run after-revert-hook as it was before we reverted.
2463 t)))))
2466 "Visit file FILE, but get contents from its last auto-save file."
2467 ;; Actually putting the file name in the minibuffer should be used
2468 ;; only rarely.
2469 ;; Not just because users often use the default.
2486 file file-name)))
2490 ;; Auto-saved file shoule be read without any code conversion.
2498 "Recover auto save files from a previous Emacs session.
2499 This command first displays a Dired buffer showing you the
2500 previous sessions that you could recover from.
2501 To choose one, move point to the proper line and then type C-c C-c.
2502 Then you'll be asked about a number of files to recover."
2520 "Choose one saved session to recover auto-save files from.
2521 This command is used in the special Dired buffer created by
2524 ;; Get the name of the session file to recover from.
2526 files
2531 ;; Read in the auto-save-list file.
2535 ;; Loop thru the text of that file
2536 ;; and get out the names of the files to recover.
2540 ;; This is a pair of lines for a non-file-visiting buffer.
2541 ;; Get the auto-save file name and manufacture
2542 ;; a "visited file name" from that.
2558 ;; This pair of lines is a file-visiting
2559 ;; buffer. Use the visited file name.
2569 ;; Ignore a file if its auto-save file does not exist now.
2573 ;; The file contains a pair of line for each auto-saved buffer.
2574 ;; The first line of the pair contains the visited file name
2575 ;; or is empty if the buffer was not visiting a file.
2576 ;; The second line is the auto-save file name.
2584 files
2590 "For each buffer in LIST, ask whether to kill it.
2591 LIST defaults to all existing live buffers."
2602 name
2607 \f
2609 "Toggle auto-saving of contents of current buffer.
2610 With prefix argument ARG, turn auto-saving on if positive, else off."
2615 ;; If autosave is off because buffer has shrunk,
2616 ;; then toggling should turn it on.
2621 buffer-file-name
2623 ;; If -1 was stored here, to temporarily turn off saving,
2624 ;; turn it back on.
2630 buffer-auto-save-file-name)
2633 "Adjust current buffer's auto save file name for current conditions.
2634 Also rename any existing auto save file, if it was made in this session."
2646 "Return file name to use for auto-saves of current buffer.
2647 Does not consider `auto-save-visited-file-name' as that variable is checked
2648 before calling this function. You can redefine this for customization.
2649 See also `auto-save-file-name-p'."
2659 "#"
2663 ;; Deal with buffers that don't have any associated files. (Mail
2664 ;; mode tends to create a good number of these.)
2668 ;; Eliminate all slashes and backslashes by
2669 ;; replacing them with sequences that start with %.
2670 ;; Quote % also, to keep distinct names distinct.
2679 ;; Generate the file name.
2682 ;; Try a few alternative directories, to get one we can write it.
2689 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2690 FILENAME should lack slashes. You can redefine this for customization."
2692 \f
2694 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2695 The generated regexp will match a filename iff the filename
2696 matches that wildcard according to shell rules. Only wildcards known
2697 by `sh' are supported."
2699 ;; Copy the initial run of non-special characters.
2702 ;; If no special characters, we're almost done.
2706 j)
2708 result
2729 ;; Found "[^". Insert a `\0' character
2730 ;; (which cannot happen in a filename)
2731 ;; into the character class, so that `^'
2732 ;; is not the first character after `[',
2733 ;; and thus non-special in a regexp.
2738 ;; I don't think `]' can appear in a
2739 ;; character class in a wildcard, but
2740 ;; let's be general here.
2747 i
2760 ;; Shell wildcards should match the entire filename,
2761 ;; not its part. Make the regexp say so.
2763 \f
2766 "*Switches for list-directory to pass to `ls' for brief listing,"
2772 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2774 "*Switches for list-directory to pass to `ls' for verbose listing,"
2779 "Display a list of files in or matching DIRNAME, a la `ls'.
2780 DIRNAME is globbed by the shell if necessary.
2781 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2782 Actions controlled by variables `list-directory-brief-switches'
2783 and `list-directory-verbose-switches'."
2787 nil default-directory nil)
2788 pfx)))
2790 list-directory-brief-switches)))
2810 ;; insert-directory
2811 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2812 ;; FULL-DIRECTORY-P is nil.
2813 ;; The single line of output must display FILE's name as it was
2814 ;; given, namely, an absolute path name.
2815 ;; - must insert exactly one line for each file if WILDCARD or
2816 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
2817 ;; before the file lines, plus optional text after the file lines.
2818 ;; Lines are delimited by "\n", so filenames containing "\n" are not
2819 ;; allowed.
2820 ;; File lines should display the basename.
2821 ;; - must be consistent with
2822 ;; - functions dired-move-to-filename, (these two define what a file line is)
2823 ;; dired-move-to-end-of-filename,
2824 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2825 ;; dired-insert-headerline
2826 ;; dired-after-subdir-garbage (defines what a "total" line is)
2827 ;; - variable dired-subdir-regexp
2829 "Insert directory listing for FILE, formatted according to SWITCHES.
2830 Leaves point after the inserted text.
2831 SWITCHES may be a string of options, or a list of strings.
2832 Optional third arg WILDCARD means treat FILE as shell wildcard.
2833 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2834 switches do not contain `d', so that a full listing is expected.
2836 This works by running a directory listing program
2837 whose name is in the variable `insert-directory-program'.
2838 If WILDCARD, it also runs the shell specified by `shell-file-name'."
2839 ;; We need the directory in order to find the right handler.
2844 wildcard full-directory-p)
2849 ;; Run ls in the directory of the file pattern we asked for.
2856 ;; Quote some characters that have special meanings in shells;
2857 ;; but don't quote the wildcards--we want them to be special.
2858 ;; We also currently don't quote the quoting characters
2859 ;; in case people want to use them explicitly to quote
2860 ;; wildcard characters.
2869 insert-directory-program
2870 " -d "
2872 switches
2874 " -- "
2875 pattern)))
2876 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2877 ;; directory if FILE is a symbolic link.
2879 insert-directory-program nil t nil
2885 ;; Split the switches at any spaces
2886 ;; so we can pass separate options as separate args.
2889 list)
2893 ;; Avoid lossage if FILE starts with `-'.
2898 file)))))))
2899 ;; We get here if ls failed.
2900 ;; Access the file to get a suitable error.
2904 "Functions to call with no arguments to query about killing Emacs.
2905 If any of these functions returns nil, killing Emacs is cancelled.
2907 but `kill-emacs', the low level primitive, does not.
2911 "Offer to save each buffer, then kill this Emacs process.
2912 With prefix arg, silently save all file-visiting buffers, then kill."
2921 ;; process-list is not defined on VMS.
2923 active)
2928 val)
2933 ;; Query the user for other things, perhaps.
2936 \f
2937 ;; We use /: as a prefix to "quote" a file name
2938 ;; so that magic file name handlers will not apply to it.
2942 file-name-handler-alist))
2944 ;; We depend on being the last handler on the list,
2945 ;; so that anything else which does need handling
2946 ;; has been handled already.
2947 ;; So it is safe for us to inhibit *all* magic file name handlers.
2951 ;; Get a list of the indices of the args which are file names.
2954 ;; The first four are special because they
2955 ;; return a file name. We want to include the /:
2956 ;; in the return value.
2957 ;; So just avoid stripping it in the first place.
2959 ;; `identity' means just return the first arg
2960 ;; as stripped of its quoting.
2969 ;; For all other operations, treat the first argument only
2970 ;; as the file name.
2972 ;; Copy ARGUMENTS so we can replace elements in it.
2974 ;; Strip off the /: from the file names that have this handler.
2985 \f
3009 ;;; files.el ends here