| blob | 037c37b64558239111b6a69142277d77df94eee0 |
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
689 ;; If this file directly leads to a link, process that iteratively
690 ;; so that we don't use lots of stack.
696 ;; For file name that has a special handler, call handler.
697 ;; This is so that ange-ftp can save time by doing a no-op.
700 done t)
702 target dirfile)
703 ;; Get the truename of the directory.
705 ;; If these are equal, we have the (or a) root directory.
707 ;; If this is the same dir we last got the truename for,
708 ;; save time--don't recalculate.
718 done t)
721 done t)
722 ;; Put it back on the file name.
724 ;; Is the file name the name of a link?
727 ;; Yes => chase that link, then start all over
728 ;; since the link may point to a directory name that uses links.
729 ;; We can't safely use expand-file-name here
730 ;; since target might look like foo/../bar where foo
731 ;; is itself a link. Instead, we handle . and .. above.
734 target
736 done nil)
737 ;; No, we are done!
739 filename))
742 "Chase links in FILENAME until a name that is not a link.
743 Does not examine containing directories for links,
744 unlike `file-truename'."
750 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
753 ;; Handle `..' by hand, since it needs to work in the
754 ;; target of any directory symlink.
755 ;; This code is not quite complete; it does not handle
756 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
760 ;; Chase links in the default dir of the symlink.
764 ;; Now find the parent of that dir.
768 newname))
771 "Change the encoding of FILE's name from CODING to NEW-CODING.
772 The value is a new name of FILE.
773 Signals a `file-already-exists' error if a file of the new name
774 already exists unless optional third argument OK-IF-ALREADY-EXISTS
775 is non-nil. A number as third arg means request confirmation if
776 the new name already exists. This is what happens in interactive
777 use with M-x."
780 default-file-name-coding-system))
782 from-coding to-coding)
784 ;; We provide the default coding only when it seems that
785 ;; the filename is correctly decoded by the default
786 ;; coding.
792 filename default-coding)
793 default-coding))
797 ;; We provide the default coding only when a user is going to
798 ;; change the encoding not from the default coding.
802 filename from-coding)))
805 filename from-coding default-coding)
806 default-coding)))
810 default-file-name-coding-system))
811 ;; FILE should have been decoded by DEFAULT-CODING.
815 ;; Suppress further encoding.
820 newname))
821 \f
823 "Select buffer BUFFER in another window.
824 Optional second arg NORECORD non-nil means
825 do not put this buffer at the front of the list of recently selected ones.
827 This uses the function `display-buffer' as a subroutine; see its
828 documentation for additional customization information."
834 "Switch to buffer BUFFER in another frame.
835 Optional second arg NORECORD non-nil means
836 do not put this buffer at the front of the list of recently selected ones.
838 This uses the function `display-buffer' as a subroutine; see its
839 documentation for additional customization information."
855 ;; Clear out this hook so it does not interfere
856 ;; with any recursive minibuffer usage.
859 minibuffer-setup-hook))
862 t))
865 "Edit file FILENAME.
866 Switch to a buffer visiting file FILENAME,
867 creating one if none already exists.
868 Interactively, the default if you just type RET is the current directory,
869 but the visited file name is available through the minibuffer history:
870 type M-n to pull it into the minibuffer.
872 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
873 expand wildcards (if any) and visit multiple files. Wildcard expansion
874 can be suppressed by setting `find-file-wildcards'."
883 "Edit file FILENAME, in another window.
884 May create a new window, or reuse an existing one.
885 See the function `display-buffer'.
887 Interactively, the default if you just type RET is the current directory,
888 but the visited file name is available through the minibuffer history:
889 type M-n to pull it into the minibuffer.
891 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
892 expand wildcards (if any) and visit multiple files."
903 "Edit file FILENAME, in another frame.
904 May create a new frame, or reuse an existing one.
905 See the function `display-buffer'.
907 Interactively, the default if you just type RET is the current directory,
908 but the visited file name is available through the minibuffer history:
909 type M-n to pull it into the minibuffer.
911 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
912 expand wildcards (if any) and visit multiple files."
923 "Edit file FILENAME but don't allow changes.
932 "Edit file FILENAME in another window but don't allow changes.
941 "Edit file FILENAME in another frame but don't allow changes.
950 "Find file FILENAME as a replacement for the file in the next window.
951 This command does not select that window."
970 "Find file FILENAME, select its buffer, kill previous buffer.
971 If the current buffer now contains an empty file that you just visited
972 \(presumably by mistake), use this command to visit the file you really want."
1002 ;; This prevents us from finding the same buffer
1003 ;; if we specified the same file again.
1007 ;; Likewise for dired buffers.
1011 ;; This executes if find-file gets an error
1012 ;; and does not really find anything.
1013 ;; We put things back as they were.
1014 ;; If find-file actually finds something, we kill obuf below.
1023 ;; We already asked; don't ask again.
1026 \f
1028 "Create a suitably named buffer for visiting FILENAME, and return it.
1029 FILENAME (sans directory) is used unchanged if that name is free;
1030 otherwise a string <2> or <3> or ... is appended to get an unused name."
1037 "Create and return a buffer with a name based on NAME.
1038 Choose the buffer's name using `generate-new-buffer-name'."
1042 "Regexp to match the automounter prefix in a directory name."
1050 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1052 removes automounter prefixes (see the variable `automount-dir-prefix')."
1053 ;; Get rid of the prefixes added by the automounter.
1060 ;; If any elt of directory-abbrev-alist matches this name,
1061 ;; abbreviate accordingly.
1067 ;; Compute and save the abbreviated homedir name.
1068 ;; We defer computing this until the first time it's needed, to
1069 ;; give time for directory-abbrev-alist to be set properly.
1070 ;; We include a slash at the end, to avoid spurious matches
1071 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1078 ;; If FILENAME starts with the abbreviated homedir,
1079 ;; make it start with `~' instead.
1081 ;; If the home dir is just /, don't change it.
1084 ;; MS-DOS root directories can come with a drive letter;
1085 ;; Novell Netware allows drive letters beyond `Z:'.
1095 filename))
1098 "*List of logical names for which visiting shouldn't save the true dirname.
1099 On VMS, when you visit a file using a logical name that searches a path,
1100 you may or may not want the visited file name to record the specific
1101 directory where the file was found. If you *do not* want that, add the logical
1102 name to this list as a string."
1107 "Return the buffer visiting file FILENAME (a string).
1108 This is like `get-file-buffer', except that it checks for any buffer
1109 visiting the same file, possibly under a different name.
1110 If PREDICATE is non-nil, only a buffer satisfying it can be returned.
1111 If there is no such live buffer, return nil."
1125 found)
1130 number
1135 ;; Verify this buffer's file number
1136 ;; still belongs to its file.
1139 attributes)
1143 found))))
1144 \f
1146 "*Non-nil means file-visiting commands should handle wildcards.
1147 For example, if you specify `*.c', that would visit all the files
1148 whose names match the pattern."
1154 "*Non-nil means suppress warning messages for symlinked files.
1155 When nil, Emacs prints a warning when visiting a file that is already
1156 visited, but with a different name. Setting this option to t
1157 suppresses this warning."
1163 "Read file FILENAME into a buffer and return the buffer.
1164 If a buffer exists visiting FILENAME, return that one, but
1165 verify that the file has not changed since visited or saved.
1166 The buffer is not selected, just returned to the caller.
1167 Optional first arg NOWARN non-nil means suppress any warning messages.
1168 Optional second arg RAWFILE non-nil means the file is read literally.
1169 Optional third arg WILDCARDS non-nil means do wildcard processing
1170 and visit all the matching files. When wildcards are actually
1171 used and expanded, the value is a list of buffers
1172 that are visiting the various files."
1179 'find-directory-functions
1182 filename)))
1185 find-file-wildcards
1198 ;; Find any buffer for a file which has same truename.
1200 ;; Let user know if there is a buffer with the same truename.
1204 find-file-suppress-same-file-warnings
1208 ;; Optionally also find that buffer.
1212 ;; We are using an existing buffer.
1218 ;; Certain files should be reverted automatically
1219 ;; if they have changed on disk and not in the buffer.
1227 found))
1237 "File %s changed on disk. Discard your edits? "
1242 "File %s changed on disk. Discard your edits in %s? "
1250 ;; Check if a formerly read-only file has become
1251 ;; writable and vice versa, but if the buffer agrees
1252 ;; with the new state of the file, that is ok too.
1259 buffer-file-name
1267 ;; It is confusing to ask whether to visit
1268 ;; non-literally if they have the file in
1269 ;; hexl-mode.
1273 "Save file and revisit literally? "
1278 rawfile truename number))
1280 "Discard your edits and revisit file literally? "
1283 rawfile truename number)
1287 "Revisit file literally? "
1290 rawfile truename number)
1293 ;; Return the buffer we are using.
1294 buf)
1295 ;; Create a new buffer.
1298 ;; find-file-noselect-1 may use a different buffer.
1300 rawfile truename number))))))
1304 error)
1307 ;; Needed in case we are re-visiting the file with a different
1308 ;; text representation.
1323 filename)))
1324 ;; Unconditionally set error
1333 filename)))
1334 ;; Run find-file-not-found-hooks until one returns non-nil.
1336 ;; If they fail too, set error.
1338 ;; Record the file's truename, and maybe use that as visited name.
1344 ;; On VMS, we may want to remember which directory in a search list
1345 ;; the file was found in.
1357 ;; Set buffer's default directory to that of the file.
1359 ;; Turn off backup files for certain file names. Since
1360 ;; this is a permanent local, the major mode won't eliminate it.
1373 \f
1375 "Like `insert-file-contents', but only reads in the file literally.
1376 A buffer may be modified in several ways after reading into the buffer,
1377 to Emacs features such as format decoding, character code
1378 conversion, `find-file-hook', automatic uncompression, etc.
1380 This function ensures that none of these modifications will take place."
1388 nil))
1402 filename)))
1412 "Insert contents of file FILENAME into buffer after point with no conversion.
1414 This function is meant for the user to run interactively.
1415 Don't call it from programs! Use `insert-file-contents-literally' instead.
1416 \(Its calling sequence is different; see its documentation)."
1421 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1426 "Visit file FILENAME with no conversion of any kind.
1427 Format conversion and character code conversion are both disabled,
1428 and multibyte characters are disabled in the resulting buffer.
1429 The major mode used is Fundamental mode regardless of the file name,
1430 and local variable specifications in the file are ignored.
1431 Automatic uncompression and adding a newline at the end of the
1432 file due to `require-final-newline' is also disabled.
1434 You cannot absolutely rely on this function to result in
1435 visiting the file literally. If Emacs already has a buffer
1436 which is visiting the file, you get the existing buffer,
1437 regardless of whether it was created literally or not.
1439 In a Lisp program, if you want to be sure of accessing a file's
1440 contents literally, you should create a temporary buffer and then read
1441 the file contents into it using `insert-file-contents-literally'."
1444 \f
1448 after-find-file-from-revert-buffer
1449 nomodes)
1450 "Called after finding a file and by the default revert function.
1451 Sets buffer mode, parses local variables.
1452 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1453 error in reading the file. WARN non-nil means warn if there
1454 exists an auto-save file more recent than the visited file.
1455 NOAUTO means don't mess with auto-save mode.
1456 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1457 means this call was from `revert-buffer'.
1458 Fifth arg NOMODES non-nil means don't alter the file's modes.
1459 Finishes by calling the functions in `find-file-hook'
1460 unless NOMODES is non-nil."
1463 nil
1473 ;; No need to warn if buffer is auto-saved
1474 ;; under the name of the visited file.
1476 auto-save-visited-file-name))
1479 buffer-file-name))
1493 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1494 "Use M-x make-directory RET RET to create the directory"
1501 ;; Make people do a little extra work (C-x C-q)
1502 ;; before altering a backup file.
1505 ;; When a file is marked read-only,
1506 ;; make the buffer read-only even if root is looking at it.
1515 view-read-only
1521 "Choose the major mode for this buffer automatically.
1522 Also sets up any specified local variables of the file.
1523 Uses the visited file name, the -*- line, and the local variables spec.
1525 This function is called automatically from `find-file'. In that case,
1526 we may set up the file-specified mode and local variables,
1527 depending on the value of `enable-local-variables': if it is t, we do;
1528 if it is nil, we don't; otherwise, we query.
1529 In addition, if `local-enable-local-variables' is nil, we do
1530 not set local variables (though we do notice a mode specified with -*-.)
1532 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1533 or from Lisp without specifying the optional argument FIND-FILE;
1534 in that case, this function acts as if `enable-local-variables' were t."
1543 enable-local-variables)))
1587 ;; Less common extensions come here
1588 ;; so more common ones above are found faster.
1598 ;; for MSDOS and MS-Windows (which are case-insensitive)
1646 ;; Mailer puts message to be edited in
1647 ;; /tmp/Re.... or Message
1652 ;; some news reader is reported to use this
1663 ;; .emacs or .gnus or .viper following a directory delimiter in
1664 ;; Unix, MSDOG or VMS syntax.
1667 ;; _emacs following a directory delimiter
1668 ;; in MsDos syntax
1681 ;; Get rid of any trailing .n.m and try again.
1682 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1683 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1684 ;; Using mode nil rather than `ignore' would let the search continue
1685 ;; through this list (with the shortened name) rather than start over.
1687 ;; The following should come after the ChangeLog pattern
1688 ;; for the sake of ChangeLog.1, etc.
1689 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1694 "Alist of filename patterns vs corresponding major mode functions.
1695 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1696 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1697 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1698 mode function to use. FUNCTION will be called, unless it is nil.
1700 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1701 calling FUNCTION (if it's not nil), we delete the suffix that matched
1747 "Alist mapping interpreter names to major modes.
1748 This alist applies to files whose first line starts with `#!'.
1749 Each element looks like (INTERPRETER . MODE).
1750 The car of each element is compared with
1751 the name of the interpreter specified in the first line.
1758 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1759 When checking `inhibit-first-line-modes-regexps', we first discard
1765 "Regular expression matching interpreters, for file mode determination.
1766 This regular expression is matched against the first line of a file
1767 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1768 a mode from the file's name. If it matches, the file is assumed to
1769 be interpreted by the interpreter matched by the second group of the
1770 regular expression. The mode is then determined as the mode associated
1774 "Select major mode appropriate for current buffer.
1775 This checks for a -*- mode tag in the buffer's text,
1776 compares the filename against the entries in `auto-mode-alist',
1777 or checks the interpreter that runs this file against
1778 `interpreter-mode-alist'.
1780 It does not check for the `mode:' local variable in the
1781 Local Variables section of the file; for that, use `hack-local-variables'.
1783 If `enable-local-variables' is nil, this function does not check for a
1784 -*- mode tag.
1786 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1787 then we do not set anything but the major mode,
1788 and we don't even do that unless it would come from the file name."
1789 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1797 ;; Find all specifications for the `mode:' variable
1798 ;; and execute them left to right.
1810 modes)))
1811 ;; Simple -*-MODE-*- case.
1814 modes))))
1815 ;; If we found modes to use, invoke them now,
1816 ;; outside the save-excursion.
1823 ;; If we didn't find a mode from a -*- line, try using the file name.
1827 ;; Remove backup-suffixes from file name.
1833 ;; Find first matching alist entry.
1842 keep-going t)
1844 keep-going nil)))
1847 ;; When JUST-FROM-FILE-NAME is set,
1848 ;; we are working on behalf of set-visited-file-name.
1849 ;; In that case, if the major mode specified is the
1850 ;; same one we already have, don't actually reset it.
1851 ;; We don't want to lose minor modes such as Font Lock.
1854 ;; If we can't deduce a mode from the file name,
1855 ;; look for an interpreter specified in the first line.
1856 ;; As a special case, allow for things like "#!/bin/env perl",
1857 ;; which finds the interpreter anywhere in $PATH.
1864 elt)
1865 ;; Map interpreter name to a mode.
1867 interpreter-mode-alist))
1874 "Find the -*- spec in the buffer.
1875 Call with point at the place to start searching from.
1876 If one is found, set point to the beginning
1877 and return the position of the end.
1878 Otherwise, return nil; point may be changed."
1881 ;; Don't look for -*- if this file name matches any
1882 ;; of the regexps in inhibit-first-line-modes-regexps.
1890 sufs)
1898 ;; If the file begins with "#!"
1899 ;; (exec interpreter magic), look
1900 ;; for mode frobs in the first two
1901 ;; lines. You cannot necessarily
1902 ;; put them in the first line of
1903 ;; such a file without screwing up
1904 ;; the interpreter invocation.
1912 t))
1918 end))))
1921 "Set local variables specified in the -*- line.
1922 Ignore any specification for `mode:' and `coding:';
1923 `set-auto-mode' should already have handled `mode:',
1924 `set-auto-coding' should already have handled `coding:'."
1931 ;; Parse the -*- line into the `result' alist.
1933 nil)
1935 ;; Simple form: "-*- MODENAME -*-". Already handled.
1936 nil)
1938 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1939 ;; (last ";" is optional).
1944 ;; There used to be a downcase here,
1945 ;; but the manual didn't say so,
1946 ;; and people want to set var names that aren't all lc.
1953 ;; It is traditional to ignore
1954 ;; case when checking for `mode' in set-auto-mode,
1955 ;; so we must do that here as well.
1956 ;; That is inconsistent, but we're stuck with it.
1957 ;; The same can be said for `coding' in set-auto-coding.
1971 ;; If we fail to switch in the selected window,
1972 ;; it is probably a minibuffer.
1973 ;; So try another window.
1986 "Normal hook run after processing a file's local variables specs.
1987 Major modes can use this to examine user-specified local variables
1991 "Parse and put into effect this buffer's local variables spec.
1992 If MODE-ONLY is non-nil, all we do is check whether the major mode
1993 is specified, returning t if it is specified."
1996 ;; Look for "Local variables:" line in last page.
2006 mode-only
2016 buffer-file-name)
2020 prefix prefixlen suffix beg
2021 mode-specified
2023 ;; The prefix is what comes before "local variables:" in its line.
2024 ;; The suffix is what comes after "local variables:" in its line.
2039 ;; Look at next local variable spec.
2042 ;; Skip the prefix, if any.
2047 ;; Find the variable name; strip whitespace.
2055 val)
2056 ;; Setting variable named "end" means end of list.
2059 ;; Otherwise read the variable value.
2070 ;; Set the variable. "Variables" mode and eval are funny.
2074 mode-specified))
2080 ;; Get confirmation before setting these variables as locals in a file.
2105 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2135 ;; This case is safe because the user gets to check it before it is used.
2139 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2140 If VAL is nil, the question is whether any value might be dangerous."
2144 (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$"
2147 ;; If the safe-local-variable property isn't t or nil,
2148 ;; then it must return non-nil on the proposed value to be safe.
2155 Add expressions to this list if you want Emacs to evaluate them, when
2156 they appear in an `eval' local variable specification, without first
2157 asking you for confirmation."
2174 "Return t if it is safe to eval EXP when it is found in a file."
2176 ;; Detect certain `put' expressions.
2182 ;; Only allow safe values of lisp-indent-hook;
2183 ;; not functions.
2186 ;; Allow expressions that the user requested.
2188 ;; Certain functions can be allowed with safe arguments
2189 ;; or can specify verification functions to try.
2197 ok))
2205 ok)))))))
2209 A few patterns are specified so that any name which matches one
2210 is considered risky."
2215 ;; We have already handled coding: tag in set-auto-coding.
2216 nil)
2217 ;; "Setting" eval means either eval it or do nothing.
2218 ;; Likewise for setting hook variables.
2220 ;; Permit evalling a put of a harmless property.
2221 ;; if the args do nothing tricky.
2224 ;; Permit eval if not root and user says ok.
2243 ;; Ordinary variable, really set it.
2245 ;; Make sure the string has no text properties.
2246 ;; Some text properties can get evaluated in various ways,
2247 ;; so it is risky to put them on with a local variable list.
2252 \f
2255 However, the mode will not be changed if
2256 \(1) a local variables list or the `-*-' line specifies a major mode, or
2258 \ not suitable for ordinary files, or
2259 \(3) the new file name does not particularly specify any mode."
2264 "Change name of file visited in current buffer to FILENAME.
2265 The next time the buffer is saved it will go in the newly specified file.
2266 nil or empty string as argument means make buffer not be visiting any file.
2267 Remember to delete the initial contents of the minibuffer
2268 if you wish to pass an empty string as the argument.
2270 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2271 confirmation in the case where another buffer is already visiting FILENAME.
2273 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2274 the old visited file has been renamed to the new name FILENAME."
2282 nil
2293 filename)))
2312 ;; Abbreviate the file names of the buffer.
2321 nil)))
2322 ;; write-file-functions is normally used for things like ftp-find-file
2323 ;; that visit things that are not local files as if they were files.
2324 ;; Changing to visit an ordinary local file instead should flush the hook.
2329 ;; If buffer was read-only because of version control,
2330 ;; that reason is gone now, so make it writable.
2334 ;; Turn off backup files for certain file names.
2335 ;; Since this is a permanent local, the major mode won't eliminate it.
2342 ;; If auto-save was not already on, turn it on if appropriate.
2346 ;; If auto save is on, start using a new name.
2347 ;; We deliberately don't rename or delete the old auto save
2348 ;; for the old visited file name. This is because perhaps
2349 ;; the user wants to save the new state and then compare with the
2350 ;; previous state from the auto save file.
2353 ;; Rename the old auto save file if any.
2360 ;; Update the major mode, if the file name determines it.
2362 ;; Don't change the mode if it is special.
2365 ;; Don't change the mode if the local variable list specifies it.
2371 "Write current buffer into file FILENAME.
2372 This makes the buffer visit that file, and marks it as not modified.
2374 If you specify just a directory name as FILENAME, that means to use
2375 the default file name but in that directory. You can also yank
2376 the default file name into the minibuffer to edit it, using M-n.
2378 If the buffer is not already visiting a file, the default file name
2379 for the output file is the buffer name.
2381 If optional second arg CONFIRM is non-nil, this function
2382 asks for confirmation before overwriting an existing file.
2383 Interactively, confirmation is required unless you supply a prefix argument."
2384 ;; (interactive "FWrite file: ")
2388 nil nil nil nil)
2392 default-directory)
2393 nil nil))
2397 ;; If arg is just a directory,
2398 ;; use the default file name, but in that directory.
2409 ;; Make buffer writable if file is writable.
2414 \f
2416 "Make a backup of the disk file visited by the current buffer, if appropriate.
2417 This is normally done before saving the buffer the first time.
2419 A backup may be done by renaming or by copying; see documentation of
2420 variable `make-backup-files'. If it's done by renaming, then the file is
2421 no longer accessible under its old name.
2423 The value is non-nil after a backup was made by renaming.
2424 It has the form (MODES . BACKUPNAME).
2425 MODES is the result of `file-modes' on the original
2426 file; this means that the caller, after saving the buffer, should change
2427 the modes of the new file to agree with the old modes.
2428 BACKUPNAME is the backup file name, which is the old file renamed."
2435 backup-info backupname targets setmodes)
2436 ;; If specified name is a symbolic link, chase it to the target.
2437 ;; Thus we make the backups in the directory where the real file is.
2442 ;; (if (file-directory-p buffer-file-name)
2443 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2447 ;; If have old versions to maybe delete,
2448 ;; ask the user to confirm now, before doing anything.
2449 ;; But don't actually delete til later.
2454 real-file-name)))))
2456 ;; Actually write the back up file.
2459 ; (file-symlink-p buffer-file-name)
2460 backup-by-copying
2461 ;; Don't rename a suid or sgid file.
2475 ;; rename-file should delete old backup.
2479 ;; If trouble writing the backup, write it in ~.
2488 ;; Now delete the old versions, if desired.
2495 setmodes)
2502 ;; If copying fails because file TO-NAME
2503 ;; is not writable, delete that file and try again.
2511 "Return file NAME sans backup versions or strings.
2512 This is a separate procedure so your site-init or startup file can
2513 redefine it.
2514 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2515 we do not remove backup version numbers, only true file version numbers."
2521 ;; VMS version number is (a) semicolon, optional
2522 ;; sign, zero or more digits or (b) period, option
2523 ;; sign, zero or more digits, provided this is the
2524 ;; second period encountered outside of the
2525 ;; device/directory part of the file name.
2528 name)
2538 "Return t if deleting FILE and rewriting it would preserve the owner."
2543 ;; Return t if the file doesn't exist, since it's true that no
2544 ;; information would be lost by an (attempted) delete and create.
2550 The extension, in a file name, is the part that follows the last `.',
2551 except that a leading `.', if any, doesn't count."
2554 directory)
2558 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2559 ;; we don't want to expand it.
2562 filename))))
2566 The extension, in a file name, is the part that follows the last `.',
2567 except that a leading `.', if any, doesn't count.
2568 Return nil for extensionless file names such as `foo'.
2569 Return the empty string for file names such as `foo.'.
2571 If PERIOD is non-nil, then the returned value includes the period
2572 that delimits the extension, and if FILENAME has no extension,
2583 "A function to use instead of the default `make-backup-file-name'.
2584 A value of nil gives the default `make-backup-file-name' behaviour.
2586 This could be buffer-local to do something special for specific
2587 files. If you define it, you may need to change `backup-file-name-p'
2588 and `file-name-sans-versions' too.
2590 See also `backup-directory-alist'."
2596 "Alist of filename patterns and backup directory names.
2597 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2598 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2599 relative or absolute. If it is absolute, so that all matching files
2600 are backed up into the same directory, the file names in this
2601 directory will be the full name of the file backed up with all
2602 directory separators changed to `!' to prevent clashes. This will not
2603 work correctly if your filesystem truncates the resulting name.
2605 For the common case of all backups going into one directory, the alist
2607 directory name.
2609 If this variable is nil, or it fails to match a filename, the backup
2610 is made in the original file's directory.
2612 On MS-DOS filesystems without long names this variable is always
2613 ignored."
2619 "Default `backup-enable-predicate' function.
2620 Checks for files in `temporary-file-directory' or
2621 `small-temporary-file-directory'."
2624 ;; Directory is under temporary-file-directory.
2629 0 nil
2631 ;; Directory is under small-temporary-file-directory.
2636 "Create the non-numeric backup file name for FILE.
2637 Normally this will just be the file's name with `~' appended.
2638 Customization hooks are provided as follows.
2640 If the variable `make-backup-file-name-function' is non-nil, its value
2641 should be a function which will be called with FILE as its argument;
2642 the resulting name is used.
2644 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2645 the documentation of that variable. If the directory for the backup
2646 doesn't exist, it is created."
2660 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2662 elt backup-directory failed)
2667 alist nil)))
2673 file
2677 ;; Normalize DOSish file names: downcase the drive
2678 ;; letter, if any, and replace the leading "x:" with
2679 ;; "/drive_x".
2682 ;; Replace any invalid file-name characters (for the
2683 ;; case of backing up remote files).
2687 "drive_"
2690 ""
2693 ;; Make the name unique by substituting directory
2694 ;; separators. It may not really be worth bothering about
2695 ;; doubling `!'s in the original name...
2700 backup-directory))
2707 "Return non-nil if FILE is a backup file name (numeric or not).
2708 This is a separate function so you can redefine it for customization.
2709 You may need to redefine `file-name-sans-versions' as well."
2714 ;; This is used in various files.
2715 ;; The usage of backup-extract-version-start is not very clean,
2716 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2718 "Given the name of a numeric backup file, FN, return the backup number.
2719 Uses the free variable `backup-extract-version-start', whose value should be
2720 the index in the name where the version number begins."
2726 ;; I believe there is no need to alter this behavior for VMS;
2727 ;; since backup files are not made on VMS, it should not get called.
2729 "Find a file name for a backup file FN, and suggestions for deletions.
2730 Value is a list whose car is the name for the backup file
2731 and whose cdr is a list of old versions to consider deleting now.
2732 If the value is nil, don't make a backup.
2733 Uses `backup-directory-alist' in the same way as does
2734 `make-backup-file-name'."
2736 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2740 ;; We don't support numbered backups on plain MS-DOS
2741 ;; when long file names are unavailable.
2751 possibilities deserve-versions-p versions)
2754 base-versions
2757 possibilities)
2758 #'<)
2763 kept-old-versions
2764 kept-new-versions
2771 ;; Delete nothing if there is overflow
2772 ;; in the number of versions to keep.
2778 v))))))))))
2781 "Return number of names file FILENAME has."
2784 ;; (defun file-relative-name (filename &optional directory)
2785 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2786 ;; This function returns a relative file name which is equivalent to FILENAME
2787 ;; when used with that default directory as the default.
2788 ;; If this is impossible (which can happen on MSDOS and Windows
2789 ;; when the file name and directory use different drive names)
2790 ;; then it returns FILENAME."
2791 ;; (save-match-data
2792 ;; (let ((fname (expand-file-name filename)))
2793 ;; (setq directory (file-name-as-directory
2794 ;; (expand-file-name (or directory default-directory))))
2795 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2796 ;; ;; drive names, they can't be relative, so return the absolute name.
2797 ;; (if (and (or (eq system-type 'ms-dos)
2798 ;; (eq system-type 'cygwin)
2799 ;; (eq system-type 'windows-nt))
2800 ;; (not (string-equal (substring fname 0 2)
2801 ;; (substring directory 0 2))))
2802 ;; filename
2803 ;; (let ((ancestor ".")
2804 ;; (fname-dir (file-name-as-directory fname)))
2805 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2806 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
2807 ;; (setq directory (file-name-directory (substring directory 0 -1))
2808 ;; ancestor (if (equal ancestor ".")
2809 ;; ".."
2810 ;; (concat "../" ancestor))))
2811 ;; ;; Now ancestor is empty, or .., or ../.., etc.
2812 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
2813 ;; ;; We matched within FNAME's directory part.
2814 ;; ;; Add the rest of FNAME onto ANCESTOR.
2815 ;; (let ((rest (substring fname (match-end 0))))
2816 ;; (if (and (equal ancestor ".")
2817 ;; (not (equal rest "")))
2818 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
2819 ;; rest
2820 ;; (concat (file-name-as-directory ancestor) rest)))
2821 ;; ;; We matched FNAME's directory equivalent.
2822 ;; ancestor))))))
2825 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2826 This function returns a relative file name which is equivalent to FILENAME
2827 when used with that default directory as the default.
2828 If FILENAME and DIRECTORY lie on different machines or on different drives
2829 on a DOS/Windows machine, it returns FILENAME on expanded form."
2833 default-directory))))
2841 ;; Test for different drives on DOS/Windows
2846 ;; Test for different remote file handlers
2848 ;; Test for different remote file system identification
2850 hf
2860 filename
2870 filename-dir))
2872 filename)))
2875 ".."
2877 ;; Now ancestor is empty, or .., or ../.., etc.
2879 ;; We matched within FILENAME's directory part.
2880 ;; Add the rest of FILENAME onto ANCESTOR.
2883 ;; But don't bother with ANCESTOR if it would give us `./'.
2884 rest
2886 ;; We matched FILENAME's directory equivalent.
2887 ancestor))))))
2888 \f
2890 "Save current buffer in visited file if modified. Versions described below.
2891 By default, makes the previous version into a backup file
2892 if previously requested or if this is the first save.
2894 to become a backup when the next save is done.
2896 unconditionally makes the previous version into a backup file.
2898 to become a backup when the next save is done,
2899 and unconditionally makes the previous version into a backup file.
2901 With argument of 0, never make the previous version into a backup file.
2903 If a file's name is FOO, the names of its numbered backup versions are
2904 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2905 Numeric backups (rather than FOO~) will be made if value of
2906 `version-control' is not the atom `never' and either there are already
2907 numeric versions of the file being backed up, or `version-control' is
2908 non-nil.
2909 We don't want excessive versions piling up, so there are variables
2910 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2911 and `kept-new-versions', which tells how many newest versions to keep.
2912 Defaults are 2 old versions and 2 new.
2913 `dired-kept-versions' controls dired's clean-directory (.) command.
2914 If `delete-old-versions' is nil, system will query user
2915 before trimming versions. Otherwise it does it silently.
2917 If `vc-make-backup-files' is nil, which is the default,
2918 no backup files are made for files managed by version control.
2919 (This is because the version control system itself records previous versions.)
2921 See the subroutine `basic-save-buffer' for more information."
2934 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2935 Normally delete only if the file was written by this Emacs since
2936 the last real save, but optional arg FORCE non-nil means delete anyway."
2950 "Normal hook that is run after a buffer is saved to its file."
2956 "If non-nil, use this coding system for saving the buffer.
2957 More precisely, use this coding system in place of the
2958 value of `buffer-file-coding-system', when saving the buffer.
2959 Calling `write-region' for any purpose other than saving the buffer
2960 will still use `buffer-file-coding-system'; this variable has no effect
2967 "Save the current buffer in its visited file, if it has been modified.
2968 The hooks `write-contents-functions' and `write-file-functions' get a chance
2969 to do the job of saving; if they do not, then the buffer is saved in
2970 the visited file file in the usual way.
2971 After saving the buffer, this function runs `after-save-hook'."
2974 ;; In an indirect buffer, save its base buffer instead.
2979 setmodes tempsetmodes)
2980 ;; On VMS, rename file and buffer to get rid of version number.
2985 ;; Strip VMS version number before save.
2988 ;; Construct a (unique) buffer name to correspond.
2993 ;; If buffer has no file name, ask user for one.
3000 filename))
3025 ;; Support VC version backups.
3030 ;; If a hook returned t, file is already "written".
3031 ;; Otherwise, write it the usual way now.
3033 ;; Now we have saved the current buffer. Let's make sure
3034 ;; that buffer-file-coding-system is fixed to what
3035 ;; actually used for saving by binding it locally.
3045 ;; If the auto-save file was recent before this command,
3046 ;; delete it now.
3048 ;; Support VC `implicit' locking.
3053 ;; This does the "real job" of writing a buffer into its visited file
3054 ;; and making a backup file. This is what is normally done
3055 ;; but inhibited if one of write-file-functions returns non-nil.
3056 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3063 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3077 buffer-file-name)))
3085 ;; If file is precious, write temp name, then rename it.
3086 ;; This requires write access to the containing dir,
3087 ;; which is why we don't try it if we don't have that access.
3089 tempname temp nogood i succeed
3093 ;; Find the temporary name to write under.
3100 "%s$tmp$%d"
3102 dir i))
3108 tempname nil realname
3109 buffer-file-truename)
3111 ;; If writing the temp file fails,
3112 ;; delete the temp file.
3119 ;; Since we have created an entirely new file
3120 ;; and renamed it, make sure it gets the
3121 ;; right permission bits set.
3123 buffer-file-name)))
3124 ;; We succeeded in writing the temp file,
3125 ;; so rename it.
3127 ;; If file not writable, see if we can make it writable
3128 ;; temporarily while we write it.
3129 ;; But no need to do so if we have just backed it up
3130 ;; (setmodes is set) because that says we're superseding.
3132 ;; Change the mode back, after writing.
3139 buffer-file-name nil t buffer-file-truename)
3141 ;; If we get an error writing the new file, and we made
3142 ;; the backup by renaming, undo the backing-up.
3145 setmodes))
3148 "View the differences between BUFFER and its associated file.
3149 This requires the external program `diff' to be in your `exec-path'."
3164 ;; Display that message for 1 second so that user can read it
3165 ;; in the minibuffer.
3167 ;; return always nil, so that save-buffers-kill-emacs will not move
3168 ;; over to the next unsaved buffer when calling `d'.
3169 nil)
3172 '((?\C-r
3178 ;; Return nil to ask about BUF again.
3179 nil)
3181 (?d diff-buffer-with-file
3187 "Save some modified file-visiting buffers. Asks user about each one.
3188 You can answer `y' to save, `n' not to save, `C-r' to look at the
3189 buffer in question with `view-buffer' before deciding or `d' to
3190 view the differences using `diff-buffer-to-file'.
3192 Optional argument (the prefix) non-nil means save all with no questions.
3193 Optional second argument PRED determines which buffers are considered:
3194 If PRED is nil, all the file-visiting buffers are considered.
3195 If PRED is t, then certain non-file buffers will also be considered.
3196 If PRED is a zero-argument function, it indicates for each buffer whether
3197 to consider it or not when called with that buffer current.
3199 See `save-some-buffers-action-alist' if you want to
3200 change the additional actions you can take on files."
3219 t
3232 save-some-buffers-action-alist))
3239 abbrev-file-name)))
3241 ;; Don't keep bothering user if he says no.
3243 t))))
3246 \f
3248 "Mark current buffer as unmodified, not needing to be saved.
3251 It is not a good idea to use this function in Lisp programs, because it
3252 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3259 "Change whether this buffer is visiting its file read-only.
3260 With arg, set read-only iff arg is positive.
3261 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3266 nil ; do nothing.
3267 ;; Toggle.
3284 "Insert contents of file FILENAME into buffer after point.
3285 Set mark after the inserted text.
3287 This function is meant for the user to run interactively.
3288 Don't call it from programs! Use `insert-file-contents' instead.
3289 \(Its calling sequence is different; see its documentation)."
3294 "Append the contents of the region to the end of file FILENAME.
3295 When called from a function, expects three arguments,
3296 START, END and FILENAME. START and END are buffer positions
3297 saying what text to write."
3302 "Return most recent backup file for FILENAME or nil if no backups exist."
3303 ;; `make-backup-file-name' will get us the right directory for
3304 ;; ordinary or numeric backups. It might create a directory for
3305 ;; backups as a side-effect, according to `backup-directory-alist'.
3312 tem)
3321 newest))
3324 "Rename current buffer to a similar name not already taken.
3325 This function is useful for creating multiple shell process buffers
3326 or multiple mail buffers, etc."
3334 ;; If the existing buffer name has a <NNN>,
3335 ;; which isn't part of the file name (if any),
3336 ;; then get rid of that.
3342 "Create the directory DIR and any nonexistent parent dirs.
3343 Interactively, the default choice of directory to create
3344 is the current default directory for file names.
3345 That is useful when you have visited a file in a nonexistent directory.
3347 Noninteractively, the second (optional) argument PARENTS says whether
3348 to create parent directories if they don't exist."
3351 nil nil)
3352 t))
3353 ;; If default-directory is a remote directory,
3354 ;; make sure we find its make-directory handler.
3362 create-list)
3369 \f
3372 "Function to use to revert this buffer, or nil to do the default.
3373 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3378 "Function to use to insert contents when reverting this buffer.
3379 Gets two args, first the nominal file name to use,
3380 and second, t if reading the auto-save file.
3385 "Normal hook for `revert-buffer' to run before reverting.
3386 If `revert-buffer-function' is used to override the normal revert
3390 "Normal hook for `revert-buffer' to run after reverting.
3391 Note that the hook value that it runs is the value that was in effect
3392 before reverting; that makes a difference if you have buffer-local
3393 hook functions.
3395 If `revert-buffer-function' is used to override the normal revert
3401 "Replace current buffer text with the text of the visited file on disk.
3402 This undoes all changes since the file was visited or saved.
3403 With a prefix argument, offer to revert from latest auto-save file, if
3404 that is more recent than the visited file.
3406 This command also works for special buffers that contain text which
3407 doesn't come from a file, but reflects some other data base instead:
3408 for example, Dired buffers and buffer-list buffers. In these cases,
3409 it reconstructs the buffer contents from the appropriate data base.
3411 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3412 to revert from the auto-save file when this is nil. Note that the
3413 sense of this argument is the reverse of the prefix argument, for the
3414 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3415 to nil.
3417 Optional second argument NOCONFIRM means don't ask for confirmation at
3418 all. (The local variable `revert-without-query', if non-nil, prevents
3419 confirmation.)
3421 Optional third argument PRESERVE-MODES non-nil means don't alter
3422 the files modes. Normally we reinitialize them using `normal-mode'.
3424 If the value of `revert-buffer-function' is non-nil, it is called to
3425 do all the work for this command. Otherwise, the hooks
3426 `before-revert-hook' and `after-revert-hook' are run at the beginning
3427 and the end, and if `revert-buffer-insert-file-contents-function' is
3428 non-nil, it is called instead of rereading visited file contents."
3430 ;; I admit it's odd to reverse the sense of the prefix argument, but
3431 ;; there is a lot of code out there which assumes that the first
3432 ;; argument should be t to avoid consulting the auto-save file, and
3433 ;; there's no straightforward way to encourage authors to notice a
3434 ;; reversal of the argument sense. So I'm just changing the user
3435 ;; interface, but leaving the programmatic interface the same.
3441 buffer-auto-save-file-name
3446 buffer-auto-save-file-name
3447 buffer-file-name)))
3458 found))
3460 file-name)))
3462 ;; If file was backed up but has changed since,
3463 ;; we shd make another backup.
3467 ;; Get rid of all undo records for this buffer.
3470 ;; Effectively copy the after-revert-hook status,
3471 ;; since after-find-file will clobber it.
3475 after-revert-hook)))
3477 ;; Don't make undo records for the reversion.
3481 file-name auto-save-p)
3484 "File %s no longer exists!"
3486 file-name))
3487 ;; Bind buffer-file-name to nil
3488 ;; so that we don't try to lock the file.
3494 ;; Auto-saved file shoule be read without
3495 ;; any code conversion.
3498 buffer-file-coding-system))))
3499 ;; This force
3500 ;; after-insert-file-set-buffer-file-coding-system
3501 ;; (called from insert-file-contents) to set
3502 ;; buffer-file-coding-system to a proper value.
3505 ;; Note that this preserves point in an intelligent way.
3509 nil nil t))
3511 nil nil t)))))
3512 ;; Recompute the truename in case changes in symlinks
3513 ;; have changed the truename.
3517 ;; Run after-revert-hook as it was before we reverted.
3525 t)))))
3528 "Recover the visited file--get contents from its last auto-save file."
3533 "Visit file FILE, but get contents from its last auto-save file."
3534 ;; Actually putting the file name in the minibuffer should be used
3535 ;; only rarely.
3536 ;; Not just because users often use the default.
3555 ;; Use insert-directory-safely, not insert-directory,
3556 ;; because these files might not exist. In particular,
3557 ;; FILE might not exist if the auto-save file was for
3558 ;; a buffer that didn't visit a file, such as "*mail*".
3559 ;; The code in v20.x called `ls' directly, so we need
3560 ;; to emulate what `ls' did in that case.
3566 ;; Keep the current buffer-file-coding-system.
3568 ;; Auto-saved file shoule be read without any code conversion.
3577 "Recover auto save files from a previous Emacs session.
3578 This command first displays a Dired buffer showing you the
3579 previous sessions that you could recover from.
3580 To choose one, move point to the proper line and then type C-c C-c.
3581 Then you'll be asked about a number of files to recover."
3591 auto-save-list-file-prefix)))
3592 t)
3601 ;; Each line starts with a space
3602 ;; so that Font Lock mode won't highlight the first character.
3611 "Choose one saved session to recover auto-save files from.
3612 This command is used in the special Dired buffer created by
3615 ;; Get the name of the session file to recover from.
3617 files
3623 ;; Read in the auto-save-list file.
3627 ;; Loop thru the text of that file
3628 ;; and get out the names of the files to recover.
3632 ;; This is a pair of lines for a non-file-visiting buffer.
3633 ;; Get the auto-save file name and manufacture
3634 ;; a "visited file name" from that.
3650 ;; This pair of lines is a file-visiting
3651 ;; buffer. Use the visited file name.
3661 ;; Ignore a file if its auto-save file does not exist now.
3665 ;; The file contains a pair of line for each auto-saved buffer.
3666 ;; The first line of the pair contains the visited file name
3667 ;; or is empty if the buffer was not visiting a file.
3668 ;; The second line is the auto-save file name.
3676 files
3682 "For each buffer in LIST, ask whether to kill it.
3683 LIST defaults to all existing live buffers."
3694 name
3699 \f
3701 "Toggle auto-saving of contents of current buffer.
3702 With prefix argument ARG, turn auto-saving on if positive, else off."
3707 ;; If auto-save is off because buffer has shrunk,
3708 ;; then toggling should turn it on.
3713 buffer-file-name
3715 ;; If -1 was stored here, to temporarily turn off saving,
3716 ;; turn it back on.
3722 buffer-auto-save-file-name)
3725 "Adjust current buffer's auto save file name for current conditions.
3726 Also rename any existing auto save file, if it was made in this session."
3738 "Return file name to use for auto-saves of current buffer.
3739 Does not consider `auto-save-visited-file-name' as that variable is checked
3740 before calling this function. You can redefine this for customization.
3741 See also `auto-save-file-name-p'."
3745 result uniq)
3746 ;; Apply user-specified translations
3747 ;; to the file name.
3751 filename)
3761 filename))))
3766 ;; We truncate the file name to DOS 8+3 limits
3767 ;; before doing anything else, because the regexp
3768 ;; passed to string-match below cannot handle
3769 ;; extensions longer than 3 characters, multiple
3770 ;; dots, and other atrocities.
3775 fn)
3780 "#"
3783 ;; Make sure auto-save file names don't contain characters
3784 ;; invalid for the underlying filesystem.
3786 ;; Don't modify remote (ange-ftp) filenames
3789 result))
3791 ;; Deal with buffers that don't have any associated files. (Mail
3792 ;; mode tends to create a good number of these.)
3796 file-name)
3797 ;; Eliminate all slashes and backslashes by
3798 ;; replacing them with sequences that start with %.
3799 ;; Quote % also, to keep distinct names distinct.
3808 ;; Generate the file name.
3814 ;; Try a few alternative directories, to get one we can
3815 ;; write it.
3821 ;; Don't modify remote (ange-ftp) filenames
3823 ;; The call to convert-standard-filename is in case
3824 ;; buffer-name includes characters not allowed by the
3825 ;; DOS/Windows filesystems. make-temp-file writes to the
3826 ;; file it creates, so we must fix the file name _before_
3827 ;; make-temp-file is called.
3829 fname))
3831 ;; make-temp-file creates the file,
3832 ;; but we don't want it to exist until we do an auto-save.
3836 file-name)))
3839 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3840 FILENAME should lack slashes. You can redefine this for customization."
3842 \f
3844 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3845 The generated regexp will match a filename iff the filename
3846 matches that wildcard according to shell rules. Only wildcards known
3847 by `sh' are supported."
3849 ;; Copy the initial run of non-special characters.
3852 ;; If no special characters, we're almost done.
3856 j)
3858 result
3879 ;; Found "[^". Insert a `\0' character
3880 ;; (which cannot happen in a filename)
3881 ;; into the character class, so that `^'
3882 ;; is not the first character after `[',
3883 ;; and thus non-special in a regexp.
3888 ;; I don't think `]' can appear in a
3889 ;; character class in a wildcard, but
3890 ;; let's be general here.
3897 i
3910 ;; Shell wildcards should match the entire filename,
3911 ;; not its part. Make the regexp say so.
3913 \f
3916 "*Switches for `list-directory' to pass to `ls' for brief listing."
3922 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3924 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3929 "Expand wildcard pattern PATTERN.
3930 This returns a list of file names which match the pattern.
3932 If PATTERN is written as an absolute relative file name,
3933 the values are absolute also.
3935 If PATTERN is written as a relative file name, it is interpreted
3936 relative to the current default directory, `default-directory'.
3937 The file names returned are normally also relative to the current
3938 default directory. However, if FULL is non-nil, they are absolute."
3942 ;; A list of all dirs that DIRPART specifies.
3943 ;; This can be more than one dir
3944 ;; if DIRPART contains wildcards.
3949 contents)
3954 ;; Filter out "." and ".."
3959 name))
3966 this-dir-contents)
3967 this-dir-contents)
3968 contents))))
3970 contents)))
3973 "Display a list of files in or matching DIRNAME, a la `ls'.
3974 DIRNAME is globbed by the shell if necessary.
3975 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3976 Actions controlled by variables `list-directory-brief-switches'
3977 and `list-directory-verbose-switches'."
3981 nil default-directory nil)
3982 pfx)))
3984 list-directory-brief-switches))
3985 buffer)
3998 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4006 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4008 PATTERN is assumed to represent a file-name wildcard suitable for the
4009 underlying filesystem. For Unix and GNU/Linux, the characters from the
4011 the parts of the pattern which don't include wildcard characters are
4012 quoted with double quotes.
4013 Existing quote characters in PATTERN are left alone, so you can pass
4014 PATTERN that already quotes some of the special characters."
4018 ;; DOS/Windows don't allow `"' in file names. So if the
4019 ;; argument has quotes, we can safely assume it is already
4020 ;; quoted by the caller.
4022 ;; We quote [&()#$'] in case their shell is a port of a
4023 ;; Unixy shell. We quote [,=+] because stock DOS and
4024 ;; Windows shells require that in some cases, such as
4025 ;; passing arguments to batch files that use positional
4026 ;; arguments like %1.
4028 pattern
4031 end)
4048 pattern))))
4055 "*Program to get the amount of free space on a file system.
4056 We assume the output has the format of `df'.
4057 The value of this variable must be just a command name or file name;
4058 if you want to specify options, use `directory-free-space-args'.
4060 A value of nil disables this feature.
4062 If the function `file-system-info' is defined, it is always used in
4063 preference to the program given by this variable."
4069 "*Options to use when running `directory-free-space-program'."
4074 "Return the mount of free space on directory DIR's file system.
4075 The result is a string that gives the number of free 1KB blocks,
4076 or nil if the system call or the program which retrieve the infornmation
4077 fail.
4079 This function calls `file-system-info' if it is available, or invokes the
4080 program specified by `directory-free-space-program' if that is non-nil."
4081 ;; Try to find the number of free blocks. Non-Posix systems don't
4082 ;; always have df, but might have an equivalent system call.
4091 nil t nil
4092 directory-free-space-args
4093 dir)))
4094 ;; Usual format is a header line followed by a line of
4095 ;; numbers.
4100 ;; Move to the end of the "available blocks" number.
4103 ;; Copy it into AVAILABLE.
4109 ;; insert-directory
4110 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4111 ;; FULL-DIRECTORY-P is nil.
4112 ;; The single line of output must display FILE's name as it was
4113 ;; given, namely, an absolute path name.
4114 ;; - must insert exactly one line for each file if WILDCARD or
4115 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4116 ;; before the file lines, plus optional text after the file lines.
4117 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4118 ;; allowed.
4119 ;; File lines should display the basename.
4120 ;; - must be consistent with
4121 ;; - functions dired-move-to-filename, (these two define what a file line is)
4122 ;; dired-move-to-end-of-filename,
4123 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4124 ;; dired-insert-headerline
4125 ;; dired-after-subdir-garbage (defines what a "total" line is)
4126 ;; - variable dired-subdir-regexp
4127 ;; - may be passed "--dired" as the first argument in SWITCHES.
4128 ;; Filename handlers might have to remove this switch if their
4129 ;; "ls" command does not support it.
4131 "Insert directory listing for FILE, formatted according to SWITCHES.
4132 Leaves point after the inserted text.
4133 SWITCHES may be a string of options, or a list of strings.
4134 Optional third arg WILDCARD means treat FILE as shell wildcard.
4135 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4136 switches do not contain `d', so that a full listing is expected.
4138 This works by running a directory listing program
4139 whose name is in the variable `insert-directory-program'.
4140 If WILDCARD, it also runs the shell specified by `shell-file-name'."
4141 ;; We need the directory in order to find the right handler.
4146 wildcard full-directory-p)
4151 ;; Read the actual directory using `insert-directory-program'.
4152 ;; RESULT gets the status code.
4154 ;; putting text property `dired-filename, decode one
4155 ;; bunch by one to preserve that property.
4157 ;; This is to control encoding the arguments in call-process.
4161 default-file-name-coding-system))))
4164 ;; Run ls in the directory part of the file pattern
4165 ;; using the last component as argument.
4172 shell-file-name nil t nil
4173 "-c"
4175 ""
4177 insert-directory-program
4178 " -d "
4180 switches
4182 " -- "
4183 ;; Quote some characters that have
4184 ;; special meanings in shells; but
4185 ;; don't quote the wildcards--we want
4186 ;; them to be special. We also
4187 ;; currently don't quote the quoting
4188 ;; characters in case people want to
4189 ;; use them explicitly to quote
4190 ;; wildcard characters.
4192 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4193 ;; directory if FILE is a symbolic link.
4195 insert-directory-program nil t nil
4199 ;; Split the switches at any spaces so we can
4200 ;; pass separate options as separate args.
4202 ;; Avoid lossage if FILE starts with `-'.
4210 file))))))))
4212 ;; If `insert-directory-program' failed, signal an error.
4214 ;; On non-Posix systems, we cannot open a directory, so
4215 ;; don't even try, because that will always result in
4216 ;; the ubiquitous "Access denied". Instead, show the
4217 ;; command line so the user can try to guess what went wrong.
4222 insert-directory-program
4224 file result)
4225 ;; Unix. Access the file to get a suitable error.
4242 ;; It seems that we can't trust ls's output as to
4243 ;; byte positions of filenames.
4250 ;; Now decode what read if necessary.
4252 file-name-coding-system
4253 default-file-name-coding-system
4255 val pos)
4259 ;; If no coding system is specified or detection is
4260 ;; requested, detect the coding.
4278 ;; Try to insert the amount of free space.
4281 ;; First find the line to put it on.
4285 ;; Replace "total" with "used", to avoid confusion.
4292 "Insert directory listing for FILE, formatted according to SWITCHES.
4294 Like `insert-directory', but if FILE does not exist, it inserts a
4295 message to that effect instead of signaling an error."
4298 ;; Simulate the message printed by `ls'.
4302 "Functions to call with no arguments to query about killing Emacs.
4303 If any of these functions returns nil, killing Emacs is cancelled.
4305 but `kill-emacs', the low level primitive, does not.
4309 "How to ask for confirmation when leaving Emacs.
4310 If nil, the default, don't ask at all. If the value is non-nil, it should
4311 be a predicate function such as `yes-or-no-p'."
4319 "Offer to save each buffer, then kill this Emacs process.
4320 With prefix arg, silently save all file-visiting buffers, then kill."
4329 ;; process-list is not defined on VMS.
4331 active)
4340 ;; Query the user for other things, perhaps.
4345 \f
4346 ;; We use /: as a prefix to "quote" a file name
4347 ;; so that magic file name handlers will not apply to it.
4351 file-name-handler-alist))
4353 ;; We depend on being the last handler on the list,
4354 ;; so that anything else which does need handling
4355 ;; has been handled already.
4356 ;; So it is safe for us to inhibit *all* magic file name handlers.
4365 default-directory))
4366 ;; Get a list of the indices of the args which are file names.
4369 ;; The first five are special because they
4370 ;; return a file name. We want to include the /:
4371 ;; in the return value.
4372 ;; So just avoid stripping it in the first place.
4378 ;; `identity' means just return the first arg
4379 ;; as stripped of its quoting.
4387 ;; For all other operations, treat the first argument only
4388 ;; as the file name.
4390 ;; Copy ARGUMENTS so we can replace elements in it.
4392 ;; Strip off the /: from the file names that have this handler.
4400 "/"
4406 \f
4430 ;;; files.el ends here