| blob | ca03ee8726bd0e51d6d3532bf5b6c5d0189fabaf |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
32 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "*Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "*Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 Do not use `~' in the TO strings.
63 They should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
75 ;; Turn off backup files on VMS since it has version numbers.
77 "*Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
106 "*Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
112 "*Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
119 "*Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
129 "*Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
141 "Predicate that looks at a file name and decides whether to make backups.
145 "*Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
153 "*Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
160 "*Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
167 "*Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
198 "The directory for writing temporary files."
204 "The directory for writing small temporary files.
205 If non-nil, this directory is used instead of `temporary-file-directory'
206 by programs that create small temporary files. This is for systems that
207 have fast storage with limited space, such as a RAM disk."
211 ;; The system null device. (Should reference NULL_DEVICE from C.)
228 "*Non-nil means protect against I/O errors while saving files.
229 Some modes set this non-nil in particular buffers.
231 This feature works by writing the new contents into a temporary file
232 and then renaming the temporary file to replace the original.
233 In this way, any I/O error in writing leaves the original untouched,
234 and there is never any instant where the file is nonexistent.
236 Note that this feature forces backups to be made by copying.
237 Yet, at the same time, saving a precious file
238 breaks any hard links between it and other files."
243 "*Control use of version numbers for backup files.
244 t means make numeric backup versions unconditionally.
245 nil means make them for files that have some already.
246 `never' means do not make them."
254 "*When cleaning directory, number of versions to keep."
260 "*If t, delete excess backup versions silently.
261 If nil, ask confirmation. Any other value prevents any trimming."
268 "*Number of oldest versions to keep when a new numbered backup is made."
273 "*Number of newest versions to keep when a new numbered backup is made.
274 Includes the new backup. Must be > 0"
279 "*Whether to add a newline automatically at the end of the file.
281 A value of t means do this only when the file is about to be saved.
282 A value of `visit' means do this right after the file is visited.
283 A value of `visit-save' means do it at both of those times.
284 Any other non-nil value means ask user whether to add a newline, when saving.
285 nil means don't add newlines.
287 Certain major modes set this locally to the value obtained
288 from `mode-require-final-newline'."
297 "*Whether to add a newline at end of file, in certain major modes.
298 Those modes set `require-final-newline' to this value when you enable them.
299 They do so because they are often used for files that are supposed
300 to end in newlines, and the question is how to arrange that.
302 A value of t means do this only when the file is about to be saved.
303 A value of `visit' means do this right after the file is visited.
304 A value of `visit-save' means do it at both of those times.
305 Any other non-nil value means ask user whether to add a newline, when saving.
307 nil means do not add newlines. That is a risky choice in this variable
308 since this value is used for modes for files that ought to have final newlines.
309 So if you set this to nil, you must explicitly check and add
310 a final newline, whenever you save a file that really needs one."
320 "*Non-nil says by default do auto-saving of every file-visiting buffer."
325 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
326 Normally auto-save files are written under other names."
332 ;; Don't put "\\2" inside expand-file-name, since it will be
333 ;; transformed to "/2" on DOS/Windows.
335 "*Transforms to apply to buffer file name before making auto-save file name.
336 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
337 REGEXP is a regular expression to match against the file name.
338 If it matches, `replace-match' is used to replace the
339 matching part with REPLACEMENT.
340 If the optional element UNIQUIFY is non-nil, the auto-save file name is
341 constructed by taking the directory part of the replaced file-name,
342 concatenated with the buffer file name with all directory separators
343 changed to `!' to prevent clashes. This will not work
344 correctly if your filesystem truncates the resulting name.
346 All the transforms in the list are tried, in the order they are listed.
347 When one transform applies, its result is final;
348 no further transforms are tried.
350 The default value is set up to put the auto-save file into the
351 temporary directory (see the variable `temporary-file-directory') for
352 editing a remote file.
354 On MS-DOS filesystems without long names this variable is always
355 ignored."
362 "*Non-nil means save word abbrevs too when files are saved.
363 If `silently', don't ask the user before saving."
368 "*Non-nil means allow `find-file' to visit directories.
369 To visit the directory, `find-file' runs `find-directory-functions'."
374 "*List of functions to try in sequence to visit a directory.
375 Each function is called with the directory name as the sole argument
376 and should return either a buffer or nil."
380 ;;;It is not useful to make this a local variable.
381 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
383 "List of functions to be called for `find-file' on nonexistent file.
384 These functions are called as soon as the error is detected.
385 Variable `buffer-file-name' is already set up.
390 ;;;It is not useful to make this a local variable.
391 ;;;(put 'find-file-hooks 'permanent-local t)
393 "List of functions to be called after a buffer is loaded from a file.
394 The buffer's local variables (if any) will have been processed before the
395 functions are called."
403 "List of functions to be called before writing out a buffer to a file.
404 If one of them returns non-nil, the file is considered already written
405 and the rest are not called.
406 These hooks are considered to pertain to the visited file.
407 So any buffer-local binding of this variable is discarded if you change
409 change the major mode.
411 This hook is not run if any of the functions in
412 `write-contents-functions' returns non-nil. Both hooks pertain
413 to how to save a buffer to file, for instance, choosing a suitable
414 coding system and setting mode bits. (See Info
415 node `(elisp)Saving Buffers'.) To perform various checks or
426 "List of functions to be called before writing out a buffer to a file.
427 If one of them returns non-nil, the file is considered already written
428 and the rest are not called and neither are the functions in
429 `write-file-functions'.
431 This variable is meant to be used for hooks that pertain to the
432 buffer's contents, not to the particular visited file; thus,
433 `set-visited-file-name' does not clear this variable; but changing the
434 major mode does clear it.
436 For hooks that _do_ pertain to the particular visited file, use
437 `write-file-functions'. Both this variable and
438 `write-file-functions' relate to how a buffer is saved to file.
439 To perform various checks or updates before the buffer is saved,
446 "*Control use of local variables in files you visit.
447 The value can be t, nil, :safe, or something else.
449 A value of t means file local variables specifications are obeyed
450 if all the specified variable values are safe; if any values are
451 not safe, Emacs queries you, once, whether to set them all.
452 \(When you say yes to certain values, they are remembered as safe.)
454 :safe means set the safe variables, and ignore the rest.
455 nil means always ignore the file local variables.
457 Any other value means always query you once whether to set them all.
458 \(When you say yes to certain values, they are remembered as safe, but
461 This variable also controls use of major modes specified in
462 a -*- line.
465 always obeys file local variable specifications and the -*- line,
466 and ignores this variable."
474 "Like `enable-local-variables' but meant for buffer-local bindings.
475 The meaningful values are nil and non-nil. The default is non-nil.
476 If a major mode sets this to nil, buffer-locally, then any local
477 variables list in the file will be ignored.
479 This variable does not affect the use of major modes
484 The value can be t, nil or something else.
485 A value of t means obey `eval' variables;
486 nil means ignore them; anything else means query."
492 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
501 "*Non-nil means buffers visiting files read-only do so in view mode.
502 In fact, this means that all read-only buffers normally have
503 View mode enabled, including buffers that are read-only because
504 you visit a file you cannot alter, and buffers you make read-only
511 "Provides support for ange-ftp host name completion.
512 Runs the usual ange-ftp hook, but only for completion operations."
513 ;; Having this here avoids the need to load ange-ftp when it's not
514 ;; really in use.
520 inhibit-file-name-handlers)))
525 "Convert a standard file's name to something suitable for the OS.
526 This means to guarantee valid names and perhaps to canonicalize
527 certain patterns.
529 FILENAME should be an absolute file name since the conversion rules
530 sometimes vary depending on the position in the file name. E.g. c:/foo
531 is a valid DOS file name, but c:/bar/c:/foo is not.
533 This function's standard definition is trivial; it just returns
534 the argument. However, on Windows and DOS, replace invalid
535 characters. On DOS, make sure to obey the 8.3 limitations. On
536 Windows, turn Cygwin names into native names, and also turn
537 slashes into backslashes if the shell requires it (see
538 `w32-shell-dos-semantics').
540 See Info node `(elisp)Standard File Names' for more details."
541 filename)
544 "Read directory name, prompting with PROMPT and completing in directory DIR.
545 Value is not expanded---you must call `expand-file-name' yourself.
546 Default name to DEFAULT-DIRNAME if user exits with the same
547 non-empty string that was inserted by this function.
548 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
549 or just DIR if INITIAL is nil.)
550 If the user exits with an empty minibuffer, this function returns
551 an empty string. (This can only happen if the user erased the
552 pre-inserted contents or if `insert-default-directory' is nil.)
553 Fourth arg MUSTMATCH non-nil means require existing directory's name.
554 Non-nil and non-t means also require confirmation after completion.
555 Fifth arg INITIAL specifies text to start with.
556 DIR should be an absolute directory name. It defaults to
557 the value of `default-directory'."
562 dir))
563 mustmatch initial
566 \f
568 "Show the current default directory."
573 "Value of the CDPATH environment variable, as a list.
577 "Explode a search path into a list of directory names.
578 Directories are separated by occurrences of `path-separator'
579 \(which is colon in GNU and GNU-like systems)."
580 ;; We could use split-string here.
588 nil
593 cd-list)))
596 "Change current directory to given absolute file name DIR."
597 ;; Put the name into directory syntax now,
598 ;; because otherwise expand-file-name may give some bad results.
611 "Make DIR become the current buffer's default directory.
612 If your environment includes a `CDPATH' variable, try each one of
613 that list of directories (separated by occurrences of
614 `path-separator') when resolving a relative directory name.
615 The path separator is colon in GNU and GNU-like systems."
618 default-directory default-directory
634 cd-path)
635 nil))
639 "Load the Lisp file named FILE."
640 ;; This is a case where .elc makes a lot of sense.
647 "Search for FILENAME through PATH.
648 If found, return the absolute file name of FILENAME, with its suffixes;
649 otherwise return nil.
650 PATH should be a list of directories to look in, like the lists in
651 `exec-path' or `load-path'.
652 If SUFFIXES is non-nil, it should be a list of suffixes to append to
655 If non-nil, PREDICATE is used instead of `file-readable-p'.
656 PREDICATE can also be an integer to pass to the `access' system call,
657 in which case file-name handlers are ignored. This usage is deprecated.
659 For compatibility, PREDICATE can also be one of the symbols
660 `executable', `readable', `writable', or `exists', or a list of
661 one or more of those symbols."
672 "Do completion for file names passed to `locate-file'.
673 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
696 "Search for COMMAND in `exec-path' and return the absolute file name.
697 Return nil if COMMAND is not found anywhere in `exec-path'."
698 ;; Use 1 rather than file-executable-p to better match the behavior of
699 ;; call-process.
703 "Load the library named LIBRARY.
704 This is an interface to the function `load'."
707 'locate-file-completion
712 "Test whether FILE specifies a location on a remote system.
713 Return an identification of the system if the location is indeed
714 remote. The identification of the system may comprise a method
715 to access the system and its hostname, amongst other things.
722 nil)))
725 "Copy the file FILE into a temporary file on this machine.
726 Returns the name of the local copy, or nil, if FILE is directly
727 accessible."
728 ;; This formerly had an optional BUFFER argument that wasn't used by
729 ;; anything.
733 nil)))
736 "Return the truename of FILENAME, which should be absolute.
737 The truename of a file name is found by chasing symbolic links
738 both at the level of the file and at the level of the directories
739 containing it, until no links are left at any level.
742 ;; COUNTER and PREV-DIRS are only used in recursive calls.
743 ;; COUNTER can be a cons cell whose car is the count of how many
744 ;; more links to chase before getting an error.
745 ;; PREV-DIRS can be a cons cell whose car is an alist
746 ;; of truenames we've just recently computed.
760 ;; For speed, remove the ange-ftp completion handler from the list.
761 ;; We know it's not needed here.
762 ;; For even more speed, do this only on the outermost call.
769 ;; andrewi@harlequin.co.uk - none of the following code (except for
770 ;; invoking the file-name handler) currently applies on Windows
771 ;; (ie. there are no native symlinks), but there is an issue with
772 ;; case differences being ignored by the OS, and short "8.3 DOS"
773 ;; name aliases existing for all files. (The short names are not
774 ;; reported by directory-files, but can be used to refer to files.)
775 ;; It seems appropriate for file-truename to resolve these issues in
776 ;; the most natural way, which on Windows is to call the function
777 ;; `w32-long-file-name' - this returns the exact name of a file as
778 ;; it is stored on disk (expanding short name aliases with the full
779 ;; name in the process).
782 ;; For file name that has a special handler, call handler.
783 ;; This is so that ange-ftp can save time by doing a no-op.
786 ;; If filename contains a wildcard, newname will be the old name.
788 ;; If filename exists, use the long name
792 ;; If this file directly leads to a link, process that iteratively
793 ;; so that we don't use lots of stack.
799 ;; For file name that has a special handler, call handler.
800 ;; This is so that ange-ftp can save time by doing a no-op.
803 done t)
805 target dirfile)
806 ;; Get the truename of the directory.
808 ;; If these are equal, we have the (or a) root directory.
810 ;; If this is the same dir we last got the truename for,
811 ;; save time--don't recalculate.
821 done t)
824 done t)
825 ;; Put it back on the file name.
827 ;; Is the file name the name of a link?
830 ;; Yes => chase that link, then start all over
831 ;; since the link may point to a directory name that uses links.
832 ;; We can't safely use expand-file-name here
833 ;; since target might look like foo/../bar where foo
834 ;; is itself a link. Instead, we handle . and .. above.
837 target
839 done nil)
840 ;; No, we are done!
842 filename))
845 "Chase links in FILENAME until a name that is not a link.
846 Unlike `file-truename', this does not check whether a parent
847 directory name is a symbolic link.
848 If the optional argument LIMIT is a number,
849 it means chase no more than that many links and then stop."
857 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
860 ;; Handle `..' by hand, since it needs to work in the
861 ;; target of any directory symlink.
862 ;; This code is not quite complete; it does not handle
863 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
867 ;; Chase links in the default dir of the symlink.
871 ;; Now find the parent of that dir.
875 newname))
878 "Create a temporary file.
879 The returned file name (created by appending some random characters at the end
880 of PREFIX, and expanding against `temporary-file-directory' if necessary),
881 is guaranteed to point to a newly created empty file.
882 You can then use `write-region' to write new data into the file.
884 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
886 If SUFFIX is non-nil, add that at the end of the file name."
888 file)
891 ;; Create temp files with strict access rights. It's easy to
892 ;; loosen them later, whereas it's impossible to close the
893 ;; time-window of loose permissions otherwise.
905 nil)
907 ;; the file was somehow created by someone else between
908 ;; `make-temp-name' and `write-region', let's try again.
909 nil)
910 file)
911 ;; Reset the umask.
915 "Change the encoding of FILE's name from CODING to NEW-CODING.
916 The value is a new name of FILE.
917 Signals a `file-already-exists' error if a file of the new name
918 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
919 is non-nil. A number as fourth arg means request confirmation if
920 the new name already exists. This is what happens in interactive
921 use with M-x."
924 default-file-name-coding-system))
926 from-coding to-coding)
928 ;; We provide the default coding only when it seems that
929 ;; the filename is correctly decoded by the default
930 ;; coding.
936 filename default-coding)
937 default-coding))
941 ;; We provide the default coding only when a user is going to
942 ;; change the encoding not from the default coding.
946 filename from-coding)))
949 filename from-coding default-coding)
950 default-coding)))
954 default-file-name-coding-system))
955 ;; FILE should have been decoded by DEFAULT-CODING.
959 ;; Suppress further encoding.
964 newname))
965 \f
967 "Select buffer BUFFER in another window.
968 If BUFFER does not identify an existing buffer, then this function
969 creates a buffer with that name.
971 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
972 or nil. If BUFFER is nil, then this function chooses a buffer
973 using `other-buffer'.
974 Optional second arg NORECORD non-nil means
975 do not put this buffer at the front of the list of recently selected ones.
976 This function returns the buffer it switched to.
978 This uses the function `display-buffer' as a subroutine; see its
979 documentation for additional customization information."
982 ;; Don't let these interfere.
983 same-window-buffer-names same-window-regexps)
987 "Switch to buffer BUFFER in another frame.
988 Optional second arg NORECORD non-nil means
989 do not put this buffer at the front of the list of recently selected ones.
991 This uses the function `display-buffer' as a subroutine; see its
992 documentation for additional customization information."
995 same-window-buffer-names same-window-regexps)
1000 "Switch to buffer BUFFER in another frame.
1001 This uses the function `display-buffer' as a subroutine; see its
1002 documentation for additional customization information."
1005 same-window-buffer-names same-window-regexps
1007 new-window)
1017 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1018 BODY should use the minibuffer at most once.
1019 Recursive uses of the minibuffer will not be affected."
1025 ;; Clear out this hook so it does not interfere
1026 ;; with any recursive minibuffer usage.
1042 t))
1045 "Edit file FILENAME.
1046 Switch to a buffer visiting file FILENAME,
1047 creating one if none already exists.
1048 Interactively, the default if you just type RET is the current directory,
1049 but the visited file name is available through the minibuffer history:
1050 type M-n to pull it into the minibuffer.
1052 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1053 expand wildcards (if any) and visit multiple files. You can
1054 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1056 To visit a file without any kind of conversion and without
1065 "Edit file FILENAME, in another window.
1066 May create a new window, or reuse an existing one.
1067 See the function `display-buffer'.
1069 Interactively, the default if you just type RET is the current directory,
1070 but the visited file name is available through the minibuffer history:
1071 type M-n to pull it into the minibuffer.
1073 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1074 expand wildcards (if any) and visit multiple files."
1085 "Edit file FILENAME, in another frame.
1086 May create a new frame, or reuse an existing one.
1087 See the function `display-buffer'.
1089 Interactively, the default if you just type RET is the current directory,
1090 but the visited file name is available through the minibuffer history:
1091 type M-n to pull it into the minibuffer.
1093 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1094 expand wildcards (if any) and visit multiple files."
1105 "Edit the existing file FILENAME.
1113 "Edit file FILENAME but don't allow changes.
1125 value))
1128 "Edit file FILENAME in another window but don't allow changes.
1140 value))
1143 "Edit file FILENAME in another frame but don't allow changes.
1155 value))
1158 "Find file FILENAME as a replacement for the file in the next window.
1159 This command does not select that window.
1161 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1162 expand wildcards (if any) and replace the file with multiple files."
1174 t))))
1182 "Find file FILENAME, select its buffer, kill previous buffer.
1183 If the current buffer now contains an empty file that you just visited
1184 \(presumably by mistake), use this command to visit the file you really want.
1186 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1187 expand wildcards (if any) and replace the file with multiple files."
1197 t)))
1218 ;; This prevents us from finding the same buffer
1219 ;; if we specified the same file again.
1223 ;; Likewise for dired buffers.
1227 ;; This executes if find-file gets an error
1228 ;; and does not really find anything.
1229 ;; We put things back as they were.
1230 ;; If find-file actually finds something, we kill obuf below.
1239 ;; We already asked; don't ask again.
1242 \f
1244 "Create a suitably named buffer for visiting FILENAME, and return it.
1245 FILENAME (sans directory) is used unchanged if that name is free;
1246 otherwise a string <2> or <3> or ... is appended to get an unused name."
1253 "Create and return a buffer with a name based on NAME.
1254 Choose the buffer's name using `generate-new-buffer-name'."
1258 "Regexp to match the automounter prefix in a directory name."
1266 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1268 removes automounter prefixes (see the variable `automount-dir-prefix')."
1269 ;; Get rid of the prefixes added by the automounter.
1276 ;; If any elt of directory-abbrev-alist matches this name,
1277 ;; abbreviate accordingly.
1283 ;; Compute and save the abbreviated homedir name.
1284 ;; We defer computing this until the first time it's needed, to
1285 ;; give time for directory-abbrev-alist to be set properly.
1286 ;; We include a slash at the end, to avoid spurious matches
1287 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1294 ;; If FILENAME starts with the abbreviated homedir,
1295 ;; make it start with `~' instead.
1297 ;; If the home dir is just /, don't change it.
1300 ;; MS-DOS root directories can come with a drive letter;
1301 ;; Novell Netware allows drive letters beyond `Z:'.
1311 filename))
1314 "*List of logical names for which visiting shouldn't save the true dirname.
1315 On VMS, when you visit a file using a logical name that searches a path,
1316 you may or may not want the visited file name to record the specific
1317 directory where the file was found. If you *do not* want that, add the logical
1318 name to this list as a string."
1323 "Return the buffer visiting file FILENAME (a string).
1324 This is like `get-file-buffer', except that it checks for any buffer
1325 visiting the same file, possibly under a different name.
1326 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1327 and others are ignored.
1328 If there is no such live buffer, return nil."
1342 found)
1347 number
1352 ;; Verify this buffer's file number
1353 ;; still belongs to its file.
1356 attributes)
1360 found))))
1361 \f
1363 "*Non-nil means file-visiting commands should handle wildcards.
1364 For example, if you specify `*.c', that would visit all the files
1365 whose names match the pattern."
1371 "*Non-nil means suppress warning messages for symlinked files.
1372 When nil, Emacs prints a warning when visiting a file that is already
1373 visited, but with a different name. Setting this option to t
1374 suppresses this warning."
1380 "Maximum size of file above which a confirmation is requested.
1381 When nil, never request confirmation."
1388 "Read file FILENAME into a buffer and return the buffer.
1389 If a buffer exists visiting FILENAME, return that one, but
1390 verify that the file has not changed since visited or saved.
1391 The buffer is not selected, just returned to the caller.
1392 Optional second arg NOWARN non-nil means suppress any warning messages.
1393 Optional third arg RAWFILE non-nil means the file is read literally.
1394 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1395 and visit all the matching files. When wildcards are actually
1396 used and expanded, return a list of buffers that are visiting
1397 the various files."
1404 'find-directory-functions
1407 filename)))
1410 find-file-wildcards
1424 ;; Find any buffer for a file which has same truename.
1426 ;; Let user know if there is a buffer with the same truename.
1430 find-file-suppress-same-file-warnings
1434 ;; Optionally also find that buffer.
1437 ;; Check to see if the file looks uncommonly large.
1439 ;; Don't ask again if we already have the file or
1440 ;; if we're asked to be quiet.
1449 ;; We are using an existing buffer.
1455 ;; Certain files should be reverted automatically
1456 ;; if they have changed on disk and not in the buffer.
1464 found))
1474 "File %s changed on disk. Discard your edits? "
1479 "File %s changed on disk. Discard your edits in %s? "
1487 ;; Check if a formerly read-only file has become
1488 ;; writable and vice versa, but if the buffer agrees
1489 ;; with the new state of the file, that is ok too.
1496 buffer-file-name
1504 ;; It is confusing to ask whether to visit
1505 ;; non-literally if they have the file in
1506 ;; hexl-mode.
1510 "Save file and revisit literally? "
1515 rawfile truename number))
1517 "Discard your edits and revisit file literally? "
1520 rawfile truename number)
1524 "Revisit file literally? "
1527 rawfile truename number)
1530 ;; Return the buffer we are using.
1531 buf)
1532 ;; Create a new buffer.
1534 ;; find-file-noselect-1 may use a different buffer.
1536 rawfile truename number))))))
1542 ;; Needed in case we are re-visiting the file with a different
1543 ;; text representation.
1560 filename)))
1561 ;; Unconditionally set error
1571 filename)))
1572 ;; Run find-file-not-found-hooks until one returns non-nil.
1574 ;; If they fail too, set error.
1576 ;; Record the file's truename, and maybe use that as visited name.
1582 ;; On VMS, we may want to remember which directory in a search list
1583 ;; the file was found in.
1595 ;; Set buffer's default directory to that of the file.
1597 ;; Turn off backup files for certain file names. Since
1598 ;; this is a permanent local, the major mode won't eliminate it.
1612 \f
1614 "Like `insert-file-contents', but only reads in the file literally.
1615 A buffer may be modified in several ways after reading into the buffer,
1616 to Emacs features such as format decoding, character code
1617 conversion, `find-file-hook', automatic uncompression, etc.
1619 This function ensures that none of these modifications will take place."
1627 nil))
1630 inhibit-file-name-handlers))
1643 filename)))
1653 "Insert contents of file FILENAME into buffer after point with no conversion.
1655 This function is meant for the user to run interactively.
1656 Don't call it from programs! Use `insert-file-contents-literally' instead.
1657 \(Its calling sequence is different; see its documentation)."
1662 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1667 "Visit file FILENAME with no conversion of any kind.
1668 Format conversion and character code conversion are both disabled,
1669 and multibyte characters are disabled in the resulting buffer.
1670 The major mode used is Fundamental mode regardless of the file name,
1671 and local variable specifications in the file are ignored.
1672 Automatic uncompression and adding a newline at the end of the
1673 file due to `require-final-newline' is also disabled.
1675 You cannot absolutely rely on this function to result in
1676 visiting the file literally. If Emacs already has a buffer
1677 which is visiting the file, you get the existing buffer,
1678 regardless of whether it was created literally or not.
1680 In a Lisp program, if you want to be sure of accessing a file's
1681 contents literally, you should create a temporary buffer and then read
1682 the file contents into it using `insert-file-contents-literally'."
1685 \f
1689 after-find-file-from-revert-buffer
1690 nomodes)
1691 "Called after finding a file and by the default revert function.
1692 Sets buffer mode, parses local variables.
1693 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1694 error in reading the file. WARN non-nil means warn if there
1695 exists an auto-save file more recent than the visited file.
1696 NOAUTO means don't mess with auto-save mode.
1697 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1698 means this call was from `revert-buffer'.
1699 Fifth arg NOMODES non-nil means don't alter the file's modes.
1700 Finishes by calling the functions in `find-file-hook'
1701 unless NOMODES is non-nil."
1704 nil
1714 ;; No need to warn if buffer is auto-saved
1715 ;; under the name of the visited file.
1717 auto-save-visited-file-name))
1720 buffer-file-name))
1740 ;; Make people do a little extra work (C-x C-q)
1741 ;; before altering a backup file.
1744 ;; When a file is marked read-only,
1745 ;; make the buffer read-only even if root is looking at it.
1753 ;; If requested, add a newline at the end of the file.
1763 view-read-only
1769 "Eval BODY and turn any error into a FORMAT message.
1770 FORMAT can have a %s escape which will be replaced with the actual error.
1771 If `debug-on-error' is set, errors are not caught, so that you can
1772 debug them.
1773 Avoid using a large BODY since it is duplicated."
1782 "Choose the major mode for this buffer automatically.
1783 Also sets up any specified local variables of the file.
1784 Uses the visited file name, the -*- line, and the local variables spec.
1786 This function is called automatically from `find-file'. In that case,
1787 we may set up the file-specified mode and local variables,
1788 depending on the value of `enable-local-variables'.
1789 In addition, if `local-enable-local-variables' is nil, we do
1790 not set local variables (though we do notice a mode specified with -*-.)
1792 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1793 or from Lisp without specifying the optional argument FIND-FILE;
1794 in that case, this function acts as if `enable-local-variables' were t."
1802 ;; Turn font lock off and on, to make sure it takes account of
1803 ;; whatever file local variables are relevant to it.
1805 ;; Font-lock-mode (now in font-core.el) can be ON when
1806 ;; font-lock.el still hasn't been loaded.
1816 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1817 ;; c++-mode, java-mode and more) are added through autoload
1818 ;; directives in that file. That way is discouraged since it
1819 ;; spreads out the definition of the initial value.
1850 ;; Less common extensions come here
1851 ;; so more common ones above are found faster.
1890 ;; The list of archive file extensions should be in sync with
1891 ;; `auto-coding-alist' with `no-conversion' coding system.
1895 ;; Mailer puts message to be edited in
1896 ;; /tmp/Re.... or Message
1900 ;; some news reader is reported to use this
1909 ;; .emacs or .gnus or .viper following a directory delimiter in
1910 ;; Unix, MSDOG or VMS syntax.
1913 ;; _emacs following a directory delimiter
1914 ;; in MsDos syntax
1933 ;; Windows candidates may be opened case sensitively on Unix
1939 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1941 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1942 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
1943 ;; either user's dot-files or under /etc or some such
1945 ;; alas not all ~/.*rc files are like this
1946 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1951 ;; this contains everything twice, with space and with colon :-(
1953 ;; Get rid of any trailing .n.m and try again.
1954 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1955 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1956 ;; Using mode nil rather than `ignore' would let the search continue
1957 ;; through this list (with the shortened name) rather than start over.
1959 ;; The following should come after the ChangeLog pattern
1960 ;; for the sake of ChangeLog.1, etc.
1961 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1964 "Alist of filename patterns vs corresponding major mode functions.
1965 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1966 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1967 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1968 mode function to use. FUNCTION will be called, unless it is nil.
1970 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1971 calling FUNCTION (if it's not nil), we delete the suffix that matched
1972 REGEXP and search the list again for another match.
1974 If the file name matches `inhibit-first-line-modes-regexps',
1975 then `auto-mode-alist' is not processed.
1977 The extensions whose FUNCTION is `archive-mode' should also
1978 appear in `auto-coding-alist' with `no-conversion' coding system.
1980 See also `interpreter-mode-alist', which detects executable script modes
1981 based on the interpreters they specify to run,
1985 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1986 ;; and pike-mode) are added through autoload directives in that
1987 ;; file. That way is discouraged since it spreads out the
1988 ;; definition of the initial value.
2026 "Alist mapping interpreter names to major modes.
2027 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2028 Each element looks like (INTERPRETER . MODE).
2029 If INTERPRETER matches the name of the interpreter specified in the first line
2030 of a script, mode MODE is enabled.
2038 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2039 When checking `inhibit-first-line-modes-regexps', we first discard
2045 "Regexp matching interpreters, for file mode determination.
2046 This regular expression is matched against the first line of a file
2047 to determine the file's mode in `set-auto-mode'. If it matches, the file
2048 is assumed to be interpreted by the interpreter matched by the second group
2049 of the regular expression. The mode is then determined as the mode
2054 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2055 ;; We use [ \t\n] instead of `\\s ' to make regex overflow less likely.
2059 comment-re "*"
2062 . html-mode)
2063 ;; These two must come after html, because they are more general:
2068 . sgml-mode)
2071 "Alist of buffer beginnings vs. corresponding major mode functions.
2072 Each element looks like (REGEXP . FUNCTION). After visiting a file,
2073 if REGEXP matches the text at the beginning of the buffer,
2074 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
2075 to decide the buffer's major mode.
2077 If FUNCTION is nil, then it is not called. (That is a way of saying
2084 "Select major mode appropriate for current buffer.
2086 This checks for a -*- mode tag in the buffer's text, checks the
2087 interpreter that runs this file against `interpreter-mode-alist',
2088 compares the buffer beginning against `magic-mode-alist', or
2089 compares the filename against the entries in `auto-mode-alist'.
2091 It does not check for the `mode:' local variable in the
2092 Local Variables section of the file; for that, use `hack-local-variables'.
2094 If `enable-local-variables' is nil, this function does not check for a
2095 -*- mode tag.
2097 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2098 only set the major mode, if that would change it."
2099 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2101 ;; Find a -*- mode tag
2108 ;; Find all specifications for the `mode:' variable
2109 ;; and execute them left to right.
2121 modes)))
2122 ;; Simple -*-MODE-*- case.
2125 modes))))
2126 ;; If we found modes to use, invoke them now, outside the save-excursion.
2134 ;; continuing would call minor modes again, toggling them off
2137 ;; If we didn't, look for an interpreter specified in the first line.
2138 ;; As a special case, allow for things like "#!/bin/env perl", which
2139 ;; finds the interpreter anywhere in $PATH.
2145 ;; Map interpreter name to a mode, signalling we're done at the
2146 ;; same time.
2148 interpreter-mode-alist))
2149 ;; If we found an interpreter mode to use, invoke it now.
2152 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2164 ;; Compare the filename against the entries in auto-mode-alist.
2167 ;; Remove backup-suffixes from file name.
2170 ;; Find first matching alist entry.
2183 ;; When `keep-mode-if-same' is set, we are working on behalf of
2184 ;; set-visited-file-name. In that case, if the major mode specified is the
2185 ;; same one we already have, don't actually reset it. We don't want to lose
2186 ;; minor modes such as Font Lock.
2188 "Apply MODE and return it.
2189 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2190 any aliases and compared to current major mode. If they are the
2191 same, do nothing and return nil."
2199 mode))
2202 "Find the -*- spec in the buffer.
2203 Call with point at the place to start searching from.
2204 If one is found, set point to the beginning
2205 and return the position of the end.
2206 Otherwise, return nil; point may be changed."
2209 ;; Don't look for -*- if this file name matches any
2210 ;; of the regexps in inhibit-first-line-modes-regexps.
2218 sufs)
2226 ;; If the file begins with "#!"
2227 ;; (exec interpreter magic), look
2228 ;; for mode frobs in the first two
2229 ;; lines. You cannot necessarily
2230 ;; put them in the first line of
2231 ;; such a file without screwing up
2232 ;; the interpreter invocation.
2243 end))))
2244 \f
2245 ;;; Handling file local variables
2252 "Normal hook run after processing a file's local variables specs.
2253 Major modes can use this to examine user-specified local variables
2257 "List variable-value pairs that are considered safe.
2258 Each element is a cons cell (VAR . VAL), where VAR is a variable
2259 symbol and VAL is a value that is considered safe."
2264 "*Expressions that are considered safe in an `eval:' local variable.
2265 Add expressions to this list if you want Emacs to evaluate them, when
2266 they appear in an `eval' local variable specification, without first
2267 asking you for confirmation."
2272 ;; Risky local variables:
2275 auto-mode-alist
2276 buffer-auto-save-file-name
2277 buffer-file-name
2278 buffer-file-truename
2279 buffer-undo-list
2280 dabbrev-case-fold-search
2281 dabbrev-case-replace
2282 debugger
2283 default-text-properties
2284 display-time-string
2285 enable-local-eval
2286 eval
2287 exec-directory
2288 exec-path
2289 file-name-handler-alist
2290 font-lock-defaults
2291 format-alist
2292 frame-title-format
2293 global-mode-string
2294 header-line-format
2295 icon-title-format
2296 ignored-local-variables
2297 imenu--index-alist
2298 imenu-generic-expression
2299 inhibit-quit
2300 input-method-alist
2301 load-path
2302 max-lisp-eval-depth
2303 max-specpdl-size
2304 minor-mode-alist
2305 minor-mode-map-alist
2306 minor-mode-overriding-map-alist
2307 mode-line-buffer-identification
2308 mode-line-format
2309 mode-line-modes
2310 mode-line-modified
2311 mode-line-mule-info
2312 mode-line-position
2313 mode-line-process
2314 mode-name
2315 outline-level
2316 overriding-local-map
2317 overriding-terminal-local-map
2318 parse-time-rules
2319 process-environment
2320 rmail-output-file-alist
2321 save-some-buffers-action-alist
2322 special-display-buffer-names
2323 standard-input
2324 standard-output
2325 unread-command-events
2326 vc-mode))
2328 ;; Safe local variables:
2329 ;;
2330 ;; For variables defined by major modes, the safety declarations can go into
2331 ;; the major mode's file, since that will be loaded before file variables are
2332 ;; processed.
2333 ;;
2334 ;; For variables defined by minor modes, put the safety declarations in the
2335 ;; file defining the minor mode after the defcustom/defvar using an autoload
2336 ;; cookie, e.g.:
2337 ;;
2338 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2339 ;;
2340 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2341 ;; minor mode file may not be loaded yet.
2342 ;;
2343 ;; For variables defined in the C source code the declaration should go here:
2345 ;; FIXME: Some variables should be moved according to the rules above.
2374 nil
2379 prompt char)
2389 ", and variables that are risky (**)."
2396 y -- to apply the local variables list.
2400 ! -- to apply the local variables list, and permanently mark these
2418 ""
2424 done)
2438 ;; When this is called from desktop-restore-file-buffer,
2439 ;; coding-system-for-read may be non-nil. Reset it before
2440 ;; writing to .emacs.
2444 'safe-local-variable-values
2445 safe-local-variable-values))))
2452 "Return local variables specified in the -*- line.
2453 Ignore any specification for `mode:' and `coding:';
2454 `set-auto-mode' should already have handled `mode:',
2455 `set-auto-coding' should already have handled `coding:'.
2457 If MODE-ONLY is non-nil, all we do is check whether the major
2458 mode is specified, returning t if it is specified. Otherwise,
2459 return an alist of elements (VAR . VAL), where VAR is a variable
2460 and VAL is the specified value."
2464 result mode-specified)
2465 ;; Parse the -*- line into the RESULT alist.
2466 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2468 nil)
2470 ;; Simple form: "-*- MODENAME -*-". Already handled.
2472 nil)
2474 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2475 ;; (last ";" is optional).
2480 ;; There used to be a downcase here,
2481 ;; but the manual didn't say so,
2482 ;; and people want to set var names that aren't all lc.
2489 ;; It is traditional to ignore
2490 ;; case when checking for `mode' in set-auto-mode,
2491 ;; so we must do that here as well.
2492 ;; That is inconsistent, but we're stuck with it.
2493 ;; The same can be said for `coding' in set-auto-coding.
2499 'eval
2506 mode-specified
2507 result))))
2510 "Parse and put into effect this buffer's local variables spec.
2511 If MODE-ONLY is non-nil, all we do is check whether the major mode
2512 is specified, returning t if it is specified."
2515 result)
2518 ;; Look for "Local variables:" line in last page.
2526 ;; suffix is what comes after "local variables:" in its line.
2527 ;; prefix is what comes before "local variables:" in its line.
2537 beg)
2541 endpos
2547 nil t))
2557 ;; Discard the prefix.
2562 ;; Discard the suffix.
2570 ;; Find the variable name; strip whitespace.
2578 val)
2579 ;; Read the variable value.
2589 'eval
2595 ;; We've read all the local variables. Now, return whether the
2596 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2597 ;; variables (if MODE-ONLY is nil.)
2599 result
2606 ;; Find those variables that we may want to save to
2607 ;; `safe-local-variable-values'.
2622 ;; If caller wants only the safe variables,
2623 ;; install only them.
2628 ;; Query, except in the case where all are known safe
2629 ;; if the user wants no quuery in that case.
2634 result unsafe-vars risky-vars))
2640 "Non-nil if SYM is safe as a file-local variable with value VAL.
2641 It is safe if any of these conditions are met:
2643 * There is a matching entry (SYM . VAL) in the
2644 `safe-local-variable-values' user option.
2646 * The `safe-local-variable' property of SYM is t.
2648 * The `safe-local-variable' property of SYM is a function that
2649 evaluates to a non-nil value with VAL as an argument."
2657 "Non-nil if SYM could be dangerous as a file-local variable.
2658 It is dangerous if either of these conditions are met:
2660 * Its `risky-local-variable' property is non-nil.
2666 ;; If this is an alias, check the base name.
2686 "Return t if it is safe to eval EXP when it is found in a file."
2688 ;; Detect certain `put' expressions.
2694 ;; Only allow safe values of lisp-indent-hook;
2695 ;; not functions.
2698 ;; Allow expressions that the user requested.
2700 ;; Certain functions can be allowed with safe arguments
2701 ;; or can specify verification functions to try.
2709 ok))
2717 ok)))))))
2720 "Set local variable VAR with value VAL."
2727 ;; Make sure the string has no text properties.
2728 ;; Some text properties can get evaluated in various ways,
2729 ;; so it is risky to put them on with a local variable list.
2734 \f
2737 However, the mode will not be changed if
2738 \(1) a local variables list or the `-*-' line specifies a major mode, or
2740 \ not suitable for ordinary files, or
2741 \(3) the new file name does not particularly specify any mode."
2746 "Change name of file visited in current buffer to FILENAME.
2747 This also renames the buffer to correspond to the new file.
2748 The next time the buffer is saved it will go in the newly specified file.
2749 FILENAME nil or an empty string means mark buffer as not visiting any file.
2750 Remember to delete the initial contents of the minibuffer
2751 if you wish to pass an empty string as the argument.
2753 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2754 confirmation in the case where another buffer is already visiting FILENAME.
2756 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2757 the old visited file has been renamed to the new name FILENAME."
2765 nil
2780 filename)))
2792 ;; If new-name == old-name, renaming would add a spurious <2>
2793 ;; and it's considered as a feature in rename-buffer.
2799 ;; Abbreviate the file names of the buffer.
2808 nil)))
2809 ;; write-file-functions is normally used for things like ftp-find-file
2810 ;; that visit things that are not local files as if they were files.
2811 ;; Changing to visit an ordinary local file instead should flush the hook.
2816 ;; If buffer was read-only because of version control,
2817 ;; that reason is gone now, so make it writable.
2821 ;; Turn off backup files for certain file names.
2822 ;; Since this is a permanent local, the major mode won't eliminate it.
2829 ;; If auto-save was not already on, turn it on if appropriate.
2833 ;; If auto save is on, start using a new name.
2834 ;; We deliberately don't rename or delete the old auto save
2835 ;; for the old visited file name. This is because perhaps
2836 ;; the user wants to save the new state and then compare with the
2837 ;; previous state from the auto save file.
2840 ;; Rename the old auto save file if any.
2847 ;; Update the major mode, if the file name determines it.
2849 ;; Don't change the mode if it is special.
2852 ;; Don't change the mode if the local variable list specifies it.
2858 "Write current buffer into file FILENAME.
2859 This makes the buffer visit that file, and marks it as not modified.
2861 If you specify just a directory name as FILENAME, that means to use
2862 the default file name but in that directory. You can also yank
2863 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2865 If the buffer is not already visiting a file, the default file name
2866 for the output file is the buffer name.
2868 If optional second arg CONFIRM is non-nil, this function
2869 asks for confirmation before overwriting an existing file.
2870 Interactively, confirmation is required unless you supply a prefix argument."
2871 ;; (interactive "FWrite file: ")
2875 nil nil nil nil)
2879 default-directory)
2880 nil nil))
2884 ;; If arg is just a directory,
2885 ;; use the default file name, but in that directory.
2896 ;; Make buffer writable if file is writable.
2901 ;; It's likely that the VC status at the new location is different from
2902 ;; the one at the old location.
2904 \f
2906 "Make a backup of the disk file visited by the current buffer, if appropriate.
2907 This is normally done before saving the buffer the first time.
2909 A backup may be done by renaming or by copying; see documentation of
2910 variable `make-backup-files'. If it's done by renaming, then the file is
2911 no longer accessible under its old name.
2913 The value is non-nil after a backup was made by renaming.
2914 It has the form (MODES . BACKUPNAME).
2915 MODES is the result of `file-modes' on the original
2916 file; this means that the caller, after saving the buffer, should change
2917 the modes of the new file to agree with the old modes.
2918 BACKUPNAME is the backup file name, which is the old file renamed."
2925 backup-info backupname targets setmodes)
2926 ;; If specified name is a symbolic link, chase it to the target.
2927 ;; Thus we make the backups in the directory where the real file is.
2932 ;; (if (file-directory-p buffer-file-name)
2933 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2937 ;; If have old versions to maybe delete,
2938 ;; ask the user to confirm now, before doing anything.
2939 ;; But don't actually delete til later.
2944 real-file-name)))))
2946 ;; Actually write the back up file.
2949 ; (file-symlink-p buffer-file-name)
2950 backup-by-copying
2951 ;; Don't rename a suid or sgid file.
2966 ;; rename-file should delete old backup.
2970 ;; If trouble writing the backup, write it in ~.
2979 ;; Now delete the old versions, if desired.
2986 setmodes)
2993 ;; Create temp files with strict access rights. It's easy to
2994 ;; loosen them later, whereas it's impossible to close the
2995 ;; time-window of loose permissions otherwise.
3003 nil)
3005 ;; The file was somehow created by someone else between
3006 ;; `delete-file' and `copy-file', so let's try again.
3007 nil))
3008 ;; Reset the umask.
3014 "Return file NAME sans backup versions or strings.
3015 This is a separate procedure so your site-init or startup file can
3016 redefine it.
3017 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3018 we do not remove backup version numbers, only true file version numbers."
3024 ;; VMS version number is (a) semicolon, optional
3025 ;; sign, zero or more digits or (b) period, option
3026 ;; sign, zero or more digits, provided this is the
3027 ;; second period encountered outside of the
3028 ;; device/directory part of the file name.
3031 name)
3041 "Return t if deleting FILE and rewriting it would preserve the owner."
3046 ;; Return t if the file doesn't exist, since it's true that no
3047 ;; information would be lost by an (attempted) delete and create.
3053 The extension, in a file name, is the part that follows the last `.',
3054 except that a leading `.', if any, doesn't count."
3057 directory)
3061 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3062 ;; we don't want to expand it.
3065 filename))))
3069 The extension, in a file name, is the part that follows the last `.',
3070 except that a leading `.', if any, doesn't count.
3071 Return nil for extensionless file names such as `foo'.
3072 Return the empty string for file names such as `foo.'.
3074 If PERIOD is non-nil, then the returned value includes the period
3075 that delimits the extension, and if FILENAME has no extension,
3086 "A function to use instead of the default `make-backup-file-name'.
3087 A value of nil gives the default `make-backup-file-name' behavior.
3089 This could be buffer-local to do something special for specific
3090 files. If you define it, you may need to change `backup-file-name-p'
3091 and `file-name-sans-versions' too.
3093 See also `backup-directory-alist'."
3099 "Alist of filename patterns and backup directory names.
3100 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3101 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3102 relative or absolute. If it is absolute, so that all matching files
3103 are backed up into the same directory, the file names in this
3104 directory will be the full name of the file backed up with all
3105 directory separators changed to `!' to prevent clashes. This will not
3106 work correctly if your filesystem truncates the resulting name.
3108 For the common case of all backups going into one directory, the alist
3110 directory name.
3112 If this variable is nil, or it fails to match a filename, the backup
3113 is made in the original file's directory.
3115 On MS-DOS filesystems without long names this variable is always
3116 ignored."
3122 "Default `backup-enable-predicate' function.
3123 Checks for files in `temporary-file-directory',
3124 `small-temporary-file-directory', and /tmp."
3127 ;; Directory is under temporary-file-directory.
3132 ;; Directory is under /tmp.
3137 0 nil
3139 ;; Directory is under small-temporary-file-directory.
3144 "Create the non-numeric backup file name for FILE.
3145 Normally this will just be the file's name with `~' appended.
3146 Customization hooks are provided as follows.
3148 If the variable `make-backup-file-name-function' is non-nil, its value
3149 should be a function which will be called with FILE as its argument;
3150 the resulting name is used.
3152 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3153 the documentation of that variable. If the directory for the backup
3154 doesn't exist, it is created."
3168 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3170 elt backup-directory)
3175 alist nil)))
3181 file
3185 ;; Normalize DOSish file names: downcase the drive
3186 ;; letter, if any, and replace the leading "x:" with
3187 ;; "/drive_x".
3190 ;; Replace any invalid file-name characters (for the
3191 ;; case of backing up remote files).
3195 "drive_"
3198 ""
3201 ;; Make the name unique by substituting directory
3202 ;; separators. It may not really be worth bothering about
3203 ;; doubling `!'s in the original name...
3208 backup-directory))
3215 "Return non-nil if FILE is a backup file name (numeric or not).
3216 This is a separate function so you can redefine it for customization.
3217 You may need to redefine `file-name-sans-versions' as well."
3222 ;; This is used in various files.
3223 ;; The usage of backup-extract-version-start is not very clean,
3224 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3226 "Given the name of a numeric backup file, FN, return the backup number.
3227 Uses the free variable `backup-extract-version-start', whose value should be
3228 the index in the name where the version number begins."
3234 ;; I believe there is no need to alter this behavior for VMS;
3235 ;; since backup files are not made on VMS, it should not get called.
3237 "Find a file name for a backup file FN, and suggestions for deletions.
3238 Value is a list whose car is the name for the backup file
3239 and whose cdr is a list of old versions to consider deleting now.
3240 If the value is nil, don't make a backup.
3241 Uses `backup-directory-alist' in the same way as does
3242 `make-backup-file-name'."
3244 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3248 ;; We don't support numbered backups on plain MS-DOS
3249 ;; when long file names are unavailable.
3259 possibilities deserve-versions-p versions)
3262 base-versions
3265 possibilities)
3266 #'<)
3271 kept-old-versions
3272 kept-new-versions
3279 ;; Delete nothing if there is overflow
3280 ;; in the number of versions to keep.
3286 v))))))))))
3289 "Return number of names file FILENAME has."
3292 ;; (defun file-relative-name (filename &optional directory)
3293 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3294 ;; This function returns a relative file name which is equivalent to FILENAME
3295 ;; when used with that default directory as the default.
3296 ;; If this is impossible (which can happen on MSDOS and Windows
3297 ;; when the file name and directory use different drive names)
3298 ;; then it returns FILENAME."
3299 ;; (save-match-data
3300 ;; (let ((fname (expand-file-name filename)))
3301 ;; (setq directory (file-name-as-directory
3302 ;; (expand-file-name (or directory default-directory))))
3303 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3304 ;; ;; drive names, they can't be relative, so return the absolute name.
3305 ;; (if (and (or (eq system-type 'ms-dos)
3306 ;; (eq system-type 'cygwin)
3307 ;; (eq system-type 'windows-nt))
3308 ;; (not (string-equal (substring fname 0 2)
3309 ;; (substring directory 0 2))))
3310 ;; filename
3311 ;; (let ((ancestor ".")
3312 ;; (fname-dir (file-name-as-directory fname)))
3313 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3314 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3315 ;; (setq directory (file-name-directory (substring directory 0 -1))
3316 ;; ancestor (if (equal ancestor ".")
3317 ;; ".."
3318 ;; (concat "../" ancestor))))
3319 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3320 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3321 ;; ;; We matched within FNAME's directory part.
3322 ;; ;; Add the rest of FNAME onto ANCESTOR.
3323 ;; (let ((rest (substring fname (match-end 0))))
3324 ;; (if (and (equal ancestor ".")
3325 ;; (not (equal rest "")))
3326 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3327 ;; rest
3328 ;; (concat (file-name-as-directory ancestor) rest)))
3329 ;; ;; We matched FNAME's directory equivalent.
3330 ;; ancestor))))))
3333 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3334 This function returns a relative file name which is equivalent to FILENAME
3335 when used with that default directory as the default.
3336 If FILENAME and DIRECTORY lie on different machines or on different drives
3337 on a DOS/Windows machine, it returns FILENAME in expanded form."
3341 default-directory))))
3347 ;; Test for different drives on DOS/Windows
3349 ;; Should `cygwin' really be included here? --stef
3352 ;; Test for different remote file system identification
3354 filename
3360 directory nil nil case-fold-search))
3362 directory nil nil case-fold-search))))
3365 ".."
3367 ;; Now ancestor is empty, or .., or ../.., etc.
3369 directory nil nil case-fold-search))
3370 ;; We matched within FILENAME's directory part.
3371 ;; Add the rest of FILENAME onto ANCESTOR.
3374 ;; But don't bother with ANCESTOR if it would give us `./'.
3375 rest
3377 ;; We matched FILENAME's directory equivalent.
3378 ancestor))))))
3379 \f
3381 "Save current buffer in visited file if modified.
3382 Variations are described below.
3384 By default, makes the previous version into a backup file
3385 if previously requested or if this is the first save.
3387 to become a backup when the next save is done.
3389 unconditionally makes the previous version into a backup file.
3391 to become a backup when the next save is done,
3392 and unconditionally makes the previous version into a backup file.
3394 With a numeric argument of 0, never make the previous version
3395 into a backup file.
3397 If a file's name is FOO, the names of its numbered backup versions are
3398 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3399 Numeric backups (rather than FOO~) will be made if value of
3400 `version-control' is not the atom `never' and either there are already
3401 numeric versions of the file being backed up, or `version-control' is
3402 non-nil.
3403 We don't want excessive versions piling up, so there are variables
3404 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3405 and `kept-new-versions', which tells how many newest versions to keep.
3406 Defaults are 2 old versions and 2 new.
3407 `dired-kept-versions' controls dired's clean-directory (.) command.
3408 If `delete-old-versions' is nil, system will query user
3409 before trimming versions. Otherwise it does it silently.
3411 If `vc-make-backup-files' is nil, which is the default,
3412 no backup files are made for files managed by version control.
3413 (This is because the version control system itself records previous versions.)
3415 See the subroutine `basic-save-buffer' for more information."
3428 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3429 Normally delete only if the file was written by this Emacs since
3430 the last real save, but optional arg FORCE non-nil means delete anyway."
3444 "Normal hook that is run before a buffer is saved to its file."
3450 "Normal hook that is run after a buffer is saved to its file."
3456 "If non-nil, use this coding system for saving the buffer.
3457 More precisely, use this coding system in place of the
3458 value of `buffer-file-coding-system', when saving the buffer.
3459 Calling `write-region' for any purpose other than saving the buffer
3460 will still use `buffer-file-coding-system'; this variable has no effect
3467 "Save the current buffer in its visited file, if it has been modified.
3468 The hooks `write-contents-functions' and `write-file-functions' get a chance
3469 to do the job of saving; if they do not, then the buffer is saved in
3470 the visited file in the usual way.
3471 Before and after saving the buffer, this function runs
3472 `before-save-hook' and `after-save-hook', respectively."
3475 ;; In an indirect buffer, save its base buffer instead.
3480 setmodes)
3481 ;; On VMS, rename file and buffer to get rid of version number.
3486 ;; Strip VMS version number before save.
3489 ;; Construct a (unique) buffer name to correspond.
3494 ;; If buffer has no file name, ask user for one.
3501 filename))
3527 ;; Support VC version backups.
3533 ;; If a hook returned t, file is already "written".
3534 ;; Otherwise, write it the usual way now.
3536 ;; Now we have saved the current buffer. Let's make sure
3537 ;; that buffer-file-coding-system is fixed to what
3538 ;; actually used for saving by binding it locally.
3548 ;; If the auto-save file was recent before this command,
3549 ;; delete it now.
3551 ;; Support VC `implicit' locking.
3556 ;; This does the "real job" of writing a buffer into its visited file
3557 ;; and making a backup file. This is what is normally done
3558 ;; but inhibited if one of write-file-functions returns non-nil.
3559 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3568 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3582 buffer-file-name)))
3590 ;; If file is precious, write temp name, then rename it.
3591 ;; This requires write access to the containing dir,
3592 ;; which is why we don't try it if we don't have that access.
3594 tempname succeed
3597 ;; Create temp files with strict access rights. It's easy to
3598 ;; loosen them later, whereas it's impossible to close the
3599 ;; time-window of loose permissions otherwise.
3604 ;; Try various temporary names.
3605 ;; This code follows the example of make-temp-file,
3606 ;; but it calls write-region in the appropriate way
3607 ;; for saving the buffer.
3614 tempname nil realname
3616 nil)
3618 ;; The file was somehow created by someone else between
3619 ;; `make-temp-name' and `write-region', let's try again.
3620 nil)
3622 ;; Reset the umask.
3624 ;; If we failed, restore the buffer's modtime.
3627 ;; Since we have created an entirely new file,
3628 ;; make sure it gets the right permission bits set.
3630 buffer-file-name)))
3631 ;; We succeeded in writing the temp file,
3632 ;; so rename it.
3634 ;; If file not writable, see if we can make it writable
3635 ;; temporarily while we write it.
3636 ;; But no need to do so if we have just backed it up
3637 ;; (setmodes is set) because that says we're superseding.
3639 ;; Change the mode back, after writing.
3646 buffer-file-name nil t buffer-file-truename)
3648 ;; If we get an error writing the new file, and we made
3649 ;; the backup by renaming, undo the backing-up.
3654 setmodes))
3657 "View the differences between BUFFER and its associated file.
3658 This requires the external program `diff' to be in your `exec-path'."
3673 ;; Display that message for 1 second so that user can read it
3674 ;; in the minibuffer.
3676 ;; return always nil, so that save-buffers-kill-emacs will not move
3677 ;; over to the next unsaved buffer when calling `d'.
3678 nil)
3681 '((?\C-r
3687 ;; Return nil to ask about BUF again.
3688 nil)
3690 (?d diff-buffer-with-file
3699 "Save some modified file-visiting buffers. Asks user about each one.
3700 You can answer `y' to save, `n' not to save, `C-r' to look at the
3701 buffer in question with `view-buffer' before deciding or `d' to
3702 view the differences using `diff-buffer-with-file'.
3704 Optional argument (the prefix) non-nil means save all with no questions.
3705 Optional second argument PRED determines which buffers are considered:
3706 If PRED is nil, all the file-visiting buffers are considered.
3707 If PRED is t, then certain non-file buffers will also be considered.
3708 If PRED is a zero-argument function, it indicates for each buffer whether
3709 to consider it or not when called with that buffer current.
3711 See `save-some-buffers-action-alist' if you want to
3712 change the additional actions you can take on files."
3716 files-done abbrevs-done)
3718 ;; First save any buffers that we're supposed to save unconditionally.
3719 ;; That way the following code won't ask about them.
3724 ;; Ask about those buffers that merit it,
3725 ;; and record the number thus saved.
3741 t
3754 save-some-buffers-action-alist))
3755 ;; Maybe to save abbrevs, and record whether
3756 ;; we either saved them or asked to.
3762 abbrev-file-name)))
3764 ;; Don't keep bothering user if he says no.
3769 "(Some special files were saved without asking)"
3771 \f
3773 "Mark current buffer as unmodified, not needing to be saved.
3776 It is not a good idea to use this function in Lisp programs, because it
3777 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3784 "Change whether this buffer is visiting its file read-only.
3785 With arg, set read-only iff arg is positive.
3786 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3791 nil ; do nothing.
3792 ;; Toggle.
3799 ;; If view-mode is already active, `view-mode-enter' is a nop.
3811 "Insert contents of file FILENAME into buffer after point.
3812 Set mark after the inserted text.
3814 This function is meant for the user to run interactively.
3815 Don't call it from programs! Use `insert-file-contents' instead.
3816 \(Its calling sequence is different; see its documentation)."
3821 "Append the contents of the region to the end of file FILENAME.
3822 When called from a function, expects three arguments,
3823 START, END and FILENAME. START and END are buffer positions
3824 saying what text to write."
3829 "Return most recent backup file for FILENAME or nil if no backups exist."
3830 ;; `make-backup-file-name' will get us the right directory for
3831 ;; ordinary or numeric backups. It might create a directory for
3832 ;; backups as a side-effect, according to `backup-directory-alist'.
3839 tem)
3848 newest))
3851 "Rename current buffer to a similar name not already taken.
3852 This function is useful for creating multiple shell process buffers
3853 or multiple mail buffers, etc."
3861 ;; If the existing buffer name has a <NNN>,
3862 ;; which isn't part of the file name (if any),
3863 ;; then get rid of that.
3869 "Create the directory DIR and any nonexistent parent dirs.
3870 Interactively, the default choice of directory to create
3871 is the current default directory for file names.
3872 That is useful when you have visited a file in a nonexistent directory.
3874 Noninteractively, the second (optional) argument PARENTS says whether
3875 to create parent directories if they don't exist. Interactively,
3876 this happens by default."
3879 nil nil)
3880 t))
3881 ;; If default-directory is a remote directory,
3882 ;; make sure we find its make-directory handler.
3890 create-list)
3897 \f
3900 "Function to use to revert this buffer, or nil to do the default.
3901 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3906 "Function to use to insert contents when reverting this buffer.
3907 Gets two args, first the nominal file name to use,
3908 and second, t if reading the auto-save file.
3913 "Function to check whether a non-file buffer needs reverting.
3914 This should be a function with one optional argument NOCONFIRM.
3915 Auto Revert Mode passes t for NOCONFIRM. The function should return
3916 non-nil if the buffer should be reverted. A return value of
3917 `fast' means that the need for reverting was not checked, but
3918 that reverting the buffer is fast. The buffer is current when
3919 this function is called.
3921 The idea behind the NOCONFIRM argument is that it should be
3922 non-nil if the buffer is going to be reverted without asking the
3923 user. In such situations, one has to be careful with potentially
3924 time consuming operations.
3926 For more information on how this variable is used by Auto Revert mode,
3930 "Normal hook for `revert-buffer' to run before reverting.
3931 If `revert-buffer-function' is used to override the normal revert
3935 "Normal hook for `revert-buffer' to run after reverting.
3936 Note that the hook value that it runs is the value that was in effect
3937 before reverting; that makes a difference if you have buffer-local
3938 hook functions.
3940 If `revert-buffer-function' is used to override the normal revert
3946 "Replace current buffer text with the text of the visited file on disk.
3947 This undoes all changes since the file was visited or saved.
3948 With a prefix argument, offer to revert from latest auto-save file, if
3949 that is more recent than the visited file.
3951 This command also works for special buffers that contain text which
3952 doesn't come from a file, but reflects some other data base instead:
3953 for example, Dired buffers and `buffer-list' buffers. In these cases,
3954 it reconstructs the buffer contents from the appropriate data base.
3956 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3957 to revert from the auto-save file when this is nil. Note that the
3958 sense of this argument is the reverse of the prefix argument, for the
3959 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3960 to nil.
3962 Optional second argument NOCONFIRM means don't ask for confirmation at
3963 all. \(The variable `revert-without-query' offers another way to
3964 revert buffers without querying for confirmation.)
3966 Optional third argument PRESERVE-MODES non-nil means don't alter
3967 the files modes. Normally we reinitialize them using `normal-mode'.
3969 If the value of `revert-buffer-function' is non-nil, it is called to
3970 do all the work for this command. Otherwise, the hooks
3971 `before-revert-hook' and `after-revert-hook' are run at the beginning
3972 and the end, and if `revert-buffer-insert-file-contents-function' is
3973 non-nil, it is called instead of rereading visited file contents."
3975 ;; I admit it's odd to reverse the sense of the prefix argument, but
3976 ;; there is a lot of code out there which assumes that the first
3977 ;; argument should be t to avoid consulting the auto-save file, and
3978 ;; there's no straightforward way to encourage authors to notice a
3979 ;; reversal of the argument sense. So I'm just changing the user
3980 ;; interface, but leaving the programmatic interface the same.
3988 buffer-auto-save-file-name
3993 buffer-auto-save-file-name
3994 buffer-file-name)))
4004 file-name)))
4006 ;; If file was backed up but has changed since,
4007 ;; we shd make another backup.
4011 ;; Effectively copy the after-revert-hook status,
4012 ;; since after-find-file will clobber it.
4015 after-revert-hook))
4020 ;; Get rid of all undo records for this buffer.
4022 ;; Don't make undo records for the reversion.
4025 file-name auto-save-p)))
4028 "File %s no longer exists!"
4030 file-name))
4032 ;; Bind buffer-file-name to nil
4033 ;; so that we don't try to lock the file.
4039 ;; Auto-saved file should be read by Emacs'
4040 ;; internal coding.
4043 buffer-file-coding-system-explicit))))
4044 ;; This force after-insert-file-set-coding
4045 ;; (called from insert-file-contents) to set
4046 ;; buffer-file-coding-system to a proper value.
4049 ;; Note that this preserves point in an intelligent way.
4053 nil nil t))
4055 nil nil t)))))
4056 ;; Recompute the truename in case changes in symlinks
4057 ;; have changed the truename.
4061 ;; Run after-revert-hook as it was before we reverted.
4065 local-hook)
4068 t))))))
4071 "Recover the visited file--get contents from its last auto-save file."
4076 "Visit file FILE, but get contents from its last auto-save file."
4077 ;; Actually putting the file name in the minibuffer should be used
4078 ;; only rarely.
4079 ;; Not just because users often use the default.
4099 ;; Use insert-directory-safely, not insert-directory,
4100 ;; because these files might not exist. In particular,
4101 ;; FILE might not exist if the auto-save file was for
4102 ;; a buffer that didn't visit a file, such as "*mail*".
4103 ;; The code in v20.x called `ls' directly, so we need
4104 ;; to emulate what `ls' did in that case.
4110 ;; Keep the current buffer-file-coding-system.
4112 ;; Auto-saved file shoule be read with special coding.
4121 "Recover auto save files from a previous Emacs session.
4122 This command first displays a Dired buffer showing you the
4123 previous sessions that you could recover from.
4124 To choose one, move point to the proper line and then type C-c C-c.
4125 Then you'll be asked about a number of files to recover."
4135 auto-save-list-file-prefix)))
4136 t)
4145 ;; Each line starts with a space
4146 ;; so that Font Lock mode won't highlight the first character.
4155 "Choose one saved session to recover auto-save files from.
4156 This command is used in the special Dired buffer created by
4159 ;; Get the name of the session file to recover from.
4161 files
4167 ;; Read in the auto-save-list file.
4171 ;; Loop thru the text of that file
4172 ;; and get out the names of the files to recover.
4176 ;; This is a pair of lines for a non-file-visiting buffer.
4177 ;; Get the auto-save file name and manufacture
4178 ;; a "visited file name" from that.
4181 ;; If there is no auto-save file name, the
4182 ;; auto-save-list file is probably corrupted.
4197 ;; This pair of lines is a file-visiting
4198 ;; buffer. Use the visited file name.
4208 ;; Ignore a file if its auto-save file does not exist now.
4212 ;; The file contains a pair of line for each auto-saved buffer.
4213 ;; The first line of the pair contains the visited file name
4214 ;; or is empty if the buffer was not visiting a file.
4215 ;; The second line is the auto-save file name.
4223 files
4229 "Kill some buffers. Asks the user whether to kill each one of them.
4230 Non-interactively, if optional argument LIST is non-nil, it
4231 specifies the list of buffers to kill, asking for approval for each one."
4239 ; if we killed the base buffer.
4244 name
4249 \f
4251 "Toggle auto-saving of contents of current buffer.
4252 With prefix argument ARG, turn auto-saving on if positive, else off."
4257 ;; If auto-save is off because buffer has shrunk,
4258 ;; then toggling should turn it on.
4263 buffer-file-name
4265 ;; If -1 was stored here, to temporarily turn off saving,
4266 ;; turn it back on.
4272 buffer-auto-save-file-name)
4275 "Adjust current buffer's auto save file name for current conditions.
4276 Also rename any existing auto save file, if it was made in this session."
4288 "Return file name to use for auto-saves of current buffer.
4289 Does not consider `auto-save-visited-file-name' as that variable is checked
4290 before calling this function. You can redefine this for customization.
4291 See also `auto-save-file-name-p'."
4299 result uniq)
4300 ;; Apply user-specified translations
4301 ;; to the file name.
4305 filename)
4315 filename))))
4320 ;; We truncate the file name to DOS 8+3 limits
4321 ;; before doing anything else, because the regexp
4322 ;; passed to string-match below cannot handle
4323 ;; extensions longer than 3 characters, multiple
4324 ;; dots, and other atrocities.
4329 fn)
4334 "#"
4337 ;; Make sure auto-save file names don't contain characters
4338 ;; invalid for the underlying filesystem.
4340 ;; Don't modify remote (ange-ftp) filenames
4343 result))))
4345 ;; Deal with buffers that don't have any associated files. (Mail
4346 ;; mode tends to create a good number of these.)
4350 file-name)
4351 ;; Eliminate all slashes and backslashes by
4352 ;; replacing them with sequences that start with %.
4353 ;; Quote % also, to keep distinct names distinct.
4362 ;; Generate the file name.
4368 ;; Try a few alternative directories, to get one we can
4369 ;; write it.
4375 ;; Don't modify remote (ange-ftp) filenames
4377 ;; The call to convert-standard-filename is in case
4378 ;; buffer-name includes characters not allowed by the
4379 ;; DOS/Windows filesystems. make-temp-file writes to the
4380 ;; file it creates, so we must fix the file name _before_
4381 ;; make-temp-file is called.
4383 fname))
4385 ;; make-temp-file creates the file,
4386 ;; but we don't want it to exist until we do an auto-save.
4390 file-name)))
4393 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4394 FILENAME should lack slashes. You can redefine this for customization."
4396 \f
4398 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4399 The generated regexp will match a filename iff the filename
4400 matches that wildcard according to shell rules. Only wildcards known
4401 by `sh' are supported."
4403 ;; Copy the initial run of non-special characters.
4406 ;; If no special characters, we're almost done.
4410 j)
4412 result
4433 ;; Found "[^". Insert a `\0' character
4434 ;; (which cannot happen in a filename)
4435 ;; into the character class, so that `^'
4436 ;; is not the first character after `[',
4437 ;; and thus non-special in a regexp.
4442 ;; I don't think `]' can appear in a
4443 ;; character class in a wildcard, but
4444 ;; let's be general here.
4451 i
4464 ;; Shell wildcards should match the entire filename,
4465 ;; not its part. Make the regexp say so.
4467 \f
4470 "*Switches for `list-directory' to pass to `ls' for brief listing."
4476 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4478 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4483 "Expand wildcard pattern PATTERN.
4484 This returns a list of file names which match the pattern.
4486 If PATTERN is written as an absolute file name,
4487 the values are absolute also.
4489 If PATTERN is written as a relative file name, it is interpreted
4490 relative to the current default directory, `default-directory'.
4491 The file names returned are normally also relative to the current
4492 default directory. However, if FULL is non-nil, they are absolute."
4496 ;; A list of all dirs that DIRPART specifies.
4497 ;; This can be more than one dir
4498 ;; if DIRPART contains wildcards.
4503 contents)
4508 ;; Filter out "." and ".."
4513 name))
4520 this-dir-contents)
4521 this-dir-contents)
4522 contents))))
4524 contents)))
4527 "Display a list of files in or matching DIRNAME, a la `ls'.
4528 DIRNAME is globbed by the shell if necessary.
4529 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4530 Actions controlled by variables `list-directory-brief-switches'
4531 and `list-directory-verbose-switches'."
4535 nil default-directory nil)
4536 pfx)))
4538 list-directory-brief-switches))
4539 buffer)
4552 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4560 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4562 PATTERN is assumed to represent a file-name wildcard suitable for the
4563 underlying filesystem. For Unix and GNU/Linux, the characters from the
4565 the parts of the pattern which don't include wildcard characters are
4566 quoted with double quotes.
4567 Existing quote characters in PATTERN are left alone, so you can pass
4568 PATTERN that already quotes some of the special characters."
4572 ;; DOS/Windows don't allow `"' in file names. So if the
4573 ;; argument has quotes, we can safely assume it is already
4574 ;; quoted by the caller.
4576 ;; We quote [&()#$'] in case their shell is a port of a
4577 ;; Unixy shell. We quote [,=+] because stock DOS and
4578 ;; Windows shells require that in some cases, such as
4579 ;; passing arguments to batch files that use positional
4580 ;; arguments like %1.
4582 pattern
4585 end)
4602 pattern))))
4609 "*Program to get the amount of free space on a file system.
4610 We assume the output has the format of `df'.
4611 The value of this variable must be just a command name or file name;
4612 if you want to specify options, use `directory-free-space-args'.
4614 A value of nil disables this feature.
4616 If the function `file-system-info' is defined, it is always used in
4617 preference to the program given by this variable."
4623 "*Options to use when running `directory-free-space-program'."
4628 "Return the amount of free space on directory DIR's file system.
4629 The result is a string that gives the number of free 1KB blocks,
4630 or nil if the system call or the program which retrieve the information
4631 fail.
4633 This function calls `file-system-info' if it is available, or invokes the
4634 program specified by `directory-free-space-program' if that is non-nil."
4635 ;; Try to find the number of free blocks. Non-Posix systems don't
4636 ;; always have df, but might have an equivalent system call.
4645 nil t nil
4646 directory-free-space-args
4647 dir)))
4648 ;; Usual format is a header line followed by a line of
4649 ;; numbers.
4654 ;; Move to the end of the "available blocks" number.
4657 ;; Copy it into AVAILABLE.
4662 ;; The following expression replaces `dired-move-to-filename-regexp'.
4666 ;; In some locales, month abbreviations are as short as 2 letters,
4667 ;; and they can be followed by ".".
4668 ;; In Breton, a month name can include a quote character.
4681 s "+"
4684 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4685 ;; omits the Kanji characters after month and day-of-month.
4686 ;; On Mac OS X 10.3, the date format in East Asian locales is
4687 ;; day-of-month digits followed by month digits.
4693 ;; The "[0-9]" below requires the previous column to end in a digit.
4694 ;; This avoids recognizing `1 may 1997' as a date in the line:
4695 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4697 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4698 ;; The ".*" below finds the last match if there are multiple matches.
4699 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4700 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4702 ;; vc dired listings provide the state or blanks between file
4703 ;; permissions and date. The state is always surrounded by
4704 ;; parantheses:
4705 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4706 ;; This is not supported yet.
4710 "Regular expression to match up to the file name in a directory listing.
4711 The default value is designed to recognize dates and times
4716 ;; insert-directory
4717 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4718 ;; FULL-DIRECTORY-P is nil.
4719 ;; The single line of output must display FILE's name as it was
4720 ;; given, namely, an absolute path name.
4721 ;; - must insert exactly one line for each file if WILDCARD or
4722 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4723 ;; before the file lines, plus optional text after the file lines.
4724 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4725 ;; allowed.
4726 ;; File lines should display the basename.
4727 ;; - must be consistent with
4728 ;; - functions dired-move-to-filename, (these two define what a file line is)
4729 ;; dired-move-to-end-of-filename,
4730 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4731 ;; dired-insert-headerline
4732 ;; dired-after-subdir-garbage (defines what a "total" line is)
4733 ;; - variable dired-subdir-regexp
4734 ;; - may be passed "--dired" as the first argument in SWITCHES.
4735 ;; Filename handlers might have to remove this switch if their
4736 ;; "ls" command does not support it.
4738 "Insert directory listing for FILE, formatted according to SWITCHES.
4739 Leaves point after the inserted text.
4740 SWITCHES may be a string of options, or a list of strings
4741 representing individual options.
4742 Optional third arg WILDCARD means treat FILE as shell wildcard.
4743 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4744 switches do not contain `d', so that a full listing is expected.
4746 This works by running a directory listing program
4747 whose name is in the variable `insert-directory-program'.
4748 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4750 When SWITCHES contains the long `--dired' option, this function
4751 treats it specially, for the sake of dired. However, the
4752 normally equivalent short `-D' option is just passed on to
4753 `insert-directory-program', as any other option."
4754 ;; We need the directory in order to find the right handler.
4759 wildcard full-directory-p)
4764 ;; Read the actual directory using `insert-directory-program'.
4765 ;; RESULT gets the status code.
4767 ;; putting text property `dired-filename, decode one
4768 ;; bunch by one to preserve that property.
4770 ;; This is to control encoding the arguments in call-process.
4774 default-file-name-coding-system))))
4777 ;; Run ls in the directory part of the file pattern
4778 ;; using the last component as argument.
4785 shell-file-name nil t nil
4786 "-c"
4788 ""
4790 insert-directory-program
4791 " -d "
4793 switches
4795 " -- "
4796 ;; Quote some characters that have
4797 ;; special meanings in shells; but
4798 ;; don't quote the wildcards--we want
4799 ;; them to be special. We also
4800 ;; currently don't quote the quoting
4801 ;; characters in case people want to
4802 ;; use them explicitly to quote
4803 ;; wildcard characters.
4805 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4806 ;; directory if FILE is a symbolic link.
4808 insert-directory-program nil t nil
4812 ;; Split the switches at any spaces so we can
4813 ;; pass separate options as separate args.
4815 ;; Avoid lossage if FILE starts with `-'.
4823 file))))))))
4825 ;; If we got "//DIRED//" in the output, it means we got a real
4826 ;; directory listing, even if `ls' returned nonzero.
4827 ;; So ignore any errors.
4840 ;; The first time ls returns an error,
4841 ;; find the version numbers of ls,
4842 ;; and set insert-directory-ls-version
4843 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4844 ;; is equal or if the info cannot be obtained.
4845 ;; (That can mean it isn't GNU ls.)
4855 comparison)
4871 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4875 ;; If `insert-directory-program' failed, signal an error.
4877 ;; Delete the error message it may have output.
4879 ;; On non-Posix systems, we cannot open a directory, so
4880 ;; don't even try, because that will always result in
4881 ;; the ubiquitous "Access denied". Instead, show the
4882 ;; command line so the user can try to guess what went wrong.
4887 insert-directory-program
4889 file result)
4890 ;; Unix. Access the file to get a suitable error.
4897 ;; The following overshoots by one line for an empty
4898 ;; directory listed with "--dired", but without "-a"
4899 ;; switch, where the ls output contains a
4900 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4901 ;; We take care of that case later.
4909 error-lines)
4910 ;; Find all the lines that are error messages,
4911 ;; and record the bounds of each one.
4918 ;; Now read the numeric positions of file names.
4925 error-lines))
4928 error-lines)))
4930 ;; End is followed by \n or by " -> ".
4932 ;; It seems that we can't trust ls's output as to
4933 ;; byte positions of filenames.
4939 ;; Take care of the case where the ls output contains a
4940 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4941 ;; and we went one line too far back (see above).
4946 ;; Now decode what read if necessary.
4948 file-name-coding-system
4949 default-file-name-coding-system
4951 coding-no-eol
4952 val pos)
4956 ;; If no coding system is specified or detection is
4957 ;; requested, detect the coding.
4971 ;; Force no eol conversion on a file name, so
4972 ;; that CR is preserved.
4980 ;; Try to insert the amount of free space.
4983 ;; First find the line to put it on.
4987 ;; Replace "total" with "used", to avoid confusion.
4993 "Convert `ls --dired' file name position value POS to a buffer position.
4994 File name position values returned in ls --dired output
4995 count only stdout; they don't count the error messages sent to stderr.
4996 So this function converts to them to real buffer positions.
4997 ERROR-LINES is a list of buffer positions of error message lines,
4998 of the form (START END)."
5002 pos)
5006 "Insert directory listing for FILE, formatted according to SWITCHES.
5008 Like `insert-directory', but if FILE does not exist, it inserts a
5009 message to that effect instead of signaling an error."
5012 ;; Simulate the message printed by `ls'.
5016 "Functions to call with no arguments to query about killing Emacs.
5017 If any of these functions returns nil, killing Emacs is cancelled.
5019 but `kill-emacs', the low level primitive, does not.
5023 "How to ask for confirmation when leaving Emacs.
5024 If nil, the default, don't ask at all. If the value is non-nil, it should
5025 be a predicate function such as `yes-or-no-p'."
5033 "Offer to save each buffer, then kill this Emacs process.
5034 With prefix arg, silently save all file-visiting buffers, then kill."
5043 ;; process-list is not defined on VMS.
5045 active)
5054 ;; Query the user for other things, perhaps.
5059 \f
5060 ;; We use /: as a prefix to "quote" a file name
5061 ;; so that magic file name handlers will not apply to it.
5065 file-name-handler-alist))
5067 ;; We depend on being the last handler on the list,
5068 ;; so that anything else which does need handling
5069 ;; has been handled already.
5070 ;; So it is safe for us to inhibit *all* magic file name handlers.
5079 default-directory))
5080 ;; Get a list of the indices of the args which are file names.
5083 ;; The first six are special because they
5084 ;; return a file name. We want to include the /:
5085 ;; in the return value.
5086 ;; So just avoid stripping it in the first place.
5093 ;; `identity' means just return the first arg
5094 ;; not stripped of its quoting.
5096 ;; `add' means add "/:" to the result.
5098 ;; `quote' means add "/:" to buffer-file-name.
5100 ;; `unquote-then-quote' means set buffer-file-name
5101 ;; temporarily to unquoted filename.
5103 ;; List the arguments which are filenames.
5111 ;; For all other operations, treat the first argument only
5112 ;; as the file name.
5114 method
5115 ;; Copy ARGUMENTS so we can replace elements in it.
5119 ;; Strip off the /: from the file names that have it.
5127 "/"
5143 res))
5146 \f
5171 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5172 ;;; files.el ends here