| blob | 3313f003d89e099c8606fbca4b0cd26e302e86ec |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
32 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "*Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "*Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 Do not use `~' in the TO strings.
63 They should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
75 ;; Turn off backup files on VMS since it has version numbers.
77 "*Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
106 "*Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
112 "*Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
119 "*Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
129 "*Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
141 "Predicate that looks at a file name and decides whether to make backups.
145 "*Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
153 "*Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
160 "*Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
168 "*Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
199 "The directory for writing temporary files."
205 "The directory for writing small temporary files.
206 If non-nil, this directory is used instead of `temporary-file-directory'
207 by programs that create small temporary files. This is for systems that
208 have fast storage with limited space, such as a RAM disk."
212 ;; The system null device. (Should reference NULL_DEVICE from C.)
229 "*Non-nil means protect against I/O errors while saving files.
230 Some modes set this non-nil in particular buffers.
232 This feature works by writing the new contents into a temporary file
233 and then renaming the temporary file to replace the original.
234 In this way, any I/O error in writing leaves the original untouched,
235 and there is never any instant where the file is nonexistent.
237 Note that this feature forces backups to be made by copying.
238 Yet, at the same time, saving a precious file
239 breaks any hard links between it and other files."
244 "*Control use of version numbers for backup files.
245 t means make numeric backup versions unconditionally.
246 nil means make them for files that have some already.
247 `never' means do not make them."
257 "*When cleaning directory, number of versions to keep."
263 "*If t, delete excess backup versions silently.
264 If nil, ask confirmation. Any other value prevents any trimming."
271 "*Number of oldest versions to keep when a new numbered backup is made."
277 "*Number of newest versions to keep when a new numbered backup is made.
278 Includes the new backup. Must be > 0"
284 "*Whether to add a newline automatically at the end of the file.
286 A value of t means do this only when the file is about to be saved.
287 A value of `visit' means do this right after the file is visited.
288 A value of `visit-save' means do it at both of those times.
289 Any other non-nil value means ask user whether to add a newline, when saving.
290 nil means don't add newlines.
292 Certain major modes set this locally to the value obtained
293 from `mode-require-final-newline'."
302 "*Whether to add a newline at end of file, in certain major modes.
303 Those modes set `require-final-newline' to this value when you enable them.
304 They do so because they are often used for files that are supposed
305 to end in newlines, and the question is how to arrange that.
307 A value of t means do this only when the file is about to be saved.
308 A value of `visit' means do this right after the file is visited.
309 A value of `visit-save' means do it at both of those times.
310 Any other non-nil value means ask user whether to add a newline, when saving.
312 nil means do not add newlines. That is a risky choice in this variable
313 since this value is used for modes for files that ought to have final newlines.
314 So if you set this to nil, you must explicitly check and add
315 a final newline, whenever you save a file that really needs one."
325 "*Non-nil says by default do auto-saving of every file-visiting buffer."
330 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
331 Normally auto-save files are written under other names."
337 ;; Don't put "\\2" inside expand-file-name, since it will be
338 ;; transformed to "/2" on DOS/Windows.
340 "*Transforms to apply to buffer file name before making auto-save file name.
341 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
342 REGEXP is a regular expression to match against the file name.
343 If it matches, `replace-match' is used to replace the
344 matching part with REPLACEMENT.
345 If the optional element UNIQUIFY is non-nil, the auto-save file name is
346 constructed by taking the directory part of the replaced file-name,
347 concatenated with the buffer file name with all directory separators
348 changed to `!' to prevent clashes. This will not work
349 correctly if your filesystem truncates the resulting name.
351 All the transforms in the list are tried, in the order they are listed.
352 When one transform applies, its result is final;
353 no further transforms are tried.
355 The default value is set up to put the auto-save file into the
356 temporary directory (see the variable `temporary-file-directory') for
357 editing a remote file.
359 On MS-DOS filesystems without long names this variable is always
360 ignored."
367 "*Non-nil means save word abbrevs too when files are saved.
368 If `silently', don't ask the user before saving."
373 "*Non-nil means allow `find-file' to visit directories.
374 To visit the directory, `find-file' runs `find-directory-functions'."
379 "*List of functions to try in sequence to visit a directory.
380 Each function is called with the directory name as the sole argument
381 and should return either a buffer or nil."
385 ;;;It is not useful to make this a local variable.
386 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
388 "List of functions to be called for `find-file' on nonexistent file.
389 These functions are called as soon as the error is detected.
390 Variable `buffer-file-name' is already set up.
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-hooks 'permanent-local t)
398 "List of functions to be called after a buffer is loaded from a file.
399 The buffer's local variables (if any) will have been processed before the
400 functions are called."
408 "List of functions to be called before writing out a buffer to a file.
409 If one of them returns non-nil, the file is considered already written
410 and the rest are not called.
411 These hooks are considered to pertain to the visited file.
412 So any buffer-local binding of this variable is discarded if you change
414 change the major mode.
416 This hook is not run if any of the functions in
417 `write-contents-functions' returns non-nil. Both hooks pertain
418 to how to save a buffer to file, for instance, choosing a suitable
419 coding system and setting mode bits. (See Info
420 node `(elisp)Saving Buffers'.) To perform various checks or
431 "List of functions to be called before writing out a buffer to a file.
432 If one of them returns non-nil, the file is considered already written
433 and the rest are not called and neither are the functions in
434 `write-file-functions'.
436 This variable is meant to be used for hooks that pertain to the
437 buffer's contents, not to the particular visited file; thus,
438 `set-visited-file-name' does not clear this variable; but changing the
439 major mode does clear it.
441 For hooks that _do_ pertain to the particular visited file, use
442 `write-file-functions'. Both this variable and
443 `write-file-functions' relate to how a buffer is saved to file.
444 To perform various checks or updates before the buffer is saved,
451 "*Control use of local variables in files you visit.
452 The value can be t, nil, :safe, or something else.
454 A value of t means file local variables specifications are obeyed
455 if all the specified variable values are safe; if any values are
456 not safe, Emacs queries you, once, whether to set them all.
457 \(When you say yes to certain values, they are remembered as safe.)
459 :safe means set the safe variables, and ignore the rest.
460 :all means set all variables, whether safe or not.
461 (Don't set it permanently to :all.)
462 nil means always ignore the file local variables.
464 Any other value means always query you once whether to set them all.
465 \(When you say yes to certain values, they are remembered as safe, but
468 This variable also controls use of major modes specified in
469 a -*- line.
472 always obeys file local variable specifications and the -*- line,
473 and ignores this variable."
482 "Like `enable-local-variables' but meant for buffer-local bindings.
483 The meaningful values are nil and non-nil. The default is non-nil.
484 If a major mode sets this to nil, buffer-locally, then any local
485 variables list in the file will be ignored.
487 This variable does not affect the use of major modes
492 The value can be t, nil or something else.
493 A value of t means obey `eval' variables;
494 nil means ignore them; anything else means query."
500 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
509 "*Non-nil means buffers visiting files read-only do so in view mode.
510 In fact, this means that all read-only buffers normally have
511 View mode enabled, including buffers that are read-only because
512 you visit a file you cannot alter, and buffers you make read-only
519 "Provides support for ange-ftp host name completion.
520 Runs the usual ange-ftp hook, but only for completion operations."
521 ;; Having this here avoids the need to load ange-ftp when it's not
522 ;; really in use.
528 inhibit-file-name-handlers)))
533 "Convert a standard file's name to something suitable for the OS.
534 This means to guarantee valid names and perhaps to canonicalize
535 certain patterns.
537 FILENAME should be an absolute file name since the conversion rules
538 sometimes vary depending on the position in the file name. E.g. c:/foo
539 is a valid DOS file name, but c:/bar/c:/foo is not.
541 This function's standard definition is trivial; it just returns
542 the argument. However, on Windows and DOS, replace invalid
543 characters. On DOS, make sure to obey the 8.3 limitations. On
544 Windows, turn Cygwin names into native names, and also turn
545 slashes into backslashes if the shell requires it (see
546 `w32-shell-dos-semantics').
548 See Info node `(elisp)Standard File Names' for more details."
549 filename)
552 "Read directory name, prompting with PROMPT and completing in directory DIR.
553 Value is not expanded---you must call `expand-file-name' yourself.
554 Default name to DEFAULT-DIRNAME if user exits with the same
555 non-empty string that was inserted by this function.
556 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
557 or just DIR if INITIAL is nil.)
558 If the user exits with an empty minibuffer, this function returns
559 an empty string. (This can only happen if the user erased the
560 pre-inserted contents or if `insert-default-directory' is nil.)
561 Fourth arg MUSTMATCH non-nil means require existing directory's name.
562 Non-nil and non-t means also require confirmation after completion.
563 Fifth arg INITIAL specifies text to start with.
564 DIR should be an absolute directory name. It defaults to
565 the value of `default-directory'."
570 dir))
571 mustmatch initial
574 \f
576 "Show the current default directory."
581 "Value of the CDPATH environment variable, as a list.
585 "Explode a search path into a list of directory names.
586 Directories are separated by occurrences of `path-separator'
587 \(which is colon in GNU and GNU-like systems)."
588 ;; We could use split-string here.
596 nil
601 cd-list)))
604 "Change current directory to given absolute file name DIR."
605 ;; Put the name into directory syntax now,
606 ;; because otherwise expand-file-name may give some bad results.
619 "Make DIR become the current buffer's default directory.
620 If your environment includes a `CDPATH' variable, try each one of
621 that list of directories (separated by occurrences of
622 `path-separator') when resolving a relative directory name.
623 The path separator is colon in GNU and GNU-like systems."
626 default-directory default-directory
642 cd-path)
643 nil))
647 "Load the Lisp file named FILE."
648 ;; This is a case where .elc makes a lot of sense.
655 "Search for FILENAME through PATH.
656 If found, return the absolute file name of FILENAME, with its suffixes;
657 otherwise return nil.
658 PATH should be a list of directories to look in, like the lists in
659 `exec-path' or `load-path'.
660 If SUFFIXES is non-nil, it should be a list of suffixes to append to
663 If non-nil, PREDICATE is used instead of `file-readable-p'.
664 PREDICATE can also be an integer to pass to the `access' system call,
665 in which case file-name handlers are ignored. This usage is deprecated.
667 For compatibility, PREDICATE can also be one of the symbols
668 `executable', `readable', `writable', or `exists', or a list of
669 one or more of those symbols."
680 "Do completion for file names passed to `locate-file'.
681 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
704 "Search for COMMAND in `exec-path' and return the absolute file name.
705 Return nil if COMMAND is not found anywhere in `exec-path'."
706 ;; Use 1 rather than file-executable-p to better match the behavior of
707 ;; call-process.
711 "Load the library named LIBRARY.
712 This is an interface to the function `load'."
715 'locate-file-completion
720 "Test whether FILE specifies a location on a remote system.
721 Return an identification of the system if the location is indeed
722 remote. The identification of the system may comprise a method
723 to access the system and its hostname, amongst other things.
730 nil)))
733 "Copy the file FILE into a temporary file on this machine.
734 Returns the name of the local copy, or nil, if FILE is directly
735 accessible."
736 ;; This formerly had an optional BUFFER argument that wasn't used by
737 ;; anything.
741 nil)))
744 "Return the truename of FILENAME, which should be absolute.
745 The truename of a file name is found by chasing symbolic links
746 both at the level of the file and at the level of the directories
747 containing it, until no links are left at any level.
750 ;; COUNTER and PREV-DIRS are only used in recursive calls.
751 ;; COUNTER can be a cons cell whose car is the count of how many
752 ;; more links to chase before getting an error.
753 ;; PREV-DIRS can be a cons cell whose car is an alist
754 ;; of truenames we've just recently computed.
768 ;; For speed, remove the ange-ftp completion handler from the list.
769 ;; We know it's not needed here.
770 ;; For even more speed, do this only on the outermost call.
777 ;; andrewi@harlequin.co.uk - none of the following code (except for
778 ;; invoking the file-name handler) currently applies on Windows
779 ;; (ie. there are no native symlinks), but there is an issue with
780 ;; case differences being ignored by the OS, and short "8.3 DOS"
781 ;; name aliases existing for all files. (The short names are not
782 ;; reported by directory-files, but can be used to refer to files.)
783 ;; It seems appropriate for file-truename to resolve these issues in
784 ;; the most natural way, which on Windows is to call the function
785 ;; `w32-long-file-name' - this returns the exact name of a file as
786 ;; it is stored on disk (expanding short name aliases with the full
787 ;; name in the process).
790 ;; For file name that has a special handler, call handler.
791 ;; This is so that ange-ftp can save time by doing a no-op.
794 ;; If filename contains a wildcard, newname will be the old name.
796 ;; If filename exists, use the long name
800 ;; If this file directly leads to a link, process that iteratively
801 ;; so that we don't use lots of stack.
807 ;; For file name that has a special handler, call handler.
808 ;; This is so that ange-ftp can save time by doing a no-op.
811 done t)
813 target dirfile)
814 ;; Get the truename of the directory.
816 ;; If these are equal, we have the (or a) root directory.
818 ;; If this is the same dir we last got the truename for,
819 ;; save time--don't recalculate.
829 done t)
832 done t)
833 ;; Put it back on the file name.
835 ;; Is the file name the name of a link?
838 ;; Yes => chase that link, then start all over
839 ;; since the link may point to a directory name that uses links.
840 ;; We can't safely use expand-file-name here
841 ;; since target might look like foo/../bar where foo
842 ;; is itself a link. Instead, we handle . and .. above.
845 target
847 done nil)
848 ;; No, we are done!
850 filename))
853 "Chase links in FILENAME until a name that is not a link.
854 Unlike `file-truename', this does not check whether a parent
855 directory name is a symbolic link.
856 If the optional argument LIMIT is a number,
857 it means chase no more than that many links and then stop."
865 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
868 ;; Handle `..' by hand, since it needs to work in the
869 ;; target of any directory symlink.
870 ;; This code is not quite complete; it does not handle
871 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
875 ;; Chase links in the default dir of the symlink.
879 ;; Now find the parent of that dir.
883 newname))
886 "Create a temporary file.
887 The returned file name (created by appending some random characters at the end
888 of PREFIX, and expanding against `temporary-file-directory' if necessary),
889 is guaranteed to point to a newly created empty file.
890 You can then use `write-region' to write new data into the file.
892 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
894 If SUFFIX is non-nil, add that at the end of the file name."
896 file)
899 ;; Create temp files with strict access rights. It's easy to
900 ;; loosen them later, whereas it's impossible to close the
901 ;; time-window of loose permissions otherwise.
913 nil)
915 ;; the file was somehow created by someone else between
916 ;; `make-temp-name' and `write-region', let's try again.
917 nil)
918 file)
919 ;; Reset the umask.
923 "Change the encoding of FILE's name from CODING to NEW-CODING.
924 The value is a new name of FILE.
925 Signals a `file-already-exists' error if a file of the new name
926 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
927 is non-nil. A number as fourth arg means request confirmation if
928 the new name already exists. This is what happens in interactive
929 use with M-x."
932 default-file-name-coding-system))
934 from-coding to-coding)
936 ;; We provide the default coding only when it seems that
937 ;; the filename is correctly decoded by the default
938 ;; coding.
944 filename default-coding)
945 default-coding))
949 ;; We provide the default coding only when a user is going to
950 ;; change the encoding not from the default coding.
954 filename from-coding)))
957 filename from-coding default-coding)
958 default-coding)))
962 default-file-name-coding-system))
963 ;; FILE should have been decoded by DEFAULT-CODING.
967 ;; Suppress further encoding.
972 newname))
973 \f
975 "Select buffer BUFFER in another window.
976 If BUFFER does not identify an existing buffer, then this function
977 creates a buffer with that name.
979 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
980 or nil. If BUFFER is nil, then this function chooses a buffer
981 using `other-buffer'.
982 Optional second arg NORECORD non-nil means
983 do not put this buffer at the front of the list of recently selected ones.
984 This function returns the buffer it switched to.
986 This uses the function `display-buffer' as a subroutine; see its
987 documentation for additional customization information."
990 ;; Don't let these interfere.
991 same-window-buffer-names same-window-regexps)
995 "Switch to buffer BUFFER in another frame.
996 Optional second arg NORECORD non-nil means
997 do not put this buffer at the front of the list of recently selected ones.
999 This uses the function `display-buffer' as a subroutine; see its
1000 documentation for additional customization information."
1003 same-window-buffer-names same-window-regexps)
1008 "Switch to buffer BUFFER in another frame.
1009 This uses the function `display-buffer' as a subroutine; see its
1010 documentation for additional customization information."
1013 same-window-buffer-names same-window-regexps
1015 new-window)
1025 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1026 BODY should use the minibuffer at most once.
1027 Recursive uses of the minibuffer will not be affected."
1033 ;; Clear out this hook so it does not interfere
1034 ;; with any recursive minibuffer usage.
1050 t))
1053 "Edit file FILENAME.
1054 Switch to a buffer visiting file FILENAME,
1055 creating one if none already exists.
1056 Interactively, the default if you just type RET is the current directory,
1057 but the visited file name is available through the minibuffer history:
1058 type M-n to pull it into the minibuffer.
1060 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1061 expand wildcards (if any) and visit multiple files. You can
1062 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1064 To visit a file without any kind of conversion and without
1073 "Edit file FILENAME, in another window.
1074 May create a new window, or reuse an existing one.
1075 See the function `display-buffer'.
1077 Interactively, the default if you just type RET is the current directory,
1078 but the visited file name is available through the minibuffer history:
1079 type M-n to pull it into the minibuffer.
1081 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1082 expand wildcards (if any) and visit multiple files."
1093 "Edit file FILENAME, in another frame.
1094 May create a new frame, or reuse an existing one.
1095 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 the existing file FILENAME.
1121 "Edit file FILENAME but don't allow changes.
1133 value))
1136 "Edit file FILENAME in another window but don't allow changes.
1148 value))
1151 "Edit file FILENAME in another frame but don't allow changes.
1163 value))
1166 "Find file FILENAME as a replacement for the file in the next window.
1167 This command does not select that window.
1169 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1170 expand wildcards (if any) and replace the file with multiple files."
1182 t))))
1190 "Find file FILENAME, select its buffer, kill previous buffer.
1191 If the current buffer now contains an empty file that you just visited
1192 \(presumably by mistake), use this command to visit the file you really want.
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."
1205 t)))
1226 ;; This prevents us from finding the same buffer
1227 ;; if we specified the same file again.
1231 ;; Likewise for dired buffers.
1235 ;; This executes if find-file gets an error
1236 ;; and does not really find anything.
1237 ;; We put things back as they were.
1238 ;; If find-file actually finds something, we kill obuf below.
1247 ;; We already asked; don't ask again.
1250 \f
1252 "Create a suitably named buffer for visiting FILENAME, and return it.
1253 FILENAME (sans directory) is used unchanged if that name is free;
1254 otherwise a string <2> or <3> or ... is appended to get an unused name."
1261 "Create and return a buffer with a name based on NAME.
1262 Choose the buffer's name using `generate-new-buffer-name'."
1266 "Regexp to match the automounter prefix in a directory name."
1274 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1276 removes automounter prefixes (see the variable `automount-dir-prefix')."
1277 ;; Get rid of the prefixes added by the automounter.
1284 ;; If any elt of directory-abbrev-alist matches this name,
1285 ;; abbreviate accordingly.
1291 ;; Compute and save the abbreviated homedir name.
1292 ;; We defer computing this until the first time it's needed, to
1293 ;; give time for directory-abbrev-alist to be set properly.
1294 ;; We include a slash at the end, to avoid spurious matches
1295 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1302 ;; If FILENAME starts with the abbreviated homedir,
1303 ;; make it start with `~' instead.
1305 ;; If the home dir is just /, don't change it.
1308 ;; MS-DOS root directories can come with a drive letter;
1309 ;; Novell Netware allows drive letters beyond `Z:'.
1319 filename))
1322 "*List of logical names for which visiting shouldn't save the true dirname.
1323 On VMS, when you visit a file using a logical name that searches a path,
1324 you may or may not want the visited file name to record the specific
1325 directory where the file was found. If you *do not* want that, add the logical
1326 name to this list as a string."
1331 "Return the buffer visiting file FILENAME (a string).
1332 This is like `get-file-buffer', except that it checks for any buffer
1333 visiting the same file, possibly under a different name.
1334 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1335 and others are ignored.
1336 If there is no such live buffer, return nil."
1350 found)
1355 number
1360 ;; Verify this buffer's file number
1361 ;; still belongs to its file.
1364 attributes)
1368 found))))
1369 \f
1371 "*Non-nil means file-visiting commands should handle wildcards.
1372 For example, if you specify `*.c', that would visit all the files
1373 whose names match the pattern."
1379 "*Non-nil means suppress warning messages for symlinked files.
1380 When nil, Emacs prints a warning when visiting a file that is already
1381 visited, but with a different name. Setting this option to t
1382 suppresses this warning."
1388 "Maximum size of file above which a confirmation is requested.
1389 When nil, never request confirmation."
1396 "Read file FILENAME into a buffer and return the buffer.
1397 If a buffer exists visiting FILENAME, return that one, but
1398 verify that the file has not changed since visited or saved.
1399 The buffer is not selected, just returned to the caller.
1400 Optional second arg NOWARN non-nil means suppress any warning messages.
1401 Optional third arg RAWFILE non-nil means the file is read literally.
1402 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1403 and visit all the matching files. When wildcards are actually
1404 used and expanded, return a list of buffers that are visiting
1405 the various files."
1412 'find-directory-functions
1415 filename)))
1418 find-file-wildcards
1432 ;; Find any buffer for a file which has same truename.
1434 ;; Let user know if there is a buffer with the same truename.
1438 find-file-suppress-same-file-warnings
1442 ;; Optionally also find that buffer.
1445 ;; Check to see if the file looks uncommonly large.
1447 ;; Don't ask again if we already have the file or
1448 ;; if we're asked to be quiet.
1457 ;; We are using an existing buffer.
1463 ;; Certain files should be reverted automatically
1464 ;; if they have changed on disk and not in the buffer.
1472 found))
1482 "File %s changed on disk. Discard your edits? "
1487 "File %s changed on disk. Discard your edits in %s? "
1495 ;; Check if a formerly read-only file has become
1496 ;; writable and vice versa, but if the buffer agrees
1497 ;; with the new state of the file, that is ok too.
1504 buffer-file-name
1512 ;; It is confusing to ask whether to visit
1513 ;; non-literally if they have the file in
1514 ;; hexl-mode.
1518 "Save file and revisit literally? "
1523 rawfile truename number))
1525 "Discard your edits and revisit file literally? "
1528 rawfile truename number)
1532 "Revisit file literally? "
1535 rawfile truename number)
1538 ;; Return the buffer we are using.
1539 buf)
1540 ;; Create a new buffer.
1542 ;; find-file-noselect-1 may use a different buffer.
1544 rawfile truename number))))))
1550 ;; Needed in case we are re-visiting the file with a different
1551 ;; text representation.
1568 filename)))
1569 ;; Unconditionally set error
1579 filename)))
1580 ;; Run find-file-not-found-hooks until one returns non-nil.
1582 ;; If they fail too, set error.
1584 ;; Record the file's truename, and maybe use that as visited name.
1590 ;; On VMS, we may want to remember which directory in a search list
1591 ;; the file was found in.
1603 ;; Set buffer's default directory to that of the file.
1605 ;; Turn off backup files for certain file names. Since
1606 ;; this is a permanent local, the major mode won't eliminate it.
1620 \f
1622 "Like `insert-file-contents', but only reads in the file literally.
1623 A buffer may be modified in several ways after reading into the buffer,
1624 to Emacs features such as format decoding, character code
1625 conversion, `find-file-hook', automatic uncompression, etc.
1627 This function ensures that none of these modifications will take place."
1635 nil))
1638 inhibit-file-name-handlers))
1651 filename)))
1661 "Insert contents of file FILENAME into buffer after point with no conversion.
1663 This function is meant for the user to run interactively.
1664 Don't call it from programs! Use `insert-file-contents-literally' instead.
1665 \(Its calling sequence is different; see its documentation)."
1670 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1675 "Visit file FILENAME with no conversion of any kind.
1676 Format conversion and character code conversion are both disabled,
1677 and multibyte characters are disabled in the resulting buffer.
1678 The major mode used is Fundamental mode regardless of the file name,
1679 and local variable specifications in the file are ignored.
1680 Automatic uncompression and adding a newline at the end of the
1681 file due to `require-final-newline' is also disabled.
1683 You cannot absolutely rely on this function to result in
1684 visiting the file literally. If Emacs already has a buffer
1685 which is visiting the file, you get the existing buffer,
1686 regardless of whether it was created literally or not.
1688 In a Lisp program, if you want to be sure of accessing a file's
1689 contents literally, you should create a temporary buffer and then read
1690 the file contents into it using `insert-file-contents-literally'."
1693 \f
1697 after-find-file-from-revert-buffer
1698 nomodes)
1699 "Called after finding a file and by the default revert function.
1700 Sets buffer mode, parses local variables.
1701 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1702 error in reading the file. WARN non-nil means warn if there
1703 exists an auto-save file more recent than the visited file.
1704 NOAUTO means don't mess with auto-save mode.
1705 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1706 means this call was from `revert-buffer'.
1707 Fifth arg NOMODES non-nil means don't alter the file's modes.
1708 Finishes by calling the functions in `find-file-hook'
1709 unless NOMODES is non-nil."
1712 nil
1722 ;; No need to warn if buffer is auto-saved
1723 ;; under the name of the visited file.
1725 auto-save-visited-file-name))
1728 buffer-file-name))
1748 ;; Make people do a little extra work (C-x C-q)
1749 ;; before altering a backup file.
1752 ;; When a file is marked read-only,
1753 ;; make the buffer read-only even if root is looking at it.
1761 ;; If requested, add a newline at the end of the file.
1771 view-read-only
1777 "Eval BODY and turn any error into a FORMAT message.
1778 FORMAT can have a %s escape which will be replaced with the actual error.
1779 If `debug-on-error' is set, errors are not caught, so that you can
1780 debug them.
1781 Avoid using a large BODY since it is duplicated."
1790 "Choose the major mode for this buffer automatically.
1791 Also sets up any specified local variables of the file.
1792 Uses the visited file name, the -*- line, and the local variables spec.
1794 This function is called automatically from `find-file'. In that case,
1795 we may set up the file-specified mode and local variables,
1796 depending on the value of `enable-local-variables'.
1797 In addition, if `local-enable-local-variables' is nil, we do
1798 not set local variables (though we do notice a mode specified with -*-.)
1800 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1801 or from Lisp without specifying the optional argument FIND-FILE;
1802 in that case, this function acts as if `enable-local-variables' were t."
1810 ;; Turn font lock off and on, to make sure it takes account of
1811 ;; whatever file local variables are relevant to it.
1813 ;; Font-lock-mode (now in font-core.el) can be ON when
1814 ;; font-lock.el still hasn't been loaded.
1824 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1825 ;; c++-mode, java-mode and more) are added through autoload
1826 ;; directives in that file. That way is discouraged since it
1827 ;; spreads out the definition of the initial value.
1859 ;; Less common extensions come here
1860 ;; so more common ones above are found faster.
1899 ;; The list of archive file extensions should be in sync with
1900 ;; `auto-coding-alist' with `no-conversion' coding system.
1904 ;; Mailer puts message to be edited in
1905 ;; /tmp/Re.... or Message
1909 ;; some news reader is reported to use this
1918 ;; .emacs or .gnus or .viper following a directory delimiter in
1919 ;; Unix, MSDOG or VMS syntax.
1922 ;; _emacs following a directory delimiter
1923 ;; in MsDos syntax
1942 ;; Windows candidates may be opened case sensitively on Unix
1948 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1950 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1951 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
1952 ;; either user's dot-files or under /etc or some such
1954 ;; alas not all ~/.*rc files are like this
1955 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1960 ;; this contains everything twice, with space and with colon :-(
1962 ;; Get rid of any trailing .n.m and try again.
1963 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1964 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1965 ;; Using mode nil rather than `ignore' would let the search continue
1966 ;; through this list (with the shortened name) rather than start over.
1968 ;; The following should come after the ChangeLog pattern
1969 ;; for the sake of ChangeLog.1, etc.
1970 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1973 "Alist of filename patterns vs corresponding major mode functions.
1974 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1975 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1976 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1977 mode function to use. FUNCTION will be called, unless it is nil.
1979 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1980 calling FUNCTION (if it's not nil), we delete the suffix that matched
1981 REGEXP and search the list again for another match.
1983 If the file name matches `inhibit-first-line-modes-regexps',
1984 then `auto-mode-alist' is not processed.
1986 The extensions whose FUNCTION is `archive-mode' should also
1987 appear in `auto-coding-alist' with `no-conversion' coding system.
1989 See also `interpreter-mode-alist', which detects executable script modes
1990 based on the interpreters they specify to run,
1994 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1995 ;; and pike-mode) are added through autoload directives in that
1996 ;; file. That way is discouraged since it spreads out the
1997 ;; definition of the initial value.
2035 "Alist mapping interpreter names to major modes.
2036 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2037 Each element looks like (INTERPRETER . MODE).
2038 If INTERPRETER matches the name of the interpreter specified in the first line
2039 of a script, mode MODE is enabled.
2047 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2048 When checking `inhibit-first-line-modes-regexps', we first discard
2054 "Regexp matching interpreters, for file mode determination.
2055 This regular expression is matched against the first line of a file
2056 to determine the file's mode in `set-auto-mode'. If it matches, the file
2057 is assumed to be interpreted by the interpreter matched by the second group
2058 of the regular expression. The mode is then determined as the mode
2063 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2064 ;; We use [ \t\n] instead of `\\s ' to make regex overflow less likely.
2068 comment-re "*"
2071 . html-mode)
2072 ;; These two must come after html, because they are more general:
2077 . sgml-mode)
2080 "Alist of buffer beginnings vs. corresponding major mode functions.
2081 Each element looks like (REGEXP . FUNCTION). After visiting a file,
2082 if REGEXP matches the text at the beginning of the buffer,
2083 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
2084 to decide the buffer's major mode.
2086 If FUNCTION is nil, then it is not called. (That is a way of saying
2093 "Select major mode appropriate for current buffer.
2095 This checks for a -*- mode tag in the buffer's text, checks the
2096 interpreter that runs this file against `interpreter-mode-alist',
2097 compares the buffer beginning against `magic-mode-alist', or
2098 compares the filename against the entries in `auto-mode-alist'.
2100 It does not check for the `mode:' local variable in the
2101 Local Variables section of the file; for that, use `hack-local-variables'.
2103 If `enable-local-variables' is nil, this function does not check for a
2104 -*- mode tag.
2106 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2107 only set the major mode, if that would change it."
2108 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2110 ;; Find a -*- mode tag
2117 ;; Find all specifications for the `mode:' variable
2118 ;; and execute them left to right.
2130 modes)))
2131 ;; Simple -*-MODE-*- case.
2134 modes))))
2135 ;; If we found modes to use, invoke them now, outside the save-excursion.
2143 ;; continuing would call minor modes again, toggling them off
2146 ;; If we didn't, look for an interpreter specified in the first line.
2147 ;; As a special case, allow for things like "#!/bin/env perl", which
2148 ;; finds the interpreter anywhere in $PATH.
2154 ;; Map interpreter name to a mode, signalling we're done at the
2155 ;; same time.
2157 interpreter-mode-alist))
2158 ;; If we found an interpreter mode to use, invoke it now.
2161 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2173 ;; Compare the filename against the entries in auto-mode-alist.
2176 ;; Remove backup-suffixes from file name.
2179 ;; Find first matching alist entry.
2192 ;; When `keep-mode-if-same' is set, we are working on behalf of
2193 ;; set-visited-file-name. In that case, if the major mode specified is the
2194 ;; same one we already have, don't actually reset it. We don't want to lose
2195 ;; minor modes such as Font Lock.
2197 "Apply MODE and return it.
2198 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2199 any aliases and compared to current major mode. If they are the
2200 same, do nothing and return nil."
2208 mode))
2211 "Find the -*- spec in the buffer.
2212 Call with point at the place to start searching from.
2213 If one is found, set point to the beginning
2214 and return the position of the end.
2215 Otherwise, return nil; point may be changed."
2218 ;; Don't look for -*- if this file name matches any
2219 ;; of the regexps in inhibit-first-line-modes-regexps.
2227 sufs)
2235 ;; If the file begins with "#!"
2236 ;; (exec interpreter magic), look
2237 ;; for mode frobs in the first two
2238 ;; lines. You cannot necessarily
2239 ;; put them in the first line of
2240 ;; such a file without screwing up
2241 ;; the interpreter invocation.
2252 end))))
2253 \f
2254 ;;; Handling file local variables
2261 "Normal hook run after processing a file's local variables specs.
2262 Major modes can use this to examine user-specified local variables
2266 "List variable-value pairs that are considered safe.
2267 Each element is a cons cell (VAR . VAL), where VAR is a variable
2268 symbol and VAL is a value that is considered safe."
2273 "*Expressions that are considered safe in an `eval:' local variable.
2274 Add expressions to this list if you want Emacs to evaluate them, when
2275 they appear in an `eval' local variable specification, without first
2276 asking you for confirmation."
2281 ;; Risky local variables:
2284 auto-mode-alist
2285 buffer-auto-save-file-name
2286 buffer-file-name
2287 buffer-file-truename
2288 buffer-undo-list
2289 dabbrev-case-fold-search
2290 dabbrev-case-replace
2291 debugger
2292 default-text-properties
2293 display-time-string
2294 enable-local-eval
2295 enable-local-variables
2296 eval
2297 exec-directory
2298 exec-path
2299 file-name-handler-alist
2300 font-lock-defaults
2301 format-alist
2302 frame-title-format
2303 global-mode-string
2304 header-line-format
2305 icon-title-format
2306 ignored-local-variables
2307 imenu--index-alist
2308 imenu-generic-expression
2309 inhibit-quit
2310 input-method-alist
2311 load-path
2312 max-lisp-eval-depth
2313 max-specpdl-size
2314 minor-mode-alist
2315 minor-mode-map-alist
2316 minor-mode-overriding-map-alist
2317 mode-line-buffer-identification
2318 mode-line-format
2319 mode-line-modes
2320 mode-line-modified
2321 mode-line-mule-info
2322 mode-line-position
2323 mode-line-process
2324 mode-name
2325 outline-level
2326 overriding-local-map
2327 overriding-terminal-local-map
2328 parse-time-rules
2329 process-environment
2330 rmail-output-file-alist
2331 safe-local-variable-values
2332 safe-local-eval-forms
2333 save-some-buffers-action-alist
2334 special-display-buffer-names
2335 standard-input
2336 standard-output
2337 unread-command-events
2338 vc-mode))
2340 ;; Safe local variables:
2341 ;;
2342 ;; For variables defined by major modes, the safety declarations can go into
2343 ;; the major mode's file, since that will be loaded before file variables are
2344 ;; processed.
2345 ;;
2346 ;; For variables defined by minor modes, put the safety declarations in the
2347 ;; file defining the minor mode after the defcustom/defvar using an autoload
2348 ;; cookie, e.g.:
2349 ;;
2350 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2351 ;;
2352 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2353 ;; minor mode file may not be loaded yet.
2354 ;;
2355 ;; For variables defined in the C source code the declaration should go here:
2357 ;; FIXME: Some variables should be moved according to the rules above.
2371 nil
2376 prompt char)
2386 ", and variables that are risky (**)."
2393 y -- to apply the local variables list.
2397 ! -- to apply the local variables list, and permanently mark these
2410 ;; Make strings with embedded whitespace easier to read.
2419 ""
2425 done)
2439 ;; When this is called from desktop-restore-file-buffer,
2440 ;; coding-system-for-read may be non-nil. Reset it before
2441 ;; writing to .emacs.
2445 'safe-local-variable-values
2446 safe-local-variable-values))))
2453 "Return local variables specified in the -*- line.
2454 Ignore any specification for `mode:' and `coding:';
2455 `set-auto-mode' should already have handled `mode:',
2456 `set-auto-coding' should already have handled `coding:'.
2458 If MODE-ONLY is non-nil, all we do is check whether the major
2459 mode is specified, returning t if it is specified. Otherwise,
2460 return an alist of elements (VAR . VAL), where VAR is a variable
2461 and VAL is the specified value."
2465 result mode-specified)
2466 ;; Parse the -*- line into the RESULT alist.
2467 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2469 nil)
2471 ;; Simple form: "-*- MODENAME -*-". Already handled.
2473 nil)
2475 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2476 ;; (last ";" is optional).
2481 ;; There used to be a downcase here,
2482 ;; but the manual didn't say so,
2483 ;; and people want to set var names that aren't all lc.
2490 ;; It is traditional to ignore
2491 ;; case when checking for `mode' in set-auto-mode,
2492 ;; so we must do that here as well.
2493 ;; That is inconsistent, but we're stuck with it.
2494 ;; The same can be said for `coding' in set-auto-coding.
2500 'eval
2507 mode-specified
2508 result))))
2511 "Parse and put into effect this buffer's local variables spec.
2512 If MODE-ONLY is non-nil, all we do is check whether the major mode
2513 is specified, returning t if it is specified."
2516 result)
2519 ;; Look for "Local variables:" line in last page.
2527 ;; suffix is what comes after "local variables:" in its line.
2528 ;; prefix is what comes before "local variables:" in its line.
2538 beg)
2542 endpos
2548 nil t))
2558 ;; Discard the prefix.
2563 ;; Discard the suffix.
2571 ;; Find the variable name; strip whitespace.
2579 val)
2580 ;; Read the variable value.
2590 'eval
2596 ;; We've read all the local variables. Now, return whether the
2597 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2598 ;; variables (if MODE-ONLY is nil.)
2600 result
2607 ;; Find those variables that we may want to save to
2608 ;; `safe-local-variable-values'.
2623 ;; If caller wants only the safe variables,
2624 ;; install only them.
2629 ;; Query, except in the case where all are known safe
2630 ;; if the user wants no quuery in that case.
2636 result unsafe-vars risky-vars))
2642 "Non-nil if SYM is safe as a file-local variable with value VAL.
2643 It is safe if any of these conditions are met:
2645 * There is a matching entry (SYM . VAL) in the
2646 `safe-local-variable-values' user option.
2648 * The `safe-local-variable' property of SYM is a function that
2649 evaluates to a non-nil value with VAL as an argument."
2655 "Non-nil if SYM could be dangerous as a file-local variable.
2656 It is dangerous if either of these conditions are met:
2658 * Its `risky-local-variable' property is non-nil.
2664 ;; If this is an alias, check the base name.
2684 "Return t if it is safe to eval EXP when it is found in a file."
2686 ;; Detect certain `put' expressions.
2692 ;; Only allow safe values of lisp-indent-hook;
2693 ;; not functions.
2696 ;; Only allow indirect form specs.
2697 ;; During bootstrapping, edebug-basic-spec might not be
2698 ;; defined yet.
2701 ;; Allow expressions that the user requested.
2703 ;; Certain functions can be allowed with safe arguments
2704 ;; or can specify verification functions to try.
2712 ok))
2720 ok)))))))
2723 "Set local variable VAR with value VAL."
2730 ;; Make sure the string has no text properties.
2731 ;; Some text properties can get evaluated in various ways,
2732 ;; so it is risky to put them on with a local variable list.
2737 \f
2740 However, the mode will not be changed if
2741 \(1) a local variables list or the `-*-' line specifies a major mode, or
2743 \ not suitable for ordinary files, or
2744 \(3) the new file name does not particularly specify any mode."
2749 "Change name of file visited in current buffer to FILENAME.
2750 This also renames the buffer to correspond to the new file.
2751 The next time the buffer is saved it will go in the newly specified file.
2752 FILENAME nil or an empty string means mark buffer as not visiting any file.
2753 Remember to delete the initial contents of the minibuffer
2754 if you wish to pass an empty string as the argument.
2756 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2757 confirmation in the case where another buffer is already visiting FILENAME.
2759 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2760 the old visited file has been renamed to the new name FILENAME."
2768 nil
2783 filename)))
2795 ;; If new-name == old-name, renaming would add a spurious <2>
2796 ;; and it's considered as a feature in rename-buffer.
2802 ;; Abbreviate the file names of the buffer.
2811 nil)))
2812 ;; write-file-functions is normally used for things like ftp-find-file
2813 ;; that visit things that are not local files as if they were files.
2814 ;; Changing to visit an ordinary local file instead should flush the hook.
2819 ;; If buffer was read-only because of version control,
2820 ;; that reason is gone now, so make it writable.
2824 ;; Turn off backup files for certain file names.
2825 ;; Since this is a permanent local, the major mode won't eliminate it.
2832 ;; If auto-save was not already on, turn it on if appropriate.
2836 ;; If auto save is on, start using a new name.
2837 ;; We deliberately don't rename or delete the old auto save
2838 ;; for the old visited file name. This is because perhaps
2839 ;; the user wants to save the new state and then compare with the
2840 ;; previous state from the auto save file.
2843 ;; Rename the old auto save file if any.
2850 ;; Update the major mode, if the file name determines it.
2852 ;; Don't change the mode if it is special.
2855 ;; Don't change the mode if the local variable list specifies it.
2861 "Write current buffer into file FILENAME.
2862 This makes the buffer visit that file, and marks it as not modified.
2864 If you specify just a directory name as FILENAME, that means to use
2865 the default file name but in that directory. You can also yank
2866 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2868 If the buffer is not already visiting a file, the default file name
2869 for the output file is the buffer name.
2871 If optional second arg CONFIRM is non-nil, this function
2872 asks for confirmation before overwriting an existing file.
2873 Interactively, confirmation is required unless you supply a prefix argument."
2874 ;; (interactive "FWrite file: ")
2878 nil nil nil nil)
2882 default-directory)
2883 nil nil))
2887 ;; If arg is just a directory,
2888 ;; use the default file name, but in that directory.
2899 ;; Make buffer writable if file is writable.
2904 ;; It's likely that the VC status at the new location is different from
2905 ;; the one at the old location.
2907 \f
2909 "Make a backup of the disk file visited by the current buffer, if appropriate.
2910 This is normally done before saving the buffer the first time.
2912 A backup may be done by renaming or by copying; see documentation of
2913 variable `make-backup-files'. If it's done by renaming, then the file is
2914 no longer accessible under its old name.
2916 The value is non-nil after a backup was made by renaming.
2917 It has the form (MODES . BACKUPNAME).
2918 MODES is the result of `file-modes' on the original
2919 file; this means that the caller, after saving the buffer, should change
2920 the modes of the new file to agree with the old modes.
2921 BACKUPNAME is the backup file name, which is the old file renamed."
2928 backup-info backupname targets setmodes)
2929 ;; If specified name is a symbolic link, chase it to the target.
2930 ;; Thus we make the backups in the directory where the real file is.
2935 ;; (if (file-directory-p buffer-file-name)
2936 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2940 ;; If have old versions to maybe delete,
2941 ;; ask the user to confirm now, before doing anything.
2942 ;; But don't actually delete til later.
2947 real-file-name)))))
2949 ;; Actually write the back up file.
2952 ; (file-symlink-p buffer-file-name)
2953 backup-by-copying
2954 ;; Don't rename a suid or sgid file.
2969 ;; rename-file should delete old backup.
2973 ;; If trouble writing the backup, write it in ~.
2982 ;; Now delete the old versions, if desired.
2989 setmodes)
2996 ;; Create temp files with strict access rights. It's easy to
2997 ;; loosen them later, whereas it's impossible to close the
2998 ;; time-window of loose permissions otherwise.
3006 nil)
3008 ;; The file was somehow created by someone else between
3009 ;; `delete-file' and `copy-file', so let's try again.
3010 nil))
3011 ;; Reset the umask.
3017 "Return file NAME sans backup versions or strings.
3018 This is a separate procedure so your site-init or startup file can
3019 redefine it.
3020 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3021 we do not remove backup version numbers, only true file version numbers."
3027 ;; VMS version number is (a) semicolon, optional
3028 ;; sign, zero or more digits or (b) period, option
3029 ;; sign, zero or more digits, provided this is the
3030 ;; second period encountered outside of the
3031 ;; device/directory part of the file name.
3034 name)
3044 "Return t if deleting FILE and rewriting it would preserve the owner."
3049 ;; Return t if the file doesn't exist, since it's true that no
3050 ;; information would be lost by an (attempted) delete and create.
3056 The extension, in a file name, is the part that follows the last `.',
3057 except that a leading `.', if any, doesn't count."
3060 directory)
3064 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3065 ;; we don't want to expand it.
3068 filename))))
3072 The extension, in a file name, is the part that follows the last `.',
3073 excluding version numbers and backup suffixes,
3074 except that a leading `.', if any, doesn't count.
3075 Return nil for extensionless file names such as `foo'.
3076 Return the empty string for file names such as `foo.'.
3078 If PERIOD is non-nil, then the returned value includes the period
3079 that delimits the extension, and if FILENAME has no extension,
3090 "A function to use instead of the default `make-backup-file-name'.
3091 A value of nil gives the default `make-backup-file-name' behavior.
3093 This could be buffer-local to do something special for specific
3094 files. If you define it, you may need to change `backup-file-name-p'
3095 and `file-name-sans-versions' too.
3097 See also `backup-directory-alist'."
3103 "Alist of filename patterns and backup directory names.
3104 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3105 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3106 relative or absolute. If it is absolute, so that all matching files
3107 are backed up into the same directory, the file names in this
3108 directory will be the full name of the file backed up with all
3109 directory separators changed to `!' to prevent clashes. This will not
3110 work correctly if your filesystem truncates the resulting name.
3112 For the common case of all backups going into one directory, the alist
3114 directory name.
3116 If this variable is nil, or it fails to match a filename, the backup
3117 is made in the original file's directory.
3119 On MS-DOS filesystems without long names this variable is always
3120 ignored."
3126 "Default `backup-enable-predicate' function.
3127 Checks for files in `temporary-file-directory',
3128 `small-temporary-file-directory', and /tmp."
3131 ;; Directory is under temporary-file-directory.
3136 ;; Directory is under /tmp.
3141 0 nil
3143 ;; Directory is under small-temporary-file-directory.
3148 "Create the non-numeric backup file name for FILE.
3149 Normally this will just be the file's name with `~' appended.
3150 Customization hooks are provided as follows.
3152 If the variable `make-backup-file-name-function' is non-nil, its value
3153 should be a function which will be called with FILE as its argument;
3154 the resulting name is used.
3156 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3157 the documentation of that variable. If the directory for the backup
3158 doesn't exist, it is created."
3172 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3174 elt backup-directory)
3179 alist nil)))
3185 file
3189 ;; Normalize DOSish file names: downcase the drive
3190 ;; letter, if any, and replace the leading "x:" with
3191 ;; "/drive_x".
3194 ;; Replace any invalid file-name characters (for the
3195 ;; case of backing up remote files).
3199 "drive_"
3202 ""
3205 ;; Make the name unique by substituting directory
3206 ;; separators. It may not really be worth bothering about
3207 ;; doubling `!'s in the original name...
3212 backup-directory))
3219 "Return non-nil if FILE is a backup file name (numeric or not).
3220 This is a separate function so you can redefine it for customization.
3221 You may need to redefine `file-name-sans-versions' as well."
3226 ;; This is used in various files.
3227 ;; The usage of backup-extract-version-start is not very clean,
3228 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3230 "Given the name of a numeric backup file, FN, return the backup number.
3231 Uses the free variable `backup-extract-version-start', whose value should be
3232 the index in the name where the version number begins."
3238 ;; I believe there is no need to alter this behavior for VMS;
3239 ;; since backup files are not made on VMS, it should not get called.
3241 "Find a file name for a backup file FN, and suggestions for deletions.
3242 Value is a list whose car is the name for the backup file
3243 and whose cdr is a list of old versions to consider deleting now.
3244 If the value is nil, don't make a backup.
3245 Uses `backup-directory-alist' in the same way as does
3246 `make-backup-file-name'."
3248 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3252 ;; We don't support numbered backups on plain MS-DOS
3253 ;; when long file names are unavailable.
3263 possibilities deserve-versions-p versions)
3266 base-versions
3269 possibilities)
3270 #'<)
3275 kept-old-versions
3276 kept-new-versions
3283 ;; Delete nothing if there is overflow
3284 ;; in the number of versions to keep.
3290 v))))))))))
3293 "Return number of names file FILENAME has."
3296 ;; (defun file-relative-name (filename &optional directory)
3297 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3298 ;; This function returns a relative file name which is equivalent to FILENAME
3299 ;; when used with that default directory as the default.
3300 ;; If this is impossible (which can happen on MSDOS and Windows
3301 ;; when the file name and directory use different drive names)
3302 ;; then it returns FILENAME."
3303 ;; (save-match-data
3304 ;; (let ((fname (expand-file-name filename)))
3305 ;; (setq directory (file-name-as-directory
3306 ;; (expand-file-name (or directory default-directory))))
3307 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3308 ;; ;; drive names, they can't be relative, so return the absolute name.
3309 ;; (if (and (or (eq system-type 'ms-dos)
3310 ;; (eq system-type 'cygwin)
3311 ;; (eq system-type 'windows-nt))
3312 ;; (not (string-equal (substring fname 0 2)
3313 ;; (substring directory 0 2))))
3314 ;; filename
3315 ;; (let ((ancestor ".")
3316 ;; (fname-dir (file-name-as-directory fname)))
3317 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3318 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3319 ;; (setq directory (file-name-directory (substring directory 0 -1))
3320 ;; ancestor (if (equal ancestor ".")
3321 ;; ".."
3322 ;; (concat "../" ancestor))))
3323 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3324 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3325 ;; ;; We matched within FNAME's directory part.
3326 ;; ;; Add the rest of FNAME onto ANCESTOR.
3327 ;; (let ((rest (substring fname (match-end 0))))
3328 ;; (if (and (equal ancestor ".")
3329 ;; (not (equal rest "")))
3330 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3331 ;; rest
3332 ;; (concat (file-name-as-directory ancestor) rest)))
3333 ;; ;; We matched FNAME's directory equivalent.
3334 ;; ancestor))))))
3337 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3338 This function returns a relative file name which is equivalent to FILENAME
3339 when used with that default directory as the default.
3340 If FILENAME and DIRECTORY lie on different machines or on different drives
3341 on a DOS/Windows machine, it returns FILENAME in expanded form."
3345 default-directory))))
3351 ;; Test for different drives on DOS/Windows
3353 ;; Should `cygwin' really be included here? --stef
3356 ;; Test for different remote file system identification
3358 filename
3364 directory nil nil case-fold-search))
3366 directory nil nil case-fold-search))))
3369 ".."
3371 ;; Now ancestor is empty, or .., or ../.., etc.
3373 directory nil nil case-fold-search))
3374 ;; We matched within FILENAME's directory part.
3375 ;; Add the rest of FILENAME onto ANCESTOR.
3378 ;; But don't bother with ANCESTOR if it would give us `./'.
3379 rest
3381 ;; We matched FILENAME's directory equivalent.
3382 ancestor))))))
3383 \f
3385 "Save current buffer in visited file if modified.
3386 Variations are described below.
3388 By default, makes the previous version into a backup file
3389 if previously requested or if this is the first save.
3391 to become a backup when the next save is done.
3393 unconditionally makes the previous version into a backup file.
3395 to become a backup when the next save is done,
3396 and unconditionally makes the previous version into a backup file.
3398 With a numeric argument of 0, never make the previous version
3399 into a backup file.
3401 If a file's name is FOO, the names of its numbered backup versions are
3402 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3403 Numeric backups (rather than FOO~) will be made if value of
3404 `version-control' is not the atom `never' and either there are already
3405 numeric versions of the file being backed up, or `version-control' is
3406 non-nil.
3407 We don't want excessive versions piling up, so there are variables
3408 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3409 and `kept-new-versions', which tells how many newest versions to keep.
3410 Defaults are 2 old versions and 2 new.
3411 `dired-kept-versions' controls dired's clean-directory (.) command.
3412 If `delete-old-versions' is nil, system will query user
3413 before trimming versions. Otherwise it does it silently.
3415 If `vc-make-backup-files' is nil, which is the default,
3416 no backup files are made for files managed by version control.
3417 (This is because the version control system itself records previous versions.)
3419 See the subroutine `basic-save-buffer' for more information."
3432 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3433 Normally delete only if the file was written by this Emacs since
3434 the last real save, but optional arg FORCE non-nil means delete anyway."
3448 "Normal hook that is run before a buffer is saved to its file."
3454 "Normal hook that is run after a buffer is saved to its file."
3460 "If non-nil, use this coding system for saving the buffer.
3461 More precisely, use this coding system in place of the
3462 value of `buffer-file-coding-system', when saving the buffer.
3463 Calling `write-region' for any purpose other than saving the buffer
3464 will still use `buffer-file-coding-system'; this variable has no effect
3471 "Save the current buffer in its visited file, if it has been modified.
3472 The hooks `write-contents-functions' and `write-file-functions' get a chance
3473 to do the job of saving; if they do not, then the buffer is saved in
3474 the visited file in the usual way.
3475 Before and after saving the buffer, this function runs
3476 `before-save-hook' and `after-save-hook', respectively."
3479 ;; In an indirect buffer, save its base buffer instead.
3484 setmodes)
3485 ;; On VMS, rename file and buffer to get rid of version number.
3490 ;; Strip VMS version number before save.
3493 ;; Construct a (unique) buffer name to correspond.
3498 ;; If buffer has no file name, ask user for one.
3505 filename))
3531 ;; Support VC version backups.
3537 ;; If a hook returned t, file is already "written".
3538 ;; Otherwise, write it the usual way now.
3540 ;; Now we have saved the current buffer. Let's make sure
3541 ;; that buffer-file-coding-system is fixed to what
3542 ;; actually used for saving by binding it locally.
3552 ;; If the auto-save file was recent before this command,
3553 ;; delete it now.
3555 ;; Support VC `implicit' locking.
3560 ;; This does the "real job" of writing a buffer into its visited file
3561 ;; and making a backup file. This is what is normally done
3562 ;; but inhibited if one of write-file-functions returns non-nil.
3563 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3572 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3586 buffer-file-name)))
3594 ;; If file is precious, write temp name, then rename it.
3595 ;; This requires write access to the containing dir,
3596 ;; which is why we don't try it if we don't have that access.
3598 tempname succeed
3601 ;; Create temp files with strict access rights. It's easy to
3602 ;; loosen them later, whereas it's impossible to close the
3603 ;; time-window of loose permissions otherwise.
3608 ;; Try various temporary names.
3609 ;; This code follows the example of make-temp-file,
3610 ;; but it calls write-region in the appropriate way
3611 ;; for saving the buffer.
3618 tempname nil realname
3620 nil)
3622 ;; The file was somehow created by someone else between
3623 ;; `make-temp-name' and `write-region', let's try again.
3624 nil)
3626 ;; Reset the umask.
3628 ;; If we failed, restore the buffer's modtime.
3631 ;; Since we have created an entirely new file,
3632 ;; make sure it gets the right permission bits set.
3635 buffer-file-name)))
3636 ;; We succeeded in writing the temp file,
3637 ;; so rename it.
3639 ;; If file not writable, see if we can make it writable
3640 ;; temporarily while we write it.
3641 ;; But no need to do so if we have just backed it up
3642 ;; (setmodes is set) because that says we're superseding.
3644 ;; Change the mode back, after writing.
3651 buffer-file-name nil t buffer-file-truename)
3653 ;; If we get an error writing the new file, and we made
3654 ;; the backup by renaming, undo the backing-up.
3659 setmodes))
3662 "View the differences between BUFFER and its associated file.
3663 This requires the external program `diff' to be in your `exec-path'."
3678 ;; Display that message for 1 second so that user can read it
3679 ;; in the minibuffer.
3681 ;; return always nil, so that save-buffers-kill-emacs will not move
3682 ;; over to the next unsaved buffer when calling `d'.
3683 nil)
3686 '((?\C-r
3692 ;; Return nil to ask about BUF again.
3693 nil)
3695 (?d diff-buffer-with-file
3704 "Save some modified file-visiting buffers. Asks user about each one.
3705 You can answer `y' to save, `n' not to save, `C-r' to look at the
3706 buffer in question with `view-buffer' before deciding or `d' to
3707 view the differences using `diff-buffer-with-file'.
3709 Optional argument (the prefix) non-nil means save all with no questions.
3710 Optional second argument PRED determines which buffers are considered:
3711 If PRED is nil, all the file-visiting buffers are considered.
3712 If PRED is t, then certain non-file buffers will also be considered.
3713 If PRED is a zero-argument function, it indicates for each buffer whether
3714 to consider it or not when called with that buffer current.
3716 See `save-some-buffers-action-alist' if you want to
3717 change the additional actions you can take on files."
3721 files-done abbrevs-done)
3723 ;; First save any buffers that we're supposed to save unconditionally.
3724 ;; That way the following code won't ask about them.
3729 ;; Ask about those buffers that merit it,
3730 ;; and record the number thus saved.
3746 t
3759 save-some-buffers-action-alist))
3760 ;; Maybe to save abbrevs, and record whether
3761 ;; we either saved them or asked to.
3767 abbrev-file-name)))
3769 ;; Don't keep bothering user if he says no.
3774 "(Some special files were saved without asking)"
3776 \f
3778 "Mark current buffer as unmodified, not needing to be saved.
3781 It is not a good idea to use this function in Lisp programs, because it
3782 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3789 "Change whether this buffer is visiting its file read-only.
3790 With arg, set read-only iff arg is positive.
3791 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3796 nil ; do nothing.
3797 ;; Toggle.
3804 ;; If view-mode is already active, `view-mode-enter' is a nop.
3816 "Insert contents of file FILENAME into buffer after point.
3817 Set mark after the inserted text.
3819 This function is meant for the user to run interactively.
3820 Don't call it from programs! Use `insert-file-contents' instead.
3821 \(Its calling sequence is different; see its documentation)."
3826 "Append the contents of the region to the end of file FILENAME.
3827 When called from a function, expects three arguments,
3828 START, END and FILENAME. START and END are buffer positions
3829 saying what text to write."
3834 "Return most recent backup file for FILENAME or nil if no backups exist."
3835 ;; `make-backup-file-name' will get us the right directory for
3836 ;; ordinary or numeric backups. It might create a directory for
3837 ;; backups as a side-effect, according to `backup-directory-alist'.
3844 tem)
3853 newest))
3856 "Rename current buffer to a similar name not already taken.
3857 This function is useful for creating multiple shell process buffers
3858 or multiple mail buffers, etc."
3866 ;; If the existing buffer name has a <NNN>,
3867 ;; which isn't part of the file name (if any),
3868 ;; then get rid of that.
3874 "Create the directory DIR and any nonexistent parent dirs.
3875 Interactively, the default choice of directory to create
3876 is the current default directory for file names.
3877 That is useful when you have visited a file in a nonexistent directory.
3879 Noninteractively, the second (optional) argument PARENTS says whether
3880 to create parent directories if they don't exist. Interactively,
3881 this happens by default."
3884 nil nil)
3885 t))
3886 ;; If default-directory is a remote directory,
3887 ;; make sure we find its make-directory handler.
3895 create-list)
3902 \f
3905 "Function to use to revert this buffer, or nil to do the default.
3906 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3911 "Function to use to insert contents when reverting this buffer.
3912 Gets two args, first the nominal file name to use,
3913 and second, t if reading the auto-save file.
3918 "Function to check whether a non-file buffer needs reverting.
3919 This should be a function with one optional argument NOCONFIRM.
3920 Auto Revert Mode passes t for NOCONFIRM. The function should return
3921 non-nil if the buffer should be reverted. A return value of
3922 `fast' means that the need for reverting was not checked, but
3923 that reverting the buffer is fast. The buffer is current when
3924 this function is called.
3926 The idea behind the NOCONFIRM argument is that it should be
3927 non-nil if the buffer is going to be reverted without asking the
3928 user. In such situations, one has to be careful with potentially
3929 time consuming operations.
3931 For more information on how this variable is used by Auto Revert mode,
3935 "Normal hook for `revert-buffer' to run before reverting.
3936 If `revert-buffer-function' is used to override the normal revert
3940 "Normal hook for `revert-buffer' to run after reverting.
3941 Note that the hook value that it runs is the value that was in effect
3942 before reverting; that makes a difference if you have buffer-local
3943 hook functions.
3945 If `revert-buffer-function' is used to override the normal revert
3951 "Replace current buffer text with the text of the visited file on disk.
3952 This undoes all changes since the file was visited or saved.
3953 With a prefix argument, offer to revert from latest auto-save file, if
3954 that is more recent than the visited file.
3956 This command also works for special buffers that contain text which
3957 doesn't come from a file, but reflects some other data base instead:
3958 for example, Dired buffers and `buffer-list' buffers. In these cases,
3959 it reconstructs the buffer contents from the appropriate data base.
3961 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3962 to revert from the auto-save file when this is nil. Note that the
3963 sense of this argument is the reverse of the prefix argument, for the
3964 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3965 to nil.
3967 Optional second argument NOCONFIRM means don't ask for confirmation at
3968 all. \(The variable `revert-without-query' offers another way to
3969 revert buffers without querying for confirmation.)
3971 Optional third argument PRESERVE-MODES non-nil means don't alter
3972 the files modes. Normally we reinitialize them using `normal-mode'.
3974 If the value of `revert-buffer-function' is non-nil, it is called to
3975 do all the work for this command. Otherwise, the hooks
3976 `before-revert-hook' and `after-revert-hook' are run at the beginning
3977 and the end, and if `revert-buffer-insert-file-contents-function' is
3978 non-nil, it is called instead of rereading visited file contents."
3980 ;; I admit it's odd to reverse the sense of the prefix argument, but
3981 ;; there is a lot of code out there which assumes that the first
3982 ;; argument should be t to avoid consulting the auto-save file, and
3983 ;; there's no straightforward way to encourage authors to notice a
3984 ;; reversal of the argument sense. So I'm just changing the user
3985 ;; interface, but leaving the programmatic interface the same.
3993 buffer-auto-save-file-name
3998 buffer-auto-save-file-name
3999 buffer-file-name)))
4009 file-name)))
4011 ;; If file was backed up but has changed since,
4012 ;; we shd make another backup.
4016 ;; Effectively copy the after-revert-hook status,
4017 ;; since after-find-file will clobber it.
4020 after-revert-hook))
4025 ;; Get rid of all undo records for this buffer.
4027 ;; Don't make undo records for the reversion.
4030 file-name auto-save-p)))
4033 "File %s no longer exists!"
4035 file-name))
4037 ;; Bind buffer-file-name to nil
4038 ;; so that we don't try to lock the file.
4044 ;; Auto-saved file should be read by Emacs'
4045 ;; internal coding.
4048 buffer-file-coding-system-explicit))))
4049 ;; This force after-insert-file-set-coding
4050 ;; (called from insert-file-contents) to set
4051 ;; buffer-file-coding-system to a proper value.
4054 ;; Note that this preserves point in an intelligent way.
4058 nil nil t))
4060 nil nil t)))))
4061 ;; Recompute the truename in case changes in symlinks
4062 ;; have changed the truename.
4066 ;; Run after-revert-hook as it was before we reverted.
4070 local-hook)
4073 t))))))
4076 "Recover the visited file--get contents from its last auto-save file."
4081 "Visit file FILE, but get contents from its last auto-save file."
4082 ;; Actually putting the file name in the minibuffer should be used
4083 ;; only rarely.
4084 ;; Not just because users often use the default.
4104 ;; Use insert-directory-safely, not insert-directory,
4105 ;; because these files might not exist. In particular,
4106 ;; FILE might not exist if the auto-save file was for
4107 ;; a buffer that didn't visit a file, such as "*mail*".
4108 ;; The code in v20.x called `ls' directly, so we need
4109 ;; to emulate what `ls' did in that case.
4115 ;; Keep the current buffer-file-coding-system.
4117 ;; Auto-saved file should be read with special coding.
4126 "Recover auto save files from a previous Emacs session.
4127 This command first displays a Dired buffer showing you the
4128 previous sessions that you could recover from.
4129 To choose one, move point to the proper line and then type C-c C-c.
4130 Then you'll be asked about a number of files to recover."
4140 auto-save-list-file-prefix)))
4141 t)
4150 ;; Each line starts with a space
4151 ;; so that Font Lock mode won't highlight the first character.
4160 "Choose one saved session to recover auto-save files from.
4161 This command is used in the special Dired buffer created by
4164 ;; Get the name of the session file to recover from.
4166 files
4172 ;; Read in the auto-save-list file.
4176 ;; Loop thru the text of that file
4177 ;; and get out the names of the files to recover.
4181 ;; This is a pair of lines for a non-file-visiting buffer.
4182 ;; Get the auto-save file name and manufacture
4183 ;; a "visited file name" from that.
4186 ;; If there is no auto-save file name, the
4187 ;; auto-save-list file is probably corrupted.
4202 ;; This pair of lines is a file-visiting
4203 ;; buffer. Use the visited file name.
4213 ;; Ignore a file if its auto-save file does not exist now.
4217 ;; The file contains a pair of line for each auto-saved buffer.
4218 ;; The first line of the pair contains the visited file name
4219 ;; or is empty if the buffer was not visiting a file.
4220 ;; The second line is the auto-save file name.
4228 files
4234 "Kill some buffers. Asks the user whether to kill each one of them.
4235 Non-interactively, if optional argument LIST is non-nil, it
4236 specifies the list of buffers to kill, asking for approval for each one."
4244 ; if we killed the base buffer.
4249 name
4254 \f
4256 "Toggle auto-saving of contents of current buffer.
4257 With prefix argument ARG, turn auto-saving on if positive, else off."
4262 ;; If auto-save is off because buffer has shrunk,
4263 ;; then toggling should turn it on.
4268 buffer-file-name
4270 ;; If -1 was stored here, to temporarily turn off saving,
4271 ;; turn it back on.
4277 buffer-auto-save-file-name)
4280 "Adjust current buffer's auto save file name for current conditions.
4281 Also rename any existing auto save file, if it was made in this session."
4293 "Return file name to use for auto-saves of current buffer.
4294 Does not consider `auto-save-visited-file-name' as that variable is checked
4295 before calling this function. You can redefine this for customization.
4296 See also `auto-save-file-name-p'."
4304 result uniq)
4305 ;; Apply user-specified translations
4306 ;; to the file name.
4310 filename)
4320 filename))))
4325 ;; We truncate the file name to DOS 8+3 limits
4326 ;; before doing anything else, because the regexp
4327 ;; passed to string-match below cannot handle
4328 ;; extensions longer than 3 characters, multiple
4329 ;; dots, and other atrocities.
4334 fn)
4339 "#"
4342 ;; Make sure auto-save file names don't contain characters
4343 ;; invalid for the underlying filesystem.
4345 ;; Don't modify remote (ange-ftp) filenames
4348 result))))
4350 ;; Deal with buffers that don't have any associated files. (Mail
4351 ;; mode tends to create a good number of these.)
4355 file-name)
4356 ;; Eliminate all slashes and backslashes by
4357 ;; replacing them with sequences that start with %.
4358 ;; Quote % also, to keep distinct names distinct.
4367 ;; Generate the file name.
4373 ;; Try a few alternative directories, to get one we can
4374 ;; write it.
4380 ;; Don't modify remote (ange-ftp) filenames
4382 ;; The call to convert-standard-filename is in case
4383 ;; buffer-name includes characters not allowed by the
4384 ;; DOS/Windows filesystems. make-temp-file writes to the
4385 ;; file it creates, so we must fix the file name _before_
4386 ;; make-temp-file is called.
4388 fname))
4390 ;; make-temp-file creates the file,
4391 ;; but we don't want it to exist until we do an auto-save.
4395 file-name)))
4398 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4399 FILENAME should lack slashes. You can redefine this for customization."
4401 \f
4403 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4404 The generated regexp will match a filename iff the filename
4405 matches that wildcard according to shell rules. Only wildcards known
4406 by `sh' are supported."
4408 ;; Copy the initial run of non-special characters.
4411 ;; If no special characters, we're almost done.
4415 j)
4417 result
4438 ;; Found "[^". Insert a `\0' character
4439 ;; (which cannot happen in a filename)
4440 ;; into the character class, so that `^'
4441 ;; is not the first character after `[',
4442 ;; and thus non-special in a regexp.
4447 ;; I don't think `]' can appear in a
4448 ;; character class in a wildcard, but
4449 ;; let's be general here.
4456 i
4469 ;; Shell wildcards should match the entire filename,
4470 ;; not its part. Make the regexp say so.
4472 \f
4475 "*Switches for `list-directory' to pass to `ls' for brief listing."
4481 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4483 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4488 "Expand wildcard pattern PATTERN.
4489 This returns a list of file names which match the pattern.
4491 If PATTERN is written as an absolute file name,
4492 the values are absolute also.
4494 If PATTERN is written as a relative file name, it is interpreted
4495 relative to the current default directory, `default-directory'.
4496 The file names returned are normally also relative to the current
4497 default directory. However, if FULL is non-nil, they are absolute."
4501 ;; A list of all dirs that DIRPART specifies.
4502 ;; This can be more than one dir
4503 ;; if DIRPART contains wildcards.
4508 contents)
4513 ;; Filter out "." and ".."
4518 name))
4525 this-dir-contents)
4526 this-dir-contents)
4527 contents))))
4529 contents)))
4532 "Display a list of files in or matching DIRNAME, a la `ls'.
4533 DIRNAME is globbed by the shell if necessary.
4534 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4535 Actions controlled by variables `list-directory-brief-switches'
4536 and `list-directory-verbose-switches'."
4540 nil default-directory nil)
4541 pfx)))
4543 list-directory-brief-switches))
4544 buffer)
4557 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4565 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4567 PATTERN is assumed to represent a file-name wildcard suitable for the
4568 underlying filesystem. For Unix and GNU/Linux, the characters from the
4570 the parts of the pattern which don't include wildcard characters are
4571 quoted with double quotes.
4572 Existing quote characters in PATTERN are left alone, so you can pass
4573 PATTERN that already quotes some of the special characters."
4577 ;; DOS/Windows don't allow `"' in file names. So if the
4578 ;; argument has quotes, we can safely assume it is already
4579 ;; quoted by the caller.
4581 ;; We quote [&()#$'] in case their shell is a port of a
4582 ;; Unixy shell. We quote [,=+] because stock DOS and
4583 ;; Windows shells require that in some cases, such as
4584 ;; passing arguments to batch files that use positional
4585 ;; arguments like %1.
4587 pattern
4590 end)
4607 pattern))))
4614 "*Program to get the amount of free space on a file system.
4615 We assume the output has the format of `df'.
4616 The value of this variable must be just a command name or file name;
4617 if you want to specify options, use `directory-free-space-args'.
4619 A value of nil disables this feature.
4621 If the function `file-system-info' is defined, it is always used in
4622 preference to the program given by this variable."
4628 "*Options to use when running `directory-free-space-program'."
4633 "Return the amount of free space on directory DIR's file system.
4634 The result is a string that gives the number of free 1KB blocks,
4635 or nil if the system call or the program which retrieve the information
4636 fail.
4638 This function calls `file-system-info' if it is available, or invokes the
4639 program specified by `directory-free-space-program' if that is non-nil."
4640 ;; Try to find the number of free blocks. Non-Posix systems don't
4641 ;; always have df, but might have an equivalent system call.
4650 nil t nil
4651 directory-free-space-args
4652 dir)))
4653 ;; Usual format is a header line followed by a line of
4654 ;; numbers.
4659 ;; Move to the end of the "available blocks" number.
4662 ;; Copy it into AVAILABLE.
4667 ;; The following expression replaces `dired-move-to-filename-regexp'.
4671 ;; In some locales, month abbreviations are as short as 2 letters,
4672 ;; and they can be followed by ".".
4673 ;; In Breton, a month name can include a quote character.
4686 s "+"
4689 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4690 ;; omits the Kanji characters after month and day-of-month.
4691 ;; On Mac OS X 10.3, the date format in East Asian locales is
4692 ;; day-of-month digits followed by month digits.
4698 ;; The "[0-9]" below requires the previous column to end in a digit.
4699 ;; This avoids recognizing `1 may 1997' as a date in the line:
4700 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4702 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4703 ;; The ".*" below finds the last match if there are multiple matches.
4704 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4705 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4707 ;; vc dired listings provide the state or blanks between file
4708 ;; permissions and date. The state is always surrounded by
4709 ;; parantheses:
4710 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4711 ;; This is not supported yet.
4715 "Regular expression to match up to the file name in a directory listing.
4716 The default value is designed to recognize dates and times
4721 ;; insert-directory
4722 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4723 ;; FULL-DIRECTORY-P is nil.
4724 ;; The single line of output must display FILE's name as it was
4725 ;; given, namely, an absolute path name.
4726 ;; - must insert exactly one line for each file if WILDCARD or
4727 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4728 ;; before the file lines, plus optional text after the file lines.
4729 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4730 ;; allowed.
4731 ;; File lines should display the basename.
4732 ;; - must be consistent with
4733 ;; - functions dired-move-to-filename, (these two define what a file line is)
4734 ;; dired-move-to-end-of-filename,
4735 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4736 ;; dired-insert-headerline
4737 ;; dired-after-subdir-garbage (defines what a "total" line is)
4738 ;; - variable dired-subdir-regexp
4739 ;; - may be passed "--dired" as the first argument in SWITCHES.
4740 ;; Filename handlers might have to remove this switch if their
4741 ;; "ls" command does not support it.
4743 "Insert directory listing for FILE, formatted according to SWITCHES.
4744 Leaves point after the inserted text.
4745 SWITCHES may be a string of options, or a list of strings
4746 representing individual options.
4747 Optional third arg WILDCARD means treat FILE as shell wildcard.
4748 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4749 switches do not contain `d', so that a full listing is expected.
4751 This works by running a directory listing program
4752 whose name is in the variable `insert-directory-program'.
4753 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4755 When SWITCHES contains the long `--dired' option, this function
4756 treats it specially, for the sake of dired. However, the
4757 normally equivalent short `-D' option is just passed on to
4758 `insert-directory-program', as any other option."
4759 ;; We need the directory in order to find the right handler.
4764 wildcard full-directory-p)
4769 ;; Read the actual directory using `insert-directory-program'.
4770 ;; RESULT gets the status code.
4772 ;; putting text property `dired-filename, decode one
4773 ;; bunch by one to preserve that property.
4775 ;; This is to control encoding the arguments in call-process.
4779 default-file-name-coding-system))))
4782 ;; Run ls in the directory part of the file pattern
4783 ;; using the last component as argument.
4790 shell-file-name nil t nil
4791 "-c"
4793 ""
4795 insert-directory-program
4796 " -d "
4798 switches
4800 " -- "
4801 ;; Quote some characters that have
4802 ;; special meanings in shells; but
4803 ;; don't quote the wildcards--we want
4804 ;; them to be special. We also
4805 ;; currently don't quote the quoting
4806 ;; characters in case people want to
4807 ;; use them explicitly to quote
4808 ;; wildcard characters.
4810 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4811 ;; directory if FILE is a symbolic link.
4813 insert-directory-program nil t nil
4817 ;; Split the switches at any spaces so we can
4818 ;; pass separate options as separate args.
4820 ;; Avoid lossage if FILE starts with `-'.
4828 file))))))))
4830 ;; If we got "//DIRED//" in the output, it means we got a real
4831 ;; directory listing, even if `ls' returned nonzero.
4832 ;; So ignore any errors.
4845 ;; The first time ls returns an error,
4846 ;; find the version numbers of ls,
4847 ;; and set insert-directory-ls-version
4848 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4849 ;; is equal or if the info cannot be obtained.
4850 ;; (That can mean it isn't GNU ls.)
4860 comparison)
4876 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4880 ;; If `insert-directory-program' failed, signal an error.
4882 ;; Delete the error message it may have output.
4884 ;; On non-Posix systems, we cannot open a directory, so
4885 ;; don't even try, because that will always result in
4886 ;; the ubiquitous "Access denied". Instead, show the
4887 ;; command line so the user can try to guess what went wrong.
4892 insert-directory-program
4894 file result)
4895 ;; Unix. Access the file to get a suitable error.
4902 ;; The following overshoots by one line for an empty
4903 ;; directory listed with "--dired", but without "-a"
4904 ;; switch, where the ls output contains a
4905 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4906 ;; We take care of that case later.
4914 error-lines)
4915 ;; Find all the lines that are error messages,
4916 ;; and record the bounds of each one.
4923 ;; Now read the numeric positions of file names.
4930 error-lines))
4933 error-lines)))
4935 ;; End is followed by \n or by " -> ".
4937 ;; It seems that we can't trust ls's output as to
4938 ;; byte positions of filenames.
4944 ;; Take care of the case where the ls output contains a
4945 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4946 ;; and we went one line too far back (see above).
4951 ;; Now decode what read if necessary.
4953 file-name-coding-system
4954 default-file-name-coding-system
4956 coding-no-eol
4957 val pos)
4961 ;; If no coding system is specified or detection is
4962 ;; requested, detect the coding.
4976 ;; Force no eol conversion on a file name, so
4977 ;; that CR is preserved.
4985 ;; Try to insert the amount of free space.
4988 ;; First find the line to put it on.
4992 ;; Replace "total" with "used", to avoid confusion.
4998 "Convert `ls --dired' file name position value POS to a buffer position.
4999 File name position values returned in ls --dired output
5000 count only stdout; they don't count the error messages sent to stderr.
5001 So this function converts to them to real buffer positions.
5002 ERROR-LINES is a list of buffer positions of error message lines,
5003 of the form (START END)."
5007 pos)
5011 "Insert directory listing for FILE, formatted according to SWITCHES.
5013 Like `insert-directory', but if FILE does not exist, it inserts a
5014 message to that effect instead of signaling an error."
5017 ;; Simulate the message printed by `ls'.
5021 "Functions to call with no arguments to query about killing Emacs.
5022 If any of these functions returns nil, killing Emacs is cancelled.
5024 but `kill-emacs', the low level primitive, does not.
5028 "How to ask for confirmation when leaving Emacs.
5029 If nil, the default, don't ask at all. If the value is non-nil, it should
5030 be a predicate function such as `yes-or-no-p'."
5038 "Offer to save each buffer, then kill this Emacs process.
5039 With prefix arg, silently save all file-visiting buffers, then kill."
5048 ;; process-list is not defined on VMS.
5050 active)
5059 ;; Query the user for other things, perhaps.
5064 \f
5065 ;; We use /: as a prefix to "quote" a file name
5066 ;; so that magic file name handlers will not apply to it.
5070 file-name-handler-alist))
5072 ;; We depend on being the last handler on the list,
5073 ;; so that anything else which does need handling
5074 ;; has been handled already.
5075 ;; So it is safe for us to inhibit *all* magic file name handlers.
5084 default-directory))
5085 ;; Get a list of the indices of the args which are file names.
5088 ;; The first six are special because they
5089 ;; return a file name. We want to include the /:
5090 ;; in the return value.
5091 ;; So just avoid stripping it in the first place.
5098 ;; `identity' means just return the first arg
5099 ;; not stripped of its quoting.
5101 ;; `add' means add "/:" to the result.
5103 ;; `quote' means add "/:" to buffer-file-name.
5105 ;; `unquote-then-quote' means set buffer-file-name
5106 ;; temporarily to unquoted filename.
5108 ;; List the arguments which are filenames.
5116 ;; For all other operations, treat the first argument only
5117 ;; as the file name.
5119 method
5120 ;; Copy ARGUMENTS so we can replace elements in it.
5124 ;; Strip off the /: from the file names that have it.
5132 "/"
5148 res))
5151 \f
5176 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5177 ;;; files.el ends here