| blob | bb2342c2cefcac96d01a8eb45eec3ffbcaced068 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
37 "Backups of edited data files."
41 "Finding files."
46 "*Non-nil means delete auto-save file when a buffer is saved or killed.
48 Note that the auto-save file will not be deleted if the buffer is killed
49 when it has unsaved changes."
54 nil
55 "*Alist of abbreviations for file directories.
56 A list of elements of the form (FROM . TO), each meaning to replace
57 FROM with TO when it appears in a directory name. This replacement is
58 done when setting up the default directory of a newly visited file.
59 *Every* FROM string should start with `^'.
61 Do not use `~' in the TO strings.
62 They should be ordinary absolute directory names.
64 Use this feature when you have directories which you normally refer to
65 via absolute symbolic links. Make TO the name of the link, and FROM
66 the name it is linked to."
74 ;; Turn off backup files on VMS since it has version numbers.
76 "*Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
105 "*Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
111 "*Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
118 "*Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
128 "*Non-nil means create backups by copying to preserve a privileged owner.
129 Renaming may still be used (subject to control of other variables)
130 when it would not result in changing the owner of the file or if the owner
131 has a user id greater than the value of this variable. This is useful
132 when low-numbered uid's are used for special system users (such as root)
133 that must maintain ownership of certain files.
134 This variable is relevant only if `backup-by-copying' and
135 `backup-by-copying-when-mismatch' are nil."
140 "Predicate that looks at a file name and decides whether to make backups.
144 "*Non-nil in a buffer means always offer to save buffer on exit.
145 Do so even if the buffer is not visiting a file.
146 Automatically local in all buffers."
152 "*Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
159 "*Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
166 "*Specify which files should be reverted without query.
167 The value is a list of regular expressions.
168 If the file name matches one of these regular expressions,
169 then `revert-buffer' reverts the file without querying
170 if the file has changed on disk and you have not edited the buffer."
175 "The device number and file number of the file visited in the current buffer.
176 The value is a list of the form (FILENUM DEVNUM).
177 This pair of numbers uniquely identifies the file.
197 "The directory for writing temporary files."
203 "The directory for writing small temporary files.
204 If non-nil, this directory is used instead of `temporary-file-directory'
205 by programs that create small temporary files. This is for systems that
206 have fast storage with limited space, such as a RAM disk."
210 ;; The system null device. (Should reference NULL_DEVICE from C.)
227 "*Non-nil means protect against I/O errors while saving files.
228 Some modes set this non-nil in particular buffers.
230 This feature works by writing the new contents into a temporary file
231 and then renaming the temporary file to replace the original.
232 In this way, any I/O error in writing leaves the original untouched,
233 and there is never any instant where the file is nonexistent.
235 Note that this feature forces backups to be made by copying.
236 Yet, at the same time, saving a precious file
237 breaks any hard links between it and other files."
242 "*Control use of version numbers for backup files.
243 t means make numeric backup versions unconditionally.
244 nil means make them for files that have some already.
245 `never' means do not make them."
253 "*When cleaning directory, number of versions to keep."
259 "*If t, delete excess backup versions silently.
260 If nil, ask confirmation. Any other value prevents any trimming."
267 "*Number of oldest versions to keep when a new numbered backup is made."
272 "*Number of newest versions to keep when a new numbered backup is made.
273 Includes the new backup. Must be > 0"
278 "*Whether to add a newline automatically at the end of the file.
280 A value of t means do this only when the file is about to be saved.
281 A value of `visit' means do this right after the file is visited.
282 A value of `visit-save' means do it at both of those times.
283 Any other non-nil value means ask user whether to add a newline, when saving.
284 nil means don't add newlines.
286 Certain major modes set this locally to the value obtained
287 from `mode-require-final-newline'."
296 "*Whether to add a newline at end of file, in certain major modes.
297 Those modes set `require-final-newline' to this value when you enable them.
298 They do so because they are often used for files that are supposed
299 to end in newlines, and the question is how to arrange that.
301 A value of t means do this only when the file is about to be saved.
302 A value of `visit' means do this right after the file is visited.
303 A value of `visit-save' means do it at both of those times.
304 Any other non-nil value means ask user whether to add a newline, when saving.
306 nil means do not add newlines. That is a risky choice in this variable
307 since this value is used for modes for files that ought to have final newlines.
308 So if you set this to nil, you must explicitly check and add
309 a final newline, whenever you save a file that really needs one."
319 "*Non-nil says by default do auto-saving of every file-visiting buffer."
324 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
325 Normally auto-save files are written under other names."
331 ;; Don't put "\\2" inside expand-file-name, since it will be
332 ;; transformed to "/2" on DOS/Windows.
334 "*Transforms to apply to buffer file name before making auto-save file name.
335 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
336 REGEXP is a regular expression to match against the file name.
337 If it matches, `replace-match' is used to replace the
338 matching part with REPLACEMENT.
339 If the optional element UNIQUIFY is non-nil, the auto-save file name is
340 constructed by taking the directory part of the replaced file-name,
341 concatenated with the buffer file name with all directory separators
342 changed to `!' to prevent clashes. This will not work
343 correctly if your filesystem truncates the resulting name.
345 All the transforms in the list are tried, in the order they are listed.
346 When one transform applies, its result is final;
347 no further transforms are tried.
349 The default value is set up to put the auto-save file into the
350 temporary directory (see the variable `temporary-file-directory') for
351 editing a remote file.
353 On MS-DOS filesystems without long names this variable is always
354 ignored."
361 "*Non-nil means save word abbrevs too when files are saved.
362 If `silently', don't ask the user before saving."
367 "*Non-nil means allow `find-file' to visit directories.
368 To visit the directory, `find-file' runs `find-directory-functions'."
373 "*List of functions to try in sequence to visit a directory.
374 Each function is called with the directory name as the sole argument
375 and should return either a buffer or nil."
379 ;;;It is not useful to make this a local variable.
380 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
382 "List of functions to be called for `find-file' on nonexistent file.
383 These functions are called as soon as the error is detected.
384 Variable `buffer-file-name' is already set up.
389 ;;;It is not useful to make this a local variable.
390 ;;;(put 'find-file-hooks 'permanent-local t)
392 "List of functions to be called after a buffer is loaded from a file.
393 The buffer's local variables (if any) will have been processed before the
394 functions are called."
402 "List of functions to be called before writing out a buffer to a file.
403 If one of them returns non-nil, the file is considered already written
404 and the rest are not called.
405 These hooks are considered to pertain to the visited file.
406 So any buffer-local binding of this variable is discarded if you change
408 change the major mode.
410 This hook is not run if any of the functions in
411 `write-contents-functions' returns non-nil. Both hooks pertain
412 to how to save a buffer to file, for instance, choosing a suitable
413 coding system and setting mode bits. (See Info
414 node `(elisp)Saving Buffers'.) To perform various checks or
425 "List of functions to be called before writing out a buffer to a file.
426 If one of them returns non-nil, the file is considered already written
427 and the rest are not called and neither are the functions in
428 `write-file-functions'.
430 This variable is meant to be used for hooks that pertain to the
431 buffer's contents, not to the particular visited file; thus,
432 `set-visited-file-name' does not clear this variable; but changing the
433 major mode does clear it.
435 For hooks that _do_ pertain to the particular visited file, use
436 `write-file-functions'. Both this variable and
437 `write-file-functions' relate to how a buffer is saved to file.
438 To perform various checks or updates before the buffer is saved,
445 "*Control use of local variables in files you visit.
446 The value can be t, nil or something else.
447 A value of t means file local variables specifications are obeyed;
448 nil means they are ignored; anything else means query.
449 This variable also controls use of major modes specified in
450 a -*- line.
453 always obeys file local variable specifications and the -*- line,
454 and ignores this variable."
461 "Like `enable-local-variables' but meant for buffer-local bindings.
462 The meaningful values are nil and non-nil. The default is non-nil.
463 If a major mode sets this to nil, buffer-locally, then any local
464 variables list in the file will be ignored.
466 This variable does not affect the use of major modes
471 The value can be t, nil or something else.
472 A value of t means obey `eval' variables;
473 nil means ignore them; anything else means query."
479 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
488 "*Non-nil means buffers visiting files read-only do so in view mode.
489 In fact, this means that all read-only buffers normally have
490 View mode enabled, including buffers that are read-only because
491 you visit a file you cannot alter, and buffers you make read-only
498 "Provides support for ange-ftp host name completion.
499 Runs the usual ange-ftp hook, but only for completion operations."
500 ;; Having this here avoids the need to load ange-ftp when it's not
501 ;; really in use.
507 inhibit-file-name-handlers)))
512 "Convert a standard file's name to something suitable for the OS.
513 This means to guarantee valid names and perhaps to canonicalize
514 certain patterns.
516 FILENAME should be an absolute file name since the conversion rules
517 sometimes vary depending on the position in the file name. E.g. c:/foo
518 is a valid DOS file name, but c:/bar/c:/foo is not.
520 This function's standard definition is trivial; it just returns
521 the argument. However, on Windows and DOS, replace invalid
522 characters. On DOS, make sure to obey the 8.3 limitations. On
523 Windows, turn Cygwin names into native names, and also turn
524 slashes into backslashes if the shell requires it (see
525 `w32-shell-dos-semantics').
527 See Info node `(elisp)Standard File Names' for more details."
528 filename)
531 "Read directory name, prompting with PROMPT and completing in directory DIR.
532 Value is not expanded---you must call `expand-file-name' yourself.
533 Default name to DEFAULT-DIRNAME if user exits with the same
534 non-empty string that was inserted by this function.
535 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
536 or just DIR if INITIAL is nil.)
537 If the user exits with an empty minibuffer, this function returns
538 an empty string. (This can only happen if the user erased the
539 pre-inserted contents or if `insert-default-directory' is nil.)
540 Fourth arg MUSTMATCH non-nil means require existing directory's name.
541 Non-nil and non-t means also require confirmation after completion.
542 Fifth arg INITIAL specifies text to start with.
543 DIR should be an absolute directory name. It defaults to
544 the value of `default-directory'."
549 dir))
550 mustmatch initial
553 \f
555 "Show the current default directory."
560 "Value of the CDPATH environment variable, as a list.
564 "Explode a search path into a list of directory names.
565 Directories are separated by occurrences of `path-separator'
566 \(which is colon in GNU and GNU-like systems)."
567 ;; We could use split-string here.
575 nil
580 cd-list)))
583 "Change current directory to given absolute file name DIR."
584 ;; Put the name into directory syntax now,
585 ;; because otherwise expand-file-name may give some bad results.
598 "Make DIR become the current buffer's default directory.
599 If your environment includes a `CDPATH' variable, try each one of
600 that list of directories (separated by occurrences of
601 `path-separator') when resolving a relative directory name.
602 The path separator is colon in GNU and GNU-like systems."
605 default-directory default-directory
621 cd-path)
622 nil))
626 "Load the Lisp file named FILE."
627 ;; This is a case where .elc makes a lot of sense.
634 "Search for FILENAME through PATH.
635 If found, return the absolute file name of FILENAME, with its suffixes;
636 otherwise return nil.
637 PATH should be a list of directories to look in, like the lists in
638 `exec-path' or `load-path'.
639 If SUFFIXES is non-nil, it should be a list of suffixes to append to
642 If non-nil, PREDICATE is used instead of `file-readable-p'.
643 PREDICATE can also be an integer to pass to the `access' system call,
644 in which case file-name handlers are ignored. This usage is deprecated.
646 For compatibility, PREDICATE can also be one of the symbols
647 `executable', `readable', `writable', or `exists', or a list of
648 one or more of those symbols."
659 "Do completion for file names passed to `locate-file'.
660 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
683 "Search for COMMAND in `exec-path' and return the absolute file name.
684 Return nil if COMMAND is not found anywhere in `exec-path'."
685 ;; Use 1 rather than file-executable-p to better match the behavior of
686 ;; call-process.
690 "Load the library named LIBRARY.
691 This is an interface to the function `load'."
694 'locate-file-completion
699 "Test whether FILE specifies a location on a remote system.
700 Return an identification of the system if the location is indeed
701 remote. The identification of the system may comprise a method
702 to access the system and its hostname, amongst other things.
709 nil)))
712 "Copy the file FILE into a temporary file on this machine.
713 Returns the name of the local copy, or nil, if FILE is directly
714 accessible."
715 ;; This formerly had an optional BUFFER argument that wasn't used by
716 ;; anything.
720 nil)))
723 "Return the truename of FILENAME, which should be absolute.
724 The truename of a file name is found by chasing symbolic links
725 both at the level of the file and at the level of the directories
726 containing it, until no links are left at any level.
729 ;; COUNTER and PREV-DIRS are only used in recursive calls.
730 ;; COUNTER can be a cons cell whose car is the count of how many
731 ;; more links to chase before getting an error.
732 ;; PREV-DIRS can be a cons cell whose car is an alist
733 ;; of truenames we've just recently computed.
747 ;; For speed, remove the ange-ftp completion handler from the list.
748 ;; We know it's not needed here.
749 ;; For even more speed, do this only on the outermost call.
756 ;; andrewi@harlequin.co.uk - none of the following code (except for
757 ;; invoking the file-name handler) currently applies on Windows
758 ;; (ie. there are no native symlinks), but there is an issue with
759 ;; case differences being ignored by the OS, and short "8.3 DOS"
760 ;; name aliases existing for all files. (The short names are not
761 ;; reported by directory-files, but can be used to refer to files.)
762 ;; It seems appropriate for file-truename to resolve these issues in
763 ;; the most natural way, which on Windows is to call the function
764 ;; `w32-long-file-name' - this returns the exact name of a file as
765 ;; it is stored on disk (expanding short name aliases with the full
766 ;; name in the process).
769 ;; For file name that has a special handler, call handler.
770 ;; This is so that ange-ftp can save time by doing a no-op.
773 ;; If filename contains a wildcard, newname will be the old name.
775 ;; If filename exists, use the long name
779 ;; If this file directly leads to a link, process that iteratively
780 ;; so that we don't use lots of stack.
786 ;; For file name that has a special handler, call handler.
787 ;; This is so that ange-ftp can save time by doing a no-op.
790 done t)
792 target dirfile)
793 ;; Get the truename of the directory.
795 ;; If these are equal, we have the (or a) root directory.
797 ;; If this is the same dir we last got the truename for,
798 ;; save time--don't recalculate.
808 done t)
811 done t)
812 ;; Put it back on the file name.
814 ;; Is the file name the name of a link?
817 ;; Yes => chase that link, then start all over
818 ;; since the link may point to a directory name that uses links.
819 ;; We can't safely use expand-file-name here
820 ;; since target might look like foo/../bar where foo
821 ;; is itself a link. Instead, we handle . and .. above.
824 target
826 done nil)
827 ;; No, we are done!
829 filename))
832 "Chase links in FILENAME until a name that is not a link.
833 Unlike `file-truename', this does not check whether a parent
834 directory name is a symbolic link.
835 If the optional argument LIMIT is a number,
836 it means chase no more than that many links and then stop."
844 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
847 ;; Handle `..' by hand, since it needs to work in the
848 ;; target of any directory symlink.
849 ;; This code is not quite complete; it does not handle
850 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
854 ;; Chase links in the default dir of the symlink.
858 ;; Now find the parent of that dir.
862 newname))
865 "Create a temporary file.
866 The returned file name (created by appending some random characters at the end
867 of PREFIX, and expanding against `temporary-file-directory' if necessary),
868 is guaranteed to point to a newly created empty file.
869 You can then use `write-region' to write new data into the file.
871 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
873 If SUFFIX is non-nil, add that at the end of the file name."
875 file)
878 ;; Create temp files with strict access rights. It's easy to
879 ;; loosen them later, whereas it's impossible to close the
880 ;; time-window of loose permissions otherwise.
892 nil)
894 ;; the file was somehow created by someone else between
895 ;; `make-temp-name' and `write-region', let's try again.
896 nil)
897 file)
898 ;; Reset the umask.
902 "Change the encoding of FILE's name from CODING to NEW-CODING.
903 The value is a new name of FILE.
904 Signals a `file-already-exists' error if a file of the new name
905 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
906 is non-nil. A number as fourth arg means request confirmation if
907 the new name already exists. This is what happens in interactive
908 use with M-x."
911 default-file-name-coding-system))
913 from-coding to-coding)
915 ;; We provide the default coding only when it seems that
916 ;; the filename is correctly decoded by the default
917 ;; coding.
923 filename default-coding)
924 default-coding))
928 ;; We provide the default coding only when a user is going to
929 ;; change the encoding not from the default coding.
933 filename from-coding)))
936 filename from-coding default-coding)
937 default-coding)))
941 default-file-name-coding-system))
942 ;; FILE should have been decoded by DEFAULT-CODING.
946 ;; Suppress further encoding.
951 newname))
952 \f
954 "Select buffer BUFFER in another window.
955 If BUFFER does not identify an existing buffer, then this function
956 creates a buffer with that name.
958 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
959 or nil. If BUFFER is nil, then this function chooses a buffer
960 using `other-buffer'.
961 Optional second arg NORECORD non-nil means
962 do not put this buffer at the front of the list of recently selected ones.
963 This function returns the buffer it switched to.
965 This uses the function `display-buffer' as a subroutine; see its
966 documentation for additional customization information."
969 ;; Don't let these interfere.
970 same-window-buffer-names same-window-regexps)
974 "Switch to buffer BUFFER in another frame.
975 Optional second arg NORECORD non-nil means
976 do not put this buffer at the front of the list of recently selected ones.
978 This uses the function `display-buffer' as a subroutine; see its
979 documentation for additional customization information."
982 same-window-buffer-names same-window-regexps)
990 "Add FUN to `minibuffer-setup-hook' while executing BODY.
991 BODY should use the minibuffer at most once.
992 Recursive uses of the minibuffer will not be affected."
998 ;; Clear out this hook so it does not interfere
999 ;; with any recursive minibuffer usage.
1015 t))
1018 "Edit file FILENAME.
1019 Switch to a buffer visiting file FILENAME,
1020 creating one if none already exists.
1021 Interactively, the default if you just type RET is the current directory,
1022 but the visited file name is available through the minibuffer history:
1023 type M-n to pull it into the minibuffer.
1025 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1026 expand wildcards (if any) and visit multiple files. You can
1027 suppress wildcard expansion by setting `find-file-wildcards'.
1029 To visit a file without any kind of conversion and without
1038 "Edit file FILENAME, in another window.
1039 May create a new window, or reuse an existing one.
1040 See the function `display-buffer'.
1042 Interactively, the default if you just type RET is the current directory,
1043 but the visited file name is available through the minibuffer history:
1044 type M-n to pull it into the minibuffer.
1046 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1047 expand wildcards (if any) and visit multiple files."
1058 "Edit file FILENAME, in another frame.
1059 May create a new frame, or reuse an existing one.
1060 See the function `display-buffer'.
1062 Interactively, the default if you just type RET is the current directory,
1063 but the visited file name is available through the minibuffer history:
1064 type M-n to pull it into the minibuffer.
1066 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1067 expand wildcards (if any) and visit multiple files."
1078 "Edit the existing file FILENAME.
1086 "Edit file FILENAME but don't allow changes.
1098 value))
1101 "Edit file FILENAME in another window but don't allow changes.
1113 value))
1116 "Edit file FILENAME in another frame but don't allow changes.
1128 value))
1131 "Find file FILENAME as a replacement for the file in the next window.
1132 This command does not select that window.
1134 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1135 expand wildcards (if any) and replace the file with multiple files."
1147 t))))
1155 "Find file FILENAME, select its buffer, kill previous buffer.
1156 If the current buffer now contains an empty file that you just visited
1157 \(presumably by mistake), use this command to visit the file you really want.
1159 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1160 expand wildcards (if any) and replace the file with multiple files."
1170 t)))
1191 ;; This prevents us from finding the same buffer
1192 ;; if we specified the same file again.
1196 ;; Likewise for dired buffers.
1200 ;; This executes if find-file gets an error
1201 ;; and does not really find anything.
1202 ;; We put things back as they were.
1203 ;; If find-file actually finds something, we kill obuf below.
1212 ;; We already asked; don't ask again.
1215 \f
1217 "Create a suitably named buffer for visiting FILENAME, and return it.
1218 FILENAME (sans directory) is used unchanged if that name is free;
1219 otherwise a string <2> or <3> or ... is appended to get an unused name."
1226 "Create and return a buffer with a name based on NAME.
1227 Choose the buffer's name using `generate-new-buffer-name'."
1231 "Regexp to match the automounter prefix in a directory name."
1239 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1241 removes automounter prefixes (see the variable `automount-dir-prefix')."
1242 ;; Get rid of the prefixes added by the automounter.
1249 ;; If any elt of directory-abbrev-alist matches this name,
1250 ;; abbreviate accordingly.
1256 ;; Compute and save the abbreviated homedir name.
1257 ;; We defer computing this until the first time it's needed, to
1258 ;; give time for directory-abbrev-alist to be set properly.
1259 ;; We include a slash at the end, to avoid spurious matches
1260 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1267 ;; If FILENAME starts with the abbreviated homedir,
1268 ;; make it start with `~' instead.
1270 ;; If the home dir is just /, don't change it.
1273 ;; MS-DOS root directories can come with a drive letter;
1274 ;; Novell Netware allows drive letters beyond `Z:'.
1284 filename))
1287 "*List of logical names for which visiting shouldn't save the true dirname.
1288 On VMS, when you visit a file using a logical name that searches a path,
1289 you may or may not want the visited file name to record the specific
1290 directory where the file was found. If you *do not* want that, add the logical
1291 name to this list as a string."
1296 "Return the buffer visiting file FILENAME (a string).
1297 This is like `get-file-buffer', except that it checks for any buffer
1298 visiting the same file, possibly under a different name.
1299 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1300 and others are ignored.
1301 If there is no such live buffer, return nil."
1315 found)
1320 number
1325 ;; Verify this buffer's file number
1326 ;; still belongs to its file.
1329 attributes)
1333 found))))
1334 \f
1336 "*Non-nil means file-visiting commands should handle wildcards.
1337 For example, if you specify `*.c', that would visit all the files
1338 whose names match the pattern."
1344 "*Non-nil means suppress warning messages for symlinked files.
1345 When nil, Emacs prints a warning when visiting a file that is already
1346 visited, but with a different name. Setting this option to t
1347 suppresses this warning."
1353 "Maximum size of file above which a confirmation is requested.
1354 When nil, never request confirmation."
1361 "Read file FILENAME into a buffer and return the buffer.
1362 If a buffer exists visiting FILENAME, return that one, but
1363 verify that the file has not changed since visited or saved.
1364 The buffer is not selected, just returned to the caller.
1365 Optional second arg NOWARN non-nil means suppress any warning messages.
1366 Optional third arg RAWFILE non-nil means the file is read literally.
1367 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1368 and visit all the matching files. When wildcards are actually
1369 used and expanded, return a list of buffers that are visiting
1370 the various files."
1377 'find-directory-functions
1380 filename)))
1383 find-file-wildcards
1397 ;; Find any buffer for a file which has same truename.
1399 ;; Let user know if there is a buffer with the same truename.
1403 find-file-suppress-same-file-warnings
1407 ;; Optionally also find that buffer.
1410 ;; Check to see if the file looks uncommonly large.
1412 ;; Don't ask again if we already have the file or
1413 ;; if we're asked to be quiet.
1422 ;; We are using an existing buffer.
1428 ;; Certain files should be reverted automatically
1429 ;; if they have changed on disk and not in the buffer.
1437 found))
1447 "File %s changed on disk. Discard your edits? "
1452 "File %s changed on disk. Discard your edits in %s? "
1460 ;; Check if a formerly read-only file has become
1461 ;; writable and vice versa, but if the buffer agrees
1462 ;; with the new state of the file, that is ok too.
1469 buffer-file-name
1477 ;; It is confusing to ask whether to visit
1478 ;; non-literally if they have the file in
1479 ;; hexl-mode.
1483 "Save file and revisit literally? "
1488 rawfile truename number))
1490 "Discard your edits and revisit file literally? "
1493 rawfile truename number)
1497 "Revisit file literally? "
1500 rawfile truename number)
1503 ;; Return the buffer we are using.
1504 buf)
1505 ;; Create a new buffer.
1507 ;; find-file-noselect-1 may use a different buffer.
1509 rawfile truename number))))))
1515 ;; Needed in case we are re-visiting the file with a different
1516 ;; text representation.
1533 filename)))
1534 ;; Unconditionally set error
1544 filename)))
1545 ;; Run find-file-not-found-hooks until one returns non-nil.
1547 ;; If they fail too, set error.
1549 ;; Record the file's truename, and maybe use that as visited name.
1555 ;; On VMS, we may want to remember which directory in a search list
1556 ;; the file was found in.
1568 ;; Set buffer's default directory to that of the file.
1570 ;; Turn off backup files for certain file names. Since
1571 ;; this is a permanent local, the major mode won't eliminate it.
1585 \f
1587 "Like `insert-file-contents', but only reads in the file literally.
1588 A buffer may be modified in several ways after reading into the buffer,
1589 to Emacs features such as format decoding, character code
1590 conversion, `find-file-hook', automatic uncompression, etc.
1592 This function ensures that none of these modifications will take place."
1600 nil))
1603 inhibit-file-name-handlers))
1616 filename)))
1626 "Insert contents of file FILENAME into buffer after point with no conversion.
1628 This function is meant for the user to run interactively.
1629 Don't call it from programs! Use `insert-file-contents-literally' instead.
1630 \(Its calling sequence is different; see its documentation)."
1635 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1640 "Visit file FILENAME with no conversion of any kind.
1641 Format conversion and character code conversion are both disabled,
1642 and multibyte characters are disabled in the resulting buffer.
1643 The major mode used is Fundamental mode regardless of the file name,
1644 and local variable specifications in the file are ignored.
1645 Automatic uncompression and adding a newline at the end of the
1646 file due to `require-final-newline' is also disabled.
1648 You cannot absolutely rely on this function to result in
1649 visiting the file literally. If Emacs already has a buffer
1650 which is visiting the file, you get the existing buffer,
1651 regardless of whether it was created literally or not.
1653 In a Lisp program, if you want to be sure of accessing a file's
1654 contents literally, you should create a temporary buffer and then read
1655 the file contents into it using `insert-file-contents-literally'."
1658 \f
1662 after-find-file-from-revert-buffer
1663 nomodes)
1664 "Called after finding a file and by the default revert function.
1665 Sets buffer mode, parses local variables.
1666 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1667 error in reading the file. WARN non-nil means warn if there
1668 exists an auto-save file more recent than the visited file.
1669 NOAUTO means don't mess with auto-save mode.
1670 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1671 means this call was from `revert-buffer'.
1672 Fifth arg NOMODES non-nil means don't alter the file's modes.
1673 Finishes by calling the functions in `find-file-hook'
1674 unless NOMODES is non-nil."
1677 nil
1687 ;; No need to warn if buffer is auto-saved
1688 ;; under the name of the visited file.
1690 auto-save-visited-file-name))
1693 buffer-file-name))
1713 ;; Make people do a little extra work (C-x C-q)
1714 ;; before altering a backup file.
1717 ;; When a file is marked read-only,
1718 ;; make the buffer read-only even if root is looking at it.
1726 ;; If requested, add a newline at the end of the file.
1736 view-read-only
1742 "Eval BODY and turn any error into a FORMAT message.
1743 FORMAT can have a %s escape which will be replaced with the actual error.
1744 If `debug-on-error' is set, errors are not caught, so that you can
1745 debug them.
1746 Avoid using a large BODY since it is duplicated."
1755 "Choose the major mode for this buffer automatically.
1756 Also sets up any specified local variables of the file.
1757 Uses the visited file name, the -*- line, and the local variables spec.
1759 This function is called automatically from `find-file'. In that case,
1760 we may set up the file-specified mode and local variables,
1761 depending on the value of `enable-local-variables': if it is t, we do;
1762 if it is nil, we don't; otherwise, we query.
1763 In addition, if `local-enable-local-variables' is nil, we do
1764 not set local variables (though we do notice a mode specified with -*-.)
1766 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1767 or from Lisp without specifying the optional argument FIND-FILE;
1768 in that case, this function acts as if `enable-local-variables' were t."
1776 ;; Turn font lock off and on, to make sure it takes account of
1777 ;; whatever file local variables are relevant to it.
1779 ;; Font-lock-mode (now in font-core.el) can be ON when
1780 ;; font-lock.el still hasn't been loaded.
1790 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1791 ;; c++-mode, java-mode and more) are added through autoload
1792 ;; directives in that file. That way is discouraged since it
1793 ;; spreads out the definition of the initial value.
1823 ;; Less common extensions come here
1824 ;; so more common ones above are found faster.
1863 ;; The list of archive file extensions should be in sync with
1864 ;; `auto-coding-alist' with `no-conversion' coding system.
1868 ;; Mailer puts message to be edited in
1869 ;; /tmp/Re.... or Message
1873 ;; some news reader is reported to use this
1882 ;; .emacs or .gnus or .viper following a directory delimiter in
1883 ;; Unix, MSDOG or VMS syntax.
1886 ;; _emacs following a directory delimiter
1887 ;; in MsDos syntax
1906 ;; Windows candidates may be opened case sensitively on Unix
1912 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1914 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1915 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
1916 ;; either user's dot-files or under /etc or some such
1918 ;; alas not all ~/.*rc files are like this
1919 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1924 ;; this contains everything twice, with space and with colon :-(
1926 ;; Get rid of any trailing .n.m and try again.
1927 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1928 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1929 ;; Using mode nil rather than `ignore' would let the search continue
1930 ;; through this list (with the shortened name) rather than start over.
1932 ;; The following should come after the ChangeLog pattern
1933 ;; for the sake of ChangeLog.1, etc.
1934 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1937 "Alist of filename patterns vs corresponding major mode functions.
1938 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1939 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1940 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1941 mode function to use. FUNCTION will be called, unless it is nil.
1943 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1944 calling FUNCTION (if it's not nil), we delete the suffix that matched
1945 REGEXP and search the list again for another match.
1947 If the file name matches `inhibit-first-line-modes-regexps',
1948 then `auto-mode-alist' is not processed.
1950 See also `interpreter-mode-alist', which detects executable script modes
1951 based on the interpreters they specify to run,
1955 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1956 ;; and pike-mode) are added through autoload directives in that
1957 ;; file. That way is discouraged since it spreads out the
1958 ;; definition of the initial value.
1996 "Alist mapping interpreter names to major modes.
1997 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
1998 Each element looks like (INTERPRETER . MODE).
1999 If INTERPRETER matches the name of the interpreter specified in the first line
2000 of a script, mode MODE is enabled.
2008 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2009 When checking `inhibit-first-line-modes-regexps', we first discard
2015 "Regexp matching interpreters, for file mode determination.
2016 This regular expression is matched against the first line of a file
2017 to determine the file's mode in `set-auto-mode'. If it matches, the file
2018 is assumed to be interpreted by the interpreter matched by the second group
2019 of the regular expression. The mode is then determined as the mode
2024 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2028 comment-re "*"
2031 . html-mode)
2032 ;; These two must come after html, because they are more general:
2037 . sgml-mode)
2040 "Alist of buffer beginnings vs. corresponding major mode functions.
2041 Each element looks like (REGEXP . FUNCTION). After visiting a file,
2042 if REGEXP matches the text at the beginning of the buffer,
2043 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
2044 to decide the buffer's major mode.
2046 If FUNCTION is nil, then it is not called. (That is a way of saying
2050 "Select major mode appropriate for current buffer.
2052 This checks for a -*- mode tag in the buffer's text, checks the
2053 interpreter that runs this file against `interpreter-mode-alist',
2054 compares the buffer beginning against `magic-mode-alist', or
2055 compares the filename against the entries in `auto-mode-alist'.
2057 It does not check for the `mode:' local variable in the
2058 Local Variables section of the file; for that, use `hack-local-variables'.
2060 If `enable-local-variables' is nil, this function does not check for a
2061 -*- mode tag.
2063 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2064 only set the major mode, if that would change it."
2065 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2067 ;; Find a -*- mode tag
2074 ;; Find all specifications for the `mode:' variable
2075 ;; and execute them left to right.
2087 modes)))
2088 ;; Simple -*-MODE-*- case.
2091 modes))))
2092 ;; If we found modes to use, invoke them now, outside the save-excursion.
2100 ;; continuing would call minor modes again, toggling them off
2103 ;; If we didn't, look for an interpreter specified in the first line.
2104 ;; As a special case, allow for things like "#!/bin/env perl", which
2105 ;; finds the interpreter anywhere in $PATH.
2111 ;; Map interpreter name to a mode, signalling we're done at the
2112 ;; same time.
2114 interpreter-mode-alist))
2115 ;; If we found an interpreter mode to use, invoke it now.
2118 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2126 ;; Compare the filename against the entries in auto-mode-alist.
2129 ;; Remove backup-suffixes from file name.
2132 ;; Find first matching alist entry.
2145 ;; When `keep-mode-if-same' is set, we are working on behalf of
2146 ;; set-visited-file-name. In that case, if the major mode specified is the
2147 ;; same one we already have, don't actually reset it. We don't want to lose
2148 ;; minor modes such as Font Lock.
2150 "Apply MODE and return it.
2151 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2152 any aliases and compared to current major mode. If they are the
2153 same, do nothing and return nil."
2161 mode))
2164 "Find the -*- spec in the buffer.
2165 Call with point at the place to start searching from.
2166 If one is found, set point to the beginning
2167 and return the position of the end.
2168 Otherwise, return nil; point may be changed."
2171 ;; Don't look for -*- if this file name matches any
2172 ;; of the regexps in inhibit-first-line-modes-regexps.
2180 sufs)
2188 ;; If the file begins with "#!"
2189 ;; (exec interpreter magic), look
2190 ;; for mode frobs in the first two
2191 ;; lines. You cannot necessarily
2192 ;; put them in the first line of
2193 ;; such a file without screwing up
2194 ;; the interpreter invocation.
2205 end))))
2214 ;; If we fail to switch in the selected window,
2215 ;; it is probably a minibuffer or dedicated window.
2216 ;; So try another window.
2218 ;; Refrain from popping up frames since it can't
2219 ;; be undone by save-window-excursion.
2230 "Set local variables specified in the -*- line.
2231 Ignore any specification for `mode:' and `coding:';
2232 `set-auto-mode' should already have handled `mode:',
2233 `set-auto-coding' should already have handled `coding:'.
2234 If MODE-ONLY is non-nil, all we do is check whether the major mode
2235 is specified, returning t if it is specified."
2240 mode-specified
2243 ;; Parse the -*- line into the RESULT alist.
2244 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2246 nil)
2248 ;; Simple form: "-*- MODENAME -*-". Already handled.
2250 nil)
2252 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2253 ;; (last ";" is optional).
2258 ;; There used to be a downcase here,
2259 ;; but the manual didn't say so,
2260 ;; and people want to set var names that aren't all lc.
2267 ;; It is traditional to ignore
2268 ;; case when checking for `mode' in set-auto-mode,
2269 ;; so we must do that here as well.
2270 ;; That is inconsistent, but we're stuck with it.
2271 ;; The same can be said for `coding' in set-auto-coding.
2284 "Set local variables as specified in -*- line of %s? "
2285 enable-local-variables)))
2290 nil))))
2293 "Normal hook run after processing a file's local variables specs.
2294 Major modes can use this to examine user-specified local variables
2298 "Parse and put into effect this buffer's local variables spec.
2299 If MODE-ONLY is non-nil, all we do is check whether the major mode
2300 is specified, returning t if it is specified."
2302 ;; If MODE-ONLY is t, we check here for specifying the mode
2303 ;; in the -*- line. If MODE-ONLY is nil, we process
2304 ;; the -*- line here.
2308 ;; Look for "Local variables:" line in last page.
2316 "Set local variables as specified at end of %s? "
2317 enable-local-variables))))
2320 ;; suffix is what comes after "local variables:" in its line.
2325 ;; prefix is what comes before "local variables:" in its line.
2330 beg)
2334 endpos
2340 nil t))
2350 ;; Discard the prefix.
2355 ;; Discard the suffix.
2363 ;; Find the variable name; strip whitespace.
2371 val)
2372 ;; Read the variable value.
2379 ;; Set the variable. "Variables" mode and eval are funny.
2385 mode-specified))
2390 ;; Get confirmation before setting these variables as locals in a file.
2415 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2445 ;; This case is safe because the user gets to check it before it is used.
2449 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2450 If VAL is nil or omitted, the question is whether any value might be
2451 dangerous."
2454 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2457 ;; If the safe-local-variable property isn't t or nil,
2458 ;; then it must return non-nil on the proposed value to be safe.
2465 Add expressions to this list if you want Emacs to evaluate them, when
2466 they appear in an `eval' local variable specification, without first
2467 asking you for confirmation."
2484 "Return t if it is safe to eval EXP when it is found in a file."
2486 ;; Detect certain `put' expressions.
2492 ;; Only allow safe values of lisp-indent-hook;
2493 ;; not functions.
2496 ;; Allow expressions that the user requested.
2498 ;; Certain functions can be allowed with safe arguments
2499 ;; or can specify verification functions to try.
2507 ok))
2515 ok)))))))
2519 A few patterns are specified so that any name which matches one
2520 is considered risky."
2525 ;; We have already handled coding: tag in set-auto-coding.
2526 nil)
2528 nil)
2529 ;; "Setting" eval means either eval it or do nothing.
2530 ;; Likewise for setting hook variables.
2532 ;; Permit evalling a put of a harmless property.
2533 ;; if the args do nothing tricky.
2536 ;; Permit eval if not root and user says ok.
2539 "Process `eval' or hook local variables in %s? "
2540 enable-local-eval)))
2546 ;; Ordinary variable, really set it.
2548 ;; Make sure the string has no text properties.
2549 ;; Some text properties can get evaluated in various ways,
2550 ;; so it is risky to put them on with a local variable list.
2555 \f
2558 However, the mode will not be changed if
2559 \(1) a local variables list or the `-*-' line specifies a major mode, or
2561 \ not suitable for ordinary files, or
2562 \(3) the new file name does not particularly specify any mode."
2567 "Change name of file visited in current buffer to FILENAME.
2568 The next time the buffer is saved it will go in the newly specified file.
2569 FILENAME nil or an empty string means make buffer not be visiting any file.
2570 Remember to delete the initial contents of the minibuffer
2571 if you wish to pass an empty string as the argument.
2573 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2574 confirmation in the case where another buffer is already visiting FILENAME.
2576 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2577 the old visited file has been renamed to the new name FILENAME."
2585 nil
2600 filename)))
2612 ;; If new-name == old-name, renaming would add a spurious <2>
2613 ;; and it's considered as a feature in rename-buffer.
2619 ;; Abbreviate the file names of the buffer.
2628 nil)))
2629 ;; write-file-functions is normally used for things like ftp-find-file
2630 ;; that visit things that are not local files as if they were files.
2631 ;; Changing to visit an ordinary local file instead should flush the hook.
2636 ;; If buffer was read-only because of version control,
2637 ;; that reason is gone now, so make it writable.
2641 ;; Turn off backup files for certain file names.
2642 ;; Since this is a permanent local, the major mode won't eliminate it.
2649 ;; If auto-save was not already on, turn it on if appropriate.
2653 ;; If auto save is on, start using a new name.
2654 ;; We deliberately don't rename or delete the old auto save
2655 ;; for the old visited file name. This is because perhaps
2656 ;; the user wants to save the new state and then compare with the
2657 ;; previous state from the auto save file.
2660 ;; Rename the old auto save file if any.
2667 ;; Update the major mode, if the file name determines it.
2669 ;; Don't change the mode if it is special.
2672 ;; Don't change the mode if the local variable list specifies it.
2678 "Write current buffer into file FILENAME.
2679 This makes the buffer visit that file, and marks it as not modified.
2681 If you specify just a directory name as FILENAME, that means to use
2682 the default file name but in that directory. You can also yank
2683 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2685 If the buffer is not already visiting a file, the default file name
2686 for the output file is the buffer name.
2688 If optional second arg CONFIRM is non-nil, this function
2689 asks for confirmation before overwriting an existing file.
2690 Interactively, confirmation is required unless you supply a prefix argument."
2691 ;; (interactive "FWrite file: ")
2695 nil nil nil nil)
2699 default-directory)
2700 nil nil))
2704 ;; If arg is just a directory,
2705 ;; use the default file name, but in that directory.
2716 ;; Make buffer writable if file is writable.
2721 ;; It's likely that the VC status at the new location is different from
2722 ;; the one at the old location.
2724 \f
2726 "Make a backup of the disk file visited by the current buffer, if appropriate.
2727 This is normally done before saving the buffer the first time.
2729 A backup may be done by renaming or by copying; see documentation of
2730 variable `make-backup-files'. If it's done by renaming, then the file is
2731 no longer accessible under its old name.
2733 The value is non-nil after a backup was made by renaming.
2734 It has the form (MODES . BACKUPNAME).
2735 MODES is the result of `file-modes' on the original
2736 file; this means that the caller, after saving the buffer, should change
2737 the modes of the new file to agree with the old modes.
2738 BACKUPNAME is the backup file name, which is the old file renamed."
2745 backup-info backupname targets setmodes)
2746 ;; If specified name is a symbolic link, chase it to the target.
2747 ;; Thus we make the backups in the directory where the real file is.
2752 ;; (if (file-directory-p buffer-file-name)
2753 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2757 ;; If have old versions to maybe delete,
2758 ;; ask the user to confirm now, before doing anything.
2759 ;; But don't actually delete til later.
2764 real-file-name)))))
2766 ;; Actually write the back up file.
2769 ; (file-symlink-p buffer-file-name)
2770 backup-by-copying
2771 ;; Don't rename a suid or sgid file.
2786 ;; rename-file should delete old backup.
2790 ;; If trouble writing the backup, write it in ~.
2799 ;; Now delete the old versions, if desired.
2806 setmodes)
2813 ;; Create temp files with strict access rights. It's easy to
2814 ;; loosen them later, whereas it's impossible to close the
2815 ;; time-window of loose permissions otherwise.
2823 nil)
2825 ;; The file was somehow created by someone else between
2826 ;; `delete-file' and `copy-file', so let's try again.
2827 nil))
2828 ;; Reset the umask.
2834 "Return file NAME sans backup versions or strings.
2835 This is a separate procedure so your site-init or startup file can
2836 redefine it.
2837 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2838 we do not remove backup version numbers, only true file version numbers."
2844 ;; VMS version number is (a) semicolon, optional
2845 ;; sign, zero or more digits or (b) period, option
2846 ;; sign, zero or more digits, provided this is the
2847 ;; second period encountered outside of the
2848 ;; device/directory part of the file name.
2851 name)
2861 "Return t if deleting FILE and rewriting it would preserve the owner."
2866 ;; Return t if the file doesn't exist, since it's true that no
2867 ;; information would be lost by an (attempted) delete and create.
2873 The extension, in a file name, is the part that follows the last `.',
2874 except that a leading `.', if any, doesn't count."
2877 directory)
2881 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2882 ;; we don't want to expand it.
2885 filename))))
2889 The extension, in a file name, is the part that follows the last `.',
2890 except that a leading `.', if any, doesn't count.
2891 Return nil for extensionless file names such as `foo'.
2892 Return the empty string for file names such as `foo.'.
2894 If PERIOD is non-nil, then the returned value includes the period
2895 that delimits the extension, and if FILENAME has no extension,
2906 "A function to use instead of the default `make-backup-file-name'.
2907 A value of nil gives the default `make-backup-file-name' behavior.
2909 This could be buffer-local to do something special for specific
2910 files. If you define it, you may need to change `backup-file-name-p'
2911 and `file-name-sans-versions' too.
2913 See also `backup-directory-alist'."
2919 "Alist of filename patterns and backup directory names.
2920 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2921 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2922 relative or absolute. If it is absolute, so that all matching files
2923 are backed up into the same directory, the file names in this
2924 directory will be the full name of the file backed up with all
2925 directory separators changed to `!' to prevent clashes. This will not
2926 work correctly if your filesystem truncates the resulting name.
2928 For the common case of all backups going into one directory, the alist
2930 directory name.
2932 If this variable is nil, or it fails to match a filename, the backup
2933 is made in the original file's directory.
2935 On MS-DOS filesystems without long names this variable is always
2936 ignored."
2942 "Default `backup-enable-predicate' function.
2943 Checks for files in `temporary-file-directory',
2944 `small-temporary-file-directory', and /tmp."
2947 ;; Directory is under temporary-file-directory.
2952 ;; Directory is under /tmp.
2957 0 nil
2959 ;; Directory is under small-temporary-file-directory.
2964 "Create the non-numeric backup file name for FILE.
2965 Normally this will just be the file's name with `~' appended.
2966 Customization hooks are provided as follows.
2968 If the variable `make-backup-file-name-function' is non-nil, its value
2969 should be a function which will be called with FILE as its argument;
2970 the resulting name is used.
2972 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2973 the documentation of that variable. If the directory for the backup
2974 doesn't exist, it is created."
2988 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2990 elt backup-directory)
2995 alist nil)))
3001 file
3005 ;; Normalize DOSish file names: downcase the drive
3006 ;; letter, if any, and replace the leading "x:" with
3007 ;; "/drive_x".
3010 ;; Replace any invalid file-name characters (for the
3011 ;; case of backing up remote files).
3015 "drive_"
3018 ""
3021 ;; Make the name unique by substituting directory
3022 ;; separators. It may not really be worth bothering about
3023 ;; doubling `!'s in the original name...
3028 backup-directory))
3035 "Return non-nil if FILE is a backup file name (numeric or not).
3036 This is a separate function so you can redefine it for customization.
3037 You may need to redefine `file-name-sans-versions' as well."
3042 ;; This is used in various files.
3043 ;; The usage of backup-extract-version-start is not very clean,
3044 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3046 "Given the name of a numeric backup file, FN, return the backup number.
3047 Uses the free variable `backup-extract-version-start', whose value should be
3048 the index in the name where the version number begins."
3054 ;; I believe there is no need to alter this behavior for VMS;
3055 ;; since backup files are not made on VMS, it should not get called.
3057 "Find a file name for a backup file FN, and suggestions for deletions.
3058 Value is a list whose car is the name for the backup file
3059 and whose cdr is a list of old versions to consider deleting now.
3060 If the value is nil, don't make a backup.
3061 Uses `backup-directory-alist' in the same way as does
3062 `make-backup-file-name'."
3064 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3068 ;; We don't support numbered backups on plain MS-DOS
3069 ;; when long file names are unavailable.
3079 possibilities deserve-versions-p versions)
3082 base-versions
3085 possibilities)
3086 #'<)
3091 kept-old-versions
3092 kept-new-versions
3099 ;; Delete nothing if there is overflow
3100 ;; in the number of versions to keep.
3106 v))))))))))
3109 "Return number of names file FILENAME has."
3112 ;; (defun file-relative-name (filename &optional directory)
3113 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3114 ;; This function returns a relative file name which is equivalent to FILENAME
3115 ;; when used with that default directory as the default.
3116 ;; If this is impossible (which can happen on MSDOS and Windows
3117 ;; when the file name and directory use different drive names)
3118 ;; then it returns FILENAME."
3119 ;; (save-match-data
3120 ;; (let ((fname (expand-file-name filename)))
3121 ;; (setq directory (file-name-as-directory
3122 ;; (expand-file-name (or directory default-directory))))
3123 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3124 ;; ;; drive names, they can't be relative, so return the absolute name.
3125 ;; (if (and (or (eq system-type 'ms-dos)
3126 ;; (eq system-type 'cygwin)
3127 ;; (eq system-type 'windows-nt))
3128 ;; (not (string-equal (substring fname 0 2)
3129 ;; (substring directory 0 2))))
3130 ;; filename
3131 ;; (let ((ancestor ".")
3132 ;; (fname-dir (file-name-as-directory fname)))
3133 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3134 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3135 ;; (setq directory (file-name-directory (substring directory 0 -1))
3136 ;; ancestor (if (equal ancestor ".")
3137 ;; ".."
3138 ;; (concat "../" ancestor))))
3139 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3140 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3141 ;; ;; We matched within FNAME's directory part.
3142 ;; ;; Add the rest of FNAME onto ANCESTOR.
3143 ;; (let ((rest (substring fname (match-end 0))))
3144 ;; (if (and (equal ancestor ".")
3145 ;; (not (equal rest "")))
3146 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3147 ;; rest
3148 ;; (concat (file-name-as-directory ancestor) rest)))
3149 ;; ;; We matched FNAME's directory equivalent.
3150 ;; ancestor))))))
3153 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3154 This function returns a relative file name which is equivalent to FILENAME
3155 when used with that default directory as the default.
3156 If FILENAME and DIRECTORY lie on different machines or on different drives
3157 on a DOS/Windows machine, it returns FILENAME in expanded form."
3161 default-directory))))
3167 ;; Test for different drives on DOS/Windows
3169 ;; Should `cygwin' really be included here? --stef
3172 ;; Test for different remote file system identification
3174 filename
3180 directory nil nil case-fold-search))
3182 directory nil nil case-fold-search))))
3185 ".."
3187 ;; Now ancestor is empty, or .., or ../.., etc.
3189 directory nil nil case-fold-search))
3190 ;; We matched within FILENAME's directory part.
3191 ;; Add the rest of FILENAME onto ANCESTOR.
3194 ;; But don't bother with ANCESTOR if it would give us `./'.
3195 rest
3197 ;; We matched FILENAME's directory equivalent.
3198 ancestor))))))
3199 \f
3201 "Save current buffer in visited file if modified.
3202 Variations are described below.
3204 By default, makes the previous version into a backup file
3205 if previously requested or if this is the first save.
3207 to become a backup when the next save is done.
3209 unconditionally makes the previous version into a backup file.
3211 to become a backup when the next save is done,
3212 and unconditionally makes the previous version into a backup file.
3214 With a numeric argument of 0, never make the previous version
3215 into a backup file.
3217 If a file's name is FOO, the names of its numbered backup versions are
3218 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3219 Numeric backups (rather than FOO~) will be made if value of
3220 `version-control' is not the atom `never' and either there are already
3221 numeric versions of the file being backed up, or `version-control' is
3222 non-nil.
3223 We don't want excessive versions piling up, so there are variables
3224 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3225 and `kept-new-versions', which tells how many newest versions to keep.
3226 Defaults are 2 old versions and 2 new.
3227 `dired-kept-versions' controls dired's clean-directory (.) command.
3228 If `delete-old-versions' is nil, system will query user
3229 before trimming versions. Otherwise it does it silently.
3231 If `vc-make-backup-files' is nil, which is the default,
3232 no backup files are made for files managed by version control.
3233 (This is because the version control system itself records previous versions.)
3235 See the subroutine `basic-save-buffer' for more information."
3248 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3249 Normally delete only if the file was written by this Emacs since
3250 the last real save, but optional arg FORCE non-nil means delete anyway."
3264 "Normal hook that is run before a buffer is saved to its file."
3270 "Normal hook that is run after a buffer is saved to its file."
3276 "If non-nil, use this coding system for saving the buffer.
3277 More precisely, use this coding system in place of the
3278 value of `buffer-file-coding-system', when saving the buffer.
3279 Calling `write-region' for any purpose other than saving the buffer
3280 will still use `buffer-file-coding-system'; this variable has no effect
3287 "Save the current buffer in its visited file, if it has been modified.
3288 The hooks `write-contents-functions' and `write-file-functions' get a chance
3289 to do the job of saving; if they do not, then the buffer is saved in
3290 the visited file in the usual way.
3291 Before and after saving the buffer, this function runs
3292 `before-save-hook' and `after-save-hook', respectively."
3295 ;; In an indirect buffer, save its base buffer instead.
3300 setmodes)
3301 ;; On VMS, rename file and buffer to get rid of version number.
3306 ;; Strip VMS version number before save.
3309 ;; Construct a (unique) buffer name to correspond.
3314 ;; If buffer has no file name, ask user for one.
3321 filename))
3347 ;; Support VC version backups.
3353 ;; If a hook returned t, file is already "written".
3354 ;; Otherwise, write it the usual way now.
3356 ;; Now we have saved the current buffer. Let's make sure
3357 ;; that buffer-file-coding-system is fixed to what
3358 ;; actually used for saving by binding it locally.
3368 ;; If the auto-save file was recent before this command,
3369 ;; delete it now.
3371 ;; Support VC `implicit' locking.
3376 ;; This does the "real job" of writing a buffer into its visited file
3377 ;; and making a backup file. This is what is normally done
3378 ;; but inhibited if one of write-file-functions returns non-nil.
3379 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3388 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3402 buffer-file-name)))
3410 ;; If file is precious, write temp name, then rename it.
3411 ;; This requires write access to the containing dir,
3412 ;; which is why we don't try it if we don't have that access.
3414 tempname succeed
3417 ;; Create temp files with strict access rights. It's easy to
3418 ;; loosen them later, whereas it's impossible to close the
3419 ;; time-window of loose permissions otherwise.
3424 ;; Try various temporary names.
3425 ;; This code follows the example of make-temp-file,
3426 ;; but it calls write-region in the appropriate way
3427 ;; for saving the buffer.
3434 tempname nil realname
3436 nil)
3438 ;; The file was somehow created by someone else between
3439 ;; `make-temp-name' and `write-region', let's try again.
3440 nil)
3442 ;; Reset the umask.
3444 ;; If we failed, restore the buffer's modtime.
3447 ;; Since we have created an entirely new file,
3448 ;; make sure it gets the right permission bits set.
3450 buffer-file-name)))
3451 ;; We succeeded in writing the temp file,
3452 ;; so rename it.
3454 ;; If file not writable, see if we can make it writable
3455 ;; temporarily while we write it.
3456 ;; But no need to do so if we have just backed it up
3457 ;; (setmodes is set) because that says we're superseding.
3459 ;; Change the mode back, after writing.
3466 buffer-file-name nil t buffer-file-truename)
3468 ;; If we get an error writing the new file, and we made
3469 ;; the backup by renaming, undo the backing-up.
3472 setmodes))
3475 "View the differences between BUFFER and its associated file.
3476 This requires the external program `diff' to be in your `exec-path'."
3491 ;; Display that message for 1 second so that user can read it
3492 ;; in the minibuffer.
3494 ;; return always nil, so that save-buffers-kill-emacs will not move
3495 ;; over to the next unsaved buffer when calling `d'.
3496 nil)
3499 '((?\C-r
3505 ;; Return nil to ask about BUF again.
3506 nil)
3508 (?d diff-buffer-with-file
3518 "Save some modified file-visiting buffers. Asks user about each one.
3519 You can answer `y' to save, `n' not to save, `C-r' to look at the
3520 buffer in question with `view-buffer' before deciding or `d' to
3521 view the differences using `diff-buffer-with-file'.
3523 Optional argument (the prefix) non-nil means save all with no questions.
3524 Optional second argument PRED determines which buffers are considered:
3525 If PRED is nil, all the file-visiting buffers are considered.
3526 If PRED is t, then certain non-file buffers will also be considered.
3527 If PRED is a zero-argument function, it indicates for each buffer whether
3528 to consider it or not when called with that buffer current.
3530 See `save-some-buffers-action-alist' if you want to
3531 change the additional actions you can take on files."
3535 files-done abbrevs-done)
3537 ;; First save any buffers that we're supposed to save unconditionally.
3538 ;; That way the following code won't ask about them.
3543 ;; Ask about those buffers that merit it,
3544 ;; and record the number thus saved.
3560 t
3573 save-some-buffers-action-alist))
3574 ;; Maybe to save abbrevs, and record whether
3575 ;; we either saved them or asked to.
3581 abbrev-file-name)))
3583 ;; Don't keep bothering user if he says no.
3588 "(Some special files were saved without asking)"
3590 \f
3592 "Mark current buffer as unmodified, not needing to be saved.
3595 It is not a good idea to use this function in Lisp programs, because it
3596 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3603 "Change whether this buffer is visiting its file read-only.
3604 With arg, set read-only iff arg is positive.
3605 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3610 nil ; do nothing.
3611 ;; Toggle.
3618 ;; If view-mode is already active, `view-mode-enter' is a nop.
3630 "Insert contents of file FILENAME into buffer after point.
3631 Set mark after the inserted text.
3633 This function is meant for the user to run interactively.
3634 Don't call it from programs! Use `insert-file-contents' instead.
3635 \(Its calling sequence is different; see its documentation)."
3640 "Append the contents of the region to the end of file FILENAME.
3641 When called from a function, expects three arguments,
3642 START, END and FILENAME. START and END are buffer positions
3643 saying what text to write."
3648 "Return most recent backup file for FILENAME or nil if no backups exist."
3649 ;; `make-backup-file-name' will get us the right directory for
3650 ;; ordinary or numeric backups. It might create a directory for
3651 ;; backups as a side-effect, according to `backup-directory-alist'.
3658 tem)
3667 newest))
3670 "Rename current buffer to a similar name not already taken.
3671 This function is useful for creating multiple shell process buffers
3672 or multiple mail buffers, etc."
3680 ;; If the existing buffer name has a <NNN>,
3681 ;; which isn't part of the file name (if any),
3682 ;; then get rid of that.
3688 "Create the directory DIR and any nonexistent parent dirs.
3689 Interactively, the default choice of directory to create
3690 is the current default directory for file names.
3691 That is useful when you have visited a file in a nonexistent directory.
3693 Noninteractively, the second (optional) argument PARENTS says whether
3694 to create parent directories if they don't exist. Interactively,
3695 this happens by default."
3698 nil nil)
3699 t))
3700 ;; If default-directory is a remote directory,
3701 ;; make sure we find its make-directory handler.
3709 create-list)
3716 \f
3719 "Function to use to revert this buffer, or nil to do the default.
3720 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3725 "Function to use to insert contents when reverting this buffer.
3726 Gets two args, first the nominal file name to use,
3727 and second, t if reading the auto-save file.
3732 "Function to check whether a non-file buffer needs reverting.
3733 This should be a function with one optional argument NOCONFIRM.
3734 Auto Revert Mode passes t for NOCONFIRM. The function should return
3735 non-nil if the buffer should be reverted. A return value of
3736 `fast' means that the need for reverting was not checked, but
3737 that reverting the buffer is fast. The buffer is current when
3738 this function is called.
3740 The idea behind the NOCONFIRM argument is that it should be
3741 non-nil if the buffer is going to be reverted without asking the
3742 user. In such situations, one has to be careful with potentially
3743 time consuming operations.
3745 For more information on how this variable is used by Auto Revert mode,
3749 "Normal hook for `revert-buffer' to run before reverting.
3750 If `revert-buffer-function' is used to override the normal revert
3754 "Normal hook for `revert-buffer' to run after reverting.
3755 Note that the hook value that it runs is the value that was in effect
3756 before reverting; that makes a difference if you have buffer-local
3757 hook functions.
3759 If `revert-buffer-function' is used to override the normal revert
3765 "Replace current buffer text with the text of the visited file on disk.
3766 This undoes all changes since the file was visited or saved.
3767 With a prefix argument, offer to revert from latest auto-save file, if
3768 that is more recent than the visited file.
3770 This command also works for special buffers that contain text which
3771 doesn't come from a file, but reflects some other data base instead:
3772 for example, Dired buffers and `buffer-list' buffers. In these cases,
3773 it reconstructs the buffer contents from the appropriate data base.
3775 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3776 to revert from the auto-save file when this is nil. Note that the
3777 sense of this argument is the reverse of the prefix argument, for the
3778 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3779 to nil.
3781 Optional second argument NOCONFIRM means don't ask for confirmation at
3782 all. (The local variable `revert-without-query', if non-nil, prevents
3783 confirmation.)
3785 Optional third argument PRESERVE-MODES non-nil means don't alter
3786 the files modes. Normally we reinitialize them using `normal-mode'.
3788 If the value of `revert-buffer-function' is non-nil, it is called to
3789 do all the work for this command. Otherwise, the hooks
3790 `before-revert-hook' and `after-revert-hook' are run at the beginning
3791 and the end, and if `revert-buffer-insert-file-contents-function' is
3792 non-nil, it is called instead of rereading visited file contents."
3794 ;; I admit it's odd to reverse the sense of the prefix argument, but
3795 ;; there is a lot of code out there which assumes that the first
3796 ;; argument should be t to avoid consulting the auto-save file, and
3797 ;; there's no straightforward way to encourage authors to notice a
3798 ;; reversal of the argument sense. So I'm just changing the user
3799 ;; interface, but leaving the programmatic interface the same.
3807 buffer-auto-save-file-name
3812 buffer-auto-save-file-name
3813 buffer-file-name)))
3824 found))
3826 file-name)))
3828 ;; If file was backed up but has changed since,
3829 ;; we shd make another backup.
3833 ;; Get rid of all undo records for this buffer.
3836 ;; Effectively copy the after-revert-hook status,
3837 ;; since after-find-file will clobber it.
3841 after-revert-hook)))
3843 ;; Don't make undo records for the reversion.
3847 file-name auto-save-p)
3850 "File %s no longer exists!"
3852 file-name))
3853 ;; Bind buffer-file-name to nil
3854 ;; so that we don't try to lock the file.
3860 ;; Auto-saved file shoule be read by Emacs'
3861 ;; internal coding.
3864 buffer-file-coding-system-explicit))))
3865 ;; This force after-insert-file-set-coding
3866 ;; (called from insert-file-contents) to set
3867 ;; buffer-file-coding-system to a proper value.
3870 ;; Note that this preserves point in an intelligent way.
3874 nil nil t))
3876 nil nil t)))))
3877 ;; Recompute the truename in case changes in symlinks
3878 ;; have changed the truename.
3882 ;; Run after-revert-hook as it was before we reverted.
3886 local-hook)
3889 t))))))
3892 "Recover the visited file--get contents from its last auto-save file."
3897 "Visit file FILE, but get contents from its last auto-save file."
3898 ;; Actually putting the file name in the minibuffer should be used
3899 ;; only rarely.
3900 ;; Not just because users often use the default.
3920 ;; Use insert-directory-safely, not insert-directory,
3921 ;; because these files might not exist. In particular,
3922 ;; FILE might not exist if the auto-save file was for
3923 ;; a buffer that didn't visit a file, such as "*mail*".
3924 ;; The code in v20.x called `ls' directly, so we need
3925 ;; to emulate what `ls' did in that case.
3931 ;; Keep the current buffer-file-coding-system.
3933 ;; Auto-saved file shoule be read with special coding.
3942 "Recover auto save files from a previous Emacs session.
3943 This command first displays a Dired buffer showing you the
3944 previous sessions that you could recover from.
3945 To choose one, move point to the proper line and then type C-c C-c.
3946 Then you'll be asked about a number of files to recover."
3956 auto-save-list-file-prefix)))
3957 t)
3966 ;; Each line starts with a space
3967 ;; so that Font Lock mode won't highlight the first character.
3976 "Choose one saved session to recover auto-save files from.
3977 This command is used in the special Dired buffer created by
3980 ;; Get the name of the session file to recover from.
3982 files
3988 ;; Read in the auto-save-list file.
3992 ;; Loop thru the text of that file
3993 ;; and get out the names of the files to recover.
3997 ;; This is a pair of lines for a non-file-visiting buffer.
3998 ;; Get the auto-save file name and manufacture
3999 ;; a "visited file name" from that.
4002 ;; If there is no auto-save file name, the
4003 ;; auto-save-list file is probably corrupted.
4018 ;; This pair of lines is a file-visiting
4019 ;; buffer. Use the visited file name.
4029 ;; Ignore a file if its auto-save file does not exist now.
4033 ;; The file contains a pair of line for each auto-saved buffer.
4034 ;; The first line of the pair contains the visited file name
4035 ;; or is empty if the buffer was not visiting a file.
4036 ;; The second line is the auto-save file name.
4044 files
4050 "Kill some buffers. Asks the user whether to kill each one of them.
4051 Non-interactively, if optional argument LIST is non-nil, it
4052 specifies the list of buffers to kill, asking for approval for each one."
4060 ; if we killed the base buffer.
4065 name
4070 \f
4072 "Toggle auto-saving of contents of current buffer.
4073 With prefix argument ARG, turn auto-saving on if positive, else off."
4078 ;; If auto-save is off because buffer has shrunk,
4079 ;; then toggling should turn it on.
4084 buffer-file-name
4086 ;; If -1 was stored here, to temporarily turn off saving,
4087 ;; turn it back on.
4093 buffer-auto-save-file-name)
4096 "Adjust current buffer's auto save file name for current conditions.
4097 Also rename any existing auto save file, if it was made in this session."
4109 "Return file name to use for auto-saves of current buffer.
4110 Does not consider `auto-save-visited-file-name' as that variable is checked
4111 before calling this function. You can redefine this for customization.
4112 See also `auto-save-file-name-p'."
4120 result uniq)
4121 ;; Apply user-specified translations
4122 ;; to the file name.
4126 filename)
4136 filename))))
4141 ;; We truncate the file name to DOS 8+3 limits
4142 ;; before doing anything else, because the regexp
4143 ;; passed to string-match below cannot handle
4144 ;; extensions longer than 3 characters, multiple
4145 ;; dots, and other atrocities.
4150 fn)
4155 "#"
4158 ;; Make sure auto-save file names don't contain characters
4159 ;; invalid for the underlying filesystem.
4161 ;; Don't modify remote (ange-ftp) filenames
4164 result))))
4166 ;; Deal with buffers that don't have any associated files. (Mail
4167 ;; mode tends to create a good number of these.)
4171 file-name)
4172 ;; Eliminate all slashes and backslashes by
4173 ;; replacing them with sequences that start with %.
4174 ;; Quote % also, to keep distinct names distinct.
4183 ;; Generate the file name.
4189 ;; Try a few alternative directories, to get one we can
4190 ;; write it.
4196 ;; Don't modify remote (ange-ftp) filenames
4198 ;; The call to convert-standard-filename is in case
4199 ;; buffer-name includes characters not allowed by the
4200 ;; DOS/Windows filesystems. make-temp-file writes to the
4201 ;; file it creates, so we must fix the file name _before_
4202 ;; make-temp-file is called.
4204 fname))
4206 ;; make-temp-file creates the file,
4207 ;; but we don't want it to exist until we do an auto-save.
4211 file-name)))
4214 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4215 FILENAME should lack slashes. You can redefine this for customization."
4217 \f
4219 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4220 The generated regexp will match a filename iff the filename
4221 matches that wildcard according to shell rules. Only wildcards known
4222 by `sh' are supported."
4224 ;; Copy the initial run of non-special characters.
4227 ;; If no special characters, we're almost done.
4231 j)
4233 result
4254 ;; Found "[^". Insert a `\0' character
4255 ;; (which cannot happen in a filename)
4256 ;; into the character class, so that `^'
4257 ;; is not the first character after `[',
4258 ;; and thus non-special in a regexp.
4263 ;; I don't think `]' can appear in a
4264 ;; character class in a wildcard, but
4265 ;; let's be general here.
4272 i
4285 ;; Shell wildcards should match the entire filename,
4286 ;; not its part. Make the regexp say so.
4288 \f
4291 "*Switches for `list-directory' to pass to `ls' for brief listing."
4297 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4299 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4304 "Expand wildcard pattern PATTERN.
4305 This returns a list of file names which match the pattern.
4307 If PATTERN is written as an absolute file name,
4308 the values are absolute also.
4310 If PATTERN is written as a relative file name, it is interpreted
4311 relative to the current default directory, `default-directory'.
4312 The file names returned are normally also relative to the current
4313 default directory. However, if FULL is non-nil, they are absolute."
4317 ;; A list of all dirs that DIRPART specifies.
4318 ;; This can be more than one dir
4319 ;; if DIRPART contains wildcards.
4324 contents)
4329 ;; Filter out "." and ".."
4334 name))
4341 this-dir-contents)
4342 this-dir-contents)
4343 contents))))
4345 contents)))
4348 "Display a list of files in or matching DIRNAME, a la `ls'.
4349 DIRNAME is globbed by the shell if necessary.
4350 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4351 Actions controlled by variables `list-directory-brief-switches'
4352 and `list-directory-verbose-switches'."
4356 nil default-directory nil)
4357 pfx)))
4359 list-directory-brief-switches))
4360 buffer)
4373 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4381 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4383 PATTERN is assumed to represent a file-name wildcard suitable for the
4384 underlying filesystem. For Unix and GNU/Linux, the characters from the
4386 the parts of the pattern which don't include wildcard characters are
4387 quoted with double quotes.
4388 Existing quote characters in PATTERN are left alone, so you can pass
4389 PATTERN that already quotes some of the special characters."
4393 ;; DOS/Windows don't allow `"' in file names. So if the
4394 ;; argument has quotes, we can safely assume it is already
4395 ;; quoted by the caller.
4397 ;; We quote [&()#$'] in case their shell is a port of a
4398 ;; Unixy shell. We quote [,=+] because stock DOS and
4399 ;; Windows shells require that in some cases, such as
4400 ;; passing arguments to batch files that use positional
4401 ;; arguments like %1.
4403 pattern
4406 end)
4423 pattern))))
4430 "*Program to get the amount of free space on a file system.
4431 We assume the output has the format of `df'.
4432 The value of this variable must be just a command name or file name;
4433 if you want to specify options, use `directory-free-space-args'.
4435 A value of nil disables this feature.
4437 If the function `file-system-info' is defined, it is always used in
4438 preference to the program given by this variable."
4444 "*Options to use when running `directory-free-space-program'."
4449 "Return the amount of free space on directory DIR's file system.
4450 The result is a string that gives the number of free 1KB blocks,
4451 or nil if the system call or the program which retrieve the information
4452 fail.
4454 This function calls `file-system-info' if it is available, or invokes the
4455 program specified by `directory-free-space-program' if that is non-nil."
4456 ;; Try to find the number of free blocks. Non-Posix systems don't
4457 ;; always have df, but might have an equivalent system call.
4466 nil t nil
4467 directory-free-space-args
4468 dir)))
4469 ;; Usual format is a header line followed by a line of
4470 ;; numbers.
4475 ;; Move to the end of the "available blocks" number.
4478 ;; Copy it into AVAILABLE.
4483 ;; The following expression replaces `dired-move-to-filename-regexp'.
4487 ;; In some locales, month abbreviations are as short as 2 letters,
4488 ;; and they can be followed by ".".
4489 ;; In Breton, a month name can include a quote character.
4502 s "+"
4505 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4506 ;; omits the Kanji characters after month and day-of-month.
4507 ;; On Mac OS X 10.3, the date format in East Asian locales is
4508 ;; day-of-month digits followed by month digits.
4514 ;; The "[0-9]" below requires the previous column to end in a digit.
4515 ;; This avoids recognizing `1 may 1997' as a date in the line:
4516 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4518 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4519 ;; The ".*" below finds the last match if there are multiple matches.
4520 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4521 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4523 ;; vc dired listings provide the state or blanks between file
4524 ;; permissions and date. The state is always surrounded by
4525 ;; parantheses:
4526 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4527 ;; This is not supported yet.
4531 "Regular expression to match up to the file name in a directory listing.
4532 The default value is designed to recognize dates and times
4537 ;; insert-directory
4538 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4539 ;; FULL-DIRECTORY-P is nil.
4540 ;; The single line of output must display FILE's name as it was
4541 ;; given, namely, an absolute path name.
4542 ;; - must insert exactly one line for each file if WILDCARD or
4543 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4544 ;; before the file lines, plus optional text after the file lines.
4545 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4546 ;; allowed.
4547 ;; File lines should display the basename.
4548 ;; - must be consistent with
4549 ;; - functions dired-move-to-filename, (these two define what a file line is)
4550 ;; dired-move-to-end-of-filename,
4551 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4552 ;; dired-insert-headerline
4553 ;; dired-after-subdir-garbage (defines what a "total" line is)
4554 ;; - variable dired-subdir-regexp
4555 ;; - may be passed "--dired" as the first argument in SWITCHES.
4556 ;; Filename handlers might have to remove this switch if their
4557 ;; "ls" command does not support it.
4559 "Insert directory listing for FILE, formatted according to SWITCHES.
4560 Leaves point after the inserted text.
4561 SWITCHES may be a string of options, or a list of strings
4562 representing individual options.
4563 Optional third arg WILDCARD means treat FILE as shell wildcard.
4564 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4565 switches do not contain `d', so that a full listing is expected.
4567 This works by running a directory listing program
4568 whose name is in the variable `insert-directory-program'.
4569 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4571 When SWITCHES contains the long `--dired' option, this function
4572 treats it specially, for the sake of dired. However, the
4573 normally equivalent short `-D' option is just passed on to
4574 `insert-directory-program', as any other option."
4575 ;; We need the directory in order to find the right handler.
4580 wildcard full-directory-p)
4585 ;; Read the actual directory using `insert-directory-program'.
4586 ;; RESULT gets the status code.
4588 ;; putting text property `dired-filename, decode one
4589 ;; bunch by one to preserve that property.
4591 ;; This is to control encoding the arguments in call-process.
4595 default-file-name-coding-system))))
4598 ;; Run ls in the directory part of the file pattern
4599 ;; using the last component as argument.
4606 shell-file-name nil t nil
4607 "-c"
4609 ""
4611 insert-directory-program
4612 " -d "
4614 switches
4616 " -- "
4617 ;; Quote some characters that have
4618 ;; special meanings in shells; but
4619 ;; don't quote the wildcards--we want
4620 ;; them to be special. We also
4621 ;; currently don't quote the quoting
4622 ;; characters in case people want to
4623 ;; use them explicitly to quote
4624 ;; wildcard characters.
4626 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4627 ;; directory if FILE is a symbolic link.
4629 insert-directory-program nil t nil
4633 ;; Split the switches at any spaces so we can
4634 ;; pass separate options as separate args.
4636 ;; Avoid lossage if FILE starts with `-'.
4644 file))))))))
4646 ;; If we got "//DIRED//" in the output, it means we got a real
4647 ;; directory listing, even if `ls' returned nonzero.
4648 ;; So ignore any errors.
4661 ;; The first time ls returns an error,
4662 ;; find the version numbers of ls,
4663 ;; and set insert-directory-ls-version
4664 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4665 ;; is equal or if the info cannot be obtained.
4666 ;; (That can mean it isn't GNU ls.)
4676 comparison)
4692 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4696 ;; If `insert-directory-program' failed, signal an error.
4698 ;; Delete the error message it may have output.
4700 ;; On non-Posix systems, we cannot open a directory, so
4701 ;; don't even try, because that will always result in
4702 ;; the ubiquitous "Access denied". Instead, show the
4703 ;; command line so the user can try to guess what went wrong.
4708 insert-directory-program
4710 file result)
4711 ;; Unix. Access the file to get a suitable error.
4718 ;; The following overshoots by one line for an empty
4719 ;; directory listed with "--dired", but without "-a"
4720 ;; switch, where the ls output contains a
4721 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4722 ;; We take care of that case later.
4730 error-lines)
4731 ;; Find all the lines that are error messages,
4732 ;; and record the bounds of each one.
4739 ;; Now read the numeric positions of file names.
4746 error-lines))
4749 error-lines)))
4751 ;; End is followed by \n or by " -> ".
4753 ;; It seems that we can't trust ls's output as to
4754 ;; byte positions of filenames.
4760 ;; Take care of the case where the ls output contains a
4761 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4762 ;; and we went one line too far back (see above).
4767 ;; Now decode what read if necessary.
4769 file-name-coding-system
4770 default-file-name-coding-system
4772 coding-no-eol
4773 val pos)
4777 ;; If no coding system is specified or detection is
4778 ;; requested, detect the coding.
4792 ;; Force no eol conversion on a file name, so
4793 ;; that CR is preserved.
4801 ;; Try to insert the amount of free space.
4804 ;; First find the line to put it on.
4808 ;; Replace "total" with "used", to avoid confusion.
4814 "Convert `ls --dired' file name position value POS to a buffer position.
4815 File name position values returned in ls --dired output
4816 count only stdout; they don't count the error messages sent to stderr.
4817 So this function converts to them to real buffer positions.
4818 ERROR-LINES is a list of buffer positions of error message lines,
4819 of the form (START END)."
4823 pos)
4827 "Insert directory listing for FILE, formatted according to SWITCHES.
4829 Like `insert-directory', but if FILE does not exist, it inserts a
4830 message to that effect instead of signaling an error."
4833 ;; Simulate the message printed by `ls'.
4837 "Functions to call with no arguments to query about killing Emacs.
4838 If any of these functions returns nil, killing Emacs is cancelled.
4840 but `kill-emacs', the low level primitive, does not.
4844 "How to ask for confirmation when leaving Emacs.
4845 If nil, the default, don't ask at all. If the value is non-nil, it should
4846 be a predicate function such as `yes-or-no-p'."
4854 "Offer to save each buffer, then kill this Emacs process.
4855 With prefix arg, silently save all file-visiting buffers, then kill."
4864 ;; process-list is not defined on VMS.
4866 active)
4875 ;; Query the user for other things, perhaps.
4880 \f
4881 ;; We use /: as a prefix to "quote" a file name
4882 ;; so that magic file name handlers will not apply to it.
4886 file-name-handler-alist))
4888 ;; We depend on being the last handler on the list,
4889 ;; so that anything else which does need handling
4890 ;; has been handled already.
4891 ;; So it is safe for us to inhibit *all* magic file name handlers.
4900 default-directory))
4901 ;; Get a list of the indices of the args which are file names.
4904 ;; The first six are special because they
4905 ;; return a file name. We want to include the /:
4906 ;; in the return value.
4907 ;; So just avoid stripping it in the first place.
4914 ;; `identity' means just return the first arg
4915 ;; not stripped of its quoting.
4917 ;; `add' means add "/:" to the result.
4919 ;; `quote' means add "/:" to buffer-file-name.
4921 ;; `unquote-then-quote' means set buffer-file-name
4922 ;; temporarily to unquoted filename.
4924 ;; List the arguments which are filenames.
4932 ;; For all other operations, treat the first argument only
4933 ;; as the file name.
4935 method
4936 ;; Copy ARGUMENTS so we can replace elements in it.
4940 ;; Strip off the /: from the file names that have it.
4948 "/"
4964 res))
4967 \f
4991 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
4992 ;;; files.el ends here