| blob | eb4895781c90956c653e06d9e0bd110aa4d131e0 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002
4 ;;; 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.
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
71 ;; Turn off backup files on VMS since it has version numbers.
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
137 "Predicate that looks at a file name and decides whether to make backups.
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
163 nil
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
195 "The directory for writing temporary files."
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil means make them for files that have some already.
243 `never' means do not make them."
251 "*When cleaning directory, number of versions to keep."
257 "*If t, delete excess backup versions silently.
258 If nil, ask confirmation. Any other value prevents any trimming."
265 "*Number of oldest versions to keep when a new numbered backup is made."
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
276 "*Value of t says silently ensure a file ends in a newline when it is saved.
277 Non-nil but not t says ask user whether to add a newline when there isn't one.
278 nil means don't add newlines."
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
291 Normally auto-save files are written under other names."
297 ;; Don't put "\\2" inside expand-file-name, since it will be
298 ;; transformed to "/2" on DOS/Windows.
300 "*Transforms to apply to buffer file name before making auto-save file name.
301 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
302 REGEXP is a regular expression to match against the file name.
303 If it matches, `replace-match' is used to replace the
304 matching part with REPLACEMENT.
305 If the optional element UNIQUIFY is non-nil, the auto-save file name is
306 constructed by taking the directory part of the replaced file-name,
307 concatenated with the buffer file name with all directory separators
308 changed to `!' to prevent clashes. This will not work
309 correctly if your filesystem truncates the resulting name.
311 All the transforms in the list are tried, in the order they are listed.
312 When one transform applies, its result is final;
313 no further transforms are tried.
315 The default value is set up to put the auto-save file into the
316 temporary directory (see the variable `temporary-file-directory') for
317 editing a remote file.
319 On MS-DOS filesystems without long names this variable is always
320 ignored."
327 "*Non-nil means save word abbrevs too when files are saved.
328 If `silently', don't ask the user before saving."
333 "*Non-nil means allow `find-file' to visit directories.
334 To visit the directory, `find-file' runs `find-directory-functions'."
339 "*List of functions to try in sequence to visit a directory.
340 Each function is called with the directory name as the sole argument
341 and should return either a buffer or nil."
345 ;;;It is not useful to make this a local variable.
346 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
348 "List of functions to be called for `find-file' on nonexistent file.
349 These functions are called as soon as the error is detected.
350 Variable `buffer-file-name' is already set up.
356 ;;;It is not useful to make this a local variable.
357 ;;;(put 'find-file-hooks 'permanent-local t)
359 "List of functions to be called after a buffer is loaded from a file.
360 The buffer's local variables (if any) will have been processed before the
366 "List of functions to be called before writing out a buffer to a file.
367 If one of them returns non-nil, the file is considered already written
368 and the rest are not called.
369 These hooks are considered to pertain to the visited file.
370 So any buffer-local binding of this variable is discarded if you change
372 change the major mode.
385 "List of functions to be called before writing out a buffer to a file.
386 If one of them returns non-nil, the file is considered already written
387 and the rest are not called.
389 This variable is meant to be used for hooks that pertain to the
390 buffer's contents, not to the particular visited file; thus,
391 `set-visited-file-name' does not clear this variable; but changing the
392 major mode does clear it.
400 "*Control use of local variables in files you visit.
401 The value can be t, nil or something else.
402 A value of t means file local variables specifications are obeyed;
403 nil means they are ignored; anything else means query.
404 This variable also controls use of major modes specified in
405 a -*- line.
408 always obeys file local variable specifications and the -*- line,
409 and ignores this variable."
416 "Like `enable-local-variables' but meant for buffer-local bindings.
417 The meaningful values are nil and non-nil. The default is non-nil.
418 If a major mode sets this to nil, buffer-locally, then any local
419 variables list in the file will be ignored.
421 This variable does not affect the use of major modes
426 The value can be t, nil or something else.
427 A value of t means obey `eval' variables;
428 nil means ignore them; anything else means query.
431 and ignores this variable."
437 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
450 "Provides support for ange-ftp host name completion.
451 Runs the usual ange-ftp hook, but only for completion operations."
452 ;; Having this here avoids the need to load ange-ftp when it's not
453 ;; really in use.
459 inhibit-file-name-handlers)))
464 "Convert a standard file's name to something suitable for the current OS.
465 This function's standard definition is trivial; it just returns the argument.
466 However, on some systems, the function is redefined with a definition
467 that really does change some file names to canonicalize certain
468 patterns and to guarantee valid names."
469 filename)
472 "Read directory name, prompting with PROMPT and completing in directory DIR.
473 Value is not expanded---you must call `expand-file-name' yourself.
474 Default name to DEFAULT-DIRNAME if user enters a null string.
475 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
476 except that if INITIAL is specified, that combined with DIR is used.)
477 Fourth arg MUSTMATCH non-nil means require existing directory's name.
478 Non-nil and non-t means also require confirmation after completion.
479 Fifth arg INITIAL specifies text to start with.
480 DIR defaults to current buffer's directory default."
489 \f
491 "Show the current default directory."
496 "Value of the CDPATH environment variable, as a list.
500 "Explode a colon-separated search path into a list of directory names.
501 \(For values of `colon' equal to `path-separator'.)"
502 ;; We could use split-string here.
510 nil
515 cd-list)))
518 "Change current directory to given absolute file name DIR."
519 ;; Put the name into directory syntax now,
520 ;; because otherwise expand-file-name may give some bad results.
533 "Make DIR become the current buffer's default directory.
534 If your environment includes a `CDPATH' variable, try each one of that
535 colon-separated list of directories when resolving a relative directory name."
538 default-directory default-directory
554 cd-path)
555 nil))
559 "Load the Lisp file named FILE."
560 ;; This is a case where .elc makes a lot of sense.
567 "Search for FILENAME through PATH.
568 If SUFFIXES is non-nil, it should be a list of suffixes to append to
570 If non-nil, PREDICATE is used instead of `file-readable-p'.
571 PREDICATE can also be an integer to pass to the `access' system call,
572 in which case file-name handlers are ignored. This usage is deprecated.
574 For compatibility, PREDICATE can also be one of the symbols
575 `executable', `readable', `writable', or `exists', or a list of
576 one or more of those symbols."
587 "Do completion for file names passed to `locate-file'.
588 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
609 "Load the library named LIBRARY.
610 This is an interface to the function `load'."
613 'locate-file-completion
618 "Test whether FILE specifies a location on a remote system."
624 "Copy the file FILE into a temporary file on this machine.
625 Returns the name of the local copy, or nil, if FILE is directly
626 accessible."
627 ;; This formerly had an optional BUFFER argument that wasn't used by
628 ;; anything.
632 nil)))
635 "Return the truename of FILENAME, which should be absolute.
636 The truename of a file name is found by chasing symbolic links
637 both at the level of the file and at the level of the directories
638 containing it, until no links are left at any level.
640 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
641 Do not specify them in other calls."
642 ;; COUNTER can be a cons cell whose car is the count of how many more links
643 ;; to chase before getting an error.
644 ;; PREV-DIRS can be a cons cell whose car is an alist
645 ;; of truenames we've just recently computed.
647 ;; The last test looks dubious, maybe `+' is meant here? --simon.
657 ;; For speed, remove the ange-ftp completion handler from the list.
658 ;; We know it's not needed here.
659 ;; For even more speed, do this only on the outermost call.
666 ;; andrewi@harlequin.co.uk - none of the following code (except for
667 ;; invoking the file-name handler) currently applies on Windows
668 ;; (ie. there are no native symlinks), but there is an issue with
669 ;; case differences being ignored by the OS, and short "8.3 DOS"
670 ;; name aliases existing for all files. (The short names are not
671 ;; reported by directory-files, but can be used to refer to files.)
672 ;; It seems appropriate for file-truename to resolve these issues in
673 ;; the most natural way, which on Windows is to call the function
674 ;; `w32-long-file-name' - this returns the exact name of a file as
675 ;; it is stored on disk (expanding short name aliases with the full
676 ;; name in the process).
679 ;; For file name that has a special handler, call handler.
680 ;; This is so that ange-ftp can save time by doing a no-op.
683 ;; If filename contains a wildcard, newname will be the old name.
685 ;; If filename exists, use the long name, otherwise
686 ;; canonicalize the name, to handle case differences.
691 ;; If this file directly leads to a link, process that iteratively
692 ;; so that we don't use lots of stack.
698 ;; For file name that has a special handler, call handler.
699 ;; This is so that ange-ftp can save time by doing a no-op.
702 done t)
704 target dirfile)
705 ;; Get the truename of the directory.
707 ;; If these are equal, we have the (or a) root directory.
709 ;; If this is the same dir we last got the truename for,
710 ;; save time--don't recalculate.
720 done t)
723 done t)
724 ;; Put it back on the file name.
726 ;; Is the file name the name of a link?
729 ;; Yes => chase that link, then start all over
730 ;; since the link may point to a directory name that uses links.
731 ;; We can't safely use expand-file-name here
732 ;; since target might look like foo/../bar where foo
733 ;; is itself a link. Instead, we handle . and .. above.
736 target
738 done nil)
739 ;; No, we are done!
741 filename))
744 "Chase links in FILENAME until a name that is not a link.
745 Does not examine containing directories for links,
746 unlike `file-truename'."
752 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
755 ;; Handle `..' by hand, since it needs to work in the
756 ;; target of any directory symlink.
757 ;; This code is not quite complete; it does not handle
758 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
762 ;; Chase links in the default dir of the symlink.
766 ;; Now find the parent of that dir.
770 newname))
771 \f
773 "Select buffer BUFFER in another window.
774 Optional second arg NORECORD non-nil means
775 do not put this buffer at the front of the list of recently selected ones.
777 This uses the function `display-buffer' as a subroutine; see its
778 documentation for additional customization information."
784 "Switch to buffer BUFFER in another frame.
785 Optional second arg NORECORD non-nil means
786 do not put this buffer at the front of the list of recently selected ones.
788 This uses the function `display-buffer' as a subroutine; see its
789 documentation for additional customization information."
805 ;; Clear out this hook so it does not interfere
806 ;; with any recursive minibuffer usage.
809 minibuffer-setup-hook))
812 t))
815 "Edit file FILENAME.
816 Switch to a buffer visiting file FILENAME,
817 creating one if none already exists.
818 Interactively, the default if you just type RET is the current directory,
819 but the visited file name is available through the minibuffer history:
820 type M-n to pull it into the minibuffer.
822 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
823 expand wildcards (if any) and visit multiple files. Wildcard expansion
824 can be suppressed by setting `find-file-wildcards'."
833 "Edit file FILENAME, in another window.
834 May create a new window, or reuse an existing one.
835 See the function `display-buffer'.
837 Interactively, the default if you just type RET is the current directory,
838 but the visited file name is available through the minibuffer history:
839 type M-n to pull it into the minibuffer.
841 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
842 expand wildcards (if any) and visit multiple files."
853 "Edit file FILENAME, in another frame.
854 May create a new frame, or reuse an existing one.
855 See the function `display-buffer'.
857 Interactively, the default if you just type RET is the current directory,
858 but the visited file name is available through the minibuffer history:
859 type M-n to pull it into the minibuffer.
861 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
862 expand wildcards (if any) and visit multiple files."
873 "Edit file FILENAME but don't allow changes.
882 "Edit file FILENAME in another window but don't allow changes.
891 "Edit file FILENAME in another frame but don't allow changes.
900 "Find file FILENAME as a replacement for the file in the next window.
901 This command does not select that window."
920 "Find file FILENAME, select its buffer, kill previous buffer.
921 If the current buffer now contains an empty file that you just visited
922 \(presumably by mistake), use this command to visit the file you really want."
956 ;; This executes if find-file gets an error
957 ;; and does not really find anything.
958 ;; We put things back as they were.
959 ;; If find-file actually finds something, we kill obuf below.
967 ;; We already asked; don't ask again.
970 \f
972 "Create a suitably named buffer for visiting FILENAME, and return it.
973 FILENAME (sans directory) is used unchanged if that name is free;
974 otherwise a string <2> or <3> or ... is appended to get an unused name."
981 "Create and return a buffer with a name based on NAME.
982 Choose the buffer's name using `generate-new-buffer-name'."
986 "Regexp to match the automounter prefix in a directory name."
994 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
997 ;; Get rid of the prefixes added by the automounter.
1004 ;; If any elt of directory-abbrev-alist matches this name,
1005 ;; abbreviate accordingly.
1011 ;; Compute and save the abbreviated homedir name.
1012 ;; We defer computing this until the first time it's needed, to
1013 ;; give time for directory-abbrev-alist to be set properly.
1014 ;; We include a slash at the end, to avoid spurious matches
1015 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1022 ;; If FILENAME starts with the abbreviated homedir,
1023 ;; make it start with `~' instead.
1025 ;; If the home dir is just /, don't change it.
1028 ;; MS-DOS root directories can come with a drive letter;
1029 ;; Novell Netware allows drive letters beyond `Z:'.
1038 filename))
1041 "*List of logical names for which visiting shouldn't save the true dirname.
1042 On VMS, when you visit a file using a logical name that searches a path,
1043 you may or may not want the visited file name to record the specific
1044 directory where the file was found. If you *do not* want that, add the logical
1045 name to this list as a string."
1050 "Return the buffer visiting file FILENAME (a string).
1051 This is like `get-file-buffer', except that it checks for any buffer
1052 visiting the same file, possibly under a different name.
1053 If PREDICATE is non-nil, only a buffer satisfying it can be returned.
1054 If there is no such live buffer, return nil."
1068 found)
1073 number
1078 ;; Verify this buffer's file number
1079 ;; still belongs to its file.
1082 attributes)
1086 found))))
1087 \f
1089 "*Non-nil means file-visiting commands should handle wildcards.
1090 For example, if you specify `*.c', that would visit all the files
1091 whose names match the pattern."
1097 "*Non-nil means suppress warning messages for symlinked files.
1098 When nil, Emacs prints a warning when visiting a file that is already
1099 visited, but with a different name. Setting this option to t
1100 suppresses this warning."
1106 "Read file FILENAME into a buffer and return the buffer.
1107 If a buffer exists visiting FILENAME, return that one, but
1108 verify that the file has not changed since visited or saved.
1109 The buffer is not selected, just returned to the caller.
1110 Optional first arg NOWARN non-nil means suppress any warning messages.
1111 Optional second arg RAWFILE non-nil means the file is read literally.
1112 Optional third arg WILDCARDS non-nil means do wildcard processing
1113 and visit all the matching files. When wildcards are actually
1114 used and expanded, the value is a list of buffers
1115 that are visiting the various files."
1122 'find-directory-functions
1125 filename)))
1128 find-file-wildcards
1141 ;; Find any buffer for a file which has same truename.
1143 ;; Let user know if there is a buffer with the same truename.
1147 find-file-suppress-same-file-warnings
1151 ;; Optionally also find that buffer.
1155 ;; We are using an existing buffer.
1161 ;; Certain files should be reverted automatically
1162 ;; if they have changed on disk and not in the buffer.
1170 found))
1180 "File %s changed on disk. Discard your edits? "
1185 "File %s changed on disk. Discard your edits in %s? "
1193 ;; Check if a formerly read-only file has become
1194 ;; writable and vice versa, but if the buffer agrees
1195 ;; with the new state of the file, that is ok too.
1202 buffer-file-name
1210 ;; It is confusing to ask whether to visit
1211 ;; non-literally if they have the file in
1212 ;; hexl-mode.
1216 "Save file and revisit literally? "
1221 rawfile truename number))
1223 "Discard your edits and revisit file literally? "
1226 rawfile truename number)
1230 "Revisit file literally? "
1233 rawfile truename number)
1236 ;; Return the buffer we are using.
1237 buf)
1238 ;; Create a new buffer.
1241 ;; find-file-noselect-1 may use a different buffer.
1243 rawfile truename number))))))
1247 error)
1250 ;; Needed in case we are re-visiting the file with a different
1251 ;; text representation.
1265 filename)))
1266 ;; Unconditionally set error
1275 filename)))
1276 ;; Run find-file-not-found-hooks until one returns non-nil.
1278 ;; If they fail too, set error.
1280 ;; Record the file's truename, and maybe use that as visited name.
1286 ;; On VMS, we may want to remember which directory in a search list
1287 ;; the file was found in.
1299 ;; Set buffer's default directory to that of the file.
1301 ;; Turn off backup files for certain file names. Since
1302 ;; this is a permanent local, the major mode won't eliminate it.
1315 \f
1317 "Like `insert-file-contents', but only reads in the file literally.
1318 A buffer may be modified in several ways after reading into the buffer,
1319 to Emacs features such as format decoding, character code
1320 conversion, `find-file-hook', automatic uncompression, etc.
1322 This function ensures that none of these modifications will take place."
1330 nil))
1344 filename)))
1354 "Insert contents of file FILENAME into buffer after point with no conversion.
1356 This function is meant for the user to run interactively.
1357 Don't call it from programs! Use `insert-file-contents-literally' instead.
1358 \(Its calling sequence is different; see its documentation)."
1363 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1368 "Visit file FILENAME with no conversion of any kind.
1369 Format conversion and character code conversion are both disabled,
1370 and multibyte characters are disabled in the resulting buffer.
1371 The major mode used is Fundamental mode regardless of the file name,
1372 and local variable specifications in the file are ignored.
1373 Automatic uncompression and adding a newline at the end of the
1374 file due to `require-final-newline' is also disabled.
1376 You cannot absolutely rely on this function to result in
1377 visiting the file literally. If Emacs already has a buffer
1378 which is visiting the file, you get the existing buffer,
1379 regardless of whether it was created literally or not.
1381 In a Lisp program, if you want to be sure of accessing a file's
1382 contents literally, you should create a temporary buffer and then read
1383 the file contents into it using `insert-file-contents-literally'."
1386 \f
1390 after-find-file-from-revert-buffer
1391 nomodes)
1392 "Called after finding a file and by the default revert function.
1393 Sets buffer mode, parses local variables.
1394 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1395 error in reading the file. WARN non-nil means warn if there
1396 exists an auto-save file more recent than the visited file.
1397 NOAUTO means don't mess with auto-save mode.
1398 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1399 means this call was from `revert-buffer'.
1400 Fifth arg NOMODES non-nil means don't alter the file's modes.
1401 Finishes by calling the functions in `find-file-hook'
1402 unless NOMODES is non-nil."
1405 nil
1415 ;; No need to warn if buffer is auto-saved
1416 ;; under the name of the visited file.
1418 auto-save-visited-file-name))
1421 buffer-file-name))
1435 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1436 "Use M-x make-directory RET RET to create the directory"
1443 ;; Make people do a little extra work (C-x C-q)
1444 ;; before altering a backup file.
1447 ;; When a file is marked read-only,
1448 ;; make the buffer read-only even if root is looking at it.
1457 view-read-only
1463 "Choose the major mode for this buffer automatically.
1464 Also sets up any specified local variables of the file.
1465 Uses the visited file name, the -*- line, and the local variables spec.
1467 This function is called automatically from `find-file'. In that case,
1468 we may set up the file-specified mode and local variables,
1469 depending on the value of `enable-local-variables': if it is t, we do;
1470 if it is nil, we don't; otherwise, we query.
1471 In addition, if `local-enable-local-variables' is nil, we do
1472 not set local variables (though we do notice a mode specified with -*-.)
1474 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1475 or from Lisp without specifying the optional argument FIND-FILE;
1476 in that case, this function acts as if `enable-local-variables' were t."
1485 enable-local-variables)))
1529 ;; Less common extensions come here
1530 ;; so more common ones above are found faster.
1540 ;; for MSDOS and MS-Windows (which are case-insensitive)
1588 ;; Mailer puts message to be edited in
1589 ;; /tmp/Re.... or Message
1594 ;; some news reader is reported to use this
1604 ;; .emacs or .gnus or .viper following a directory delimiter in
1605 ;; Unix, MSDOG or VMS syntax.
1608 ;; _emacs following a directory delimiter
1609 ;; in MsDos syntax
1622 ;; Get rid of any trailing .n.m and try again.
1623 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1624 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1625 ;; Using mode nil rather than `ignore' would let the search continue
1626 ;; through this list (with the shortened name) rather than start over.
1628 ;; The following should come after the ChangeLog pattern
1629 ;; for the sake of ChangeLog.1, etc.
1630 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1635 "Alist of filename patterns vs corresponding major mode functions.
1636 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1637 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1638 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1639 mode function to use. FUNCTION will be called, unless it is nil.
1641 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1642 calling FUNCTION (if it's not nil), we delete the suffix that matched
1688 "Alist mapping interpreter names to major modes.
1689 This alist applies to files whose first line starts with `#!'.
1690 Each element looks like (INTERPRETER . MODE).
1691 The car of each element is compared with
1692 the name of the interpreter specified in the first line.
1699 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1700 When checking `inhibit-first-line-modes-regexps', we first discard
1706 "Regular expression matching interpreters, for file mode determination.
1707 This regular expression is matched against the first line of a file
1708 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1709 a mode from the file's name. If it matches, the file is assumed to
1710 be interpreted by the interpreter matched by the second group of the
1711 regular expression. The mode is then determined as the mode associated
1715 "Select major mode appropriate for current buffer.
1716 This checks for a -*- mode tag in the buffer's text,
1717 compares the filename against the entries in `auto-mode-alist',
1718 or checks the interpreter that runs this file against
1719 `interpreter-mode-alist'.
1721 It does not check for the `mode:' local variable in the
1722 Local Variables section of the file; for that, use `hack-local-variables'.
1724 If `enable-local-variables' is nil, this function does not check for a
1725 -*- mode tag.
1727 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1728 then we do not set anything but the major mode,
1729 and we don't even do that unless it would come from the file name."
1730 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1738 ;; Find all specifications for the `mode:' variable
1739 ;; and execute them left to right.
1751 modes)))
1752 ;; Simple -*-MODE-*- case.
1755 modes))))
1756 ;; If we found modes to use, invoke them now,
1757 ;; outside the save-excursion.
1764 ;; If we didn't find a mode from a -*- line, try using the file name.
1768 ;; Remove backup-suffixes from file name.
1774 ;; Find first matching alist entry.
1783 keep-going t)
1785 keep-going nil)))
1788 ;; When JUST-FROM-FILE-NAME is set,
1789 ;; we are working on behalf of set-visited-file-name.
1790 ;; In that case, if the major mode specified is the
1791 ;; same one we already have, don't actually reset it.
1792 ;; We don't want to lose minor modes such as Font Lock.
1795 ;; If we can't deduce a mode from the file name,
1796 ;; look for an interpreter specified in the first line.
1797 ;; As a special case, allow for things like "#!/bin/env perl",
1798 ;; which finds the interpreter anywhere in $PATH.
1805 elt)
1806 ;; Map interpreter name to a mode.
1808 interpreter-mode-alist))
1815 "Find the -*- spec in the buffer.
1816 Call with point at the place to start searching from.
1817 If one is found, set point to the beginning
1818 and return the position of the end.
1819 Otherwise, return nil; point may be changed."
1822 ;; Don't look for -*- if this file name matches any
1823 ;; of the regexps in inhibit-first-line-modes-regexps.
1831 sufs)
1839 ;; If the file begins with "#!"
1840 ;; (exec interpreter magic), look
1841 ;; for mode frobs in the first two
1842 ;; lines. You cannot necessarily
1843 ;; put them in the first line of
1844 ;; such a file without screwing up
1845 ;; the interpreter invocation.
1853 t))
1859 end))))
1862 "Set local variables specified in the -*- line.
1863 Ignore any specification for `mode:' and `coding:';
1864 `set-auto-mode' should already have handled `mode:',
1865 `set-auto-coding' should already have handled `coding:'."
1872 ;; Parse the -*- line into the `result' alist.
1874 nil)
1876 ;; Simple form: "-*- MODENAME -*-". Already handled.
1877 nil)
1879 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1880 ;; (last ";" is optional).
1885 ;; There used to be a downcase here,
1886 ;; but the manual didn't say so,
1887 ;; and people want to set var names that aren't all lc.
1894 ;; It is traditional to ignore
1895 ;; case when checking for `mode' in set-auto-mode,
1896 ;; so we must do that here as well.
1897 ;; That is inconsistent, but we're stuck with it.
1898 ;; The same can be said for `coding' in set-auto-coding.
1912 ;; If we fail to switch in the selected window,
1913 ;; it is probably a minibuffer.
1914 ;; So try another window.
1927 "Normal hook run after processing a file's local variables specs.
1928 Major modes can use this to examine user-specified local variables
1932 "Parse and put into effect this buffer's local variables spec.
1933 If MODE-ONLY is non-nil, all we do is check whether the major mode
1934 is specified, returning t if it is specified."
1937 ;; Look for "Local variables:" line in last page.
1947 mode-only
1957 buffer-file-name)
1961 prefix prefixlen suffix beg
1962 mode-specified
1964 ;; The prefix is what comes before "local variables:" in its line.
1965 ;; The suffix is what comes after "local variables:" in its line.
1980 ;; Look at next local variable spec.
1983 ;; Skip the prefix, if any.
1988 ;; Find the variable name; strip whitespace.
1996 val)
1997 ;; Setting variable named "end" means end of list.
2000 ;; Otherwise read the variable value.
2011 ;; Set the variable. "Variables" mode and eval are funny.
2015 mode-specified))
2021 ;; Get confirmation before setting these variables as locals in a file.
2046 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2075 ;; This case is safe because the user gets to check it before it is used.
2079 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2080 If VAL is nil, the question is whether any value might be dangerous."
2084 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2087 ;; If the safe-local-variable property isn't t or nil,
2088 ;; then it must return non-nil on the proposed value to be safe.
2095 Add expressions to this list if you want Emacs to evaluate them, when
2096 they appear in an `eval' local variable specification, without first
2097 asking you for confirmation."
2114 "Return t if it is safe to eval EXP when it is found in a file."
2116 ;; Detect certain `put' expressions.
2122 ;; Only allow safe values of lisp-indent-hook;
2123 ;; not functions.
2126 ;; Allow expressions that the user requested.
2128 ;; Certain functions can be allowed with safe arguments
2129 ;; or can specify verification functions to try.
2137 ok))
2145 ok)))))))
2149 A few patterns are specified so that any name which matches one
2150 is considered risky."
2155 ;; We have already handled coding: tag in set-auto-coding.
2156 nil)
2157 ;; "Setting" eval means either eval it or do nothing.
2158 ;; Likewise for setting hook variables.
2160 ;; Permit evalling a put of a harmless property.
2161 ;; if the args do nothing tricky.
2164 ;; Permit eval if not root and user says ok.
2183 ;; Ordinary variable, really set it.
2185 ;; Make sure the string has no text properties.
2186 ;; Some text properties can get evaluated in various ways,
2187 ;; so it is risky to put them on with a local variable list.
2192 \f
2195 However, the mode will not be changed if
2196 \(1) a local variables list or the `-*-' line specifies a major mode, or
2198 \ not suitable for ordinary files, or
2199 \(3) the new file name does not particularly specify any mode."
2204 "Change name of file visited in current buffer to FILENAME.
2205 The next time the buffer is saved it will go in the newly specified file.
2206 nil or empty string as argument means make buffer not be visiting any file.
2207 Remember to delete the initial contents of the minibuffer
2208 if you wish to pass an empty string as the argument.
2210 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2211 confirmation in the case where another buffer is already visiting FILENAME.
2213 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2214 the old visited file has been renamed to the new name FILENAME."
2222 nil
2233 filename)))
2252 ;; Abbreviate the file names of the buffer.
2261 nil)))
2262 ;; write-file-functions is normally used for things like ftp-find-file
2263 ;; that visit things that are not local files as if they were files.
2264 ;; Changing to visit an ordinary local file instead should flush the hook.
2269 ;; If buffer was read-only because of version control,
2270 ;; that reason is gone now, so make it writable.
2274 ;; Turn off backup files for certain file names.
2275 ;; Since this is a permanent local, the major mode won't eliminate it.
2282 ;; If auto-save was not already on, turn it on if appropriate.
2286 ;; If auto save is on, start using a new name.
2287 ;; We deliberately don't rename or delete the old auto save
2288 ;; for the old visited file name. This is because perhaps
2289 ;; the user wants to save the new state and then compare with the
2290 ;; previous state from the auto save file.
2293 ;; Rename the old auto save file if any.
2300 ;; Update the major mode, if the file name determines it.
2302 ;; Don't change the mode if it is special.
2305 ;; Don't change the mode if the local variable list specifies it.
2311 "Write current buffer into file FILENAME.
2312 This makes the buffer visit that file, and marks it as not modified.
2314 If you specify just a directory name as FILENAME, that means to use
2315 the default file name but in that directory. You can also yank
2316 the default file name into the minibuffer to edit it, using M-n.
2318 If the buffer is not already visiting a file, the default file name
2319 for the output file is the buffer name.
2321 If optional second arg CONFIRM is non-nil, this function
2322 asks for confirmation before overwriting an existing file.
2323 Interactively, confirmation is required unless you supply a prefix argument."
2324 ;; (interactive "FWrite file: ")
2328 nil nil nil nil)
2332 default-directory)
2333 nil nil))
2337 ;; If arg is just a directory,
2338 ;; use the default file name, but in that directory.
2349 ;; Make buffer writable if file is writable.
2354 \f
2356 "Make a backup of the disk file visited by the current buffer, if appropriate.
2357 This is normally done before saving the buffer the first time.
2359 A backup may be done by renaming or by copying; see documentation of
2360 variable `make-backup-files'. If it's done by renaming, then the file is
2361 no longer accessible under its old name.
2363 The value is non-nil after a backup was made by renaming.
2364 It has the form (MODES . BACKUPNAME).
2365 MODES is the result of `file-modes' on the original
2366 file; this means that the caller, after saving the buffer, should change
2367 the modes of the new file to agree with the old modes.
2368 BACKUPNAME is the backup file name, which is the old file renamed."
2375 backup-info backupname targets setmodes)
2376 ;; If specified name is a symbolic link, chase it to the target.
2377 ;; Thus we make the backups in the directory where the real file is.
2382 ;; (if (file-directory-p buffer-file-name)
2383 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2387 ;; If have old versions to maybe delete,
2388 ;; ask the user to confirm now, before doing anything.
2389 ;; But don't actually delete til later.
2394 real-file-name)))))
2396 ;; Actually write the back up file.
2399 ; (file-symlink-p buffer-file-name)
2400 backup-by-copying
2401 ;; Don't rename a suid or sgid file.
2415 ;; rename-file should delete old backup.
2419 ;; If trouble writing the backup, write it in ~.
2428 ;; Now delete the old versions, if desired.
2435 setmodes)
2442 ;; If copying fails because file TO-NAME
2443 ;; is not writable, delete that file and try again.
2451 "Return file NAME sans backup versions or strings.
2452 This is a separate procedure so your site-init or startup file can
2453 redefine it.
2454 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2455 we do not remove backup version numbers, only true file version numbers."
2461 ;; VMS version number is (a) semicolon, optional
2462 ;; sign, zero or more digits or (b) period, option
2463 ;; sign, zero or more digits, provided this is the
2464 ;; second period encountered outside of the
2465 ;; device/directory part of the file name.
2468 name)
2478 "Return t if deleting FILE and rewriting it would preserve the owner."
2483 ;; Return t if the file doesn't exist, since it's true that no
2484 ;; information would be lost by an (attempted) delete and create.
2490 The extension, in a file name, is the part that follows the last `.',
2491 except that a leading `.', if any, doesn't count."
2494 directory)
2498 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2499 ;; we don't want to expand it.
2502 filename))))
2506 The extension, in a file name, is the part that follows the last `.',
2507 except that a leading `.', if any, doesn't count.
2508 Return nil for extensionless file names such as `foo'.
2509 Return the empty string for file names such as `foo.'.
2511 If PERIOD is non-nil, then the returned value includes the period
2512 that delimits the extension, and if FILENAME has no extension,
2523 "A function to use instead of the default `make-backup-file-name'.
2524 A value of nil gives the default `make-backup-file-name' behaviour.
2526 This could be buffer-local to do something special for specific
2527 files. If you define it, you may need to change `backup-file-name-p'
2528 and `file-name-sans-versions' too.
2530 See also `backup-directory-alist'."
2536 "Alist of filename patterns and backup directory names.
2537 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2538 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2539 relative or absolute. If it is absolute, so that all matching files
2540 are backed up into the same directory, the file names in this
2541 directory will be the full name of the file backed up with all
2542 directory separators changed to `!' to prevent clashes. This will not
2543 work correctly if your filesystem truncates the resulting name.
2545 For the common case of all backups going into one directory, the alist
2547 directory name.
2549 If this variable is nil, or it fails to match a filename, the backup
2550 is made in the original file's directory.
2552 On MS-DOS filesystems without long names this variable is always
2553 ignored."
2559 "Default `backup-enable-predicate' function.
2560 Checks for files in `temporary-file-directory' or
2561 `small-temporary-file-directory'."
2564 ;; Directory is under temporary-file-directory.
2569 0 nil
2571 ;; Directory is under small-temporary-file-directory.
2576 "Create the non-numeric backup file name for FILE.
2577 Normally this will just be the file's name with `~' appended.
2578 Customization hooks are provided as follows.
2580 If the variable `make-backup-file-name-function' is non-nil, its value
2581 should be a function which will be called with FILE as its argument;
2582 the resulting name is used.
2584 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2585 the documentation of that variable. If the directory for the backup
2586 doesn't exist, it is created."
2600 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2602 elt backup-directory failed)
2607 alist nil)))
2613 file
2617 ;; Normalize DOSish file names: downcase the drive
2618 ;; letter, if any, and replace the leading "x:" with
2619 ;; "/drive_x".
2622 ;; Replace any invalid file-name characters (for the
2623 ;; case of backing up remote files).
2627 "drive_"
2630 ""
2633 ;; Make the name unique by substituting directory
2634 ;; separators. It may not really be worth bothering about
2635 ;; doubling `!'s in the original name...
2640 backup-directory))
2647 "Return non-nil if FILE is a backup file name (numeric or not).
2648 This is a separate function so you can redefine it for customization.
2649 You may need to redefine `file-name-sans-versions' as well."
2654 ;; This is used in various files.
2655 ;; The usage of backup-extract-version-start is not very clean,
2656 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2658 "Given the name of a numeric backup file, FN, return the backup number.
2659 Uses the free variable `backup-extract-version-start', whose value should be
2660 the index in the name where the version number begins."
2666 ;; I believe there is no need to alter this behavior for VMS;
2667 ;; since backup files are not made on VMS, it should not get called.
2669 "Find a file name for a backup file FN, and suggestions for deletions.
2670 Value is a list whose car is the name for the backup file
2671 and whose cdr is a list of old versions to consider deleting now.
2672 If the value is nil, don't make a backup.
2673 Uses `backup-directory-alist' in the same way as does
2674 `make-backup-file-name'."
2676 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2680 ;; We don't support numbered backups on plain MS-DOS
2681 ;; when long file names are unavailable.
2691 possibilities deserve-versions-p versions)
2694 base-versions
2697 possibilities)
2698 #'<)
2703 kept-old-versions
2704 kept-new-versions
2711 ;; Delete nothing if there is overflow
2712 ;; in the number of versions to keep.
2718 v))))))))))
2721 "Return number of names file FILENAME has."
2725 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2726 This function returns a relative file name which is equivalent to FILENAME
2727 when used with that default directory as the default.
2728 If this is impossible (which can happen on MSDOS and Windows
2729 when the file name and directory use different drive names)
2730 then it returns FILENAME."
2735 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2736 ;; drive names, they can't be relative, so return the absolute name.
2741 filename
2748 ".."
2750 ;; Now ancestor is empty, or .., or ../.., etc.
2752 ;; We matched within FNAME's directory part.
2753 ;; Add the rest of FNAME onto ANCESTOR.
2757 ;; But don't bother with ANCESTOR if it would give us `./'.
2758 rest
2760 ;; We matched FNAME's directory equivalent.
2761 ancestor))))))
2762 \f
2764 "Save current buffer in visited file if modified. Versions described below.
2765 By default, makes the previous version into a backup file
2766 if previously requested or if this is the first save.
2768 to become a backup when the next save is done.
2770 unconditionally makes the previous version into a backup file.
2772 to become a backup when the next save is done,
2773 and unconditionally makes the previous version into a backup file.
2775 With argument of 0, never make the previous version into a backup file.
2777 If a file's name is FOO, the names of its numbered backup versions are
2778 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2779 Numeric backups (rather than FOO~) will be made if value of
2780 `version-control' is not the atom `never' and either there are already
2781 numeric versions of the file being backed up, or `version-control' is
2782 non-nil.
2783 We don't want excessive versions piling up, so there are variables
2784 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2785 and `kept-new-versions', which tells how many newest versions to keep.
2786 Defaults are 2 old versions and 2 new.
2787 `dired-kept-versions' controls dired's clean-directory (.) command.
2788 If `delete-old-versions' is nil, system will query user
2789 before trimming versions. Otherwise it does it silently.
2791 If `vc-make-backup-files' is nil, which is the default,
2792 no backup files are made for files managed by version control.
2793 (This is because the version control system itself records previous versions.)
2795 See the subroutine `basic-save-buffer' for more information."
2808 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2809 Normally delete only if the file was written by this Emacs since
2810 the last real save, but optional arg FORCE non-nil means delete anyway."
2824 "Normal hook that is run after a buffer is saved to its file."
2830 "If non-nil, use this coding system for saving the buffer.
2831 More precisely, use this coding system in place of the
2832 value of `buffer-file-coding-system', when saving the buffer.
2833 Calling `write-region' for any purpose other than saving the buffer
2834 will still use `buffer-file-coding-system'; this variable has no effect
2841 "Save the current buffer in its visited file, if it has been modified.
2842 The hooks `write-contents-functions' and `write-file-functions' get a chance
2843 to do the job of saving; if they do not, then the buffer is saved in
2844 the visited file file in the usual way.
2845 After saving the buffer, this function runs `after-save-hook'."
2848 ;; In an indirect buffer, save its base buffer instead.
2853 setmodes tempsetmodes)
2854 ;; On VMS, rename file and buffer to get rid of version number.
2859 ;; Strip VMS version number before save.
2862 ;; Construct a (unique) buffer name to correspond.
2867 ;; If buffer has no file name, ask user for one.
2874 filename))
2899 ;; Support VC version backups.
2904 ;; If a hook returned t, file is already "written".
2905 ;; Otherwise, write it the usual way now.
2907 ;; Now we have saved the current buffer. Let's make sure
2908 ;; that buffer-file-coding-system is fixed to what
2909 ;; actually used for saving by binding it locally.
2919 ;; If the auto-save file was recent before this command,
2920 ;; delete it now.
2922 ;; Support VC `implicit' locking.
2927 ;; This does the "real job" of writing a buffer into its visited file
2928 ;; and making a backup file. This is what is normally done
2929 ;; but inhibited if one of write-file-functions returns non-nil.
2930 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
2937 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
2951 buffer-file-name)))
2959 ;; If file is precious, write temp name, then rename it.
2960 ;; This requires write access to the containing dir,
2961 ;; which is why we don't try it if we don't have that access.
2963 tempname temp nogood i succeed
2967 ;; Find the temporary name to write under.
2974 "%s$tmp$%d"
2976 dir i))
2982 tempname nil realname
2983 buffer-file-truename)
2985 ;; If writing the temp file fails,
2986 ;; delete the temp file.
2993 ;; Since we have created an entirely new file
2994 ;; and renamed it, make sure it gets the
2995 ;; right permission bits set.
2997 buffer-file-name)))
2998 ;; We succeeded in writing the temp file,
2999 ;; so rename it.
3001 ;; If file not writable, see if we can make it writable
3002 ;; temporarily while we write it.
3003 ;; But no need to do so if we have just backed it up
3004 ;; (setmodes is set) because that says we're superseding.
3006 ;; Change the mode back, after writing.
3013 buffer-file-name nil t buffer-file-truename)
3015 ;; If we get an error writing the new file, and we made
3016 ;; the backup by renaming, undo the backing-up.
3019 setmodes))
3022 "View the differences between BUFFER and its associated file.
3023 This requires the external program `diff' to be in your `exec-path'."
3038 ;; Display that message for 1 second so that user can read it
3039 ;; in the minibuffer.
3041 ;; return always nil, so that save-buffers-kill-emacs will not move
3042 ;; over to the next unsaved buffer when calling `d'.
3043 nil)
3046 '((?\C-r
3052 ;; Return nil to ask about BUF again.
3053 nil)
3055 (?d diff-buffer-with-file
3061 "Save some modified file-visiting buffers. Asks user about each one.
3062 You can answer `y' to save, `n' not to save, `C-r' to look at the
3063 buffer in question with `view-buffer' before deciding or `d' to
3064 view the differences using `diff-buffer-to-file'.
3066 Optional argument (the prefix) non-nil means save all with no questions.
3067 Optional second argument PRED determines which buffers are considered:
3068 If PRED is nil, all the file-visiting buffers are considered.
3069 If PRED is t, then certain non-file buffers will also be considered.
3070 If PRED is a zero-argument function, it indicates for each buffer whether
3071 to consider it or not when called with that buffer current.
3073 See `save-some-buffers-action-alist' if you want to
3074 change the additional actions you can take on files."
3093 t
3106 save-some-buffers-action-alist))
3113 abbrev-file-name)))
3115 ;; Don't keep bothering user if he says no.
3117 t))))
3120 \f
3122 "Mark current buffer as unmodified, not needing to be saved.
3125 It is not a good idea to use this function in Lisp programs, because it
3126 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3133 "Change whether this buffer is visiting its file read-only.
3134 With arg, set read-only iff arg is positive.
3135 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3140 nil ; do nothing.
3141 ;; Toggle.
3158 "Insert contents of file FILENAME into buffer after point.
3159 Set mark after the inserted text.
3161 This function is meant for the user to run interactively.
3162 Don't call it from programs! Use `insert-file-contents' instead.
3163 \(Its calling sequence is different; see its documentation)."
3168 "Append the contents of the region to the end of file FILENAME.
3169 When called from a function, expects three arguments,
3170 START, END and FILENAME. START and END are buffer positions
3171 saying what text to write."
3176 "Return most recent backup file for FILENAME or nil if no backups exist."
3177 ;; `make-backup-file-name' will get us the right directory for
3178 ;; ordinary or numeric backups. It might create a directory for
3179 ;; backups as a side-effect, according to `backup-directory-alist'.
3186 tem)
3195 newest))
3198 "Rename current buffer to a similar name not already taken.
3199 This function is useful for creating multiple shell process buffers
3200 or multiple mail buffers, etc."
3208 ;; If the existing buffer name has a <NNN>,
3209 ;; which isn't part of the file name (if any),
3210 ;; then get rid of that.
3216 "Create the directory DIR and any nonexistent parent dirs.
3217 Interactively, the default choice of directory to create
3218 is the current default directory for file names.
3219 That is useful when you have visited a file in a nonexistent directory.
3221 Noninteractively, the second (optional) argument PARENTS says whether
3222 to create parent directories if they don't exist."
3225 nil nil)
3226 t))
3227 ;; If default-directory is a remote directory,
3228 ;; make sure we find its make-directory handler.
3236 create-list)
3243 \f
3246 "Function to use to revert this buffer, or nil to do the default.
3247 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3252 "Function to use to insert contents when reverting this buffer.
3253 Gets two args, first the nominal file name to use,
3254 and second, t if reading the auto-save file.
3259 "Normal hook for `revert-buffer' to run before reverting.
3260 If `revert-buffer-function' is used to override the normal revert
3264 "Normal hook for `revert-buffer' to run after reverting.
3265 Note that the hook value that it runs is the value that was in effect
3266 before reverting; that makes a difference if you have buffer-local
3267 hook functions.
3269 If `revert-buffer-function' is used to override the normal revert
3275 "Replace current buffer text with the text of the visited file on disk.
3276 This undoes all changes since the file was visited or saved.
3277 With a prefix argument, offer to revert from latest auto-save file, if
3278 that is more recent than the visited file.
3280 This command also works for special buffers that contain text which
3281 doesn't come from a file, but reflects some other data base instead:
3282 for example, Dired buffers and buffer-list buffers. In these cases,
3283 it reconstructs the buffer contents from the appropriate data base.
3285 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3286 to revert from the auto-save file when this is nil. Note that the
3287 sense of this argument is the reverse of the prefix argument, for the
3288 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3289 to nil.
3291 Optional second argument NOCONFIRM means don't ask for confirmation at
3292 all. (The local variable `revert-without-query', if non-nil, prevents
3293 confirmation.)
3295 Optional third argument PRESERVE-MODES non-nil means don't alter
3296 the files modes. Normally we reinitialize them using `normal-mode'.
3298 If the value of `revert-buffer-function' is non-nil, it is called to
3299 do all the work for this command. Otherwise, the hooks
3300 `before-revert-hook' and `after-revert-hook' are run at the beginning
3301 and the end, and if `revert-buffer-insert-file-contents-function' is
3302 non-nil, it is called instead of rereading visited file contents."
3304 ;; I admit it's odd to reverse the sense of the prefix argument, but
3305 ;; there is a lot of code out there which assumes that the first
3306 ;; argument should be t to avoid consulting the auto-save file, and
3307 ;; there's no straightforward way to encourage authors to notice a
3308 ;; reversal of the argument sense. So I'm just changing the user
3309 ;; interface, but leaving the programmatic interface the same.
3315 buffer-auto-save-file-name
3320 buffer-auto-save-file-name
3321 buffer-file-name)))
3332 found))
3334 file-name)))
3336 ;; If file was backed up but has changed since,
3337 ;; we shd make another backup.
3341 ;; Get rid of all undo records for this buffer.
3344 ;; Effectively copy the after-revert-hook status,
3345 ;; since after-find-file will clobber it.
3349 after-revert-hook)))
3351 ;; Don't make undo records for the reversion.
3355 file-name auto-save-p)
3358 ;; Bind buffer-file-name to nil
3359 ;; so that we don't try to lock the file.
3365 ;; Auto-saved file shoule be read without
3366 ;; any code conversion.
3369 buffer-file-coding-system))))
3370 ;; This force
3371 ;; after-insert-file-set-buffer-file-coding-system
3372 ;; (called from insert-file-contents) to set
3373 ;; buffer-file-coding-system to a proper value.
3376 ;; Note that this preserves point in an intelligent way.
3380 nil nil t))
3382 nil nil t)))))
3383 ;; Recompute the truename in case changes in symlinks
3384 ;; have changed the truename.
3388 ;; Run after-revert-hook as it was before we reverted.
3396 t)))))
3399 "Recover the visited file--get contents from its last auto-save file."
3404 "Visit file FILE, but get contents from its last auto-save file."
3405 ;; Actually putting the file name in the minibuffer should be used
3406 ;; only rarely.
3407 ;; Not just because users often use the default.
3426 ;; Use insert-directory-safely, not insert-directory,
3427 ;; because these files might not exist. In particular,
3428 ;; FILE might not exist if the auto-save file was for
3429 ;; a buffer that didn't visit a file, such as "*mail*".
3430 ;; The code in v20.x called `ls' directly, so we need
3431 ;; to emulate what `ls' did in that case.
3437 ;; Keep the current buffer-file-coding-system.
3439 ;; Auto-saved file shoule be read without any code conversion.
3448 "Recover auto save files from a previous Emacs session.
3449 This command first displays a Dired buffer showing you the
3450 previous sessions that you could recover from.
3451 To choose one, move point to the proper line and then type C-c C-c.
3452 Then you'll be asked about a number of files to recover."
3466 ;; Each line starts with a space
3467 ;; so that Font Lock mode won't highlight the first character.
3476 "Choose one saved session to recover auto-save files from.
3477 This command is used in the special Dired buffer created by
3480 ;; Get the name of the session file to recover from.
3482 files
3488 ;; Read in the auto-save-list file.
3492 ;; Loop thru the text of that file
3493 ;; and get out the names of the files to recover.
3497 ;; This is a pair of lines for a non-file-visiting buffer.
3498 ;; Get the auto-save file name and manufacture
3499 ;; a "visited file name" from that.
3515 ;; This pair of lines is a file-visiting
3516 ;; buffer. Use the visited file name.
3526 ;; Ignore a file if its auto-save file does not exist now.
3530 ;; The file contains a pair of line for each auto-saved buffer.
3531 ;; The first line of the pair contains the visited file name
3532 ;; or is empty if the buffer was not visiting a file.
3533 ;; The second line is the auto-save file name.
3541 files
3547 "For each buffer in LIST, ask whether to kill it.
3548 LIST defaults to all existing live buffers."
3559 name
3564 \f
3566 "Toggle auto-saving of contents of current buffer.
3567 With prefix argument ARG, turn auto-saving on if positive, else off."
3572 ;; If auto-save is off because buffer has shrunk,
3573 ;; then toggling should turn it on.
3578 buffer-file-name
3580 ;; If -1 was stored here, to temporarily turn off saving,
3581 ;; turn it back on.
3587 buffer-auto-save-file-name)
3590 "Adjust current buffer's auto save file name for current conditions.
3591 Also rename any existing auto save file, if it was made in this session."
3603 "Return file name to use for auto-saves of current buffer.
3604 Does not consider `auto-save-visited-file-name' as that variable is checked
3605 before calling this function. You can redefine this for customization.
3606 See also `auto-save-file-name-p'."
3610 result uniq)
3611 ;; Apply user-specified translations
3612 ;; to the file name.
3616 filename)
3626 filename))))
3631 ;; We truncate the file name to DOS 8+3 limits
3632 ;; before doing anything else, because the regexp
3633 ;; passed to string-match below cannot handle
3634 ;; extensions longer than 3 characters, multiple
3635 ;; dots, and other atrocities.
3640 fn)
3645 "#"
3648 ;; Make sure auto-save file names don't contain characters
3649 ;; invalid for the underlying filesystem.
3651 ;; Don't modify remote (ange-ftp) filenames
3654 result))
3656 ;; Deal with buffers that don't have any associated files. (Mail
3657 ;; mode tends to create a good number of these.)
3661 file-name)
3662 ;; Eliminate all slashes and backslashes by
3663 ;; replacing them with sequences that start with %.
3664 ;; Quote % also, to keep distinct names distinct.
3673 ;; Generate the file name.
3679 ;; Try a few alternative directories, to get one we can
3680 ;; write it.
3686 ;; Don't modify remote (ange-ftp) filenames
3688 ;; The call to convert-standard-filename is in case
3689 ;; buffer-name includes characters not allowed by the
3690 ;; DOS/Windows filesystems. make-temp-file writes to the
3691 ;; file it creates, so we must fix the file name _before_
3692 ;; make-temp-file is called.
3694 fname))
3696 ;; make-temp-file creates the file,
3697 ;; but we don't want it to exist until we do an auto-save.
3701 file-name)))
3704 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3705 FILENAME should lack slashes. You can redefine this for customization."
3707 \f
3709 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3710 The generated regexp will match a filename iff the filename
3711 matches that wildcard according to shell rules. Only wildcards known
3712 by `sh' are supported."
3714 ;; Copy the initial run of non-special characters.
3717 ;; If no special characters, we're almost done.
3721 j)
3723 result
3744 ;; Found "[^". Insert a `\0' character
3745 ;; (which cannot happen in a filename)
3746 ;; into the character class, so that `^'
3747 ;; is not the first character after `[',
3748 ;; and thus non-special in a regexp.
3753 ;; I don't think `]' can appear in a
3754 ;; character class in a wildcard, but
3755 ;; let's be general here.
3762 i
3775 ;; Shell wildcards should match the entire filename,
3776 ;; not its part. Make the regexp say so.
3778 \f
3781 "*Switches for `list-directory' to pass to `ls' for brief listing."
3787 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3789 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3794 "Expand wildcard pattern PATTERN.
3795 This returns a list of file names which match the pattern.
3797 If PATTERN is written as an absolute relative file name,
3798 the values are absolute also.
3800 If PATTERN is written as a relative file name, it is interpreted
3801 relative to the current default directory, `default-directory'.
3802 The file names returned are normally also relative to the current
3803 default directory. However, if FULL is non-nil, they are absolute."
3807 ;; A list of all dirs that DIRPART specifies.
3808 ;; This can be more than one dir
3809 ;; if DIRPART contains wildcards.
3814 contents)
3819 ;; Filter out "." and ".."
3824 name))
3831 this-dir-contents)
3832 this-dir-contents)
3833 contents))))
3835 contents)))
3838 "Display a list of files in or matching DIRNAME, a la `ls'.
3839 DIRNAME is globbed by the shell if necessary.
3840 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3841 Actions controlled by variables `list-directory-brief-switches'
3842 and `list-directory-verbose-switches'."
3846 nil default-directory nil)
3847 pfx)))
3849 list-directory-brief-switches))
3850 buffer)
3863 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
3871 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3873 PATTERN is assumed to represent a file-name wildcard suitable for the
3874 underlying filesystem. For Unix and GNU/Linux, the characters from the
3876 the parts of the pattern which don't include wildcard characters are
3877 quoted with double quotes.
3878 Existing quote characters in PATTERN are left alone, so you can pass
3879 PATTERN that already quotes some of the special characters."
3883 ;; DOS/Windows don't allow `"' in file names. So if the
3884 ;; argument has quotes, we can safely assume it is already
3885 ;; quoted by the caller.
3887 ;; We quote [&()#$'] in case their shell is a port of a
3888 ;; Unixy shell. We quote [,=+] because stock DOS and
3889 ;; Windows shells require that in some cases, such as
3890 ;; passing arguments to batch files that use positional
3891 ;; arguments like %1.
3893 pattern
3896 end)
3913 pattern))))
3920 "*Program to get the amount of free space on a file system.
3921 We assume the output has the format of `df'.
3922 The value of this variable must be just a command name or file name;
3923 if you want to specify options, use `directory-free-space-args'.
3925 A value of nil disables this feature.
3927 If the function `file-system-info' is defined, it is always used in
3928 preference to the program given by this variable."
3934 "*Options to use when running `directory-free-space-program'."
3939 "Return the mount of free space on directory DIR's file system.
3940 The result is a string that gives the number of free 1KB blocks,
3941 or nil if the system call or the program which retrieve the infornmation
3942 fail.
3944 This function calls `file-system-info' if it is available, or invokes the
3945 program specified by `directory-free-space-program' if that is non-nil."
3946 ;; Try to find the number of free blocks. Non-Posix systems don't
3947 ;; always have df, but might have an equivalent system call.
3956 nil t nil
3957 directory-free-space-args
3958 dir)))
3959 ;; Usual format is a header line followed by a line of
3960 ;; numbers.
3965 ;; Move to the end of the "available blocks" number.
3968 ;; Copy it into AVAILABLE.
3974 ;; insert-directory
3975 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3976 ;; FULL-DIRECTORY-P is nil.
3977 ;; The single line of output must display FILE's name as it was
3978 ;; given, namely, an absolute path name.
3979 ;; - must insert exactly one line for each file if WILDCARD or
3980 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3981 ;; before the file lines, plus optional text after the file lines.
3982 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3983 ;; allowed.
3984 ;; File lines should display the basename.
3985 ;; - must be consistent with
3986 ;; - functions dired-move-to-filename, (these two define what a file line is)
3987 ;; dired-move-to-end-of-filename,
3988 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3989 ;; dired-insert-headerline
3990 ;; dired-after-subdir-garbage (defines what a "total" line is)
3991 ;; - variable dired-subdir-regexp
3992 ;; - may be passed "--dired" as the first argument in SWITCHES.
3993 ;; Filename handlers might have to remove this switch if their
3994 ;; "ls" command does not support it.
3996 "Insert directory listing for FILE, formatted according to SWITCHES.
3997 Leaves point after the inserted text.
3998 SWITCHES may be a string of options, or a list of strings.
3999 Optional third arg WILDCARD means treat FILE as shell wildcard.
4000 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4001 switches do not contain `d', so that a full listing is expected.
4003 This works by running a directory listing program
4004 whose name is in the variable `insert-directory-program'.
4005 If WILDCARD, it also runs the shell specified by `shell-file-name'."
4006 ;; We need the directory in order to find the right handler.
4011 wildcard full-directory-p)
4016 ;; Read the actual directory using `insert-directory-program'.
4017 ;; RESULT gets the status code.
4021 default-file-name-coding-system)))
4022 ;; This is to control encoding the arguments in call-process.
4026 ;; Run ls in the directory part of the file pattern
4027 ;; using the last component as argument.
4034 shell-file-name nil t nil
4035 "-c"
4037 ""
4039 insert-directory-program
4040 " -d "
4042 switches
4044 " -- "
4045 ;; Quote some characters that have
4046 ;; special meanings in shells; but
4047 ;; don't quote the wildcards--we want
4048 ;; them to be special. We also
4049 ;; currently don't quote the quoting
4050 ;; characters in case people want to
4051 ;; use them explicitly to quote
4052 ;; wildcard characters.
4054 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4055 ;; directory if FILE is a symbolic link.
4057 insert-directory-program nil t nil
4061 ;; Split the switches at any spaces so we can
4062 ;; pass separate options as separate args.
4064 ;; Avoid lossage if FILE starts with `-'.
4072 file))))))))
4074 ;; If `insert-directory-program' failed, signal an error.
4076 ;; On non-Posix systems, we cannot open a directory, so
4077 ;; don't even try, because that will always result in
4078 ;; the ubiquitous "Access denied". Instead, show the
4079 ;; command line so the user can try to guess what went wrong.
4084 insert-directory-program
4086 file result)
4087 ;; Unix. Access the file to get a suitable error.
4108 ;; Try to insert the amount of free space.
4111 ;; First find the line to put it on.
4115 ;; Replace "total" with "used", to avoid confusion.
4122 "Insert directory listing for FILE, formatted according to SWITCHES.
4124 Like `insert-directory', but if FILE does not exist, it inserts a
4125 message to that effect instead of signaling an error."
4128 ;; Simulate the message printed by `ls'.
4132 "Functions to call with no arguments to query about killing Emacs.
4133 If any of these functions returns nil, killing Emacs is cancelled.
4135 but `kill-emacs', the low level primitive, does not.
4139 "How to ask for confirmation when leaving Emacs.
4140 If nil, the default, don't ask at all. If the value is non-nil, it should
4141 be a predicate function such as `yes-or-no-p'."
4149 "Offer to save each buffer, then kill this Emacs process.
4150 With prefix arg, silently save all file-visiting buffers, then kill."
4159 ;; process-list is not defined on VMS.
4161 active)
4170 ;; Query the user for other things, perhaps.
4175 \f
4176 ;; We use /: as a prefix to "quote" a file name
4177 ;; so that magic file name handlers will not apply to it.
4181 file-name-handler-alist))
4183 ;; We depend on being the last handler on the list,
4184 ;; so that anything else which does need handling
4185 ;; has been handled already.
4186 ;; So it is safe for us to inhibit *all* magic file name handlers.
4195 default-directory))
4196 ;; Get a list of the indices of the args which are file names.
4199 ;; The first five are special because they
4200 ;; return a file name. We want to include the /:
4201 ;; in the return value.
4202 ;; So just avoid stripping it in the first place.
4208 ;; `identity' means just return the first arg
4209 ;; as stripped of its quoting.
4217 ;; For all other operations, treat the first argument only
4218 ;; as the file name.
4220 ;; Copy ARGUMENTS so we can replace elements in it.
4222 ;; Strip off the /: from the file names that have this handler.
4230 "/"
4236 \f
4260 ;;; files.el ends here