| blob | c794719964cac9d59a9836a85602ab73e7458b06 |
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 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."
229 "*Non-nil says by default do auto-saving of every file-visiting buffer."
234 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
235 Normally auto-save files are written under other names."
240 "*Non-nil means save word abbrevs too when files are saved.
241 Loading an abbrev file sets this to t."
246 "*Non-nil says run dired if `find-file' is given the name of a directory."
250 ;;;It is not useful to make this a local variable.
251 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
253 "List of functions to be called for `find-file' on nonexistent file.
254 These functions are called as soon as the error is detected.
255 `buffer-file-name' is already set up.
258 ;;;It is not useful to make this a local variable.
259 ;;;(put 'find-file-hooks 'permanent-local t)
261 "List of functions to be called after a buffer is loaded from a file.
262 The buffer's local variables (if any) will have been processed before the
266 "List of functions to be called before writing out a buffer to a file.
267 If one of them returns non-nil, the file is considered already written
268 and the rest are not called.
269 These hooks are considered to pertain to the visited file.
270 So this list is cleared if you change the visited file name.
272 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
274 ;;; However, in case someone does make it local...
278 "Just like `write-file-hooks', except intended for per-buffer use.
279 The functions in this list are called before the ones in
280 `write-file-hooks'.
282 This variable is meant to be used for hooks that have to do with a
283 particular visited file. Therefore, it is a permanent local, so that
284 changing the major mode does not clear it. However, calling
290 "List of functions to be called before writing out a buffer to a file.
291 If one of them returns non-nil, the file is considered already written
292 and the rest are not called.
294 This variable is meant to be used for hooks that pertain to the
295 buffer's contents, not to the particular visited file; thus,
296 `set-visited-file-name' does not clear this variable; but changing the
297 major mode does clear it.
299 This variable automatically becomes buffer-local whenever it is set.
300 If you use `add-hook' to add elements to the list, use nil for the
301 LOCAL argument.
307 "*Control use of local variables in files you visit.
308 The value can be t, nil or something else.
309 A value of t means file local variables specifications are obeyed;
310 nil means they are ignored; anything else means query.
313 specifications and ignores this variable."
321 The value can be t, nil or something else.
322 A value of t means obey `eval' variables;
323 nil means ignore them; anything else means query.
326 and ignores this variable."
332 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
343 ;; This hook function provides support for ange-ftp host name
344 ;; completion. It runs the usual ange-ftp hook, but only for
345 ;; completion operations. Having this here avoids the need
346 ;; to load ange-ftp when it's not really in use.
353 inhibit-file-name-handlers)))
358 "Convert a standard file's name to something suitable for the current OS.
359 This function's standard definition is trivial; it just returns the argument.
360 However, on some systems, the function is redefined
361 with a definition that really does change some file names."
362 filename)
363 \f
365 "Show the current default directory."
370 "Value of the CDPATH environment variable, as a list.
377 "Explode a colon-separated search path into a list of directory names."
385 nil
390 cd-list)))
393 "Change current directory to given absolute file name DIR."
394 ;; Put the name into directory syntax now,
395 ;; because otherwise expand-file-name may give some bad results.
406 "Make DIR become the current buffer's default directory.
407 If your environment includes a `CDPATH' variable, try each one of that
408 colon-separated list of directories when resolving a relative directory name."
411 default-directory default-directory
427 cd-path)
428 nil))
432 "Load the Lisp file named FILE."
437 "Load the library named LIBRARY.
438 This is an interface to the function `load'."
443 "Copy the file FILE into a temporary file on this machine.
444 Returns the name of the local copy, or nil, if FILE is directly
445 accessible."
449 nil)))
452 "Return the truename of FILENAME, which should be absolute.
453 The truename of a file name is found by chasing symbolic links
454 both at the level of the file and at the level of the directories
455 containing it, until no links are left at any level.
457 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
458 Do not specify them in other calls."
459 ;; COUNTER can be a cons cell whose car is the count of how many more links
460 ;; to chase before getting an error.
461 ;; PREV-DIRS can be a cons cell whose car is an alist
462 ;; of truenames we've just recently computed.
464 ;; The last test looks dubious, maybe `+' is meant here? --simon.
474 ;; For speed, remove the ange-ftp completion handler from the list.
475 ;; We know it's not needed here.
476 ;; For even more speed, do this only on the outermost call.
482 ;; If this file directly leads to a link, process that iteratively
483 ;; so that we don't use lots of stack.
489 ;; For file name that has a special handler, call handler.
490 ;; This is so that ange-ftp can save time by doing a no-op.
493 done t)
495 target dirfile)
496 ;; Get the truename of the directory.
498 ;; If these are equal, we have the (or a) root directory.
500 ;; If this is the same dir we last got the truename for,
501 ;; save time--don't recalculate.
511 done t)
514 done t)
515 ;; Put it back on the file name.
517 ;; Is the file name the name of a link?
520 ;; Yes => chase that link, then start all over
521 ;; since the link may point to a directory name that uses links.
522 ;; We can't safely use expand-file-name here
523 ;; since target might look like foo/../bar where foo
524 ;; is itself a link. Instead, we handle . and .. above.
527 target
529 done nil)
530 ;; No, we are done!
532 filename))
535 "Chase links in FILENAME until a name that is not a link.
536 Does not examine containing directories for links,
537 unlike `file-truename'."
543 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
546 ;; Handle `..' by hand, since it needs to work in the
547 ;; target of any directory symlink.
548 ;; This code is not quite complete; it does not handle
549 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
553 ;; Chase links in the default dir of the symlink.
557 ;; Now find the parent of that dir.
561 newname))
562 \f
564 "Select buffer BUFFER in another window.
565 Optional second arg NORECORD non-nil means
566 do not put this buffer at the front of the list of recently selected ones."
572 "Switch to buffer BUFFER in another frame.
573 Optional second arg NORECORD non-nil means
574 do not put this buffer at the front of the list of recently selected ones."
581 "Edit file FILENAME.
582 Switch to a buffer visiting file FILENAME,
583 creating one if none already exists."
588 "Edit file FILENAME, in another window.
589 May create a new window, or reuse an existing one.
590 See the function `display-buffer'."
595 "Edit file FILENAME, in another frame.
596 May create a new frame, or reuse an existing one.
597 See the function `display-buffer'."
602 "Edit file FILENAME but don't allow changes.
611 "Edit file FILENAME in another window but don't allow changes.
620 "Edit file FILENAME in another frame but don't allow changes.
629 "Find file FILENAME as a replacement for the file in the next window.
630 This command does not select that window."
649 "Find file FILENAME, select its buffer, kill previous buffer.
650 If the current buffer now contains an empty file that you just visited
651 \(presumably by mistake), use this command to visit the file you really want."
662 ;; (not buffer-read-only)
691 "Create a suitably named buffer for visiting FILENAME, and return it.
692 FILENAME (sans directory) is used unchanged if that name is free;
693 otherwise a string <2> or <3> or ... is appended to get an unused name."
700 "Create and return a buffer with a name based on NAME.
701 Choose the buffer's name using `generate-new-buffer-name'."
711 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
714 ;; Get rid of the prefixes added by the automounter.
721 ;; If any elt of directory-abbrev-alist matches this name,
722 ;; abbreviate accordingly.
728 ;; Compute and save the abbreviated homedir name.
729 ;; We defer computing this until the first time it's needed, to
730 ;; give time for directory-abbrev-alist to be set properly.
731 ;; We include a slash at the end, to avoid spurious matches
732 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
739 ;; If FILENAME starts with the abbreviated homedir,
740 ;; make it start with `~' instead.
742 ;; If the home dir is just /, don't change it.
745 ;; MS-DOS root directories can come with a drive letter;
746 ;; Novell Netware allows drive letters beyond `Z:'.
755 filename))
758 "*List of logical names for which visiting shouldn't save the true dirname.
759 On VMS, when you visit a file using a logical name that searches a path,
760 you may or may not want the visited file name to record the specific
761 directory where the file was found. If you *do not* want that, add the logical
762 name to this list as a string."
767 "Return the buffer visiting file FILENAME (a string).
768 This is like `get-file-buffer', except that it checks for any buffer
769 visiting the same file, possibly under a different name.
770 If there is no such live buffer, return nil."
782 found)
786 number
792 ;; Verify this buffer's file number
793 ;; still belongs to its file.
796 number))
799 found))))
802 "Like `insert-file-contents', q.v., but only reads in the file.
803 A buffer may be modified in several ways after reading into the buffer due
804 to advanced Emacs features, such as file-name-handlers, format decoding,
805 find-file-hooks, etc.
806 This function ensures that none of these modifications will take place.
808 This function does not work for remote files, because it turns off
809 file name handlers and remote file access uses a file name handler."
816 nil)))
826 "Read file FILENAME into a buffer and return the buffer.
827 If a buffer exists visiting FILENAME, return that one, but
828 verify that the file has not changed since visited or saved.
829 The buffer is not selected, just returned to the caller.
830 Optional first arg NOWARN non-nil means suppress any warning messages.
831 Optional second arg RAWFILE non-nil means the file is read literally"
839 filename))
844 ;; Find any buffer for a file which has same truename.
846 error)
847 ;; Let user know if there is a buffer with the same truename.
854 ;; Optionally also find that buffer.
862 ;; Certain files should be reverted automatically
863 ;; if they have changed on disk and not in the buffer.
871 found))
881 "File %s changed on disk. Discard your edits? "
886 "File %s changed on disk. Discard your edits in %s? "
893 ;;; The truename stuff makes this obsolete.
894 ;;; (let* ((link-name (car (file-attributes filename)))
895 ;;; (linked-buf (and (stringp link-name)
896 ;;; (get-file-buffer link-name))))
897 ;;; (if (bufferp linked-buf)
898 ;;; (message "Symbolic link to file in buffer %s"
899 ;;; (buffer-name linked-buf))))
908 ;; Unconditionally set error
913 ;; Run find-file-not-found-hooks until one returns non-nil.
915 ;; If they fail too, set error.
917 ;; Find the file's truename, and maybe use that as visited name.
920 ;; On VMS, we may want to remember which directory in a search list
921 ;; the file was found in.
933 ;; Set buffer's default directory to that of the file.
935 ;; Turn off backup files for certain file names. Since
936 ;; this is a permanent local, the major mode won't eliminate it.
942 nil
945 buf)))
946 \f
950 after-find-file-from-revert-buffer
951 nomodes)
952 "Called after finding a file and by the default revert function.
953 Sets buffer mode, parses local variables.
954 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
955 error in reading the file. WARN non-nil means warn if there
956 exists an auto-save file more recent than the visited file.
957 NOAUTO means don't mess with auto-save mode.
958 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
959 means this call was from `revert-buffer'.
960 Fifth arg NOMODES non-nil means don't alter the file's modes.
961 Finishes by calling the functions in `find-file-hooks'
962 unless NOMODES is non-nil."
965 nil
974 buffer-file-name))
988 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
989 "Use M-x make-dir RET RET to create the directory"
998 nil
1006 "Choose the major mode for this buffer automatically.
1007 Also sets up any specified local variables of the file.
1008 Uses the visited file name, the -*- line, and the local variables spec.
1010 This function is called automatically from `find-file'. In that case,
1011 we may set up specified local variables depending on the value of
1012 `enable-local-variables': if it is t, we do; if it is nil, we don't;
1013 otherwise, we query. `enable-local-variables' is ignored if you
1014 run `normal-mode' explicitly."
1023 enable-local-variables)))
1065 ;;; Less common extensions come here
1066 ;;; so more common ones above are found faster.
1076 ;; for MSDOS and MS-Windows (which are case-insensitive)
1085 ;;; The following should come after the ChangeLog pattern
1086 ;;; for the sake of ChangeLog.1, etc.
1087 ;;; and after the .scm.[0-9] pattern too.
1110 ;; Mailer puts message to be edited in
1111 ;; /tmp/Re.... or Message
1115 ;; some news reader is reported to use this
1123 ;; .emacs following a directory delimiter
1124 ;; in either Unix or VMS syntax.
1126 ;; _emacs following a directory delimiter
1127 ;; in MsDos syntax
1130 "\
1131 Alist of filename patterns vs corresponding major mode functions.
1132 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1133 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1134 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1135 mode function to use. FUNCTION will be called, unless it is nil.
1137 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1138 calling FUNCTION (if it's not nil), we delete the suffix that matched
1174 "Alist mapping interpreter names to major modes.
1175 This alist applies to files whose first line starts with `#!'.
1176 Each element looks like (INTERPRETER . MODE).
1177 The car of each element is compared with
1178 the name of the interpreter specified in the first line.
1185 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1186 When checking `inhibit-first-line-modes-regexps', we first discard
1194 "Select major mode appropriate for current buffer.
1195 This checks for a -*- mode tag in the buffer's text,
1196 compares the filename against the entries in `auto-mode-alist',
1197 or checks the interpreter that runs this file against
1198 `interpreter-mode-alist'.
1200 It does not check for the `mode:' local variable in the
1201 Local Variables section of the file; for that, use `hack-local-variables'.
1203 If `enable-local-variables' is nil, this function does not check for a
1204 -*- mode tag.
1206 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1207 then we do not set anything but the major mode,
1208 and we don't even do that unless it would come from the file name."
1209 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1215 ;; Don't look for -*- if this file name matches any
1216 ;; of the regexps in inhibit-first-line-modes-regexps.
1224 sufs)
1231 ;; If the file begins with "#!"
1232 ;; (exec interpreter magic), look
1233 ;; for mode frobs in the first two
1234 ;; lines. You cannot necessarily
1235 ;; put them in the first line of
1236 ;; such a file without screwing up
1237 ;; the interpreter invocation.
1245 t))
1252 ;; Find all specifications for the `mode:' variable
1253 ;; and execute them left to right.
1265 modes)))
1266 ;; Simple -*-MODE-*- case.
1269 modes))))))
1270 ;; If we found modes to use, invoke them now,
1271 ;; outside the save-excursion.
1276 ;; If we didn't find a mode from a -*- line, try using the file name.
1280 ;; Remove backup-suffixes from file name.
1286 ;; Find first matching alist entry.
1296 keep-going t))
1298 keep-going nil)))
1302 ;; If we can't deduce a mode from the file name,
1303 ;; look for an interpreter specified in the first line.
1304 ;; As a special case, allow for things like "#!/bin/env perl",
1305 ;; which finds the interpreter anywhere in $PATH.
1313 elt)
1314 ;; Map interpreter name to a mode.
1316 interpreter-mode-alist))
1322 ;; Set local variables specified in the -*- line.
1323 ;; Ignore any specification for `mode:';
1324 ;; set-auto-mode should already have handled that.
1329 ;; Parse the -*- line into the `result' alist.
1331 ;; doesn't have one.
1332 nil)
1334 ;; Simple form: "-*- MODENAME -*-". Already handled.
1335 nil)
1337 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1338 ;; (last ";" is optional).
1347 ;; There used to be a downcase here,
1348 ;; but the manual didn't say so,
1349 ;; and people want to set var names that aren't all lc.
1356 ;; It is traditional to ignore
1357 ;; case when checking for `mode' in set-auto-mode,
1358 ;; so we must do that here as well.
1359 ;; That is inconsistent, but we're stuck with it.
1372 ;; If we fail to switch in the selected window,
1373 ;; it is probably a minibuffer.
1374 ;; So try another window.
1387 "Normal hook run after processing a file's local variables specs.
1388 Major modes can use this to examine user-specified local variables
1392 "Parse and put into effect this buffer's local variables spec.
1393 If MODE-ONLY is non-nil, all we do is check whether the major mode
1394 is specified, returning t if it is specified."
1397 ;; Look for "Local variables:" line in last page.
1405 mode-only
1415 buffer-file-name)
1419 prefix prefixlen suffix beg
1420 mode-specified
1422 ;; The prefix is what comes before "local variables:" in its line.
1423 ;; The suffix is what comes after "local variables:" in its line.
1438 ;; Look at next local variable spec.
1441 ;; Skip the prefix, if any.
1446 ;; Find the variable name; strip whitespace.
1454 val)
1455 ;; Setting variable named "end" means end of list.
1458 ;; Otherwise read the variable value.
1469 ;; Set the variable. "Variables" mode and eval are funny.
1473 mode-specified))
1479 ;; Get confirmation before setting these variables as locals in a file.
1496 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1500 ;; This one is safe because the user gets to check it before it is used.
1506 ;; "Set" one variable in a local variables spec.
1507 ;; A few variable names are treated specially.
1513 nil)
1514 ;; "Setting" eval means either eval it or do nothing.
1515 ;; Likewise for setting hook variables.
1521 ;; Permit evalling a put of a harmless property.
1522 ;; if the args do nothing tricky.
1528 ;; Only allow safe values of lisp-indent-hook;
1529 ;; not functions.
1534 ;; Permit eval if not root and user says ok.
1551 ;; Ordinary variable, really set it.
1555 \f
1558 However, the mode will not be changed if
1559 \(1) a local variables list or the `-*-' line specifies a major mode, or
1561 \ not suitable for ordinary files, or
1562 \(3) the new file name does not particularly specify any mode."
1567 "Change name of file visited in current buffer to FILENAME.
1568 The next time the buffer is saved it will go in the newly specified file.
1569 nil or empty string as argument means make buffer not be visiting any file.
1570 Remember to delete the initial contents of the minibuffer
1571 if you wish to pass an empty string as the argument.
1573 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1574 confirmation in the case where another buffer is already visiting FILENAME.
1576 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1577 the old visited file has been renamed to the new name FILENAME."
1585 nil
1596 filename)))
1615 ;; Abbreviate the file names of the buffer.
1624 nil)))
1625 ;; write-file-hooks is normally used for things like ftp-find-file
1626 ;; that visit things that are not local files as if they were files.
1627 ;; Changing to visit an ordinary local file instead should flush the hook.
1632 ;; If buffer was read-only because of version control,
1633 ;; that reason is gone now, so make it writable.
1637 ;; Turn off backup files for certain file names.
1638 ;; Since this is a permanent local, the major mode won't eliminate it.
1644 ;; If auto-save was not already on, turn it on if appropriate.
1648 ;; If auto save is on, start using a new name.
1649 ;; We deliberately don't rename or delete the old auto save
1650 ;; for the old visited file name. This is because perhaps
1651 ;; the user wants to save the new state and then compare with the
1652 ;; previous state from the auto save file.
1655 ;; Rename the old auto save file if any.
1662 ;; Update the major mode, if the file name determines it.
1664 ;; Don't change the mode if it is special.
1667 ;; Don't change the mode if the local variable list specifies it.
1673 "Write current buffer into file FILENAME.
1674 Makes buffer visit that file, and marks it not modified.
1675 If the buffer is already visiting a file, you can specify
1676 a directory name as FILENAME, to write a file of the same
1677 old name in that directory.
1679 If optional second arg CONFIRM is non-nil,
1680 ask for confirmation for overwriting an existing file.
1681 Interactively, confirmation is required unless you supply a prefix argument."
1682 ;; (interactive "FWrite file: ")
1686 nil nil nil nil)
1694 ;; If arg is just a directory,
1695 ;; use same file name, but in that directory.
1706 \f
1708 "Make a backup of the disk file visited by the current buffer, if appropriate.
1709 This is normally done before saving the buffer the first time.
1710 If the value is non-nil, it is the result of `file-modes' on the original
1711 file; this means that the caller, after saving the buffer, should change
1712 the modes of the new file to agree with the old modes.
1714 A backup may be done by renaming or by copying; see documentation of
1715 variable `make-backup-files'. If it's done by renaming, then the file is
1716 no longer accessible under its old name."
1723 backup-info backupname targets setmodes)
1724 ;; If specified name is a symbolic link, chase it to the target.
1725 ;; Thus we make the backups in the directory where the real file is.
1730 ;;; (if (file-directory-p buffer-file-name)
1731 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1735 ;; If have old versions to maybe delete,
1736 ;; ask the user to confirm now, before doing anything.
1737 ;; But don't actually delete til later.
1742 real-file-name))))))
1743 ;; Actually write the back up file.
1746 ; (file-symlink-p buffer-file-name)
1747 backup-by-copying
1757 ;; If copying fails because file BACKUPNAME
1758 ;; is not writable, delete that file and try again.
1763 ;; rename-file should delete old backup.
1767 ;; If trouble writing the backup, write it in ~.
1777 ;; If copying fails because file BACKUPNAME
1778 ;; is not writable, delete that file and try again.
1784 ;; Now delete the old versions, if desired.
1791 setmodes)
1795 "Return FILENAME sans backup versions or strings.
1796 This is a separate procedure so your site-init or startup file can
1797 redefine it.
1798 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1799 we do not remove backup version numbers, only true file version numbers."
1805 ;; VMS version number is (a) semicolon, optional
1806 ;; sign, zero or more digits or (b) period, option
1807 ;; sign, zero or more digits, provided this is the
1808 ;; second period encountered outside of the
1809 ;; device/directory part of the file name.
1812 name)
1822 "Returns t if deleting FILE and rewriting it would preserve the owner."
1827 ;; Return t if the file doesn't exist, since it's true that no
1828 ;; information would be lost by an (attempted) delete and create.
1834 The extension, in a file name, is the part that follows the last `.'."
1837 directory)
1841 directory)
1843 filename))))
1847 The extension, in a file name, is the part that follows the last `.'.
1848 Return nil for extensionless file names such as `foo'.
1849 Return the empty string for file names such as `foo.'.
1851 If PERIOD is non-nil, then the returned value includes the period
1852 that delimits the extension, and if FILENAME has no extension,
1862 "Create the non-numeric backup file name for FILE.
1863 This is a separate function so you can redefine it for customization."
1876 "Return non-nil if FILE is a backup file name (numeric or not).
1877 This is a separate function so you can redefine it for customization.
1878 You may need to redefine `file-name-sans-versions' as well."
1883 ;; This is used in various files.
1884 ;; The usage of bv-length is not very clean,
1885 ;; but I can't see a good alternative,
1886 ;; so as of now I am leaving it alone.
1888 "Given the name of a numeric backup file, return the backup number.
1889 Uses the free variable `backup-extract-version-start', whose value should be
1890 the index in the name where the version number begins."
1896 ;; I believe there is no need to alter this behavior for VMS;
1897 ;; since backup files are not made on VMS, it should not get called.
1899 "Find a file name for a backup file, and suggestions for deletions.
1900 Value is a list whose car is the name for the backup file
1901 and whose cdr is a list of old versions to consider deleting now.
1902 If the value is nil, don't make a backup."
1904 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1911 possibilities
1918 base-versions
1922 possibilities)
1923 '<)
1935 ;; Delete nothing if there is overflow
1936 ;; in the number of versions to keep.
1942 v))))))))))
1945 "Return number of names file FILENAME has."
1949 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
1950 This function returns a relative file name which is equivalent to FILENAME
1951 when used with that default directory as the default.
1952 If this is impossible (which can happen on MSDOS and Windows
1953 when the file name and directory use different drive names)
1954 then it returns FILENAME."
1959 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
1960 ;; drive names, they can't be relative, so return the absolute name.
1965 filename
1972 ".."
1974 ;; Now ancestor is empty, or .., or ../.., etc.
1976 ;; We matched within FNAME's directory part.
1977 ;; Add the rest of FNAME onto ANCESTOR.
1981 ;; But don't bother with ANCESTOR if it would give us `./'.
1982 rest
1984 ;; We matched FNAME's directory equivalent.
1985 ancestor))))))
1986 \f
1988 "Save current buffer in visited file if modified. Versions described below.
1989 By default, makes the previous version into a backup file
1990 if previously requested or if this is the first save.
1992 to become a backup when the next save is done.
1994 unconditionally makes the previous version into a backup file.
1996 to become a backup when the next save is done,
1997 and unconditionally makes the previous version into a backup file.
1999 With argument of 0, never makes the previous version into a backup file.
2001 If a file's name is FOO, the names of its numbered backup versions are
2002 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2003 Numeric backups (rather than FOO~) will be made if value of
2004 `version-control' is not the atom `never' and either there are already
2005 numeric versions of the file being backed up, or `version-control' is
2006 non-nil.
2007 We don't want excessive versions piling up, so there are variables
2008 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2009 and `kept-new-versions', which tells how many newest versions to keep.
2010 Defaults are 2 old versions and 2 new.
2011 `dired-kept-versions' controls dired's clean-directory (.) command.
2012 If `delete-old-versions' is nil, system will query user
2013 before trimming versions. Otherwise it does it silently."
2025 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2026 Normally delete only if the file was written by this Emacs since
2027 the last real save, but optional arg FORCE non-nil means delete anyway."
2041 "Save the current buffer in its visited file, if it has been modified.
2042 After saving the buffer, run `after-save-hook'."
2045 ;; In an indirect buffer, save its base buffer instead.
2050 setmodes tempsetmodes)
2051 ;; On VMS, rename file and buffer to get rid of version number.
2056 ;; Strip VMS version number before save.
2059 ;; Construct a (unique) buffer name to correspond.
2064 ;; If buffer has no file name, ask user for one.
2071 filename))
2097 ;; If a hook returned t, file is already "written".
2098 ;; Otherwise, write it the usual way now.
2106 ;; If the auto-save file was recent before this command,
2107 ;; delete it now.
2109 ;; Support VC `implicit' locking.
2114 ;; This does the "real job" of writing a buffer into its visited file
2115 ;; and making a backup file. This is what is normally done
2116 ;; but inhibited if one of write-file-hooks returns non-nil.
2117 ;; It returns a value to store in setmodes.
2129 buffer-file-name)))
2137 ;; If file is precious, write temp name, then rename it.
2138 ;; This requires write access to the containing dir,
2139 ;; which is why we don't try it if we don't have that access.
2141 tempname temp nogood i succeed
2145 ;; Find the temporary name to write under.
2152 dir i))
2158 tempname nil realname
2159 buffer-file-truename)
2161 ;; If writing the temp file fails,
2162 ;; delete the temp file.
2167 ;; Since we have created an entirely new file
2168 ;; and renamed it, make sure it gets the
2169 ;; right permission bits set.
2171 ;; We succeeded in writing the temp file,
2172 ;; so rename it.
2174 ;; If file not writable, see if we can make it writable
2175 ;; temporarily while we write it.
2176 ;; But no need to do so if we have just backed it up
2177 ;; (setmodes is set) because that says we're superseding.
2179 ;; Change the mode back, after writing.
2183 buffer-file-name nil t buffer-file-truename)))
2184 setmodes))
2187 "Save some modified file-visiting buffers. Asks user about each one.
2188 Optional argument (the prefix) non-nil means save all with no questions.
2189 Optional second argument EXITING means ask about certain non-file buffers
2190 as well as about file buffers."
2207 t
2226 ;; Return nil to ask about BUF again.
2227 nil)
2234 abbrev-file-name)))
2236 ;; Don't keep bothering user if he says no.
2238 t))))
2241 \f
2243 "Mark current buffer as unmodified, not needing to be saved.
2246 It is not a good idea to use this function in Lisp programs, because it
2247 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2254 "Change whether this buffer is visiting its file read-only.
2255 With arg, set read-only iff arg is positive.
2256 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2262 ;; Toggle.
2272 "Insert contents of file FILENAME into buffer after point.
2273 Set mark after the inserted text.
2275 This function is meant for the user to run interactively.
2276 Don't call it from programs! Use `insert-file-contents' instead.
2277 \(Its calling sequence is different; see its documentation)."
2281 filename)))
2286 "Append the contents of the region to the end of file FILENAME.
2287 When called from a function, expects three arguments,
2288 START, END and FILENAME. START and END are buffer positions
2289 saying what text to write.
2290 A prefix argument enables user to specify the coding-system interactively."
2295 "Return most recent backup file for FILENAME or nil if no backups exist."
2301 tem)
2311 newest))
2314 "Rename current buffer to a similar name not already taken.
2315 This function is useful for creating multiple shell process buffers
2316 or multiple mail buffers, etc."
2323 buffer-file-name)))))
2324 ;; If the existing buffer name has a <NNN>,
2325 ;; which isn't part of the file name (if any),
2326 ;; then get rid of that.
2336 "Create the directory DIR and any nonexistent parent dirs.
2337 Interactively, the default choice of directory to create
2338 is the current default directory for file names.
2339 That is useful when you have visited a file in a nonexistent directory.
2341 Noninteractively, the second (optional) argument PARENTS says whether
2342 to create parent directories if they don't exist."
2345 nil nil)
2346 t))
2353 create-list)
2360 \f
2363 "Function to use to revert this buffer, or nil to do the default.
2364 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2369 "Function to use to insert contents when reverting this buffer.
2370 Gets two args, first the nominal file name to use,
2374 "Normal hook for `revert-buffer' to run before reverting.
2375 If `revert-buffer-function' is used to override the normal revert
2379 "Normal hook for `revert-buffer' to run after reverting.
2380 Note that the hook value that it runs is the value that was in effect
2381 before reverting; that makes a difference if you have buffer-local
2382 hook functions.
2384 If `revert-buffer-function' is used to override the normal revert
2388 "Replace current buffer text with the text of the visited file on disk.
2389 This undoes all changes since the file was visited or saved.
2390 With a prefix argument, offer to revert from latest auto-save file, if
2391 that is more recent than the visited file.
2393 This command also works for special buffers that contain text which
2394 doesn't come from a file, but reflects some other data base instead:
2395 for example, Dired buffers and buffer-list buffers. In these cases,
2396 it reconstructs the buffer contents from the appropriate data base.
2398 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2399 to revert from the auto-save file when this is nil. Note that the
2400 sense of this argument is the reverse of the prefix argument, for the
2401 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2402 to nil.
2404 Optional second argument NOCONFIRM means don't ask for confirmation at
2405 all.
2407 Optional third argument PRESERVE-MODES non-nil means don't alter
2408 the files modes. Normally we reinitialize them using `normal-mode'.
2410 If the value of `revert-buffer-function' is non-nil, it is called to
2411 do all the work for this command. Otherwise, the hooks
2412 `before-revert-hook' and `after-revert-hook' are run at the beginning
2413 and the end, and if `revert-buffer-insert-file-contents-function' is
2414 non-nil, it is called instead of rereading visited file contents."
2416 ;; I admit it's odd to reverse the sense of the prefix argument, but
2417 ;; there is a lot of code out there which assumes that the first
2418 ;; argument should be t to avoid consulting the auto-save file, and
2419 ;; there's no straightforward way to encourage authors to notice a
2420 ;; reversal of the argument sense. So I'm just changing the user
2421 ;; interface, but leaving the programmatic interface the same.
2428 buffer-auto-save-file-name
2433 buffer-auto-save-file-name
2434 buffer-file-name)))
2445 found))
2447 file-name)))
2449 ;; If file was backed up but has changed since,
2450 ;; we shd make another backup.
2454 ;; Get rid of all undo records for this buffer.
2457 ;; Effectively copy the after-revert-hook status,
2458 ;; since after-find-file will clobber it.
2462 after-revert-hook)))
2464 ;; Don't make undo records for the reversion.
2468 file-name auto-save-p)
2471 ;; Bind buffer-file-name to nil
2472 ;; so that we don't try to lock the file.
2478 nil nil t)))
2480 ;; Recompute the truename in case changes in symlinks
2481 ;; have changed the truename.
2485 ;; Run after-revert-hook as it was before we reverted.
2493 t)))))
2496 "Visit file FILE, but get contents from its last auto-save file."
2497 ;; Actually putting the file name in the minibuffer should be used
2498 ;; only rarely.
2499 ;; Not just because users often use the default.
2516 file file-name)))
2520 ;; Auto-saved file shoule be read without any code conversion.
2528 "Recover auto save files from a previous Emacs session.
2529 This command first displays a Dired buffer showing you the
2530 previous sessions that you could recover from.
2531 To choose one, move point to the proper line and then type C-c C-c.
2532 Then you'll be asked about a number of files to recover."
2550 "Choose one saved session to recover auto-save files from.
2551 This command is used in the special Dired buffer created by
2554 ;; Get the name of the session file to recover from.
2556 files
2561 ;; Read in the auto-save-list file.
2565 ;; Loop thru the text of that file
2566 ;; and get out the names of the files to recover.
2570 ;; This is a pair of lines for a non-file-visiting buffer.
2571 ;; Get the auto-save file name and manufacture
2572 ;; a "visited file name" from that.
2588 ;; This pair of lines is a file-visiting
2589 ;; buffer. Use the visited file name.
2599 ;; Ignore a file if its auto-save file does not exist now.
2603 ;; The file contains a pair of line for each auto-saved buffer.
2604 ;; The first line of the pair contains the visited file name
2605 ;; or is empty if the buffer was not visiting a file.
2606 ;; The second line is the auto-save file name.
2614 files
2620 "For each buffer in LIST, ask whether to kill it.
2621 LIST defaults to all existing live buffers."
2632 name
2637 \f
2639 "Toggle auto-saving of contents of current buffer.
2640 With prefix argument ARG, turn auto-saving on if positive, else off."
2645 ;; If autosave is off because buffer has shrunk,
2646 ;; then toggling should turn it on.
2651 buffer-file-name
2653 ;; If -1 was stored here, to temporarily turn off saving,
2654 ;; turn it back on.
2660 buffer-auto-save-file-name)
2663 "Adjust current buffer's auto save file name for current conditions.
2664 Also rename any existing auto save file, if it was made in this session."
2676 "Return file name to use for auto-saves of current buffer.
2677 Does not consider `auto-save-visited-file-name' as that variable is checked
2678 before calling this function. You can redefine this for customization.
2679 See also `auto-save-file-name-p'."
2689 "#"
2693 ;; Deal with buffers that don't have any associated files. (Mail
2694 ;; mode tends to create a good number of these.)
2698 ;; Eliminate all slashes and backslashes by
2699 ;; replacing them with sequences that start with %.
2700 ;; Quote % also, to keep distinct names distinct.
2709 ;; Generate the file name.
2712 ;; Try a few alternative directories, to get one we can write it.
2719 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2720 FILENAME should lack slashes. You can redefine this for customization."
2722 \f
2724 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2725 The generated regexp will match a filename iff the filename
2726 matches that wildcard according to shell rules. Only wildcards known
2727 by `sh' are supported."
2729 ;; Copy the initial run of non-special characters.
2732 ;; If no special characters, we're almost done.
2736 j)
2738 result
2759 ;; Found "[^". Insert a `\0' character
2760 ;; (which cannot happen in a filename)
2761 ;; into the character class, so that `^'
2762 ;; is not the first character after `[',
2763 ;; and thus non-special in a regexp.
2768 ;; I don't think `]' can appear in a
2769 ;; character class in a wildcard, but
2770 ;; let's be general here.
2777 i
2790 ;; Shell wildcards should match the entire filename,
2791 ;; not its part. Make the regexp say so.
2793 \f
2796 "*Switches for list-directory to pass to `ls' for brief listing,"
2802 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2804 "*Switches for list-directory to pass to `ls' for verbose listing,"
2809 "Display a list of files in or matching DIRNAME, a la `ls'.
2810 DIRNAME is globbed by the shell if necessary.
2811 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2812 Actions controlled by variables `list-directory-brief-switches'
2813 and `list-directory-verbose-switches'."
2817 nil default-directory nil)
2818 pfx)))
2820 list-directory-brief-switches)))
2840 ;; insert-directory
2841 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2842 ;; FULL-DIRECTORY-P is nil.
2843 ;; The single line of output must display FILE's name as it was
2844 ;; given, namely, an absolute path name.
2845 ;; - must insert exactly one line for each file if WILDCARD or
2846 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
2847 ;; before the file lines, plus optional text after the file lines.
2848 ;; Lines are delimited by "\n", so filenames containing "\n" are not
2849 ;; allowed.
2850 ;; File lines should display the basename.
2851 ;; - must be consistent with
2852 ;; - functions dired-move-to-filename, (these two define what a file line is)
2853 ;; dired-move-to-end-of-filename,
2854 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2855 ;; dired-insert-headerline
2856 ;; dired-after-subdir-garbage (defines what a "total" line is)
2857 ;; - variable dired-subdir-regexp
2859 "Insert directory listing for FILE, formatted according to SWITCHES.
2860 Leaves point after the inserted text.
2861 SWITCHES may be a string of options, or a list of strings.
2862 Optional third arg WILDCARD means treat FILE as shell wildcard.
2863 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2864 switches do not contain `d', so that a full listing is expected.
2866 This works by running a directory listing program
2867 whose name is in the variable `insert-directory-program'.
2868 If WILDCARD, it also runs the shell specified by `shell-file-name'."
2869 ;; We need the directory in order to find the right handler.
2874 wildcard full-directory-p)
2879 ;; Run ls in the directory of the file pattern we asked for.
2886 ;; Quote some characters that have special meanings in shells;
2887 ;; but don't quote the wildcards--we want them to be special.
2888 ;; We also currently don't quote the quoting characters
2889 ;; in case people want to use them explicitly to quote
2890 ;; wildcard characters.
2899 insert-directory-program
2900 " -d "
2902 switches
2904 " -- "
2905 pattern)))
2906 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2907 ;; directory if FILE is a symbolic link.
2909 insert-directory-program nil t nil
2915 ;; Split the switches at any spaces
2916 ;; so we can pass separate options as separate args.
2919 list)
2923 ;; Avoid lossage if FILE starts with `-'.
2928 file)))))))
2929 ;; We get here if ls failed.
2930 ;; Access the file to get a suitable error.
2934 "Functions to call with no arguments to query about killing Emacs.
2935 If any of these functions returns nil, killing Emacs is cancelled.
2937 but `kill-emacs', the low level primitive, does not.
2941 "Offer to save each buffer, then kill this Emacs process.
2942 With prefix arg, silently save all file-visiting buffers, then kill."
2951 ;; process-list is not defined on VMS.
2953 active)
2958 val)
2963 ;; Query the user for other things, perhaps.
2966 \f
2967 ;; We use /: as a prefix to "quote" a file name
2968 ;; so that magic file name handlers will not apply to it.
2972 file-name-handler-alist))
2974 ;; We depend on being the last handler on the list,
2975 ;; so that anything else which does need handling
2976 ;; has been handled already.
2977 ;; So it is safe for us to inhibit *all* magic file name handlers.
2981 ;; Get a list of the indices of the args which are file names.
2984 ;; The first four are special because they
2985 ;; return a file name. We want to include the /:
2986 ;; in the return value.
2987 ;; So just avoid stripping it in the first place.
2989 ;; `identity' means just return the first arg
2990 ;; as stripped of its quoting.
3001 ;; For all other operations, treat the first argument only
3002 ;; as the file name.
3004 ;; Copy ARGUMENTS so we can replace elements in it.
3006 ;; Strip off the /: from the file names that have this handler.
3017 \f
3040 ;;; files.el ends here