| blob | 9ef937570002b1940113c85a0b17f0d71047e173 |
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."
168 "Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
199 "The directory for writing temporary files."
205 "The directory for writing small temporary files.
206 If non-nil, this directory is used instead of `temporary-file-directory'
207 by programs that create small temporary files. This is for systems that
208 have fast storage with limited space, such as a RAM disk."
212 ;; The system null device. (Should reference NULL_DEVICE from C.)
229 "Non-nil means protect against I/O errors while saving files.
230 Some modes set this non-nil in particular buffers.
232 This feature works by writing the new contents into a temporary file
233 and then renaming the temporary file to replace the original.
234 In this way, any I/O error in writing leaves the original untouched,
235 and there is never any instant where the file is nonexistent.
237 Note that this feature forces backups to be made by copying.
238 Yet, at the same time, saving a precious file
239 breaks any hard links between it and other files."
244 "Control use of version numbers for backup files.
245 When t, make numeric backup versions unconditionally.
246 When nil, make them for files that have some already.
247 The value `never' means do not make them."
257 "When cleaning directory, number of versions to keep."
263 "If t, delete excess backup versions silently.
264 If nil, ask confirmation. Any other value prevents any trimming."
271 "Number of oldest versions to keep when a new numbered backup is made."
277 "Number of newest versions to keep when a new numbered backup is made.
278 Includes the new backup. Must be > 0"
284 "Whether to add a newline automatically at the end of the file.
286 A value of t means do this only when the file is about to be saved.
287 A value of `visit' means do this right after the file is visited.
288 A value of `visit-save' means do it at both of those times.
289 Any other non-nil value means ask user whether to add a newline, when saving.
290 nil means don't add newlines.
292 Certain major modes set this locally to the value obtained
293 from `mode-require-final-newline'."
302 "Whether to add a newline at end of file, in certain major modes.
303 Those modes set `require-final-newline' to this value when you enable them.
304 They do so because they are often used for files that are supposed
305 to end in newlines, and the question is how to arrange that.
307 A value of t means do this only when the file is about to be saved.
308 A value of `visit' means do this right after the file is visited.
309 A value of `visit-save' means do it at both of those times.
310 Any other non-nil value means ask user whether to add a newline, when saving.
312 nil means do not add newlines. That is a risky choice in this variable
313 since this value is used for modes for files that ought to have final newlines.
314 So if you set this to nil, you must explicitly check and add
315 a final newline, whenever you save a file that really needs one."
325 "Non-nil says by default do auto-saving of every file-visiting buffer."
330 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
331 Normally auto-save files are written under other names."
337 ;; Don't put "\\2" inside expand-file-name, since it will be
338 ;; transformed to "/2" on DOS/Windows.
340 "Transforms to apply to buffer file name before making auto-save file name.
341 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
342 REGEXP is a regular expression to match against the file name.
343 If it matches, `replace-match' is used to replace the
344 matching part with REPLACEMENT.
345 If the optional element UNIQUIFY is non-nil, the auto-save file name is
346 constructed by taking the directory part of the replaced file-name,
347 concatenated with the buffer file name with all directory separators
348 changed to `!' to prevent clashes. This will not work
349 correctly if your filesystem truncates the resulting name.
351 All the transforms in the list are tried, in the order they are listed.
352 When one transform applies, its result is final;
353 no further transforms are tried.
355 The default value is set up to put the auto-save file into the
356 temporary directory (see the variable `temporary-file-directory') for
357 editing a remote file.
359 On MS-DOS filesystems without long names this variable is always
360 ignored."
367 "Non-nil means save word abbrevs too when files are saved.
368 If `silently', don't ask the user before saving."
373 "Non-nil means allow `find-file' to visit directories.
374 To visit the directory, `find-file' runs `find-directory-functions'."
379 "List of functions to try in sequence to visit a directory.
380 Each function is called with the directory name as the sole argument
381 and should return either a buffer or nil."
385 ;;;It is not useful to make this a local variable.
386 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
388 "List of functions to be called for `find-file' on nonexistent file.
389 These functions are called as soon as the error is detected.
390 Variable `buffer-file-name' is already set up.
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-hooks 'permanent-local t)
398 "List of functions to be called after a buffer is loaded from a file.
399 The buffer's local variables (if any) will have been processed before the
400 functions are called."
408 "List of functions to be called before writing out a buffer to a file.
409 If one of them returns non-nil, the file is considered already written
410 and the rest are not called.
411 These hooks are considered to pertain to the visited file.
412 So any buffer-local binding of this variable is discarded if you change
414 change the major mode.
416 This hook is not run if any of the functions in
417 `write-contents-functions' returns non-nil. Both hooks pertain
418 to how to save a buffer to file, for instance, choosing a suitable
419 coding system and setting mode bits. (See Info
420 node `(elisp)Saving Buffers'.) To perform various checks or
431 "List of functions to be called before writing out a buffer to a file.
432 If one of them returns non-nil, the file is considered already written
433 and the rest are not called and neither are the functions in
434 `write-file-functions'.
436 This variable is meant to be used for hooks that pertain to the
437 buffer's contents, not to the particular visited file; thus,
438 `set-visited-file-name' does not clear this variable; but changing the
439 major mode does clear it.
441 For hooks that _do_ pertain to the particular visited file, use
442 `write-file-functions'. Both this variable and
443 `write-file-functions' relate to how a buffer is saved to file.
444 To perform various checks or updates before the buffer is saved,
451 "Control use of local variables in files you visit.
452 The value can be t, nil, :safe, or something else.
454 A value of t means file local variables specifications are obeyed
455 if all the specified variable values are safe; if any values are
456 not safe, Emacs queries you, once, whether to set them all.
457 \(When you say yes to certain values, they are remembered as safe.)
459 :safe means set the safe variables, and ignore the rest.
460 :all means set all variables, whether safe or not.
461 (Don't set it permanently to :all.)
462 nil means always ignore the file local variables.
464 Any other value means always query you once whether to set them all.
465 \(When you say yes to certain values, they are remembered as safe, but
468 This variable also controls use of major modes specified in
469 a -*- line.
472 always obeys file local variable specifications and the -*- line,
473 and ignores this variable."
482 "Like `enable-local-variables' but meant for buffer-local bindings.
483 The meaningful values are nil and non-nil. The default is non-nil.
484 If a major mode sets this to nil, buffer-locally, then any local
485 variables list in the file will be ignored.
487 This variable does not affect the use of major modes
492 The value can be t, nil or something else.
493 A value of t means obey `eval' variables;
494 nil means ignore them; anything else means query."
500 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
509 "Non-nil means buffers visiting files read-only do so in view mode.
510 In fact, this means that all read-only buffers normally have
511 View mode enabled, including buffers that are read-only because
512 you visit a file you cannot alter, and buffers you make read-only
519 \f
522 "Provides support for ange-ftp host name completion.
523 Runs the usual ange-ftp hook, but only for completion operations."
524 ;; Having this here avoids the need to load ange-ftp when it's not
525 ;; really in use.
531 inhibit-file-name-handlers)))
536 "Convert a standard file's name to something suitable for the OS.
537 This means to guarantee valid names and perhaps to canonicalize
538 certain patterns.
540 FILENAME should be an absolute file name since the conversion rules
541 sometimes vary depending on the position in the file name. E.g. c:/foo
542 is a valid DOS file name, but c:/bar/c:/foo is not.
544 This function's standard definition is trivial; it just returns
545 the argument. However, on Windows and DOS, replace invalid
546 characters. On DOS, make sure to obey the 8.3 limitations.
547 In the native Windows build, turn Cygwin names into native names,
548 and also turn slashes into backslashes if the shell requires it (see
549 `w32-shell-dos-semantics').
551 See Info node `(elisp)Standard File Names' for more details."
555 ;; Replace invalid filename characters with !
559 name)
560 filename))
563 "Read directory name, prompting with PROMPT and completing in directory DIR.
564 Value is not expanded---you must call `expand-file-name' yourself.
565 Default name to DEFAULT-DIRNAME if user exits with the same
566 non-empty string that was inserted by this function.
567 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
568 or just DIR if INITIAL is nil.)
569 If the user exits with an empty minibuffer, this function returns
570 an empty string. (This can only happen if the user erased the
571 pre-inserted contents or if `insert-default-directory' is nil.)
572 Fourth arg MUSTMATCH non-nil means require existing directory's name.
573 Non-nil and non-t means also require confirmation after completion.
574 Fifth arg INITIAL specifies text to start with.
575 DIR should be an absolute directory name. It defaults to
576 the value of `default-directory'."
581 dir))
582 mustmatch initial
585 \f
587 "Show the current default directory."
592 "Value of the CDPATH environment variable, as a list.
596 "Explode a search path into a list of directory names.
597 Directories are separated by occurrences of `path-separator'
598 \(which is colon in GNU and GNU-like systems)."
599 ;; We could use split-string here.
607 nil
612 cd-list)))
615 "Change current directory to given absolute file name DIR."
616 ;; Put the name into directory syntax now,
617 ;; because otherwise expand-file-name may give some bad results.
630 "Make DIR become the current buffer's default directory.
631 If your environment includes a `CDPATH' variable, try each one of
632 that list of directories (separated by occurrences of
633 `path-separator') when resolving a relative directory name.
634 The path separator is colon in GNU and GNU-like systems."
637 default-directory default-directory
653 cd-path)
654 nil))
658 "Load the Lisp file named FILE."
659 ;; This is a case where .elc makes a lot of sense.
666 "Search for FILENAME through PATH.
667 If found, return the absolute file name of FILENAME, with its suffixes;
668 otherwise return nil.
669 PATH should be a list of directories to look in, like the lists in
670 `exec-path' or `load-path'.
671 If SUFFIXES is non-nil, it should be a list of suffixes to append to
674 If non-nil, PREDICATE is used instead of `file-readable-p'.
675 PREDICATE can also be an integer to pass to the `access' system call,
676 in which case file-name handlers are ignored. This usage is deprecated.
678 For compatibility, PREDICATE can also be one of the symbols
679 `executable', `readable', `writable', or `exists', or a list of
680 one or more of those symbols."
691 "Do completion for file names passed to `locate-file'.
692 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
715 "Search for COMMAND in `exec-path' and return the absolute file name.
716 Return nil if COMMAND is not found anywhere in `exec-path'."
717 ;; Use 1 rather than file-executable-p to better match the behavior of
718 ;; call-process.
722 "Load the library named LIBRARY.
723 This is an interface to the function `load'."
726 'locate-file-completion
731 "Test whether FILE specifies a location on a remote system.
732 Return an identification of the system if the location is indeed
733 remote. The identification of the system may comprise a method
734 to access the system and its hostname, amongst other things.
741 nil)))
744 "Copy the file FILE into a temporary file on this machine.
745 Returns the name of the local copy, or nil, if FILE is directly
746 accessible."
747 ;; This formerly had an optional BUFFER argument that wasn't used by
748 ;; anything.
752 nil)))
755 "Return the truename of FILENAME, which should be absolute.
756 The truename of a file name is found by chasing symbolic links
757 both at the level of the file and at the level of the directories
758 containing it, until no links are left at any level.
761 ;; COUNTER and PREV-DIRS are only used in recursive calls.
762 ;; COUNTER can be a cons cell whose car is the count of how many
763 ;; more links to chase before getting an error.
764 ;; PREV-DIRS can be a cons cell whose car is an alist
765 ;; of truenames we've just recently computed.
779 ;; For speed, remove the ange-ftp completion handler from the list.
780 ;; We know it's not needed here.
781 ;; For even more speed, do this only on the outermost call.
788 ;; andrewi@harlequin.co.uk - none of the following code (except for
789 ;; invoking the file-name handler) currently applies on Windows
790 ;; (ie. there are no native symlinks), but there is an issue with
791 ;; case differences being ignored by the OS, and short "8.3 DOS"
792 ;; name aliases existing for all files. (The short names are not
793 ;; reported by directory-files, but can be used to refer to files.)
794 ;; It seems appropriate for file-truename to resolve these issues in
795 ;; the most natural way, which on Windows is to call the function
796 ;; `w32-long-file-name' - this returns the exact name of a file as
797 ;; it is stored on disk (expanding short name aliases with the full
798 ;; name in the process).
801 ;; For file name that has a special handler, call handler.
802 ;; This is so that ange-ftp can save time by doing a no-op.
805 ;; If filename contains a wildcard, newname will be the old name.
807 ;; If filename exists, use the long name
811 ;; If this file directly leads to a link, process that iteratively
812 ;; so that we don't use lots of stack.
818 ;; For file name that has a special handler, call handler.
819 ;; This is so that ange-ftp can save time by doing a no-op.
822 done t)
824 target dirfile)
825 ;; Get the truename of the directory.
827 ;; If these are equal, we have the (or a) root directory.
829 ;; If this is the same dir we last got the truename for,
830 ;; save time--don't recalculate.
840 done t)
843 done t)
844 ;; Put it back on the file name.
846 ;; Is the file name the name of a link?
849 ;; Yes => chase that link, then start all over
850 ;; since the link may point to a directory name that uses links.
851 ;; We can't safely use expand-file-name here
852 ;; since target might look like foo/../bar where foo
853 ;; is itself a link. Instead, we handle . and .. above.
856 target
858 done nil)
859 ;; No, we are done!
861 filename))
864 "Chase links in FILENAME until a name that is not a link.
865 Unlike `file-truename', this does not check whether a parent
866 directory name is a symbolic link.
867 If the optional argument LIMIT is a number,
868 it means chase no more than that many links and then stop."
876 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
879 ;; Handle `..' by hand, since it needs to work in the
880 ;; target of any directory symlink.
881 ;; This code is not quite complete; it does not handle
882 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
886 ;; Chase links in the default dir of the symlink.
890 ;; Now find the parent of that dir.
894 newname))
897 "Create a temporary file.
898 The returned file name (created by appending some random characters at the end
899 of PREFIX, and expanding against `temporary-file-directory' if necessary),
900 is guaranteed to point to a newly created empty file.
901 You can then use `write-region' to write new data into the file.
903 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
905 If SUFFIX is non-nil, add that at the end of the file name."
907 file)
910 ;; Create temp files with strict access rights. It's easy to
911 ;; loosen them later, whereas it's impossible to close the
912 ;; time-window of loose permissions otherwise.
924 nil)
926 ;; the file was somehow created by someone else between
927 ;; `make-temp-name' and `write-region', let's try again.
928 nil)
929 file)
930 ;; Reset the umask.
934 "Change the encoding of FILE's name from CODING to NEW-CODING.
935 The value is a new name of FILE.
936 Signals a `file-already-exists' error if a file of the new name
937 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
938 is non-nil. A number as fourth arg means request confirmation if
939 the new name already exists. This is what happens in interactive
940 use with M-x."
943 default-file-name-coding-system))
945 from-coding to-coding)
947 ;; We provide the default coding only when it seems that
948 ;; the filename is correctly decoded by the default
949 ;; coding.
955 filename default-coding)
956 default-coding))
960 ;; We provide the default coding only when a user is going to
961 ;; change the encoding not from the default coding.
965 filename from-coding)))
968 filename from-coding default-coding)
969 default-coding)))
973 default-file-name-coding-system))
974 ;; FILE should have been decoded by DEFAULT-CODING.
978 ;; Suppress further encoding.
983 newname))
984 \f
986 "Select buffer BUFFER in another window.
987 If BUFFER does not identify an existing buffer, then this function
988 creates a buffer with that name.
990 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
991 or nil. If BUFFER is nil, then this function chooses a buffer
992 using `other-buffer'.
993 Optional second arg NORECORD non-nil means
994 do not put this buffer at the front of the list of recently selected ones.
995 This function returns the buffer it switched to.
997 This uses the function `display-buffer' as a subroutine; see its
998 documentation for additional customization information."
1001 ;; Don't let these interfere.
1002 same-window-buffer-names same-window-regexps)
1006 "Switch to buffer BUFFER in another frame.
1007 Optional second arg NORECORD non-nil means
1008 do not put this buffer at the front of the list of recently selected ones.
1010 This uses the function `display-buffer' as a subroutine; see its
1011 documentation for additional customization information."
1014 same-window-buffer-names same-window-regexps)
1019 "Switch to buffer BUFFER in another frame.
1020 This uses the function `display-buffer' as a subroutine; see its
1021 documentation for additional customization information."
1024 same-window-buffer-names same-window-regexps
1026 new-window)
1036 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1037 BODY should use the minibuffer at most once.
1038 Recursive uses of the minibuffer will not be affected."
1044 ;; Clear out this hook so it does not interfere
1045 ;; with any recursive minibuffer usage.
1061 t))
1064 "Edit file FILENAME.
1065 Switch to a buffer visiting file FILENAME,
1066 creating one if none already exists.
1067 Interactively, the default if you just type RET is the current directory,
1068 but the visited file name is available through the minibuffer history:
1069 type M-n to pull it into the minibuffer.
1071 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1072 expand wildcards (if any) and visit multiple files. You can
1073 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1075 To visit a file without any kind of conversion and without
1084 "Edit file FILENAME, in another window.
1085 May create a new window, or reuse an existing one.
1086 See the function `display-buffer'.
1088 Interactively, the default if you just type RET is the current directory,
1089 but the visited file name is available through the minibuffer history:
1090 type M-n to pull it into the minibuffer.
1092 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1093 expand wildcards (if any) and visit multiple files."
1104 "Edit file FILENAME, in another frame.
1105 May create a new frame, or reuse an existing one.
1106 See the function `display-buffer'.
1108 Interactively, the default if you just type RET is the current directory,
1109 but the visited file name is available through the minibuffer history:
1110 type M-n to pull it into the minibuffer.
1112 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1113 expand wildcards (if any) and visit multiple files."
1124 "Edit the existing file FILENAME.
1126 file names with wildcards."
1134 "Edit file FILENAME but don't allow changes.
1146 value))
1149 "Edit file FILENAME in another window but don't allow changes.
1161 value))
1164 "Edit file FILENAME in another frame but don't allow changes.
1176 value))
1179 "Find file FILENAME as a replacement for the file in the next window.
1180 This command does not select that window.
1182 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1183 expand wildcards (if any) and replace the file with multiple files."
1195 t))))
1203 "Find file FILENAME, select its buffer, kill previous buffer.
1204 If the current buffer now contains an empty file that you just visited
1205 \(presumably by mistake), use this command to visit the file you really want.
1207 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1208 expand wildcards (if any) and replace the file with multiple files.
1210 If the current buffer is an indirect buffer, or the base buffer
1211 for one or more indirect buffers, the other buffer(s) are not
1212 killed."
1222 t)))
1243 ;; This prevents us from finding the same buffer
1244 ;; if we specified the same file again.
1248 ;; Likewise for dired buffers.
1252 ;; This executes if find-file gets an error
1253 ;; and does not really find anything.
1254 ;; We put things back as they were.
1255 ;; If find-file actually finds something, we kill obuf below.
1264 ;; We already asked; don't ask again.
1267 \f
1269 "Create a suitably named buffer for visiting FILENAME, and return it.
1270 FILENAME (sans directory) is used unchanged if that name is free;
1271 otherwise a string <2> or <3> or ... is appended to get an unused name."
1278 "Create and return a buffer with a name based on NAME.
1279 Choose the buffer's name using `generate-new-buffer-name'."
1283 "Regexp to match the automounter prefix in a directory name."
1291 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1293 home directory is a root directory) and removes automounter prefixes
1294 \(see the variable `automount-dir-prefix')."
1295 ;; Get rid of the prefixes added by the automounter.
1303 ;; If any elt of directory-abbrev-alist matches this name,
1304 ;; abbreviate accordingly.
1310 ;; Compute and save the abbreviated homedir name.
1311 ;; We defer computing this until the first time it's needed, to
1312 ;; give time for directory-abbrev-alist to be set properly.
1313 ;; We include a slash at the end, to avoid spurious matches
1314 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1321 ;; If FILENAME starts with the abbreviated homedir,
1322 ;; make it start with `~' instead.
1324 ;; If the home dir is just /, don't change it.
1327 ;; MS-DOS root directories can come with a drive letter;
1328 ;; Novell Netware allows drive letters beyond `Z:'.
1338 filename)))
1341 "List of logical names for which visiting shouldn't save the true dirname.
1342 On VMS, when you visit a file using a logical name that searches a path,
1343 you may or may not want the visited file name to record the specific
1344 directory where the file was found. If you *do not* want that, add the logical
1345 name to this list as a string."
1350 "Return the buffer visiting file FILENAME (a string).
1351 This is like `get-file-buffer', except that it checks for any buffer
1352 visiting the same file, possibly under a different name.
1353 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1354 and others are ignored.
1355 If there is no such live buffer, return nil."
1369 found)
1379 ;; Verify this buffer's file number
1380 ;; still belongs to its file.
1383 attributes)
1387 found))))
1388 \f
1390 "Non-nil means file-visiting commands should handle wildcards.
1391 For example, if you specify `*.c', that would visit all the files
1392 whose names match the pattern."
1398 "Non-nil means suppress warning messages for symlinked files.
1399 When nil, Emacs prints a warning when visiting a file that is already
1400 visited, but with a different name. Setting this option to t
1401 suppresses this warning."
1407 "Maximum size of file above which a confirmation is requested.
1408 When nil, never request confirmation."
1415 "Read file FILENAME into a buffer and return the buffer.
1416 If a buffer exists visiting FILENAME, return that one, but
1417 verify that the file has not changed since visited or saved.
1418 The buffer is not selected, just returned to the caller.
1419 Optional second arg NOWARN non-nil means suppress any warning messages.
1420 Optional third arg RAWFILE non-nil means the file is read literally.
1421 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1422 and visit all the matching files. When wildcards are actually
1423 used and expanded, return a list of buffers that are visiting
1424 the various files."
1431 'find-directory-functions
1434 filename)))
1437 find-file-wildcards
1451 ;; Find any buffer for a file which has same truename.
1453 ;; Let user know if there is a buffer with the same truename.
1457 find-file-suppress-same-file-warnings
1461 ;; Optionally also find that buffer.
1464 ;; Check to see if the file looks uncommonly large.
1466 ;; Don't ask again if we already have the file or
1467 ;; if we're asked to be quiet.
1476 ;; We are using an existing buffer.
1482 ;; Certain files should be reverted automatically
1483 ;; if they have changed on disk and not in the buffer.
1491 found))
1501 "File %s changed on disk. Discard your edits? "
1506 "File %s changed on disk. Discard your edits in %s? "
1514 ;; Check if a formerly read-only file has become
1515 ;; writable and vice versa, but if the buffer agrees
1516 ;; with the new state of the file, that is ok too.
1523 buffer-file-name
1531 ;; It is confusing to ask whether to visit
1532 ;; non-literally if they have the file in
1533 ;; hexl-mode.
1539 "The file %s is already visited normally,
1540 and you have edited the buffer. Now you have asked to visit it literally,
1541 meaning no coding system handling, format conversion, or local variables.
1542 Emacs can only visit a file in one way at a time.
1544 Do you want to save the file, and visit it literally instead? "
1545 "The file %s is already visited literally,
1546 meaning no coding system handling, format conversion, or local variables.
1547 You have edited the buffer. Now you have asked to visit the file normally,
1548 but Emacs can only visit a file in one way at a time.
1555 rawfile truename number))
1559 "\
1560 Do you want to discard your changes, and visit the file literally now? "
1561 "\
1564 rawfile truename number)
1570 "The file %s is already visited normally.
1571 You have asked to visit it literally,
1572 meaning no coding system decoding, format conversion, or local variables.
1573 But Emacs can only visit a file in one way at a time.
1575 Do you want to revisit the file literally now? "
1576 "The file %s is already visited literally,
1577 meaning no coding system decoding, format conversion, or local variables.
1578 You have asked to visit it normally,
1579 but Emacs can only visit a file in one way at a time.
1584 rawfile truename number)
1587 ;; Return the buffer we are using.
1588 buf)
1589 ;; Create a new buffer.
1591 ;; find-file-noselect-1 may use a different buffer.
1593 rawfile truename number))))))
1599 ;; Needed in case we are re-visiting the file with a different
1600 ;; text representation.
1617 filename)))
1618 ;; Unconditionally set error
1628 filename)))
1629 ;; Run find-file-not-found-functions until one returns non-nil.
1631 ;; If they fail too, set error.
1633 ;; Record the file's truename, and maybe use that as visited name.
1639 ;; On VMS, we may want to remember which directory in a search list
1640 ;; the file was found in.
1650 ;; Set buffer's default directory to that of the file.
1652 ;; Turn off backup files for certain file names. Since
1653 ;; this is a permanent local, the major mode won't eliminate it.
1668 \f
1670 "Like `insert-file-contents', but only reads in the file literally.
1671 A buffer may be modified in several ways after reading into the buffer,
1672 to Emacs features such as format decoding, character code
1673 conversion, `find-file-hook', automatic uncompression, etc.
1675 This function ensures that none of these modifications will take place."
1683 nil))
1686 inhibit-file-name-handlers))
1699 filename)))
1700 ;; Check whether the file is uncommonly large (see find-file-noselect):
1719 "Insert contents of file FILENAME into buffer after point with no conversion.
1721 This function is meant for the user to run interactively.
1722 Don't call it from programs! Use `insert-file-contents-literally' instead.
1723 \(Its calling sequence is different; see its documentation)."
1728 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1733 "Visit file FILENAME with no conversion of any kind.
1734 Format conversion and character code conversion are both disabled,
1735 and multibyte characters are disabled in the resulting buffer.
1736 The major mode used is Fundamental mode regardless of the file name,
1737 and local variable specifications in the file are ignored.
1738 Automatic uncompression and adding a newline at the end of the
1739 file due to `require-final-newline' is also disabled.
1741 You cannot absolutely rely on this function to result in
1742 visiting the file literally. If Emacs already has a buffer
1743 which is visiting the file, you get the existing buffer,
1744 regardless of whether it was created literally or not.
1746 In a Lisp program, if you want to be sure of accessing a file's
1747 contents literally, you should create a temporary buffer and then read
1748 the file contents into it using `insert-file-contents-literally'."
1751 \f
1755 after-find-file-from-revert-buffer
1756 nomodes)
1757 "Called after finding a file and by the default revert function.
1758 Sets buffer mode, parses local variables.
1759 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1760 error in reading the file. WARN non-nil means warn if there
1761 exists an auto-save file more recent than the visited file.
1762 NOAUTO means don't mess with auto-save mode.
1763 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1764 means this call was from `revert-buffer'.
1765 Fifth arg NOMODES non-nil means don't alter the file's modes.
1766 Finishes by calling the functions in `find-file-hook'
1767 unless NOMODES is non-nil."
1770 nil
1780 ;; No need to warn if buffer is auto-saved
1781 ;; under the name of the visited file.
1783 auto-save-visited-file-name))
1786 buffer-file-name))
1806 ;; Make people do a little extra work (C-x C-q)
1807 ;; before altering a backup file.
1810 ;; When a file is marked read-only,
1811 ;; make the buffer read-only even if root is looking at it.
1819 ;; If requested, add a newline at the end of the file.
1829 view-read-only
1835 "Eval BODY and turn any error into a FORMAT message.
1836 FORMAT can have a %s escape which will be replaced with the actual error.
1837 If `debug-on-error' is set, errors are not caught, so that you can
1838 debug them.
1839 Avoid using a large BODY since it is duplicated."
1848 "Choose the major mode for this buffer automatically.
1849 Also sets up any specified local variables of the file.
1850 Uses the visited file name, the -*- line, and the local variables spec.
1852 This function is called automatically from `find-file'. In that case,
1853 we may set up the file-specified mode and local variables,
1854 depending on the value of `enable-local-variables'.
1855 In addition, if `local-enable-local-variables' is nil, we do
1856 not set local variables (though we do notice a mode specified with -*-.)
1858 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1859 or from Lisp without specifying the optional argument FIND-FILE;
1860 in that case, this function acts as if `enable-local-variables' were t."
1868 ;; Turn font lock off and on, to make sure it takes account of
1869 ;; whatever file local variables are relevant to it.
1871 ;; Font-lock-mode (now in font-core.el) can be ON when
1872 ;; font-lock.el still hasn't been loaded.
1882 "Non-nil means to try second pass through `auto-mode-alist'.
1883 This means that if the first case-sensitive search through the alist fails
1884 to find a matching major mode, a second case-insensitive search is made.
1885 On systems with case-insensitive file names, this variable is ignored,
1886 since only a single case-insensitive search through the alist is made."
1892 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1893 ;; c++-mode, java-mode and more) are added through autoload
1894 ;; directives in that file. That way is discouraged since it
1895 ;; spreads out the definition of the initial value.
1927 ;; Less common extensions come here
1928 ;; so more common ones above are found faster.
1967 ;; The list of archive file extensions should be in sync with
1968 ;; `auto-coding-alist' with `no-conversion' coding system.
1972 ;; Mailer puts message to be edited in
1973 ;; /tmp/Re.... or Message
1977 ;; some news reader is reported to use this
1986 ;; .emacs or .gnus or .viper following a directory delimiter in
1987 ;; Unix, MSDOG or VMS syntax.
1990 ;; _emacs following a directory delimiter
1991 ;; in MsDos syntax
2010 ;; Windows candidates may be opened case sensitively on Unix
2016 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2018 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2019 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2020 ;; either user's dot-files or under /etc or some such
2022 ;; alas not all ~/.*rc files are like this
2023 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2028 ;; this contains everything twice, with space and with colon :-(
2030 ;; Get rid of any trailing .n.m and try again.
2031 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2032 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2033 ;; Using mode nil rather than `ignore' would let the search continue
2034 ;; through this list (with the shortened name) rather than start over.
2036 ;; The following should come after the ChangeLog pattern
2037 ;; for the sake of ChangeLog.1, etc.
2038 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2041 "Alist of filename patterns vs corresponding major mode functions.
2042 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2043 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2044 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2045 mode function to use. FUNCTION will be called, unless it is nil.
2047 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2048 calling FUNCTION (if it's not nil), we delete the suffix that matched
2049 REGEXP and search the list again for another match.
2051 If the file name matches `inhibit-first-line-modes-regexps',
2052 then `auto-mode-alist' is not processed.
2054 The extensions whose FUNCTION is `archive-mode' should also
2055 appear in `auto-coding-alist' with `no-conversion' coding system.
2057 See also `interpreter-mode-alist', which detects executable script modes
2058 based on the interpreters they specify to run,
2062 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2063 ;; and pike-mode) are added through autoload directives in that
2064 ;; file. That way is discouraged since it spreads out the
2065 ;; definition of the initial value.
2103 "Alist mapping interpreter names to major modes.
2104 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2105 Each element looks like (INTERPRETER . MODE).
2106 If INTERPRETER matches the name of the interpreter specified in the first line
2107 of a script, mode MODE is enabled.
2115 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2116 When checking `inhibit-first-line-modes-regexps', we first discard
2122 "Regexp matching interpreters, for file mode determination.
2123 This regular expression is matched against the first line of a file
2124 to determine the file's mode in `set-auto-mode'. If it matches, the file
2125 is assumed to be interpreted by the interpreter matched by the second group
2126 of the regular expression. The mode is then determined as the mode
2131 ;; The < comes before the groups (but the first) to reduce backtracking.
2132 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2133 ;; We use [ \t\n] instead of `\\s ' to make regex overflow less likely.
2137 comment-re "*"
2140 . html-mode)
2141 ;; These two must come after html, because they are more general:
2146 . sgml-mode)
2149 "Alist of buffer beginnings vs. corresponding major mode functions.
2150 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2151 After visiting a file, if REGEXP matches the text at the beginning of the
2152 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2153 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2154 major mode.
2156 If FUNCTION is nil, then it is not called. (That is a way of saying
2164 "Select major mode appropriate for current buffer.
2166 This checks for a -*- mode tag in the buffer's text, checks the
2167 interpreter that runs this file against `interpreter-mode-alist',
2168 compares the buffer beginning against `magic-mode-alist', or
2169 compares the filename against the entries in `auto-mode-alist'.
2171 It does not check for the `mode:' local variable in the
2172 Local Variables section of the file; for that, use `hack-local-variables'.
2174 If `enable-local-variables' is nil, this function does not check for a
2175 -*- mode tag.
2177 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2178 only set the major mode, if that would change it."
2179 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2181 ;; Find a -*- mode tag
2188 ;; Find all specifications for the `mode:' variable
2189 ;; and execute them left to right.
2201 modes)))
2202 ;; Simple -*-MODE-*- case.
2205 modes))))
2206 ;; If we found modes to use, invoke them now, outside the save-excursion.
2214 ;; continuing would call minor modes again, toggling them off
2217 ;; If we didn't, look for an interpreter specified in the first line.
2218 ;; As a special case, allow for things like "#!/bin/env perl", which
2219 ;; finds the interpreter anywhere in $PATH.
2225 ;; Map interpreter name to a mode, signalling we're done at the
2226 ;; same time.
2228 interpreter-mode-alist))
2229 ;; If we found an interpreter mode to use, invoke it now.
2232 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2246 ;; Compare the filename against the entries in auto-mode-alist.
2249 ;; Remove backup-suffixes from file name.
2252 ;; Find first matching alist entry.
2255 ;; System is case-insensitive.
2259 ;; System is case-sensitive.
2261 ;; First match case-sensitively.
2265 ;; Fallback to case-insensitive match.
2279 ;; When `keep-mode-if-same' is set, we are working on behalf of
2280 ;; set-visited-file-name. In that case, if the major mode specified is the
2281 ;; same one we already have, don't actually reset it. We don't want to lose
2282 ;; minor modes such as Font Lock.
2284 "Apply MODE and return it.
2285 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2286 any aliases and compared to current major mode. If they are the
2287 same, do nothing and return nil."
2295 mode))
2298 "Find the -*- spec in the buffer.
2299 Call with point at the place to start searching from.
2300 If one is found, set point to the beginning
2301 and return the position of the end.
2302 Otherwise, return nil; point may be changed."
2305 ;; Don't look for -*- if this file name matches any
2306 ;; of the regexps in inhibit-first-line-modes-regexps.
2314 sufs)
2322 ;; If the file begins with "#!"
2323 ;; (exec interpreter magic), look
2324 ;; for mode frobs in the first two
2325 ;; lines. You cannot necessarily
2326 ;; put them in the first line of
2327 ;; such a file without screwing up
2328 ;; the interpreter invocation.
2339 end))))
2340 \f
2341 ;;; Handling file local variables
2348 "Normal hook run after processing a file's local variables specs.
2349 Major modes can use this to examine user-specified local variables
2353 "List variable-value pairs that are considered safe.
2354 Each element is a cons cell (VAR . VAL), where VAR is a variable
2355 symbol and VAL is a value that is considered safe."
2360 "Expressions that are considered safe in an `eval:' local variable.
2361 Add expressions to this list if you want Emacs to evaluate them, when
2362 they appear in an `eval' local variable specification, without first
2363 asking you for confirmation."
2368 ;; Risky local variables:
2371 auto-mode-alist
2372 buffer-auto-save-file-name
2373 buffer-file-name
2374 buffer-file-truename
2375 buffer-undo-list
2376 dabbrev-case-fold-search
2377 dabbrev-case-replace
2378 debugger
2379 default-text-properties
2380 display-time-string
2381 enable-local-eval
2382 enable-local-variables
2383 eval
2384 exec-directory
2385 exec-path
2386 file-name-handler-alist
2387 font-lock-defaults
2388 format-alist
2389 frame-title-format
2390 global-mode-string
2391 header-line-format
2392 icon-title-format
2393 ignored-local-variables
2394 imenu--index-alist
2395 imenu-generic-expression
2396 inhibit-quit
2397 input-method-alist
2398 load-path
2399 max-lisp-eval-depth
2400 max-specpdl-size
2401 minor-mode-alist
2402 minor-mode-map-alist
2403 minor-mode-overriding-map-alist
2404 mode-line-buffer-identification
2405 mode-line-format
2406 mode-line-modes
2407 mode-line-modified
2408 mode-line-mule-info
2409 mode-line-position
2410 mode-line-process
2411 mode-name
2412 outline-level
2413 overriding-local-map
2414 overriding-terminal-local-map
2415 parse-time-rules
2416 process-environment
2417 rmail-output-file-alist
2418 safe-local-variable-values
2419 safe-local-eval-forms
2420 save-some-buffers-action-alist
2421 special-display-buffer-names
2422 standard-input
2423 standard-output
2424 unread-command-events
2425 vc-mode))
2427 ;; Safe local variables:
2428 ;;
2429 ;; For variables defined by major modes, the safety declarations can go into
2430 ;; the major mode's file, since that will be loaded before file variables are
2431 ;; processed.
2432 ;;
2433 ;; For variables defined by minor modes, put the safety declarations in the
2434 ;; file defining the minor mode after the defcustom/defvar using an autoload
2435 ;; cookie, e.g.:
2436 ;;
2437 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2438 ;;
2439 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2440 ;; minor mode file may not be loaded yet.
2441 ;;
2442 ;; For variables defined in the C source code the declaration should go here:
2458 nil
2463 prompt char)
2473 ", and variables that are risky (**)."
2480 y -- to apply the local variables list.
2484 ! -- to apply the local variables list, and permanently mark these
2496 ;; Make strings with embedded whitespace easier to read.
2504 ""
2510 done)
2524 ;; When this is called from desktop-restore-file-buffer,
2525 ;; coding-system-for-read may be non-nil. Reset it before
2526 ;; writing to .emacs.
2530 'safe-local-variable-values
2531 safe-local-variable-values))))
2538 "Return local variables specified in the -*- line.
2539 Ignore any specification for `mode:' and `coding:';
2540 `set-auto-mode' should already have handled `mode:',
2541 `set-auto-coding' should already have handled `coding:'.
2543 If MODE-ONLY is non-nil, all we do is check whether the major
2544 mode is specified, returning t if it is specified. Otherwise,
2545 return an alist of elements (VAR . VAL), where VAR is a variable
2546 and VAL is the specified value."
2550 result mode-specified)
2551 ;; Parse the -*- line into the RESULT alist.
2552 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2554 nil)
2556 ;; Simple form: "-*- MODENAME -*-". Already handled.
2558 nil)
2560 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2561 ;; (last ";" is optional).
2566 ;; There used to be a downcase here,
2567 ;; but the manual didn't say so,
2568 ;; and people want to set var names that aren't all lc.
2573 ;; It is traditional to ignore
2574 ;; case when checking for `mode' in set-auto-mode,
2575 ;; so we must do that here as well.
2576 ;; That is inconsistent, but we're stuck with it.
2577 ;; The same can be said for `coding' in set-auto-coding.
2583 'eval
2590 mode-specified
2591 result))))
2594 "Parse and put into effect this buffer's local variables spec.
2595 If MODE-ONLY is non-nil, all we do is check whether the major mode
2596 is specified, returning t if it is specified."
2599 result)
2602 ;; Look for "Local variables:" line in last page.
2610 ;; suffix is what comes after "local variables:" in its line.
2611 ;; prefix is what comes before "local variables:" in its line.
2621 beg)
2625 endpos
2631 nil t))
2641 ;; Discard the prefix.
2646 ;; Discard the suffix.
2654 ;; Find the variable name; strip whitespace.
2662 val)
2663 ;; Read the variable value.
2673 'eval
2679 ;; We've read all the local variables. Now, return whether the
2680 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2681 ;; variables (if MODE-ONLY is nil.)
2683 result
2690 ;; Find those variables that we may want to save to
2691 ;; `safe-local-variable-values'.
2706 ;; If caller wants only the safe variables,
2707 ;; install only them.
2712 ;; Query, except in the case where all are known safe
2713 ;; if the user wants no quuery in that case.
2719 result unsafe-vars risky-vars))
2725 "Non-nil if SYM is safe as a file-local variable with value VAL.
2726 It is safe if any of these conditions are met:
2728 * There is a matching entry (SYM . VAL) in the
2729 `safe-local-variable-values' user option.
2731 * The `safe-local-variable' property of SYM is a function that
2732 evaluates to a non-nil value with VAL as an argument."
2738 "Non-nil if SYM could be dangerous as a file-local variable.
2739 It is dangerous if either of these conditions are met:
2741 * Its `risky-local-variable' property is non-nil.
2747 ;; If this is an alias, check the base name.
2767 "Return t if it is safe to eval EXP when it is found in a file."
2769 ;; Detect certain `put' expressions.
2775 ;; Only allow safe values of lisp-indent-hook;
2776 ;; not functions.
2779 ;; Only allow indirect form specs.
2780 ;; During bootstrapping, edebug-basic-spec might not be
2781 ;; defined yet.
2784 ;; Allow expressions that the user requested.
2786 ;; Certain functions can be allowed with safe arguments
2787 ;; or can specify verification functions to try.
2795 ok))
2803 ok)))))))
2806 "Set local variable VAR with value VAL."
2812 ;; Make sure the string has no text properties.
2813 ;; Some text properties can get evaluated in various ways,
2814 ;; so it is risky to put them on with a local variable list.
2819 \f
2822 However, the mode will not be changed if
2823 \(1) a local variables list or the `-*-' line specifies a major mode, or
2825 \ not suitable for ordinary files, or
2826 \(3) the new file name does not particularly specify any mode."
2831 "Change name of file visited in current buffer to FILENAME.
2832 This also renames the buffer to correspond to the new file.
2833 The next time the buffer is saved it will go in the newly specified file.
2834 FILENAME nil or an empty string means mark buffer as not visiting any file.
2835 Remember to delete the initial contents of the minibuffer
2836 if you wish to pass an empty string as the argument.
2838 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2839 confirmation in the case where another buffer is already visiting FILENAME.
2841 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2842 the old visited file has been renamed to the new name FILENAME."
2850 nil
2865 filename)))
2877 ;; If new-name == old-name, renaming would add a spurious <2>
2878 ;; and it's considered as a feature in rename-buffer.
2884 ;; Abbreviate the file names of the buffer.
2893 nil)))
2894 ;; write-file-functions is normally used for things like ftp-find-file
2895 ;; that visit things that are not local files as if they were files.
2896 ;; Changing to visit an ordinary local file instead should flush the hook.
2901 ;; If buffer was read-only because of version control,
2902 ;; that reason is gone now, so make it writable.
2906 ;; Turn off backup files for certain file names.
2907 ;; Since this is a permanent local, the major mode won't eliminate it.
2909 backup-enable-predicate
2915 ;; If auto-save was not already on, turn it on if appropriate.
2919 ;; If auto save is on, start using a new name.
2920 ;; We deliberately don't rename or delete the old auto save
2921 ;; for the old visited file name. This is because perhaps
2922 ;; the user wants to save the new state and then compare with the
2923 ;; previous state from the auto save file.
2926 ;; Rename the old auto save file if any.
2933 ;; Update the major mode, if the file name determines it.
2935 ;; Don't change the mode if it is special.
2938 ;; Don't change the mode if the local variable list specifies it.
2944 "Write current buffer into file FILENAME.
2945 This makes the buffer visit that file, and marks it as not modified.
2947 If you specify just a directory name as FILENAME, that means to use
2948 the default file name but in that directory. You can also yank
2949 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2951 If the buffer is not already visiting a file, the default file name
2952 for the output file is the buffer name.
2954 If optional second arg CONFIRM is non-nil, this function
2955 asks for confirmation before overwriting an existing file.
2956 Interactively, confirmation is required unless you supply a prefix argument."
2957 ;; (interactive "FWrite file: ")
2961 nil nil nil nil)
2965 default-directory)
2966 nil nil))
2970 ;; If arg is just a directory,
2971 ;; use the default file name, but in that directory.
2982 ;; Make buffer writable if file is writable.
2987 ;; It's likely that the VC status at the new location is different from
2988 ;; the one at the old location.
2990 \f
2992 "Make a backup of the disk file visited by the current buffer, if appropriate.
2993 This is normally done before saving the buffer the first time.
2995 A backup may be done by renaming or by copying; see documentation of
2996 variable `make-backup-files'. If it's done by renaming, then the file is
2997 no longer accessible under its old name.
2999 The value is non-nil after a backup was made by renaming.
3000 It has the form (MODES . BACKUPNAME).
3001 MODES is the result of `file-modes' on the original
3002 file; this means that the caller, after saving the buffer, should change
3003 the modes of the new file to agree with the old modes.
3004 BACKUPNAME is the backup file name, which is the old file renamed."
3011 backup-info backupname targets setmodes)
3012 ;; If specified name is a symbolic link, chase it to the target.
3013 ;; Thus we make the backups in the directory where the real file is.
3018 ;; (if (file-directory-p buffer-file-name)
3019 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3023 ;; If have old versions to maybe delete,
3024 ;; ask the user to confirm now, before doing anything.
3025 ;; But don't actually delete til later.
3030 real-file-name)))))
3032 ;; Actually write the back up file.
3035 ; (file-symlink-p buffer-file-name)
3036 backup-by-copying
3037 ;; Don't rename a suid or sgid file.
3052 ;; rename-file should delete old backup.
3056 ;; If trouble writing the backup, write it in ~.
3061 backupname)
3065 ;; Now delete the old versions, if desired.
3072 setmodes)
3079 ;; Create temp files with strict access rights. It's easy to
3080 ;; loosen them later, whereas it's impossible to close the
3081 ;; time-window of loose permissions otherwise.
3089 nil)
3091 ;; The file was somehow created by someone else between
3092 ;; `delete-file' and `copy-file', so let's try again.
3093 nil))
3094 ;; Reset the umask.
3100 "Return file NAME sans backup versions or strings.
3101 This is a separate procedure so your site-init or startup file can
3102 redefine it.
3103 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3104 we do not remove backup version numbers, only true file version numbers."
3110 ;; VMS version number is (a) semicolon, optional
3111 ;; sign, zero or more digits or (b) period, option
3112 ;; sign, zero or more digits, provided this is the
3113 ;; second period encountered outside of the
3114 ;; device/directory part of the file name.
3117 name)
3127 "Return t if deleting FILE and rewriting it would preserve the owner."
3132 ;; Return t if the file doesn't exist, since it's true that no
3133 ;; information would be lost by an (attempted) delete and create.
3139 The extension, in a file name, is the part that follows the last `.',
3140 except that a leading `.', if any, doesn't count."
3143 directory)
3147 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3148 ;; we don't want to expand it.
3151 filename))))
3155 The extension, in a file name, is the part that follows the last `.',
3156 excluding version numbers and backup suffixes,
3157 except that a leading `.', if any, doesn't count.
3158 Return nil for extensionless file names such as `foo'.
3159 Return the empty string for file names such as `foo.'.
3161 If PERIOD is non-nil, then the returned value includes the period
3162 that delimits the extension, and if FILENAME has no extension,
3173 "A function to use instead of the default `make-backup-file-name'.
3174 A value of nil gives the default `make-backup-file-name' behavior.
3176 This could be buffer-local to do something special for specific
3177 files. If you define it, you may need to change `backup-file-name-p'
3178 and `file-name-sans-versions' too.
3180 See also `backup-directory-alist'."
3186 "Alist of filename patterns and backup directory names.
3187 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3188 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3189 relative or absolute. If it is absolute, so that all matching files
3190 are backed up into the same directory, the file names in this
3191 directory will be the full name of the file backed up with all
3192 directory separators changed to `!' to prevent clashes. This will not
3193 work correctly if your filesystem truncates the resulting name.
3195 For the common case of all backups going into one directory, the alist
3197 directory name.
3199 If this variable is nil, or it fails to match a filename, the backup
3200 is made in the original file's directory.
3202 On MS-DOS filesystems without long names this variable is always
3203 ignored."
3209 "Default `backup-enable-predicate' function.
3210 Checks for files in `temporary-file-directory',
3211 `small-temporary-file-directory', and /tmp."
3214 ;; Directory is under temporary-file-directory.
3219 ;; Directory is under /tmp.
3224 0 nil
3226 ;; Directory is under small-temporary-file-directory.
3231 "Create the non-numeric backup file name for FILE.
3232 Normally this will just be the file's name with `~' appended.
3233 Customization hooks are provided as follows.
3235 If the variable `make-backup-file-name-function' is non-nil, its value
3236 should be a function which will be called with FILE as its argument;
3237 the resulting name is used.
3239 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3240 the documentation of that variable. If the directory for the backup
3241 doesn't exist, it is created."
3255 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3257 elt backup-directory abs-backup-directory)
3262 alist nil)))
3263 ;; If backup-directory is relative, it should be relative to the
3264 ;; file's directory. By expanding explicitly here, we avoid
3265 ;; depending on default-directory.
3274 abs-backup-directory nil))))
3276 file
3280 ;; Normalize DOSish file names: downcase the drive
3281 ;; letter, if any, and replace the leading "x:" with
3282 ;; "/drive_x".
3285 ;; Replace any invalid file-name characters (for the
3286 ;; case of backing up remote files).
3290 "drive_"
3293 ""
3296 ;; Make the name unique by substituting directory
3297 ;; separators. It may not really be worth bothering about
3298 ;; doubling `!'s in the original name...
3303 backup-directory))
3308 "Return non-nil if FILE is a backup file name (numeric or not).
3309 This is a separate function so you can redefine it for customization.
3310 You may need to redefine `file-name-sans-versions' as well."
3315 ;; This is used in various files.
3316 ;; The usage of backup-extract-version-start is not very clean,
3317 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3319 "Given the name of a numeric backup file, FN, return the backup number.
3320 Uses the free variable `backup-extract-version-start', whose value should be
3321 the index in the name where the version number begins."
3327 ;; I believe there is no need to alter this behavior for VMS;
3328 ;; since backup files are not made on VMS, it should not get called.
3330 "Find a file name for a backup file FN, and suggestions for deletions.
3331 Value is a list whose car is the name for the backup file
3332 and whose cdr is a list of old versions to consider deleting now.
3333 If the value is nil, don't make a backup.
3334 Uses `backup-directory-alist' in the same way as does
3335 `make-backup-file-name'."
3337 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3341 ;; We don't support numbered backups on plain MS-DOS
3342 ;; when long file names are unavailable.
3352 possibilities deserve-versions-p versions)
3355 base-versions
3358 possibilities)
3359 #'<)
3364 kept-old-versions
3365 kept-new-versions
3372 ;; Delete nothing if there is overflow
3373 ;; in the number of versions to keep.
3379 v))))))))))
3382 "Return number of names file FILENAME has."
3385 ;; (defun file-relative-name (filename &optional directory)
3386 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3387 ;; This function returns a relative file name which is equivalent to FILENAME
3388 ;; when used with that default directory as the default.
3389 ;; If this is impossible (which can happen on MSDOS and Windows
3390 ;; when the file name and directory use different drive names)
3391 ;; then it returns FILENAME."
3392 ;; (save-match-data
3393 ;; (let ((fname (expand-file-name filename)))
3394 ;; (setq directory (file-name-as-directory
3395 ;; (expand-file-name (or directory default-directory))))
3396 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3397 ;; ;; drive names, they can't be relative, so return the absolute name.
3398 ;; (if (and (or (eq system-type 'ms-dos)
3399 ;; (eq system-type 'cygwin)
3400 ;; (eq system-type 'windows-nt))
3401 ;; (not (string-equal (substring fname 0 2)
3402 ;; (substring directory 0 2))))
3403 ;; filename
3404 ;; (let ((ancestor ".")
3405 ;; (fname-dir (file-name-as-directory fname)))
3406 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3407 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3408 ;; (setq directory (file-name-directory (substring directory 0 -1))
3409 ;; ancestor (if (equal ancestor ".")
3410 ;; ".."
3411 ;; (concat "../" ancestor))))
3412 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3413 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3414 ;; ;; We matched within FNAME's directory part.
3415 ;; ;; Add the rest of FNAME onto ANCESTOR.
3416 ;; (let ((rest (substring fname (match-end 0))))
3417 ;; (if (and (equal ancestor ".")
3418 ;; (not (equal rest "")))
3419 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3420 ;; rest
3421 ;; (concat (file-name-as-directory ancestor) rest)))
3422 ;; ;; We matched FNAME's directory equivalent.
3423 ;; ancestor))))))
3426 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3427 This function returns a relative file name which is equivalent to FILENAME
3428 when used with that default directory as the default.
3429 If FILENAME and DIRECTORY lie on different machines or on different drives
3430 on a DOS/Windows machine, it returns FILENAME in expanded form."
3434 default-directory))))
3440 ;; Test for different drives on DOS/Windows
3442 ;; Should `cygwin' really be included here? --stef
3445 ;; Test for different remote file system identification
3447 filename
3453 directory nil nil case-fold-search))
3455 directory nil nil case-fold-search))))
3458 ".."
3460 ;; Now ancestor is empty, or .., or ../.., etc.
3462 directory nil nil case-fold-search))
3463 ;; We matched within FILENAME's directory part.
3464 ;; Add the rest of FILENAME onto ANCESTOR.
3467 ;; But don't bother with ANCESTOR if it would give us `./'.
3468 rest
3470 ;; We matched FILENAME's directory equivalent.
3471 ancestor))))))
3472 \f
3474 "Save current buffer in visited file if modified.
3475 Variations are described below.
3477 By default, makes the previous version into a backup file
3478 if previously requested or if this is the first save.
3480 to become a backup when the next save is done.
3482 unconditionally makes the previous version into a backup file.
3484 to become a backup when the next save is done,
3485 and unconditionally makes the previous version into a backup file.
3487 With a numeric argument of 0, never make the previous version
3488 into a backup file.
3490 If a file's name is FOO, the names of its numbered backup versions are
3491 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3492 Numeric backups (rather than FOO~) will be made if value of
3493 `version-control' is not the atom `never' and either there are already
3494 numeric versions of the file being backed up, or `version-control' is
3495 non-nil.
3496 We don't want excessive versions piling up, so there are variables
3497 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3498 and `kept-new-versions', which tells how many newest versions to keep.
3499 Defaults are 2 old versions and 2 new.
3500 `dired-kept-versions' controls dired's clean-directory (.) command.
3501 If `delete-old-versions' is nil, system will query user
3502 before trimming versions. Otherwise it does it silently.
3504 If `vc-make-backup-files' is nil, which is the default,
3505 no backup files are made for files managed by version control.
3506 (This is because the version control system itself records previous versions.)
3508 See the subroutine `basic-save-buffer' for more information."
3521 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3522 Normally delete only if the file was written by this Emacs since
3523 the last real save, but optional arg FORCE non-nil means delete anyway."
3537 "Normal hook that is run before a buffer is saved to its file."
3543 "Normal hook that is run after a buffer is saved to its file."
3549 "If non-nil, use this coding system for saving the buffer.
3550 More precisely, use this coding system in place of the
3551 value of `buffer-file-coding-system', when saving the buffer.
3552 Calling `write-region' for any purpose other than saving the buffer
3553 will still use `buffer-file-coding-system'; this variable has no effect
3560 "Save the current buffer in its visited file, if it has been modified.
3561 The hooks `write-contents-functions' and `write-file-functions' get a chance
3562 to do the job of saving; if they do not, then the buffer is saved in
3563 the visited file in the usual way.
3564 Before and after saving the buffer, this function runs
3565 `before-save-hook' and `after-save-hook', respectively."
3568 ;; In an indirect buffer, save its base buffer instead.
3573 setmodes)
3574 ;; On VMS, rename file and buffer to get rid of version number.
3579 ;; Strip VMS version number before save.
3582 ;; Construct a (unique) buffer name to correspond.
3587 ;; If buffer has no file name, ask user for one.
3594 filename))
3620 ;; Support VC version backups.
3626 ;; If a hook returned t, file is already "written".
3627 ;; Otherwise, write it the usual way now.
3629 ;; Now we have saved the current buffer. Let's make sure
3630 ;; that buffer-file-coding-system is fixed to what
3631 ;; actually used for saving by binding it locally.
3641 ;; If the auto-save file was recent before this command,
3642 ;; delete it now.
3644 ;; Support VC `implicit' locking.
3649 ;; This does the "real job" of writing a buffer into its visited file
3650 ;; and making a backup file. This is what is normally done
3651 ;; but inhibited if one of write-file-functions returns non-nil.
3652 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3661 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3675 buffer-file-name)))
3683 ;; If file is precious, write temp name, then rename it.
3684 ;; This requires write access to the containing dir,
3685 ;; which is why we don't try it if we don't have that access.
3687 tempname succeed
3690 ;; Create temp files with strict access rights. It's easy to
3691 ;; loosen them later, whereas it's impossible to close the
3692 ;; time-window of loose permissions otherwise.
3697 ;; Try various temporary names.
3698 ;; This code follows the example of make-temp-file,
3699 ;; but it calls write-region in the appropriate way
3700 ;; for saving the buffer.
3707 tempname nil realname
3709 nil)
3711 ;; The file was somehow created by someone else between
3712 ;; `make-temp-name' and `write-region', let's try again.
3713 nil)
3715 ;; Reset the umask.
3717 ;; If we failed, restore the buffer's modtime.
3720 ;; Since we have created an entirely new file,
3721 ;; make sure it gets the right permission bits set.
3725 buffer-file-name)))
3726 ;; We succeeded in writing the temp file,
3727 ;; so rename it.
3729 ;; If file not writable, see if we can make it writable
3730 ;; temporarily while we write it.
3731 ;; But no need to do so if we have just backed it up
3732 ;; (setmodes is set) because that says we're superseding.
3734 ;; Change the mode back, after writing.
3741 buffer-file-name nil t buffer-file-truename)
3743 ;; If we get an error writing the new file, and we made
3744 ;; the backup by renaming, undo the backing-up.
3749 setmodes))
3752 "View the differences between BUFFER and its associated file.
3753 This requires the external program `diff' to be in your `exec-path'."
3768 ;; Display that message for 1 second so that user can read it
3769 ;; in the minibuffer.
3771 ;; return always nil, so that save-buffers-kill-emacs will not move
3772 ;; over to the next unsaved buffer when calling `d'.
3773 nil)
3776 '((?\C-r
3782 ;; Return nil to ask about BUF again.
3783 nil)
3791 nil)
3800 "Save some modified file-visiting buffers. Asks user about each one.
3801 You can answer `y' to save, `n' not to save, `C-r' to look at the
3802 buffer in question with `view-buffer' before deciding or `d' to
3803 view the differences using `diff-buffer-with-file'.
3805 Optional argument (the prefix) non-nil means save all with no questions.
3806 Optional second argument PRED determines which buffers are considered:
3807 If PRED is nil, all the file-visiting buffers are considered.
3808 If PRED is t, then certain non-file buffers will also be considered.
3809 If PRED is a zero-argument function, it indicates for each buffer whether
3810 to consider it or not when called with that buffer current.
3812 See `save-some-buffers-action-alist' if you want to
3813 change the additional actions you can take on files."
3817 files-done abbrevs-done)
3819 ;; First save any buffers that we're supposed to save unconditionally.
3820 ;; That way the following code won't ask about them.
3825 ;; Ask about those buffers that merit it,
3826 ;; and record the number thus saved.
3842 t
3855 save-some-buffers-action-alist))
3856 ;; Maybe to save abbrevs, and record whether
3857 ;; we either saved them or asked to.
3863 abbrev-file-name)))
3865 ;; Don't keep bothering user if he says no.
3870 "(Some special files were saved without asking)"
3872 \f
3874 "Mark current buffer as unmodified, not needing to be saved.
3877 It is not a good idea to use this function in Lisp programs, because it
3878 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3885 "Change whether this buffer is visiting its file read-only.
3886 With arg, set read-only iff arg is positive.
3887 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3892 nil ; do nothing.
3893 ;; Toggle.
3900 ;; If view-mode is already active, `view-mode-enter' is a nop.
3912 "Insert contents of file FILENAME into buffer after point.
3913 Set mark after the inserted text.
3915 This function is meant for the user to run interactively.
3916 Don't call it from programs! Use `insert-file-contents' instead.
3917 \(Its calling sequence is different; see its documentation)."
3922 "Append the contents of the region to the end of file FILENAME.
3923 When called from a function, expects three arguments,
3924 START, END and FILENAME. START and END are buffer positions
3925 saying what text to write."
3930 "Return most recent backup file for FILENAME or nil if no backups exist."
3931 ;; `make-backup-file-name' will get us the right directory for
3932 ;; ordinary or numeric backups. It might create a directory for
3933 ;; backups as a side-effect, according to `backup-directory-alist'.
3940 tem)
3949 newest))
3952 "Rename current buffer to a similar name not already taken.
3953 This function is useful for creating multiple shell process buffers
3954 or multiple mail buffers, etc."
3962 ;; If the existing buffer name has a <NNN>,
3963 ;; which isn't part of the file name (if any),
3964 ;; then get rid of that.
3970 "Create the directory DIR and any nonexistent parent dirs.
3971 Interactively, the default choice of directory to create
3972 is the current default directory for file names.
3973 That is useful when you have visited a file in a nonexistent directory.
3975 Noninteractively, the second (optional) argument PARENTS says whether
3976 to create parent directories if they don't exist. Interactively,
3977 this happens by default."
3980 nil nil)
3981 t))
3982 ;; If default-directory is a remote directory,
3983 ;; make sure we find its make-directory handler.
3991 create-list)
3998 \f
4001 "Function to use to revert this buffer, or nil to do the default.
4002 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4007 "Function to use to insert contents when reverting this buffer.
4008 Gets two args, first the nominal file name to use,
4009 and second, t if reading the auto-save file.
4014 "Function to check whether a non-file buffer needs reverting.
4015 This should be a function with one optional argument NOCONFIRM.
4016 Auto Revert Mode passes t for NOCONFIRM. The function should return
4017 non-nil if the buffer should be reverted. A return value of
4018 `fast' means that the need for reverting was not checked, but
4019 that reverting the buffer is fast. The buffer is current when
4020 this function is called.
4022 The idea behind the NOCONFIRM argument is that it should be
4023 non-nil if the buffer is going to be reverted without asking the
4024 user. In such situations, one has to be careful with potentially
4025 time consuming operations.
4027 For more information on how this variable is used by Auto Revert mode,
4031 "Normal hook for `revert-buffer' to run before reverting.
4032 If `revert-buffer-function' is used to override the normal revert
4036 "Normal hook for `revert-buffer' to run after reverting.
4037 Note that the hook value that it runs is the value that was in effect
4038 before reverting; that makes a difference if you have buffer-local
4039 hook functions.
4041 If `revert-buffer-function' is used to override the normal revert
4047 "Replace current buffer text with the text of the visited file on disk.
4048 This undoes all changes since the file was visited or saved.
4049 With a prefix argument, offer to revert from latest auto-save file, if
4050 that is more recent than the visited file.
4052 This command also works for special buffers that contain text which
4053 doesn't come from a file, but reflects some other data base instead:
4054 for example, Dired buffers and `buffer-list' buffers. In these cases,
4055 it reconstructs the buffer contents from the appropriate data base.
4057 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4058 to revert from the auto-save file when this is nil. Note that the
4059 sense of this argument is the reverse of the prefix argument, for the
4060 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4061 to nil.
4063 Optional second argument NOCONFIRM means don't ask for confirmation at
4064 all. \(The variable `revert-without-query' offers another way to
4065 revert buffers without querying for confirmation.)
4067 Optional third argument PRESERVE-MODES non-nil means don't alter
4068 the files modes. Normally we reinitialize them using `normal-mode'.
4070 If the value of `revert-buffer-function' is non-nil, it is called to
4071 do all the work for this command. Otherwise, the hooks
4072 `before-revert-hook' and `after-revert-hook' are run at the beginning
4073 and the end, and if `revert-buffer-insert-file-contents-function' is
4074 non-nil, it is called instead of rereading visited file contents."
4076 ;; I admit it's odd to reverse the sense of the prefix argument, but
4077 ;; there is a lot of code out there which assumes that the first
4078 ;; argument should be t to avoid consulting the auto-save file, and
4079 ;; there's no straightforward way to encourage authors to notice a
4080 ;; reversal of the argument sense. So I'm just changing the user
4081 ;; interface, but leaving the programmatic interface the same.
4089 buffer-auto-save-file-name
4094 buffer-auto-save-file-name
4095 buffer-file-name)))
4105 file-name)))
4107 ;; If file was backed up but has changed since,
4108 ;; we shd make another backup.
4112 ;; Effectively copy the after-revert-hook status,
4113 ;; since after-find-file will clobber it.
4116 after-revert-hook))
4121 ;; Get rid of all undo records for this buffer.
4123 ;; Don't make undo records for the reversion.
4126 file-name auto-save-p)))
4129 "File %s no longer exists!"
4131 file-name))
4134 "File %s no longer readable!"
4136 file-name))
4138 ;; Bind buffer-file-name to nil
4139 ;; so that we don't try to lock the file.
4145 ;; Auto-saved file should be read by Emacs'
4146 ;; internal coding.
4149 buffer-file-coding-system-explicit))))
4151 coding-system-for-read
4153 coding-system-for-read)
4155 ;; As a coding system suitable for multibyte
4156 ;; buffer is specified, make the current
4157 ;; buffer multibyte.
4160 ;; This force after-insert-file-set-coding
4161 ;; (called from insert-file-contents) to set
4162 ;; buffer-file-coding-system to a proper value.
4165 ;; Note that this preserves point in an intelligent way.
4169 nil nil t))
4171 nil nil t)))))
4172 ;; Recompute the truename in case changes in symlinks
4173 ;; have changed the truename.
4177 ;; Run after-revert-hook as it was before we reverted.
4181 local-hook)
4184 t))))))
4187 "Recover the visited file--get contents from its last auto-save file."
4192 "Visit file FILE, but get contents from its last auto-save file."
4193 ;; Actually putting the file name in the minibuffer should be used
4194 ;; only rarely.
4195 ;; Not just because users often use the default.
4215 ;; Use insert-directory-safely, not insert-directory,
4216 ;; because these files might not exist. In particular,
4217 ;; FILE might not exist if the auto-save file was for
4218 ;; a buffer that didn't visit a file, such as "*mail*".
4219 ;; The code in v20.x called `ls' directly, so we need
4220 ;; to emulate what `ls' did in that case.
4226 ;; Keep the current buffer-file-coding-system.
4228 ;; Auto-saved file should be read with special coding.
4237 "Recover auto save files from a previous Emacs session.
4238 This command first displays a Dired buffer showing you the
4239 previous sessions that you could recover from.
4240 To choose one, move point to the proper line and then type C-c C-c.
4241 Then you'll be asked about a number of files to recover."
4251 auto-save-list-file-prefix)))
4252 t)
4261 ;; Each line starts with a space
4262 ;; so that Font Lock mode won't highlight the first character.
4271 "Choose one saved session to recover auto-save files from.
4272 This command is used in the special Dired buffer created by
4275 ;; Get the name of the session file to recover from.
4277 files
4283 ;; Read in the auto-save-list file.
4287 ;; Loop thru the text of that file
4288 ;; and get out the names of the files to recover.
4292 ;; This is a pair of lines for a non-file-visiting buffer.
4293 ;; Get the auto-save file name and manufacture
4294 ;; a "visited file name" from that.
4297 ;; If there is no auto-save file name, the
4298 ;; auto-save-list file is probably corrupted.
4311 ;; This pair of lines is a file-visiting
4312 ;; buffer. Use the visited file name.
4322 ;; Ignore a file if its auto-save file does not exist now.
4326 ;; The file contains a pair of line for each auto-saved buffer.
4327 ;; The first line of the pair contains the visited file name
4328 ;; or is empty if the buffer was not visiting a file.
4329 ;; The second line is the auto-save file name.
4337 files
4343 "Kill some buffers. Asks the user whether to kill each one of them.
4344 Non-interactively, if optional argument LIST is non-nil, it
4345 specifies the list of buffers to kill, asking for approval for each one."
4353 ; if we killed the base buffer.
4358 name
4363 \f
4365 "Toggle auto-saving of contents of current buffer.
4366 With prefix argument ARG, turn auto-saving on if positive, else off."
4371 ;; If auto-save is off because buffer has shrunk,
4372 ;; then toggling should turn it on.
4377 buffer-file-name
4379 ;; If -1 was stored here, to temporarily turn off saving,
4380 ;; turn it back on.
4386 buffer-auto-save-file-name)
4389 "Adjust current buffer's auto save file name for current conditions.
4390 Also rename any existing auto save file, if it was made in this session."
4402 "Return file name to use for auto-saves of current buffer.
4403 Does not consider `auto-save-visited-file-name' as that variable is checked
4404 before calling this function. You can redefine this for customization.
4405 See also `auto-save-file-name-p'."
4413 result uniq)
4414 ;; Apply user-specified translations
4415 ;; to the file name.
4419 filename)
4429 filename))))
4434 ;; We truncate the file name to DOS 8+3 limits
4435 ;; before doing anything else, because the regexp
4436 ;; passed to string-match below cannot handle
4437 ;; extensions longer than 3 characters, multiple
4438 ;; dots, and other atrocities.
4443 fn)
4448 "#"
4451 ;; Make sure auto-save file names don't contain characters
4452 ;; invalid for the underlying filesystem.
4454 ;; Don't modify remote (ange-ftp) filenames
4457 result))))
4459 ;; Deal with buffers that don't have any associated files. (Mail
4460 ;; mode tends to create a good number of these.)
4464 file-name)
4465 ;; Eliminate all slashes and backslashes by
4466 ;; replacing them with sequences that start with %.
4467 ;; Quote % also, to keep distinct names distinct.
4476 ;; Generate the file name.
4482 ;; Try a few alternative directories, to get one we can
4483 ;; write it.
4489 ;; Don't modify remote (ange-ftp) filenames
4491 ;; The call to convert-standard-filename is in case
4492 ;; buffer-name includes characters not allowed by the
4493 ;; DOS/Windows filesystems. make-temp-file writes to the
4494 ;; file it creates, so we must fix the file name _before_
4495 ;; make-temp-file is called.
4497 fname))
4499 ;; make-temp-file creates the file,
4500 ;; but we don't want it to exist until we do an auto-save.
4504 file-name)))
4507 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4508 FILENAME should lack slashes. You can redefine this for customization."
4510 \f
4512 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4513 The generated regexp will match a filename iff the filename
4514 matches that wildcard according to shell rules. Only wildcards known
4515 by `sh' are supported."
4517 ;; Copy the initial run of non-special characters.
4520 ;; If no special characters, we're almost done.
4524 j)
4526 result
4547 ;; Found "[^". Insert a `\0' character
4548 ;; (which cannot happen in a filename)
4549 ;; into the character class, so that `^'
4550 ;; is not the first character after `[',
4551 ;; and thus non-special in a regexp.
4556 ;; I don't think `]' can appear in a
4557 ;; character class in a wildcard, but
4558 ;; let's be general here.
4565 i
4578 ;; Shell wildcards should match the entire filename,
4579 ;; not its part. Make the regexp say so.
4581 \f
4584 "Switches for `list-directory' to pass to `ls' for brief listing."
4590 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4592 "Switches for `list-directory' to pass to `ls' for verbose listing."
4597 "Expand wildcard pattern PATTERN.
4598 This returns a list of file names which match the pattern.
4600 If PATTERN is written as an absolute file name,
4601 the values are absolute also.
4603 If PATTERN is written as a relative file name, it is interpreted
4604 relative to the current default directory, `default-directory'.
4605 The file names returned are normally also relative to the current
4606 default directory. However, if FULL is non-nil, they are absolute."
4610 ;; A list of all dirs that DIRPART specifies.
4611 ;; This can be more than one dir
4612 ;; if DIRPART contains wildcards.
4617 contents)
4622 ;; Filter out "." and ".."
4627 name))
4634 this-dir-contents)
4635 this-dir-contents)
4636 contents))))
4638 contents)))
4641 "Display a list of files in or matching DIRNAME, a la `ls'.
4642 DIRNAME is globbed by the shell if necessary.
4643 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4644 Actions controlled by variables `list-directory-brief-switches'
4645 and `list-directory-verbose-switches'."
4649 nil default-directory nil)
4650 pfx)))
4652 list-directory-brief-switches))
4653 buffer)
4666 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4674 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4676 PATTERN is assumed to represent a file-name wildcard suitable for the
4677 underlying filesystem. For Unix and GNU/Linux, the characters from the
4679 the parts of the pattern which don't include wildcard characters are
4680 quoted with double quotes.
4681 Existing quote characters in PATTERN are left alone, so you can pass
4682 PATTERN that already quotes some of the special characters."
4686 ;; DOS/Windows don't allow `"' in file names. So if the
4687 ;; argument has quotes, we can safely assume it is already
4688 ;; quoted by the caller.
4690 ;; We quote [&()#$'] in case their shell is a port of a
4691 ;; Unixy shell. We quote [,=+] because stock DOS and
4692 ;; Windows shells require that in some cases, such as
4693 ;; passing arguments to batch files that use positional
4694 ;; arguments like %1.
4696 pattern
4699 end)
4716 pattern))))
4723 "Program to get the amount of free space on a file system.
4724 We assume the output has the format of `df'.
4725 The value of this variable must be just a command name or file name;
4726 if you want to specify options, use `directory-free-space-args'.
4728 A value of nil disables this feature.
4730 If the function `file-system-info' is defined, it is always used in
4731 preference to the program given by this variable."
4737 "Options to use when running `directory-free-space-program'."
4742 "Return the amount of free space on directory DIR's file system.
4743 The result is a string that gives the number of free 1KB blocks,
4744 or nil if the system call or the program which retrieve the information
4745 fail.
4747 This function calls `file-system-info' if it is available, or invokes the
4748 program specified by `directory-free-space-program' if that is non-nil."
4749 ;; Try to find the number of free blocks. Non-Posix systems don't
4750 ;; always have df, but might have an equivalent system call.
4759 nil t nil
4760 directory-free-space-args
4761 dir)))
4762 ;; Usual format is a header line followed by a line of
4763 ;; numbers.
4768 ;; Move to the end of the "available blocks" number.
4771 ;; Copy it into AVAILABLE.
4776 ;; The following expression replaces `dired-move-to-filename-regexp'.
4780 ;; In some locales, month abbreviations are as short as 2 letters,
4781 ;; and they can be followed by ".".
4782 ;; In Breton, a month name can include a quote character.
4795 s "+"
4798 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4799 ;; omits the Kanji characters after month and day-of-month.
4800 ;; On Mac OS X 10.3, the date format in East Asian locales is
4801 ;; day-of-month digits followed by month digits.
4807 ;; The "[0-9]" below requires the previous column to end in a digit.
4808 ;; This avoids recognizing `1 may 1997' as a date in the line:
4809 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4811 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4812 ;; The ".*" below finds the last match if there are multiple matches.
4813 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4814 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4816 ;; vc dired listings provide the state or blanks between file
4817 ;; permissions and date. The state is always surrounded by
4818 ;; parantheses:
4819 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4820 ;; This is not supported yet.
4824 "Regular expression to match up to the file name in a directory listing.
4825 The default value is designed to recognize dates and times
4830 ;; insert-directory
4831 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4832 ;; FULL-DIRECTORY-P is nil.
4833 ;; The single line of output must display FILE's name as it was
4834 ;; given, namely, an absolute path name.
4835 ;; - must insert exactly one line for each file if WILDCARD or
4836 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4837 ;; before the file lines, plus optional text after the file lines.
4838 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4839 ;; allowed.
4840 ;; File lines should display the basename.
4841 ;; - must be consistent with
4842 ;; - functions dired-move-to-filename, (these two define what a file line is)
4843 ;; dired-move-to-end-of-filename,
4844 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4845 ;; dired-insert-headerline
4846 ;; dired-after-subdir-garbage (defines what a "total" line is)
4847 ;; - variable dired-subdir-regexp
4848 ;; - may be passed "--dired" as the first argument in SWITCHES.
4849 ;; Filename handlers might have to remove this switch if their
4850 ;; "ls" command does not support it.
4852 "Insert directory listing for FILE, formatted according to SWITCHES.
4853 Leaves point after the inserted text.
4854 SWITCHES may be a string of options, or a list of strings
4855 representing individual options.
4856 Optional third arg WILDCARD means treat FILE as shell wildcard.
4857 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4858 switches do not contain `d', so that a full listing is expected.
4860 This works by running a directory listing program
4861 whose name is in the variable `insert-directory-program'.
4862 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4864 When SWITCHES contains the long `--dired' option, this function
4865 treats it specially, for the sake of dired. However, the
4866 normally equivalent short `-D' option is just passed on to
4867 `insert-directory-program', as any other option."
4868 ;; We need the directory in order to find the right handler.
4873 wildcard full-directory-p)
4878 ;; Read the actual directory using `insert-directory-program'.
4879 ;; RESULT gets the status code.
4881 ;; putting text property `dired-filename, decode one
4882 ;; bunch by one to preserve that property.
4884 ;; This is to control encoding the arguments in call-process.
4888 default-file-name-coding-system))))
4891 ;; Run ls in the directory part of the file pattern
4892 ;; using the last component as argument.
4899 shell-file-name nil t nil
4900 "-c"
4902 ""
4904 insert-directory-program
4905 " -d "
4907 switches
4909 " -- "
4910 ;; Quote some characters that have
4911 ;; special meanings in shells; but
4912 ;; don't quote the wildcards--we want
4913 ;; them to be special. We also
4914 ;; currently don't quote the quoting
4915 ;; characters in case people want to
4916 ;; use them explicitly to quote
4917 ;; wildcard characters.
4919 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4920 ;; directory if FILE is a symbolic link.
4922 insert-directory-program nil t nil
4926 ;; Split the switches at any spaces so we can
4927 ;; pass separate options as separate args.
4929 ;; Avoid lossage if FILE starts with `-'.
4937 file))))))))
4939 ;; If we got "//DIRED//" in the output, it means we got a real
4940 ;; directory listing, even if `ls' returned nonzero.
4941 ;; So ignore any errors.
4954 ;; The first time ls returns an error,
4955 ;; find the version numbers of ls,
4956 ;; and set insert-directory-ls-version
4957 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4958 ;; is equal or if the info cannot be obtained.
4959 ;; (That can mean it isn't GNU ls.)
4969 comparison)
4985 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4989 ;; If `insert-directory-program' failed, signal an error.
4991 ;; Delete the error message it may have output.
4993 ;; On non-Posix systems, we cannot open a directory, so
4994 ;; don't even try, because that will always result in
4995 ;; the ubiquitous "Access denied". Instead, show the
4996 ;; command line so the user can try to guess what went wrong.
5001 insert-directory-program
5003 file result)
5004 ;; Unix. Access the file to get a suitable error.
5011 ;; The following overshoots by one line for an empty
5012 ;; directory listed with "--dired", but without "-a"
5013 ;; switch, where the ls output contains a
5014 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5015 ;; We take care of that case later.
5023 error-lines)
5024 ;; Find all the lines that are error messages,
5025 ;; and record the bounds of each one.
5032 ;; Now read the numeric positions of file names.
5039 error-lines))
5042 error-lines)))
5044 ;; End is followed by \n or by " -> ".
5046 ;; It seems that we can't trust ls's output as to
5047 ;; byte positions of filenames.
5053 ;; Take care of the case where the ls output contains a
5054 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5055 ;; and we went one line too far back (see above).
5060 ;; Now decode what read if necessary.
5062 file-name-coding-system
5063 default-file-name-coding-system
5065 coding-no-eol
5066 val pos)
5070 ;; If no coding system is specified or detection is
5071 ;; requested, detect the coding.
5085 ;; Force no eol conversion on a file name, so
5086 ;; that CR is preserved.
5094 ;; Try to insert the amount of free space.
5097 ;; First find the line to put it on.
5101 ;; Replace "total" with "used", to avoid confusion.
5107 "Convert `ls --dired' file name position value POS to a buffer position.
5108 File name position values returned in ls --dired output
5109 count only stdout; they don't count the error messages sent to stderr.
5110 So this function converts to them to real buffer positions.
5111 ERROR-LINES is a list of buffer positions of error message lines,
5112 of the form (START END)."
5116 pos)
5120 "Insert directory listing for FILE, formatted according to SWITCHES.
5122 Like `insert-directory', but if FILE does not exist, it inserts a
5123 message to that effect instead of signaling an error."
5126 ;; Simulate the message printed by `ls'.
5130 "Functions to call with no arguments to query about killing Emacs.
5131 If any of these functions returns nil, killing Emacs is cancelled.
5133 but `kill-emacs', the low level primitive, does not.
5137 "How to ask for confirmation when leaving Emacs.
5138 If nil, the default, don't ask at all. If the value is non-nil, it should
5139 be a predicate function such as `yes-or-no-p'."
5147 "Offer to save each buffer, then kill this Emacs process.
5148 With prefix arg, silently save all file-visiting buffers, then kill."
5157 ;; process-list is not defined on VMS.
5159 active)
5168 ;; Query the user for other things, perhaps.
5173 \f
5174 ;; We use /: as a prefix to "quote" a file name
5175 ;; so that magic file name handlers will not apply to it.
5179 file-name-handler-alist))
5181 ;; We depend on being the last handler on the list,
5182 ;; so that anything else which does need handling
5183 ;; has been handled already.
5184 ;; So it is safe for us to inhibit *all* magic file name handlers.
5193 default-directory))
5194 ;; Get a list of the indices of the args which are file names.
5197 ;; The first six are special because they
5198 ;; return a file name. We want to include the /:
5199 ;; in the return value.
5200 ;; So just avoid stripping it in the first place.
5207 ;; `identity' means just return the first arg
5208 ;; not stripped of its quoting.
5210 ;; `add' means add "/:" to the result.
5212 ;; `quote' means add "/:" to buffer-file-name.
5214 ;; `unquote-then-quote' means set buffer-file-name
5215 ;; temporarily to unquoted filename.
5217 ;; List the arguments which are filenames.
5225 ;; For all other operations, treat the first argument only
5226 ;; as the file name.
5228 method
5229 ;; Copy ARGUMENTS so we can replace elements in it.
5233 ;; Strip off the /: from the file names that have it.
5241 "/"
5257 res))
5260 \f
5285 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5286 ;;; files.el ends here