| blob | b01472171a93c782423dbbefc635289ed042d5d0 |
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.
353 ;;;It is not useful to make this a local variable.
354 ;;;(put 'find-file-hooks 'permanent-local t)
356 "List of functions to be called after a buffer is loaded from a file.
357 The buffer's local variables (if any) will have been processed before the
361 "List of functions to be called before writing out a buffer to a file.
362 If one of them returns non-nil, the file is considered already written
363 and the rest are not called.
364 These hooks are considered to pertain to the visited file.
365 So any buffer-local binding of `write-file-hooks' is
368 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
370 ;;; However, in case someone does make it local...
374 "Just like `write-file-hooks', except intended for per-buffer use.
375 The functions in this list are called before the ones in
376 `write-file-hooks'.
378 This variable is meant to be used for hooks that have to do with a
379 particular visited file. Therefore, it is a permanent local, so that
380 changing the major mode does not clear it. However, calling
386 "List of functions to be called before writing out a buffer to a file.
387 If one of them returns non-nil, the file is considered already written
388 and the rest are not called.
390 This variable is meant to be used for hooks that pertain to the
391 buffer's contents, not to the particular visited file; thus,
392 `set-visited-file-name' does not clear this variable; but changing the
393 major mode does clear it.
395 This variable automatically becomes buffer-local whenever it is set.
396 If you use `add-hook' to add elements to the list, use nil for the
397 LOCAL argument.
403 "*Control use of local variables in files you visit.
404 The value can be t, nil or something else.
405 A value of t means file local variables specifications are obeyed;
406 nil means they are ignored; anything else means query.
407 This variable also controls use of major modes specified in
408 a -*- line.
411 always obeys file local variable specifications and the -*- line,
412 and ignores this variable."
419 "Like `enable-local-variables' but meant for buffer-local bindings.
420 The meaningful values are nil and non-nil. The default is non-nil.
421 If a major mode sets this to nil, buffer-locally, then any local
422 variables list in the file will be ignored.
424 This variable does not affect the use of major modes
429 The value can be t, nil or something else.
430 A value of t means obey `eval' variables;
431 nil means ignore them; anything else means query.
434 and ignores this variable."
440 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
452 "Provides support for ange-ftp host name completion.
453 Runs the usual ange-ftp hook, but only for completion operations."
454 ;; Having this here avoids the need to load ange-ftp when it's not
455 ;; really in use.
461 inhibit-file-name-handlers)))
466 "Convert a standard file's name to something suitable for the current OS.
467 This function's standard definition is trivial; it just returns the argument.
468 However, on some systems, the function is redefined with a definition
469 that really does change some file names to canonicalize certain
470 patterns and to guarantee valid names."
471 filename)
472 \f
474 "Show the current default directory."
479 "Value of the CDPATH environment variable, as a list.
483 "Explode a colon-separated search path into a list of directory names.
484 \(For values of `colon' equal to `path-separator'.)"
485 ;; We could use split-string here.
493 nil
498 cd-list)))
501 "Change current directory to given absolute file name DIR."
502 ;; Put the name into directory syntax now,
503 ;; because otherwise expand-file-name may give some bad results.
516 "Make DIR become the current buffer's default directory.
517 If your environment includes a `CDPATH' variable, try each one of that
518 colon-separated list of directories when resolving a relative directory name."
521 default-directory default-directory
537 cd-path)
538 nil))
542 "Load the Lisp file named FILE."
543 ;; This is a case where .elc makes a lot of sense.
550 "Search for FILENAME through PATH.
551 If SUFFIXES is non-nil, it should be a list of suffixes to append to
553 If non-nil, PREDICATE is used instead of `file-readable-p'.
554 PREDICATE can also be an integer to pass to the `access' system call,
555 in which case file-name handlers are ignored. This usage is deprecated.
557 For compatibility, PREDICATE can also be one of the symbols
558 `executable', `readable', `writable', or `exists', or a list of
559 one or more of those symbols."
570 "Do completion for file names passed to `locate-file'.
571 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
591 "Load the library named LIBRARY.
592 This is an interface to the function `load'."
595 'locate-file-completion
600 "Copy the file FILE into a temporary file on this machine.
601 Returns the name of the local copy, or nil, if FILE is directly
602 accessible."
603 ;; This formerly had an optional BUFFER argument that wasn't used by
604 ;; anything.
608 nil)))
611 "Return the truename of FILENAME, which should be absolute.
612 The truename of a file name is found by chasing symbolic links
613 both at the level of the file and at the level of the directories
614 containing it, until no links are left at any level.
616 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
617 Do not specify them in other calls."
618 ;; COUNTER can be a cons cell whose car is the count of how many more links
619 ;; to chase before getting an error.
620 ;; PREV-DIRS can be a cons cell whose car is an alist
621 ;; of truenames we've just recently computed.
623 ;; The last test looks dubious, maybe `+' is meant here? --simon.
633 ;; For speed, remove the ange-ftp completion handler from the list.
634 ;; We know it's not needed here.
635 ;; For even more speed, do this only on the outermost call.
642 ;; andrewi@harlequin.co.uk - none of the following code (except for
643 ;; invoking the file-name handler) currently applies on Windows
644 ;; (ie. there are no native symlinks), but there is an issue with
645 ;; case differences being ignored by the OS, and short "8.3 DOS"
646 ;; name aliases existing for all files. (The short names are not
647 ;; reported by directory-files, but can be used to refer to files.)
648 ;; It seems appropriate for file-truename to resolve these issues in
649 ;; the most natural way, which on Windows is to call the function
650 ;; `w32-long-file-name' - this returns the exact name of a file as
651 ;; it is stored on disk (expanding short name aliases with the full
652 ;; name in the process).
655 newname)
656 ;; For file name that has a special handler, call handler.
657 ;; This is so that ange-ftp can save time by doing a no-op.
660 ;; If filename contains a wildcard, newname will be the old name.
663 ;; If filename doesn't exist, newname will be nil.
668 ;; If this file directly leads to a link, process that iteratively
669 ;; so that we don't use lots of stack.
675 ;; For file name that has a special handler, call handler.
676 ;; This is so that ange-ftp can save time by doing a no-op.
679 done t)
681 target dirfile)
682 ;; Get the truename of the directory.
684 ;; If these are equal, we have the (or a) root directory.
686 ;; If this is the same dir we last got the truename for,
687 ;; save time--don't recalculate.
697 done t)
700 done t)
701 ;; Put it back on the file name.
703 ;; Is the file name the name of a link?
706 ;; Yes => chase that link, then start all over
707 ;; since the link may point to a directory name that uses links.
708 ;; We can't safely use expand-file-name here
709 ;; since target might look like foo/../bar where foo
710 ;; is itself a link. Instead, we handle . and .. above.
713 target
715 done nil)
716 ;; No, we are done!
718 filename))
721 "Chase links in FILENAME until a name that is not a link.
722 Does not examine containing directories for links,
723 unlike `file-truename'."
729 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
732 ;; Handle `..' by hand, since it needs to work in the
733 ;; target of any directory symlink.
734 ;; This code is not quite complete; it does not handle
735 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
739 ;; Chase links in the default dir of the symlink.
743 ;; Now find the parent of that dir.
747 newname))
748 \f
750 "Select buffer BUFFER in another window.
751 Optional second arg NORECORD non-nil means
752 do not put this buffer at the front of the list of recently selected ones.
754 This uses the function `display-buffer' as a subroutine; see its
755 documentation for additional customization information."
761 "Switch to buffer BUFFER in another frame.
762 Optional second arg NORECORD non-nil means
763 do not put this buffer at the front of the list of recently selected ones.
765 This uses the function `display-buffer' as a subroutine; see its
766 documentation for additional customization information."
779 ;; Clear out this hook so it does not interfere
780 ;; with any recursive minibuffer usage.
783 minibuffer-setup-hook))
786 current-prefix-arg))
789 "Edit file FILENAME.
790 Switch to a buffer visiting file FILENAME,
791 creating one if none already exists.
792 Interactively, the default if you just type RET is the current directory,
793 but the visited file name is available through the minibuffer history:
794 type M-n to pull it into the minibuffer.
796 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
797 expand wildcards (if any) and visit multiple files. Wildcard expansion
798 can be suppressed by setting `find-file-wildcards'."
807 "Edit file FILENAME, in another window.
808 May create a new window, or reuse an existing one.
809 See the function `display-buffer'.
811 Interactively, the default if you just type RET is the current directory,
812 but the visited file name is available through the minibuffer history:
813 type M-n to pull it into the minibuffer.
815 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
816 expand wildcards (if any) and visit multiple files."
827 "Edit file FILENAME, in another frame.
828 May create a new frame, or reuse an existing one.
829 See the function `display-buffer'.
831 Interactively, the default if you just type RET is the current directory,
832 but the visited file name is available through the minibuffer history:
833 type M-n to pull it into the minibuffer.
835 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
836 expand wildcards (if any) and visit multiple files."
847 "Edit file FILENAME but don't allow changes.
856 "Edit file FILENAME in another window but don't allow changes.
865 "Edit file FILENAME in another frame but don't allow changes.
874 "Find file FILENAME as a replacement for the file in the next window.
875 This command does not select that window."
894 "Find file FILENAME, select its buffer, kill previous buffer.
895 If the current buffer now contains an empty file that you just visited
896 \(presumably by mistake), use this command to visit the file you really want."
907 ;; (not buffer-read-only)
934 \f
936 "Create a suitably named buffer for visiting FILENAME, and return it.
937 FILENAME (sans directory) is used unchanged if that name is free;
938 otherwise a string <2> or <3> or ... is appended to get an unused name."
945 "Create and return a buffer with a name based on NAME.
946 Choose the buffer's name using `generate-new-buffer-name'."
950 "Regexp to match the automounter prefix in a directory name."
958 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
961 ;; Get rid of the prefixes added by the automounter.
968 ;; If any elt of directory-abbrev-alist matches this name,
969 ;; abbreviate accordingly.
975 ;; Compute and save the abbreviated homedir name.
976 ;; We defer computing this until the first time it's needed, to
977 ;; give time for directory-abbrev-alist to be set properly.
978 ;; We include a slash at the end, to avoid spurious matches
979 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
986 ;; If FILENAME starts with the abbreviated homedir,
987 ;; make it start with `~' instead.
989 ;; If the home dir is just /, don't change it.
992 ;; MS-DOS root directories can come with a drive letter;
993 ;; Novell Netware allows drive letters beyond `Z:'.
1002 filename))
1005 "*List of logical names for which visiting shouldn't save the true dirname.
1006 On VMS, when you visit a file using a logical name that searches a path,
1007 you may or may not want the visited file name to record the specific
1008 directory where the file was found. If you *do not* want that, add the logical
1009 name to this list as a string."
1014 "Return the buffer visiting file FILENAME (a string).
1015 This is like `get-file-buffer', except that it checks for any buffer
1016 visiting the same file, possibly under a different name.
1017 If there is no such live buffer, return nil."
1029 found)
1034 number
1039 ;; Verify this buffer's file number
1040 ;; still belongs to its file.
1043 attributes))
1046 found))))
1047 \f
1049 "*Non-nil means file-visiting commands should handle wildcards.
1050 For example, if you specify `*.c', that would visit all the files
1051 whose names match the pattern."
1057 "*Non-nil means suppress warning messages for symlinked files.
1058 When nil, Emacs prints a warning when visiting a file that is already
1059 visited, but with a different name. Setting this option to t
1060 suppresses this warning."
1066 "Read file FILENAME into a buffer and return the buffer.
1067 If a buffer exists visiting FILENAME, return that one, but
1068 verify that the file has not changed since visited or saved.
1069 The buffer is not selected, just returned to the caller.
1070 Optional first arg NOWARN non-nil means suppress any warning messages.
1071 Optional second arg RAWFILE non-nil means the file is read literally.
1072 Optional third arg WILDCARDS non-nil means do wildcard processing
1073 and visit all the matching files. When wildcards are actually
1074 used and expanded, the value is a list of buffers
1075 that are visiting the various files."
1082 'find-directory-functions
1085 filename)))
1088 find-file-wildcards
1101 ;; Find any buffer for a file which has same truename.
1103 ;; Let user know if there is a buffer with the same truename.
1107 find-file-suppress-same-file-warnings
1111 ;; Optionally also find that buffer.
1115 ;; We are using an existing buffer.
1121 ;; Certain files should be reverted automatically
1122 ;; if they have changed on disk and not in the buffer.
1130 found))
1140 "File %s changed on disk. Discard your edits? "
1145 "File %s changed on disk. Discard your edits in %s? "
1153 ;; Check if a formerly read-only file has become
1154 ;; writable and vice versa, but if the buffer agrees
1155 ;; with the new state of the file, that is ok too.
1162 buffer-file-name
1170 ;; It is confusing to ask whether to visit
1171 ;; non-literally if they have the file in
1172 ;; hexl-mode.
1176 "Save file and revisit literally? "
1181 rawfile truename number))
1183 "Discard your edits and revisit file literally? "
1186 rawfile truename number)
1190 "Revisit file literally? "
1193 rawfile truename number)
1196 ;; Return the buffer we are using.
1197 buf)
1198 ;; Create a new buffer.
1201 ;; find-file-noselect-1 may use a different buffer.
1203 rawfile truename number))))))
1207 error)
1210 ;; Needed in case we are re-visiting the file with a different
1211 ;; text representation.
1225 filename)))
1226 ;; Unconditionally set error
1235 filename)))
1236 ;; Run find-file-not-found-hooks until one returns non-nil.
1238 ;; If they fail too, set error.
1240 ;; Record the file's truename, and maybe use that as visited name.
1246 ;; On VMS, we may want to remember which directory in a search list
1247 ;; the file was found in.
1259 ;; Set buffer's default directory to that of the file.
1261 ;; Turn off backup files for certain file names. Since
1262 ;; this is a permanent local, the major mode won't eliminate it.
1275 \f
1277 "Like `insert-file-contents', but only reads in the file literally.
1278 A buffer may be modified in several ways after reading into the buffer,
1279 to Emacs features such as format decoding, character code
1280 conversion, `find-file-hooks', automatic uncompression, etc.
1282 This function ensures that none of these modifications will take place."
1290 nil))
1302 "Insert contents of file FILENAME into buffer after point with no conversion.
1304 This function is meant for the user to run interactively.
1305 Don't call it from programs! Use `insert-file-contents-literally' instead.
1306 \(Its calling sequence is different; see its documentation)."
1310 filename)))
1315 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1320 "Visit file FILENAME with no conversion of any kind.
1321 Format conversion and character code conversion are both disabled,
1322 and multibyte characters are disabled in the resulting buffer.
1323 The major mode used is Fundamental mode regardless of the file name,
1324 and local variable specifications in the file are ignored.
1325 Automatic uncompression and adding a newline at the end of the
1326 file due to `require-final-newline' is also disabled.
1328 You cannot absolutely rely on this function to result in
1329 visiting the file literally. If Emacs already has a buffer
1330 which is visiting the file, you get the existing buffer,
1331 regardless of whether it was created literally or not.
1333 In a Lisp program, if you want to be sure of accessing a file's
1334 contents literally, you should create a temporary buffer and then read
1335 the file contents into it using `insert-file-contents-literally'."
1338 \f
1342 after-find-file-from-revert-buffer
1343 nomodes)
1344 "Called after finding a file and by the default revert function.
1345 Sets buffer mode, parses local variables.
1346 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1347 error in reading the file. WARN non-nil means warn if there
1348 exists an auto-save file more recent than the visited file.
1349 NOAUTO means don't mess with auto-save mode.
1350 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1351 means this call was from `revert-buffer'.
1352 Fifth arg NOMODES non-nil means don't alter the file's modes.
1353 Finishes by calling the functions in `find-file-hooks'
1354 unless NOMODES is non-nil."
1357 nil
1367 ;; No need to warn if buffer is auto-saved
1368 ;; under the name of the visited file.
1370 auto-save-visited-file-name))
1373 buffer-file-name))
1387 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1388 "Use M-x make-directory RET RET to create the directory"
1395 ;; Make people do a little extra work (C-x C-q)
1396 ;; before altering a backup file.
1404 view-read-only
1410 "Choose the major mode for this buffer automatically.
1411 Also sets up any specified local variables of the file.
1412 Uses the visited file name, the -*- line, and the local variables spec.
1414 This function is called automatically from `find-file'. In that case,
1415 we may set up the file-specified mode and local variables,
1416 depending on the value of `enable-local-variables': if it is t, we do;
1417 if it is nil, we don't; otherwise, we query.
1418 In addition, if `local-enable-local-variables' is nil, we do
1419 not set local variables (though we do notice a mode specified with -*-.)
1421 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1422 or from Lisp without specifying the optional argument FIND-FILE;
1423 in that case, this function acts as if `enable-local-variables' were t."
1432 enable-local-variables)))
1473 ;; Less common extensions come here
1474 ;; so more common ones above are found faster.
1484 ;; for MSDOS and MS-Windows (which are case-insensitive)
1530 ;; Mailer puts message to be edited in
1531 ;; /tmp/Re.... or Message
1536 ;; some news reader is reported to use this
1546 ;; .emacs following a directory delimiter
1547 ;; in Unix, MSDOG or VMS syntax.
1550 ;; _emacs following a directory delimiter
1551 ;; in MsDos syntax
1564 ;; Get rid of any trailing .n.m and try again.
1565 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1566 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1567 ;; Using mode nil rather than `ignore' would let the search continue
1568 ;; through this list (with the shortened name) rather than start over.
1570 ;; The following should come after the ChangeLog pattern
1571 ;; for the sake of ChangeLog.1, etc.
1572 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1575 "Alist of filename patterns vs corresponding major mode functions.
1576 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1577 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1578 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1579 mode function to use. FUNCTION will be called, unless it is nil.
1581 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1582 calling FUNCTION (if it's not nil), we delete the suffix that matched
1628 "Alist mapping interpreter names to major modes.
1629 This alist applies to files whose first line starts with `#!'.
1630 Each element looks like (INTERPRETER . MODE).
1631 The car of each element is compared with
1632 the name of the interpreter specified in the first line.
1639 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1640 When checking `inhibit-first-line-modes-regexps', we first discard
1646 "Regular expression matching interpreters, for file mode determination.
1647 This regular expression is matched against the first line of a file
1648 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1649 a mode from the file's name. If it matches, the file is assumed to
1650 be interpreted by the interpreter matched by the second group of the
1651 regular expression. The mode is then determined as the mode associated
1655 "Select major mode appropriate for current buffer.
1656 This checks for a -*- mode tag in the buffer's text,
1657 compares the filename against the entries in `auto-mode-alist',
1658 or checks the interpreter that runs this file against
1659 `interpreter-mode-alist'.
1661 It does not check for the `mode:' local variable in the
1662 Local Variables section of the file; for that, use `hack-local-variables'.
1664 If `enable-local-variables' is nil, this function does not check for a
1665 -*- mode tag.
1667 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1668 then we do not set anything but the major mode,
1669 and we don't even do that unless it would come from the file name."
1670 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1678 ;; Find all specifications for the `mode:' variable
1679 ;; and execute them left to right.
1691 modes)))
1692 ;; Simple -*-MODE-*- case.
1695 modes))))
1696 ;; If we found modes to use, invoke them now,
1697 ;; outside the save-excursion.
1704 ;; If we didn't find a mode from a -*- line, try using the file name.
1708 ;; Remove backup-suffixes from file name.
1714 ;; Find first matching alist entry.
1723 keep-going t)
1725 keep-going nil)))
1728 ;; When JUST-FROM-FILE-NAME is set,
1729 ;; we are working on behalf of set-visited-file-name.
1730 ;; In that case, if the major mode specified is the
1731 ;; same one we already have, don't actually reset it.
1732 ;; We don't want to lose minor modes such as Font Lock.
1735 ;; If we can't deduce a mode from the file name,
1736 ;; look for an interpreter specified in the first line.
1737 ;; As a special case, allow for things like "#!/bin/env perl",
1738 ;; which finds the interpreter anywhere in $PATH.
1745 elt)
1746 ;; Map interpreter name to a mode.
1748 interpreter-mode-alist))
1755 "Find the -*- spec in the buffer.
1756 Call with point at the place to start searching from.
1757 If one is found, set point to the beginning
1758 and return the position of the end.
1759 Otherwise, return nil; point may be changed."
1762 ;; Don't look for -*- if this file name matches any
1763 ;; of the regexps in inhibit-first-line-modes-regexps.
1771 sufs)
1779 ;; If the file begins with "#!"
1780 ;; (exec interpreter magic), look
1781 ;; for mode frobs in the first two
1782 ;; lines. You cannot necessarily
1783 ;; put them in the first line of
1784 ;; such a file without screwing up
1785 ;; the interpreter invocation.
1793 t))
1799 end))))
1802 "Set local variables specified in the -*- line.
1803 Ignore any specification for `mode:' and `coding:';
1804 `set-auto-mode' should already have handled `mode:',
1805 `set-auto-coding' should already have handled `coding:'."
1812 ;; Parse the -*- line into the `result' alist.
1814 nil)
1816 ;; Simple form: "-*- MODENAME -*-". Already handled.
1817 nil)
1819 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1820 ;; (last ";" is optional).
1825 ;; There used to be a downcase here,
1826 ;; but the manual didn't say so,
1827 ;; and people want to set var names that aren't all lc.
1834 ;; It is traditional to ignore
1835 ;; case when checking for `mode' in set-auto-mode,
1836 ;; so we must do that here as well.
1837 ;; That is inconsistent, but we're stuck with it.
1838 ;; The same can be said for `coding' in set-auto-coding.
1852 ;; If we fail to switch in the selected window,
1853 ;; it is probably a minibuffer.
1854 ;; So try another window.
1867 "Normal hook run after processing a file's local variables specs.
1868 Major modes can use this to examine user-specified local variables
1872 "Parse and put into effect this buffer's local variables spec.
1873 If MODE-ONLY is non-nil, all we do is check whether the major mode
1874 is specified, returning t if it is specified."
1877 ;; Look for "Local variables:" line in last page.
1887 mode-only
1897 buffer-file-name)
1901 prefix prefixlen suffix beg
1902 mode-specified
1904 ;; The prefix is what comes before "local variables:" in its line.
1905 ;; The suffix is what comes after "local variables:" in its line.
1920 ;; Look at next local variable spec.
1923 ;; Skip the prefix, if any.
1928 ;; Find the variable name; strip whitespace.
1936 val)
1937 ;; Setting variable named "end" means end of list.
1940 ;; Otherwise read the variable value.
1951 ;; Set the variable. "Variables" mode and eval are funny.
1955 mode-specified))
1961 ;; Get confirmation before setting these variables as locals in a file.
1985 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2012 ;; This one is safe because the user gets to check it before it is used.
2020 A few patterns are specified so that any name which matches one
2021 is considered risky."
2026 ;; We have already handled coding: tag in set-auto-coding.
2027 nil)
2029 nil)
2030 ;; "Setting" eval means either eval it or do nothing.
2031 ;; Likewise for setting hook variables.
2034 (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$"
2037 ;; Permit evalling a put of a harmless property.
2038 ;; if the args do nothing tricky.
2044 ;; Only allow safe values of lisp-indent-hook;
2045 ;; not functions.
2050 ;; Permit eval if not root and user says ok.
2069 ;; Ordinary variable, really set it.
2071 ;; Make sure the string has no text properties.
2072 ;; Some text properties can get evaluated in various ways,
2073 ;; so it is risky to put them on with a local variable list.
2078 \f
2081 However, the mode will not be changed if
2082 \(1) a local variables list or the `-*-' line specifies a major mode, or
2084 \ not suitable for ordinary files, or
2085 \(3) the new file name does not particularly specify any mode."
2090 "Change name of file visited in current buffer to FILENAME.
2091 The next time the buffer is saved it will go in the newly specified file.
2092 nil or empty string as argument means make buffer not be visiting any file.
2093 Remember to delete the initial contents of the minibuffer
2094 if you wish to pass an empty string as the argument.
2096 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2097 confirmation in the case where another buffer is already visiting FILENAME.
2099 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2100 the old visited file has been renamed to the new name FILENAME."
2108 nil
2119 filename)))
2138 ;; Abbreviate the file names of the buffer.
2147 nil)))
2148 ;; write-file-hooks is normally used for things like ftp-find-file
2149 ;; that visit things that are not local files as if they were files.
2150 ;; Changing to visit an ordinary local file instead should flush the hook.
2155 ;; If buffer was read-only because of version control,
2156 ;; that reason is gone now, so make it writable.
2160 ;; Turn off backup files for certain file names.
2161 ;; Since this is a permanent local, the major mode won't eliminate it.
2168 ;; If auto-save was not already on, turn it on if appropriate.
2172 ;; If auto save is on, start using a new name.
2173 ;; We deliberately don't rename or delete the old auto save
2174 ;; for the old visited file name. This is because perhaps
2175 ;; the user wants to save the new state and then compare with the
2176 ;; previous state from the auto save file.
2179 ;; Rename the old auto save file if any.
2186 ;; Update the major mode, if the file name determines it.
2188 ;; Don't change the mode if it is special.
2191 ;; Don't change the mode if the local variable list specifies it.
2197 "Write current buffer into file FILENAME.
2198 This makes the buffer visit that file, and marks it as not modified.
2200 If you specify just a directory name as FILENAME, that means to use
2201 the default file name but in that directory. You can also yank
2202 the default file name into the minibuffer to edit it, using M-n.
2204 If the buffer is not already visiting a file, the default file name
2205 for the output file is the buffer name.
2207 If optional second arg CONFIRM is non-nil, this function
2208 asks for confirmation before overwriting an existing file.
2209 Interactively, confirmation is required unless you supply a prefix argument."
2210 ;; (interactive "FWrite file: ")
2214 nil nil nil nil)
2218 default-directory)
2219 nil nil))
2223 ;; If arg is just a directory,
2224 ;; use the default file name, but in that directory.
2235 ;; Make buffer writable if file is writable.
2240 \f
2242 "Make a backup of the disk file visited by the current buffer, if appropriate.
2243 This is normally done before saving the buffer the first time.
2244 If the value is non-nil, it is the result of `file-modes' on the original
2245 file; this means that the caller, after saving the buffer, should change
2246 the modes of the new file to agree with the old modes.
2248 A backup may be done by renaming or by copying; see documentation of
2249 variable `make-backup-files'. If it's done by renaming, then the file is
2250 no longer accessible under its old name."
2257 backup-info backupname targets setmodes)
2258 ;; If specified name is a symbolic link, chase it to the target.
2259 ;; Thus we make the backups in the directory where the real file is.
2264 ;; (if (file-directory-p buffer-file-name)
2265 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2269 ;; If have old versions to maybe delete,
2270 ;; ask the user to confirm now, before doing anything.
2271 ;; But don't actually delete til later.
2276 real-file-name))))))
2277 ;; Actually write the back up file.
2280 ; (file-symlink-p buffer-file-name)
2281 backup-by-copying
2296 ;; If copying fails because file BACKUPNAME
2297 ;; is not writable, delete that file and try again.
2302 ;; rename-file should delete old backup.
2306 ;; If trouble writing the backup, write it in ~.
2316 ;; If copying fails because file BACKUPNAME
2317 ;; is not writable, delete that file and try again.
2323 ;; Now delete the old versions, if desired.
2330 setmodes)
2334 "Return file NAME sans backup versions or strings.
2335 This is a separate procedure so your site-init or startup file can
2336 redefine it.
2337 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2338 we do not remove backup version numbers, only true file version numbers."
2344 ;; VMS version number is (a) semicolon, optional
2345 ;; sign, zero or more digits or (b) period, option
2346 ;; sign, zero or more digits, provided this is the
2347 ;; second period encountered outside of the
2348 ;; device/directory part of the file name.
2351 name)
2361 "Return t if deleting FILE and rewriting it would preserve the owner."
2366 ;; Return t if the file doesn't exist, since it's true that no
2367 ;; information would be lost by an (attempted) delete and create.
2373 The extension, in a file name, is the part that follows the last `.',
2374 except that a leading `.', if any, doesn't count."
2377 directory)
2382 directory)
2384 filename))))
2388 The extension, in a file name, is the part that follows the last `.',
2389 except that a leading `.', if any, doesn't count.
2390 Return nil for extensionless file names such as `foo'.
2391 Return the empty string for file names such as `foo.'.
2393 If PERIOD is non-nil, then the returned value includes the period
2394 that delimits the extension, and if FILENAME has no extension,
2405 "A function to use instead of the default `make-backup-file-name'.
2406 A value of nil gives the default `make-backup-file-name' behaviour.
2408 This could be buffer-local to do something special for specific
2409 files. If you define it, you may need to change `backup-file-name-p'
2410 and `file-name-sans-versions' too.
2412 See also `backup-directory-alist'."
2418 "Alist of filename patterns and backup directory names.
2419 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2420 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2421 relative or absolute. If it is absolute, so that all matching files
2422 are backed up into the same directory, the file names in this
2423 directory will be the full name of the file backed up with all
2424 directory separators changed to `!' to prevent clashes. This will not
2425 work correctly if your filesystem truncates the resulting name.
2427 For the common case of all backups going into one directory, the alist
2429 directory name.
2431 If this variable is nil, or it fails to match a filename, the backup
2432 is made in the original file's directory.
2434 On MS-DOS filesystems without long names this variable is always
2435 ignored."
2441 "Default `backup-enable-predicate' function.
2442 Checks for files in `temporary-file-directory' or
2443 `small-temporary-file-directory'."
2446 ;; Directory is under temporary-file-directory.
2451 0 nil
2453 ;; Directory is under small-temporary-file-directory.
2458 "Create the non-numeric backup file name for FILE.
2459 Normally this will just be the file's name with `~' appended.
2460 Customization hooks are provided as follows.
2462 If the variable `make-backup-file-name-function' is non-nil, its value
2463 should be a function which will be called with FILE as its argument;
2464 the resulting name is used.
2466 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2467 the documentation of that variable. If the directory for the backup
2468 doesn't exist, it is created."
2482 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2484 elt backup-directory dir-sep-string)
2489 alist nil)))
2491 file
2499 ;; Normalize DOSish file names: convert all slashes to
2500 ;; directory-sep-char, downcase the drive letter, if any,
2501 ;; and replace the leading "x:" with "/drive_x".
2504 ;; Replace any invalid file-name characters (for the
2505 ;; case of backing up remote files).
2510 "drive_"
2513 ""
2514 dir-sep-string)
2516 ;; Make the name unique by substituting directory
2517 ;; separators. It may not really be worth bothering about
2518 ;; doubling `!'s in the original name...
2521 directory-sep-char ?!
2523 backup-directory))
2530 "Return non-nil if FILE is a backup file name (numeric or not).
2531 This is a separate function so you can redefine it for customization.
2532 You may need to redefine `file-name-sans-versions' as well."
2537 ;; This is used in various files.
2538 ;; The usage of backup-extract-version-start is not very clean,
2539 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2541 "Given the name of a numeric backup file, FN, return the backup number.
2542 Uses the free variable `backup-extract-version-start', whose value should be
2543 the index in the name where the version number begins."
2549 ;; I believe there is no need to alter this behavior for VMS;
2550 ;; since backup files are not made on VMS, it should not get called.
2552 "Find a file name for a backup file FN, and suggestions for deletions.
2553 Value is a list whose car is the name for the backup file
2554 and whose cdr is a list of old versions to consider deleting now.
2555 If the value is nil, don't make a backup.
2556 Uses `backup-directory-alist' in the same way as does
2557 `make-backup-file-name'."
2559 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2563 ;; We don't support numbered backups on plain MS-DOS
2564 ;; when long file names are unavailable.
2574 possibilities deserve-versions-p versions)
2577 base-versions
2580 possibilities)
2581 #'<)
2586 kept-old-versions
2587 kept-new-versions
2594 ;; Delete nothing if there is overflow
2595 ;; in the number of versions to keep.
2601 v))))))))))
2604 "Return number of names file FILENAME has."
2608 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2609 This function returns a relative file name which is equivalent to FILENAME
2610 when used with that default directory as the default.
2611 If this is impossible (which can happen on MSDOS and Windows
2612 when the file name and directory use different drive names)
2613 then it returns FILENAME."
2618 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2619 ;; drive names, they can't be relative, so return the absolute name.
2624 filename
2631 ".."
2633 ;; Now ancestor is empty, or .., or ../.., etc.
2635 ;; We matched within FNAME's directory part.
2636 ;; Add the rest of FNAME onto ANCESTOR.
2640 ;; But don't bother with ANCESTOR if it would give us `./'.
2641 rest
2643 ;; We matched FNAME's directory equivalent.
2644 ancestor))))))
2645 \f
2647 "Save current buffer in visited file if modified. Versions described below.
2648 By default, makes the previous version into a backup file
2649 if previously requested or if this is the first save.
2651 to become a backup when the next save is done.
2653 unconditionally makes the previous version into a backup file.
2655 to become a backup when the next save is done,
2656 and unconditionally makes the previous version into a backup file.
2658 With argument of 0, never make the previous version into a backup file.
2660 If a file's name is FOO, the names of its numbered backup versions are
2661 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2662 Numeric backups (rather than FOO~) will be made if value of
2663 `version-control' is not the atom `never' and either there are already
2664 numeric versions of the file being backed up, or `version-control' is
2665 non-nil.
2666 We don't want excessive versions piling up, so there are variables
2667 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2668 and `kept-new-versions', which tells how many newest versions to keep.
2669 Defaults are 2 old versions and 2 new.
2670 `dired-kept-versions' controls dired's clean-directory (.) command.
2671 If `delete-old-versions' is nil, system will query user
2672 before trimming versions. Otherwise it does it silently.
2674 If `vc-make-backup-files' is nil, which is the default,
2675 no backup files are made for files managed by version control.
2676 (This is because the version control system itself records previous versions.)
2678 See the subroutine `basic-save-buffer' for more information."
2691 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2692 Normally delete only if the file was written by this Emacs since
2693 the last real save, but optional arg FORCE non-nil means delete anyway."
2707 "Normal hook that is run after a buffer is saved to its file."
2713 "If non-nil, use this coding system for saving the buffer.
2714 More precisely, use this coding system in place of the
2715 value of `buffer-file-coding-system', when saving the buffer.
2716 Calling `write-region' for any purpose other than saving the buffer
2717 will still use `buffer-file-coding-system'; this variable has no effect
2724 "Save the current buffer in its visited file, if it has been modified.
2725 The hooks `write-contents-hooks', `local-write-file-hooks' and
2726 `write-file-hooks' get a chance to do the job of saving; if they do not,
2727 then the buffer is saved in the visited file file in the usual way.
2728 After saving the buffer, this function runs `after-save-hook'."
2731 ;; In an indirect buffer, save its base buffer instead.
2736 setmodes tempsetmodes)
2737 ;; On VMS, rename file and buffer to get rid of version number.
2742 ;; Strip VMS version number before save.
2745 ;; Construct a (unique) buffer name to correspond.
2750 ;; If buffer has no file name, ask user for one.
2757 filename))
2782 ;; Support VC version backups.
2787 ;; If a hook returned t, file is already "written".
2788 ;; Otherwise, write it the usual way now.
2790 ;; Now we have saved the current buffer. Let's make sure
2791 ;; that buffer-file-coding-system is fixed to what
2792 ;; actually used for saving by binding it locally.
2802 ;; If the auto-save file was recent before this command,
2803 ;; delete it now.
2805 ;; Support VC `implicit' locking.
2810 ;; This does the "real job" of writing a buffer into its visited file
2811 ;; and making a backup file. This is what is normally done
2812 ;; but inhibited if one of write-file-hooks returns non-nil.
2813 ;; It returns a value to store in setmodes.
2833 buffer-file-name)))
2841 ;; If file is precious, write temp name, then rename it.
2842 ;; This requires write access to the containing dir,
2843 ;; which is why we don't try it if we don't have that access.
2845 tempname temp nogood i succeed
2849 ;; Find the temporary name to write under.
2856 "%s$tmp$%d"
2858 dir i))
2864 tempname nil realname
2865 buffer-file-truename)
2867 ;; If writing the temp file fails,
2868 ;; delete the temp file.
2875 ;; Since we have created an entirely new file
2876 ;; and renamed it, make sure it gets the
2877 ;; right permission bits set.
2879 ;; We succeeded in writing the temp file,
2880 ;; so rename it.
2882 ;; If file not writable, see if we can make it writable
2883 ;; temporarily while we write it.
2884 ;; But no need to do so if we have just backed it up
2885 ;; (setmodes is set) because that says we're superseding.
2887 ;; Change the mode back, after writing.
2891 buffer-file-name nil t buffer-file-truename)))
2892 setmodes))
2895 "Save some modified file-visiting buffers. Asks user about each one.
2896 Optional argument (the prefix) non-nil means save all with no questions.
2897 Optional second argument PRED determines which buffers are considered:
2898 If PRED is nil, all the file-visiting buffers are considered.
2899 If PRED is t, then certain non-file buffers will also be considered.
2900 If PRED is a zero-argument function, it indicates for each buffer whether
2901 to consider it or not when called with that buffer current."
2920 t
2939 ;; Return nil to ask about BUF again.
2940 nil)
2948 abbrev-file-name)))
2950 ;; Don't keep bothering user if he says no.
2952 t))))
2955 \f
2957 "Mark current buffer as unmodified, not needing to be saved.
2960 It is not a good idea to use this function in Lisp programs, because it
2961 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2968 "Change whether this buffer is visiting its file read-only.
2969 With arg, set read-only iff arg is positive.
2970 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2976 ;; Toggle.
2988 "Insert contents of file FILENAME into buffer after point.
2989 Set mark after the inserted text.
2991 This function is meant for the user to run interactively.
2992 Don't call it from programs! Use `insert-file-contents' instead.
2993 \(Its calling sequence is different; see its documentation)."
2997 filename)))
3002 "Append the contents of the region to the end of file FILENAME.
3003 When called from a function, expects three arguments,
3004 START, END and FILENAME. START and END are buffer positions
3005 saying what text to write."
3010 "Return most recent backup file for FILENAME or nil if no backups exist."
3011 ;; `make-backup-file-name' will get us the right directory for
3012 ;; ordinary or numeric backups. It might create a directory for
3013 ;; backups as a side-effect, according to `backup-directory-alist'.
3020 tem)
3029 newest))
3032 "Rename current buffer to a similar name not already taken.
3033 This function is useful for creating multiple shell process buffers
3034 or multiple mail buffers, etc."
3042 ;; If the existing buffer name has a <NNN>,
3043 ;; which isn't part of the file name (if any),
3044 ;; then get rid of that.
3050 "Create the directory DIR and any nonexistent parent dirs.
3051 Interactively, the default choice of directory to create
3052 is the current default directory for file names.
3053 That is useful when you have visited a file in a nonexistent directory.
3055 Noninteractively, the second (optional) argument PARENTS says whether
3056 to create parent directories if they don't exist."
3059 nil nil)
3060 t))
3067 create-list)
3074 \f
3077 "Function to use to revert this buffer, or nil to do the default.
3078 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3083 "Function to use to insert contents when reverting this buffer.
3084 Gets two args, first the nominal file name to use,
3085 and second, t if reading the auto-save file.
3090 "Normal hook for `revert-buffer' to run before reverting.
3091 If `revert-buffer-function' is used to override the normal revert
3095 "Normal hook for `revert-buffer' to run after reverting.
3096 Note that the hook value that it runs is the value that was in effect
3097 before reverting; that makes a difference if you have buffer-local
3098 hook functions.
3100 If `revert-buffer-function' is used to override the normal revert
3106 "Replace current buffer text with the text of the visited file on disk.
3107 This undoes all changes since the file was visited or saved.
3108 With a prefix argument, offer to revert from latest auto-save file, if
3109 that is more recent than the visited file.
3111 This command also works for special buffers that contain text which
3112 doesn't come from a file, but reflects some other data base instead:
3113 for example, Dired buffers and buffer-list buffers. In these cases,
3114 it reconstructs the buffer contents from the appropriate data base.
3116 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3117 to revert from the auto-save file when this is nil. Note that the
3118 sense of this argument is the reverse of the prefix argument, for the
3119 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3120 to nil.
3122 Optional second argument NOCONFIRM means don't ask for confirmation at
3123 all. (The local variable `revert-without-query', if non-nil, prevents
3124 confirmation.)
3126 Optional third argument PRESERVE-MODES non-nil means don't alter
3127 the files modes. Normally we reinitialize them using `normal-mode'.
3129 If the value of `revert-buffer-function' is non-nil, it is called to
3130 do all the work for this command. Otherwise, the hooks
3131 `before-revert-hook' and `after-revert-hook' are run at the beginning
3132 and the end, and if `revert-buffer-insert-file-contents-function' is
3133 non-nil, it is called instead of rereading visited file contents."
3135 ;; I admit it's odd to reverse the sense of the prefix argument, but
3136 ;; there is a lot of code out there which assumes that the first
3137 ;; argument should be t to avoid consulting the auto-save file, and
3138 ;; there's no straightforward way to encourage authors to notice a
3139 ;; reversal of the argument sense. So I'm just changing the user
3140 ;; interface, but leaving the programmatic interface the same.
3146 buffer-auto-save-file-name
3151 buffer-auto-save-file-name
3152 buffer-file-name)))
3163 found))
3165 file-name)))
3167 ;; If file was backed up but has changed since,
3168 ;; we shd make another backup.
3172 ;; Get rid of all undo records for this buffer.
3175 ;; Effectively copy the after-revert-hook status,
3176 ;; since after-find-file will clobber it.
3180 after-revert-hook)))
3182 ;; Don't make undo records for the reversion.
3186 file-name auto-save-p)
3189 ;; Bind buffer-file-name to nil
3190 ;; so that we don't try to lock the file.
3196 ;; Auto-saved file shoule be read without
3197 ;; any code conversion.
3199 coding-system-for-read)))
3200 ;; Note that this preserves point in an intelligent way.
3202 nil nil t))))
3203 ;; Recompute the truename in case changes in symlinks
3204 ;; have changed the truename.
3208 ;; Run after-revert-hook as it was before we reverted.
3216 t)))))
3219 "Visit file FILE, but get contents from its last auto-save file."
3220 ;; Actually putting the file name in the minibuffer should be used
3221 ;; only rarely.
3222 ;; Not just because users often use the default.
3241 ;; Use insert-directory-safely, not insert-directory,
3242 ;; because these files might not exist. In particular,
3243 ;; FILE might not exist if the auto-save file was for
3244 ;; a buffer that didn't visit a file, such as "*mail*".
3245 ;; The code in v20.x called `ls' directly, so we need
3246 ;; to emulate what `ls' did in that case.
3252 ;; Keep the current buffer-file-coding-system.
3254 ;; Auto-saved file shoule be read without any code conversion.
3263 "Recover auto save files from a previous Emacs session.
3264 This command first displays a Dired buffer showing you the
3265 previous sessions that you could recover from.
3266 To choose one, move point to the proper line and then type C-c C-c.
3267 Then you'll be asked about a number of files to recover."
3281 ;; Each line starts with a space
3282 ;; so that Font Lock mode won't highlight the first character.
3291 "Choose one saved session to recover auto-save files from.
3292 This command is used in the special Dired buffer created by
3295 ;; Get the name of the session file to recover from.
3297 files
3303 ;; Read in the auto-save-list file.
3307 ;; Loop thru the text of that file
3308 ;; and get out the names of the files to recover.
3312 ;; This is a pair of lines for a non-file-visiting buffer.
3313 ;; Get the auto-save file name and manufacture
3314 ;; a "visited file name" from that.
3330 ;; This pair of lines is a file-visiting
3331 ;; buffer. Use the visited file name.
3341 ;; Ignore a file if its auto-save file does not exist now.
3345 ;; The file contains a pair of line for each auto-saved buffer.
3346 ;; The first line of the pair contains the visited file name
3347 ;; or is empty if the buffer was not visiting a file.
3348 ;; The second line is the auto-save file name.
3356 files
3362 "For each buffer in LIST, ask whether to kill it.
3363 LIST defaults to all existing live buffers."
3374 name
3379 \f
3381 "Toggle auto-saving of contents of current buffer.
3382 With prefix argument ARG, turn auto-saving on if positive, else off."
3387 ;; If auto-save is off because buffer has shrunk,
3388 ;; then toggling should turn it on.
3393 buffer-file-name
3395 ;; If -1 was stored here, to temporarily turn off saving,
3396 ;; turn it back on.
3402 buffer-auto-save-file-name)
3405 "Adjust current buffer's auto save file name for current conditions.
3406 Also rename any existing auto save file, if it was made in this session."
3418 "Return file name to use for auto-saves of current buffer.
3419 Does not consider `auto-save-visited-file-name' as that variable is checked
3420 before calling this function. You can redefine this for customization.
3421 See also `auto-save-file-name-p'."
3425 result uniq)
3426 ;; Apply user-specified translations
3427 ;; to the file name.
3431 filename)
3439 directory-sep-char ?!
3441 filename))))
3446 ;; We truncate the file name to DOS 8+3 limits
3447 ;; before doing anything else, because the regexp
3448 ;; passed to string-match below cannot handle
3449 ;; extensions longer than 3 characters, multiple
3450 ;; dots, and other atrocities.
3455 fn)
3460 "#"
3463 ;; Make sure auto-save file names don't contain characters
3464 ;; invalid for the underlying filesystem.
3466 ;; Don't modify remote (ange-ftp) filenames
3469 result))
3471 ;; Deal with buffers that don't have any associated files. (Mail
3472 ;; mode tends to create a good number of these.)
3476 filename)
3477 ;; Eliminate all slashes and backslashes by
3478 ;; replacing them with sequences that start with %.
3479 ;; Quote % also, to keep distinct names distinct.
3488 ;; Generate the file name.
3494 ;; Try a few alternative directories, to get one we can
3495 ;; write it.
3501 ;; Don't modify remote (ange-ftp) filenames
3503 ;; The call to convert-standard-filename is in case
3504 ;; buffer-name includes characters not allowed by the
3505 ;; DOS/Windows filesystems. make-temp-file writes to the
3506 ;; file it creates, so we must fix the file name _before_
3507 ;; make-temp-file is called.
3509 fname))
3511 ;; make-temp-file creates the file,
3512 ;; but we don't want it to exist until we do an auto-save.
3516 file-name)))
3519 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3520 FILENAME should lack slashes. You can redefine this for customization."
3522 \f
3524 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3525 The generated regexp will match a filename iff the filename
3526 matches that wildcard according to shell rules. Only wildcards known
3527 by `sh' are supported."
3529 ;; Copy the initial run of non-special characters.
3532 ;; If no special characters, we're almost done.
3536 j)
3538 result
3559 ;; Found "[^". Insert a `\0' character
3560 ;; (which cannot happen in a filename)
3561 ;; into the character class, so that `^'
3562 ;; is not the first character after `[',
3563 ;; and thus non-special in a regexp.
3568 ;; I don't think `]' can appear in a
3569 ;; character class in a wildcard, but
3570 ;; let's be general here.
3577 i
3590 ;; Shell wildcards should match the entire filename,
3591 ;; not its part. Make the regexp say so.
3593 \f
3596 "*Switches for `list-directory' to pass to `ls' for brief listing."
3602 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3604 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3609 "Expand wildcard pattern PATTERN.
3610 This returns a list of file names which match the pattern.
3612 If PATTERN is written as an absolute relative file name,
3613 the values are absolute also.
3615 If PATTERN is written as a relative file name, it is interpreted
3616 relative to the current default directory, `default-directory'.
3617 The file names returned are normally also relative to the current
3618 default directory. However, if FULL is non-nil, they are absolute."
3622 ;; A list of all dirs that DIRPART specifies.
3623 ;; This can be more than one dir
3624 ;; if DIRPART contains wildcards.
3629 contents)
3634 ;; Filter out "." and ".."
3639 name))
3646 this-dir-contents)
3647 this-dir-contents)
3648 contents))))
3650 contents)))
3653 "Display a list of files in or matching DIRNAME, a la `ls'.
3654 DIRNAME is globbed by the shell if necessary.
3655 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3656 Actions controlled by variables `list-directory-brief-switches'
3657 and `list-directory-verbose-switches'."
3661 nil default-directory nil)
3662 pfx)))
3664 list-directory-brief-switches))
3665 buffer)
3678 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
3686 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3688 PATTERN is assumed to represent a file-name wildcard suitable for the
3689 underlying filesystem. For Unix and GNU/Linux, the characters from the
3691 the parts of the pattern which don't include wildcard characters are
3692 quoted with double quotes.
3693 Existing quote characters in PATTERN are left alone, so you can pass
3694 PATTERN that already quotes some of the special characters."
3698 ;; DOS/Windows don't allow `"' in file names. So if the
3699 ;; argument has quotes, we can safely assume it is already
3700 ;; quoted by the caller.
3702 ;; We quote [&()#$'] in case their shell is a port of a
3703 ;; Unixy shell. We quote [,=+] because stock DOS and
3704 ;; Windows shells require that in some cases, such as
3705 ;; passing arguments to batch files that use positional
3706 ;; arguments like %1.
3708 pattern
3711 end)
3728 pattern))))
3735 "*Program to get the amount of free space on a file system.
3736 We assume the output has the format of `df'.
3737 The value of this variable must be just a command name or file name;
3738 if you want to specify options, use `directory-free-space-args'.
3740 A value of nil disables this feature.
3742 If the function `file-system-info' is defined, it is always used in
3743 preference to the program given by this variable."
3748 "*Options to use when running `directory-free-space-program'."
3753 "Return the mount of free space on directory DIR's file system.
3754 The result is a string that gives the number of free 1KB blocks,
3755 or nil if the system call or the program which retrieve the infornmation
3756 fail.
3758 This function calls `file-system-info' if it is available, or invokes the
3759 program specified by `directory-free-space-program' if that is non-nil."
3760 ;; Try to find the number of free blocks. Non-Posix systems don't
3761 ;; always have df, but might have an equivalent system call.
3770 nil t nil
3771 directory-free-space-args
3772 dir)))
3773 ;; Usual format is a header line followed by a line of
3774 ;; numbers.
3779 ;; Move to the end of the "available blocks" number.
3782 ;; Copy it into AVAILABLE.
3788 ;; insert-directory
3789 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3790 ;; FULL-DIRECTORY-P is nil.
3791 ;; The single line of output must display FILE's name as it was
3792 ;; given, namely, an absolute path name.
3793 ;; - must insert exactly one line for each file if WILDCARD or
3794 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3795 ;; before the file lines, plus optional text after the file lines.
3796 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3797 ;; allowed.
3798 ;; File lines should display the basename.
3799 ;; - must be consistent with
3800 ;; - functions dired-move-to-filename, (these two define what a file line is)
3801 ;; dired-move-to-end-of-filename,
3802 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3803 ;; dired-insert-headerline
3804 ;; dired-after-subdir-garbage (defines what a "total" line is)
3805 ;; - variable dired-subdir-regexp
3807 "Insert directory listing for FILE, formatted according to SWITCHES.
3808 Leaves point after the inserted text.
3809 SWITCHES may be a string of options, or a list of strings.
3810 Optional third arg WILDCARD means treat FILE as shell wildcard.
3811 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3812 switches do not contain `d', so that a full listing is expected.
3814 This works by running a directory listing program
3815 whose name is in the variable `insert-directory-program'.
3816 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3817 ;; We need the directory in order to find the right handler.
3822 wildcard full-directory-p)
3827 ;; Read the actual directory using `insert-directory-program'.
3828 ;; RESULT gets the status code.
3832 default-file-name-coding-system)))
3833 ;; This is to control encoding the arguments in call-process.
3837 ;; Run ls in the directory part of the file pattern
3838 ;; using the last component as argument.
3845 shell-file-name nil t nil
3846 "-c"
3848 ""
3850 insert-directory-program
3851 " -d "
3853 switches
3855 " -- "
3856 ;; Quote some characters that have
3857 ;; special meanings in shells; but
3858 ;; don't quote the wildcards--we want
3859 ;; them to be special. We also
3860 ;; currently don't quote the quoting
3861 ;; characters in case people want to
3862 ;; use them explicitly to quote
3863 ;; wildcard characters.
3865 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3866 ;; directory if FILE is a symbolic link.
3868 insert-directory-program nil t nil
3872 ;; Split the switches at any spaces so we can
3873 ;; pass separate options as separate args.
3875 ;; Avoid lossage if FILE starts with `-'.
3883 file))))))))
3885 ;; If `insert-directory-program' failed, signal an error.
3887 ;; On non-Posix systems, we cannot open a directory, so
3888 ;; don't even try, because that will always result in
3889 ;; the ubiquitous "Access denied". Instead, show the
3890 ;; command line so the user can try to guess what went wrong.
3895 insert-directory-program
3897 file result)
3898 ;; Unix. Access the file to get a suitable error.
3902 ;; Try to insert the amount of free space.
3905 ;; First find the line to put it on.
3909 ;; Replace "total" with "used", to avoid confusion.
3916 "Insert directory listing for FILE, formatted according to SWITCHES.
3918 Like `insert-directory', but if FILE does not exist, it inserts a
3919 message to that effect instead of signaling an error."
3922 ;; Simulate the message printed by `ls'.
3926 "Functions to call with no arguments to query about killing Emacs.
3927 If any of these functions returns nil, killing Emacs is cancelled.
3929 but `kill-emacs', the low level primitive, does not.
3933 "How to ask for confirmation when leaving Emacs.
3934 If nil, the default, don't ask at all. If the value is non-nil, it should
3935 be a predicate function such as `yes-or-no-p'."
3943 "Offer to save each buffer, then kill this Emacs process.
3944 With prefix arg, silently save all file-visiting buffers, then kill."
3953 ;; process-list is not defined on VMS.
3955 active)
3964 ;; Query the user for other things, perhaps.
3969 \f
3970 ;; We use /: as a prefix to "quote" a file name
3971 ;; so that magic file name handlers will not apply to it.
3975 file-name-handler-alist))
3977 ;; We depend on being the last handler on the list,
3978 ;; so that anything else which does need handling
3979 ;; has been handled already.
3980 ;; So it is safe for us to inhibit *all* magic file name handlers.
3989 default-directory))
3990 ;; Get a list of the indices of the args which are file names.
3993 ;; The first five are special because they
3994 ;; return a file name. We want to include the /:
3995 ;; in the return value.
3996 ;; So just avoid stripping it in the first place.
4002 ;; `identity' means just return the first arg
4003 ;; as stripped of its quoting.
4011 ;; For all other operations, treat the first argument only
4012 ;; as the file name.
4014 ;; Copy ARGUMENTS so we can replace elements in it.
4016 ;; Strip off the /: from the file names that have this handler.
4024 "/"
4030 \f
4053 ;;; files.el ends here