| blob | 7a33267789a9b2c67378feb91e1baa7c0e57afe0 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002
4 ;;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
34 "Backups of edited data files."
38 "Finding files."
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
71 ;; Turn off backup files on VMS since it has version numbers.
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
137 "Predicate that looks at a file name and decides whether to make backups.
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
163 nil
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
195 "The directory for writing temporary files."
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil means make them for files that have some already.
243 `never' means do not make them."
251 "*When cleaning directory, number of versions to keep."
257 "*If t, delete excess backup versions silently.
258 If nil, ask confirmation. Any other value prevents any trimming."
265 "*Number of oldest versions to keep when a new numbered backup is made."
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
276 "*Value of t says silently ensure a file ends in a newline when it is saved.
277 Non-nil but not t says ask user whether to add a newline when there isn't one.
278 nil means don't add newlines."
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
291 Normally auto-save files are written under other names."
297 ;; Don't put "\\2" inside expand-file-name, since it will be
298 ;; transformed to "/2" on DOS/Windows.
300 "*Transforms to apply to buffer file name before making auto-save file name.
301 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
302 REGEXP is a regular expression to match against the file name.
303 If it matches, `replace-match' is used to replace the
304 matching part with REPLACEMENT.
305 If the optional element UNIQUIFY is non-nil, the auto-save file name is
306 constructed by taking the directory part of the replaced file-name,
307 concatenated with the buffer file name with all directory separators
308 changed to `!' to prevent clashes. This will not work
309 correctly if your filesystem truncates the resulting name.
311 All the transforms in the list are tried, in the order they are listed.
312 When one transform applies, its result is final;
313 no further transforms are tried.
315 The default value is set up to put the auto-save file into the
316 temporary directory (see the variable `temporary-file-directory') for
317 editing a remote file.
319 On MS-DOS filesystems without long names this variable is always
320 ignored."
327 "*Non-nil means save word abbrevs too when files are saved.
328 If `silently', don't ask the user before saving."
333 "*Non-nil means allow `find-file' to visit directories.
334 To visit the directory, `find-file' runs `find-directory-functions'."
339 "*List of functions to try in sequence to visit a directory.
340 Each function is called with the directory name as the sole argument
341 and should return either a buffer or nil."
345 ;;;It is not useful to make this a local variable.
346 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
348 "List of functions to be called for `find-file' on nonexistent file.
349 These functions are called as soon as the error is detected.
350 Variable `buffer-file-name' is already set up.
353 ;;;It is not useful to make this a local variable.
354 ;;;(put 'find-file-hooks 'permanent-local t)
356 "List of functions to be called after a buffer is loaded from a file.
357 The buffer's local variables (if any) will have been processed before the
361 "List of functions to be called before writing out a buffer to a file.
362 If one of them returns non-nil, the file is considered already written
363 and the rest are not called.
364 These hooks are considered to pertain to the visited file.
365 So any buffer-local binding of `write-file-hooks' is
368 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
370 ;;; However, in case someone does make it local...
374 "Just like `write-file-hooks', except intended for per-buffer use.
375 The functions in this list are called before the ones in
376 `write-file-hooks'.
378 This variable is meant to be used for hooks that have to do with a
379 particular visited file. Therefore, it is a permanent local, so that
380 changing the major mode does not clear it. However, calling
386 "List of functions to be called before writing out a buffer to a file.
387 If one of them returns non-nil, the file is considered already written
388 and the rest are not called.
390 This variable is meant to be used for hooks that pertain to the
391 buffer's contents, not to the particular visited file; thus,
392 `set-visited-file-name' does not clear this variable; but changing the
393 major mode does clear it.
395 This variable automatically becomes buffer-local whenever it is set.
396 If you use `add-hook' to add elements to the list, use nil for the
397 LOCAL argument.
403 "*Control use of local variables in files you visit.
404 The value can be t, nil or something else.
405 A value of t means file local variables specifications are obeyed;
406 nil means they are ignored; anything else means query.
407 This variable also controls use of major modes specified in
408 a -*- line.
411 always obeys file local variable specifications and the -*- line,
412 and ignores this variable."
419 "Like `enable-local-variables' but meant for buffer-local bindings.
420 The meaningful values are nil and non-nil. The default is non-nil.
421 If a major mode sets this to nil, buffer-locally, then any local
422 variables list in the file will be ignored.
424 This variable does not affect the use of major modes
429 The value can be t, nil or something else.
430 A value of t means obey `eval' variables;
431 nil means ignore them; anything else means query.
434 and ignores this variable."
440 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
452 "Provides support for ange-ftp host name completion.
453 Runs the usual ange-ftp hook, but only for completion operations."
454 ;; Having this here avoids the need to load ange-ftp when it's not
455 ;; really in use.
461 inhibit-file-name-handlers)))
466 "Convert a standard file's name to something suitable for the current OS.
467 This function's standard definition is trivial; it just returns the argument.
468 However, on some systems, the function is redefined with a definition
469 that really does change some file names to canonicalize certain
470 patterns and to guarantee valid names."
471 filename)
472 \f
474 "Show the current default directory."
479 "Value of the CDPATH environment variable, as a list.
483 "Explode a colon-separated search path into a list of directory names.
484 \(For values of `colon' equal to `path-separator'.)"
485 ;; We could use split-string here.
493 nil
498 cd-list)))
501 "Change current directory to given absolute file name DIR."
502 ;; Put the name into directory syntax now,
503 ;; because otherwise expand-file-name may give some bad results.
516 "Make DIR become the current buffer's default directory.
517 If your environment includes a `CDPATH' variable, try each one of that
518 colon-separated list of directories when resolving a relative directory name."
521 default-directory default-directory
537 cd-path)
538 nil))
542 "Load the Lisp file named FILE."
543 ;; This is a case where .elc makes a lot of sense.
550 "Search for FILENAME through PATH.
551 If SUFFIXES is non-nil, it should be a list of suffixes to append to
553 If non-nil, PREDICATE is used instead of `file-readable-p'.
554 PREDICATE can also be an integer to pass to the access(2) function,
555 in which case file-name-handlers are ignored (this use is deprecated).
556 For compatibility with XEmacs, PREDICATE can also be a symbol among
557 `executable', `readable', `writable', or `exists' or a list of one
558 of those symbols."
569 "Do completion for file names passed to `locate-file'.
570 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
590 "Load the library named LIBRARY.
591 This is an interface to the function `load'."
594 'locate-file-completion
599 "Copy the file FILE into a temporary file on this machine.
600 Returns the name of the local copy, or nil, if FILE is directly
601 accessible."
602 ;; This formerly had an optional BUFFER argument that wasn't used by
603 ;; anything.
607 nil)))
610 "Return the truename of FILENAME, which should be absolute.
611 The truename of a file name is found by chasing symbolic links
612 both at the level of the file and at the level of the directories
613 containing it, until no links are left at any level.
615 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
616 Do not specify them in other calls."
617 ;; COUNTER can be a cons cell whose car is the count of how many more links
618 ;; to chase before getting an error.
619 ;; PREV-DIRS can be a cons cell whose car is an alist
620 ;; of truenames we've just recently computed.
622 ;; The last test looks dubious, maybe `+' is meant here? --simon.
632 ;; For speed, remove the ange-ftp completion handler from the list.
633 ;; We know it's not needed here.
634 ;; For even more speed, do this only on the outermost call.
641 ;; andrewi@harlequin.co.uk - none of the following code (except for
642 ;; invoking the file-name handler) currently applies on Windows
643 ;; (ie. there are no native symlinks), but there is an issue with
644 ;; case differences being ignored by the OS, and short "8.3 DOS"
645 ;; name aliases existing for all files. (The short names are not
646 ;; reported by directory-files, but can be used to refer to files.)
647 ;; It seems appropriate for file-truename to resolve these issues in
648 ;; the most natural way, which on Windows is to call the function
649 ;; `w32-long-file-name' - this returns the exact name of a file as
650 ;; it is stored on disk (expanding short name aliases with the full
651 ;; name in the process).
654 newname)
655 ;; For file name that has a special handler, call handler.
656 ;; This is so that ange-ftp can save time by doing a no-op.
659 ;; If filename contains a wildcard, newname will be the old name.
662 ;; If filename doesn't exist, newname will be nil.
667 ;; If this file directly leads to a link, process that iteratively
668 ;; so that we don't use lots of stack.
674 ;; For file name that has a special handler, call handler.
675 ;; This is so that ange-ftp can save time by doing a no-op.
678 done t)
680 target dirfile)
681 ;; Get the truename of the directory.
683 ;; If these are equal, we have the (or a) root directory.
685 ;; If this is the same dir we last got the truename for,
686 ;; save time--don't recalculate.
696 done t)
699 done t)
700 ;; Put it back on the file name.
702 ;; Is the file name the name of a link?
705 ;; Yes => chase that link, then start all over
706 ;; since the link may point to a directory name that uses links.
707 ;; We can't safely use expand-file-name here
708 ;; since target might look like foo/../bar where foo
709 ;; is itself a link. Instead, we handle . and .. above.
712 target
714 done nil)
715 ;; No, we are done!
717 filename))
720 "Chase links in FILENAME until a name that is not a link.
721 Does not examine containing directories for links,
722 unlike `file-truename'."
728 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
731 ;; Handle `..' by hand, since it needs to work in the
732 ;; target of any directory symlink.
733 ;; This code is not quite complete; it does not handle
734 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
738 ;; Chase links in the default dir of the symlink.
742 ;; Now find the parent of that dir.
746 newname))
747 \f
749 "Select buffer BUFFER in another window.
750 Optional second arg NORECORD non-nil means
751 do not put this buffer at the front of the list of recently selected ones.
753 This uses the function `display-buffer' as a subroutine; see its
754 documentation for additional customization information."
760 "Switch to buffer BUFFER in another frame.
761 Optional second arg NORECORD non-nil means
762 do not put this buffer at the front of the list of recently selected ones.
764 This uses the function `display-buffer' as a subroutine; see its
765 documentation for additional customization information."
772 "Edit file FILENAME.
773 Switch to a buffer visiting file FILENAME,
774 creating one if none already exists.
775 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
776 expand wildcards (if any) and visit multiple files. Wildcard expansion
777 can be suppressed by setting `find-file-wildcards'."
785 "Edit file FILENAME, in another window.
786 May create a new window, or reuse an existing one.
787 See the function `display-buffer'.
788 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
789 expand wildcards (if any) and visit multiple files."
800 "Edit file FILENAME, in another frame.
801 May create a new frame, or reuse an existing one.
802 See the function `display-buffer'.
803 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
804 expand wildcards (if any) and visit multiple files."
815 "Edit file FILENAME but don't allow changes.
816 Like `find-file' but marks buffer as read-only.
824 "Edit file FILENAME in another window but don't allow changes.
833 "Edit file FILENAME in another frame but don't allow changes.
842 "Find file FILENAME as a replacement for the file in the next window.
843 This command does not select that window."
862 "Find file FILENAME, select its buffer, kill previous buffer.
863 If the current buffer now contains an empty file that you just visited
864 \(presumably by mistake), use this command to visit the file you really want."
875 ;; (not buffer-read-only)
902 \f
904 "Create a suitably named buffer for visiting FILENAME, and return it.
905 FILENAME (sans directory) is used unchanged if that name is free;
906 otherwise a string <2> or <3> or ... is appended to get an unused name."
913 "Create and return a buffer with a name based on NAME.
914 Choose the buffer's name using `generate-new-buffer-name'."
918 "Regexp to match the automounter prefix in a directory name."
926 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
929 ;; Get rid of the prefixes added by the automounter.
936 ;; If any elt of directory-abbrev-alist matches this name,
937 ;; abbreviate accordingly.
943 ;; Compute and save the abbreviated homedir name.
944 ;; We defer computing this until the first time it's needed, to
945 ;; give time for directory-abbrev-alist to be set properly.
946 ;; We include a slash at the end, to avoid spurious matches
947 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
954 ;; If FILENAME starts with the abbreviated homedir,
955 ;; make it start with `~' instead.
957 ;; If the home dir is just /, don't change it.
960 ;; MS-DOS root directories can come with a drive letter;
961 ;; Novell Netware allows drive letters beyond `Z:'.
970 filename))
973 "*List of logical names for which visiting shouldn't save the true dirname.
974 On VMS, when you visit a file using a logical name that searches a path,
975 you may or may not want the visited file name to record the specific
976 directory where the file was found. If you *do not* want that, add the logical
977 name to this list as a string."
982 "Return the buffer visiting file FILENAME (a string).
983 This is like `get-file-buffer', except that it checks for any buffer
984 visiting the same file, possibly under a different name.
985 If there is no such live buffer, return nil."
997 found)
1002 number
1007 ;; Verify this buffer's file number
1008 ;; still belongs to its file.
1011 attributes))
1014 found))))
1015 \f
1017 "*Non-nil means file-visiting commands should handle wildcards.
1018 For example, if you specify `*.c', that would visit all the files
1019 whose names match the pattern."
1025 "*Non-nil means suppress warning messages for symlinked files.
1026 When nil, Emacs prints a warning when visiting a file that is already
1027 visited, but with a different name. Setting this option to t
1028 suppresses this warning."
1034 "Read file FILENAME into a buffer and return the buffer.
1035 If a buffer exists visiting FILENAME, return that one, but
1036 verify that the file has not changed since visited or saved.
1037 The buffer is not selected, just returned to the caller.
1038 Optional first arg NOWARN non-nil means suppress any warning messages.
1039 Optional second arg RAWFILE non-nil means the file is read literally.
1040 Optional third arg WILDCARDS non-nil means do wildcard processing
1041 and visit all the matching files. When wildcards are actually
1042 used and expanded, the value is a list of buffers
1043 that are visiting the various files."
1050 'find-directory-functions
1053 filename)))
1056 find-file-wildcards
1069 ;; Find any buffer for a file which has same truename.
1071 ;; Let user know if there is a buffer with the same truename.
1075 find-file-suppress-same-file-warnings
1079 ;; Optionally also find that buffer.
1083 ;; We are using an existing buffer.
1089 ;; Certain files should be reverted automatically
1090 ;; if they have changed on disk and not in the buffer.
1098 found))
1108 "File %s changed on disk. Discard your edits? "
1113 "File %s changed on disk. Discard your edits in %s? "
1121 ;; Check if a formerly read-only file has become
1122 ;; writable and vice versa, but if the buffer agrees
1123 ;; with the new state of the file, that is ok too.
1130 buffer-file-name
1138 ;; It is confusing to ask whether to visit
1139 ;; non-literally if they have the file in
1140 ;; hexl-mode.
1144 "Save file and revisit literally? "
1149 rawfile truename number))
1151 "Discard your edits and revisit file literally? "
1154 rawfile truename number)
1158 "Revisit file literally? "
1161 rawfile truename number)
1164 ;; Return the buffer we are using.
1165 buf)
1166 ;; Create a new buffer.
1169 ;; find-file-noselect-1 may use a different buffer.
1171 rawfile truename number))))))
1175 error)
1178 ;; Needed in case we are re-visiting the file with a different
1179 ;; text representation.
1193 filename)))
1194 ;; Unconditionally set error
1203 filename)))
1204 ;; Run find-file-not-found-hooks until one returns non-nil.
1206 ;; If they fail too, set error.
1208 ;; Record the file's truename, and maybe use that as visited name.
1214 ;; On VMS, we may want to remember which directory in a search list
1215 ;; the file was found in.
1227 ;; Set buffer's default directory to that of the file.
1229 ;; Turn off backup files for certain file names. Since
1230 ;; this is a permanent local, the major mode won't eliminate it.
1243 \f
1245 "Like `insert-file-contents', but only reads in the file literally.
1246 A buffer may be modified in several ways after reading into the buffer,
1247 to Emacs features such as format decoding, character code
1248 conversion, `find-file-hooks', automatic uncompression, etc.
1250 This function ensures that none of these modifications will take place."
1258 nil))
1270 "Insert contents of file FILENAME into buffer after point with no conversion.
1272 This function is meant for the user to run interactively.
1273 Don't call it from programs! Use `insert-file-contents-literally' instead.
1274 \(Its calling sequence is different; see its documentation)."
1278 filename)))
1283 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1288 "Visit file FILENAME with no conversion of any kind.
1289 Format conversion and character code conversion are both disabled,
1290 and multibyte characters are disabled in the resulting buffer.
1291 The major mode used is Fundamental mode regardless of the file name,
1292 and local variable specifications in the file are ignored.
1293 Automatic uncompression and adding a newline at the end of the
1294 file due to `require-final-newline' is also disabled.
1296 You cannot absolutely rely on this function to result in
1297 visiting the file literally. If Emacs already has a buffer
1298 which is visiting the file, you get the existing buffer,
1299 regardless of whether it was created literally or not.
1301 In a Lisp program, if you want to be sure of accessing a file's
1302 contents literally, you should create a temporary buffer and then read
1303 the file contents into it using `insert-file-contents-literally'."
1306 \f
1310 after-find-file-from-revert-buffer
1311 nomodes)
1312 "Called after finding a file and by the default revert function.
1313 Sets buffer mode, parses local variables.
1314 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1315 error in reading the file. WARN non-nil means warn if there
1316 exists an auto-save file more recent than the visited file.
1317 NOAUTO means don't mess with auto-save mode.
1318 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1319 means this call was from `revert-buffer'.
1320 Fifth arg NOMODES non-nil means don't alter the file's modes.
1321 Finishes by calling the functions in `find-file-hooks'
1322 unless NOMODES is non-nil."
1325 nil
1335 ;; No need to warn if buffer is auto-saved
1336 ;; under the name of the visited file.
1338 auto-save-visited-file-name))
1341 buffer-file-name))
1355 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1356 "Use M-x make-directory RET RET to create the directory"
1363 ;; Make people do a little extra work (C-x C-q)
1364 ;; before altering a backup file.
1372 view-read-only
1378 "Choose the major mode for this buffer automatically.
1379 Also sets up any specified local variables of the file.
1380 Uses the visited file name, the -*- line, and the local variables spec.
1382 This function is called automatically from `find-file'. In that case,
1383 we may set up the file-specified mode and local variables,
1384 depending on the value of `enable-local-variables': if it is t, we do;
1385 if it is nil, we don't; otherwise, we query.
1386 In addition, if `local-enable-local-variables' is nil, we do
1387 not set local variables (though we do notice a mode specified with -*-.)
1389 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1390 or from Lisp without specifying the optional argument FIND-FILE;
1391 in that case, this function acts as if `enable-local-variables' were t."
1400 enable-local-variables)))
1441 ;; Less common extensions come here
1442 ;; so more common ones above are found faster.
1452 ;; for MSDOS and MS-Windows (which are case-insensitive)
1498 ;; Mailer puts message to be edited in
1499 ;; /tmp/Re.... or Message
1504 ;; some news reader is reported to use this
1514 ;; .emacs following a directory delimiter
1515 ;; in Unix, MSDOG or VMS syntax.
1518 ;; _emacs following a directory delimiter
1519 ;; in MsDos syntax
1532 ;; Get rid of any trailing .n.m and try again.
1533 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1534 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1535 ;; Using mode nil rather than `ignore' would let the search continue
1536 ;; through this list (with the shortened name) rather than start over.
1538 ;; The following should come after the ChangeLog pattern
1539 ;; for the sake of ChangeLog.1, etc.
1540 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1543 "Alist of filename patterns vs corresponding major mode functions.
1544 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1545 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1546 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1547 mode function to use. FUNCTION will be called, unless it is nil.
1549 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1550 calling FUNCTION (if it's not nil), we delete the suffix that matched
1596 "Alist mapping interpreter names to major modes.
1597 This alist applies to files whose first line starts with `#!'.
1598 Each element looks like (INTERPRETER . MODE).
1599 The car of each element is compared with
1600 the name of the interpreter specified in the first line.
1607 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1608 When checking `inhibit-first-line-modes-regexps', we first discard
1614 "Regular expression matching interpreters, for file mode determination.
1615 This regular expression is matched against the first line of a file
1616 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1617 a mode from the file's name. If it matches, the file is assumed to
1618 be interpreted by the interpreter matched by the second group of the
1619 regular expression. The mode is then determined as the mode associated
1623 "Select major mode appropriate for current buffer.
1624 This checks for a -*- mode tag in the buffer's text,
1625 compares the filename against the entries in `auto-mode-alist',
1626 or checks the interpreter that runs this file against
1627 `interpreter-mode-alist'.
1629 It does not check for the `mode:' local variable in the
1630 Local Variables section of the file; for that, use `hack-local-variables'.
1632 If `enable-local-variables' is nil, this function does not check for a
1633 -*- mode tag.
1635 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1636 then we do not set anything but the major mode,
1637 and we don't even do that unless it would come from the file name."
1638 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1646 ;; Find all specifications for the `mode:' variable
1647 ;; and execute them left to right.
1659 modes)))
1660 ;; Simple -*-MODE-*- case.
1663 modes))))
1664 ;; If we found modes to use, invoke them now,
1665 ;; outside the save-excursion.
1672 ;; If we didn't find a mode from a -*- line, try using the file name.
1676 ;; Remove backup-suffixes from file name.
1682 ;; Find first matching alist entry.
1691 keep-going t)
1693 keep-going nil)))
1696 ;; When JUST-FROM-FILE-NAME is set,
1697 ;; we are working on behalf of set-visited-file-name.
1698 ;; In that case, if the major mode specified is the
1699 ;; same one we already have, don't actually reset it.
1700 ;; We don't want to lose minor modes such as Font Lock.
1703 ;; If we can't deduce a mode from the file name,
1704 ;; look for an interpreter specified in the first line.
1705 ;; As a special case, allow for things like "#!/bin/env perl",
1706 ;; which finds the interpreter anywhere in $PATH.
1713 elt)
1714 ;; Map interpreter name to a mode.
1716 interpreter-mode-alist))
1723 "Find the -*- spec in the buffer.
1724 Call with point at the place to start searching from.
1725 If one is found, set point to the beginning
1726 and return the position of the end.
1727 Otherwise, return nil; point may be changed."
1730 ;; Don't look for -*- if this file name matches any
1731 ;; of the regexps in inhibit-first-line-modes-regexps.
1739 sufs)
1747 ;; If the file begins with "#!"
1748 ;; (exec interpreter magic), look
1749 ;; for mode frobs in the first two
1750 ;; lines. You cannot necessarily
1751 ;; put them in the first line of
1752 ;; such a file without screwing up
1753 ;; the interpreter invocation.
1761 t))
1767 end))))
1770 "Set local variables specified in the -*- line.
1771 Ignore any specification for `mode:' and `coding:';
1772 `set-auto-mode' should already have handled `mode:',
1773 `set-auto-coding' should already have handled `coding:'."
1780 ;; Parse the -*- line into the `result' alist.
1782 nil)
1784 ;; Simple form: "-*- MODENAME -*-". Already handled.
1785 nil)
1787 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1788 ;; (last ";" is optional).
1793 ;; There used to be a downcase here,
1794 ;; but the manual didn't say so,
1795 ;; and people want to set var names that aren't all lc.
1802 ;; It is traditional to ignore
1803 ;; case when checking for `mode' in set-auto-mode,
1804 ;; so we must do that here as well.
1805 ;; That is inconsistent, but we're stuck with it.
1806 ;; The same can be said for `coding' in set-auto-coding.
1820 ;; If we fail to switch in the selected window,
1821 ;; it is probably a minibuffer.
1822 ;; So try another window.
1835 "Normal hook run after processing a file's local variables specs.
1836 Major modes can use this to examine user-specified local variables
1840 "Parse and put into effect this buffer's local variables spec.
1841 If MODE-ONLY is non-nil, all we do is check whether the major mode
1842 is specified, returning t if it is specified."
1845 ;; Look for "Local variables:" line in last page.
1855 mode-only
1865 buffer-file-name)
1869 prefix prefixlen suffix beg
1870 mode-specified
1872 ;; The prefix is what comes before "local variables:" in its line.
1873 ;; The suffix is what comes after "local variables:" in its line.
1888 ;; Look at next local variable spec.
1891 ;; Skip the prefix, if any.
1896 ;; Find the variable name; strip whitespace.
1904 val)
1905 ;; Setting variable named "end" means end of list.
1908 ;; Otherwise read the variable value.
1919 ;; Set the variable. "Variables" mode and eval are funny.
1923 mode-specified))
1929 ;; Get confirmation before setting these variables as locals in a file.
1953 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1980 ;; This one is safe because the user gets to check it before it is used.
1988 A few patterns are specified so that any name which matches one
1989 is considered risky."
1994 ;; We have already handled coding: tag in set-auto-coding.
1995 nil)
1997 nil)
1998 ;; "Setting" eval means either eval it or do nothing.
1999 ;; Likewise for setting hook variables.
2002 (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$"
2005 ;; Permit evalling a put of a harmless property.
2006 ;; if the args do nothing tricky.
2012 ;; Only allow safe values of lisp-indent-hook;
2013 ;; not functions.
2018 ;; Permit eval if not root and user says ok.
2037 ;; Ordinary variable, really set it.
2039 ;; Make sure the string has no text properties.
2040 ;; Some text properties can get evaluated in various ways,
2041 ;; so it is risky to put them on with a local variable list.
2046 \f
2049 However, the mode will not be changed if
2050 \(1) a local variables list or the `-*-' line specifies a major mode, or
2052 \ not suitable for ordinary files, or
2053 \(3) the new file name does not particularly specify any mode."
2058 "Change name of file visited in current buffer to FILENAME.
2059 The next time the buffer is saved it will go in the newly specified file.
2060 nil or empty string as argument means make buffer not be visiting any file.
2061 Remember to delete the initial contents of the minibuffer
2062 if you wish to pass an empty string as the argument.
2064 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2065 confirmation in the case where another buffer is already visiting FILENAME.
2067 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2068 the old visited file has been renamed to the new name FILENAME."
2076 nil
2087 filename)))
2106 ;; Abbreviate the file names of the buffer.
2115 nil)))
2116 ;; write-file-hooks is normally used for things like ftp-find-file
2117 ;; that visit things that are not local files as if they were files.
2118 ;; Changing to visit an ordinary local file instead should flush the hook.
2123 ;; If buffer was read-only because of version control,
2124 ;; that reason is gone now, so make it writable.
2128 ;; Turn off backup files for certain file names.
2129 ;; Since this is a permanent local, the major mode won't eliminate it.
2136 ;; If auto-save was not already on, turn it on if appropriate.
2140 ;; If auto save is on, start using a new name.
2141 ;; We deliberately don't rename or delete the old auto save
2142 ;; for the old visited file name. This is because perhaps
2143 ;; the user wants to save the new state and then compare with the
2144 ;; previous state from the auto save file.
2147 ;; Rename the old auto save file if any.
2154 ;; Update the major mode, if the file name determines it.
2156 ;; Don't change the mode if it is special.
2159 ;; Don't change the mode if the local variable list specifies it.
2165 "Write current buffer into file FILENAME.
2166 This makes the buffer visit that file, and marks it as not modified.
2168 If you specify just a directory name as FILENAME, that means to use
2169 the default file name but in that directory. You can also yank
2170 the default file name into the minibuffer to edit it, using M-n.
2172 If the buffer is not already visiting a file, the default file name
2173 for the output file is the buffer name.
2175 If optional second arg CONFIRM is non-nil, this function
2176 asks for confirmation before overwriting an existing file.
2177 Interactively, confirmation is required unless you supply a prefix argument."
2178 ;; (interactive "FWrite file: ")
2182 nil nil nil nil)
2186 default-directory)
2187 nil nil))
2191 ;; If arg is just a directory,
2192 ;; use the default file name, but in that directory.
2203 ;; Make buffer writable if file is writable.
2208 \f
2210 "Make a backup of the disk file visited by the current buffer, if appropriate.
2211 This is normally done before saving the buffer the first time.
2212 If the value is non-nil, it is the result of `file-modes' on the original
2213 file; this means that the caller, after saving the buffer, should change
2214 the modes of the new file to agree with the old modes.
2216 A backup may be done by renaming or by copying; see documentation of
2217 variable `make-backup-files'. If it's done by renaming, then the file is
2218 no longer accessible under its old name."
2225 backup-info backupname targets setmodes)
2226 ;; If specified name is a symbolic link, chase it to the target.
2227 ;; Thus we make the backups in the directory where the real file is.
2232 ;; (if (file-directory-p buffer-file-name)
2233 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2237 ;; If have old versions to maybe delete,
2238 ;; ask the user to confirm now, before doing anything.
2239 ;; But don't actually delete til later.
2244 real-file-name))))))
2245 ;; Actually write the back up file.
2248 ; (file-symlink-p buffer-file-name)
2249 backup-by-copying
2264 ;; If copying fails because file BACKUPNAME
2265 ;; is not writable, delete that file and try again.
2270 ;; rename-file should delete old backup.
2274 ;; If trouble writing the backup, write it in ~.
2284 ;; If copying fails because file BACKUPNAME
2285 ;; is not writable, delete that file and try again.
2291 ;; Now delete the old versions, if desired.
2298 setmodes)
2302 "Return file NAME sans backup versions or strings.
2303 This is a separate procedure so your site-init or startup file can
2304 redefine it.
2305 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2306 we do not remove backup version numbers, only true file version numbers."
2312 ;; VMS version number is (a) semicolon, optional
2313 ;; sign, zero or more digits or (b) period, option
2314 ;; sign, zero or more digits, provided this is the
2315 ;; second period encountered outside of the
2316 ;; device/directory part of the file name.
2319 name)
2329 "Return t if deleting FILE and rewriting it would preserve the owner."
2334 ;; Return t if the file doesn't exist, since it's true that no
2335 ;; information would be lost by an (attempted) delete and create.
2341 The extension, in a file name, is the part that follows the last `.',
2342 except that a leading `.', if any, doesn't count."
2345 directory)
2350 directory)
2352 filename))))
2356 The extension, in a file name, is the part that follows the last `.',
2357 except that a leading `.', if any, doesn't count.
2358 Return nil for extensionless file names such as `foo'.
2359 Return the empty string for file names such as `foo.'.
2361 If PERIOD is non-nil, then the returned value includes the period
2362 that delimits the extension, and if FILENAME has no extension,
2373 "A function to use instead of the default `make-backup-file-name'.
2374 A value of nil gives the default `make-backup-file-name' behaviour.
2376 This could be buffer-local to do something special for specific
2377 files. If you define it, you may need to change `backup-file-name-p'
2378 and `file-name-sans-versions' too.
2380 See also `backup-directory-alist'."
2386 "Alist of filename patterns and backup directory names.
2387 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2388 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2389 relative or absolute. If it is absolute, so that all matching files
2390 are backed up into the same directory, the file names in this
2391 directory will be the full name of the file backed up with all
2392 directory separators changed to `!' to prevent clashes. This will not
2393 work correctly if your filesystem truncates the resulting name.
2395 For the common case of all backups going into one directory, the alist
2397 directory name.
2399 If this variable is nil, or it fails to match a filename, the backup
2400 is made in the original file's directory.
2402 On MS-DOS filesystems without long names this variable is always
2403 ignored."
2409 "Default `backup-enable-predicate' function.
2410 Checks for files in `temporary-file-directory' or
2411 `small-temporary-file-directory'."
2414 ;; Directory is under temporary-file-directory.
2419 0 nil
2421 ;; Directory is under small-temporary-file-directory.
2426 "Create the non-numeric backup file name for FILE.
2427 Normally this will just be the file's name with `~' appended.
2428 Customization hooks are provided as follows.
2430 If the variable `make-backup-file-name-function' is non-nil, its value
2431 should be a function which will be called with FILE as its argument;
2432 the resulting name is used.
2434 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2435 the documentation of that variable. If the directory for the backup
2436 doesn't exist, it is created."
2450 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2452 elt backup-directory dir-sep-string)
2457 alist nil)))
2459 file
2467 ;; Normalize DOSish file names: convert all slashes to
2468 ;; directory-sep-char, downcase the drive letter, if any,
2469 ;; and replace the leading "x:" with "/drive_x".
2472 ;; Replace any invalid file-name characters (for the
2473 ;; case of backing up remote files).
2478 "drive_"
2481 ""
2482 dir-sep-string)
2484 ;; Make the name unique by substituting directory
2485 ;; separators. It may not really be worth bothering about
2486 ;; doubling `!'s in the original name...
2489 directory-sep-char ?!
2491 backup-directory))
2498 "Return non-nil if FILE is a backup file name (numeric or not).
2499 This is a separate function so you can redefine it for customization.
2500 You may need to redefine `file-name-sans-versions' as well."
2505 ;; This is used in various files.
2506 ;; The usage of backup-extract-version-start is not very clean,
2507 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2509 "Given the name of a numeric backup file, FN, return the backup number.
2510 Uses the free variable `backup-extract-version-start', whose value should be
2511 the index in the name where the version number begins."
2517 ;; I believe there is no need to alter this behavior for VMS;
2518 ;; since backup files are not made on VMS, it should not get called.
2520 "Find a file name for a backup file FN, and suggestions for deletions.
2521 Value is a list whose car is the name for the backup file
2522 and whose cdr is a list of old versions to consider deleting now.
2523 If the value is nil, don't make a backup.
2524 Uses `backup-directory-alist' in the same way as does
2525 `make-backup-file-name'."
2527 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2531 ;; We don't support numbered backups on plain MS-DOS
2532 ;; when long file names are unavailable.
2542 possibilities deserve-versions-p versions)
2545 base-versions
2548 possibilities)
2549 #'<)
2554 kept-old-versions
2555 kept-new-versions
2562 ;; Delete nothing if there is overflow
2563 ;; in the number of versions to keep.
2569 v))))))))))
2572 "Return number of names file FILENAME has."
2576 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2577 This function returns a relative file name which is equivalent to FILENAME
2578 when used with that default directory as the default.
2579 If this is impossible (which can happen on MSDOS and Windows
2580 when the file name and directory use different drive names)
2581 then it returns FILENAME."
2586 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2587 ;; drive names, they can't be relative, so return the absolute name.
2592 filename
2599 ".."
2601 ;; Now ancestor is empty, or .., or ../.., etc.
2603 ;; We matched within FNAME's directory part.
2604 ;; Add the rest of FNAME onto ANCESTOR.
2608 ;; But don't bother with ANCESTOR if it would give us `./'.
2609 rest
2611 ;; We matched FNAME's directory equivalent.
2612 ancestor))))))
2613 \f
2615 "Save current buffer in visited file if modified. Versions described below.
2616 By default, makes the previous version into a backup file
2617 if previously requested or if this is the first save.
2619 to become a backup when the next save is done.
2621 unconditionally makes the previous version into a backup file.
2623 to become a backup when the next save is done,
2624 and unconditionally makes the previous version into a backup file.
2626 With argument of 0, never make the previous version into a backup file.
2628 If a file's name is FOO, the names of its numbered backup versions are
2629 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2630 Numeric backups (rather than FOO~) will be made if value of
2631 `version-control' is not the atom `never' and either there are already
2632 numeric versions of the file being backed up, or `version-control' is
2633 non-nil.
2634 We don't want excessive versions piling up, so there are variables
2635 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2636 and `kept-new-versions', which tells how many newest versions to keep.
2637 Defaults are 2 old versions and 2 new.
2638 `dired-kept-versions' controls dired's clean-directory (.) command.
2639 If `delete-old-versions' is nil, system will query user
2640 before trimming versions. Otherwise it does it silently.
2642 If `vc-make-backup-files' is nil, which is the default,
2643 no backup files are made for files managed by version control.
2644 (This is because the version control system itself records previous versions.)
2646 See the subroutine `basic-save-buffer' for more information."
2659 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2660 Normally delete only if the file was written by this Emacs since
2661 the last real save, but optional arg FORCE non-nil means delete anyway."
2675 "Normal hook that is run after a buffer is saved to its file."
2681 "If non-nil, use this coding system for saving the buffer.
2682 More precisely, use this coding system in place of the
2683 value of `buffer-file-coding-system', when saving the buffer.
2684 Calling `write-region' for any purpose other than saving the buffer
2685 will still use `buffer-file-coding-system'; this variable has no effect
2692 "Save the current buffer in its visited file, if it has been modified.
2693 The hooks `write-contents-hooks', `local-write-file-hooks' and
2694 `write-file-hooks' get a chance to do the job of saving; if they do not,
2695 then the buffer is saved in the visited file file in the usual way.
2696 After saving the buffer, this function runs `after-save-hook'."
2699 ;; In an indirect buffer, save its base buffer instead.
2704 setmodes tempsetmodes)
2705 ;; On VMS, rename file and buffer to get rid of version number.
2710 ;; Strip VMS version number before save.
2713 ;; Construct a (unique) buffer name to correspond.
2718 ;; If buffer has no file name, ask user for one.
2725 filename))
2750 ;; Support VC version backups.
2755 ;; If a hook returned t, file is already "written".
2756 ;; Otherwise, write it the usual way now.
2758 ;; Now we have saved the current buffer. Let's make sure
2759 ;; that buffer-file-coding-system is fixed to what
2760 ;; actually used for saving by binding it locally.
2770 ;; If the auto-save file was recent before this command,
2771 ;; delete it now.
2773 ;; Support VC `implicit' locking.
2778 ;; This does the "real job" of writing a buffer into its visited file
2779 ;; and making a backup file. This is what is normally done
2780 ;; but inhibited if one of write-file-hooks returns non-nil.
2781 ;; It returns a value to store in setmodes.
2801 buffer-file-name)))
2809 ;; If file is precious, write temp name, then rename it.
2810 ;; This requires write access to the containing dir,
2811 ;; which is why we don't try it if we don't have that access.
2813 tempname temp nogood i succeed
2817 ;; Find the temporary name to write under.
2824 "%s$tmp$%d"
2826 dir i))
2832 tempname nil realname
2833 buffer-file-truename)
2835 ;; If writing the temp file fails,
2836 ;; delete the temp file.
2843 ;; Since we have created an entirely new file
2844 ;; and renamed it, make sure it gets the
2845 ;; right permission bits set.
2847 ;; We succeeded in writing the temp file,
2848 ;; so rename it.
2850 ;; If file not writable, see if we can make it writable
2851 ;; temporarily while we write it.
2852 ;; But no need to do so if we have just backed it up
2853 ;; (setmodes is set) because that says we're superseding.
2855 ;; Change the mode back, after writing.
2859 buffer-file-name nil t buffer-file-truename)))
2860 setmodes))
2863 "Save some modified file-visiting buffers. Asks user about each one.
2864 Optional argument (the prefix) non-nil means save all with no questions.
2865 Optional second argument PRED determines which buffers are considered:
2866 If PRED is nil, all the file-visiting buffers are considered.
2867 If PRED is t, then certain non-file buffers will also be considered.
2868 If PRED is a zero-argument function, it indicates for each buffer whether
2869 to consider it or not when called with that buffer current."
2888 t
2907 ;; Return nil to ask about BUF again.
2908 nil)
2916 abbrev-file-name)))
2918 ;; Don't keep bothering user if he says no.
2920 t))))
2923 \f
2925 "Mark current buffer as unmodified, not needing to be saved.
2928 It is not a good idea to use this function in Lisp programs, because it
2929 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2936 "Change whether this buffer is visiting its file read-only.
2937 With arg, set read-only iff arg is positive.
2938 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2944 ;; Toggle.
2956 "Insert contents of file FILENAME into buffer after point.
2957 Set mark after the inserted text.
2959 This function is meant for the user to run interactively.
2960 Don't call it from programs! Use `insert-file-contents' instead.
2961 \(Its calling sequence is different; see its documentation)."
2965 filename)))
2970 "Append the contents of the region to the end of file FILENAME.
2971 When called from a function, expects three arguments,
2972 START, END and FILENAME. START and END are buffer positions
2973 saying what text to write."
2978 "Return most recent backup file for FILENAME or nil if no backups exist."
2979 ;; `make-backup-file-name' will get us the right directory for
2980 ;; ordinary or numeric backups. It might create a directory for
2981 ;; backups as a side-effect, according to `backup-directory-alist'.
2987 tem)
2996 newest))
2999 "Rename current buffer to a similar name not already taken.
3000 This function is useful for creating multiple shell process buffers
3001 or multiple mail buffers, etc."
3009 ;; If the existing buffer name has a <NNN>,
3010 ;; which isn't part of the file name (if any),
3011 ;; then get rid of that.
3017 "Create the directory DIR and any nonexistent parent dirs.
3018 Interactively, the default choice of directory to create
3019 is the current default directory for file names.
3020 That is useful when you have visited a file in a nonexistent directory.
3022 Noninteractively, the second (optional) argument PARENTS says whether
3023 to create parent directories if they don't exist."
3026 nil nil)
3027 t))
3034 create-list)
3041 \f
3044 "Function to use to revert this buffer, or nil to do the default.
3045 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3050 "Function to use to insert contents when reverting this buffer.
3051 Gets two args, first the nominal file name to use,
3052 and second, t if reading the auto-save file.
3057 "Normal hook for `revert-buffer' to run before reverting.
3058 If `revert-buffer-function' is used to override the normal revert
3062 "Normal hook for `revert-buffer' to run after reverting.
3063 Note that the hook value that it runs is the value that was in effect
3064 before reverting; that makes a difference if you have buffer-local
3065 hook functions.
3067 If `revert-buffer-function' is used to override the normal revert
3073 "Replace current buffer text with the text of the visited file on disk.
3074 This undoes all changes since the file was visited or saved.
3075 With a prefix argument, offer to revert from latest auto-save file, if
3076 that is more recent than the visited file.
3078 This command also works for special buffers that contain text which
3079 doesn't come from a file, but reflects some other data base instead:
3080 for example, Dired buffers and buffer-list buffers. In these cases,
3081 it reconstructs the buffer contents from the appropriate data base.
3083 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3084 to revert from the auto-save file when this is nil. Note that the
3085 sense of this argument is the reverse of the prefix argument, for the
3086 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3087 to nil.
3089 Optional second argument NOCONFIRM means don't ask for confirmation at
3090 all. (The local variable `revert-without-query', if non-nil, prevents
3091 confirmation.)
3093 Optional third argument PRESERVE-MODES non-nil means don't alter
3094 the files modes. Normally we reinitialize them using `normal-mode'.
3096 If the value of `revert-buffer-function' is non-nil, it is called to
3097 do all the work for this command. Otherwise, the hooks
3098 `before-revert-hook' and `after-revert-hook' are run at the beginning
3099 and the end, and if `revert-buffer-insert-file-contents-function' is
3100 non-nil, it is called instead of rereading visited file contents."
3102 ;; I admit it's odd to reverse the sense of the prefix argument, but
3103 ;; there is a lot of code out there which assumes that the first
3104 ;; argument should be t to avoid consulting the auto-save file, and
3105 ;; there's no straightforward way to encourage authors to notice a
3106 ;; reversal of the argument sense. So I'm just changing the user
3107 ;; interface, but leaving the programmatic interface the same.
3113 buffer-auto-save-file-name
3118 buffer-auto-save-file-name
3119 buffer-file-name)))
3130 found))
3132 file-name)))
3134 ;; If file was backed up but has changed since,
3135 ;; we shd make another backup.
3139 ;; Get rid of all undo records for this buffer.
3142 ;; Effectively copy the after-revert-hook status,
3143 ;; since after-find-file will clobber it.
3147 after-revert-hook)))
3149 ;; Don't make undo records for the reversion.
3153 file-name auto-save-p)
3156 ;; Bind buffer-file-name to nil
3157 ;; so that we don't try to lock the file.
3163 ;; Auto-saved file shoule be read without
3164 ;; any code conversion.
3166 coding-system-for-read)))
3167 ;; Note that this preserves point in an intelligent way.
3169 nil nil t))))
3170 ;; Recompute the truename in case changes in symlinks
3171 ;; have changed the truename.
3175 ;; Run after-revert-hook as it was before we reverted.
3183 t)))))
3186 "Visit file FILE, but get contents from its last auto-save file."
3187 ;; Actually putting the file name in the minibuffer should be used
3188 ;; only rarely.
3189 ;; Not just because users often use the default.
3208 ;; Use insert-directory-safely, not insert-directory,
3209 ;; because these files might not exist. In particular,
3210 ;; FILE might not exist if the auto-save file was for
3211 ;; a buffer that didn't visit a file, such as "*mail*".
3212 ;; The code in v20.x called `ls' directly, so we need
3213 ;; to emulate what `ls' did in that case.
3219 ;; Keep the current buffer-file-coding-system.
3221 ;; Auto-saved file shoule be read without any code conversion.
3230 "Recover auto save files from a previous Emacs session.
3231 This command first displays a Dired buffer showing you the
3232 previous sessions that you could recover from.
3233 To choose one, move point to the proper line and then type C-c C-c.
3234 Then you'll be asked about a number of files to recover."
3248 ;; Each line starts with a space
3249 ;; so that Font Lock mode won't highlight the first character.
3258 "Choose one saved session to recover auto-save files from.
3259 This command is used in the special Dired buffer created by
3262 ;; Get the name of the session file to recover from.
3264 files
3270 ;; Read in the auto-save-list file.
3274 ;; Loop thru the text of that file
3275 ;; and get out the names of the files to recover.
3279 ;; This is a pair of lines for a non-file-visiting buffer.
3280 ;; Get the auto-save file name and manufacture
3281 ;; a "visited file name" from that.
3297 ;; This pair of lines is a file-visiting
3298 ;; buffer. Use the visited file name.
3308 ;; Ignore a file if its auto-save file does not exist now.
3312 ;; The file contains a pair of line for each auto-saved buffer.
3313 ;; The first line of the pair contains the visited file name
3314 ;; or is empty if the buffer was not visiting a file.
3315 ;; The second line is the auto-save file name.
3323 files
3329 "For each buffer in LIST, ask whether to kill it.
3330 LIST defaults to all existing live buffers."
3341 name
3346 \f
3348 "Toggle auto-saving of contents of current buffer.
3349 With prefix argument ARG, turn auto-saving on if positive, else off."
3354 ;; If auto-save is off because buffer has shrunk,
3355 ;; then toggling should turn it on.
3360 buffer-file-name
3362 ;; If -1 was stored here, to temporarily turn off saving,
3363 ;; turn it back on.
3369 buffer-auto-save-file-name)
3372 "Adjust current buffer's auto save file name for current conditions.
3373 Also rename any existing auto save file, if it was made in this session."
3385 "Return file name to use for auto-saves of current buffer.
3386 Does not consider `auto-save-visited-file-name' as that variable is checked
3387 before calling this function. You can redefine this for customization.
3388 See also `auto-save-file-name-p'."
3392 result uniq)
3393 ;; Apply user-specified translations
3394 ;; to the file name.
3398 filename)
3406 directory-sep-char ?!
3408 filename))))
3413 ;; We truncate the file name to DOS 8+3 limits
3414 ;; before doing anything else, because the regexp
3415 ;; passed to string-match below cannot handle
3416 ;; extensions longer than 3 characters, multiple
3417 ;; dots, and other atrocities.
3422 fn)
3427 "#"
3430 ;; Make sure auto-save file names don't contain characters
3431 ;; invalid for the underlying filesystem.
3433 ;; Don't modify remote (ange-ftp) filenames
3436 result))
3438 ;; Deal with buffers that don't have any associated files. (Mail
3439 ;; mode tends to create a good number of these.)
3443 ;; Eliminate all slashes and backslashes by
3444 ;; replacing them with sequences that start with %.
3445 ;; Quote % also, to keep distinct names distinct.
3454 ;; Generate the file name.
3459 ;; Try a few alternative directories, to get one we can
3460 ;; write it.
3466 ;; Don't modify remote (ange-ftp) filenames
3468 ;; The call to convert-standard-filename is in case
3469 ;; buffer-name includes characters not allowed by the
3470 ;; DOS/Windows filesystems. make-temp-file writes to the
3471 ;; file it creates, so we must fix the file name _before_
3472 ;; make-temp-file is called.
3474 fname))
3478 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3479 FILENAME should lack slashes. You can redefine this for customization."
3481 \f
3483 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3484 The generated regexp will match a filename iff the filename
3485 matches that wildcard according to shell rules. Only wildcards known
3486 by `sh' are supported."
3488 ;; Copy the initial run of non-special characters.
3491 ;; If no special characters, we're almost done.
3495 j)
3497 result
3518 ;; Found "[^". Insert a `\0' character
3519 ;; (which cannot happen in a filename)
3520 ;; into the character class, so that `^'
3521 ;; is not the first character after `[',
3522 ;; and thus non-special in a regexp.
3527 ;; I don't think `]' can appear in a
3528 ;; character class in a wildcard, but
3529 ;; let's be general here.
3536 i
3549 ;; Shell wildcards should match the entire filename,
3550 ;; not its part. Make the regexp say so.
3552 \f
3555 "*Switches for `list-directory' to pass to `ls' for brief listing."
3561 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3563 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3568 "Expand wildcard pattern PATTERN.
3569 This returns a list of file names which match the pattern.
3571 If PATTERN is written as an absolute relative file name,
3572 the values are absolute also.
3574 If PATTERN is written as a relative file name, it is interpreted
3575 relative to the current default directory, `default-directory'.
3576 The file names returned are normally also relative to the current
3577 default directory. However, if FULL is non-nil, they are absolute."
3581 ;; A list of all dirs that DIRPART specifies.
3582 ;; This can be more than one dir
3583 ;; if DIRPART contains wildcards.
3588 contents)
3593 ;; Filter out "." and ".."
3598 name))
3605 this-dir-contents)
3606 this-dir-contents)
3607 contents))))
3609 contents)))
3612 "Display a list of files in or matching DIRNAME, a la `ls'.
3613 DIRNAME is globbed by the shell if necessary.
3614 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3615 Actions controlled by variables `list-directory-brief-switches'
3616 and `list-directory-verbose-switches'."
3620 nil default-directory nil)
3621 pfx)))
3623 list-directory-brief-switches))
3624 buffer)
3637 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
3645 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3647 PATTERN is assumed to represent a file-name wildcard suitable for the
3648 underlying filesystem. For Unix and GNU/Linux, the characters from the
3650 the parts of the pattern which don't include wildcard characters are
3651 quoted with double quotes.
3652 Existing quote characters in PATTERN are left alone, so you can pass
3653 PATTERN that already quotes some of the special characters."
3657 ;; DOS/Windows don't allow `"' in file names. So if the
3658 ;; argument has quotes, we can safely assume it is already
3659 ;; quoted by the caller.
3661 ;; We quote [&()#$'] in case their shell is a port of a
3662 ;; Unixy shell. We quote [,=+] because stock DOS and
3663 ;; Windows shells require that in some cases, such as
3664 ;; passing arguments to batch files that use positional
3665 ;; arguments like %1.
3667 pattern
3670 end)
3687 pattern))))
3694 "*Program to get the amount of free space on a file system.
3695 We assume the output has the format of `df'.
3696 The value of this variable must be just a command name or file name;
3697 if you want to specify options, use `directory-free-space-args'.
3699 A value of nil disables this feature.
3701 If the function `file-system-info' is defined, it is always used in
3702 preference to the program given by this variable."
3707 "*Options to use when running `directory-free-space-program'."
3712 "Return the mount of free space on directory DIR's file system.
3713 The result is a string that gives the number of free 1KB blocks,
3714 or nil if the system call or the program which retrieve the infornmation
3715 fail.
3717 This function calls `file-system-info' if it is available, or invokes the
3718 program specified by `directory-free-space-program' if that is non-nil."
3719 ;; Try to find the number of free blocks. Non-Posix systems don't
3720 ;; always have df, but might have an equivalent system call.
3729 nil t nil
3730 directory-free-space-args
3731 dir)))
3732 ;; Usual format is a header line followed by a line of
3733 ;; numbers.
3738 ;; Move to the end of the "available blocks" number.
3741 ;; Copy it into AVAILABLE.
3747 ;; insert-directory
3748 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3749 ;; FULL-DIRECTORY-P is nil.
3750 ;; The single line of output must display FILE's name as it was
3751 ;; given, namely, an absolute path name.
3752 ;; - must insert exactly one line for each file if WILDCARD or
3753 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3754 ;; before the file lines, plus optional text after the file lines.
3755 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3756 ;; allowed.
3757 ;; File lines should display the basename.
3758 ;; - must be consistent with
3759 ;; - functions dired-move-to-filename, (these two define what a file line is)
3760 ;; dired-move-to-end-of-filename,
3761 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3762 ;; dired-insert-headerline
3763 ;; dired-after-subdir-garbage (defines what a "total" line is)
3764 ;; - variable dired-subdir-regexp
3766 "Insert directory listing for FILE, formatted according to SWITCHES.
3767 Leaves point after the inserted text.
3768 SWITCHES may be a string of options, or a list of strings.
3769 Optional third arg WILDCARD means treat FILE as shell wildcard.
3770 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3771 switches do not contain `d', so that a full listing is expected.
3773 This works by running a directory listing program
3774 whose name is in the variable `insert-directory-program'.
3775 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3776 ;; We need the directory in order to find the right handler.
3781 wildcard full-directory-p)
3786 ;; Read the actual directory using `insert-directory-program'.
3787 ;; RESULT gets the status code.
3791 default-file-name-coding-system)))
3792 ;; This is to control encoding the arguments in call-process.
3796 ;; Run ls in the directory part of the file pattern
3797 ;; using the last component as argument.
3804 shell-file-name nil t nil
3805 "-c"
3807 ""
3809 insert-directory-program
3810 " -d "
3812 switches
3814 " -- "
3815 ;; Quote some characters that have
3816 ;; special meanings in shells; but
3817 ;; don't quote the wildcards--we want
3818 ;; them to be special. We also
3819 ;; currently don't quote the quoting
3820 ;; characters in case people want to
3821 ;; use them explicitly to quote
3822 ;; wildcard characters.
3824 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3825 ;; directory if FILE is a symbolic link.
3827 insert-directory-program nil t nil
3831 ;; Split the switches at any spaces so we can
3832 ;; pass separate options as separate args.
3834 ;; Avoid lossage if FILE starts with `-'.
3842 file))))))))
3844 ;; If `insert-directory-program' failed, signal an error.
3846 ;; On non-Posix systems, we cannot open a directory, so
3847 ;; don't even try, because that will always result in
3848 ;; the ubiquitous "Access denied". Instead, show the
3849 ;; command line so the user can try to guess what went wrong.
3854 insert-directory-program
3856 file result)
3857 ;; Unix. Access the file to get a suitable error.
3861 ;; Try to insert the amount of free space.
3864 ;; First find the line to put it on.
3868 ;; Replace "total" with "used", to avoid confusion.
3875 "Insert directory listing for FILE, formatted according to SWITCHES.
3877 Like `insert-directory', but if FILE does not exist, it inserts a
3878 message to that effect instead of signaling an error."
3881 ;; Simulate the message printed by `ls'.
3885 "Functions to call with no arguments to query about killing Emacs.
3886 If any of these functions returns nil, killing Emacs is cancelled.
3888 but `kill-emacs', the low level primitive, does not.
3892 "How to ask for confirmation when leaving Emacs.
3893 If nil, the default, don't ask at all. If the value is non-nil, it should
3894 be a predicate function such as `yes-or-no-p'."
3902 "Offer to save each buffer, then kill this Emacs process.
3903 With prefix arg, silently save all file-visiting buffers, then kill."
3912 ;; process-list is not defined on VMS.
3914 active)
3923 ;; Query the user for other things, perhaps.
3928 \f
3929 ;; We use /: as a prefix to "quote" a file name
3930 ;; so that magic file name handlers will not apply to it.
3934 file-name-handler-alist))
3936 ;; We depend on being the last handler on the list,
3937 ;; so that anything else which does need handling
3938 ;; has been handled already.
3939 ;; So it is safe for us to inhibit *all* magic file name handlers.
3948 default-directory))
3949 ;; Get a list of the indices of the args which are file names.
3952 ;; The first five are special because they
3953 ;; return a file name. We want to include the /:
3954 ;; in the return value.
3955 ;; So just avoid stripping it in the first place.
3961 ;; `identity' means just return the first arg
3962 ;; as stripped of its quoting.
3970 ;; For all other operations, treat the first argument only
3971 ;; as the file name.
3973 ;; Copy ARGUMENTS so we can replace elements in it.
3975 ;; Strip off the /: from the file names that have this handler.
3983 "/"
3989 \f
4012 ;;; files.el ends here