| blob | 6aff489e0a24839d33e24c6f677cbc2c02ae5e7e |
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, 2007 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 3, 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 FROM and TO should be equivalent names, which refer to the
63 same directory. Do not use `~' in the TO strings;
64 they should be ordinary absolute directory names.
66 Use this feature when you have directories which you normally refer to
67 via absolute symbolic links. Make TO the name of the link, and FROM
68 the name it is linked to."
76 ;; Turn off backup files on VMS since it has version numbers.
78 "Non-nil means make a backup of a file the first time it is saved.
79 This can be done by renaming the file or by copying.
81 Renaming means that Emacs renames the existing file so that it is a
82 backup file, then writes the buffer into a new file. Any other names
83 that the old file had will now refer to the backup file. The new file
84 is owned by you and its group is defaulted.
86 Copying means that Emacs copies the existing file into the backup
87 file, then writes the buffer on top of the existing file. Any other
88 names that the old file had will now refer to the new (edited) file.
89 The file's owner and group are unchanged.
91 The choice of renaming or copying is controlled by the variables
92 `backup-by-copying', `backup-by-copying-when-linked',
93 `backup-by-copying-when-mismatch' and
94 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
98 ;; Do this so that local variables based on the file name
99 ;; are not overridden by the major mode.
101 "Non-nil means don't make a backup, regardless of the other parameters.
102 This variable is intended for use by making it local to a buffer.
107 "Non-nil means always use copying to create backup files.
108 See documentation of variable `make-backup-files'."
113 "Non-nil means use copying to create backups for files with multiple names.
114 This causes the alternate names to refer to the latest version as edited.
115 This variable is relevant only if `backup-by-copying' is nil."
120 "Non-nil means create backups by copying if this preserves owner or group.
121 Renaming may still be used (subject to control of other variables)
122 when it would not result in changing the owner or group of the file;
123 that is, for files which are owned by you and whose group matches
124 the default for a new file created there by you.
125 This variable is relevant only if `backup-by-copying' is nil."
130 "Non-nil means create backups by copying to preserve a privileged owner.
131 Renaming may still be used (subject to control of other variables)
132 when it would not result in changing the owner of the file or if the owner
133 has a user id greater than the value of this variable. This is useful
134 when low-numbered uid's are used for special system users (such as root)
135 that must maintain ownership of certain files.
136 This variable is relevant only if `backup-by-copying' and
137 `backup-by-copying-when-mismatch' are nil."
142 "Predicate that looks at a file name and decides whether to make backups.
146 "Non-nil in a buffer means always offer to save buffer on exit.
147 Do so even if the buffer is not visiting a file.
148 Automatically local in all buffers."
154 "Non-nil means find a file under alternative names, in existing buffers.
155 This means if any existing buffer is visiting the file you want
156 under another name, you get the existing buffer instead of a new buffer."
161 "*Non-nil means visit a file under its truename.
162 The truename of a file is found by chasing all links
163 both at the file level and at the levels of the containing directories."
169 "Specify which files should be reverted without query.
170 The value is a list of regular expressions.
171 If the file name matches one of these regular expressions,
172 then `revert-buffer' reverts the file without querying
173 if the file has changed on disk and you have not edited the buffer."
178 "The device number and file number of the file visited in the current buffer.
179 The value is a list of the form (FILENUM DEVNUM).
180 This pair of numbers uniquely identifies the file.
200 "The directory for writing temporary files."
206 "The directory for writing small temporary files.
207 If non-nil, this directory is used instead of `temporary-file-directory'
208 by programs that create small temporary files. This is for systems that
209 have fast storage with limited space, such as a RAM disk."
213 ;; The system null device. (Should reference NULL_DEVICE from C.)
230 "Non-nil means protect against I/O errors while saving files.
231 Some modes set this non-nil in particular buffers.
233 This feature works by writing the new contents into a temporary file
234 and then renaming the temporary file to replace the original.
235 In this way, any I/O error in writing leaves the original untouched,
236 and there is never any instant where the file is nonexistent.
238 Note that this feature forces backups to be made by copying.
239 Yet, at the same time, saving a precious file
240 breaks any hard links between it and other files."
245 "Control use of version numbers for backup files.
246 When t, make numeric backup versions unconditionally.
247 When nil, make them for files that have some already.
248 The value `never' means do not make them."
258 "When cleaning directory, number of versions to keep."
264 "If t, delete excess backup versions silently.
265 If nil, ask confirmation. Any other value prevents any trimming."
272 "Number of oldest versions to keep when a new numbered backup is made."
278 "Number of newest versions to keep when a new numbered backup is made.
279 Includes the new backup. Must be > 0"
285 "Whether to add a newline automatically at the end of the file.
287 A value of t means do this only when the file is about to be saved.
288 A value of `visit' means do this right after the file is visited.
289 A value of `visit-save' means do it at both of those times.
290 Any other non-nil value means ask user whether to add a newline, when saving.
291 A value of nil means don't add newlines.
293 Certain major modes set this locally to the value obtained
294 from `mode-require-final-newline'."
303 "Whether to add a newline at end of file, in certain major modes.
304 Those modes set `require-final-newline' to this value when you enable them.
305 They do so because they are often used for files that are supposed
306 to end in newlines, and the question is how to arrange that.
308 A value of t means do this only when the file is about to be saved.
309 A value of `visit' means do this right after the file is visited.
310 A value of `visit-save' means do it at both of those times.
311 Any other non-nil value means ask user whether to add a newline, when saving.
313 A value of nil means do not add newlines. That is a risky choice in this
314 variable since this value is used for modes for files that ought to have
315 final newlines. So if you set this to nil, you must explicitly check and
316 add a final newline, whenever you save a file that really needs one."
326 "Non-nil says by default do auto-saving of every file-visiting buffer."
331 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
332 Normally auto-save files are written under other names."
338 ;; Don't put "\\2" inside expand-file-name, since it will be
339 ;; transformed to "/2" on DOS/Windows.
341 "Transforms to apply to buffer file name before making auto-save file name.
342 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
343 REGEXP is a regular expression to match against the file name.
344 If it matches, `replace-match' is used to replace the
345 matching part with REPLACEMENT.
346 If the optional element UNIQUIFY is non-nil, the auto-save file name is
347 constructed by taking the directory part of the replaced file-name,
348 concatenated with the buffer file name with all directory separators
349 changed to `!' to prevent clashes. This will not work
350 correctly if your filesystem truncates the resulting name.
352 All the transforms in the list are tried, in the order they are listed.
353 When one transform applies, its result is final;
354 no further transforms are tried.
356 The default value is set up to put the auto-save file into the
357 temporary directory (see the variable `temporary-file-directory') for
358 editing a remote file.
360 On MS-DOS filesystems without long names this variable is always
361 ignored."
368 "Non-nil means save word abbrevs too when files are saved.
369 If `silently', don't ask the user before saving."
374 "Non-nil means allow `find-file' to visit directories.
375 To visit the directory, `find-file' runs `find-directory-functions'."
380 "List of functions to try in sequence to visit a directory.
381 Each function is called with the directory name as the sole argument
382 and should return either a buffer or nil."
386 ;;;It is not useful to make this a local variable.
387 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
389 "List of functions to be called for `find-file' on nonexistent file.
390 These functions are called as soon as the error is detected.
391 Variable `buffer-file-name' is already set up.
396 ;;;It is not useful to make this a local variable.
397 ;;;(put 'find-file-hooks 'permanent-local t)
399 "List of functions to be called after a buffer is loaded from a file.
400 The buffer's local variables (if any) will have been processed before the
401 functions are called."
409 "List of functions to be called before writing out a buffer to a file.
410 If one of them returns non-nil, the file is considered already written
411 and the rest are not called.
412 These hooks are considered to pertain to the visited file.
413 So any buffer-local binding of this variable is discarded if you change
415 change the major mode.
417 This hook is not run if any of the functions in
418 `write-contents-functions' returns non-nil. Both hooks pertain
419 to how to save a buffer to file, for instance, choosing a suitable
420 coding system and setting mode bits. (See Info
421 node `(elisp)Saving Buffers'.) To perform various checks or
432 "List of functions to be called before writing out a buffer to a file.
433 If one of them returns non-nil, the file is considered already written
434 and the rest are not called and neither are the functions in
435 `write-file-functions'.
437 This variable is meant to be used for hooks that pertain to the
438 buffer's contents, not to the particular visited file; thus,
439 `set-visited-file-name' does not clear this variable; but changing the
440 major mode does clear it.
442 For hooks that _do_ pertain to the particular visited file, use
443 `write-file-functions'. Both this variable and
444 `write-file-functions' relate to how a buffer is saved to file.
445 To perform various checks or updates before the buffer is saved,
452 "Control use of local variables in files you visit.
453 The value can be t, nil, :safe, :all or something else.
455 A value of t means file local variables specifications are obeyed
456 if all the specified variable values are safe; if any values are
457 not safe, Emacs queries you, once, whether to set them all.
458 \(When you say yes to certain values, they are remembered as safe.)
460 :safe means set the safe variables, and ignore the rest.
461 :all means set all variables, whether safe or not.
462 (Don't set it permanently to :all.)
463 A value of nil means always ignore the file local variables.
465 Any other value means always query you once whether to set them all.
466 \(When you say yes to certain values, they are remembered as safe, but
469 This variable also controls use of major modes specified in
470 a -*- line.
473 always obeys file local variable specifications and the -*- line,
474 and ignores this variable."
483 "Like `enable-local-variables' but meant for buffer-local bindings.
484 The meaningful values are nil and non-nil. The default is non-nil.
485 If a major mode sets this to nil, buffer-locally, then any local
486 variables list in the file will be ignored.
488 This variable does not affect the use of major modes
493 The value can be t, nil or something else.
494 A value of t means obey `eval' variables;
495 A value of nil means ignore them; anything else means query."
501 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
510 "Non-nil means buffers visiting files read-only do so in view mode.
511 In fact, this means that all read-only buffers normally have
512 View mode enabled, including buffers that are read-only because
513 you visit a file you cannot alter, and buffers you make read-only
520 \f
523 "Provides support for ange-ftp host name completion.
524 Runs the usual ange-ftp hook, but only for completion operations."
525 ;; Having this here avoids the need to load ange-ftp when it's not
526 ;; really in use.
532 inhibit-file-name-handlers)))
537 "Convert a standard file's name to something suitable for the OS.
538 This means to guarantee valid names and perhaps to canonicalize
539 certain patterns.
541 FILENAME should be an absolute file name since the conversion rules
542 sometimes vary depending on the position in the file name. E.g. c:/foo
543 is a valid DOS file name, but c:/bar/c:/foo is not.
545 This function's standard definition is trivial; it just returns
546 the argument. However, on Windows and DOS, replace invalid
547 characters. On DOS, make sure to obey the 8.3 limitations.
548 In the native Windows build, turn Cygwin names into native names,
549 and also turn slashes into backslashes if the shell requires it (see
550 `w32-shell-dos-semantics').
552 See Info node `(elisp)Standard File Names' for more details."
556 ;; Replace invalid filename characters with !
560 name)
561 filename))
564 "Read directory name, prompting with PROMPT and completing in directory DIR.
565 Value is not expanded---you must call `expand-file-name' yourself.
566 Default name to DEFAULT-DIRNAME if user exits with the same
567 non-empty string that was inserted by this function.
568 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
569 or just DIR if INITIAL is nil.)
570 If the user exits with an empty minibuffer, this function returns
571 an empty string. (This can only happen if the user erased the
572 pre-inserted contents or if `insert-default-directory' is nil.)
573 Fourth arg MUSTMATCH non-nil means require existing directory's name.
574 Non-nil and non-t means also require confirmation after completion.
575 Fifth arg INITIAL specifies text to start with.
576 DIR should be an absolute directory name. It defaults to
577 the value of `default-directory'."
582 dir))
583 mustmatch initial
586 \f
588 "Show the current default directory."
593 "Value of the CDPATH environment variable, as a list.
597 "Explode a search path into a list of directory names.
598 Directories are separated by occurrences of `path-separator'
599 \(which is colon in GNU and GNU-like systems)."
600 ;; We could use split-string here.
608 nil
613 cd-list)))
616 "Change current directory to given absolute file name DIR."
617 ;; Put the name into directory syntax now,
618 ;; because otherwise expand-file-name may give some bad results.
631 "Make DIR become the current buffer's default directory.
632 If your environment includes a `CDPATH' variable, try each one of
633 that list of directories (separated by occurrences of
634 `path-separator') when resolving a relative directory name.
635 The path separator is colon in GNU and GNU-like systems."
638 default-directory default-directory
654 cd-path)
655 nil))
659 "Load the Lisp file named FILE."
660 ;; This is a case where .elc makes a lot of sense.
667 "Search for FILENAME through PATH.
668 If found, return the absolute file name of FILENAME, with its suffixes;
669 otherwise return nil.
670 PATH should be a list of directories to look in, like the lists in
671 `exec-path' or `load-path'.
672 If SUFFIXES is non-nil, it should be a list of suffixes to append to
675 If non-nil, PREDICATE is used instead of `file-readable-p'.
676 PREDICATE can also be an integer to pass to the `access' system call,
677 in which case file-name handlers are ignored. This usage is deprecated.
679 For compatibility, PREDICATE can also be one of the symbols
680 `executable', `readable', `writable', or `exists', or a list of
681 one or more of those symbols."
692 "Do completion for file names passed to `locate-file'.
693 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
716 "Search for COMMAND in `exec-path' and return the absolute file name.
717 Return nil if COMMAND is not found anywhere in `exec-path'."
718 ;; Use 1 rather than file-executable-p to better match the behavior of
719 ;; call-process.
723 "Load the library named LIBRARY.
724 This is an interface to the function `load'."
727 'locate-file-completion
732 "Test whether FILE specifies a location on a remote system.
733 Return an identification of the system if the location is indeed
734 remote. The identification of the system may comprise a method
735 to access the system and its hostname, amongst other things.
742 nil)))
745 "Copy the file FILE into a temporary file on this machine.
746 Returns the name of the local copy, or nil, if FILE is directly
747 accessible."
748 ;; This formerly had an optional BUFFER argument that wasn't used by
749 ;; anything.
753 nil)))
756 "Return the truename of FILENAME, which should be absolute.
757 The truename of a file name is found by chasing symbolic links
758 both at the level of the file and at the level of the directories
759 containing it, until no links are left at any level.
762 ;; COUNTER and PREV-DIRS are only used in recursive calls.
763 ;; COUNTER can be a cons cell whose car is the count of how many
764 ;; more links to chase before getting an error.
765 ;; PREV-DIRS can be a cons cell whose car is an alist
766 ;; of truenames we've just recently computed.
780 ;; For speed, remove the ange-ftp completion handler from the list.
781 ;; We know it's not needed here.
782 ;; For even more speed, do this only on the outermost call.
789 ;; andrewi@harlequin.co.uk - none of the following code (except for
790 ;; invoking the file-name handler) currently applies on Windows
791 ;; (ie. there are no native symlinks), but there is an issue with
792 ;; case differences being ignored by the OS, and short "8.3 DOS"
793 ;; name aliases existing for all files. (The short names are not
794 ;; reported by directory-files, but can be used to refer to files.)
795 ;; It seems appropriate for file-truename to resolve these issues in
796 ;; the most natural way, which on Windows is to call the function
797 ;; `w32-long-file-name' - this returns the exact name of a file as
798 ;; it is stored on disk (expanding short name aliases with the full
799 ;; name in the process).
802 ;; For file name that has a special handler, call handler.
803 ;; This is so that ange-ftp can save time by doing a no-op.
806 ;; If filename contains a wildcard, newname will be the old name.
808 ;; If filename exists, use the long name
812 ;; If this file directly leads to a link, process that iteratively
813 ;; so that we don't use lots of stack.
819 ;; For file name that has a special handler, call handler.
820 ;; This is so that ange-ftp can save time by doing a no-op.
823 done t)
825 target dirfile)
826 ;; Get the truename of the directory.
828 ;; If these are equal, we have the (or a) root directory.
830 ;; If this is the same dir we last got the truename for,
831 ;; save time--don't recalculate.
841 done t)
844 done t)
845 ;; Put it back on the file name.
847 ;; Is the file name the name of a link?
850 ;; Yes => chase that link, then start all over
851 ;; since the link may point to a directory name that uses links.
852 ;; We can't safely use expand-file-name here
853 ;; since target might look like foo/../bar where foo
854 ;; is itself a link. Instead, we handle . and .. above.
857 target
859 done nil)
860 ;; No, we are done!
862 filename))
865 "Chase links in FILENAME until a name that is not a link.
866 Unlike `file-truename', this does not check whether a parent
867 directory name is a symbolic link.
868 If the optional argument LIMIT is a number,
869 it means chase no more than that many links and then stop."
877 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
880 ;; Handle `..' by hand, since it needs to work in the
881 ;; target of any directory symlink.
882 ;; This code is not quite complete; it does not handle
883 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
887 ;; Chase links in the default dir of the symlink.
891 ;; Now find the parent of that dir.
895 newname))
898 "Create a temporary file.
899 The returned file name (created by appending some random characters at the end
900 of PREFIX, and expanding against `temporary-file-directory' if necessary),
901 is guaranteed to point to a newly created empty file.
902 You can then use `write-region' to write new data into the file.
904 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
906 If SUFFIX is non-nil, add that at the end of the file name."
908 file)
911 ;; Create temp files with strict access rights. It's easy to
912 ;; loosen them later, whereas it's impossible to close the
913 ;; time-window of loose permissions otherwise.
925 nil)
927 ;; the file was somehow created by someone else between
928 ;; `make-temp-name' and `write-region', let's try again.
929 nil)
930 file)
931 ;; Reset the umask.
935 "Change the encoding of FILE's name from CODING to NEW-CODING.
936 The value is a new name of FILE.
937 Signals a `file-already-exists' error if a file of the new name
938 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
939 is non-nil. A number as fourth arg means request confirmation if
940 the new name already exists. This is what happens in interactive
941 use with M-x."
944 default-file-name-coding-system))
946 from-coding to-coding)
948 ;; We provide the default coding only when it seems that
949 ;; the filename is correctly decoded by the default
950 ;; coding.
956 filename default-coding)
957 default-coding))
961 ;; We provide the default coding only when a user is going to
962 ;; change the encoding not from the default coding.
966 filename from-coding)))
969 filename from-coding default-coding)
970 default-coding)))
974 default-file-name-coding-system))
975 ;; FILE should have been decoded by DEFAULT-CODING.
979 ;; Suppress further encoding.
984 newname))
985 \f
987 "Select buffer BUFFER in another window.
988 If BUFFER does not identify an existing buffer, then this function
989 creates a buffer with that name.
991 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
992 or nil. If BUFFER is nil, then this function chooses a buffer
993 using `other-buffer'.
994 Optional second arg NORECORD non-nil means
995 do not put this buffer at the front of the list of recently selected ones.
996 This function returns the buffer it switched to.
998 This uses the function `display-buffer' as a subroutine; see its
999 documentation for additional customization information."
1002 ;; Don't let these interfere.
1003 same-window-buffer-names same-window-regexps)
1007 "Switch to buffer BUFFER in another frame.
1008 Optional second arg NORECORD non-nil means
1009 do not put this buffer at the front of the list of recently selected ones.
1011 This uses the function `display-buffer' as a subroutine; see its
1012 documentation for additional customization information."
1015 same-window-buffer-names same-window-regexps)
1020 "Switch to buffer BUFFER in another frame.
1021 This uses the function `display-buffer' as a subroutine; see its
1022 documentation for additional customization information."
1025 same-window-buffer-names same-window-regexps
1027 new-window)
1037 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1038 BODY should use the minibuffer at most once.
1039 Recursive uses of the minibuffer will not be affected."
1045 ;; Clear out this hook so it does not interfere
1046 ;; with any recursive minibuffer usage.
1062 t))
1065 "Edit file FILENAME.
1066 Switch to a buffer visiting file FILENAME,
1067 creating one if none already exists.
1068 Interactively, the default if you just type RET is the current directory,
1069 but the visited file name is available through the minibuffer history:
1070 type M-n to pull it into the minibuffer.
1072 You can visit files on remote machines by specifying something
1073 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1074 also visit local files as a different user by specifying
1075 /sudo::FILE for the file name.
1076 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1077 manual, for more about this.
1079 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1080 expand wildcards (if any) and visit multiple files. You can
1081 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1083 To visit a file without any kind of conversion and without
1092 "Edit file FILENAME, in another window.
1095 an existing one. See the function `display-buffer'.
1097 Interactively, the default if you just type RET is the current directory,
1098 but the visited file name is available through the minibuffer history:
1099 type M-n to pull it into the minibuffer.
1101 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1102 expand wildcards (if any) and visit multiple files."
1113 "Edit file FILENAME, in another frame.
1116 an existing one. See the function `display-buffer'.
1118 Interactively, the default if you just type RET is the current directory,
1119 but the visited file name is available through the minibuffer history:
1120 type M-n to pull it into the minibuffer.
1122 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1123 expand wildcards (if any) and visit multiple files."
1134 "Edit the existing file FILENAME.
1136 file names with wildcards."
1144 "Edit file FILENAME but don't allow changes.
1156 value))
1159 "Edit file FILENAME in another window but don't allow changes.
1171 value))
1174 "Edit file FILENAME in another frame but don't allow changes.
1186 value))
1189 "Find file FILENAME as a replacement for the file in the next window.
1190 This command does not select that window.
1194 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1195 expand wildcards (if any) and replace the file with multiple files."
1207 t))))
1215 "Find file FILENAME, select its buffer, kill previous buffer.
1216 If the current buffer now contains an empty file that you just visited
1217 \(presumably by mistake), use this command to visit the file you really want.
1221 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1222 expand wildcards (if any) and replace the file with multiple files.
1224 If the current buffer is an indirect buffer, or the base buffer
1225 for one or more indirect buffers, the other buffer(s) are not
1226 killed."
1236 t)))
1257 ;; This prevents us from finding the same buffer
1258 ;; if we specified the same file again.
1262 ;; Likewise for dired buffers.
1266 ;; This executes if find-file gets an error
1267 ;; and does not really find anything.
1268 ;; We put things back as they were.
1269 ;; If find-file actually finds something, we kill obuf below.
1278 ;; We already asked; don't ask again.
1281 \f
1283 "Create a suitably named buffer for visiting FILENAME, and return it.
1284 FILENAME (sans directory) is used unchanged if that name is free;
1285 otherwise a string <2> or <3> or ... is appended to get an unused name."
1292 "Create and return a buffer with a name based on NAME.
1293 Choose the buffer's name using `generate-new-buffer-name'."
1297 "Regexp to match the automounter prefix in a directory name."
1305 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1307 home directory is a root directory) and removes automounter prefixes
1308 \(see the variable `automount-dir-prefix')."
1309 ;; Get rid of the prefixes added by the automounter.
1317 ;; If any elt of directory-abbrev-alist matches this name,
1318 ;; abbreviate accordingly.
1324 ;; Compute and save the abbreviated homedir name.
1325 ;; We defer computing this until the first time it's needed, to
1326 ;; give time for directory-abbrev-alist to be set properly.
1327 ;; We include a slash at the end, to avoid spurious matches
1328 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1335 ;; If FILENAME starts with the abbreviated homedir,
1336 ;; make it start with `~' instead.
1338 ;; If the home dir is just /, don't change it.
1341 ;; MS-DOS root directories can come with a drive letter;
1342 ;; Novell Netware allows drive letters beyond `Z:'.
1352 filename)))
1355 "List of logical names for which visiting shouldn't save the true dirname.
1356 On VMS, when you visit a file using a logical name that searches a path,
1357 you may or may not want the visited file name to record the specific
1358 directory where the file was found. If you *do not* want that, add the logical
1359 name to this list as a string."
1364 "Return the buffer visiting file FILENAME (a string).
1365 This is like `get-file-buffer', except that it checks for any buffer
1366 visiting the same file, possibly under a different name.
1367 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1368 and others are ignored.
1369 If there is no such live buffer, return nil."
1383 found)
1393 ;; Verify this buffer's file number
1394 ;; still belongs to its file.
1397 attributes)
1401 found))))
1402 \f
1404 "Non-nil means file-visiting commands should handle wildcards.
1405 For example, if you specify `*.c', that would visit all the files
1406 whose names match the pattern."
1412 "Non-nil means suppress warning messages for symlinked files.
1413 When nil, Emacs prints a warning when visiting a file that is already
1414 visited, but with a different name. Setting this option to t
1415 suppresses this warning."
1421 "Maximum size of file above which a confirmation is requested.
1422 When nil, never request confirmation."
1429 "Read file FILENAME into a buffer and return the buffer.
1430 If a buffer exists visiting FILENAME, return that one, but
1431 verify that the file has not changed since visited or saved.
1432 The buffer is not selected, just returned to the caller.
1433 Optional second arg NOWARN non-nil means suppress any warning messages.
1434 Optional third arg RAWFILE non-nil means the file is read literally.
1435 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1436 and visit all the matching files. When wildcards are actually
1437 used and expanded, return a list of buffers that are visiting
1438 the various files."
1445 'find-directory-functions
1448 filename)))
1451 find-file-wildcards
1465 ;; Find any buffer for a file which has same truename.
1467 ;; Let user know if there is a buffer with the same truename.
1471 find-file-suppress-same-file-warnings
1475 ;; Optionally also find that buffer.
1478 ;; Check to see if the file looks uncommonly large.
1480 ;; Don't ask again if we already have the file or
1481 ;; if we're asked to be quiet.
1490 ;; We are using an existing buffer.
1497 ;; Certain files should be reverted automatically
1498 ;; if they have changed on disk and not in the buffer.
1506 found))
1516 "File %s changed on disk. Discard your edits? "
1521 "File %s changed on disk. Discard your edits in %s? "
1529 ;; Check if a formerly read-only file has become
1530 ;; writable and vice versa, but if the buffer agrees
1531 ;; with the new state of the file, that is ok too.
1539 buffer-file-name
1548 ;; It is confusing to ask whether to visit
1549 ;; non-literally if they have the file in
1550 ;; hexl-mode.
1556 "The file %s is already visited normally,
1557 and you have edited the buffer. Now you have asked to visit it literally,
1558 meaning no coding system handling, format conversion, or local variables.
1559 Emacs can only visit a file in one way at a time.
1561 Do you want to save the file, and visit it literally instead? "
1562 "The file %s is already visited literally,
1563 meaning no coding system handling, format conversion, or local variables.
1564 You have edited the buffer. Now you have asked to visit the file normally,
1565 but Emacs can only visit a file in one way at a time.
1572 rawfile truename number))
1576 "\
1577 Do you want to discard your changes, and visit the file literally now? "
1578 "\
1581 rawfile truename number)
1587 "The file %s is already visited normally.
1588 You have asked to visit it literally,
1589 meaning no coding system decoding, format conversion, or local variables.
1590 But Emacs can only visit a file in one way at a time.
1592 Do you want to revisit the file literally now? "
1593 "The file %s is already visited literally,
1594 meaning no coding system decoding, format conversion, or local variables.
1595 You have asked to visit it normally,
1596 but Emacs can only visit a file in one way at a time.
1601 rawfile truename number)
1604 ;; Return the buffer we are using.
1605 buf)
1606 ;; Create a new buffer.
1608 ;; find-file-noselect-1 may use a different buffer.
1610 rawfile truename number))))))
1616 ;; Needed in case we are re-visiting the file with a different
1617 ;; text representation.
1634 filename)))
1635 ;; Unconditionally set error
1645 filename)))
1646 ;; Run find-file-not-found-functions until one returns non-nil.
1648 ;; If they fail too, set error.
1650 ;; Record the file's truename, and maybe use that as visited name.
1656 ;; On VMS, we may want to remember which directory in a search list
1657 ;; the file was found in.
1667 ;; Set buffer's default directory to that of the file.
1669 ;; Turn off backup files for certain file names. Since
1670 ;; this is a permanent local, the major mode won't eliminate it.
1685 \f
1687 "Like `insert-file-contents', but only reads in the file literally.
1688 A buffer may be modified in several ways after reading into the buffer,
1689 to Emacs features such as format decoding, character code
1690 conversion, `find-file-hook', automatic uncompression, etc.
1692 This function ensures that none of these modifications will take place."
1700 nil))
1703 inhibit-file-name-handlers))
1716 filename)))
1726 "Insert contents of file FILENAME into buffer after point with no conversion.
1728 This function is meant for the user to run interactively.
1729 Don't call it from programs! Use `insert-file-contents-literally' instead.
1730 \(Its calling sequence is different; see its documentation)."
1735 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1740 "Visit file FILENAME with no conversion of any kind.
1741 Format conversion and character code conversion are both disabled,
1742 and multibyte characters are disabled in the resulting buffer.
1743 The major mode used is Fundamental mode regardless of the file name,
1744 and local variable specifications in the file are ignored.
1745 Automatic uncompression and adding a newline at the end of the
1746 file due to `require-final-newline' is also disabled.
1748 You cannot absolutely rely on this function to result in
1749 visiting the file literally. If Emacs already has a buffer
1750 which is visiting the file, you get the existing buffer,
1751 regardless of whether it was created literally or not.
1753 In a Lisp program, if you want to be sure of accessing a file's
1754 contents literally, you should create a temporary buffer and then read
1755 the file contents into it using `insert-file-contents-literally'."
1758 \f
1762 after-find-file-from-revert-buffer
1763 nomodes)
1764 "Called after finding a file and by the default revert function.
1765 Sets buffer mode, parses local variables.
1766 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1767 error in reading the file. WARN non-nil means warn if there
1768 exists an auto-save file more recent than the visited file.
1769 NOAUTO means don't mess with auto-save mode.
1770 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1771 means this call was from `revert-buffer'.
1772 Fifth arg NOMODES non-nil means don't alter the file's modes.
1773 Finishes by calling the functions in `find-file-hook'
1774 unless NOMODES is non-nil."
1777 nil
1787 ;; No need to warn if buffer is auto-saved
1788 ;; under the name of the visited file.
1790 auto-save-visited-file-name))
1793 buffer-file-name))
1813 ;; Make people do a little extra work (C-x C-q)
1814 ;; before altering a backup file.
1817 ;; When a file is marked read-only,
1818 ;; make the buffer read-only even if root is looking at it.
1826 ;; If requested, add a newline at the end of the file.
1836 view-read-only
1842 "Eval BODY and turn any error into a FORMAT message.
1843 FORMAT can have a %s escape which will be replaced with the actual error.
1844 If `debug-on-error' is set, errors are not caught, so that you can
1845 debug them.
1846 Avoid using a large BODY since it is duplicated."
1855 "Choose the major mode for this buffer automatically.
1856 Also sets up any specified local variables of the file.
1857 Uses the visited file name, the -*- line, and the local variables spec.
1859 This function is called automatically from `find-file'. In that case,
1860 we may set up the file-specified mode and local variables,
1861 depending on the value of `enable-local-variables'.
1862 In addition, if `local-enable-local-variables' is nil, we do
1863 not set local variables (though we do notice a mode specified with -*-.)
1865 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1866 or from Lisp without specifying the optional argument FIND-FILE;
1867 in that case, this function acts as if `enable-local-variables' were t."
1875 ;; Turn font lock off and on, to make sure it takes account of
1876 ;; whatever file local variables are relevant to it.
1878 ;; Font-lock-mode (now in font-core.el) can be ON when
1879 ;; font-lock.el still hasn't been loaded.
1889 "Non-nil means to try second pass through `auto-mode-alist'.
1890 This means that if the first case-sensitive search through the alist fails
1891 to find a matching major mode, a second case-insensitive search is made.
1892 On systems with case-insensitive file names, this variable is ignored,
1893 since only a single case-insensitive search through the alist is made."
1899 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1900 ;; c++-mode, java-mode and more) are added through autoload
1901 ;; directives in that file. That way is discouraged since it
1902 ;; spreads out the definition of the initial value.
1934 ;; Less common extensions come here
1935 ;; so more common ones above are found faster.
1974 ;; The list of archive file extensions should be in sync with
1975 ;; `auto-coding-alist' with `no-conversion' coding system.
1979 ;; Mailer puts message to be edited in
1980 ;; /tmp/Re.... or Message
1984 ;; some news reader is reported to use this
1993 ;; .emacs or .gnus or .viper following a directory delimiter in
1994 ;; Unix, MSDOG or VMS syntax.
1997 ;; _emacs following a directory delimiter
1998 ;; in MsDos syntax
2002 ;; Common Lisp ASDF package system.
2019 ;; Windows candidates may be opened case sensitively on Unix
2025 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2027 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2028 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2029 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2030 ;; this has lower priority to avoid matching changelog.sgml etc.
2032 ;; either user's dot-files or under /etc or some such
2034 ;; alas not all ~/.*rc files are like this
2035 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2040 ;; this contains everything twice, with space and with colon :-(
2042 ;; Get rid of any trailing .n.m and try again.
2043 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2044 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2045 ;; Using mode nil rather than `ignore' would let the search continue
2046 ;; through this list (with the shortened name) rather than start over.
2048 ;; The following should come after the ChangeLog pattern
2049 ;; for the sake of ChangeLog.1, etc.
2050 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2053 "Alist of filename patterns vs corresponding major mode functions.
2054 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2055 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2056 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2057 mode function to use. FUNCTION will be called, unless it is nil.
2059 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2060 calling FUNCTION (if it's not nil), we delete the suffix that matched
2061 REGEXP and search the list again for another match.
2063 If the file name matches `inhibit-first-line-modes-regexps',
2064 then `auto-mode-alist' is not processed.
2066 The extensions whose FUNCTION is `archive-mode' should also
2067 appear in `auto-coding-alist' with `no-conversion' coding system.
2069 See also `interpreter-mode-alist', which detects executable script modes
2070 based on the interpreters they specify to run,
2074 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2075 ;; and pike-mode) are added through autoload directives in that
2076 ;; file. That way is discouraged since it spreads out the
2077 ;; definition of the initial value.
2115 "Alist mapping interpreter names to major modes.
2116 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2117 Each element looks like (INTERPRETER . MODE).
2118 If INTERPRETER matches the name of the interpreter specified in the first line
2119 of a script, mode MODE is enabled.
2127 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2128 When checking `inhibit-first-line-modes-regexps', we first discard
2134 "Regexp matching interpreters, for file mode determination.
2135 This regular expression is matched against the first line of a file
2136 to determine the file's mode in `set-auto-mode'. If it matches, the file
2137 is assumed to be interpreted by the interpreter matched by the second group
2138 of the regular expression. The mode is then determined as the mode
2142 "Alist of buffer beginnings vs. corresponding major mode functions.
2143 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2144 After visiting a file, if REGEXP matches the text at the beginning of the
2145 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2146 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2147 major mode.
2149 If FUNCTION is nil, then it is not called. (That is a way of saying
2155 ;; The < comes before the groups (but the first) to reduce backtracking.
2156 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2157 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2161 comment-re "*"
2164 . html-mode)
2166 ;; These two must come after html, because they are more general:
2171 . sgml-mode)
2174 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2175 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2176 After visiting a file, if REGEXP matches the text at the beginning of the
2177 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2178 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2179 have not specified a mode for this file.
2185 "Upper limit on `magic-mode-alist' regexp matches.
2189 "Select major mode appropriate for current buffer.
2191 To find the right major mode, this function checks for a -*- mode tag,
2192 checks if it uses an interpreter listed in `interpreter-mode-alist',
2193 matches the buffer beginning against `magic-mode-alist',
2194 compares the filename against the entries in `auto-mode-alist',
2195 then matches the buffer beginning against `magic-fallback-mode-alist'.
2197 It does not check for the `mode:' local variable in the
2198 Local Variables section of the file; for that, use `hack-local-variables'.
2200 If `enable-local-variables' is nil, this function does not check for a
2201 -*- mode tag.
2203 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2204 set the major mode only if that would change it. In other words
2205 we don't actually set it to the same mode the buffer already has."
2206 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2208 ;; Find a -*- mode tag
2215 ;; Find all specifications for the `mode:' variable
2216 ;; and execute them left to right.
2228 modes)))
2229 ;; Simple -*-MODE-*- case.
2232 modes))))
2233 ;; If we found modes to use, invoke them now, outside the save-excursion.
2241 ;; continuing would call minor modes again, toggling them off
2243 ;; If we didn't, look for an interpreter specified in the first line.
2244 ;; As a special case, allow for things like "#!/bin/env perl", which
2245 ;; finds the interpreter anywhere in $PATH.
2252 ;; Map interpreter name to a mode, signalling we're done at the
2253 ;; same time.
2255 interpreter-mode-alist))
2256 ;; If we found an interpreter mode to use, invoke it now.
2259 ;; Next try matching the buffer beginning against magic-mode-alist.
2273 ;; Next compare the filename against the entries in auto-mode-alist.
2278 ;; Remove remote file name identification.
2282 ;; Remove backup-suffixes from file name.
2285 ;; Find first matching alist entry.
2288 ;; System is case-insensitive.
2292 ;; System is case-sensitive.
2294 ;; First match case-sensitively.
2298 ;; Fallback to case-insensitive match.
2312 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2327 ;; When `keep-mode-if-same' is set, we are working on behalf of
2328 ;; set-visited-file-name. In that case, if the major mode specified is the
2329 ;; same one we already have, don't actually reset it. We don't want to lose
2330 ;; minor modes such as Font Lock.
2332 "Apply MODE and return it.
2333 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2334 any aliases and compared to current major mode. If they are the
2335 same, do nothing and return nil."
2341 mode)))
2344 "Find the -*- spec in the buffer.
2345 Call with point at the place to start searching from.
2346 If one is found, set point to the beginning
2347 and return the position of the end.
2348 Otherwise, return nil; point may be changed."
2351 ;; Don't look for -*- if this file name matches any
2352 ;; of the regexps in inhibit-first-line-modes-regexps.
2360 sufs)
2368 ;; If the file begins with "#!"
2369 ;; (exec interpreter magic), look
2370 ;; for mode frobs in the first two
2371 ;; lines. You cannot necessarily
2372 ;; put them in the first line of
2373 ;; such a file without screwing up
2374 ;; the interpreter invocation.
2385 end))))
2386 \f
2387 ;;; Handling file local variables
2394 "Normal hook run after processing a file's local variables specs.
2395 Major modes can use this to examine user-specified local variables
2399 "List variable-value pairs that are considered safe.
2400 Each element is a cons cell (VAR . VAL), where VAR is a variable
2401 symbol and VAL is a value that is considered safe."
2406 "Expressions that are considered safe in an `eval:' local variable.
2407 Add expressions to this list if you want Emacs to evaluate them, when
2408 they appear in an `eval' local variable specification, without first
2409 asking you for confirmation."
2414 ;; Risky local variables:
2417 auto-mode-alist
2418 buffer-auto-save-file-name
2419 buffer-file-name
2420 buffer-file-truename
2421 buffer-undo-list
2422 dabbrev-case-fold-search
2423 dabbrev-case-replace
2424 debugger
2425 default-text-properties
2426 display-time-string
2427 enable-local-eval
2428 enable-local-variables
2429 eval
2430 exec-directory
2431 exec-path
2432 file-name-handler-alist
2433 font-lock-defaults
2434 format-alist
2435 frame-title-format
2436 global-mode-string
2437 header-line-format
2438 icon-title-format
2439 ignored-local-variables
2440 imenu--index-alist
2441 imenu-generic-expression
2442 inhibit-quit
2443 input-method-alist
2444 load-path
2445 max-lisp-eval-depth
2446 max-specpdl-size
2447 minor-mode-alist
2448 minor-mode-map-alist
2449 minor-mode-overriding-map-alist
2450 mode-line-buffer-identification
2451 mode-line-format
2452 mode-line-modes
2453 mode-line-modified
2454 mode-line-mule-info
2455 mode-line-position
2456 mode-line-process
2457 mode-name
2458 outline-level
2459 overriding-local-map
2460 overriding-terminal-local-map
2461 parse-time-rules
2462 process-environment
2463 rmail-output-file-alist
2464 safe-local-variable-values
2465 safe-local-eval-forms
2466 save-some-buffers-action-alist
2467 special-display-buffer-names
2468 standard-input
2469 standard-output
2470 unread-command-events
2471 vc-mode))
2473 ;; Safe local variables:
2474 ;;
2475 ;; For variables defined by major modes, the safety declarations can go into
2476 ;; the major mode's file, since that will be loaded before file variables are
2477 ;; processed.
2478 ;;
2479 ;; For variables defined by minor modes, put the safety declarations in the
2480 ;; file defining the minor mode after the defcustom/defvar using an autoload
2481 ;; cookie, e.g.:
2482 ;;
2483 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2484 ;;
2485 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2486 ;; minor mode file may not be loaded yet.
2487 ;;
2488 ;; For variables defined in the C source code the declaration should go here:
2504 "Get confirmation before setting up local variable values.
2505 ALL-VARS is the list of all variables to be set up.
2506 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2507 RISKY-VARS is the list of those that are marked as risky."
2509 nil
2514 prompt char)
2524 ", and variables that are risky (**)."
2531 y -- to apply the local variables list.
2535 ! -- to apply the local variables list, and permanently mark these
2547 ;; Make strings with embedded whitespace easier to read.
2555 ""
2562 done)
2571 ;; read-event returns -1 if we are in a kbd
2572 ;; macro and there are no more events in the
2573 ;; macro. In that case, attempt to get an
2574 ;; event interactively.
2582 ;; When this is called from desktop-restore-file-buffer,
2583 ;; coding-system-for-read may be non-nil. Reset it before
2584 ;; writing to .emacs.
2588 'safe-local-variable-values
2589 safe-local-variable-values))))
2596 "Return local variables specified in the -*- line.
2597 Ignore any specification for `mode:' and `coding:';
2598 `set-auto-mode' should already have handled `mode:',
2599 `set-auto-coding' should already have handled `coding:'.
2601 If MODE-ONLY is non-nil, all we do is check whether the major
2602 mode is specified, returning t if it is specified. Otherwise,
2603 return an alist of elements (VAR . VAL), where VAR is a variable
2604 and VAL is the specified value."
2608 result mode-specified)
2609 ;; Parse the -*- line into the RESULT alist.
2610 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2612 nil)
2614 ;; Simple form: "-*- MODENAME -*-". Already handled.
2616 nil)
2618 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2619 ;; (last ";" is optional).
2624 ;; There used to be a downcase here,
2625 ;; but the manual didn't say so,
2626 ;; and people want to set var names that aren't all lc.
2631 ;; It is traditional to ignore
2632 ;; case when checking for `mode' in set-auto-mode,
2633 ;; so we must do that here as well.
2634 ;; That is inconsistent, but we're stuck with it.
2635 ;; The same can be said for `coding' in set-auto-coding.
2641 'eval
2648 mode-specified
2649 result))))
2652 "Parse and put into effect this buffer's local variables spec.
2653 If MODE-ONLY is non-nil, all we do is check whether the major mode
2654 is specified, returning t if it is specified."
2657 result)
2660 ;; Look for "Local variables:" line in last page.
2668 ;; suffix is what comes after "local variables:" in its line.
2669 ;; prefix is what comes before "local variables:" in its line.
2679 beg)
2683 endpos
2689 nil t))
2699 ;; Discard the prefix.
2704 ;; Discard the suffix.
2712 ;; Find the variable name; strip whitespace.
2720 val)
2721 ;; Read the variable value.
2731 'eval
2737 ;; We've read all the local variables. Now, return whether the
2738 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2739 ;; variables (if MODE-ONLY is nil.)
2741 result
2748 ;; Find those variables that we may want to save to
2749 ;; `safe-local-variable-values'.
2764 ;; If caller wants only the safe variables,
2765 ;; install only them.
2770 ;; Query, except in the case where all are known safe
2771 ;; if the user wants no quuery in that case.
2777 result unsafe-vars risky-vars))
2783 "Non-nil if SYM is safe as a file-local variable with value VAL.
2784 It is safe if any of these conditions are met:
2786 * There is a matching entry (SYM . VAL) in the
2787 `safe-local-variable-values' user option.
2789 * The `safe-local-variable' property of SYM is a function that
2790 evaluates to a non-nil value with VAL as an argument."
2796 "Non-nil if SYM could be dangerous as a file-local variable.
2797 It is dangerous if either of these conditions are met:
2799 * Its `risky-local-variable' property is non-nil.
2805 ;; If this is an alias, check the base name.
2825 "Return t if it is safe to eval EXP when it is found in a file."
2827 ;; Detect certain `put' expressions.
2833 ;; Only allow safe values of lisp-indent-hook;
2834 ;; not functions.
2837 ;; Only allow indirect form specs.
2838 ;; During bootstrapping, edebug-basic-spec might not be
2839 ;; defined yet.
2843 ;; Allow expressions that the user requested.
2845 ;; Certain functions can be allowed with safe arguments
2846 ;; or can specify verification functions to try.
2854 ok))
2862 ok)))))))
2865 "Set local variable VAR with value VAL.
2866 If VAR is `mode', call `VAL-mode' as a function unless it's
2867 already the major mode."
2877 ;; Make sure the string has no text properties.
2878 ;; Some text properties can get evaluated in various ways,
2879 ;; so it is risky to put them on with a local variable list.
2884 \f
2887 However, the mode will not be changed if
2888 \(1) a local variables list or the `-*-' line specifies a major mode, or
2890 \ not suitable for ordinary files, or
2891 \(3) the new file name does not particularly specify any mode."
2896 "Change name of file visited in current buffer to FILENAME.
2897 This also renames the buffer to correspond to the new file.
2898 The next time the buffer is saved it will go in the newly specified file.
2899 FILENAME nil or an empty string means mark buffer as not visiting any file.
2900 Remember to delete the initial contents of the minibuffer
2901 if you wish to pass an empty string as the argument.
2903 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2904 confirmation in the case where another buffer is already visiting FILENAME.
2906 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2907 the old visited file has been renamed to the new name FILENAME."
2915 nil
2930 filename)))
2942 ;; If new-name == old-name, renaming would add a spurious <2>
2943 ;; and it's considered as a feature in rename-buffer.
2949 ;; Abbreviate the file names of the buffer.
2958 nil)))
2959 ;; write-file-functions is normally used for things like ftp-find-file
2960 ;; that visit things that are not local files as if they were files.
2961 ;; Changing to visit an ordinary local file instead should flush the hook.
2966 ;; If buffer was read-only because of version control,
2967 ;; that reason is gone now, so make it writable.
2971 ;; Turn off backup files for certain file names.
2972 ;; Since this is a permanent local, the major mode won't eliminate it.
2974 backup-enable-predicate
2980 ;; If auto-save was not already on, turn it on if appropriate.
2984 ;; If auto save is on, start using a new name.
2985 ;; We deliberately don't rename or delete the old auto save
2986 ;; for the old visited file name. This is because perhaps
2987 ;; the user wants to save the new state and then compare with the
2988 ;; previous state from the auto save file.
2991 ;; Rename the old auto save file if any.
2998 ;; Update the major mode, if the file name determines it.
3000 ;; Don't change the mode if it is special.
3003 ;; Don't change the mode if the local variable list specifies it.
3009 "Write current buffer into file FILENAME.
3010 This makes the buffer visit that file, and marks it as not modified.
3012 If you specify just a directory name as FILENAME, that means to use
3013 the default file name but in that directory. You can also yank
3014 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3016 If the buffer is not already visiting a file, the default file name
3017 for the output file is the buffer name.
3019 If optional second arg CONFIRM is non-nil, this function
3020 asks for confirmation before overwriting an existing file.
3021 Interactively, confirmation is required unless you supply a prefix argument."
3022 ;; (interactive "FWrite file: ")
3026 nil nil nil nil)
3030 default-directory)
3031 nil nil))
3035 ;; If arg is just a directory,
3036 ;; use the default file name, but in that directory.
3047 ;; Make buffer writable if file is writable.
3052 ;; It's likely that the VC status at the new location is different from
3053 ;; the one at the old location.
3055 \f
3057 "Make a backup of the disk file visited by the current buffer, if appropriate.
3058 This is normally done before saving the buffer the first time.
3060 A backup may be done by renaming or by copying; see documentation of
3061 variable `make-backup-files'. If it's done by renaming, then the file is
3062 no longer accessible under its old name.
3064 The value is non-nil after a backup was made by renaming.
3065 It has the form (MODES . BACKUPNAME).
3066 MODES is the result of `file-modes' on the original
3067 file; this means that the caller, after saving the buffer, should change
3068 the modes of the new file to agree with the old modes.
3069 BACKUPNAME is the backup file name, which is the old file renamed."
3076 backup-info backupname targets setmodes)
3077 ;; If specified name is a symbolic link, chase it to the target.
3078 ;; Thus we make the backups in the directory where the real file is.
3083 ;; (if (file-directory-p buffer-file-name)
3084 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3088 ;; If have old versions to maybe delete,
3089 ;; ask the user to confirm now, before doing anything.
3090 ;; But don't actually delete til later.
3095 real-file-name)))))
3097 ;; Actually write the back up file.
3100 ; (file-symlink-p buffer-file-name)
3101 backup-by-copying
3102 ;; Don't rename a suid or sgid file.
3117 ;; rename-file should delete old backup.
3121 ;; If trouble writing the backup, write it in ~.
3126 backupname)
3130 ;; Now delete the old versions, if desired.
3137 setmodes)
3144 ;; Create temp files with strict access rights. It's easy to
3145 ;; loosen them later, whereas it's impossible to close the
3146 ;; time-window of loose permissions otherwise.
3149 ;; Try to overwrite old backup first.
3157 nil)
3159 ;; The file was somehow created by someone else between
3160 ;; `delete-file' and `copy-file', so let's try again.
3161 ;; rms says "I think there is also a possible race
3162 ;; condition for making backup files" (emacs-devel 20070821).
3163 nil)))
3164 ;; Reset the umask.
3170 "Return file NAME sans backup versions or strings.
3171 This is a separate procedure so your site-init or startup file can
3172 redefine it.
3173 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3174 we do not remove backup version numbers, only true file version numbers."
3180 ;; VMS version number is (a) semicolon, optional
3181 ;; sign, zero or more digits or (b) period, option
3182 ;; sign, zero or more digits, provided this is the
3183 ;; second period encountered outside of the
3184 ;; device/directory part of the file name.
3187 name)
3197 "Return t if deleting FILE and rewriting it would preserve the owner."
3202 ;; Return t if the file doesn't exist, since it's true that no
3203 ;; information would be lost by an (attempted) delete and create.
3209 The extension, in a file name, is the part that follows the last `.',
3210 except that a leading `.', if any, doesn't count."
3213 directory)
3217 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3218 ;; we don't want to expand it.
3221 filename))))
3225 The extension, in a file name, is the part that follows the last `.',
3226 excluding version numbers and backup suffixes,
3227 except that a leading `.', if any, doesn't count.
3228 Return nil for extensionless file names such as `foo'.
3229 Return the empty string for file names such as `foo.'.
3231 If PERIOD is non-nil, then the returned value includes the period
3232 that delimits the extension, and if FILENAME has no extension,
3243 "A function to use instead of the default `make-backup-file-name'.
3244 A value of nil gives the default `make-backup-file-name' behavior.
3246 This could be buffer-local to do something special for specific
3247 files. If you define it, you may need to change `backup-file-name-p'
3248 and `file-name-sans-versions' too.
3250 See also `backup-directory-alist'."
3256 "Alist of filename patterns and backup directory names.
3257 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3258 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3259 relative or absolute. If it is absolute, so that all matching files
3260 are backed up into the same directory, the file names in this
3261 directory will be the full name of the file backed up with all
3262 directory separators changed to `!' to prevent clashes. This will not
3263 work correctly if your filesystem truncates the resulting name.
3265 For the common case of all backups going into one directory, the alist
3267 directory name.
3269 If this variable is nil, or it fails to match a filename, the backup
3270 is made in the original file's directory.
3272 On MS-DOS filesystems without long names this variable is always
3273 ignored."
3279 "Default `backup-enable-predicate' function.
3280 Checks for files in `temporary-file-directory',
3281 `small-temporary-file-directory', and /tmp."
3284 ;; Directory is under temporary-file-directory.
3289 ;; Directory is under /tmp.
3294 0 nil
3296 ;; Directory is under small-temporary-file-directory.
3301 "Create the non-numeric backup file name for FILE.
3302 Normally this will just be the file's name with `~' appended.
3303 Customization hooks are provided as follows.
3305 If the variable `make-backup-file-name-function' is non-nil, its value
3306 should be a function which will be called with FILE as its argument;
3307 the resulting name is used.
3309 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3310 the documentation of that variable. If the directory for the backup
3311 doesn't exist, it is created."
3325 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3327 elt backup-directory abs-backup-directory)
3332 alist nil)))
3333 ;; If backup-directory is relative, it should be relative to the
3334 ;; file's directory. By expanding explicitly here, we avoid
3335 ;; depending on default-directory.
3344 abs-backup-directory nil))))
3346 file
3350 ;; Normalize DOSish file names: downcase the drive
3351 ;; letter, if any, and replace the leading "x:" with
3352 ;; "/drive_x".
3355 ;; Replace any invalid file-name characters (for the
3356 ;; case of backing up remote files).
3360 "drive_"
3363 ""
3366 ;; Make the name unique by substituting directory
3367 ;; separators. It may not really be worth bothering about
3368 ;; doubling `!'s in the original name...
3373 backup-directory))
3378 "Return non-nil if FILE is a backup file name (numeric or not).
3379 This is a separate function so you can redefine it for customization.
3380 You may need to redefine `file-name-sans-versions' as well."
3385 ;; This is used in various files.
3386 ;; The usage of backup-extract-version-start is not very clean,
3387 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3389 "Given the name of a numeric backup file, FN, return the backup number.
3390 Uses the free variable `backup-extract-version-start', whose value should be
3391 the index in the name where the version number begins."
3397 ;; I believe there is no need to alter this behavior for VMS;
3398 ;; since backup files are not made on VMS, it should not get called.
3400 "Find a file name for a backup file FN, and suggestions for deletions.
3401 Value is a list whose car is the name for the backup file
3402 and whose cdr is a list of old versions to consider deleting now.
3403 If the value is nil, don't make a backup.
3404 Uses `backup-directory-alist' in the same way as does
3405 `make-backup-file-name'."
3407 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3411 ;; We don't support numbered backups on plain MS-DOS
3412 ;; when long file names are unavailable.
3422 possibilities deserve-versions-p versions)
3425 base-versions
3428 possibilities)
3429 #'<)
3434 kept-old-versions
3435 kept-new-versions
3442 ;; Delete nothing if there is overflow
3443 ;; in the number of versions to keep.
3449 v))))))))))
3452 "Return number of names file FILENAME has."
3455 ;; (defun file-relative-name (filename &optional directory)
3456 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3457 ;; This function returns a relative file name which is equivalent to FILENAME
3458 ;; when used with that default directory as the default.
3459 ;; If this is impossible (which can happen on MSDOS and Windows
3460 ;; when the file name and directory use different drive names)
3461 ;; then it returns FILENAME."
3462 ;; (save-match-data
3463 ;; (let ((fname (expand-file-name filename)))
3464 ;; (setq directory (file-name-as-directory
3465 ;; (expand-file-name (or directory default-directory))))
3466 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3467 ;; ;; drive names, they can't be relative, so return the absolute name.
3468 ;; (if (and (or (eq system-type 'ms-dos)
3469 ;; (eq system-type 'cygwin)
3470 ;; (eq system-type 'windows-nt))
3471 ;; (not (string-equal (substring fname 0 2)
3472 ;; (substring directory 0 2))))
3473 ;; filename
3474 ;; (let ((ancestor ".")
3475 ;; (fname-dir (file-name-as-directory fname)))
3476 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3477 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3478 ;; (setq directory (file-name-directory (substring directory 0 -1))
3479 ;; ancestor (if (equal ancestor ".")
3480 ;; ".."
3481 ;; (concat "../" ancestor))))
3482 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3483 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3484 ;; ;; We matched within FNAME's directory part.
3485 ;; ;; Add the rest of FNAME onto ANCESTOR.
3486 ;; (let ((rest (substring fname (match-end 0))))
3487 ;; (if (and (equal ancestor ".")
3488 ;; (not (equal rest "")))
3489 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3490 ;; rest
3491 ;; (concat (file-name-as-directory ancestor) rest)))
3492 ;; ;; We matched FNAME's directory equivalent.
3493 ;; ancestor))))))
3496 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3497 This function returns a relative file name which is equivalent to FILENAME
3498 when used with that default directory as the default.
3499 If FILENAME and DIRECTORY lie on different machines or on different drives
3500 on a DOS/Windows machine, it returns FILENAME in expanded form."
3504 default-directory))))
3510 ;; Test for different drives on DOS/Windows
3512 ;; Should `cygwin' really be included here? --stef
3515 ;; Test for different remote file system identification
3517 filename
3523 directory nil nil case-fold-search))
3525 directory nil nil case-fold-search))))
3528 ".."
3530 ;; Now ancestor is empty, or .., or ../.., etc.
3532 directory nil nil case-fold-search))
3533 ;; We matched within FILENAME's directory part.
3534 ;; Add the rest of FILENAME onto ANCESTOR.
3537 ;; But don't bother with ANCESTOR if it would give us `./'.
3538 rest
3540 ;; We matched FILENAME's directory equivalent.
3541 ancestor))))))
3542 \f
3544 "Save current buffer in visited file if modified.
3545 Variations are described below.
3547 By default, makes the previous version into a backup file
3548 if previously requested or if this is the first save.
3550 to become a backup when the next save is done.
3552 unconditionally makes the previous version into a backup file.
3554 to become a backup when the next save is done,
3555 and unconditionally makes the previous version into a backup file.
3557 With a numeric argument of 0, never make the previous version
3558 into a backup file.
3560 If a file's name is FOO, the names of its numbered backup versions are
3561 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3562 Numeric backups (rather than FOO~) will be made if value of
3563 `version-control' is not the atom `never' and either there are already
3564 numeric versions of the file being backed up, or `version-control' is
3565 non-nil.
3566 We don't want excessive versions piling up, so there are variables
3567 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3568 and `kept-new-versions', which tells how many newest versions to keep.
3569 Defaults are 2 old versions and 2 new.
3570 `dired-kept-versions' controls dired's clean-directory (.) command.
3571 If `delete-old-versions' is nil, system will query user
3572 before trimming versions. Otherwise it does it silently.
3574 If `vc-make-backup-files' is nil, which is the default,
3575 no backup files are made for files managed by version control.
3576 (This is because the version control system itself records previous versions.)
3578 See the subroutine `basic-save-buffer' for more information."
3591 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3592 Normally delete only if the file was written by this Emacs since
3593 the last real save, but optional arg FORCE non-nil means delete anyway."
3607 "Normal hook that is run before a buffer is saved to its file."
3613 "Normal hook that is run after a buffer is saved to its file."
3619 "If non-nil, use this coding system for saving the buffer.
3620 More precisely, use this coding system in place of the
3621 value of `buffer-file-coding-system', when saving the buffer.
3622 Calling `write-region' for any purpose other than saving the buffer
3623 will still use `buffer-file-coding-system'; this variable has no effect
3630 "Save the current buffer in its visited file, if it has been modified.
3631 The hooks `write-contents-functions' and `write-file-functions' get a chance
3632 to do the job of saving; if they do not, then the buffer is saved in
3633 the visited file in the usual way.
3634 Before and after saving the buffer, this function runs
3635 `before-save-hook' and `after-save-hook', respectively."
3638 ;; In an indirect buffer, save its base buffer instead.
3643 setmodes)
3644 ;; On VMS, rename file and buffer to get rid of version number.
3649 ;; Strip VMS version number before save.
3652 ;; Construct a (unique) buffer name to correspond.
3657 ;; If buffer has no file name, ask user for one.
3664 ;; Signal an error if the user specified the name of an
3665 ;; existing directory.
3668 filename))
3670 ;; Signal an error if the specified name refers to a
3671 ;; non-existing directory.
3701 ;; Support VC version backups.
3707 ;; If a hook returned t, file is already "written".
3708 ;; Otherwise, write it the usual way now.
3710 ;; Now we have saved the current buffer. Let's make sure
3711 ;; that buffer-file-coding-system is fixed to what
3712 ;; actually used for saving by binding it locally.
3722 ;; If the auto-save file was recent before this command,
3723 ;; delete it now.
3725 ;; Support VC `implicit' locking.
3730 ;; This does the "real job" of writing a buffer into its visited file
3731 ;; and making a backup file. This is what is normally done
3732 ;; but inhibited if one of write-file-functions returns non-nil.
3733 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3742 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3756 buffer-file-name)))
3764 ;; If file is precious, write temp name, then rename it.
3765 ;; This requires write access to the containing dir,
3766 ;; which is why we don't try it if we don't have that access.
3768 tempname succeed
3771 ;; Create temp files with strict access rights. It's easy to
3772 ;; loosen them later, whereas it's impossible to close the
3773 ;; time-window of loose permissions otherwise.
3778 ;; Try various temporary names.
3779 ;; This code follows the example of make-temp-file,
3780 ;; but it calls write-region in the appropriate way
3781 ;; for saving the buffer.
3788 tempname nil realname
3790 nil)
3792 ;; The file was somehow created by someone else between
3793 ;; `make-temp-name' and `write-region', let's try again.
3794 nil)
3796 ;; Reset the umask.
3798 ;; If we failed, restore the buffer's modtime.
3801 ;; Since we have created an entirely new file,
3802 ;; make sure it gets the right permission bits set.
3806 buffer-file-name)))
3807 ;; We succeeded in writing the temp file,
3808 ;; so rename it.
3810 ;; If file not writable, see if we can make it writable
3811 ;; temporarily while we write it.
3812 ;; But no need to do so if we have just backed it up
3813 ;; (setmodes is set) because that says we're superseding.
3815 ;; Change the mode back, after writing.
3822 buffer-file-name nil t buffer-file-truename)
3824 ;; If we get an error writing the new file, and we made
3825 ;; the backup by renaming, undo the backing-up.
3830 setmodes))
3833 "View the differences between BUFFER and its associated file.
3834 This requires the external program `diff' to be in your `exec-path'."
3849 ;; Display that message for 1 second so that user can read it
3850 ;; in the minibuffer.
3852 ;; return always nil, so that save-buffers-kill-emacs will not move
3853 ;; over to the next unsaved buffer when calling `d'.
3854 nil)
3857 '((?\C-r
3863 ;; Return nil to ask about BUF again.
3864 nil)
3872 nil)
3881 "Save some modified file-visiting buffers. Asks user about each one.
3882 You can answer `y' to save, `n' not to save, `C-r' to look at the
3883 buffer in question with `view-buffer' before deciding or `d' to
3884 view the differences using `diff-buffer-with-file'.
3886 Optional argument (the prefix) non-nil means save all with no questions.
3887 Optional second argument PRED determines which buffers are considered:
3888 If PRED is nil, all the file-visiting buffers are considered.
3889 If PRED is t, then certain non-file buffers will also be considered.
3890 If PRED is a zero-argument function, it indicates for each buffer whether
3891 to consider it or not when called with that buffer current.
3893 See `save-some-buffers-action-alist' if you want to
3894 change the additional actions you can take on files."
3898 files-done abbrevs-done)
3900 ;; First save any buffers that we're supposed to save unconditionally.
3901 ;; That way the following code won't ask about them.
3906 ;; Ask about those buffers that merit it,
3907 ;; and record the number thus saved.
3923 t
3936 save-some-buffers-action-alist))
3937 ;; Maybe to save abbrevs, and record whether
3938 ;; we either saved them or asked to.
3944 abbrev-file-name)))
3946 ;; Don't keep bothering user if he says no.
3951 "(Some special files were saved without asking)"
3953 \f
3955 "Mark current buffer as unmodified, not needing to be saved.
3958 It is not a good idea to use this function in Lisp programs, because it
3959 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3966 "Change whether this buffer is visiting its file read-only.
3967 With prefix argument ARG, make the buffer read-only if ARG is
3968 positive, otherwise make it writable. If visiting file read-only
3969 and `view-read-only' is non-nil, enter view mode."
3974 nil ; do nothing.
3975 ;; Toggle.
3982 ;; If view-mode is already active, `view-mode-enter' is a nop.
3994 "Insert contents of file FILENAME into buffer after point.
3995 Set mark after the inserted text.
3997 This function is meant for the user to run interactively.
3998 Don't call it from programs! Use `insert-file-contents' instead.
3999 \(Its calling sequence is different; see its documentation)."
4004 "Append the contents of the region to the end of file FILENAME.
4005 When called from a function, expects three arguments,
4006 START, END and FILENAME. START and END are buffer positions
4007 saying what text to write."
4012 "Return most recent backup file for FILENAME or nil if no backups exist."
4013 ;; `make-backup-file-name' will get us the right directory for
4014 ;; ordinary or numeric backups. It might create a directory for
4015 ;; backups as a side-effect, according to `backup-directory-alist'.
4022 tem)
4031 newest))
4034 "Rename current buffer to a similar name not already taken.
4035 This function is useful for creating multiple shell process buffers
4036 or multiple mail buffers, etc."
4044 ;; If the existing buffer name has a <NNN>,
4045 ;; which isn't part of the file name (if any),
4046 ;; then get rid of that.
4052 "Create the directory DIR and any nonexistent parent dirs.
4053 Interactively, the default choice of directory to create
4054 is the current default directory for file names.
4055 That is useful when you have visited a file in a nonexistent directory.
4057 Noninteractively, the second (optional) argument PARENTS says whether
4058 to create parent directories if they don't exist. Interactively,
4059 this happens by default."
4062 nil nil)
4063 t))
4064 ;; If default-directory is a remote directory,
4065 ;; make sure we find its make-directory handler.
4073 create-list)
4080 \f
4083 "Function to use to revert this buffer, or nil to do the default.
4084 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4089 "Function to use to insert contents when reverting this buffer.
4090 Gets two args, first the nominal file name to use,
4091 and second, t if reading the auto-save file.
4096 "Function to check whether a non-file buffer needs reverting.
4097 This should be a function with one optional argument NOCONFIRM.
4098 Auto Revert Mode passes t for NOCONFIRM. The function should return
4099 non-nil if the buffer should be reverted. A return value of
4100 `fast' means that the need for reverting was not checked, but
4101 that reverting the buffer is fast. The buffer is current when
4102 this function is called.
4104 The idea behind the NOCONFIRM argument is that it should be
4105 non-nil if the buffer is going to be reverted without asking the
4106 user. In such situations, one has to be careful with potentially
4107 time consuming operations.
4109 For more information on how this variable is used by Auto Revert mode,
4113 "Normal hook for `revert-buffer' to run before reverting.
4114 If `revert-buffer-function' is used to override the normal revert
4118 "Normal hook for `revert-buffer' to run after reverting.
4119 Note that the hook value that it runs is the value that was in effect
4120 before reverting; that makes a difference if you have buffer-local
4121 hook functions.
4123 If `revert-buffer-function' is used to override the normal revert
4129 "Replace current buffer text with the text of the visited file on disk.
4130 This undoes all changes since the file was visited or saved.
4131 With a prefix argument, offer to revert from latest auto-save file, if
4132 that is more recent than the visited file.
4134 This command also works for special buffers that contain text which
4135 doesn't come from a file, but reflects some other data base instead:
4136 for example, Dired buffers and `buffer-list' buffers. In these cases,
4137 it reconstructs the buffer contents from the appropriate data base.
4139 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4140 to revert from the auto-save file when this is nil. Note that the
4141 sense of this argument is the reverse of the prefix argument, for the
4142 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4143 to nil.
4145 Optional second argument NOCONFIRM means don't ask for confirmation at
4146 all. \(The variable `revert-without-query' offers another way to
4147 revert buffers without querying for confirmation.)
4149 Optional third argument PRESERVE-MODES non-nil means don't alter
4150 the files modes. Normally we reinitialize them using `normal-mode'.
4152 If the value of `revert-buffer-function' is non-nil, it is called to
4153 do all the work for this command. Otherwise, the hooks
4154 `before-revert-hook' and `after-revert-hook' are run at the beginning
4155 and the end, and if `revert-buffer-insert-file-contents-function' is
4156 non-nil, it is called instead of rereading visited file contents."
4158 ;; I admit it's odd to reverse the sense of the prefix argument, but
4159 ;; there is a lot of code out there which assumes that the first
4160 ;; argument should be t to avoid consulting the auto-save file, and
4161 ;; there's no straightforward way to encourage authors to notice a
4162 ;; reversal of the argument sense. So I'm just changing the user
4163 ;; interface, but leaving the programmatic interface the same.
4171 buffer-auto-save-file-name
4176 buffer-auto-save-file-name
4177 buffer-file-name)))
4187 file-name)))
4189 ;; If file was backed up but has changed since,
4190 ;; we shd make another backup.
4194 ;; Effectively copy the after-revert-hook status,
4195 ;; since after-find-file will clobber it.
4198 after-revert-hook))
4203 ;; Get rid of all undo records for this buffer.
4205 ;; Don't make undo records for the reversion.
4208 file-name auto-save-p)))
4211 "File %s no longer exists!"
4213 file-name))
4216 "File %s no longer readable!"
4218 file-name))
4220 ;; Bind buffer-file-name to nil
4221 ;; so that we don't try to lock the file.
4227 ;; Auto-saved file should be read by Emacs'
4228 ;; internal coding.
4231 buffer-file-coding-system-explicit))))
4233 coding-system-for-read
4235 coding-system-for-read)
4237 ;; As a coding system suitable for multibyte
4238 ;; buffer is specified, make the current
4239 ;; buffer multibyte.
4242 ;; This force after-insert-file-set-coding
4243 ;; (called from insert-file-contents) to set
4244 ;; buffer-file-coding-system to a proper value.
4247 ;; Note that this preserves point in an intelligent way.
4251 nil nil t))
4253 nil nil t)))))
4254 ;; Recompute the truename in case changes in symlinks
4255 ;; have changed the truename.
4259 ;; Run after-revert-hook as it was before we reverted.
4263 local-hook)
4266 t))))))
4269 "Recover the visited file--get contents from its last auto-save file."
4274 "Visit file FILE, but get contents from its last auto-save file."
4275 ;; Actually putting the file name in the minibuffer should be used
4276 ;; only rarely.
4277 ;; Not just because users often use the default.
4297 ;; Use insert-directory-safely, not insert-directory,
4298 ;; because these files might not exist. In particular,
4299 ;; FILE might not exist if the auto-save file was for
4300 ;; a buffer that didn't visit a file, such as "*mail*".
4301 ;; The code in v20.x called `ls' directly, so we need
4302 ;; to emulate what `ls' did in that case.
4308 ;; Keep the current buffer-file-coding-system.
4310 ;; Auto-saved file should be read with special coding.
4319 "Recover auto save files from a previous Emacs session.
4320 This command first displays a Dired buffer showing you the
4321 previous sessions that you could recover from.
4322 To choose one, move point to the proper line and then type C-c C-c.
4323 Then you'll be asked about a number of files to recover."
4333 auto-save-list-file-prefix)))
4334 t)
4343 ;; Each line starts with a space
4344 ;; so that Font Lock mode won't highlight the first character.
4353 "Choose one saved session to recover auto-save files from.
4354 This command is used in the special Dired buffer created by
4357 ;; Get the name of the session file to recover from.
4359 files
4365 ;; Read in the auto-save-list file.
4369 ;; Loop thru the text of that file
4370 ;; and get out the names of the files to recover.
4374 ;; This is a pair of lines for a non-file-visiting buffer.
4375 ;; Get the auto-save file name and manufacture
4376 ;; a "visited file name" from that.
4379 ;; If there is no auto-save file name, the
4380 ;; auto-save-list file is probably corrupted.
4393 ;; This pair of lines is a file-visiting
4394 ;; buffer. Use the visited file name.
4404 ;; Ignore a file if its auto-save file does not exist now.
4408 ;; The file contains a pair of line for each auto-saved buffer.
4409 ;; The first line of the pair contains the visited file name
4410 ;; or is empty if the buffer was not visiting a file.
4411 ;; The second line is the auto-save file name.
4419 files
4425 "Kill some buffers. Asks the user whether to kill each one of them.
4426 Non-interactively, if optional argument LIST is non-nil, it
4427 specifies the list of buffers to kill, asking for approval for each one."
4435 ; if we killed the base buffer.
4440 name
4445 \f
4447 "Toggle auto-saving of contents of current buffer.
4448 With prefix argument ARG, turn auto-saving on if positive, else off."
4453 ;; If auto-save is off because buffer has shrunk,
4454 ;; then toggling should turn it on.
4459 buffer-file-name
4461 ;; If -1 was stored here, to temporarily turn off saving,
4462 ;; turn it back on.
4468 buffer-auto-save-file-name)
4471 "Adjust current buffer's auto save file name for current conditions.
4472 Also rename any existing auto save file, if it was made in this session."
4484 "Return file name to use for auto-saves of current buffer.
4485 Does not consider `auto-save-visited-file-name' as that variable is checked
4486 before calling this function. You can redefine this for customization.
4487 See also `auto-save-file-name-p'."
4495 result uniq)
4496 ;; Apply user-specified translations
4497 ;; to the file name.
4501 filename)
4511 filename))))
4516 ;; We truncate the file name to DOS 8+3 limits
4517 ;; before doing anything else, because the regexp
4518 ;; passed to string-match below cannot handle
4519 ;; extensions longer than 3 characters, multiple
4520 ;; dots, and other atrocities.
4525 fn)
4530 "#"
4533 ;; Make sure auto-save file names don't contain characters
4534 ;; invalid for the underlying filesystem.
4536 ;; Don't modify remote (ange-ftp) filenames
4539 result))))
4541 ;; Deal with buffers that don't have any associated files. (Mail
4542 ;; mode tends to create a good number of these.)
4546 file-name)
4547 ;; Eliminate all slashes and backslashes by
4548 ;; replacing them with sequences that start with %.
4549 ;; Quote % also, to keep distinct names distinct.
4558 ;; Generate the file name.
4564 ;; Try a few alternative directories, to get one we can
4565 ;; write it.
4571 ;; Don't modify remote (ange-ftp) filenames
4573 ;; The call to convert-standard-filename is in case
4574 ;; buffer-name includes characters not allowed by the
4575 ;; DOS/Windows filesystems. make-temp-file writes to the
4576 ;; file it creates, so we must fix the file name _before_
4577 ;; make-temp-file is called.
4579 fname))
4581 ;; make-temp-file creates the file,
4582 ;; but we don't want it to exist until we do an auto-save.
4586 file-name)))
4589 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4590 FILENAME should lack slashes. You can redefine this for customization."
4592 \f
4594 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4595 The generated regexp will match a filename only if the filename
4596 matches that wildcard according to shell rules. Only wildcards known
4597 by `sh' are supported."
4599 ;; Copy the initial run of non-special characters.
4602 ;; If no special characters, we're almost done.
4606 j)
4608 result
4629 ;; Found "[^". Insert a `\0' character
4630 ;; (which cannot happen in a filename)
4631 ;; into the character class, so that `^'
4632 ;; is not the first character after `[',
4633 ;; and thus non-special in a regexp.
4638 ;; I don't think `]' can appear in a
4639 ;; character class in a wildcard, but
4640 ;; let's be general here.
4647 i
4660 ;; Shell wildcards should match the entire filename,
4661 ;; not its part. Make the regexp say so.
4663 \f
4666 "Switches for `list-directory' to pass to `ls' for brief listing."
4672 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4674 "Switches for `list-directory' to pass to `ls' for verbose listing."
4679 "Expand wildcard pattern PATTERN.
4680 This returns a list of file names which match the pattern.
4682 If PATTERN is written as an absolute file name,
4683 the values are absolute also.
4685 If PATTERN is written as a relative file name, it is interpreted
4686 relative to the current default directory, `default-directory'.
4687 The file names returned are normally also relative to the current
4688 default directory. However, if FULL is non-nil, they are absolute."
4692 ;; A list of all dirs that DIRPART specifies.
4693 ;; This can be more than one dir
4694 ;; if DIRPART contains wildcards.
4699 contents)
4704 ;; Filter out "." and ".."
4709 name))
4716 this-dir-contents)
4717 this-dir-contents)
4718 contents))))
4720 contents)))
4723 "Display a list of files in or matching DIRNAME, a la `ls'.
4724 DIRNAME is globbed by the shell if necessary.
4725 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4726 Actions controlled by variables `list-directory-brief-switches'
4727 and `list-directory-verbose-switches'."
4731 nil default-directory nil)
4732 pfx)))
4734 list-directory-brief-switches))
4735 buffer)
4748 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4756 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4758 PATTERN is assumed to represent a file-name wildcard suitable for the
4759 underlying filesystem. For Unix and GNU/Linux, the characters from the
4761 the parts of the pattern which don't include wildcard characters are
4762 quoted with double quotes.
4763 Existing quote characters in PATTERN are left alone, so you can pass
4764 PATTERN that already quotes some of the special characters."
4768 ;; DOS/Windows don't allow `"' in file names. So if the
4769 ;; argument has quotes, we can safely assume it is already
4770 ;; quoted by the caller.
4772 ;; We quote [&()#$'] in case their shell is a port of a
4773 ;; Unixy shell. We quote [,=+] because stock DOS and
4774 ;; Windows shells require that in some cases, such as
4775 ;; passing arguments to batch files that use positional
4776 ;; arguments like %1.
4778 pattern
4781 end)
4798 pattern))))
4805 "Program to get the amount of free space on a file system.
4806 We assume the output has the format of `df'.
4807 The value of this variable must be just a command name or file name;
4808 if you want to specify options, use `directory-free-space-args'.
4810 A value of nil disables this feature.
4812 If the function `file-system-info' is defined, it is always used in
4813 preference to the program given by this variable."
4819 "Options to use when running `directory-free-space-program'."
4824 "Return the amount of free space on directory DIR's file system.
4825 The result is a string that gives the number of free 1KB blocks,
4826 or nil if the system call or the program which retrieve the information
4827 fail. It returns also nil when DIR is a remote directory.
4829 This function calls `file-system-info' if it is available, or invokes the
4830 program specified by `directory-free-space-program' if that is non-nil."
4832 ;; Try to find the number of free blocks. Non-Posix systems don't
4833 ;; always have df, but might have an equivalent system call.
4842 nil t nil
4843 directory-free-space-args
4844 dir)))
4845 ;; Usual format is a header line followed by a line of
4846 ;; numbers.
4851 ;; Move to the end of the "available blocks" number.
4854 ;; Copy it into AVAILABLE.
4859 ;; The following expression replaces `dired-move-to-filename-regexp'.
4863 ;; In some locales, month abbreviations are as short as 2 letters,
4864 ;; and they can be followed by ".".
4865 ;; In Breton, a month name can include a quote character.
4878 s "+"
4881 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4882 ;; omits the Kanji characters after month and day-of-month.
4883 ;; On Mac OS X 10.3, the date format in East Asian locales is
4884 ;; day-of-month digits followed by month digits.
4890 ;; The "[0-9]" below requires the previous column to end in a digit.
4891 ;; This avoids recognizing `1 may 1997' as a date in the line:
4892 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4894 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4895 ;; The ".*" below finds the last match if there are multiple matches.
4896 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4897 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4899 ;; vc dired listings provide the state or blanks between file
4900 ;; permissions and date. The state is always surrounded by
4901 ;; parantheses:
4902 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4903 ;; This is not supported yet.
4907 "Regular expression to match up to the file name in a directory listing.
4908 The default value is designed to recognize dates and times
4913 ;; insert-directory
4914 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4915 ;; FULL-DIRECTORY-P is nil.
4916 ;; The single line of output must display FILE's name as it was
4917 ;; given, namely, an absolute path name.
4918 ;; - must insert exactly one line for each file if WILDCARD or
4919 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4920 ;; before the file lines, plus optional text after the file lines.
4921 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4922 ;; allowed.
4923 ;; File lines should display the basename.
4924 ;; - must be consistent with
4925 ;; - functions dired-move-to-filename, (these two define what a file line is)
4926 ;; dired-move-to-end-of-filename,
4927 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4928 ;; dired-insert-headerline
4929 ;; dired-after-subdir-garbage (defines what a "total" line is)
4930 ;; - variable dired-subdir-regexp
4931 ;; - may be passed "--dired" as the first argument in SWITCHES.
4932 ;; Filename handlers might have to remove this switch if their
4933 ;; "ls" command does not support it.
4935 "Insert directory listing for FILE, formatted according to SWITCHES.
4936 Leaves point after the inserted text.
4937 SWITCHES may be a string of options, or a list of strings
4938 representing individual options.
4939 Optional third arg WILDCARD means treat FILE as shell wildcard.
4940 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4941 switches do not contain `d', so that a full listing is expected.
4943 This works by running a directory listing program
4944 whose name is in the variable `insert-directory-program'.
4945 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4947 When SWITCHES contains the long `--dired' option, this function
4948 treats it specially, for the sake of dired. However, the
4949 normally equivalent short `-D' option is just passed on to
4950 `insert-directory-program', as any other option."
4951 ;; We need the directory in order to find the right handler.
4956 wildcard full-directory-p)
4961 ;; Read the actual directory using `insert-directory-program'.
4962 ;; RESULT gets the status code.
4964 ;; putting text property `dired-filename, decode one
4965 ;; bunch by one to preserve that property.
4967 ;; This is to control encoding the arguments in call-process.
4971 default-file-name-coding-system))))
4974 ;; Run ls in the directory part of the file pattern
4975 ;; using the last component as argument.
4982 shell-file-name nil t nil
4983 "-c"
4985 ""
4987 insert-directory-program
4988 " -d "
4990 switches
4992 " -- "
4993 ;; Quote some characters that have
4994 ;; special meanings in shells; but
4995 ;; don't quote the wildcards--we want
4996 ;; them to be special. We also
4997 ;; currently don't quote the quoting
4998 ;; characters in case people want to
4999 ;; use them explicitly to quote
5000 ;; wildcard characters.
5002 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5003 ;; directory if FILE is a symbolic link.
5005 insert-directory-program nil t nil
5009 ;; Split the switches at any spaces so we can
5010 ;; pass separate options as separate args.
5012 ;; Avoid lossage if FILE starts with `-'.
5020 file))))))))
5022 ;; If we got "//DIRED//" in the output, it means we got a real
5023 ;; directory listing, even if `ls' returned nonzero.
5024 ;; So ignore any errors.
5037 ;; The first time ls returns an error,
5038 ;; find the version numbers of ls,
5039 ;; and set insert-directory-ls-version
5040 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5041 ;; is equal or if the info cannot be obtained.
5042 ;; (That can mean it isn't GNU ls.)
5052 comparison)
5068 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5072 ;; If `insert-directory-program' failed, signal an error.
5074 ;; Delete the error message it may have output.
5076 ;; On non-Posix systems, we cannot open a directory, so
5077 ;; don't even try, because that will always result in
5078 ;; the ubiquitous "Access denied". Instead, show the
5079 ;; command line so the user can try to guess what went wrong.
5084 insert-directory-program
5086 file result)
5087 ;; Unix. Access the file to get a suitable error.
5094 ;; The following overshoots by one line for an empty
5095 ;; directory listed with "--dired", but without "-a"
5096 ;; switch, where the ls output contains a
5097 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5098 ;; We take care of that case later.
5106 error-lines)
5107 ;; Find all the lines that are error messages,
5108 ;; and record the bounds of each one.
5115 ;; Now read the numeric positions of file names.
5122 error-lines))
5125 error-lines)))
5127 ;; End is followed by \n or by " -> ".
5129 ;; It seems that we can't trust ls's output as to
5130 ;; byte positions of filenames.
5136 ;; Take care of the case where the ls output contains a
5137 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5138 ;; and we went one line too far back (see above).
5143 ;; Now decode what read if necessary.
5145 file-name-coding-system
5146 default-file-name-coding-system
5148 coding-no-eol
5149 val pos)
5153 ;; If no coding system is specified or detection is
5154 ;; requested, detect the coding.
5168 ;; Force no eol conversion on a file name, so
5169 ;; that CR is preserved.
5177 ;; Try to insert the amount of free space.
5180 ;; First find the line to put it on.
5184 ;; Replace "total" with "used", to avoid confusion.
5190 "Convert `ls --dired' file name position value POS to a buffer position.
5191 File name position values returned in ls --dired output
5192 count only stdout; they don't count the error messages sent to stderr.
5193 So this function converts to them to real buffer positions.
5194 ERROR-LINES is a list of buffer positions of error message lines,
5195 of the form (START END)."
5199 pos)
5203 "Insert directory listing for FILE, formatted according to SWITCHES.
5205 Like `insert-directory', but if FILE does not exist, it inserts a
5206 message to that effect instead of signaling an error."
5209 ;; Simulate the message printed by `ls'.
5213 "Functions to call with no arguments to query about killing Emacs.
5214 If any of these functions returns nil, killing Emacs is cancelled.
5216 but `kill-emacs', the low level primitive, does not.
5220 "How to ask for confirmation when leaving Emacs.
5221 If nil, the default, don't ask at all. If the value is non-nil, it should
5222 be a predicate function such as `yes-or-no-p'."
5230 "Offer to save each buffer, then kill this Emacs process.
5231 With prefix arg, silently save all file-visiting buffers, then kill."
5240 ;; process-list is not defined on VMS.
5242 active)
5251 ;; Query the user for other things, perhaps.
5256 \f
5257 ;; We use /: as a prefix to "quote" a file name
5258 ;; so that magic file name handlers will not apply to it.
5262 file-name-handler-alist))
5264 ;; We depend on being the last handler on the list,
5265 ;; so that anything else which does need handling
5266 ;; has been handled already.
5267 ;; So it is safe for us to inhibit *all* magic file name handlers.
5276 default-directory))
5277 ;; Get a list of the indices of the args which are file names.
5280 ;; The first six are special because they
5281 ;; return a file name. We want to include the /:
5282 ;; in the return value.
5283 ;; So just avoid stripping it in the first place.
5290 ;; `identity' means just return the first arg
5291 ;; not stripped of its quoting.
5293 ;; `add' means add "/:" to the result.
5295 ;; `quote' means add "/:" to buffer-file-name.
5297 ;; `unquote-then-quote' means set buffer-file-name
5298 ;; temporarily to unquoted filename.
5300 ;; List the arguments which are filenames.
5308 ;; For all other operations, treat the first argument only
5309 ;; as the file name.
5311 method
5312 ;; Copy ARGUMENTS so we can replace elements in it.
5316 ;; Strip off the /: from the file names that have it.
5324 "/"
5340 res))
5343 \f
5368 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5369 ;;; files.el ends here