| blob | 2504dd2d129ff40b20adc2cb80cc3e8f13b98a4f |
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., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, 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:
34 "Backups of edited data files."
38 "Finding files."
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that the auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
71 ;; Turn off backup files on VMS since it has version numbers.
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
137 "Predicate that looks at a file name and decides whether to make backups.
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
163 nil
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
195 "The directory for writing temporary files."
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil means make them for files that have some already.
243 `never' means do not make them."
251 "*When cleaning directory, number of versions to keep."
257 "*If t, delete excess backup versions silently.
258 If nil, ask confirmation. Any other value prevents any trimming."
265 "*Number of oldest versions to keep when a new numbered backup is made."
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
276 "*Whether to add a newline automatically at the end of the file.
278 A value of t means do this only when the file is about to be saved.
279 A value of `visit' means do this right after the file is visited.
280 A value of `visit-save' means do it at both of those times.
281 Any other non-nil value means ask user whether to add a newline, when saving.
282 nil means don't add newlines.
284 Certain major modes set this locally to the value obtained
285 from `mode-require-final-newline'."
294 "*Whether to add a newline at end of file, in certain major modes.
295 Those modes set `require-final-newline' to this value when you enable them.
296 They do so because they are often used for files that are supposed
297 to end in newlines, and the question is how to arrange that.
299 A value of t means do this only when the file is about to be saved.
300 A value of `visit' means do this right after the file is visited.
301 A value of `visit-save' means do it at both of those times.
302 Any other non-nil value means ask user whether to add a newline, when saving.
304 nil means do not add newlines. That is a risky choice in this variable
305 since this value is used for modes for files that ought to have final newlines.
306 So if you set this to nil, you must explicitly check and add
307 a final newline, whenever you save a file that really needs one."
317 "*Non-nil says by default do auto-saving of every file-visiting buffer."
322 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
323 Normally auto-save files are written under other names."
329 ;; Don't put "\\2" inside expand-file-name, since it will be
330 ;; transformed to "/2" on DOS/Windows.
332 "*Transforms to apply to buffer file name before making auto-save file name.
333 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
334 REGEXP is a regular expression to match against the file name.
335 If it matches, `replace-match' is used to replace the
336 matching part with REPLACEMENT.
337 If the optional element UNIQUIFY is non-nil, the auto-save file name is
338 constructed by taking the directory part of the replaced file-name,
339 concatenated with the buffer file name with all directory separators
340 changed to `!' to prevent clashes. This will not work
341 correctly if your filesystem truncates the resulting name.
343 All the transforms in the list are tried, in the order they are listed.
344 When one transform applies, its result is final;
345 no further transforms are tried.
347 The default value is set up to put the auto-save file into the
348 temporary directory (see the variable `temporary-file-directory') for
349 editing a remote file.
351 On MS-DOS filesystems without long names this variable is always
352 ignored."
359 "*Non-nil means save word abbrevs too when files are saved.
360 If `silently', don't ask the user before saving."
365 "*Non-nil means allow `find-file' to visit directories.
366 To visit the directory, `find-file' runs `find-directory-functions'."
371 "*List of functions to try in sequence to visit a directory.
372 Each function is called with the directory name as the sole argument
373 and should return either a buffer or nil."
377 ;;;It is not useful to make this a local variable.
378 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
380 "List of functions to be called for `find-file' on nonexistent file.
381 These functions are called as soon as the error is detected.
382 Variable `buffer-file-name' is already set up.
388 ;;;It is not useful to make this a local variable.
389 ;;;(put 'find-file-hooks 'permanent-local t)
391 "List of functions to be called after a buffer is loaded from a file.
392 The buffer's local variables (if any) will have been processed before the
393 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
426 "List of functions to be called before writing out a buffer to a file.
427 If one of them returns non-nil, the file is considered already written
428 and the rest are not called and neither are the functions in
429 `write-file-functions'.
431 This variable is meant to be used for hooks that pertain to the
432 buffer's contents, not to the particular visited file; thus,
433 `set-visited-file-name' does not clear this variable; but changing the
434 major mode does clear it.
436 For hooks that _do_ pertain to the particular visited file, use
437 `write-file-functions'. Both this variable and
438 `write-file-functions' relate to how a buffer is saved to file.
439 To perform various checks or updates before the buffer is saved,
446 "*Control use of local variables in files you visit.
447 The value can be t, nil or something else.
448 A value of t means file local variables specifications are obeyed;
449 nil means they are ignored; anything else means query.
450 This variable also controls use of major modes specified in
451 a -*- line.
454 always obeys file local variable specifications and the -*- line,
455 and ignores this variable."
462 "Like `enable-local-variables' but meant for buffer-local bindings.
463 The meaningful values are nil and non-nil. The default is non-nil.
464 If a major mode sets this to nil, buffer-locally, then any local
465 variables list in the file will be ignored.
467 This variable does not affect the use of major modes
472 The value can be t, nil or something else.
473 A value of t means obey `eval' variables;
474 nil means ignore them; anything else means query."
480 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
489 "*Non-nil means buffers visiting files read-only do so in view mode.
490 In fact, this means that all read-only buffers normally have
491 View mode enabled, including buffers that are read-only because
492 you visit a file you cannot alter, and buffers you make read-only
499 "Provides support for ange-ftp host name completion.
500 Runs the usual ange-ftp hook, but only for completion operations."
501 ;; Having this here avoids the need to load ange-ftp when it's not
502 ;; really in use.
508 inhibit-file-name-handlers)))
513 "Convert a standard file's name to something suitable for the OS.
514 This means to guarantee valid names and perhaps to canonicalize
515 certain patterns.
517 FILENAME should be an absolute file name since the conversion rules
518 sometimes vary depending on the position in the file name. E.g. c:/foo
519 is a valid DOS file name, but c:/bar/c:/foo is not.
521 This function's standard definition is trivial; it just returns
522 the argument. However, on Windows and DOS, replace invalid
523 characters. On DOS, make sure to obey the 8.3 limitations. On
524 Windows, turn Cygwin names into native names, and also turn
525 slashes into backslashes if the shell requires it (see
526 `w32-shell-dos-semantics').
528 See Info node `(elisp)Standard File Names' for more details."
529 filename)
532 "Read directory name, prompting with PROMPT and completing in directory DIR.
533 Value is not expanded---you must call `expand-file-name' yourself.
534 Default name to DEFAULT-DIRNAME if user exits with the same
535 non-empty string that was inserted by this function.
536 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
537 or just DIR if INITIAL is nil.)
538 If the user exits with an empty minibuffer, this function returns
539 an empty string. (This can only happen if the user erased the
540 pre-inserted contents or if `insert-default-directory' is nil.)
541 Fourth arg MUSTMATCH non-nil means require existing directory's name.
542 Non-nil and non-t means also require confirmation after completion.
543 Fifth arg INITIAL specifies text to start with.
544 DIR should be an absolute directory name. It defaults to
545 the value of `default-directory'."
550 dir))
551 mustmatch initial
554 \f
556 "Show the current default directory."
561 "Value of the CDPATH environment variable, as a list.
565 "Explode a search path into a list of directory names.
566 Directories are separated by occurrences of `path-separator'
567 \(which is colon in GNU and GNU-like systems)."
568 ;; We could use split-string here.
576 nil
581 cd-list)))
584 "Change current directory to given absolute file name DIR."
585 ;; Put the name into directory syntax now,
586 ;; because otherwise expand-file-name may give some bad results.
599 "Make DIR become the current buffer's default directory.
600 If your environment includes a `CDPATH' variable, try each one of
601 that list of directories (separated by occurrences of
602 `path-separator') when resolving a relative directory name.
603 The path separator is colon in GNU and GNU-like systems."
606 default-directory default-directory
622 cd-path)
623 nil))
627 "Load the Lisp file named FILE."
628 ;; This is a case where .elc makes a lot of sense.
635 "Search for FILENAME through PATH.
636 If found, return the absolute file name of FILENAME, with its suffixes;
637 otherwise return nil.
638 PATH should be a list of directories to look in, like the lists in
639 `exec-path' or `load-path'.
640 If SUFFIXES is non-nil, it should be a list of suffixes to append to
643 If non-nil, PREDICATE is used instead of `file-readable-p'.
644 PREDICATE can also be an integer to pass to the `access' system call,
645 in which case file-name handlers are ignored. This usage is deprecated.
647 For compatibility, PREDICATE can also be one of the symbols
648 `executable', `readable', `writable', or `exists', or a list of
649 one or more of those symbols."
660 "Do completion for file names passed to `locate-file'.
661 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
684 "Search for COMMAND in `exec-path' and return the absolute file name.
685 Return nil if COMMAND is not found anywhere in `exec-path'."
686 ;; Use 1 rather than file-executable-p to better match the behavior of
687 ;; call-process.
691 "Load the library named LIBRARY.
692 This is an interface to the function `load'."
695 'locate-file-completion
700 "Test whether FILE specifies a location on a remote system.
701 Return an identification of the system if the location is indeed
702 remote. The identification of the system may comprise a method
703 to access the system and its hostname, amongst other things.
710 nil)))
713 "Copy the file FILE into a temporary file on this machine.
714 Returns the name of the local copy, or nil, if FILE is directly
715 accessible."
716 ;; This formerly had an optional BUFFER argument that wasn't used by
717 ;; anything.
721 nil)))
724 "Return the truename of FILENAME, which should be absolute.
725 The truename of a file name is found by chasing symbolic links
726 both at the level of the file and at the level of the directories
727 containing it, until no links are left at any level.
730 ;; COUNTER and PREV-DIRS are only used in recursive calls.
731 ;; COUNTER can be a cons cell whose car is the count of how many
732 ;; more links to chase before getting an error.
733 ;; PREV-DIRS can be a cons cell whose car is an alist
734 ;; of truenames we've just recently computed.
748 ;; For speed, remove the ange-ftp completion handler from the list.
749 ;; We know it's not needed here.
750 ;; For even more speed, do this only on the outermost call.
757 ;; andrewi@harlequin.co.uk - none of the following code (except for
758 ;; invoking the file-name handler) currently applies on Windows
759 ;; (ie. there are no native symlinks), but there is an issue with
760 ;; case differences being ignored by the OS, and short "8.3 DOS"
761 ;; name aliases existing for all files. (The short names are not
762 ;; reported by directory-files, but can be used to refer to files.)
763 ;; It seems appropriate for file-truename to resolve these issues in
764 ;; the most natural way, which on Windows is to call the function
765 ;; `w32-long-file-name' - this returns the exact name of a file as
766 ;; it is stored on disk (expanding short name aliases with the full
767 ;; name in the process).
770 ;; For file name that has a special handler, call handler.
771 ;; This is so that ange-ftp can save time by doing a no-op.
774 ;; If filename contains a wildcard, newname will be the old name.
776 ;; If filename exists, use the long name
780 ;; If this file directly leads to a link, process that iteratively
781 ;; so that we don't use lots of stack.
787 ;; For file name that has a special handler, call handler.
788 ;; This is so that ange-ftp can save time by doing a no-op.
791 done t)
793 target dirfile)
794 ;; Get the truename of the directory.
796 ;; If these are equal, we have the (or a) root directory.
798 ;; If this is the same dir we last got the truename for,
799 ;; save time--don't recalculate.
809 done t)
812 done t)
813 ;; Put it back on the file name.
815 ;; Is the file name the name of a link?
818 ;; Yes => chase that link, then start all over
819 ;; since the link may point to a directory name that uses links.
820 ;; We can't safely use expand-file-name here
821 ;; since target might look like foo/../bar where foo
822 ;; is itself a link. Instead, we handle . and .. above.
825 target
827 done nil)
828 ;; No, we are done!
830 filename))
833 "Chase links in FILENAME until a name that is not a link.
834 Unlike `file-truename', this does not check whether a parent
835 directory name is a symbolic link.
836 If the optional argument LIMIT is a number,
837 it means chase no more than that many links and then stop."
845 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
848 ;; Handle `..' by hand, since it needs to work in the
849 ;; target of any directory symlink.
850 ;; This code is not quite complete; it does not handle
851 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
855 ;; Chase links in the default dir of the symlink.
859 ;; Now find the parent of that dir.
863 newname))
866 "Change the encoding of FILE's name from CODING to NEW-CODING.
867 The value is a new name of FILE.
868 Signals a `file-already-exists' error if a file of the new name
869 already exists unless optional third argument OK-IF-ALREADY-EXISTS
870 is non-nil. A number as third arg means request confirmation if
871 the new name already exists. This is what happens in interactive
872 use with M-x."
875 default-file-name-coding-system))
877 from-coding to-coding)
879 ;; We provide the default coding only when it seems that
880 ;; the filename is correctly decoded by the default
881 ;; coding.
887 filename default-coding)
888 default-coding))
892 ;; We provide the default coding only when a user is going to
893 ;; change the encoding not from the default coding.
897 filename from-coding)))
900 filename from-coding default-coding)
901 default-coding)))
905 default-file-name-coding-system))
906 ;; FILE should have been decoded by DEFAULT-CODING.
910 ;; Suppress further encoding.
915 newname))
916 \f
918 "Select buffer BUFFER in another window.
919 If BUFFER does not identify an existing buffer, then this function
920 creates a buffer with that name.
922 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
923 or nil. If BUFFER is nil, then this function chooses a buffer
924 using `other-buffer'.
925 Optional second arg NORECORD non-nil means
926 do not put this buffer at the front of the list of recently selected ones.
927 This function returns the buffer it switched to.
929 This uses the function `display-buffer' as a subroutine; see its
930 documentation for additional customization information."
933 ;; Don't let these interfere.
934 same-window-buffer-names same-window-regexps)
938 "Switch to buffer BUFFER in another frame.
939 Optional second arg NORECORD non-nil means
940 do not put this buffer at the front of the list of recently selected ones.
942 This uses the function `display-buffer' as a subroutine; see its
943 documentation for additional customization information."
946 same-window-buffer-names same-window-regexps)
954 "Add FUN to `minibuffer-setup-hook' while executing BODY.
955 BODY should use the minibuffer at most once.
956 Recursive uses of the minibuffer will not be affected."
962 ;; Clear out this hook so it does not interfere
963 ;; with any recursive minibuffer usage.
979 t))
982 "Edit file FILENAME.
983 Switch to a buffer visiting file FILENAME,
984 creating one if none already exists.
985 Interactively, the default if you just type RET is the current directory,
986 but the visited file name is available through the minibuffer history:
987 type M-n to pull it into the minibuffer.
989 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
990 expand wildcards (if any) and visit multiple files. You can
991 suppress wildcard expansion by setting `find-file-wildcards'.
993 To visit a file without any kind of conversion and without
1002 "Edit file FILENAME, in another window.
1003 May create a new window, or reuse an existing one.
1004 See the function `display-buffer'.
1006 Interactively, the default if you just type RET is the current directory,
1007 but the visited file name is available through the minibuffer history:
1008 type M-n to pull it into the minibuffer.
1010 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1011 expand wildcards (if any) and visit multiple files."
1022 "Edit file FILENAME, in another frame.
1023 May create a new frame, or reuse an existing one.
1024 See the function `display-buffer'.
1026 Interactively, the default if you just type RET is the current directory,
1027 but the visited file name is available through the minibuffer history:
1028 type M-n to pull it into the minibuffer.
1030 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1031 expand wildcards (if any) and visit multiple files."
1042 "Edit the existing file FILENAME.
1050 "Edit file FILENAME but don't allow changes.
1062 value))
1065 "Edit file FILENAME in another window but don't allow changes.
1077 value))
1080 "Edit file FILENAME in another frame but don't allow changes.
1092 value))
1095 "Find file FILENAME as a replacement for the file in the next window.
1096 This command does not select that window.
1098 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1099 expand wildcards (if any) and replace the file with multiple files."
1111 t))))
1119 "Find file FILENAME, select its buffer, kill previous buffer.
1120 If the current buffer now contains an empty file that you just visited
1121 \(presumably by mistake), use this command to visit the file you really want.
1123 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1124 expand wildcards (if any) and replace the file with multiple files."
1134 t)))
1155 ;; This prevents us from finding the same buffer
1156 ;; if we specified the same file again.
1160 ;; Likewise for dired buffers.
1164 ;; This executes if find-file gets an error
1165 ;; and does not really find anything.
1166 ;; We put things back as they were.
1167 ;; If find-file actually finds something, we kill obuf below.
1176 ;; We already asked; don't ask again.
1179 \f
1181 "Create a suitably named buffer for visiting FILENAME, and return it.
1182 FILENAME (sans directory) is used unchanged if that name is free;
1183 otherwise a string <2> or <3> or ... is appended to get an unused name."
1190 "Create and return a buffer with a name based on NAME.
1191 Choose the buffer's name using `generate-new-buffer-name'."
1195 "Regexp to match the automounter prefix in a directory name."
1203 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1205 removes automounter prefixes (see the variable `automount-dir-prefix')."
1206 ;; Get rid of the prefixes added by the automounter.
1213 ;; If any elt of directory-abbrev-alist matches this name,
1214 ;; abbreviate accordingly.
1220 ;; Compute and save the abbreviated homedir name.
1221 ;; We defer computing this until the first time it's needed, to
1222 ;; give time for directory-abbrev-alist to be set properly.
1223 ;; We include a slash at the end, to avoid spurious matches
1224 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1231 ;; If FILENAME starts with the abbreviated homedir,
1232 ;; make it start with `~' instead.
1234 ;; If the home dir is just /, don't change it.
1237 ;; MS-DOS root directories can come with a drive letter;
1238 ;; Novell Netware allows drive letters beyond `Z:'.
1248 filename))
1251 "*List of logical names for which visiting shouldn't save the true dirname.
1252 On VMS, when you visit a file using a logical name that searches a path,
1253 you may or may not want the visited file name to record the specific
1254 directory where the file was found. If you *do not* want that, add the logical
1255 name to this list as a string."
1260 "Return the buffer visiting file FILENAME (a string).
1261 This is like `get-file-buffer', except that it checks for any buffer
1262 visiting the same file, possibly under a different name.
1263 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1264 and others are ignored.
1265 If there is no such live buffer, return nil."
1279 found)
1284 number
1289 ;; Verify this buffer's file number
1290 ;; still belongs to its file.
1293 attributes)
1297 found))))
1298 \f
1300 "*Non-nil means file-visiting commands should handle wildcards.
1301 For example, if you specify `*.c', that would visit all the files
1302 whose names match the pattern."
1308 "*Non-nil means suppress warning messages for symlinked files.
1309 When nil, Emacs prints a warning when visiting a file that is already
1310 visited, but with a different name. Setting this option to t
1311 suppresses this warning."
1317 "Maximum size of file above which a confirmation is requested.
1318 When nil, never request confirmation."
1325 "Read file FILENAME into a buffer and return the buffer.
1326 If a buffer exists visiting FILENAME, return that one, but
1327 verify that the file has not changed since visited or saved.
1328 The buffer is not selected, just returned to the caller.
1329 Optional first arg NOWARN non-nil means suppress any warning messages.
1330 Optional second arg RAWFILE non-nil means the file is read literally.
1331 Optional third arg WILDCARDS non-nil means do wildcard processing
1332 and visit all the matching files. When wildcards are actually
1333 used and expanded, return a list of buffers that are visiting
1334 the various files."
1341 'find-directory-functions
1344 filename)))
1347 find-file-wildcards
1361 ;; Find any buffer for a file which has same truename.
1363 ;; Let user know if there is a buffer with the same truename.
1367 find-file-suppress-same-file-warnings
1371 ;; Optionally also find that buffer.
1374 ;; Check to see if the file looks uncommonly large.
1376 ;; Don't ask again if we already have the file or
1377 ;; if we're asked to be quiet.
1386 ;; We are using an existing buffer.
1392 ;; Certain files should be reverted automatically
1393 ;; if they have changed on disk and not in the buffer.
1401 found))
1411 "File %s changed on disk. Discard your edits? "
1416 "File %s changed on disk. Discard your edits in %s? "
1424 ;; Check if a formerly read-only file has become
1425 ;; writable and vice versa, but if the buffer agrees
1426 ;; with the new state of the file, that is ok too.
1433 buffer-file-name
1441 ;; It is confusing to ask whether to visit
1442 ;; non-literally if they have the file in
1443 ;; hexl-mode.
1447 "Save file and revisit literally? "
1452 rawfile truename number))
1454 "Discard your edits and revisit file literally? "
1457 rawfile truename number)
1461 "Revisit file literally? "
1464 rawfile truename number)
1467 ;; Return the buffer we are using.
1468 buf)
1469 ;; Create a new buffer.
1472 ;; find-file-noselect-1 may use a different buffer.
1474 rawfile truename number))))))
1480 ;; Needed in case we are re-visiting the file with a different
1481 ;; text representation.
1498 filename)))
1499 ;; Unconditionally set error
1509 filename)))
1510 ;; Run find-file-not-found-hooks until one returns non-nil.
1512 ;; If they fail too, set error.
1514 ;; Record the file's truename, and maybe use that as visited name.
1520 ;; On VMS, we may want to remember which directory in a search list
1521 ;; the file was found in.
1533 ;; Set buffer's default directory to that of the file.
1535 ;; Turn off backup files for certain file names. Since
1536 ;; this is a permanent local, the major mode won't eliminate it.
1549 \f
1551 "Like `insert-file-contents', but only reads in the file literally.
1552 A buffer may be modified in several ways after reading into the buffer,
1553 to Emacs features such as format decoding, character code
1554 conversion, `find-file-hook', automatic uncompression, etc.
1556 This function ensures that none of these modifications will take place."
1564 nil))
1567 inhibit-file-name-handlers))
1580 filename)))
1590 "Insert contents of file FILENAME into buffer after point with no conversion.
1592 This function is meant for the user to run interactively.
1593 Don't call it from programs! Use `insert-file-contents-literally' instead.
1594 \(Its calling sequence is different; see its documentation)."
1599 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1604 "Visit file FILENAME with no conversion of any kind.
1605 Format conversion and character code conversion are both disabled,
1606 and multibyte characters are disabled in the resulting buffer.
1607 The major mode used is Fundamental mode regardless of the file name,
1608 and local variable specifications in the file are ignored.
1609 Automatic uncompression and adding a newline at the end of the
1610 file due to `require-final-newline' is also disabled.
1612 You cannot absolutely rely on this function to result in
1613 visiting the file literally. If Emacs already has a buffer
1614 which is visiting the file, you get the existing buffer,
1615 regardless of whether it was created literally or not.
1617 In a Lisp program, if you want to be sure of accessing a file's
1618 contents literally, you should create a temporary buffer and then read
1619 the file contents into it using `insert-file-contents-literally'."
1622 \f
1626 after-find-file-from-revert-buffer
1627 nomodes)
1628 "Called after finding a file and by the default revert function.
1629 Sets buffer mode, parses local variables.
1630 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1631 error in reading the file. WARN non-nil means warn if there
1632 exists an auto-save file more recent than the visited file.
1633 NOAUTO means don't mess with auto-save mode.
1634 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1635 means this call was from `revert-buffer'.
1636 Fifth arg NOMODES non-nil means don't alter the file's modes.
1637 Finishes by calling the functions in `find-file-hook'
1638 unless NOMODES is non-nil."
1641 nil
1651 ;; No need to warn if buffer is auto-saved
1652 ;; under the name of the visited file.
1654 auto-save-visited-file-name))
1657 buffer-file-name))
1677 ;; Make people do a little extra work (C-x C-q)
1678 ;; before altering a backup file.
1681 ;; When a file is marked read-only,
1682 ;; make the buffer read-only even if root is looking at it.
1690 ;; If requested, add a newline at the end of the file.
1700 view-read-only
1706 "Eval BODY and turn any error into a FORMAT message.
1707 FORMAT can have a %s escape which will be replaced with the actual error.
1708 If `debug-on-error' is set, errors are not caught, so that you can
1709 debug them.
1710 Avoid using a large BODY since it is duplicated."
1719 "Choose the major mode for this buffer automatically.
1720 Also sets up any specified local variables of the file.
1721 Uses the visited file name, the -*- line, and the local variables spec.
1723 This function is called automatically from `find-file'. In that case,
1724 we may set up the file-specified mode and local variables,
1725 depending on the value of `enable-local-variables': if it is t, we do;
1726 if it is nil, we don't; otherwise, we query.
1727 In addition, if `local-enable-local-variables' is nil, we do
1728 not set local variables (though we do notice a mode specified with -*-.)
1730 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1731 or from Lisp without specifying the optional argument FIND-FILE;
1732 in that case, this function acts as if `enable-local-variables' were t."
1744 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1745 ;; c++-mode, java-mode and more) are added through autoload
1746 ;; directives in that file. That way is discouraged since it
1747 ;; spreads out the definition of the initial value.
1777 ;; Less common extensions come here
1778 ;; so more common ones above are found faster.
1817 ;; The list of archive file extensions should be in sync with
1818 ;; `auto-coding-alist' with `no-conversion' coding system.
1822 ;; Mailer puts message to be edited in
1823 ;; /tmp/Re.... or Message
1828 ;; some news reader is reported to use this
1837 ;; .emacs or .gnus or .viper following a directory delimiter in
1838 ;; Unix, MSDOG or VMS syntax.
1841 ;; _emacs following a directory delimiter
1842 ;; in MsDos syntax
1861 ;; Windows candidates may be opened case sensitively on Unix
1867 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1869 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1870 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
1871 ;; either user's dot-files or under /etc or some such
1873 ;; alas not all ~/.*rc files are like this
1874 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1879 ;; this contains everything twice, with space and with colon :-(
1881 ;; Get rid of any trailing .n.m and try again.
1882 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1883 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1884 ;; Using mode nil rather than `ignore' would let the search continue
1885 ;; through this list (with the shortened name) rather than start over.
1887 ;; The following should come after the ChangeLog pattern
1888 ;; for the sake of ChangeLog.1, etc.
1889 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1892 "Alist of filename patterns vs corresponding major mode functions.
1893 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1894 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1895 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1896 mode function to use. FUNCTION will be called, unless it is nil.
1898 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1899 calling FUNCTION (if it's not nil), we delete the suffix that matched
1900 REGEXP and search the list again for another match.
1902 If the file name matches `inhibit-first-line-modes-regexps',
1903 then `auto-mode-alist' is not processed.
1905 See also `interpreter-mode-alist', which detects executable script modes
1906 based on the interpreters they specify to run,
1910 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1911 ;; and pike-mode) are added through autoload directives in that
1912 ;; file. That way is discouraged since it spreads out the
1913 ;; definition of the initial value.
1951 "Alist mapping interpreter names to major modes.
1952 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
1953 Each element looks like (INTERPRETER . MODE).
1954 The car of each element, a regular expression, is compared with
1955 the name of the interpreter specified in the first line.
1956 If it matches, mode MODE is selected.
1964 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1965 When checking `inhibit-first-line-modes-regexps', we first discard
1971 "Regexp matching interpreters, for file mode determination.
1972 This regular expression is matched against the first line of a file
1973 to determine the file's mode in `set-auto-mode'. If it matches, the file
1974 is assumed to be interpreted by the interpreter matched by the second group
1975 of the regular expression. The mode is then determined as the mode
1980 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
1984 comment-re "*"
1987 . html-mode)
1988 ;; These two must come after html, because they are more general:
1993 . sgml-mode)
1996 "Alist of buffer beginnings vs. corresponding major mode functions.
1997 Each element looks like (REGEXP . FUNCTION). After visiting a file,
1998 if REGEXP matches the text at the beginning of the buffer,
1999 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
2000 to decide the buffer's major mode.
2002 If FUNCTION is nil, then it is not called. (That is a way of saying
2006 "Select major mode appropriate for current buffer.
2008 This checks for a -*- mode tag in the buffer's text, checks the
2009 interpreter that runs this file against `interpreter-mode-alist',
2010 compares the buffer beginning against `magic-mode-alist', or
2011 compares the filename against the entries in `auto-mode-alist'.
2013 It does not check for the `mode:' local variable in the
2014 Local Variables section of the file; for that, use `hack-local-variables'.
2016 If `enable-local-variables' is nil, this function does not check for a
2017 -*- mode tag.
2019 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2020 only set the major mode, if that would change it."
2021 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2023 ;; Find a -*- mode tag
2030 ;; Find all specifications for the `mode:' variable
2031 ;; and execute them left to right.
2043 modes)))
2044 ;; Simple -*-MODE-*- case.
2047 modes))))
2048 ;; If we found modes to use, invoke them now, outside the save-excursion.
2056 ;; continuing would call minor modes again, toggling them off
2058 ;; If we didn't, look for an interpreter specified in the first line.
2059 ;; As a special case, allow for things like "#!/bin/env perl", which
2060 ;; finds the interpreter anywhere in $PATH.
2066 ;; Map interpreter name to a mode, signalling we're done at the
2067 ;; same time.
2069 interpreter-mode-alist))
2070 ;; If we found an interpreter mode to use, invoke it now.
2073 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2081 ;; Compare the filename against the entries in auto-mode-alist.
2084 ;; Remove backup-suffixes from file name.
2087 ;; Find first matching alist entry.
2100 ;; When `keep-mode-if-same' is set, we are working on behalf of
2101 ;; set-visited-file-name. In that case, if the major mode specified is the
2102 ;; same one we already have, don't actually reset it. We don't want to lose
2103 ;; minor modes such as Font Lock.
2105 "Apply MODE and return it.
2106 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2107 any aliases and compared to current major mode. If they are the
2108 same, do nothing and return nil."
2116 mode))
2119 "Find the -*- spec in the buffer.
2120 Call with point at the place to start searching from.
2121 If one is found, set point to the beginning
2122 and return the position of the end.
2123 Otherwise, return nil; point may be changed."
2126 ;; Don't look for -*- if this file name matches any
2127 ;; of the regexps in inhibit-first-line-modes-regexps.
2135 sufs)
2143 ;; If the file begins with "#!"
2144 ;; (exec interpreter magic), look
2145 ;; for mode frobs in the first two
2146 ;; lines. You cannot necessarily
2147 ;; put them in the first line of
2148 ;; such a file without screwing up
2149 ;; the interpreter invocation.
2160 end))))
2169 ;; If we fail to switch in the selected window,
2170 ;; it is probably a minibuffer or dedicated window.
2171 ;; So try another window.
2173 ;; Refrain from popping up frames since it can't
2174 ;; be undone by save-window-excursion.
2185 "Set local variables specified in the -*- line.
2186 Ignore any specification for `mode:' and `coding:';
2187 `set-auto-mode' should already have handled `mode:',
2188 `set-auto-coding' should already have handled `coding:'.
2189 If MODE-ONLY is non-nil, all we do is check whether the major mode
2190 is specified, returning t if it is specified."
2195 mode-specified
2198 ;; Parse the -*- line into the RESULT alist.
2199 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2201 nil)
2203 ;; Simple form: "-*- MODENAME -*-". Already handled.
2205 nil)
2207 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2208 ;; (last ";" is optional).
2213 ;; There used to be a downcase here,
2214 ;; but the manual didn't say so,
2215 ;; and people want to set var names that aren't all lc.
2222 ;; It is traditional to ignore
2223 ;; case when checking for `mode' in set-auto-mode,
2224 ;; so we must do that here as well.
2225 ;; That is inconsistent, but we're stuck with it.
2226 ;; The same can be said for `coding' in set-auto-coding.
2239 "Set local variables as specified in -*- line of %s? "
2240 enable-local-variables)))
2245 nil))))
2248 "Normal hook run after processing a file's local variables specs.
2249 Major modes can use this to examine user-specified local variables
2253 "Parse and put into effect this buffer's local variables spec.
2254 If MODE-ONLY is non-nil, all we do is check whether the major mode
2255 is specified, returning t if it is specified."
2257 ;; If MODE-ONLY is t, we check here for specifying the mode
2258 ;; in the -*- line. If MODE-ONLY is nil, we process
2259 ;; the -*- line here.
2263 ;; Look for "Local variables:" line in last page.
2271 "Set local variables as specified at end of %s? "
2272 enable-local-variables))))
2275 ;; suffix is what comes after "local variables:" in its line.
2280 ;; prefix is what comes before "local variables:" in its line.
2285 beg)
2289 endpos
2295 nil t))
2305 ;; Discard the prefix.
2310 ;; Discard the suffix.
2318 ;; Find the variable name; strip whitespace.
2326 val)
2327 ;; Read the variable value.
2334 ;; Set the variable. "Variables" mode and eval are funny.
2340 mode-specified))
2345 ;; Get confirmation before setting these variables as locals in a file.
2370 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2400 ;; This case is safe because the user gets to check it before it is used.
2404 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2405 If VAL is nil or omitted, the question is whether any value might be
2406 dangerous."
2409 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2412 ;; If the safe-local-variable property isn't t or nil,
2413 ;; then it must return non-nil on the proposed value to be safe.
2420 Add expressions to this list if you want Emacs to evaluate them, when
2421 they appear in an `eval' local variable specification, without first
2422 asking you for confirmation."
2439 "Return t if it is safe to eval EXP when it is found in a file."
2441 ;; Detect certain `put' expressions.
2447 ;; Only allow safe values of lisp-indent-hook;
2448 ;; not functions.
2451 ;; Allow expressions that the user requested.
2453 ;; Certain functions can be allowed with safe arguments
2454 ;; or can specify verification functions to try.
2462 ok))
2470 ok)))))))
2474 A few patterns are specified so that any name which matches one
2475 is considered risky."
2480 ;; We have already handled coding: tag in set-auto-coding.
2481 nil)
2483 nil)
2484 ;; "Setting" eval means either eval it or do nothing.
2485 ;; Likewise for setting hook variables.
2487 ;; Permit evalling a put of a harmless property.
2488 ;; if the args do nothing tricky.
2491 ;; Permit eval if not root and user says ok.
2494 "Process `eval' or hook local variables in %s? "
2495 enable-local-eval)))
2501 ;; Ordinary variable, really set it.
2503 ;; Make sure the string has no text properties.
2504 ;; Some text properties can get evaluated in various ways,
2505 ;; so it is risky to put them on with a local variable list.
2510 \f
2513 However, the mode will not be changed if
2514 \(1) a local variables list or the `-*-' line specifies a major mode, or
2516 \ not suitable for ordinary files, or
2517 \(3) the new file name does not particularly specify any mode."
2522 "Change name of file visited in current buffer to FILENAME.
2523 The next time the buffer is saved it will go in the newly specified file.
2524 FILENAME nil or an empty string means make buffer not be visiting any file.
2525 Remember to delete the initial contents of the minibuffer
2526 if you wish to pass an empty string as the argument.
2528 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2529 confirmation in the case where another buffer is already visiting FILENAME.
2531 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2532 the old visited file has been renamed to the new name FILENAME."
2540 nil
2551 filename)))
2565 ;; If new-name == old-name, renaming would add a spurious <2>
2566 ;; and it's considered as a feature in rename-buffer.
2572 ;; Abbreviate the file names of the buffer.
2581 nil)))
2582 ;; write-file-functions is normally used for things like ftp-find-file
2583 ;; that visit things that are not local files as if they were files.
2584 ;; Changing to visit an ordinary local file instead should flush the hook.
2589 ;; If buffer was read-only because of version control,
2590 ;; that reason is gone now, so make it writable.
2594 ;; Turn off backup files for certain file names.
2595 ;; Since this is a permanent local, the major mode won't eliminate it.
2602 ;; If auto-save was not already on, turn it on if appropriate.
2606 ;; If auto save is on, start using a new name.
2607 ;; We deliberately don't rename or delete the old auto save
2608 ;; for the old visited file name. This is because perhaps
2609 ;; the user wants to save the new state and then compare with the
2610 ;; previous state from the auto save file.
2613 ;; Rename the old auto save file if any.
2620 ;; Update the major mode, if the file name determines it.
2622 ;; Don't change the mode if it is special.
2625 ;; Don't change the mode if the local variable list specifies it.
2631 "Write current buffer into file FILENAME.
2632 This makes the buffer visit that file, and marks it as not modified.
2634 If you specify just a directory name as FILENAME, that means to use
2635 the default file name but in that directory. You can also yank
2636 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2638 If the buffer is not already visiting a file, the default file name
2639 for the output file is the buffer name.
2641 If optional second arg CONFIRM is non-nil, this function
2642 asks for confirmation before overwriting an existing file.
2643 Interactively, confirmation is required unless you supply a prefix argument."
2644 ;; (interactive "FWrite file: ")
2648 nil nil nil nil)
2652 default-directory)
2653 nil nil))
2657 ;; If arg is just a directory,
2658 ;; use the default file name, but in that directory.
2669 ;; Make buffer writable if file is writable.
2674 \f
2676 "Make a backup of the disk file visited by the current buffer, if appropriate.
2677 This is normally done before saving the buffer the first time.
2679 A backup may be done by renaming or by copying; see documentation of
2680 variable `make-backup-files'. If it's done by renaming, then the file is
2681 no longer accessible under its old name.
2683 The value is non-nil after a backup was made by renaming.
2684 It has the form (MODES . BACKUPNAME).
2685 MODES is the result of `file-modes' on the original
2686 file; this means that the caller, after saving the buffer, should change
2687 the modes of the new file to agree with the old modes.
2688 BACKUPNAME is the backup file name, which is the old file renamed."
2695 backup-info backupname targets setmodes)
2696 ;; If specified name is a symbolic link, chase it to the target.
2697 ;; Thus we make the backups in the directory where the real file is.
2702 ;; (if (file-directory-p buffer-file-name)
2703 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2707 ;; If have old versions to maybe delete,
2708 ;; ask the user to confirm now, before doing anything.
2709 ;; But don't actually delete til later.
2714 real-file-name)))))
2716 ;; Actually write the back up file.
2719 ; (file-symlink-p buffer-file-name)
2720 backup-by-copying
2721 ;; Don't rename a suid or sgid file.
2736 ;; rename-file should delete old backup.
2740 ;; If trouble writing the backup, write it in ~.
2749 ;; Now delete the old versions, if desired.
2756 setmodes)
2763 ;; Create temp files with strict access rights. It's easy to
2764 ;; loosen them later, whereas it's impossible to close the
2765 ;; time-window of loose permissions otherwise.
2773 nil)
2775 ;; The file was somehow created by someone else between
2776 ;; `delete-file' and `copy-file', so let's try again.
2777 nil))
2778 ;; Reset the umask.
2784 "Return file NAME sans backup versions or strings.
2785 This is a separate procedure so your site-init or startup file can
2786 redefine it.
2787 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2788 we do not remove backup version numbers, only true file version numbers."
2794 ;; VMS version number is (a) semicolon, optional
2795 ;; sign, zero or more digits or (b) period, option
2796 ;; sign, zero or more digits, provided this is the
2797 ;; second period encountered outside of the
2798 ;; device/directory part of the file name.
2801 name)
2811 "Return t if deleting FILE and rewriting it would preserve the owner."
2816 ;; Return t if the file doesn't exist, since it's true that no
2817 ;; information would be lost by an (attempted) delete and create.
2823 The extension, in a file name, is the part that follows the last `.',
2824 except that a leading `.', if any, doesn't count."
2827 directory)
2831 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2832 ;; we don't want to expand it.
2835 filename))))
2839 The extension, in a file name, is the part that follows the last `.',
2840 except that a leading `.', if any, doesn't count.
2841 Return nil for extensionless file names such as `foo'.
2842 Return the empty string for file names such as `foo.'.
2844 If PERIOD is non-nil, then the returned value includes the period
2845 that delimits the extension, and if FILENAME has no extension,
2856 "A function to use instead of the default `make-backup-file-name'.
2857 A value of nil gives the default `make-backup-file-name' behavior.
2859 This could be buffer-local to do something special for specific
2860 files. If you define it, you may need to change `backup-file-name-p'
2861 and `file-name-sans-versions' too.
2863 See also `backup-directory-alist'."
2869 "Alist of filename patterns and backup directory names.
2870 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2871 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2872 relative or absolute. If it is absolute, so that all matching files
2873 are backed up into the same directory, the file names in this
2874 directory will be the full name of the file backed up with all
2875 directory separators changed to `!' to prevent clashes. This will not
2876 work correctly if your filesystem truncates the resulting name.
2878 For the common case of all backups going into one directory, the alist
2880 directory name.
2882 If this variable is nil, or it fails to match a filename, the backup
2883 is made in the original file's directory.
2885 On MS-DOS filesystems without long names this variable is always
2886 ignored."
2892 "Default `backup-enable-predicate' function.
2893 Checks for files in `temporary-file-directory',
2894 `small-temporary-file-directory', and /tmp."
2897 ;; Directory is under temporary-file-directory.
2902 ;; Directory is under /tmp.
2907 0 nil
2909 ;; Directory is under small-temporary-file-directory.
2914 "Create the non-numeric backup file name for FILE.
2915 Normally this will just be the file's name with `~' appended.
2916 Customization hooks are provided as follows.
2918 If the variable `make-backup-file-name-function' is non-nil, its value
2919 should be a function which will be called with FILE as its argument;
2920 the resulting name is used.
2922 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2923 the documentation of that variable. If the directory for the backup
2924 doesn't exist, it is created."
2938 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2940 elt backup-directory)
2945 alist nil)))
2951 file
2955 ;; Normalize DOSish file names: downcase the drive
2956 ;; letter, if any, and replace the leading "x:" with
2957 ;; "/drive_x".
2960 ;; Replace any invalid file-name characters (for the
2961 ;; case of backing up remote files).
2965 "drive_"
2968 ""
2971 ;; Make the name unique by substituting directory
2972 ;; separators. It may not really be worth bothering about
2973 ;; doubling `!'s in the original name...
2978 backup-directory))
2985 "Return non-nil if FILE is a backup file name (numeric or not).
2986 This is a separate function so you can redefine it for customization.
2987 You may need to redefine `file-name-sans-versions' as well."
2992 ;; This is used in various files.
2993 ;; The usage of backup-extract-version-start is not very clean,
2994 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2996 "Given the name of a numeric backup file, FN, return the backup number.
2997 Uses the free variable `backup-extract-version-start', whose value should be
2998 the index in the name where the version number begins."
3004 ;; I believe there is no need to alter this behavior for VMS;
3005 ;; since backup files are not made on VMS, it should not get called.
3007 "Find a file name for a backup file FN, and suggestions for deletions.
3008 Value is a list whose car is the name for the backup file
3009 and whose cdr is a list of old versions to consider deleting now.
3010 If the value is nil, don't make a backup.
3011 Uses `backup-directory-alist' in the same way as does
3012 `make-backup-file-name'."
3014 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3018 ;; We don't support numbered backups on plain MS-DOS
3019 ;; when long file names are unavailable.
3029 possibilities deserve-versions-p versions)
3032 base-versions
3035 possibilities)
3036 #'<)
3041 kept-old-versions
3042 kept-new-versions
3049 ;; Delete nothing if there is overflow
3050 ;; in the number of versions to keep.
3056 v))))))))))
3059 "Return number of names file FILENAME has."
3062 ;; (defun file-relative-name (filename &optional directory)
3063 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3064 ;; This function returns a relative file name which is equivalent to FILENAME
3065 ;; when used with that default directory as the default.
3066 ;; If this is impossible (which can happen on MSDOS and Windows
3067 ;; when the file name and directory use different drive names)
3068 ;; then it returns FILENAME."
3069 ;; (save-match-data
3070 ;; (let ((fname (expand-file-name filename)))
3071 ;; (setq directory (file-name-as-directory
3072 ;; (expand-file-name (or directory default-directory))))
3073 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3074 ;; ;; drive names, they can't be relative, so return the absolute name.
3075 ;; (if (and (or (eq system-type 'ms-dos)
3076 ;; (eq system-type 'cygwin)
3077 ;; (eq system-type 'windows-nt))
3078 ;; (not (string-equal (substring fname 0 2)
3079 ;; (substring directory 0 2))))
3080 ;; filename
3081 ;; (let ((ancestor ".")
3082 ;; (fname-dir (file-name-as-directory fname)))
3083 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3084 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3085 ;; (setq directory (file-name-directory (substring directory 0 -1))
3086 ;; ancestor (if (equal ancestor ".")
3087 ;; ".."
3088 ;; (concat "../" ancestor))))
3089 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3090 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3091 ;; ;; We matched within FNAME's directory part.
3092 ;; ;; Add the rest of FNAME onto ANCESTOR.
3093 ;; (let ((rest (substring fname (match-end 0))))
3094 ;; (if (and (equal ancestor ".")
3095 ;; (not (equal rest "")))
3096 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3097 ;; rest
3098 ;; (concat (file-name-as-directory ancestor) rest)))
3099 ;; ;; We matched FNAME's directory equivalent.
3100 ;; ancestor))))))
3103 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3104 This function returns a relative file name which is equivalent to FILENAME
3105 when used with that default directory as the default.
3106 If FILENAME and DIRECTORY lie on different machines or on different drives
3107 on a DOS/Windows machine, it returns FILENAME on expanded form."
3111 default-directory))))
3117 ;; Test for different drives on DOS/Windows
3119 ;; Should `cygwin' really be included here? --stef
3122 ;; Test for different remote file system identification
3124 filename
3130 directory nil nil case-fold-search))
3132 directory nil nil case-fold-search))))
3135 ".."
3137 ;; Now ancestor is empty, or .., or ../.., etc.
3139 directory nil nil case-fold-search))
3140 ;; We matched within FILENAME's directory part.
3141 ;; Add the rest of FILENAME onto ANCESTOR.
3144 ;; But don't bother with ANCESTOR if it would give us `./'.
3145 rest
3147 ;; We matched FILENAME's directory equivalent.
3148 ancestor))))))
3149 \f
3151 "Save current buffer in visited file if modified. Variations are described below.
3152 By default, makes the previous version into a backup file
3153 if previously requested or if this is the first save.
3155 to become a backup when the next save is done.
3157 unconditionally makes the previous version into a backup file.
3159 to become a backup when the next save is done,
3160 and unconditionally makes the previous version into a backup file.
3162 With a numeric argument of 0, never make the previous version
3163 into a backup file.
3165 If a file's name is FOO, the names of its numbered backup versions are
3166 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3167 Numeric backups (rather than FOO~) will be made if value of
3168 `version-control' is not the atom `never' and either there are already
3169 numeric versions of the file being backed up, or `version-control' is
3170 non-nil.
3171 We don't want excessive versions piling up, so there are variables
3172 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3173 and `kept-new-versions', which tells how many newest versions to keep.
3174 Defaults are 2 old versions and 2 new.
3175 `dired-kept-versions' controls dired's clean-directory (.) command.
3176 If `delete-old-versions' is nil, system will query user
3177 before trimming versions. Otherwise it does it silently.
3179 If `vc-make-backup-files' is nil, which is the default,
3180 no backup files are made for files managed by version control.
3181 (This is because the version control system itself records previous versions.)
3183 See the subroutine `basic-save-buffer' for more information."
3196 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3197 Normally delete only if the file was written by this Emacs since
3198 the last real save, but optional arg FORCE non-nil means delete anyway."
3212 "Normal hook that is run before a buffer is saved to its file."
3218 "Normal hook that is run after a buffer is saved to its file."
3224 "If non-nil, use this coding system for saving the buffer.
3225 More precisely, use this coding system in place of the
3226 value of `buffer-file-coding-system', when saving the buffer.
3227 Calling `write-region' for any purpose other than saving the buffer
3228 will still use `buffer-file-coding-system'; this variable has no effect
3235 "Save the current buffer in its visited file, if it has been modified.
3236 The hooks `write-contents-functions' and `write-file-functions' get a chance
3237 to do the job of saving; if they do not, then the buffer is saved in
3238 the visited file file in the usual way.
3239 Before and after saving the buffer, this function runs
3240 `before-save-hook' and `after-save-hook', respectively."
3243 ;; In an indirect buffer, save its base buffer instead.
3248 setmodes)
3249 ;; On VMS, rename file and buffer to get rid of version number.
3254 ;; Strip VMS version number before save.
3257 ;; Construct a (unique) buffer name to correspond.
3262 ;; If buffer has no file name, ask user for one.
3269 filename))
3295 ;; Support VC version backups.
3301 ;; If a hook returned t, file is already "written".
3302 ;; Otherwise, write it the usual way now.
3304 ;; Now we have saved the current buffer. Let's make sure
3305 ;; that buffer-file-coding-system is fixed to what
3306 ;; actually used for saving by binding it locally.
3316 ;; If the auto-save file was recent before this command,
3317 ;; delete it now.
3319 ;; Support VC `implicit' locking.
3324 ;; This does the "real job" of writing a buffer into its visited file
3325 ;; and making a backup file. This is what is normally done
3326 ;; but inhibited if one of write-file-functions returns non-nil.
3327 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3336 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3350 buffer-file-name)))
3358 ;; If file is precious, write temp name, then rename it.
3359 ;; This requires write access to the containing dir,
3360 ;; which is why we don't try it if we don't have that access.
3362 tempname succeed
3365 ;; Create temp files with strict access rights. It's easy to
3366 ;; loosen them later, whereas it's impossible to close the
3367 ;; time-window of loose permissions otherwise.
3372 ;; Try various temporary names.
3373 ;; This code follows the example of make-temp-file,
3374 ;; but it calls write-region in the appropriate way
3375 ;; for saving the buffer.
3382 tempname nil realname
3384 nil)
3386 ;; The file was somehow created by someone else between
3387 ;; `make-temp-name' and `write-region', let's try again.
3388 nil)
3390 ;; Reset the umask.
3392 ;; If we failed, restore the buffer's modtime.
3395 ;; Since we have created an entirely new file,
3396 ;; make sure it gets the right permission bits set.
3398 buffer-file-name)))
3399 ;; We succeeded in writing the temp file,
3400 ;; so rename it.
3402 ;; If file not writable, see if we can make it writable
3403 ;; temporarily while we write it.
3404 ;; But no need to do so if we have just backed it up
3405 ;; (setmodes is set) because that says we're superseding.
3407 ;; Change the mode back, after writing.
3414 buffer-file-name nil t buffer-file-truename)
3416 ;; If we get an error writing the new file, and we made
3417 ;; the backup by renaming, undo the backing-up.
3420 setmodes))
3423 "View the differences between BUFFER and its associated file.
3424 This requires the external program `diff' to be in your `exec-path'."
3439 ;; Display that message for 1 second so that user can read it
3440 ;; in the minibuffer.
3442 ;; return always nil, so that save-buffers-kill-emacs will not move
3443 ;; over to the next unsaved buffer when calling `d'.
3444 nil)
3447 '((?\C-r
3453 ;; Return nil to ask about BUF again.
3454 nil)
3456 (?d diff-buffer-with-file
3466 "Save some modified file-visiting buffers. Asks user about each one.
3467 You can answer `y' to save, `n' not to save, `C-r' to look at the
3468 buffer in question with `view-buffer' before deciding or `d' to
3469 view the differences using `diff-buffer-with-file'.
3471 Optional argument (the prefix) non-nil means save all with no questions.
3472 Optional second argument PRED determines which buffers are considered:
3473 If PRED is nil, all the file-visiting buffers are considered.
3474 If PRED is t, then certain non-file buffers will also be considered.
3475 If PRED is a zero-argument function, it indicates for each buffer whether
3476 to consider it or not when called with that buffer current.
3478 See `save-some-buffers-action-alist' if you want to
3479 change the additional actions you can take on files."
3483 files-done abbrevs-done)
3485 ;; First save any buffers that we're supposed to save unconditionally.
3486 ;; That way the following code won't ask about them.
3491 ;; Ask about those buffers that merit it,
3492 ;; and record the number thus saved.
3508 t
3521 save-some-buffers-action-alist))
3522 ;; Maybe to save abbrevs, and record whether
3523 ;; we either saved them or asked to.
3529 abbrev-file-name)))
3531 ;; Don't keep bothering user if he says no.
3536 "(Some special files were saved without asking)"
3538 \f
3540 "Mark current buffer as unmodified, not needing to be saved.
3543 It is not a good idea to use this function in Lisp programs, because it
3544 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3551 "Change whether this buffer is visiting its file read-only.
3552 With arg, set read-only iff arg is positive.
3553 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3558 nil ; do nothing.
3559 ;; Toggle.
3566 ;; If view-mode is already active, `view-mode-enter' is a nop.
3578 "Insert contents of file FILENAME into buffer after point.
3579 Set mark after the inserted text.
3581 This function is meant for the user to run interactively.
3582 Don't call it from programs! Use `insert-file-contents' instead.
3583 \(Its calling sequence is different; see its documentation)."
3588 "Append the contents of the region to the end of file FILENAME.
3589 When called from a function, expects three arguments,
3590 START, END and FILENAME. START and END are buffer positions
3591 saying what text to write."
3596 "Return most recent backup file for FILENAME or nil if no backups exist."
3597 ;; `make-backup-file-name' will get us the right directory for
3598 ;; ordinary or numeric backups. It might create a directory for
3599 ;; backups as a side-effect, according to `backup-directory-alist'.
3606 tem)
3615 newest))
3618 "Rename current buffer to a similar name not already taken.
3619 This function is useful for creating multiple shell process buffers
3620 or multiple mail buffers, etc."
3628 ;; If the existing buffer name has a <NNN>,
3629 ;; which isn't part of the file name (if any),
3630 ;; then get rid of that.
3636 "Create the directory DIR and any nonexistent parent dirs.
3637 Interactively, the default choice of directory to create
3638 is the current default directory for file names.
3639 That is useful when you have visited a file in a nonexistent directory.
3641 Noninteractively, the second (optional) argument PARENTS says whether
3642 to create parent directories if they don't exist. Interactively,
3643 this happens by default."
3646 nil nil)
3647 t))
3648 ;; If default-directory is a remote directory,
3649 ;; make sure we find its make-directory handler.
3657 create-list)
3664 \f
3667 "Function to use to revert this buffer, or nil to do the default.
3668 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3673 "Function to use to insert contents when reverting this buffer.
3674 Gets two args, first the nominal file name to use,
3675 and second, t if reading the auto-save file.
3680 "Function to check whether a non-file buffer needs reverting.
3681 This should be a function with one optional argument NOCONFIRM.
3682 Auto Revert Mode passes t for NOCONFIRM. The function should return
3683 non-nil if the buffer should be reverted. A return value of
3684 `fast' means that the need for reverting was not checked, but
3685 that reverting the buffer is fast. The buffer is current when
3686 this function is called.
3688 The idea behind the NOCONFIRM argument is that it should be
3689 non-nil if the buffer is going to be reverted without asking the
3690 user. In such situations, one has to be careful with potentially
3691 time consuming operations.
3693 For more information on how this variable is used by Auto Revert mode,
3697 "Normal hook for `revert-buffer' to run before reverting.
3698 If `revert-buffer-function' is used to override the normal revert
3702 "Normal hook for `revert-buffer' to run after reverting.
3703 Note that the hook value that it runs is the value that was in effect
3704 before reverting; that makes a difference if you have buffer-local
3705 hook functions.
3707 If `revert-buffer-function' is used to override the normal revert
3713 "Replace current buffer text with the text of the visited file on disk.
3714 This undoes all changes since the file was visited or saved.
3715 With a prefix argument, offer to revert from latest auto-save file, if
3716 that is more recent than the visited file.
3718 This command also works for special buffers that contain text which
3719 doesn't come from a file, but reflects some other data base instead:
3720 for example, Dired buffers and `buffer-list' buffers. In these cases,
3721 it reconstructs the buffer contents from the appropriate data base.
3723 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3724 to revert from the auto-save file when this is nil. Note that the
3725 sense of this argument is the reverse of the prefix argument, for the
3726 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3727 to nil.
3729 Optional second argument NOCONFIRM means don't ask for confirmation at
3730 all. (The local variable `revert-without-query', if non-nil, prevents
3731 confirmation.)
3733 Optional third argument PRESERVE-MODES non-nil means don't alter
3734 the files modes. Normally we reinitialize them using `normal-mode'.
3736 If the value of `revert-buffer-function' is non-nil, it is called to
3737 do all the work for this command. Otherwise, the hooks
3738 `before-revert-hook' and `after-revert-hook' are run at the beginning
3739 and the end, and if `revert-buffer-insert-file-contents-function' is
3740 non-nil, it is called instead of rereading visited file contents."
3742 ;; I admit it's odd to reverse the sense of the prefix argument, but
3743 ;; there is a lot of code out there which assumes that the first
3744 ;; argument should be t to avoid consulting the auto-save file, and
3745 ;; there's no straightforward way to encourage authors to notice a
3746 ;; reversal of the argument sense. So I'm just changing the user
3747 ;; interface, but leaving the programmatic interface the same.
3755 buffer-auto-save-file-name
3760 buffer-auto-save-file-name
3761 buffer-file-name)))
3772 found))
3774 file-name)))
3776 ;; If file was backed up but has changed since,
3777 ;; we shd make another backup.
3781 ;; Get rid of all undo records for this buffer.
3784 ;; Effectively copy the after-revert-hook status,
3785 ;; since after-find-file will clobber it.
3789 after-revert-hook)))
3791 ;; Don't make undo records for the reversion.
3795 file-name auto-save-p)
3798 "File %s no longer exists!"
3800 file-name))
3801 ;; Bind buffer-file-name to nil
3802 ;; so that we don't try to lock the file.
3808 ;; Auto-saved file shoule be read by Emacs'
3809 ;; internal coding.
3812 buffer-file-coding-system-explicit))))
3813 ;; This force after-insert-file-set-coding
3814 ;; (called from insert-file-contents) to set
3815 ;; buffer-file-coding-system to a proper value.
3818 ;; Note that this preserves point in an intelligent way.
3822 nil nil t))
3824 nil nil t)))))
3825 ;; Recompute the truename in case changes in symlinks
3826 ;; have changed the truename.
3830 ;; Run after-revert-hook as it was before we reverted.
3834 local-hook)
3837 t))))))
3840 "Recover the visited file--get contents from its last auto-save file."
3845 "Visit file FILE, but get contents from its last auto-save file."
3846 ;; Actually putting the file name in the minibuffer should be used
3847 ;; only rarely.
3848 ;; Not just because users often use the default.
3868 ;; Use insert-directory-safely, not insert-directory,
3869 ;; because these files might not exist. In particular,
3870 ;; FILE might not exist if the auto-save file was for
3871 ;; a buffer that didn't visit a file, such as "*mail*".
3872 ;; The code in v20.x called `ls' directly, so we need
3873 ;; to emulate what `ls' did in that case.
3879 ;; Keep the current buffer-file-coding-system.
3881 ;; Auto-saved file shoule be read with special coding.
3890 "Recover auto save files from a previous Emacs session.
3891 This command first displays a Dired buffer showing you the
3892 previous sessions that you could recover from.
3893 To choose one, move point to the proper line and then type C-c C-c.
3894 Then you'll be asked about a number of files to recover."
3904 auto-save-list-file-prefix)))
3905 t)
3914 ;; Each line starts with a space
3915 ;; so that Font Lock mode won't highlight the first character.
3924 "Choose one saved session to recover auto-save files from.
3925 This command is used in the special Dired buffer created by
3928 ;; Get the name of the session file to recover from.
3930 files
3936 ;; Read in the auto-save-list file.
3940 ;; Loop thru the text of that file
3941 ;; and get out the names of the files to recover.
3945 ;; This is a pair of lines for a non-file-visiting buffer.
3946 ;; Get the auto-save file name and manufacture
3947 ;; a "visited file name" from that.
3950 ;; If there is no auto-save file name, the
3951 ;; auto-save-list file is probably corrupted.
3966 ;; This pair of lines is a file-visiting
3967 ;; buffer. Use the visited file name.
3977 ;; Ignore a file if its auto-save file does not exist now.
3981 ;; The file contains a pair of line for each auto-saved buffer.
3982 ;; The first line of the pair contains the visited file name
3983 ;; or is empty if the buffer was not visiting a file.
3984 ;; The second line is the auto-save file name.
3992 files
3998 "Kill some buffers. Asks the user whether to kill each one of them.
3999 Non-interactively, if optional argument LIST is non-nil, it
4000 specifies the list of buffers to kill, asking for approval for each one."
4011 name
4016 \f
4018 "Toggle auto-saving of contents of current buffer.
4019 With prefix argument ARG, turn auto-saving on if positive, else off."
4024 ;; If auto-save is off because buffer has shrunk,
4025 ;; then toggling should turn it on.
4030 buffer-file-name
4032 ;; If -1 was stored here, to temporarily turn off saving,
4033 ;; turn it back on.
4039 buffer-auto-save-file-name)
4042 "Adjust current buffer's auto save file name for current conditions.
4043 Also rename any existing auto save file, if it was made in this session."
4055 "Return file name to use for auto-saves of current buffer.
4056 Does not consider `auto-save-visited-file-name' as that variable is checked
4057 before calling this function. You can redefine this for customization.
4058 See also `auto-save-file-name-p'."
4062 result uniq)
4063 ;; Apply user-specified translations
4064 ;; to the file name.
4068 filename)
4078 filename))))
4083 ;; We truncate the file name to DOS 8+3 limits
4084 ;; before doing anything else, because the regexp
4085 ;; passed to string-match below cannot handle
4086 ;; extensions longer than 3 characters, multiple
4087 ;; dots, and other atrocities.
4092 fn)
4097 "#"
4100 ;; Make sure auto-save file names don't contain characters
4101 ;; invalid for the underlying filesystem.
4103 ;; Don't modify remote (ange-ftp) filenames
4106 result))
4108 ;; Deal with buffers that don't have any associated files. (Mail
4109 ;; mode tends to create a good number of these.)
4113 file-name)
4114 ;; Eliminate all slashes and backslashes by
4115 ;; replacing them with sequences that start with %.
4116 ;; Quote % also, to keep distinct names distinct.
4125 ;; Generate the file name.
4131 ;; Try a few alternative directories, to get one we can
4132 ;; write it.
4138 ;; Don't modify remote (ange-ftp) filenames
4140 ;; The call to convert-standard-filename is in case
4141 ;; buffer-name includes characters not allowed by the
4142 ;; DOS/Windows filesystems. make-temp-file writes to the
4143 ;; file it creates, so we must fix the file name _before_
4144 ;; make-temp-file is called.
4146 fname))
4148 ;; make-temp-file creates the file,
4149 ;; but we don't want it to exist until we do an auto-save.
4153 file-name)))
4156 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4157 FILENAME should lack slashes. You can redefine this for customization."
4159 \f
4161 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4162 The generated regexp will match a filename iff the filename
4163 matches that wildcard according to shell rules. Only wildcards known
4164 by `sh' are supported."
4166 ;; Copy the initial run of non-special characters.
4169 ;; If no special characters, we're almost done.
4173 j)
4175 result
4196 ;; Found "[^". Insert a `\0' character
4197 ;; (which cannot happen in a filename)
4198 ;; into the character class, so that `^'
4199 ;; is not the first character after `[',
4200 ;; and thus non-special in a regexp.
4205 ;; I don't think `]' can appear in a
4206 ;; character class in a wildcard, but
4207 ;; let's be general here.
4214 i
4227 ;; Shell wildcards should match the entire filename,
4228 ;; not its part. Make the regexp say so.
4230 \f
4233 "*Switches for `list-directory' to pass to `ls' for brief listing."
4239 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4241 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4246 "Expand wildcard pattern PATTERN.
4247 This returns a list of file names which match the pattern.
4249 If PATTERN is written as an absolute file name,
4250 the values are absolute also.
4252 If PATTERN is written as a relative file name, it is interpreted
4253 relative to the current default directory, `default-directory'.
4254 The file names returned are normally also relative to the current
4255 default directory. However, if FULL is non-nil, they are absolute."
4259 ;; A list of all dirs that DIRPART specifies.
4260 ;; This can be more than one dir
4261 ;; if DIRPART contains wildcards.
4266 contents)
4271 ;; Filter out "." and ".."
4276 name))
4283 this-dir-contents)
4284 this-dir-contents)
4285 contents))))
4287 contents)))
4290 "Display a list of files in or matching DIRNAME, a la `ls'.
4291 DIRNAME is globbed by the shell if necessary.
4292 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4293 Actions controlled by variables `list-directory-brief-switches'
4294 and `list-directory-verbose-switches'."
4298 nil default-directory nil)
4299 pfx)))
4301 list-directory-brief-switches))
4302 buffer)
4315 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4323 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4325 PATTERN is assumed to represent a file-name wildcard suitable for the
4326 underlying filesystem. For Unix and GNU/Linux, the characters from the
4328 the parts of the pattern which don't include wildcard characters are
4329 quoted with double quotes.
4330 Existing quote characters in PATTERN are left alone, so you can pass
4331 PATTERN that already quotes some of the special characters."
4335 ;; DOS/Windows don't allow `"' in file names. So if the
4336 ;; argument has quotes, we can safely assume it is already
4337 ;; quoted by the caller.
4339 ;; We quote [&()#$'] in case their shell is a port of a
4340 ;; Unixy shell. We quote [,=+] because stock DOS and
4341 ;; Windows shells require that in some cases, such as
4342 ;; passing arguments to batch files that use positional
4343 ;; arguments like %1.
4345 pattern
4348 end)
4365 pattern))))
4372 "*Program to get the amount of free space on a file system.
4373 We assume the output has the format of `df'.
4374 The value of this variable must be just a command name or file name;
4375 if you want to specify options, use `directory-free-space-args'.
4377 A value of nil disables this feature.
4379 If the function `file-system-info' is defined, it is always used in
4380 preference to the program given by this variable."
4386 "*Options to use when running `directory-free-space-program'."
4391 "Return the mount of free space on directory DIR's file system.
4392 The result is a string that gives the number of free 1KB blocks,
4393 or nil if the system call or the program which retrieve the infornmation
4394 fail.
4396 This function calls `file-system-info' if it is available, or invokes the
4397 program specified by `directory-free-space-program' if that is non-nil."
4398 ;; Try to find the number of free blocks. Non-Posix systems don't
4399 ;; always have df, but might have an equivalent system call.
4408 nil t nil
4409 directory-free-space-args
4410 dir)))
4411 ;; Usual format is a header line followed by a line of
4412 ;; numbers.
4417 ;; Move to the end of the "available blocks" number.
4420 ;; Copy it into AVAILABLE.
4428 ;; insert-directory
4429 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4430 ;; FULL-DIRECTORY-P is nil.
4431 ;; The single line of output must display FILE's name as it was
4432 ;; given, namely, an absolute path name.
4433 ;; - must insert exactly one line for each file if WILDCARD or
4434 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4435 ;; before the file lines, plus optional text after the file lines.
4436 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4437 ;; allowed.
4438 ;; File lines should display the basename.
4439 ;; - must be consistent with
4440 ;; - functions dired-move-to-filename, (these two define what a file line is)
4441 ;; dired-move-to-end-of-filename,
4442 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4443 ;; dired-insert-headerline
4444 ;; dired-after-subdir-garbage (defines what a "total" line is)
4445 ;; - variable dired-subdir-regexp
4446 ;; - may be passed "--dired" as the first argument in SWITCHES.
4447 ;; Filename handlers might have to remove this switch if their
4448 ;; "ls" command does not support it.
4450 "Insert directory listing for FILE, formatted according to SWITCHES.
4451 Leaves point after the inserted text.
4452 SWITCHES may be a string of options, or a list of strings
4453 representing individual options.
4454 Optional third arg WILDCARD means treat FILE as shell wildcard.
4455 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4456 switches do not contain `d', so that a full listing is expected.
4458 This works by running a directory listing program
4459 whose name is in the variable `insert-directory-program'.
4460 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4462 When SWITCHES contains the long `--dired' option, this function
4463 treats it specially, for the sake of dired. However, the
4464 normally equivalent short `-D' option is just passed on to
4465 `insert-directory-program', as any other option."
4466 ;; We need the directory in order to find the right handler.
4471 wildcard full-directory-p)
4476 ;; Read the actual directory using `insert-directory-program'.
4477 ;; RESULT gets the status code.
4479 ;; putting text property `dired-filename, decode one
4480 ;; bunch by one to preserve that property.
4482 ;; This is to control encoding the arguments in call-process.
4486 default-file-name-coding-system))))
4489 ;; Run ls in the directory part of the file pattern
4490 ;; using the last component as argument.
4497 shell-file-name nil t nil
4498 "-c"
4500 ""
4502 insert-directory-program
4503 " -d "
4505 switches
4507 " -- "
4508 ;; Quote some characters that have
4509 ;; special meanings in shells; but
4510 ;; don't quote the wildcards--we want
4511 ;; them to be special. We also
4512 ;; currently don't quote the quoting
4513 ;; characters in case people want to
4514 ;; use them explicitly to quote
4515 ;; wildcard characters.
4517 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4518 ;; directory if FILE is a symbolic link.
4520 insert-directory-program nil t nil
4524 ;; Split the switches at any spaces so we can
4525 ;; pass separate options as separate args.
4527 ;; Avoid lossage if FILE starts with `-'.
4535 file))))))))
4537 ;; If we got "//DIRED//" in the output, it means we got a real
4538 ;; directory listing, even if `ls' returned nonzero.
4539 ;; So ignore any errors.
4552 ;; The first time ls returns an error,
4553 ;; find the version numbers of ls,
4554 ;; and set insert-directory-ls-version
4555 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4556 ;; is equal or if the info cannot be obtained.
4557 ;; (That can mean it isn't GNU ls.)
4567 comparison)
4583 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4587 ;; If `insert-directory-program' failed, signal an error.
4589 ;; Delete the error message it may have output.
4591 ;; On non-Posix systems, we cannot open a directory, so
4592 ;; don't even try, because that will always result in
4593 ;; the ubiquitous "Access denied". Instead, show the
4594 ;; command line so the user can try to guess what went wrong.
4599 insert-directory-program
4601 file result)
4602 ;; Unix. Access the file to get a suitable error.
4609 ;; The following overshoots by one line for an empty
4610 ;; directory listed with "--dired", but without "-a"
4611 ;; switch, where the ls output contains a
4612 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4613 ;; We take care of that case later.
4621 error-lines)
4622 ;; Find all the lines that are error messages,
4623 ;; and record the bounds of each one.
4630 ;; Now read the numeric positions of file names.
4637 error-lines))
4640 error-lines)))
4642 ;; End is followed by \n or by " -> ".
4644 ;; It seems that we can't trust ls's output as to
4645 ;; byte positions of filenames.
4651 ;; Take care of the case where the ls output contains a
4652 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4653 ;; and we went one line too far back (see above).
4658 ;; Now decode what read if necessary.
4660 file-name-coding-system
4661 default-file-name-coding-system
4663 coding-no-eol
4664 val pos)
4668 ;; If no coding system is specified or detection is
4669 ;; requested, detect the coding.
4683 ;; Force no eol conversion on a file name, so
4684 ;; that CR is preserved.
4692 ;; Try to insert the amount of free space.
4695 ;; First find the line to put it on.
4699 ;; Replace "total" with "used", to avoid confusion.
4705 "Convert `ls --dired' file name position value POS to a buffer position.
4706 File name position values returned in ls --dired output
4707 count only stdout; they don't count the error messages sent to stderr.
4708 So this function converts to them to real buffer positions.
4709 ERROR-LINES is a list of buffer positions of error message lines,
4710 of the form (START END)."
4714 pos)
4718 "Insert directory listing for FILE, formatted according to SWITCHES.
4720 Like `insert-directory', but if FILE does not exist, it inserts a
4721 message to that effect instead of signaling an error."
4724 ;; Simulate the message printed by `ls'.
4728 "Functions to call with no arguments to query about killing Emacs.
4729 If any of these functions returns nil, killing Emacs is cancelled.
4731 but `kill-emacs', the low level primitive, does not.
4735 "How to ask for confirmation when leaving Emacs.
4736 If nil, the default, don't ask at all. If the value is non-nil, it should
4737 be a predicate function such as `yes-or-no-p'."
4745 "Offer to save each buffer, then kill this Emacs process.
4746 With prefix arg, silently save all file-visiting buffers, then kill."
4755 ;; process-list is not defined on VMS.
4757 active)
4766 ;; Query the user for other things, perhaps.
4771 \f
4772 ;; We use /: as a prefix to "quote" a file name
4773 ;; so that magic file name handlers will not apply to it.
4777 file-name-handler-alist))
4779 ;; We depend on being the last handler on the list,
4780 ;; so that anything else which does need handling
4781 ;; has been handled already.
4782 ;; So it is safe for us to inhibit *all* magic file name handlers.
4791 default-directory))
4792 ;; Get a list of the indices of the args which are file names.
4795 ;; The first six are special because they
4796 ;; return a file name. We want to include the /:
4797 ;; in the return value.
4798 ;; So just avoid stripping it in the first place.
4805 ;; `identity' means just return the first arg
4806 ;; not stripped of its quoting.
4808 ;; `add' means add "/:" to the result.
4810 ;; `quote' means add "/:" to buffer-file-name.
4812 ;; `unquote-then-quote' means set buffer-file-name
4813 ;; temporarily to unquoted filename.
4815 ;; List the arguments which are filenames.
4823 ;; For all other operations, treat the first argument only
4824 ;; as the file name.
4826 method
4827 ;; Copy ARGUMENTS so we can replace elements in it.
4831 ;; Strip off the /: from the file names that have it.
4839 "/"
4854 res))
4857 \f
4881 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
4882 ;;; files.el ends here