| blob | 4a495aab30c58636983fcfecf2a54e6cb774dc80 |
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 newname)
680 ;; For file name that has a special handler, call handler.
681 ;; This is so that ange-ftp can save time by doing a no-op.
684 ;; If filename contains a wildcard, newname will be the old name.
687 ;; If filename doesn't exist, newname will be nil.
692 ;; If this file directly leads to a link, process that iteratively
693 ;; so that we don't use lots of stack.
699 ;; For file name that has a special handler, call handler.
700 ;; This is so that ange-ftp can save time by doing a no-op.
703 done t)
705 target dirfile)
706 ;; Get the truename of the directory.
708 ;; If these are equal, we have the (or a) root directory.
710 ;; If this is the same dir we last got the truename for,
711 ;; save time--don't recalculate.
721 done t)
724 done t)
725 ;; Put it back on the file name.
727 ;; Is the file name the name of a link?
730 ;; Yes => chase that link, then start all over
731 ;; since the link may point to a directory name that uses links.
732 ;; We can't safely use expand-file-name here
733 ;; since target might look like foo/../bar where foo
734 ;; is itself a link. Instead, we handle . and .. above.
737 target
739 done nil)
740 ;; No, we are done!
742 filename))
745 "Chase links in FILENAME until a name that is not a link.
746 Does not examine containing directories for links,
747 unlike `file-truename'."
753 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
756 ;; Handle `..' by hand, since it needs to work in the
757 ;; target of any directory symlink.
758 ;; This code is not quite complete; it does not handle
759 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
763 ;; Chase links in the default dir of the symlink.
767 ;; Now find the parent of that dir.
771 newname))
772 \f
774 "Select buffer BUFFER in another window.
775 Optional second arg NORECORD non-nil means
776 do not put this buffer at the front of the list of recently selected ones.
778 This uses the function `display-buffer' as a subroutine; see its
779 documentation for additional customization information."
785 "Switch to buffer BUFFER in another frame.
786 Optional second arg NORECORD non-nil means
787 do not put this buffer at the front of the list of recently selected ones.
789 This uses the function `display-buffer' as a subroutine; see its
790 documentation for additional customization information."
806 ;; Clear out this hook so it does not interfere
807 ;; with any recursive minibuffer usage.
810 minibuffer-setup-hook))
813 current-prefix-arg))
816 "Edit file FILENAME.
817 Switch to a buffer visiting file FILENAME,
818 creating one if none already exists.
819 Interactively, the default if you just type RET is the current directory,
820 but the visited file name is available through the minibuffer history:
821 type M-n to pull it into the minibuffer.
823 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
824 expand wildcards (if any) and visit multiple files. Wildcard expansion
825 can be suppressed by setting `find-file-wildcards'."
834 "Edit file FILENAME, in another window.
835 May create a new window, or reuse an existing one.
836 See the function `display-buffer'.
838 Interactively, the default if you just type RET is the current directory,
839 but the visited file name is available through the minibuffer history:
840 type M-n to pull it into the minibuffer.
842 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
843 expand wildcards (if any) and visit multiple files."
854 "Edit file FILENAME, in another frame.
855 May create a new frame, or reuse an existing one.
856 See the function `display-buffer'.
858 Interactively, the default if you just type RET is the current directory,
859 but the visited file name is available through the minibuffer history:
860 type M-n to pull it into the minibuffer.
862 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
863 expand wildcards (if any) and visit multiple files."
874 "Edit file FILENAME but don't allow changes.
883 "Edit file FILENAME in another window but don't allow changes.
892 "Edit file FILENAME in another frame but don't allow changes.
901 "Find file FILENAME as a replacement for the file in the next window.
902 This command does not select that window."
921 "Find file FILENAME, select its buffer, kill previous buffer.
922 If the current buffer now contains an empty file that you just visited
923 \(presumably by mistake), use this command to visit the file you really want."
957 ;; This executes if find-file gets an error
958 ;; and does not really find anything.
959 ;; We put things back as they were.
960 ;; If find-file actually finds something, we kill obuf below.
968 ;; We already asked; don't ask again.
971 \f
973 "Create a suitably named buffer for visiting FILENAME, and return it.
974 FILENAME (sans directory) is used unchanged if that name is free;
975 otherwise a string <2> or <3> or ... is appended to get an unused name."
982 "Create and return a buffer with a name based on NAME.
983 Choose the buffer's name using `generate-new-buffer-name'."
987 "Regexp to match the automounter prefix in a directory name."
995 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
998 ;; Get rid of the prefixes added by the automounter.
1005 ;; If any elt of directory-abbrev-alist matches this name,
1006 ;; abbreviate accordingly.
1012 ;; Compute and save the abbreviated homedir name.
1013 ;; We defer computing this until the first time it's needed, to
1014 ;; give time for directory-abbrev-alist to be set properly.
1015 ;; We include a slash at the end, to avoid spurious matches
1016 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1023 ;; If FILENAME starts with the abbreviated homedir,
1024 ;; make it start with `~' instead.
1026 ;; If the home dir is just /, don't change it.
1029 ;; MS-DOS root directories can come with a drive letter;
1030 ;; Novell Netware allows drive letters beyond `Z:'.
1039 filename))
1042 "*List of logical names for which visiting shouldn't save the true dirname.
1043 On VMS, when you visit a file using a logical name that searches a path,
1044 you may or may not want the visited file name to record the specific
1045 directory where the file was found. If you *do not* want that, add the logical
1046 name to this list as a string."
1051 "Return the buffer visiting file FILENAME (a string).
1052 This is like `get-file-buffer', except that it checks for any buffer
1053 visiting the same file, possibly under a different name.
1054 If there is no such live buffer, return nil."
1066 found)
1071 number
1076 ;; Verify this buffer's file number
1077 ;; still belongs to its file.
1080 attributes))
1083 found))))
1084 \f
1086 "*Non-nil means file-visiting commands should handle wildcards.
1087 For example, if you specify `*.c', that would visit all the files
1088 whose names match the pattern."
1094 "*Non-nil means suppress warning messages for symlinked files.
1095 When nil, Emacs prints a warning when visiting a file that is already
1096 visited, but with a different name. Setting this option to t
1097 suppresses this warning."
1103 "Read file FILENAME into a buffer and return the buffer.
1104 If a buffer exists visiting FILENAME, return that one, but
1105 verify that the file has not changed since visited or saved.
1106 The buffer is not selected, just returned to the caller.
1107 Optional first arg NOWARN non-nil means suppress any warning messages.
1108 Optional second arg RAWFILE non-nil means the file is read literally.
1109 Optional third arg WILDCARDS non-nil means do wildcard processing
1110 and visit all the matching files. When wildcards are actually
1111 used and expanded, the value is a list of buffers
1112 that are visiting the various files."
1119 'find-directory-functions
1122 filename)))
1125 find-file-wildcards
1138 ;; Find any buffer for a file which has same truename.
1140 ;; Let user know if there is a buffer with the same truename.
1144 find-file-suppress-same-file-warnings
1148 ;; Optionally also find that buffer.
1152 ;; We are using an existing buffer.
1158 ;; Certain files should be reverted automatically
1159 ;; if they have changed on disk and not in the buffer.
1167 found))
1177 "File %s changed on disk. Discard your edits? "
1182 "File %s changed on disk. Discard your edits in %s? "
1190 ;; Check if a formerly read-only file has become
1191 ;; writable and vice versa, but if the buffer agrees
1192 ;; with the new state of the file, that is ok too.
1199 buffer-file-name
1207 ;; It is confusing to ask whether to visit
1208 ;; non-literally if they have the file in
1209 ;; hexl-mode.
1213 "Save file and revisit literally? "
1218 rawfile truename number))
1220 "Discard your edits and revisit file literally? "
1223 rawfile truename number)
1227 "Revisit file literally? "
1230 rawfile truename number)
1233 ;; Return the buffer we are using.
1234 buf)
1235 ;; Create a new buffer.
1238 ;; find-file-noselect-1 may use a different buffer.
1240 rawfile truename number))))))
1244 error)
1247 ;; Needed in case we are re-visiting the file with a different
1248 ;; text representation.
1262 filename)))
1263 ;; Unconditionally set error
1272 filename)))
1273 ;; Run find-file-not-found-hooks until one returns non-nil.
1275 ;; If they fail too, set error.
1277 ;; Record the file's truename, and maybe use that as visited name.
1283 ;; On VMS, we may want to remember which directory in a search list
1284 ;; the file was found in.
1296 ;; Set buffer's default directory to that of the file.
1298 ;; Turn off backup files for certain file names. Since
1299 ;; this is a permanent local, the major mode won't eliminate it.
1312 \f
1314 "Like `insert-file-contents', but only reads in the file literally.
1315 A buffer may be modified in several ways after reading into the buffer,
1316 to Emacs features such as format decoding, character code
1317 conversion, `find-file-hook', automatic uncompression, etc.
1319 This function ensures that none of these modifications will take place."
1327 nil))
1339 "Insert contents of file FILENAME into buffer after point with no conversion.
1341 This function is meant for the user to run interactively.
1342 Don't call it from programs! Use `insert-file-contents-literally' instead.
1343 \(Its calling sequence is different; see its documentation)."
1347 filename)))
1352 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1357 "Visit file FILENAME with no conversion of any kind.
1358 Format conversion and character code conversion are both disabled,
1359 and multibyte characters are disabled in the resulting buffer.
1360 The major mode used is Fundamental mode regardless of the file name,
1361 and local variable specifications in the file are ignored.
1362 Automatic uncompression and adding a newline at the end of the
1363 file due to `require-final-newline' is also disabled.
1365 You cannot absolutely rely on this function to result in
1366 visiting the file literally. If Emacs already has a buffer
1367 which is visiting the file, you get the existing buffer,
1368 regardless of whether it was created literally or not.
1370 In a Lisp program, if you want to be sure of accessing a file's
1371 contents literally, you should create a temporary buffer and then read
1372 the file contents into it using `insert-file-contents-literally'."
1375 \f
1379 after-find-file-from-revert-buffer
1380 nomodes)
1381 "Called after finding a file and by the default revert function.
1382 Sets buffer mode, parses local variables.
1383 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1384 error in reading the file. WARN non-nil means warn if there
1385 exists an auto-save file more recent than the visited file.
1386 NOAUTO means don't mess with auto-save mode.
1387 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1388 means this call was from `revert-buffer'.
1389 Fifth arg NOMODES non-nil means don't alter the file's modes.
1390 Finishes by calling the functions in `find-file-hook'
1391 unless NOMODES is non-nil."
1394 nil
1404 ;; No need to warn if buffer is auto-saved
1405 ;; under the name of the visited file.
1407 auto-save-visited-file-name))
1410 buffer-file-name))
1424 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1425 "Use M-x make-directory RET RET to create the directory"
1432 ;; Make people do a little extra work (C-x C-q)
1433 ;; before altering a backup file.
1436 ;; When a file is marked read-only,
1437 ;; make the buffer read-only even if root is looking at it.
1446 view-read-only
1452 "Choose the major mode for this buffer automatically.
1453 Also sets up any specified local variables of the file.
1454 Uses the visited file name, the -*- line, and the local variables spec.
1456 This function is called automatically from `find-file'. In that case,
1457 we may set up the file-specified mode and local variables,
1458 depending on the value of `enable-local-variables': if it is t, we do;
1459 if it is nil, we don't; otherwise, we query.
1460 In addition, if `local-enable-local-variables' is nil, we do
1461 not set local variables (though we do notice a mode specified with -*-.)
1463 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1464 or from Lisp without specifying the optional argument FIND-FILE;
1465 in that case, this function acts as if `enable-local-variables' were t."
1474 enable-local-variables)))
1516 ;; Less common extensions come here
1517 ;; so more common ones above are found faster.
1527 ;; for MSDOS and MS-Windows (which are case-insensitive)
1575 ;; Mailer puts message to be edited in
1576 ;; /tmp/Re.... or Message
1581 ;; some news reader is reported to use this
1591 ;; .emacs or .gnus or .viper following a directory delimiter in
1592 ;; Unix, MSDOG or VMS syntax.
1595 ;; _emacs following a directory delimiter
1596 ;; in MsDos syntax
1609 ;; Get rid of any trailing .n.m and try again.
1610 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1611 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1612 ;; Using mode nil rather than `ignore' would let the search continue
1613 ;; through this list (with the shortened name) rather than start over.
1615 ;; The following should come after the ChangeLog pattern
1616 ;; for the sake of ChangeLog.1, etc.
1617 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1621 "Alist of filename patterns vs corresponding major mode functions.
1622 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1623 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1624 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1625 mode function to use. FUNCTION will be called, unless it is nil.
1627 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1628 calling FUNCTION (if it's not nil), we delete the suffix that matched
1674 "Alist mapping interpreter names to major modes.
1675 This alist applies to files whose first line starts with `#!'.
1676 Each element looks like (INTERPRETER . MODE).
1677 The car of each element is compared with
1678 the name of the interpreter specified in the first line.
1685 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1686 When checking `inhibit-first-line-modes-regexps', we first discard
1692 "Regular expression matching interpreters, for file mode determination.
1693 This regular expression is matched against the first line of a file
1694 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1695 a mode from the file's name. If it matches, the file is assumed to
1696 be interpreted by the interpreter matched by the second group of the
1697 regular expression. The mode is then determined as the mode associated
1701 "Select major mode appropriate for current buffer.
1702 This checks for a -*- mode tag in the buffer's text,
1703 compares the filename against the entries in `auto-mode-alist',
1704 or checks the interpreter that runs this file against
1705 `interpreter-mode-alist'.
1707 It does not check for the `mode:' local variable in the
1708 Local Variables section of the file; for that, use `hack-local-variables'.
1710 If `enable-local-variables' is nil, this function does not check for a
1711 -*- mode tag.
1713 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1714 then we do not set anything but the major mode,
1715 and we don't even do that unless it would come from the file name."
1716 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1724 ;; Find all specifications for the `mode:' variable
1725 ;; and execute them left to right.
1737 modes)))
1738 ;; Simple -*-MODE-*- case.
1741 modes))))
1742 ;; If we found modes to use, invoke them now,
1743 ;; outside the save-excursion.
1750 ;; If we didn't find a mode from a -*- line, try using the file name.
1754 ;; Remove backup-suffixes from file name.
1760 ;; Find first matching alist entry.
1769 keep-going t)
1771 keep-going nil)))
1774 ;; When JUST-FROM-FILE-NAME is set,
1775 ;; we are working on behalf of set-visited-file-name.
1776 ;; In that case, if the major mode specified is the
1777 ;; same one we already have, don't actually reset it.
1778 ;; We don't want to lose minor modes such as Font Lock.
1781 ;; If we can't deduce a mode from the file name,
1782 ;; look for an interpreter specified in the first line.
1783 ;; As a special case, allow for things like "#!/bin/env perl",
1784 ;; which finds the interpreter anywhere in $PATH.
1791 elt)
1792 ;; Map interpreter name to a mode.
1794 interpreter-mode-alist))
1801 "Find the -*- spec in the buffer.
1802 Call with point at the place to start searching from.
1803 If one is found, set point to the beginning
1804 and return the position of the end.
1805 Otherwise, return nil; point may be changed."
1808 ;; Don't look for -*- if this file name matches any
1809 ;; of the regexps in inhibit-first-line-modes-regexps.
1817 sufs)
1825 ;; If the file begins with "#!"
1826 ;; (exec interpreter magic), look
1827 ;; for mode frobs in the first two
1828 ;; lines. You cannot necessarily
1829 ;; put them in the first line of
1830 ;; such a file without screwing up
1831 ;; the interpreter invocation.
1839 t))
1845 end))))
1848 "Set local variables specified in the -*- line.
1849 Ignore any specification for `mode:' and `coding:';
1850 `set-auto-mode' should already have handled `mode:',
1851 `set-auto-coding' should already have handled `coding:'."
1858 ;; Parse the -*- line into the `result' alist.
1860 nil)
1862 ;; Simple form: "-*- MODENAME -*-". Already handled.
1863 nil)
1865 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1866 ;; (last ";" is optional).
1871 ;; There used to be a downcase here,
1872 ;; but the manual didn't say so,
1873 ;; and people want to set var names that aren't all lc.
1880 ;; It is traditional to ignore
1881 ;; case when checking for `mode' in set-auto-mode,
1882 ;; so we must do that here as well.
1883 ;; That is inconsistent, but we're stuck with it.
1884 ;; The same can be said for `coding' in set-auto-coding.
1898 ;; If we fail to switch in the selected window,
1899 ;; it is probably a minibuffer.
1900 ;; So try another window.
1913 "Normal hook run after processing a file's local variables specs.
1914 Major modes can use this to examine user-specified local variables
1918 "Parse and put into effect this buffer's local variables spec.
1919 If MODE-ONLY is non-nil, all we do is check whether the major mode
1920 is specified, returning t if it is specified."
1923 ;; Look for "Local variables:" line in last page.
1933 mode-only
1943 buffer-file-name)
1947 prefix prefixlen suffix beg
1948 mode-specified
1950 ;; The prefix is what comes before "local variables:" in its line.
1951 ;; The suffix is what comes after "local variables:" in its line.
1966 ;; Look at next local variable spec.
1969 ;; Skip the prefix, if any.
1974 ;; Find the variable name; strip whitespace.
1982 val)
1983 ;; Setting variable named "end" means end of list.
1986 ;; Otherwise read the variable value.
1997 ;; Set the variable. "Variables" mode and eval are funny.
2001 mode-specified))
2007 ;; Get confirmation before setting these variables as locals in a file.
2031 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2058 ;; This one is safe because the user gets to check it before it is used.
2063 Add expressions to this list if you want Emacs to evaluate them, when
2064 they appear in an `eval' local variable specification, without first
2065 asking you for confirmation."
2082 "Return t if it is safe to eval EXP when it is found in a file."
2084 ;; Detect certain `put' expressions.
2090 ;; Only allow safe values of lisp-indent-hook;
2091 ;; not functions.
2094 ;; Allow expressions that the user requested.
2096 ;; Certain functions can be allowed with safe arguments
2097 ;; or can specify verification functions to try.
2105 ok))
2113 ok)))))))
2117 A few patterns are specified so that any name which matches one
2118 is considered risky."
2123 ;; We have already handled coding: tag in set-auto-coding.
2124 nil)
2126 nil)
2127 ;; "Setting" eval means either eval it or do nothing.
2128 ;; Likewise for setting hook variables.
2131 (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$"
2134 ;; Permit evalling a put of a harmless property.
2135 ;; if the args do nothing tricky.
2138 ;; Permit eval if not root and user says ok.
2157 ;; Ordinary variable, really set it.
2159 ;; Make sure the string has no text properties.
2160 ;; Some text properties can get evaluated in various ways,
2161 ;; so it is risky to put them on with a local variable list.
2166 \f
2169 However, the mode will not be changed if
2170 \(1) a local variables list or the `-*-' line specifies a major mode, or
2172 \ not suitable for ordinary files, or
2173 \(3) the new file name does not particularly specify any mode."
2178 "Change name of file visited in current buffer to FILENAME.
2179 The next time the buffer is saved it will go in the newly specified file.
2180 nil or empty string as argument means make buffer not be visiting any file.
2181 Remember to delete the initial contents of the minibuffer
2182 if you wish to pass an empty string as the argument.
2184 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2185 confirmation in the case where another buffer is already visiting FILENAME.
2187 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2188 the old visited file has been renamed to the new name FILENAME."
2196 nil
2207 filename)))
2226 ;; Abbreviate the file names of the buffer.
2235 nil)))
2236 ;; write-file-functions is normally used for things like ftp-find-file
2237 ;; that visit things that are not local files as if they were files.
2238 ;; Changing to visit an ordinary local file instead should flush the hook.
2243 ;; If buffer was read-only because of version control,
2244 ;; that reason is gone now, so make it writable.
2248 ;; Turn off backup files for certain file names.
2249 ;; Since this is a permanent local, the major mode won't eliminate it.
2256 ;; If auto-save was not already on, turn it on if appropriate.
2260 ;; If auto save is on, start using a new name.
2261 ;; We deliberately don't rename or delete the old auto save
2262 ;; for the old visited file name. This is because perhaps
2263 ;; the user wants to save the new state and then compare with the
2264 ;; previous state from the auto save file.
2267 ;; Rename the old auto save file if any.
2274 ;; Update the major mode, if the file name determines it.
2276 ;; Don't change the mode if it is special.
2279 ;; Don't change the mode if the local variable list specifies it.
2285 "Write current buffer into file FILENAME.
2286 This makes the buffer visit that file, and marks it as not modified.
2288 If you specify just a directory name as FILENAME, that means to use
2289 the default file name but in that directory. You can also yank
2290 the default file name into the minibuffer to edit it, using M-n.
2292 If the buffer is not already visiting a file, the default file name
2293 for the output file is the buffer name.
2295 If optional second arg CONFIRM is non-nil, this function
2296 asks for confirmation before overwriting an existing file.
2297 Interactively, confirmation is required unless you supply a prefix argument."
2298 ;; (interactive "FWrite file: ")
2302 nil nil nil nil)
2306 default-directory)
2307 nil nil))
2311 ;; If arg is just a directory,
2312 ;; use the default file name, but in that directory.
2323 ;; Make buffer writable if file is writable.
2328 \f
2330 "Make a backup of the disk file visited by the current buffer, if appropriate.
2331 This is normally done before saving the buffer the first time.
2333 A backup may be done by renaming or by copying; see documentation of
2334 variable `make-backup-files'. If it's done by renaming, then the file is
2335 no longer accessible under its old name.
2337 The value is non-nil after a backup was made by renaming.
2338 It has the form (MODES . BACKUPNAME).
2339 MODES is the result of `file-modes' on the original
2340 file; this means that the caller, after saving the buffer, should change
2341 the modes of the new file to agree with the old modes.
2342 BACKUPNAME is the backup file name, which is the old file renamed."
2349 backup-info backupname targets setmodes)
2350 ;; If specified name is a symbolic link, chase it to the target.
2351 ;; Thus we make the backups in the directory where the real file is.
2356 ;; (if (file-directory-p buffer-file-name)
2357 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2361 ;; If have old versions to maybe delete,
2362 ;; ask the user to confirm now, before doing anything.
2363 ;; But don't actually delete til later.
2368 real-file-name))))))
2369 ;; Actually write the back up file.
2372 ; (file-symlink-p buffer-file-name)
2373 backup-by-copying
2388 ;; If copying fails because file BACKUPNAME
2389 ;; is not writable, delete that file and try again.
2394 ;; rename-file should delete old backup.
2399 ;; If trouble writing the backup, write it in ~.
2409 ;; If copying fails because file BACKUPNAME
2410 ;; is not writable, delete that file and try again.
2416 ;; Now delete the old versions, if desired.
2423 setmodes)
2427 "Return file NAME sans backup versions or strings.
2428 This is a separate procedure so your site-init or startup file can
2429 redefine it.
2430 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2431 we do not remove backup version numbers, only true file version numbers."
2437 ;; VMS version number is (a) semicolon, optional
2438 ;; sign, zero or more digits or (b) period, option
2439 ;; sign, zero or more digits, provided this is the
2440 ;; second period encountered outside of the
2441 ;; device/directory part of the file name.
2444 name)
2454 "Return t if deleting FILE and rewriting it would preserve the owner."
2459 ;; Return t if the file doesn't exist, since it's true that no
2460 ;; information would be lost by an (attempted) delete and create.
2466 The extension, in a file name, is the part that follows the last `.',
2467 except that a leading `.', if any, doesn't count."
2470 directory)
2474 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2475 ;; we don't want to expand it.
2478 filename))))
2482 The extension, in a file name, is the part that follows the last `.',
2483 except that a leading `.', if any, doesn't count.
2484 Return nil for extensionless file names such as `foo'.
2485 Return the empty string for file names such as `foo.'.
2487 If PERIOD is non-nil, then the returned value includes the period
2488 that delimits the extension, and if FILENAME has no extension,
2499 "A function to use instead of the default `make-backup-file-name'.
2500 A value of nil gives the default `make-backup-file-name' behaviour.
2502 This could be buffer-local to do something special for specific
2503 files. If you define it, you may need to change `backup-file-name-p'
2504 and `file-name-sans-versions' too.
2506 See also `backup-directory-alist'."
2512 "Alist of filename patterns and backup directory names.
2513 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2514 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2515 relative or absolute. If it is absolute, so that all matching files
2516 are backed up into the same directory, the file names in this
2517 directory will be the full name of the file backed up with all
2518 directory separators changed to `!' to prevent clashes. This will not
2519 work correctly if your filesystem truncates the resulting name.
2521 For the common case of all backups going into one directory, the alist
2523 directory name.
2525 If this variable is nil, or it fails to match a filename, the backup
2526 is made in the original file's directory.
2528 On MS-DOS filesystems without long names this variable is always
2529 ignored."
2535 "Default `backup-enable-predicate' function.
2536 Checks for files in `temporary-file-directory' or
2537 `small-temporary-file-directory'."
2540 ;; Directory is under temporary-file-directory.
2545 0 nil
2547 ;; Directory is under small-temporary-file-directory.
2552 "Create the non-numeric backup file name for FILE.
2553 Normally this will just be the file's name with `~' appended.
2554 Customization hooks are provided as follows.
2556 If the variable `make-backup-file-name-function' is non-nil, its value
2557 should be a function which will be called with FILE as its argument;
2558 the resulting name is used.
2560 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2561 the documentation of that variable. If the directory for the backup
2562 doesn't exist, it is created."
2576 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2578 elt backup-directory failed)
2583 alist nil)))
2589 file
2593 ;; Normalize DOSish file names: downcase the drive
2594 ;; letter, if any, and replace the leading "x:" with
2595 ;; "/drive_x".
2598 ;; Replace any invalid file-name characters (for the
2599 ;; case of backing up remote files).
2603 "drive_"
2606 ""
2609 ;; Make the name unique by substituting directory
2610 ;; separators. It may not really be worth bothering about
2611 ;; doubling `!'s in the original name...
2616 backup-directory))
2623 "Return non-nil if FILE is a backup file name (numeric or not).
2624 This is a separate function so you can redefine it for customization.
2625 You may need to redefine `file-name-sans-versions' as well."
2630 ;; This is used in various files.
2631 ;; The usage of backup-extract-version-start is not very clean,
2632 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2634 "Given the name of a numeric backup file, FN, return the backup number.
2635 Uses the free variable `backup-extract-version-start', whose value should be
2636 the index in the name where the version number begins."
2642 ;; I believe there is no need to alter this behavior for VMS;
2643 ;; since backup files are not made on VMS, it should not get called.
2645 "Find a file name for a backup file FN, and suggestions for deletions.
2646 Value is a list whose car is the name for the backup file
2647 and whose cdr is a list of old versions to consider deleting now.
2648 If the value is nil, don't make a backup.
2649 Uses `backup-directory-alist' in the same way as does
2650 `make-backup-file-name'."
2652 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2656 ;; We don't support numbered backups on plain MS-DOS
2657 ;; when long file names are unavailable.
2667 possibilities deserve-versions-p versions)
2670 base-versions
2673 possibilities)
2674 #'<)
2679 kept-old-versions
2680 kept-new-versions
2687 ;; Delete nothing if there is overflow
2688 ;; in the number of versions to keep.
2694 v))))))))))
2697 "Return number of names file FILENAME has."
2701 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2702 This function returns a relative file name which is equivalent to FILENAME
2703 when used with that default directory as the default.
2704 If this is impossible (which can happen on MSDOS and Windows
2705 when the file name and directory use different drive names)
2706 then it returns FILENAME."
2711 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2712 ;; drive names, they can't be relative, so return the absolute name.
2717 filename
2724 ".."
2726 ;; Now ancestor is empty, or .., or ../.., etc.
2728 ;; We matched within FNAME's directory part.
2729 ;; Add the rest of FNAME onto ANCESTOR.
2733 ;; But don't bother with ANCESTOR if it would give us `./'.
2734 rest
2736 ;; We matched FNAME's directory equivalent.
2737 ancestor))))))
2738 \f
2740 "Save current buffer in visited file if modified. Versions described below.
2741 By default, makes the previous version into a backup file
2742 if previously requested or if this is the first save.
2744 to become a backup when the next save is done.
2746 unconditionally makes the previous version into a backup file.
2748 to become a backup when the next save is done,
2749 and unconditionally makes the previous version into a backup file.
2751 With argument of 0, never make the previous version into a backup file.
2753 If a file's name is FOO, the names of its numbered backup versions are
2754 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2755 Numeric backups (rather than FOO~) will be made if value of
2756 `version-control' is not the atom `never' and either there are already
2757 numeric versions of the file being backed up, or `version-control' is
2758 non-nil.
2759 We don't want excessive versions piling up, so there are variables
2760 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2761 and `kept-new-versions', which tells how many newest versions to keep.
2762 Defaults are 2 old versions and 2 new.
2763 `dired-kept-versions' controls dired's clean-directory (.) command.
2764 If `delete-old-versions' is nil, system will query user
2765 before trimming versions. Otherwise it does it silently.
2767 If `vc-make-backup-files' is nil, which is the default,
2768 no backup files are made for files managed by version control.
2769 (This is because the version control system itself records previous versions.)
2771 See the subroutine `basic-save-buffer' for more information."
2784 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2785 Normally delete only if the file was written by this Emacs since
2786 the last real save, but optional arg FORCE non-nil means delete anyway."
2800 "Normal hook that is run after a buffer is saved to its file."
2806 "If non-nil, use this coding system for saving the buffer.
2807 More precisely, use this coding system in place of the
2808 value of `buffer-file-coding-system', when saving the buffer.
2809 Calling `write-region' for any purpose other than saving the buffer
2810 will still use `buffer-file-coding-system'; this variable has no effect
2817 "Save the current buffer in its visited file, if it has been modified.
2818 The hooks `write-contents-functions' and `write-file-functions' get a chance
2819 to do the job of saving; if they do not, then the buffer is saved in
2820 the visited file file in the usual way.
2821 After saving the buffer, this function runs `after-save-hook'."
2824 ;; In an indirect buffer, save its base buffer instead.
2829 setmodes tempsetmodes)
2830 ;; On VMS, rename file and buffer to get rid of version number.
2835 ;; Strip VMS version number before save.
2838 ;; Construct a (unique) buffer name to correspond.
2843 ;; If buffer has no file name, ask user for one.
2850 filename))
2875 ;; Support VC version backups.
2880 ;; If a hook returned t, file is already "written".
2881 ;; Otherwise, write it the usual way now.
2883 ;; Now we have saved the current buffer. Let's make sure
2884 ;; that buffer-file-coding-system is fixed to what
2885 ;; actually used for saving by binding it locally.
2895 ;; If the auto-save file was recent before this command,
2896 ;; delete it now.
2898 ;; Support VC `implicit' locking.
2903 ;; This does the "real job" of writing a buffer into its visited file
2904 ;; and making a backup file. This is what is normally done
2905 ;; but inhibited if one of write-file-functions returns non-nil.
2906 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
2913 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
2927 buffer-file-name)))
2935 ;; If file is precious, write temp name, then rename it.
2936 ;; This requires write access to the containing dir,
2937 ;; which is why we don't try it if we don't have that access.
2939 tempname temp nogood i succeed
2943 ;; Find the temporary name to write under.
2950 "%s$tmp$%d"
2952 dir i))
2958 tempname nil realname
2959 buffer-file-truename)
2961 ;; If writing the temp file fails,
2962 ;; delete the temp file.
2969 ;; Since we have created an entirely new file
2970 ;; and renamed it, make sure it gets the
2971 ;; right permission bits set.
2973 buffer-file-name)))
2974 ;; We succeeded in writing the temp file,
2975 ;; so rename it.
2977 ;; If file not writable, see if we can make it writable
2978 ;; temporarily while we write it.
2979 ;; But no need to do so if we have just backed it up
2980 ;; (setmodes is set) because that says we're superseding.
2982 ;; Change the mode back, after writing.
2989 buffer-file-name nil t buffer-file-truename)
2991 ;; If we get an error writing the new file, and we made
2992 ;; the backup by renaming, undo the backing-up.
2995 setmodes))
2998 "View the differences between BUFFER and its associated file.
2999 This requires the external program `diff' to be in your `exec-path'."
3014 ;; Display that message for 1 second so that user can read it
3015 ;; in the minibuffer.
3017 ;; return always nil, so that save-buffers-kill-emacs will not move
3018 ;; over to the next unsaved buffer when calling `d'.
3019 nil)
3022 '((?\C-r
3028 ;; Return nil to ask about BUF again.
3029 nil)
3031 (?d diff-buffer-with-file
3037 "Save some modified file-visiting buffers. Asks user about each one.
3038 You can answer `y' to save, `n' not to save, `C-r' to look at the
3039 buffer in question with `view-buffer' before deciding or `d' to
3040 view the differences using `diff-buffer-to-file'.
3042 Optional argument (the prefix) non-nil means save all with no questions.
3043 Optional second argument PRED determines which buffers are considered:
3044 If PRED is nil, all the file-visiting buffers are considered.
3045 If PRED is t, then certain non-file buffers will also be considered.
3046 If PRED is a zero-argument function, it indicates for each buffer whether
3047 to consider it or not when called with that buffer current.
3049 See `save-some-buffers-action-alist' if you want to
3050 change the additional actions you can take on files."
3069 t
3082 save-some-buffers-action-alist))
3089 abbrev-file-name)))
3091 ;; Don't keep bothering user if he says no.
3093 t))))
3096 \f
3098 "Mark current buffer as unmodified, not needing to be saved.
3101 It is not a good idea to use this function in Lisp programs, because it
3102 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3109 "Change whether this buffer is visiting its file read-only.
3110 With arg, set read-only iff arg is positive.
3111 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3116 nil ; do nothing.
3117 ;; Toggle.
3134 "Insert contents of file FILENAME into buffer after point.
3135 Set mark after the inserted text.
3137 This function is meant for the user to run interactively.
3138 Don't call it from programs! Use `insert-file-contents' instead.
3139 \(Its calling sequence is different; see its documentation)."
3143 filename)))
3148 "Append the contents of the region to the end of file FILENAME.
3149 When called from a function, expects three arguments,
3150 START, END and FILENAME. START and END are buffer positions
3151 saying what text to write."
3156 "Return most recent backup file for FILENAME or nil if no backups exist."
3157 ;; `make-backup-file-name' will get us the right directory for
3158 ;; ordinary or numeric backups. It might create a directory for
3159 ;; backups as a side-effect, according to `backup-directory-alist'.
3166 tem)
3175 newest))
3178 "Rename current buffer to a similar name not already taken.
3179 This function is useful for creating multiple shell process buffers
3180 or multiple mail buffers, etc."
3188 ;; If the existing buffer name has a <NNN>,
3189 ;; which isn't part of the file name (if any),
3190 ;; then get rid of that.
3196 "Create the directory DIR and any nonexistent parent dirs.
3197 Interactively, the default choice of directory to create
3198 is the current default directory for file names.
3199 That is useful when you have visited a file in a nonexistent directory.
3201 Noninteractively, the second (optional) argument PARENTS says whether
3202 to create parent directories if they don't exist."
3205 nil nil)
3206 t))
3207 ;; If default-directory is a remote directory,
3208 ;; make sure we find its make-directory handler.
3216 create-list)
3223 \f
3226 "Function to use to revert this buffer, or nil to do the default.
3227 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3232 "Function to use to insert contents when reverting this buffer.
3233 Gets two args, first the nominal file name to use,
3234 and second, t if reading the auto-save file.
3239 "Normal hook for `revert-buffer' to run before reverting.
3240 If `revert-buffer-function' is used to override the normal revert
3244 "Normal hook for `revert-buffer' to run after reverting.
3245 Note that the hook value that it runs is the value that was in effect
3246 before reverting; that makes a difference if you have buffer-local
3247 hook functions.
3249 If `revert-buffer-function' is used to override the normal revert
3255 "Replace current buffer text with the text of the visited file on disk.
3256 This undoes all changes since the file was visited or saved.
3257 With a prefix argument, offer to revert from latest auto-save file, if
3258 that is more recent than the visited file.
3260 This command also works for special buffers that contain text which
3261 doesn't come from a file, but reflects some other data base instead:
3262 for example, Dired buffers and buffer-list buffers. In these cases,
3263 it reconstructs the buffer contents from the appropriate data base.
3265 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3266 to revert from the auto-save file when this is nil. Note that the
3267 sense of this argument is the reverse of the prefix argument, for the
3268 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3269 to nil.
3271 Optional second argument NOCONFIRM means don't ask for confirmation at
3272 all. (The local variable `revert-without-query', if non-nil, prevents
3273 confirmation.)
3275 Optional third argument PRESERVE-MODES non-nil means don't alter
3276 the files modes. Normally we reinitialize them using `normal-mode'.
3278 If the value of `revert-buffer-function' is non-nil, it is called to
3279 do all the work for this command. Otherwise, the hooks
3280 `before-revert-hook' and `after-revert-hook' are run at the beginning
3281 and the end, and if `revert-buffer-insert-file-contents-function' is
3282 non-nil, it is called instead of rereading visited file contents."
3284 ;; I admit it's odd to reverse the sense of the prefix argument, but
3285 ;; there is a lot of code out there which assumes that the first
3286 ;; argument should be t to avoid consulting the auto-save file, and
3287 ;; there's no straightforward way to encourage authors to notice a
3288 ;; reversal of the argument sense. So I'm just changing the user
3289 ;; interface, but leaving the programmatic interface the same.
3295 buffer-auto-save-file-name
3300 buffer-auto-save-file-name
3301 buffer-file-name)))
3312 found))
3314 file-name)))
3316 ;; If file was backed up but has changed since,
3317 ;; we shd make another backup.
3321 ;; Get rid of all undo records for this buffer.
3324 ;; Effectively copy the after-revert-hook status,
3325 ;; since after-find-file will clobber it.
3329 after-revert-hook)))
3331 ;; Don't make undo records for the reversion.
3335 file-name auto-save-p)
3338 ;; Bind buffer-file-name to nil
3339 ;; so that we don't try to lock the file.
3345 ;; Auto-saved file shoule be read without
3346 ;; any code conversion.
3349 buffer-file-coding-system))))
3350 ;; This force
3351 ;; after-insert-file-set-buffer-file-coding-system
3352 ;; (called from insert-file-contents) to set
3353 ;; buffer-file-coding-system to a proper value.
3356 ;; Note that this preserves point in an intelligent way.
3360 nil nil t))
3362 nil nil t)))))
3363 ;; Recompute the truename in case changes in symlinks
3364 ;; have changed the truename.
3368 ;; Run after-revert-hook as it was before we reverted.
3376 t)))))
3379 "Recover the visited file--get contents from its last auto-save file."
3384 "Visit file FILE, but get contents from its last auto-save file."
3385 ;; Actually putting the file name in the minibuffer should be used
3386 ;; only rarely.
3387 ;; Not just because users often use the default.
3406 ;; Use insert-directory-safely, not insert-directory,
3407 ;; because these files might not exist. In particular,
3408 ;; FILE might not exist if the auto-save file was for
3409 ;; a buffer that didn't visit a file, such as "*mail*".
3410 ;; The code in v20.x called `ls' directly, so we need
3411 ;; to emulate what `ls' did in that case.
3417 ;; Keep the current buffer-file-coding-system.
3419 ;; Auto-saved file shoule be read without any code conversion.
3428 "Recover auto save files from a previous Emacs session.
3429 This command first displays a Dired buffer showing you the
3430 previous sessions that you could recover from.
3431 To choose one, move point to the proper line and then type C-c C-c.
3432 Then you'll be asked about a number of files to recover."
3446 ;; Each line starts with a space
3447 ;; so that Font Lock mode won't highlight the first character.
3456 "Choose one saved session to recover auto-save files from.
3457 This command is used in the special Dired buffer created by
3460 ;; Get the name of the session file to recover from.
3462 files
3468 ;; Read in the auto-save-list file.
3472 ;; Loop thru the text of that file
3473 ;; and get out the names of the files to recover.
3477 ;; This is a pair of lines for a non-file-visiting buffer.
3478 ;; Get the auto-save file name and manufacture
3479 ;; a "visited file name" from that.
3495 ;; This pair of lines is a file-visiting
3496 ;; buffer. Use the visited file name.
3506 ;; Ignore a file if its auto-save file does not exist now.
3510 ;; The file contains a pair of line for each auto-saved buffer.
3511 ;; The first line of the pair contains the visited file name
3512 ;; or is empty if the buffer was not visiting a file.
3513 ;; The second line is the auto-save file name.
3521 files
3527 "For each buffer in LIST, ask whether to kill it.
3528 LIST defaults to all existing live buffers."
3539 name
3544 \f
3546 "Toggle auto-saving of contents of current buffer.
3547 With prefix argument ARG, turn auto-saving on if positive, else off."
3552 ;; If auto-save is off because buffer has shrunk,
3553 ;; then toggling should turn it on.
3558 buffer-file-name
3560 ;; If -1 was stored here, to temporarily turn off saving,
3561 ;; turn it back on.
3567 buffer-auto-save-file-name)
3570 "Adjust current buffer's auto save file name for current conditions.
3571 Also rename any existing auto save file, if it was made in this session."
3583 "Return file name to use for auto-saves of current buffer.
3584 Does not consider `auto-save-visited-file-name' as that variable is checked
3585 before calling this function. You can redefine this for customization.
3586 See also `auto-save-file-name-p'."
3590 result uniq)
3591 ;; Apply user-specified translations
3592 ;; to the file name.
3596 filename)
3606 filename))))
3611 ;; We truncate the file name to DOS 8+3 limits
3612 ;; before doing anything else, because the regexp
3613 ;; passed to string-match below cannot handle
3614 ;; extensions longer than 3 characters, multiple
3615 ;; dots, and other atrocities.
3620 fn)
3625 "#"
3628 ;; Make sure auto-save file names don't contain characters
3629 ;; invalid for the underlying filesystem.
3631 ;; Don't modify remote (ange-ftp) filenames
3634 result))
3636 ;; Deal with buffers that don't have any associated files. (Mail
3637 ;; mode tends to create a good number of these.)
3641 file-name)
3642 ;; Eliminate all slashes and backslashes by
3643 ;; replacing them with sequences that start with %.
3644 ;; Quote % also, to keep distinct names distinct.
3653 ;; Generate the file name.
3659 ;; Try a few alternative directories, to get one we can
3660 ;; write it.
3666 ;; Don't modify remote (ange-ftp) filenames
3668 ;; The call to convert-standard-filename is in case
3669 ;; buffer-name includes characters not allowed by the
3670 ;; DOS/Windows filesystems. make-temp-file writes to the
3671 ;; file it creates, so we must fix the file name _before_
3672 ;; make-temp-file is called.
3674 fname))
3676 ;; make-temp-file creates the file,
3677 ;; but we don't want it to exist until we do an auto-save.
3681 file-name)))
3684 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3685 FILENAME should lack slashes. You can redefine this for customization."
3687 \f
3689 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3690 The generated regexp will match a filename iff the filename
3691 matches that wildcard according to shell rules. Only wildcards known
3692 by `sh' are supported."
3694 ;; Copy the initial run of non-special characters.
3697 ;; If no special characters, we're almost done.
3701 j)
3703 result
3724 ;; Found "[^". Insert a `\0' character
3725 ;; (which cannot happen in a filename)
3726 ;; into the character class, so that `^'
3727 ;; is not the first character after `[',
3728 ;; and thus non-special in a regexp.
3733 ;; I don't think `]' can appear in a
3734 ;; character class in a wildcard, but
3735 ;; let's be general here.
3742 i
3755 ;; Shell wildcards should match the entire filename,
3756 ;; not its part. Make the regexp say so.
3758 \f
3761 "*Switches for `list-directory' to pass to `ls' for brief listing."
3767 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3769 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3774 "Expand wildcard pattern PATTERN.
3775 This returns a list of file names which match the pattern.
3777 If PATTERN is written as an absolute relative file name,
3778 the values are absolute also.
3780 If PATTERN is written as a relative file name, it is interpreted
3781 relative to the current default directory, `default-directory'.
3782 The file names returned are normally also relative to the current
3783 default directory. However, if FULL is non-nil, they are absolute."
3787 ;; A list of all dirs that DIRPART specifies.
3788 ;; This can be more than one dir
3789 ;; if DIRPART contains wildcards.
3794 contents)
3799 ;; Filter out "." and ".."
3804 name))
3811 this-dir-contents)
3812 this-dir-contents)
3813 contents))))
3815 contents)))
3818 "Display a list of files in or matching DIRNAME, a la `ls'.
3819 DIRNAME is globbed by the shell if necessary.
3820 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3821 Actions controlled by variables `list-directory-brief-switches'
3822 and `list-directory-verbose-switches'."
3826 nil default-directory nil)
3827 pfx)))
3829 list-directory-brief-switches))
3830 buffer)
3843 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
3851 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3853 PATTERN is assumed to represent a file-name wildcard suitable for the
3854 underlying filesystem. For Unix and GNU/Linux, the characters from the
3856 the parts of the pattern which don't include wildcard characters are
3857 quoted with double quotes.
3858 Existing quote characters in PATTERN are left alone, so you can pass
3859 PATTERN that already quotes some of the special characters."
3863 ;; DOS/Windows don't allow `"' in file names. So if the
3864 ;; argument has quotes, we can safely assume it is already
3865 ;; quoted by the caller.
3867 ;; We quote [&()#$'] in case their shell is a port of a
3868 ;; Unixy shell. We quote [,=+] because stock DOS and
3869 ;; Windows shells require that in some cases, such as
3870 ;; passing arguments to batch files that use positional
3871 ;; arguments like %1.
3873 pattern
3876 end)
3893 pattern))))
3900 "*Program to get the amount of free space on a file system.
3901 We assume the output has the format of `df'.
3902 The value of this variable must be just a command name or file name;
3903 if you want to specify options, use `directory-free-space-args'.
3905 A value of nil disables this feature.
3907 If the function `file-system-info' is defined, it is always used in
3908 preference to the program given by this variable."
3914 "*Options to use when running `directory-free-space-program'."
3919 "Return the mount of free space on directory DIR's file system.
3920 The result is a string that gives the number of free 1KB blocks,
3921 or nil if the system call or the program which retrieve the infornmation
3922 fail.
3924 This function calls `file-system-info' if it is available, or invokes the
3925 program specified by `directory-free-space-program' if that is non-nil."
3926 ;; Try to find the number of free blocks. Non-Posix systems don't
3927 ;; always have df, but might have an equivalent system call.
3936 nil t nil
3937 directory-free-space-args
3938 dir)))
3939 ;; Usual format is a header line followed by a line of
3940 ;; numbers.
3945 ;; Move to the end of the "available blocks" number.
3948 ;; Copy it into AVAILABLE.
3954 ;; insert-directory
3955 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3956 ;; FULL-DIRECTORY-P is nil.
3957 ;; The single line of output must display FILE's name as it was
3958 ;; given, namely, an absolute path name.
3959 ;; - must insert exactly one line for each file if WILDCARD or
3960 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3961 ;; before the file lines, plus optional text after the file lines.
3962 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3963 ;; allowed.
3964 ;; File lines should display the basename.
3965 ;; - must be consistent with
3966 ;; - functions dired-move-to-filename, (these two define what a file line is)
3967 ;; dired-move-to-end-of-filename,
3968 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3969 ;; dired-insert-headerline
3970 ;; dired-after-subdir-garbage (defines what a "total" line is)
3971 ;; - variable dired-subdir-regexp
3972 ;; - may be passed "--dired" as the first argument in SWITCHES.
3973 ;; Filename handlers might have to remove this switch if their
3974 ;; "ls" command does not support it.
3976 "Insert directory listing for FILE, formatted according to SWITCHES.
3977 Leaves point after the inserted text.
3978 SWITCHES may be a string of options, or a list of strings.
3979 Optional third arg WILDCARD means treat FILE as shell wildcard.
3980 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3981 switches do not contain `d', so that a full listing is expected.
3983 This works by running a directory listing program
3984 whose name is in the variable `insert-directory-program'.
3985 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3986 ;; We need the directory in order to find the right handler.
3991 wildcard full-directory-p)
3996 ;; Read the actual directory using `insert-directory-program'.
3997 ;; RESULT gets the status code.
4001 default-file-name-coding-system)))
4002 ;; This is to control encoding the arguments in call-process.
4006 ;; Run ls in the directory part of the file pattern
4007 ;; using the last component as argument.
4014 shell-file-name nil t nil
4015 "-c"
4017 ""
4019 insert-directory-program
4020 " -d "
4022 switches
4024 " -- "
4025 ;; Quote some characters that have
4026 ;; special meanings in shells; but
4027 ;; don't quote the wildcards--we want
4028 ;; them to be special. We also
4029 ;; currently don't quote the quoting
4030 ;; characters in case people want to
4031 ;; use them explicitly to quote
4032 ;; wildcard characters.
4034 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4035 ;; directory if FILE is a symbolic link.
4037 insert-directory-program nil t nil
4041 ;; Split the switches at any spaces so we can
4042 ;; pass separate options as separate args.
4044 ;; Avoid lossage if FILE starts with `-'.
4052 file))))))))
4054 ;; If `insert-directory-program' failed, signal an error.
4056 ;; On non-Posix systems, we cannot open a directory, so
4057 ;; don't even try, because that will always result in
4058 ;; the ubiquitous "Access denied". Instead, show the
4059 ;; command line so the user can try to guess what went wrong.
4064 insert-directory-program
4066 file result)
4067 ;; Unix. Access the file to get a suitable error.
4084 ;; Try to insert the amount of free space.
4087 ;; First find the line to put it on.
4091 ;; Replace "total" with "used", to avoid confusion.
4098 "Insert directory listing for FILE, formatted according to SWITCHES.
4100 Like `insert-directory', but if FILE does not exist, it inserts a
4101 message to that effect instead of signaling an error."
4104 ;; Simulate the message printed by `ls'.
4108 "Functions to call with no arguments to query about killing Emacs.
4109 If any of these functions returns nil, killing Emacs is cancelled.
4111 but `kill-emacs', the low level primitive, does not.
4115 "How to ask for confirmation when leaving Emacs.
4116 If nil, the default, don't ask at all. If the value is non-nil, it should
4117 be a predicate function such as `yes-or-no-p'."
4125 "Offer to save each buffer, then kill this Emacs process.
4126 With prefix arg, silently save all file-visiting buffers, then kill."
4135 ;; process-list is not defined on VMS.
4137 active)
4146 ;; Query the user for other things, perhaps.
4151 \f
4152 ;; We use /: as a prefix to "quote" a file name
4153 ;; so that magic file name handlers will not apply to it.
4157 file-name-handler-alist))
4159 ;; We depend on being the last handler on the list,
4160 ;; so that anything else which does need handling
4161 ;; has been handled already.
4162 ;; So it is safe for us to inhibit *all* magic file name handlers.
4171 default-directory))
4172 ;; Get a list of the indices of the args which are file names.
4175 ;; The first five are special because they
4176 ;; return a file name. We want to include the /:
4177 ;; in the return value.
4178 ;; So just avoid stripping it in the first place.
4184 ;; `identity' means just return the first arg
4185 ;; as stripped of its quoting.
4193 ;; For all other operations, treat the first argument only
4194 ;; as the file name.
4196 ;; Copy ARGUMENTS so we can replace elements in it.
4198 ;; Strip off the /: from the file names that have this handler.
4206 "/"
4212 \f
4236 ;;; files.el ends here