| blob | fc92d94825c62bd402114cd123d79b46b99a630b |
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)
474 "Read directory name, prompting with PROMPT and completing in directory DIR.
475 Value is not expanded---you must call `expand-file-name' yourself.
476 Default name to DEFAULT-DIRNAME if user enters a null string.
477 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
478 except that if INITIAL is specified, that combined with DIR is used.)
479 Fourth arg MUSTMATCH non-nil means require existing directory's name.
480 Non-nil and non-t means also require confirmation after completion.
481 Fifth arg INITIAL specifies text to start with.
482 DIR defaults to current buffer's directory default."
491 \f
493 "Show the current default directory."
498 "Value of the CDPATH environment variable, as a list.
502 "Explode a colon-separated search path into a list of directory names.
503 \(For values of `colon' equal to `path-separator'.)"
504 ;; We could use split-string here.
512 nil
517 cd-list)))
520 "Change current directory to given absolute file name DIR."
521 ;; Put the name into directory syntax now,
522 ;; because otherwise expand-file-name may give some bad results.
535 "Make DIR become the current buffer's default directory.
536 If your environment includes a `CDPATH' variable, try each one of that
537 colon-separated list of directories when resolving a relative directory name."
540 default-directory default-directory
556 cd-path)
557 nil))
561 "Load the Lisp file named FILE."
562 ;; This is a case where .elc makes a lot of sense.
569 "Search for FILENAME through PATH.
570 If SUFFIXES is non-nil, it should be a list of suffixes to append to
572 If non-nil, PREDICATE is used instead of `file-readable-p'.
573 PREDICATE can also be an integer to pass to the `access' system call,
574 in which case file-name handlers are ignored. This usage is deprecated.
576 For compatibility, PREDICATE can also be one of the symbols
577 `executable', `readable', `writable', or `exists', or a list of
578 one or more of those symbols."
589 "Do completion for file names passed to `locate-file'.
590 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
610 "Load the library named LIBRARY.
611 This is an interface to the function `load'."
614 'locate-file-completion
619 "Copy the file FILE into a temporary file on this machine.
620 Returns the name of the local copy, or nil, if FILE is directly
621 accessible."
622 ;; This formerly had an optional BUFFER argument that wasn't used by
623 ;; anything.
627 nil)))
630 "Return the truename of FILENAME, which should be absolute.
631 The truename of a file name is found by chasing symbolic links
632 both at the level of the file and at the level of the directories
633 containing it, until no links are left at any level.
635 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
636 Do not specify them in other calls."
637 ;; COUNTER can be a cons cell whose car is the count of how many more links
638 ;; to chase before getting an error.
639 ;; PREV-DIRS can be a cons cell whose car is an alist
640 ;; of truenames we've just recently computed.
642 ;; The last test looks dubious, maybe `+' is meant here? --simon.
652 ;; For speed, remove the ange-ftp completion handler from the list.
653 ;; We know it's not needed here.
654 ;; For even more speed, do this only on the outermost call.
661 ;; andrewi@harlequin.co.uk - none of the following code (except for
662 ;; invoking the file-name handler) currently applies on Windows
663 ;; (ie. there are no native symlinks), but there is an issue with
664 ;; case differences being ignored by the OS, and short "8.3 DOS"
665 ;; name aliases existing for all files. (The short names are not
666 ;; reported by directory-files, but can be used to refer to files.)
667 ;; It seems appropriate for file-truename to resolve these issues in
668 ;; the most natural way, which on Windows is to call the function
669 ;; `w32-long-file-name' - this returns the exact name of a file as
670 ;; it is stored on disk (expanding short name aliases with the full
671 ;; name in the process).
674 newname)
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 ;; If filename contains a wildcard, newname will be the old name.
682 ;; If filename doesn't exist, newname will be nil.
687 ;; If this file directly leads to a link, process that iteratively
688 ;; so that we don't use lots of stack.
694 ;; For file name that has a special handler, call handler.
695 ;; This is so that ange-ftp can save time by doing a no-op.
698 done t)
700 target dirfile)
701 ;; Get the truename of the directory.
703 ;; If these are equal, we have the (or a) root directory.
705 ;; If this is the same dir we last got the truename for,
706 ;; save time--don't recalculate.
716 done t)
719 done t)
720 ;; Put it back on the file name.
722 ;; Is the file name the name of a link?
725 ;; Yes => chase that link, then start all over
726 ;; since the link may point to a directory name that uses links.
727 ;; We can't safely use expand-file-name here
728 ;; since target might look like foo/../bar where foo
729 ;; is itself a link. Instead, we handle . and .. above.
732 target
734 done nil)
735 ;; No, we are done!
737 filename))
740 "Chase links in FILENAME until a name that is not a link.
741 Does not examine containing directories for links,
742 unlike `file-truename'."
748 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
751 ;; Handle `..' by hand, since it needs to work in the
752 ;; target of any directory symlink.
753 ;; This code is not quite complete; it does not handle
754 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
758 ;; Chase links in the default dir of the symlink.
762 ;; Now find the parent of that dir.
766 newname))
767 \f
769 "Select buffer BUFFER in another window.
770 Optional second arg NORECORD non-nil means
771 do not put this buffer at the front of the list of recently selected ones.
773 This uses the function `display-buffer' as a subroutine; see its
774 documentation for additional customization information."
780 "Switch to buffer BUFFER in another frame.
781 Optional second arg NORECORD non-nil means
782 do not put this buffer at the front of the list of recently selected ones.
784 This uses the function `display-buffer' as a subroutine; see its
785 documentation for additional customization information."
801 ;; Clear out this hook so it does not interfere
802 ;; with any recursive minibuffer usage.
805 minibuffer-setup-hook))
808 current-prefix-arg))
811 "Edit file FILENAME.
812 Switch to a buffer visiting file FILENAME,
813 creating one if none already exists.
814 Interactively, the default if you just type RET is the current directory,
815 but the visited file name is available through the minibuffer history:
816 type M-n to pull it into the minibuffer.
818 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
819 expand wildcards (if any) and visit multiple files. Wildcard expansion
820 can be suppressed by setting `find-file-wildcards'."
829 "Edit file FILENAME, in another window.
830 May create a new window, or reuse an existing one.
831 See the function `display-buffer'.
833 Interactively, the default if you just type RET is the current directory,
834 but the visited file name is available through the minibuffer history:
835 type M-n to pull it into the minibuffer.
837 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
838 expand wildcards (if any) and visit multiple files."
849 "Edit file FILENAME, in another frame.
850 May create a new frame, or reuse an existing one.
851 See the function `display-buffer'.
853 Interactively, the default if you just type RET is the current directory,
854 but the visited file name is available through the minibuffer history:
855 type M-n to pull it into the minibuffer.
857 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
858 expand wildcards (if any) and visit multiple files."
869 "Edit file FILENAME but don't allow changes.
878 "Edit file FILENAME in another window but don't allow changes.
887 "Edit file FILENAME in another frame but don't allow changes.
896 "Find file FILENAME as a replacement for the file in the next window.
897 This command does not select that window."
916 "Find file FILENAME, select its buffer, kill previous buffer.
917 If the current buffer now contains an empty file that you just visited
918 \(presumably by mistake), use this command to visit the file you really want."
929 ;; (not buffer-read-only)
956 \f
958 "Create a suitably named buffer for visiting FILENAME, and return it.
959 FILENAME (sans directory) is used unchanged if that name is free;
960 otherwise a string <2> or <3> or ... is appended to get an unused name."
967 "Create and return a buffer with a name based on NAME.
968 Choose the buffer's name using `generate-new-buffer-name'."
972 "Regexp to match the automounter prefix in a directory name."
980 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
983 ;; Get rid of the prefixes added by the automounter.
990 ;; If any elt of directory-abbrev-alist matches this name,
991 ;; abbreviate accordingly.
997 ;; Compute and save the abbreviated homedir name.
998 ;; We defer computing this until the first time it's needed, to
999 ;; give time for directory-abbrev-alist to be set properly.
1000 ;; We include a slash at the end, to avoid spurious matches
1001 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1008 ;; If FILENAME starts with the abbreviated homedir,
1009 ;; make it start with `~' instead.
1011 ;; If the home dir is just /, don't change it.
1014 ;; MS-DOS root directories can come with a drive letter;
1015 ;; Novell Netware allows drive letters beyond `Z:'.
1024 filename))
1027 "*List of logical names for which visiting shouldn't save the true dirname.
1028 On VMS, when you visit a file using a logical name that searches a path,
1029 you may or may not want the visited file name to record the specific
1030 directory where the file was found. If you *do not* want that, add the logical
1031 name to this list as a string."
1036 "Return the buffer visiting file FILENAME (a string).
1037 This is like `get-file-buffer', except that it checks for any buffer
1038 visiting the same file, possibly under a different name.
1039 If there is no such live buffer, return nil."
1051 found)
1056 number
1061 ;; Verify this buffer's file number
1062 ;; still belongs to its file.
1065 attributes))
1068 found))))
1069 \f
1071 "*Non-nil means file-visiting commands should handle wildcards.
1072 For example, if you specify `*.c', that would visit all the files
1073 whose names match the pattern."
1079 "*Non-nil means suppress warning messages for symlinked files.
1080 When nil, Emacs prints a warning when visiting a file that is already
1081 visited, but with a different name. Setting this option to t
1082 suppresses this warning."
1088 "Read file FILENAME into a buffer and return the buffer.
1089 If a buffer exists visiting FILENAME, return that one, but
1090 verify that the file has not changed since visited or saved.
1091 The buffer is not selected, just returned to the caller.
1092 Optional first arg NOWARN non-nil means suppress any warning messages.
1093 Optional second arg RAWFILE non-nil means the file is read literally.
1094 Optional third arg WILDCARDS non-nil means do wildcard processing
1095 and visit all the matching files. When wildcards are actually
1096 used and expanded, the value is a list of buffers
1097 that are visiting the various files."
1104 'find-directory-functions
1107 filename)))
1110 find-file-wildcards
1123 ;; Find any buffer for a file which has same truename.
1125 ;; Let user know if there is a buffer with the same truename.
1129 find-file-suppress-same-file-warnings
1133 ;; Optionally also find that buffer.
1137 ;; We are using an existing buffer.
1143 ;; Certain files should be reverted automatically
1144 ;; if they have changed on disk and not in the buffer.
1152 found))
1162 "File %s changed on disk. Discard your edits? "
1167 "File %s changed on disk. Discard your edits in %s? "
1175 ;; Check if a formerly read-only file has become
1176 ;; writable and vice versa, but if the buffer agrees
1177 ;; with the new state of the file, that is ok too.
1184 buffer-file-name
1192 ;; It is confusing to ask whether to visit
1193 ;; non-literally if they have the file in
1194 ;; hexl-mode.
1198 "Save file and revisit literally? "
1203 rawfile truename number))
1205 "Discard your edits and revisit file literally? "
1208 rawfile truename number)
1212 "Revisit file literally? "
1215 rawfile truename number)
1218 ;; Return the buffer we are using.
1219 buf)
1220 ;; Create a new buffer.
1223 ;; find-file-noselect-1 may use a different buffer.
1225 rawfile truename number))))))
1229 error)
1232 ;; Needed in case we are re-visiting the file with a different
1233 ;; text representation.
1247 filename)))
1248 ;; Unconditionally set error
1257 filename)))
1258 ;; Run find-file-not-found-hooks until one returns non-nil.
1260 ;; If they fail too, set error.
1262 ;; Record the file's truename, and maybe use that as visited name.
1268 ;; On VMS, we may want to remember which directory in a search list
1269 ;; the file was found in.
1281 ;; Set buffer's default directory to that of the file.
1283 ;; Turn off backup files for certain file names. Since
1284 ;; this is a permanent local, the major mode won't eliminate it.
1297 \f
1299 "Like `insert-file-contents', but only reads in the file literally.
1300 A buffer may be modified in several ways after reading into the buffer,
1301 to Emacs features such as format decoding, character code
1302 conversion, `find-file-hooks', automatic uncompression, etc.
1304 This function ensures that none of these modifications will take place."
1312 nil))
1324 "Insert contents of file FILENAME into buffer after point with no conversion.
1326 This function is meant for the user to run interactively.
1327 Don't call it from programs! Use `insert-file-contents-literally' instead.
1328 \(Its calling sequence is different; see its documentation)."
1332 filename)))
1337 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1342 "Visit file FILENAME with no conversion of any kind.
1343 Format conversion and character code conversion are both disabled,
1344 and multibyte characters are disabled in the resulting buffer.
1345 The major mode used is Fundamental mode regardless of the file name,
1346 and local variable specifications in the file are ignored.
1347 Automatic uncompression and adding a newline at the end of the
1348 file due to `require-final-newline' is also disabled.
1350 You cannot absolutely rely on this function to result in
1351 visiting the file literally. If Emacs already has a buffer
1352 which is visiting the file, you get the existing buffer,
1353 regardless of whether it was created literally or not.
1355 In a Lisp program, if you want to be sure of accessing a file's
1356 contents literally, you should create a temporary buffer and then read
1357 the file contents into it using `insert-file-contents-literally'."
1360 \f
1364 after-find-file-from-revert-buffer
1365 nomodes)
1366 "Called after finding a file and by the default revert function.
1367 Sets buffer mode, parses local variables.
1368 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1369 error in reading the file. WARN non-nil means warn if there
1370 exists an auto-save file more recent than the visited file.
1371 NOAUTO means don't mess with auto-save mode.
1372 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1373 means this call was from `revert-buffer'.
1374 Fifth arg NOMODES non-nil means don't alter the file's modes.
1375 Finishes by calling the functions in `find-file-hooks'
1376 unless NOMODES is non-nil."
1379 nil
1389 ;; No need to warn if buffer is auto-saved
1390 ;; under the name of the visited file.
1392 auto-save-visited-file-name))
1395 buffer-file-name))
1409 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1410 "Use M-x make-directory RET RET to create the directory"
1417 ;; Make people do a little extra work (C-x C-q)
1418 ;; before altering a backup file.
1426 view-read-only
1432 "Choose the major mode for this buffer automatically.
1433 Also sets up any specified local variables of the file.
1434 Uses the visited file name, the -*- line, and the local variables spec.
1436 This function is called automatically from `find-file'. In that case,
1437 we may set up the file-specified mode and local variables,
1438 depending on the value of `enable-local-variables': if it is t, we do;
1439 if it is nil, we don't; otherwise, we query.
1440 In addition, if `local-enable-local-variables' is nil, we do
1441 not set local variables (though we do notice a mode specified with -*-.)
1443 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1444 or from Lisp without specifying the optional argument FIND-FILE;
1445 in that case, this function acts as if `enable-local-variables' were t."
1454 enable-local-variables)))
1496 ;; Less common extensions come here
1497 ;; so more common ones above are found faster.
1507 ;; for MSDOS and MS-Windows (which are case-insensitive)
1553 ;; Mailer puts message to be edited in
1554 ;; /tmp/Re.... or Message
1559 ;; some news reader is reported to use this
1569 ;; .emacs following a directory delimiter
1570 ;; in Unix, MSDOG or VMS syntax.
1573 ;; _emacs following a directory delimiter
1574 ;; in MsDos syntax
1587 ;; Get rid of any trailing .n.m and try again.
1588 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1589 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1590 ;; Using mode nil rather than `ignore' would let the search continue
1591 ;; through this list (with the shortened name) rather than start over.
1593 ;; The following should come after the ChangeLog pattern
1594 ;; for the sake of ChangeLog.1, etc.
1595 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1599 "Alist of filename patterns vs corresponding major mode functions.
1600 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1601 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1602 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1603 mode function to use. FUNCTION will be called, unless it is nil.
1605 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1606 calling FUNCTION (if it's not nil), we delete the suffix that matched
1652 "Alist mapping interpreter names to major modes.
1653 This alist applies to files whose first line starts with `#!'.
1654 Each element looks like (INTERPRETER . MODE).
1655 The car of each element is compared with
1656 the name of the interpreter specified in the first line.
1663 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1664 When checking `inhibit-first-line-modes-regexps', we first discard
1670 "Regular expression matching interpreters, for file mode determination.
1671 This regular expression is matched against the first line of a file
1672 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1673 a mode from the file's name. If it matches, the file is assumed to
1674 be interpreted by the interpreter matched by the second group of the
1675 regular expression. The mode is then determined as the mode associated
1679 "Select major mode appropriate for current buffer.
1680 This checks for a -*- mode tag in the buffer's text,
1681 compares the filename against the entries in `auto-mode-alist',
1682 or checks the interpreter that runs this file against
1683 `interpreter-mode-alist'.
1685 It does not check for the `mode:' local variable in the
1686 Local Variables section of the file; for that, use `hack-local-variables'.
1688 If `enable-local-variables' is nil, this function does not check for a
1689 -*- mode tag.
1691 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1692 then we do not set anything but the major mode,
1693 and we don't even do that unless it would come from the file name."
1694 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1702 ;; Find all specifications for the `mode:' variable
1703 ;; and execute them left to right.
1715 modes)))
1716 ;; Simple -*-MODE-*- case.
1719 modes))))
1720 ;; If we found modes to use, invoke them now,
1721 ;; outside the save-excursion.
1728 ;; If we didn't find a mode from a -*- line, try using the file name.
1732 ;; Remove backup-suffixes from file name.
1738 ;; Find first matching alist entry.
1747 keep-going t)
1749 keep-going nil)))
1752 ;; When JUST-FROM-FILE-NAME is set,
1753 ;; we are working on behalf of set-visited-file-name.
1754 ;; In that case, if the major mode specified is the
1755 ;; same one we already have, don't actually reset it.
1756 ;; We don't want to lose minor modes such as Font Lock.
1759 ;; If we can't deduce a mode from the file name,
1760 ;; look for an interpreter specified in the first line.
1761 ;; As a special case, allow for things like "#!/bin/env perl",
1762 ;; which finds the interpreter anywhere in $PATH.
1769 elt)
1770 ;; Map interpreter name to a mode.
1772 interpreter-mode-alist))
1779 "Find the -*- spec in the buffer.
1780 Call with point at the place to start searching from.
1781 If one is found, set point to the beginning
1782 and return the position of the end.
1783 Otherwise, return nil; point may be changed."
1786 ;; Don't look for -*- if this file name matches any
1787 ;; of the regexps in inhibit-first-line-modes-regexps.
1795 sufs)
1803 ;; If the file begins with "#!"
1804 ;; (exec interpreter magic), look
1805 ;; for mode frobs in the first two
1806 ;; lines. You cannot necessarily
1807 ;; put them in the first line of
1808 ;; such a file without screwing up
1809 ;; the interpreter invocation.
1817 t))
1823 end))))
1826 "Set local variables specified in the -*- line.
1827 Ignore any specification for `mode:' and `coding:';
1828 `set-auto-mode' should already have handled `mode:',
1829 `set-auto-coding' should already have handled `coding:'."
1836 ;; Parse the -*- line into the `result' alist.
1838 nil)
1840 ;; Simple form: "-*- MODENAME -*-". Already handled.
1841 nil)
1843 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1844 ;; (last ";" is optional).
1849 ;; There used to be a downcase here,
1850 ;; but the manual didn't say so,
1851 ;; and people want to set var names that aren't all lc.
1858 ;; It is traditional to ignore
1859 ;; case when checking for `mode' in set-auto-mode,
1860 ;; so we must do that here as well.
1861 ;; That is inconsistent, but we're stuck with it.
1862 ;; The same can be said for `coding' in set-auto-coding.
1876 ;; If we fail to switch in the selected window,
1877 ;; it is probably a minibuffer.
1878 ;; So try another window.
1891 "Normal hook run after processing a file's local variables specs.
1892 Major modes can use this to examine user-specified local variables
1896 "Parse and put into effect this buffer's local variables spec.
1897 If MODE-ONLY is non-nil, all we do is check whether the major mode
1898 is specified, returning t if it is specified."
1901 ;; Look for "Local variables:" line in last page.
1911 mode-only
1921 buffer-file-name)
1925 prefix prefixlen suffix beg
1926 mode-specified
1928 ;; The prefix is what comes before "local variables:" in its line.
1929 ;; The suffix is what comes after "local variables:" in its line.
1944 ;; Look at next local variable spec.
1947 ;; Skip the prefix, if any.
1952 ;; Find the variable name; strip whitespace.
1960 val)
1961 ;; Setting variable named "end" means end of list.
1964 ;; Otherwise read the variable value.
1975 ;; Set the variable. "Variables" mode and eval are funny.
1979 mode-specified))
1985 ;; Get confirmation before setting these variables as locals in a file.
2009 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2036 ;; This one is safe because the user gets to check it before it is used.
2044 A few patterns are specified so that any name which matches one
2045 is considered risky."
2050 ;; We have already handled coding: tag in set-auto-coding.
2051 nil)
2053 nil)
2054 ;; "Setting" eval means either eval it or do nothing.
2055 ;; Likewise for setting hook variables.
2058 (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$"
2061 ;; Permit evalling a put of a harmless property.
2062 ;; if the args do nothing tricky.
2068 ;; Only allow safe values of lisp-indent-hook;
2069 ;; not functions.
2074 ;; Permit eval if not root and user says ok.
2093 ;; Ordinary variable, really set it.
2095 ;; Make sure the string has no text properties.
2096 ;; Some text properties can get evaluated in various ways,
2097 ;; so it is risky to put them on with a local variable list.
2102 \f
2105 However, the mode will not be changed if
2106 \(1) a local variables list or the `-*-' line specifies a major mode, or
2108 \ not suitable for ordinary files, or
2109 \(3) the new file name does not particularly specify any mode."
2114 "Change name of file visited in current buffer to FILENAME.
2115 The next time the buffer is saved it will go in the newly specified file.
2116 nil or empty string as argument means make buffer not be visiting any file.
2117 Remember to delete the initial contents of the minibuffer
2118 if you wish to pass an empty string as the argument.
2120 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2121 confirmation in the case where another buffer is already visiting FILENAME.
2123 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2124 the old visited file has been renamed to the new name FILENAME."
2132 nil
2143 filename)))
2162 ;; Abbreviate the file names of the buffer.
2171 nil)))
2172 ;; write-file-hooks is normally used for things like ftp-find-file
2173 ;; that visit things that are not local files as if they were files.
2174 ;; Changing to visit an ordinary local file instead should flush the hook.
2179 ;; If buffer was read-only because of version control,
2180 ;; that reason is gone now, so make it writable.
2184 ;; Turn off backup files for certain file names.
2185 ;; Since this is a permanent local, the major mode won't eliminate it.
2192 ;; If auto-save was not already on, turn it on if appropriate.
2196 ;; If auto save is on, start using a new name.
2197 ;; We deliberately don't rename or delete the old auto save
2198 ;; for the old visited file name. This is because perhaps
2199 ;; the user wants to save the new state and then compare with the
2200 ;; previous state from the auto save file.
2203 ;; Rename the old auto save file if any.
2210 ;; Update the major mode, if the file name determines it.
2212 ;; Don't change the mode if it is special.
2215 ;; Don't change the mode if the local variable list specifies it.
2221 "Write current buffer into file FILENAME.
2222 This makes the buffer visit that file, and marks it as not modified.
2224 If you specify just a directory name as FILENAME, that means to use
2225 the default file name but in that directory. You can also yank
2226 the default file name into the minibuffer to edit it, using M-n.
2228 If the buffer is not already visiting a file, the default file name
2229 for the output file is the buffer name.
2231 If optional second arg CONFIRM is non-nil, this function
2232 asks for confirmation before overwriting an existing file.
2233 Interactively, confirmation is required unless you supply a prefix argument."
2234 ;; (interactive "FWrite file: ")
2238 nil nil nil nil)
2242 default-directory)
2243 nil nil))
2247 ;; If arg is just a directory,
2248 ;; use the default file name, but in that directory.
2259 ;; Make buffer writable if file is writable.
2264 \f
2266 "Make a backup of the disk file visited by the current buffer, if appropriate.
2267 This is normally done before saving the buffer the first time.
2268 If the value is non-nil, it is the result of `file-modes' on the original
2269 file; this means that the caller, after saving the buffer, should change
2270 the modes of the new file to agree with the old modes.
2272 A backup may be done by renaming or by copying; see documentation of
2273 variable `make-backup-files'. If it's done by renaming, then the file is
2274 no longer accessible under its old name."
2281 backup-info backupname targets setmodes)
2282 ;; If specified name is a symbolic link, chase it to the target.
2283 ;; Thus we make the backups in the directory where the real file is.
2288 ;; (if (file-directory-p buffer-file-name)
2289 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2293 ;; If have old versions to maybe delete,
2294 ;; ask the user to confirm now, before doing anything.
2295 ;; But don't actually delete til later.
2300 real-file-name))))))
2301 ;; Actually write the back up file.
2304 ; (file-symlink-p buffer-file-name)
2305 backup-by-copying
2320 ;; If copying fails because file BACKUPNAME
2321 ;; is not writable, delete that file and try again.
2326 ;; rename-file should delete old backup.
2330 ;; If trouble writing the backup, write it in ~.
2340 ;; If copying fails because file BACKUPNAME
2341 ;; is not writable, delete that file and try again.
2347 ;; Now delete the old versions, if desired.
2354 setmodes)
2358 "Return file NAME sans backup versions or strings.
2359 This is a separate procedure so your site-init or startup file can
2360 redefine it.
2361 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2362 we do not remove backup version numbers, only true file version numbers."
2368 ;; VMS version number is (a) semicolon, optional
2369 ;; sign, zero or more digits or (b) period, option
2370 ;; sign, zero or more digits, provided this is the
2371 ;; second period encountered outside of the
2372 ;; device/directory part of the file name.
2375 name)
2385 "Return t if deleting FILE and rewriting it would preserve the owner."
2390 ;; Return t if the file doesn't exist, since it's true that no
2391 ;; information would be lost by an (attempted) delete and create.
2397 The extension, in a file name, is the part that follows the last `.',
2398 except that a leading `.', if any, doesn't count."
2401 directory)
2406 directory)
2408 filename))))
2412 The extension, in a file name, is the part that follows the last `.',
2413 except that a leading `.', if any, doesn't count.
2414 Return nil for extensionless file names such as `foo'.
2415 Return the empty string for file names such as `foo.'.
2417 If PERIOD is non-nil, then the returned value includes the period
2418 that delimits the extension, and if FILENAME has no extension,
2429 "A function to use instead of the default `make-backup-file-name'.
2430 A value of nil gives the default `make-backup-file-name' behaviour.
2432 This could be buffer-local to do something special for specific
2433 files. If you define it, you may need to change `backup-file-name-p'
2434 and `file-name-sans-versions' too.
2436 See also `backup-directory-alist'."
2442 "Alist of filename patterns and backup directory names.
2443 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2444 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2445 relative or absolute. If it is absolute, so that all matching files
2446 are backed up into the same directory, the file names in this
2447 directory will be the full name of the file backed up with all
2448 directory separators changed to `!' to prevent clashes. This will not
2449 work correctly if your filesystem truncates the resulting name.
2451 For the common case of all backups going into one directory, the alist
2453 directory name.
2455 If this variable is nil, or it fails to match a filename, the backup
2456 is made in the original file's directory.
2458 On MS-DOS filesystems without long names this variable is always
2459 ignored."
2465 "Default `backup-enable-predicate' function.
2466 Checks for files in `temporary-file-directory' or
2467 `small-temporary-file-directory'."
2470 ;; Directory is under temporary-file-directory.
2475 0 nil
2477 ;; Directory is under small-temporary-file-directory.
2482 "Create the non-numeric backup file name for FILE.
2483 Normally this will just be the file's name with `~' appended.
2484 Customization hooks are provided as follows.
2486 If the variable `make-backup-file-name-function' is non-nil, its value
2487 should be a function which will be called with FILE as its argument;
2488 the resulting name is used.
2490 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2491 the documentation of that variable. If the directory for the backup
2492 doesn't exist, it is created."
2506 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2508 elt backup-directory dir-sep-string)
2513 alist nil)))
2515 file
2523 ;; Normalize DOSish file names: convert all slashes to
2524 ;; directory-sep-char, downcase the drive letter, if any,
2525 ;; and replace the leading "x:" with "/drive_x".
2528 ;; Replace any invalid file-name characters (for the
2529 ;; case of backing up remote files).
2534 "drive_"
2537 ""
2538 dir-sep-string)
2540 ;; Make the name unique by substituting directory
2541 ;; separators. It may not really be worth bothering about
2542 ;; doubling `!'s in the original name...
2545 directory-sep-char ?!
2547 backup-directory))
2554 "Return non-nil if FILE is a backup file name (numeric or not).
2555 This is a separate function so you can redefine it for customization.
2556 You may need to redefine `file-name-sans-versions' as well."
2561 ;; This is used in various files.
2562 ;; The usage of backup-extract-version-start is not very clean,
2563 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2565 "Given the name of a numeric backup file, FN, return the backup number.
2566 Uses the free variable `backup-extract-version-start', whose value should be
2567 the index in the name where the version number begins."
2573 ;; I believe there is no need to alter this behavior for VMS;
2574 ;; since backup files are not made on VMS, it should not get called.
2576 "Find a file name for a backup file FN, and suggestions for deletions.
2577 Value is a list whose car is the name for the backup file
2578 and whose cdr is a list of old versions to consider deleting now.
2579 If the value is nil, don't make a backup.
2580 Uses `backup-directory-alist' in the same way as does
2581 `make-backup-file-name'."
2583 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2587 ;; We don't support numbered backups on plain MS-DOS
2588 ;; when long file names are unavailable.
2598 possibilities deserve-versions-p versions)
2601 base-versions
2604 possibilities)
2605 #'<)
2610 kept-old-versions
2611 kept-new-versions
2618 ;; Delete nothing if there is overflow
2619 ;; in the number of versions to keep.
2625 v))))))))))
2628 "Return number of names file FILENAME has."
2632 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2633 This function returns a relative file name which is equivalent to FILENAME
2634 when used with that default directory as the default.
2635 If this is impossible (which can happen on MSDOS and Windows
2636 when the file name and directory use different drive names)
2637 then it returns FILENAME."
2642 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2643 ;; drive names, they can't be relative, so return the absolute name.
2648 filename
2655 ".."
2657 ;; Now ancestor is empty, or .., or ../.., etc.
2659 ;; We matched within FNAME's directory part.
2660 ;; Add the rest of FNAME onto ANCESTOR.
2664 ;; But don't bother with ANCESTOR if it would give us `./'.
2665 rest
2667 ;; We matched FNAME's directory equivalent.
2668 ancestor))))))
2669 \f
2671 "Save current buffer in visited file if modified. Versions described below.
2672 By default, makes the previous version into a backup file
2673 if previously requested or if this is the first save.
2675 to become a backup when the next save is done.
2677 unconditionally makes the previous version into a backup file.
2679 to become a backup when the next save is done,
2680 and unconditionally makes the previous version into a backup file.
2682 With argument of 0, never make the previous version into a backup file.
2684 If a file's name is FOO, the names of its numbered backup versions are
2685 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2686 Numeric backups (rather than FOO~) will be made if value of
2687 `version-control' is not the atom `never' and either there are already
2688 numeric versions of the file being backed up, or `version-control' is
2689 non-nil.
2690 We don't want excessive versions piling up, so there are variables
2691 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2692 and `kept-new-versions', which tells how many newest versions to keep.
2693 Defaults are 2 old versions and 2 new.
2694 `dired-kept-versions' controls dired's clean-directory (.) command.
2695 If `delete-old-versions' is nil, system will query user
2696 before trimming versions. Otherwise it does it silently.
2698 If `vc-make-backup-files' is nil, which is the default,
2699 no backup files are made for files managed by version control.
2700 (This is because the version control system itself records previous versions.)
2702 See the subroutine `basic-save-buffer' for more information."
2715 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2716 Normally delete only if the file was written by this Emacs since
2717 the last real save, but optional arg FORCE non-nil means delete anyway."
2731 "Normal hook that is run after a buffer is saved to its file."
2737 "If non-nil, use this coding system for saving the buffer.
2738 More precisely, use this coding system in place of the
2739 value of `buffer-file-coding-system', when saving the buffer.
2740 Calling `write-region' for any purpose other than saving the buffer
2741 will still use `buffer-file-coding-system'; this variable has no effect
2748 "Save the current buffer in its visited file, if it has been modified.
2749 The hooks `write-contents-hooks', `local-write-file-hooks' and
2750 `write-file-hooks' get a chance to do the job of saving; if they do not,
2751 then the buffer is saved in the visited file file in the usual way.
2752 After saving the buffer, this function runs `after-save-hook'."
2755 ;; In an indirect buffer, save its base buffer instead.
2760 setmodes tempsetmodes)
2761 ;; On VMS, rename file and buffer to get rid of version number.
2766 ;; Strip VMS version number before save.
2769 ;; Construct a (unique) buffer name to correspond.
2774 ;; If buffer has no file name, ask user for one.
2781 filename))
2806 ;; Support VC version backups.
2811 ;; If a hook returned t, file is already "written".
2812 ;; Otherwise, write it the usual way now.
2814 ;; Now we have saved the current buffer. Let's make sure
2815 ;; that buffer-file-coding-system is fixed to what
2816 ;; actually used for saving by binding it locally.
2826 ;; If the auto-save file was recent before this command,
2827 ;; delete it now.
2829 ;; Support VC `implicit' locking.
2834 ;; This does the "real job" of writing a buffer into its visited file
2835 ;; and making a backup file. This is what is normally done
2836 ;; but inhibited if one of write-file-hooks returns non-nil.
2837 ;; It returns a value to store in setmodes.
2857 buffer-file-name)))
2865 ;; If file is precious, write temp name, then rename it.
2866 ;; This requires write access to the containing dir,
2867 ;; which is why we don't try it if we don't have that access.
2869 tempname temp nogood i succeed
2873 ;; Find the temporary name to write under.
2880 "%s$tmp$%d"
2882 dir i))
2888 tempname nil realname
2889 buffer-file-truename)
2891 ;; If writing the temp file fails,
2892 ;; delete the temp file.
2899 ;; Since we have created an entirely new file
2900 ;; and renamed it, make sure it gets the
2901 ;; right permission bits set.
2903 ;; We succeeded in writing the temp file,
2904 ;; so rename it.
2906 ;; If file not writable, see if we can make it writable
2907 ;; temporarily while we write it.
2908 ;; But no need to do so if we have just backed it up
2909 ;; (setmodes is set) because that says we're superseding.
2911 ;; Change the mode back, after writing.
2915 buffer-file-name nil t buffer-file-truename)))
2916 setmodes))
2919 "Save some modified file-visiting buffers. Asks user about each one.
2920 Optional argument (the prefix) non-nil means save all with no questions.
2921 Optional second argument PRED determines which buffers are considered:
2922 If PRED is nil, all the file-visiting buffers are considered.
2923 If PRED is t, then certain non-file buffers will also be considered.
2924 If PRED is a zero-argument function, it indicates for each buffer whether
2925 to consider it or not when called with that buffer current."
2944 t
2963 ;; Return nil to ask about BUF again.
2964 nil)
2972 abbrev-file-name)))
2974 ;; Don't keep bothering user if he says no.
2976 t))))
2979 \f
2981 "Mark current buffer as unmodified, not needing to be saved.
2984 It is not a good idea to use this function in Lisp programs, because it
2985 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2992 "Change whether this buffer is visiting its file read-only.
2993 With arg, set read-only iff arg is positive.
2994 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3000 ;; Toggle.
3012 "Insert contents of file FILENAME into buffer after point.
3013 Set mark after the inserted text.
3015 This function is meant for the user to run interactively.
3016 Don't call it from programs! Use `insert-file-contents' instead.
3017 \(Its calling sequence is different; see its documentation)."
3021 filename)))
3026 "Append the contents of the region to the end of file FILENAME.
3027 When called from a function, expects three arguments,
3028 START, END and FILENAME. START and END are buffer positions
3029 saying what text to write."
3034 "Return most recent backup file for FILENAME or nil if no backups exist."
3035 ;; `make-backup-file-name' will get us the right directory for
3036 ;; ordinary or numeric backups. It might create a directory for
3037 ;; backups as a side-effect, according to `backup-directory-alist'.
3044 tem)
3053 newest))
3056 "Rename current buffer to a similar name not already taken.
3057 This function is useful for creating multiple shell process buffers
3058 or multiple mail buffers, etc."
3066 ;; If the existing buffer name has a <NNN>,
3067 ;; which isn't part of the file name (if any),
3068 ;; then get rid of that.
3074 "Create the directory DIR and any nonexistent parent dirs.
3075 Interactively, the default choice of directory to create
3076 is the current default directory for file names.
3077 That is useful when you have visited a file in a nonexistent directory.
3079 Noninteractively, the second (optional) argument PARENTS says whether
3080 to create parent directories if they don't exist."
3083 nil nil)
3084 t))
3091 create-list)
3098 \f
3101 "Function to use to revert this buffer, or nil to do the default.
3102 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3107 "Function to use to insert contents when reverting this buffer.
3108 Gets two args, first the nominal file name to use,
3109 and second, t if reading the auto-save file.
3114 "Normal hook for `revert-buffer' to run before reverting.
3115 If `revert-buffer-function' is used to override the normal revert
3119 "Normal hook for `revert-buffer' to run after reverting.
3120 Note that the hook value that it runs is the value that was in effect
3121 before reverting; that makes a difference if you have buffer-local
3122 hook functions.
3124 If `revert-buffer-function' is used to override the normal revert
3130 "Replace current buffer text with the text of the visited file on disk.
3131 This undoes all changes since the file was visited or saved.
3132 With a prefix argument, offer to revert from latest auto-save file, if
3133 that is more recent than the visited file.
3135 This command also works for special buffers that contain text which
3136 doesn't come from a file, but reflects some other data base instead:
3137 for example, Dired buffers and buffer-list buffers. In these cases,
3138 it reconstructs the buffer contents from the appropriate data base.
3140 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3141 to revert from the auto-save file when this is nil. Note that the
3142 sense of this argument is the reverse of the prefix argument, for the
3143 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3144 to nil.
3146 Optional second argument NOCONFIRM means don't ask for confirmation at
3147 all. (The local variable `revert-without-query', if non-nil, prevents
3148 confirmation.)
3150 Optional third argument PRESERVE-MODES non-nil means don't alter
3151 the files modes. Normally we reinitialize them using `normal-mode'.
3153 If the value of `revert-buffer-function' is non-nil, it is called to
3154 do all the work for this command. Otherwise, the hooks
3155 `before-revert-hook' and `after-revert-hook' are run at the beginning
3156 and the end, and if `revert-buffer-insert-file-contents-function' is
3157 non-nil, it is called instead of rereading visited file contents."
3159 ;; I admit it's odd to reverse the sense of the prefix argument, but
3160 ;; there is a lot of code out there which assumes that the first
3161 ;; argument should be t to avoid consulting the auto-save file, and
3162 ;; there's no straightforward way to encourage authors to notice a
3163 ;; reversal of the argument sense. So I'm just changing the user
3164 ;; interface, but leaving the programmatic interface the same.
3170 buffer-auto-save-file-name
3175 buffer-auto-save-file-name
3176 buffer-file-name)))
3187 found))
3189 file-name)))
3191 ;; If file was backed up but has changed since,
3192 ;; we shd make another backup.
3196 ;; Get rid of all undo records for this buffer.
3199 ;; Effectively copy the after-revert-hook status,
3200 ;; since after-find-file will clobber it.
3204 after-revert-hook)))
3206 ;; Don't make undo records for the reversion.
3210 file-name auto-save-p)
3213 ;; Bind buffer-file-name to nil
3214 ;; so that we don't try to lock the file.
3220 ;; Auto-saved file shoule be read without
3221 ;; any code conversion.
3223 coding-system-for-read)))
3224 ;; Note that this preserves point in an intelligent way.
3228 nil nil t))
3230 nil nil t)))))
3231 ;; Recompute the truename in case changes in symlinks
3232 ;; have changed the truename.
3236 ;; Run after-revert-hook as it was before we reverted.
3244 t)))))
3247 "Visit file FILE, but get contents from its last auto-save file."
3248 ;; Actually putting the file name in the minibuffer should be used
3249 ;; only rarely.
3250 ;; Not just because users often use the default.
3269 ;; Use insert-directory-safely, not insert-directory,
3270 ;; because these files might not exist. In particular,
3271 ;; FILE might not exist if the auto-save file was for
3272 ;; a buffer that didn't visit a file, such as "*mail*".
3273 ;; The code in v20.x called `ls' directly, so we need
3274 ;; to emulate what `ls' did in that case.
3280 ;; Keep the current buffer-file-coding-system.
3282 ;; Auto-saved file shoule be read without any code conversion.
3291 "Recover auto save files from a previous Emacs session.
3292 This command first displays a Dired buffer showing you the
3293 previous sessions that you could recover from.
3294 To choose one, move point to the proper line and then type C-c C-c.
3295 Then you'll be asked about a number of files to recover."
3309 ;; Each line starts with a space
3310 ;; so that Font Lock mode won't highlight the first character.
3319 "Choose one saved session to recover auto-save files from.
3320 This command is used in the special Dired buffer created by
3323 ;; Get the name of the session file to recover from.
3325 files
3331 ;; Read in the auto-save-list file.
3335 ;; Loop thru the text of that file
3336 ;; and get out the names of the files to recover.
3340 ;; This is a pair of lines for a non-file-visiting buffer.
3341 ;; Get the auto-save file name and manufacture
3342 ;; a "visited file name" from that.
3358 ;; This pair of lines is a file-visiting
3359 ;; buffer. Use the visited file name.
3369 ;; Ignore a file if its auto-save file does not exist now.
3373 ;; The file contains a pair of line for each auto-saved buffer.
3374 ;; The first line of the pair contains the visited file name
3375 ;; or is empty if the buffer was not visiting a file.
3376 ;; The second line is the auto-save file name.
3384 files
3390 "For each buffer in LIST, ask whether to kill it.
3391 LIST defaults to all existing live buffers."
3402 name
3407 \f
3409 "Toggle auto-saving of contents of current buffer.
3410 With prefix argument ARG, turn auto-saving on if positive, else off."
3415 ;; If auto-save is off because buffer has shrunk,
3416 ;; then toggling should turn it on.
3421 buffer-file-name
3423 ;; If -1 was stored here, to temporarily turn off saving,
3424 ;; turn it back on.
3430 buffer-auto-save-file-name)
3433 "Adjust current buffer's auto save file name for current conditions.
3434 Also rename any existing auto save file, if it was made in this session."
3446 "Return file name to use for auto-saves of current buffer.
3447 Does not consider `auto-save-visited-file-name' as that variable is checked
3448 before calling this function. You can redefine this for customization.
3449 See also `auto-save-file-name-p'."
3453 result uniq)
3454 ;; Apply user-specified translations
3455 ;; to the file name.
3459 filename)
3467 directory-sep-char ?!
3469 filename))))
3474 ;; We truncate the file name to DOS 8+3 limits
3475 ;; before doing anything else, because the regexp
3476 ;; passed to string-match below cannot handle
3477 ;; extensions longer than 3 characters, multiple
3478 ;; dots, and other atrocities.
3483 fn)
3488 "#"
3491 ;; Make sure auto-save file names don't contain characters
3492 ;; invalid for the underlying filesystem.
3494 ;; Don't modify remote (ange-ftp) filenames
3497 result))
3499 ;; Deal with buffers that don't have any associated files. (Mail
3500 ;; mode tends to create a good number of these.)
3504 file-name)
3505 ;; Eliminate all slashes and backslashes by
3506 ;; replacing them with sequences that start with %.
3507 ;; Quote % also, to keep distinct names distinct.
3516 ;; Generate the file name.
3522 ;; Try a few alternative directories, to get one we can
3523 ;; write it.
3529 ;; Don't modify remote (ange-ftp) filenames
3531 ;; The call to convert-standard-filename is in case
3532 ;; buffer-name includes characters not allowed by the
3533 ;; DOS/Windows filesystems. make-temp-file writes to the
3534 ;; file it creates, so we must fix the file name _before_
3535 ;; make-temp-file is called.
3537 fname))
3539 ;; make-temp-file creates the file,
3540 ;; but we don't want it to exist until we do an auto-save.
3544 file-name)))
3547 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3548 FILENAME should lack slashes. You can redefine this for customization."
3550 \f
3552 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3553 The generated regexp will match a filename iff the filename
3554 matches that wildcard according to shell rules. Only wildcards known
3555 by `sh' are supported."
3557 ;; Copy the initial run of non-special characters.
3560 ;; If no special characters, we're almost done.
3564 j)
3566 result
3587 ;; Found "[^". Insert a `\0' character
3588 ;; (which cannot happen in a filename)
3589 ;; into the character class, so that `^'
3590 ;; is not the first character after `[',
3591 ;; and thus non-special in a regexp.
3596 ;; I don't think `]' can appear in a
3597 ;; character class in a wildcard, but
3598 ;; let's be general here.
3605 i
3618 ;; Shell wildcards should match the entire filename,
3619 ;; not its part. Make the regexp say so.
3621 \f
3624 "*Switches for `list-directory' to pass to `ls' for brief listing."
3630 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3632 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3637 "Expand wildcard pattern PATTERN.
3638 This returns a list of file names which match the pattern.
3640 If PATTERN is written as an absolute relative file name,
3641 the values are absolute also.
3643 If PATTERN is written as a relative file name, it is interpreted
3644 relative to the current default directory, `default-directory'.
3645 The file names returned are normally also relative to the current
3646 default directory. However, if FULL is non-nil, they are absolute."
3650 ;; A list of all dirs that DIRPART specifies.
3651 ;; This can be more than one dir
3652 ;; if DIRPART contains wildcards.
3657 contents)
3662 ;; Filter out "." and ".."
3667 name))
3674 this-dir-contents)
3675 this-dir-contents)
3676 contents))))
3678 contents)))
3681 "Display a list of files in or matching DIRNAME, a la `ls'.
3682 DIRNAME is globbed by the shell if necessary.
3683 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3684 Actions controlled by variables `list-directory-brief-switches'
3685 and `list-directory-verbose-switches'."
3689 nil default-directory nil)
3690 pfx)))
3692 list-directory-brief-switches))
3693 buffer)
3706 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
3714 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3716 PATTERN is assumed to represent a file-name wildcard suitable for the
3717 underlying filesystem. For Unix and GNU/Linux, the characters from the
3719 the parts of the pattern which don't include wildcard characters are
3720 quoted with double quotes.
3721 Existing quote characters in PATTERN are left alone, so you can pass
3722 PATTERN that already quotes some of the special characters."
3726 ;; DOS/Windows don't allow `"' in file names. So if the
3727 ;; argument has quotes, we can safely assume it is already
3728 ;; quoted by the caller.
3730 ;; We quote [&()#$'] in case their shell is a port of a
3731 ;; Unixy shell. We quote [,=+] because stock DOS and
3732 ;; Windows shells require that in some cases, such as
3733 ;; passing arguments to batch files that use positional
3734 ;; arguments like %1.
3736 pattern
3739 end)
3756 pattern))))
3763 "*Program to get the amount of free space on a file system.
3764 We assume the output has the format of `df'.
3765 The value of this variable must be just a command name or file name;
3766 if you want to specify options, use `directory-free-space-args'.
3768 A value of nil disables this feature.
3770 If the function `file-system-info' is defined, it is always used in
3771 preference to the program given by this variable."
3776 "*Options to use when running `directory-free-space-program'."
3781 "Return the mount of free space on directory DIR's file system.
3782 The result is a string that gives the number of free 1KB blocks,
3783 or nil if the system call or the program which retrieve the infornmation
3784 fail.
3786 This function calls `file-system-info' if it is available, or invokes the
3787 program specified by `directory-free-space-program' if that is non-nil."
3788 ;; Try to find the number of free blocks. Non-Posix systems don't
3789 ;; always have df, but might have an equivalent system call.
3798 nil t nil
3799 directory-free-space-args
3800 dir)))
3801 ;; Usual format is a header line followed by a line of
3802 ;; numbers.
3807 ;; Move to the end of the "available blocks" number.
3810 ;; Copy it into AVAILABLE.
3816 ;; insert-directory
3817 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3818 ;; FULL-DIRECTORY-P is nil.
3819 ;; The single line of output must display FILE's name as it was
3820 ;; given, namely, an absolute path name.
3821 ;; - must insert exactly one line for each file if WILDCARD or
3822 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3823 ;; before the file lines, plus optional text after the file lines.
3824 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3825 ;; allowed.
3826 ;; File lines should display the basename.
3827 ;; - must be consistent with
3828 ;; - functions dired-move-to-filename, (these two define what a file line is)
3829 ;; dired-move-to-end-of-filename,
3830 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3831 ;; dired-insert-headerline
3832 ;; dired-after-subdir-garbage (defines what a "total" line is)
3833 ;; - variable dired-subdir-regexp
3835 "Insert directory listing for FILE, formatted according to SWITCHES.
3836 Leaves point after the inserted text.
3837 SWITCHES may be a string of options, or a list of strings.
3838 Optional third arg WILDCARD means treat FILE as shell wildcard.
3839 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3840 switches do not contain `d', so that a full listing is expected.
3842 This works by running a directory listing program
3843 whose name is in the variable `insert-directory-program'.
3844 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3845 ;; We need the directory in order to find the right handler.
3850 wildcard full-directory-p)
3855 ;; Read the actual directory using `insert-directory-program'.
3856 ;; RESULT gets the status code.
3860 default-file-name-coding-system)))
3861 ;; This is to control encoding the arguments in call-process.
3865 ;; Run ls in the directory part of the file pattern
3866 ;; using the last component as argument.
3873 shell-file-name nil t nil
3874 "-c"
3876 ""
3878 insert-directory-program
3879 " -d "
3881 switches
3883 " -- "
3884 ;; Quote some characters that have
3885 ;; special meanings in shells; but
3886 ;; don't quote the wildcards--we want
3887 ;; them to be special. We also
3888 ;; currently don't quote the quoting
3889 ;; characters in case people want to
3890 ;; use them explicitly to quote
3891 ;; wildcard characters.
3893 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3894 ;; directory if FILE is a symbolic link.
3896 insert-directory-program nil t nil
3900 ;; Split the switches at any spaces so we can
3901 ;; pass separate options as separate args.
3903 ;; Avoid lossage if FILE starts with `-'.
3911 file))))))))
3913 ;; If `insert-directory-program' failed, signal an error.
3915 ;; On non-Posix systems, we cannot open a directory, so
3916 ;; don't even try, because that will always result in
3917 ;; the ubiquitous "Access denied". Instead, show the
3918 ;; command line so the user can try to guess what went wrong.
3923 insert-directory-program
3925 file result)
3926 ;; Unix. Access the file to get a suitable error.
3930 ;; Try to insert the amount of free space.
3933 ;; First find the line to put it on.
3937 ;; Replace "total" with "used", to avoid confusion.
3944 "Insert directory listing for FILE, formatted according to SWITCHES.
3946 Like `insert-directory', but if FILE does not exist, it inserts a
3947 message to that effect instead of signaling an error."
3950 ;; Simulate the message printed by `ls'.
3954 "Functions to call with no arguments to query about killing Emacs.
3955 If any of these functions returns nil, killing Emacs is cancelled.
3957 but `kill-emacs', the low level primitive, does not.
3961 "How to ask for confirmation when leaving Emacs.
3962 If nil, the default, don't ask at all. If the value is non-nil, it should
3963 be a predicate function such as `yes-or-no-p'."
3971 "Offer to save each buffer, then kill this Emacs process.
3972 With prefix arg, silently save all file-visiting buffers, then kill."
3981 ;; process-list is not defined on VMS.
3983 active)
3992 ;; Query the user for other things, perhaps.
3997 \f
3998 ;; We use /: as a prefix to "quote" a file name
3999 ;; so that magic file name handlers will not apply to it.
4003 file-name-handler-alist))
4005 ;; We depend on being the last handler on the list,
4006 ;; so that anything else which does need handling
4007 ;; has been handled already.
4008 ;; So it is safe for us to inhibit *all* magic file name handlers.
4017 default-directory))
4018 ;; Get a list of the indices of the args which are file names.
4021 ;; The first five are special because they
4022 ;; return a file name. We want to include the /:
4023 ;; in the return value.
4024 ;; So just avoid stripping it in the first place.
4030 ;; `identity' means just return the first arg
4031 ;; as stripped of its quoting.
4039 ;; For all other operations, treat the first argument only
4040 ;; as the file name.
4042 ;; Copy ARGUMENTS so we can replace elements in it.
4044 ;; Strip off the /: from the file names that have this handler.
4052 "/"
4058 \f
4081 ;;; files.el ends here