| blob | eca86c52a794cbdc23330a9d3dbd402b7ded9e1e |
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 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.
303 nil means don't add newlines.
305 You will have to be careful if you set this to nil: you will have
306 to remember to manually add a final newline whenever you finish a
307 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 This function's standard definition is trivial; it just returns
518 the argument. However, on Windows and DOS, replace invalid
519 characters. On DOS, make sure to obey the 8.3 limitations. On
520 Windows, turn Cygwin names into native names, and also turn
521 slashes into backslashes if the shell requires it (see
522 `w32-shell-dos-semantics').
524 See Info node `(elisp)Standard File Names' for more details."
525 filename)
528 "Read directory name, prompting with PROMPT and completing in directory DIR.
529 Value is not expanded---you must call `expand-file-name' yourself.
530 Default name to DEFAULT-DIRNAME if user exits with the same
531 non-empty string that was inserted by this function.
532 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
533 except that if INITIAL is specified, that combined with DIR is used.)
534 If the user exits with an empty minibuffer, this function returns
535 an empty string. (This can only happen if the user erased the
536 pre-inserted contents or if `insert-default-directory' is nil.)
537 Fourth arg MUSTMATCH non-nil means require existing directory's name.
538 Non-nil and non-t means also require confirmation after completion.
539 Fifth arg INITIAL specifies text to start with.
540 DIR should be an absolute directory name. It defaults to
541 the value of `default-directory'."
550 \f
552 "Show the current default directory."
557 "Value of the CDPATH environment variable, as a list.
561 "Explode a search path into a list of directory names.
562 Directories are separated by occurrences of `path-separator'
563 \(which is colon in GNU and GNU-like systems)."
564 ;; We could use split-string here.
572 nil
577 cd-list)))
580 "Change current directory to given absolute file name DIR."
581 ;; Put the name into directory syntax now,
582 ;; because otherwise expand-file-name may give some bad results.
595 "Make DIR become the current buffer's default directory.
596 If your environment includes a `CDPATH' variable, try each one of
597 that list of directories (separated by occurrences of
598 `path-separator') when resolving a relative directory name.
599 The path separator is colon in GNU and GNU-like systems."
602 default-directory default-directory
618 cd-path)
619 nil))
623 "Load the Lisp file named FILE."
624 ;; This is a case where .elc makes a lot of sense.
631 "Search for FILENAME through PATH.
632 If SUFFIXES is non-nil, it should be a list of suffixes to append to
634 If non-nil, PREDICATE is used instead of `file-readable-p'.
635 PREDICATE can also be an integer to pass to the `access' system call,
636 in which case file-name handlers are ignored. This usage is deprecated.
638 For compatibility, PREDICATE can also be one of the symbols
639 `executable', `readable', `writable', or `exists', or a list of
640 one or more of those symbols."
651 "Do completion for file names passed to `locate-file'.
652 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
675 "Load the library named LIBRARY.
676 This is an interface to the function `load'."
679 'locate-file-completion
684 "Test whether FILE specifies a location on a remote system.
685 Return an identification of the system if the location is indeed
686 remote. The identification of the system may comprise a method
687 to access the system and its hostname, amongst other things.
694 nil)))
697 "Copy the file FILE into a temporary file on this machine.
698 Returns the name of the local copy, or nil, if FILE is directly
699 accessible."
700 ;; This formerly had an optional BUFFER argument that wasn't used by
701 ;; anything.
705 nil)))
708 "Return the truename of FILENAME, which should be absolute.
709 The truename of a file name is found by chasing symbolic links
710 both at the level of the file and at the level of the directories
711 containing it, until no links are left at any level.
714 ;; COUNTER and PREV-DIRS are only used in recursive calls.
715 ;; COUNTER can be a cons cell whose car is the count of how many
716 ;; more links to chase before getting an error.
717 ;; PREV-DIRS can be a cons cell whose car is an alist
718 ;; of truenames we've just recently computed.
732 ;; For speed, remove the ange-ftp completion handler from the list.
733 ;; We know it's not needed here.
734 ;; For even more speed, do this only on the outermost call.
741 ;; andrewi@harlequin.co.uk - none of the following code (except for
742 ;; invoking the file-name handler) currently applies on Windows
743 ;; (ie. there are no native symlinks), but there is an issue with
744 ;; case differences being ignored by the OS, and short "8.3 DOS"
745 ;; name aliases existing for all files. (The short names are not
746 ;; reported by directory-files, but can be used to refer to files.)
747 ;; It seems appropriate for file-truename to resolve these issues in
748 ;; the most natural way, which on Windows is to call the function
749 ;; `w32-long-file-name' - this returns the exact name of a file as
750 ;; it is stored on disk (expanding short name aliases with the full
751 ;; name in the process).
754 ;; For file name that has a special handler, call handler.
755 ;; This is so that ange-ftp can save time by doing a no-op.
758 ;; If filename contains a wildcard, newname will be the old name.
760 ;; If filename exists, use the long name
764 ;; If this file directly leads to a link, process that iteratively
765 ;; so that we don't use lots of stack.
771 ;; For file name that has a special handler, call handler.
772 ;; This is so that ange-ftp can save time by doing a no-op.
775 done t)
777 target dirfile)
778 ;; Get the truename of the directory.
780 ;; If these are equal, we have the (or a) root directory.
782 ;; If this is the same dir we last got the truename for,
783 ;; save time--don't recalculate.
793 done t)
796 done t)
797 ;; Put it back on the file name.
799 ;; Is the file name the name of a link?
802 ;; Yes => chase that link, then start all over
803 ;; since the link may point to a directory name that uses links.
804 ;; We can't safely use expand-file-name here
805 ;; since target might look like foo/../bar where foo
806 ;; is itself a link. Instead, we handle . and .. above.
809 target
811 done nil)
812 ;; No, we are done!
814 filename))
817 "Chase links in FILENAME until a name that is not a link.
818 Unlike `file-truename', this does not check whether a parent
819 directory name is a symbolic link.
820 If the optional argument LIMIT is a number,
821 it means chase no more than that many links and then stop."
829 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
832 ;; Handle `..' by hand, since it needs to work in the
833 ;; target of any directory symlink.
834 ;; This code is not quite complete; it does not handle
835 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
839 ;; Chase links in the default dir of the symlink.
843 ;; Now find the parent of that dir.
847 newname))
850 "Change the encoding of FILE's name from CODING to NEW-CODING.
851 The value is a new name of FILE.
852 Signals a `file-already-exists' error if a file of the new name
853 already exists unless optional third argument OK-IF-ALREADY-EXISTS
854 is non-nil. A number as third arg means request confirmation if
855 the new name already exists. This is what happens in interactive
856 use with M-x."
859 default-file-name-coding-system))
861 from-coding to-coding)
863 ;; We provide the default coding only when it seems that
864 ;; the filename is correctly decoded by the default
865 ;; coding.
871 filename default-coding)
872 default-coding))
876 ;; We provide the default coding only when a user is going to
877 ;; change the encoding not from the default coding.
881 filename from-coding)))
884 filename from-coding default-coding)
885 default-coding)))
889 default-file-name-coding-system))
890 ;; FILE should have been decoded by DEFAULT-CODING.
894 ;; Suppress further encoding.
899 newname))
900 \f
902 "Select buffer BUFFER in another window.
903 If BUFFER does not identify an existing buffer, then this function
904 creates a buffer with that name.
906 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
907 or nil. If BUFFER is nil, then this function chooses a buffer
908 using `other-buffer'.
909 Optional second arg NORECORD non-nil means
910 do not put this buffer at the front of the list of recently selected ones.
911 This function returns the buffer it switched to.
913 This uses the function `display-buffer' as a subroutine; see its
914 documentation for additional customization information."
917 ;; Don't let these interfere.
918 same-window-buffer-names same-window-regexps)
922 "Switch to buffer BUFFER in another frame.
923 Optional second arg NORECORD non-nil means
924 do not put this buffer at the front of the list of recently selected ones.
926 This uses the function `display-buffer' as a subroutine; see its
927 documentation for additional customization information."
930 same-window-buffer-names same-window-regexps)
938 "Add FUN to `minibuffer-setup-hook' while executing BODY.
939 BODY should use the minibuffer at most once.
940 Recursive uses of the minibuffer will not be affected."
945 ;; Clear out this hook so it does not interfere
946 ;; with any recursive minibuffer usage.
962 t))
965 "Edit file FILENAME.
966 Switch to a buffer visiting file FILENAME,
967 creating one if none already exists.
968 Interactively, the default if you just type RET is the current directory,
969 but the visited file name is available through the minibuffer history:
970 type M-n to pull it into the minibuffer.
972 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
973 expand wildcards (if any) and visit multiple files. You can
974 suppress wildcard expansion by setting `find-file-wildcards'.
976 To visit a file without any kind of conversion and without
985 "Edit file FILENAME, in another window.
986 May create a new window, or reuse an existing one.
987 See the function `display-buffer'.
989 Interactively, the default if you just type RET is the current directory,
990 but the visited file name is available through the minibuffer history:
991 type M-n to pull it into the minibuffer.
993 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
994 expand wildcards (if any) and visit multiple files."
1005 "Edit file FILENAME, in another frame.
1006 May create a new frame, or reuse an existing one.
1007 See the function `display-buffer'.
1009 Interactively, the default if you just type RET is the current directory,
1010 but the visited file name is available through the minibuffer history:
1011 type M-n to pull it into the minibuffer.
1013 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1014 expand wildcards (if any) and visit multiple files."
1025 "Edit the existing file FILENAME.
1033 "Edit file FILENAME but don't allow changes.
1045 value))
1048 "Edit file FILENAME in another window but don't allow changes.
1060 value))
1063 "Edit file FILENAME in another frame but don't allow changes.
1075 value))
1078 "Find file FILENAME as a replacement for the file in the next window.
1079 This command does not select that window.
1081 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1082 expand wildcards (if any) and replace the file with multiple files."
1094 t))))
1102 "Find file FILENAME, select its buffer, kill previous buffer.
1103 If the current buffer now contains an empty file that you just visited
1104 \(presumably by mistake), use this command to visit the file you really want.
1106 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1107 expand wildcards (if any) and replace the file with multiple files."
1117 t)))
1138 ;; This prevents us from finding the same buffer
1139 ;; if we specified the same file again.
1143 ;; Likewise for dired buffers.
1147 ;; This executes if find-file gets an error
1148 ;; and does not really find anything.
1149 ;; We put things back as they were.
1150 ;; If find-file actually finds something, we kill obuf below.
1159 ;; We already asked; don't ask again.
1162 \f
1164 "Create a suitably named buffer for visiting FILENAME, and return it.
1165 FILENAME (sans directory) is used unchanged if that name is free;
1166 otherwise a string <2> or <3> or ... is appended to get an unused name."
1173 "Create and return a buffer with a name based on NAME.
1174 Choose the buffer's name using `generate-new-buffer-name'."
1178 "Regexp to match the automounter prefix in a directory name."
1186 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1188 removes automounter prefixes (see the variable `automount-dir-prefix')."
1189 ;; Get rid of the prefixes added by the automounter.
1196 ;; If any elt of directory-abbrev-alist matches this name,
1197 ;; abbreviate accordingly.
1203 ;; Compute and save the abbreviated homedir name.
1204 ;; We defer computing this until the first time it's needed, to
1205 ;; give time for directory-abbrev-alist to be set properly.
1206 ;; We include a slash at the end, to avoid spurious matches
1207 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1214 ;; If FILENAME starts with the abbreviated homedir,
1215 ;; make it start with `~' instead.
1217 ;; If the home dir is just /, don't change it.
1220 ;; MS-DOS root directories can come with a drive letter;
1221 ;; Novell Netware allows drive letters beyond `Z:'.
1231 filename))
1234 "*List of logical names for which visiting shouldn't save the true dirname.
1235 On VMS, when you visit a file using a logical name that searches a path,
1236 you may or may not want the visited file name to record the specific
1237 directory where the file was found. If you *do not* want that, add the logical
1238 name to this list as a string."
1243 "Return the buffer visiting file FILENAME (a string).
1244 This is like `get-file-buffer', except that it checks for any buffer
1245 visiting the same file, possibly under a different name.
1246 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1247 and others are ignored.
1248 If there is no such live buffer, return nil."
1262 found)
1267 number
1272 ;; Verify this buffer's file number
1273 ;; still belongs to its file.
1276 attributes)
1280 found))))
1281 \f
1283 "*Non-nil means file-visiting commands should handle wildcards.
1284 For example, if you specify `*.c', that would visit all the files
1285 whose names match the pattern."
1291 "*Non-nil means suppress warning messages for symlinked files.
1292 When nil, Emacs prints a warning when visiting a file that is already
1293 visited, but with a different name. Setting this option to t
1294 suppresses this warning."
1300 "Maximum size of file above which a confirmation is requested.
1301 When nil, never request confirmation."
1308 "Read file FILENAME into a buffer and return the buffer.
1309 If a buffer exists visiting FILENAME, return that one, but
1310 verify that the file has not changed since visited or saved.
1311 The buffer is not selected, just returned to the caller.
1312 Optional first arg NOWARN non-nil means suppress any warning messages.
1313 Optional second arg RAWFILE non-nil means the file is read literally.
1314 Optional third arg WILDCARDS non-nil means do wildcard processing
1315 and visit all the matching files. When wildcards are actually
1316 used and expanded, return a list of buffers that are visiting
1317 the various files."
1324 'find-directory-functions
1327 filename)))
1330 find-file-wildcards
1344 ;; Find any buffer for a file which has same truename.
1346 ;; Let user know if there is a buffer with the same truename.
1350 find-file-suppress-same-file-warnings
1354 ;; Optionally also find that buffer.
1357 ;; Check to see if the file looks uncommonly large.
1359 ;; Don't ask again if we already have the file or
1360 ;; if we're asked to be quiet.
1369 ;; We are using an existing buffer.
1375 ;; Certain files should be reverted automatically
1376 ;; if they have changed on disk and not in the buffer.
1384 found))
1394 "File %s changed on disk. Discard your edits? "
1399 "File %s changed on disk. Discard your edits in %s? "
1407 ;; Check if a formerly read-only file has become
1408 ;; writable and vice versa, but if the buffer agrees
1409 ;; with the new state of the file, that is ok too.
1416 buffer-file-name
1424 ;; It is confusing to ask whether to visit
1425 ;; non-literally if they have the file in
1426 ;; hexl-mode.
1430 "Save file and revisit literally? "
1435 rawfile truename number))
1437 "Discard your edits and revisit file literally? "
1440 rawfile truename number)
1444 "Revisit file literally? "
1447 rawfile truename number)
1450 ;; Return the buffer we are using.
1451 buf)
1452 ;; Create a new buffer.
1455 ;; find-file-noselect-1 may use a different buffer.
1457 rawfile truename number))))))
1463 ;; Needed in case we are re-visiting the file with a different
1464 ;; text representation.
1481 filename)))
1482 ;; Unconditionally set error
1492 filename)))
1493 ;; Run find-file-not-found-hooks until one returns non-nil.
1495 ;; If they fail too, set error.
1497 ;; Record the file's truename, and maybe use that as visited name.
1503 ;; On VMS, we may want to remember which directory in a search list
1504 ;; the file was found in.
1516 ;; Set buffer's default directory to that of the file.
1518 ;; Turn off backup files for certain file names. Since
1519 ;; this is a permanent local, the major mode won't eliminate it.
1532 \f
1534 "Like `insert-file-contents', but only reads in the file literally.
1535 A buffer may be modified in several ways after reading into the buffer,
1536 to Emacs features such as format decoding, character code
1537 conversion, `find-file-hook', automatic uncompression, etc.
1539 This function ensures that none of these modifications will take place."
1547 nil))
1550 inhibit-file-name-handlers))
1563 filename)))
1573 "Insert contents of file FILENAME into buffer after point with no conversion.
1575 This function is meant for the user to run interactively.
1576 Don't call it from programs! Use `insert-file-contents-literally' instead.
1577 \(Its calling sequence is different; see its documentation)."
1582 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1587 "Visit file FILENAME with no conversion of any kind.
1588 Format conversion and character code conversion are both disabled,
1589 and multibyte characters are disabled in the resulting buffer.
1590 The major mode used is Fundamental mode regardless of the file name,
1591 and local variable specifications in the file are ignored.
1592 Automatic uncompression and adding a newline at the end of the
1593 file due to `require-final-newline' is also disabled.
1595 You cannot absolutely rely on this function to result in
1596 visiting the file literally. If Emacs already has a buffer
1597 which is visiting the file, you get the existing buffer,
1598 regardless of whether it was created literally or not.
1600 In a Lisp program, if you want to be sure of accessing a file's
1601 contents literally, you should create a temporary buffer and then read
1602 the file contents into it using `insert-file-contents-literally'."
1605 \f
1609 after-find-file-from-revert-buffer
1610 nomodes)
1611 "Called after finding a file and by the default revert function.
1612 Sets buffer mode, parses local variables.
1613 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1614 error in reading the file. WARN non-nil means warn if there
1615 exists an auto-save file more recent than the visited file.
1616 NOAUTO means don't mess with auto-save mode.
1617 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1618 means this call was from `revert-buffer'.
1619 Fifth arg NOMODES non-nil means don't alter the file's modes.
1620 Finishes by calling the functions in `find-file-hook'
1621 unless NOMODES is non-nil."
1624 nil
1634 ;; No need to warn if buffer is auto-saved
1635 ;; under the name of the visited file.
1637 auto-save-visited-file-name))
1640 buffer-file-name))
1660 ;; Make people do a little extra work (C-x C-q)
1661 ;; before altering a backup file.
1664 ;; When a file is marked read-only,
1665 ;; make the buffer read-only even if root is looking at it.
1673 ;; If requested, add a newline at the end of the file.
1683 view-read-only
1689 "Eval BODY and turn any error into a FORMAT message.
1690 FORMAT can have a %s escape which will be replaced with the actual error.
1691 If `debug-on-error' is set, errors are not caught, so that you can
1692 debug them.
1693 Avoid using a large BODY since it is duplicated."
1702 "Choose the major mode for this buffer automatically.
1703 Also sets up any specified local variables of the file.
1704 Uses the visited file name, the -*- line, and the local variables spec.
1706 This function is called automatically from `find-file'. In that case,
1707 we may set up the file-specified mode and local variables,
1708 depending on the value of `enable-local-variables': if it is t, we do;
1709 if it is nil, we don't; otherwise, we query.
1710 In addition, if `local-enable-local-variables' is nil, we do
1711 not set local variables (though we do notice a mode specified with -*-.)
1713 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1714 or from Lisp without specifying the optional argument FIND-FILE;
1715 in that case, this function acts as if `enable-local-variables' were t."
1727 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1728 ;; c++-mode, java-mode and more) are added through autoload
1729 ;; directives in that file. That way is discouraged since it
1730 ;; spreads out the definition of the initial value.
1755 ;; Less common extensions come here
1756 ;; so more common ones above are found faster.
1795 ;; The list of archive file extensions should be in sync with
1796 ;; `auto-coding-alist' with `no-conversion' coding system.
1800 ;; Mailer puts message to be edited in
1801 ;; /tmp/Re.... or Message
1806 ;; some news reader is reported to use this
1815 ;; .emacs or .gnus or .viper following a directory delimiter in
1816 ;; Unix, MSDOG or VMS syntax.
1819 ;; _emacs following a directory delimiter
1820 ;; in MsDos syntax
1839 ;; Windows candidates may be opened case sensitively on Unix
1845 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1847 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1848 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\)\\'" . conf-mode)
1849 ;; either user's dot-files or under /etc or some such
1851 ;; alas not all ~/.*rc files are like this
1852 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1857 ;; this contains everything twice, with space and with colon :-(
1859 ;; Get rid of any trailing .n.m and try again.
1860 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1861 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1862 ;; Using mode nil rather than `ignore' would let the search continue
1863 ;; through this list (with the shortened name) rather than start over.
1865 ;; The following should come after the ChangeLog pattern
1866 ;; for the sake of ChangeLog.1, etc.
1867 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1870 "Alist of filename patterns vs corresponding major mode functions.
1871 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1872 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1873 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1874 mode function to use. FUNCTION will be called, unless it is nil.
1876 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1877 calling FUNCTION (if it's not nil), we delete the suffix that matched
1878 REGEXP and search the list again for another match.
1880 If the file name matches `inhibit-first-line-modes-regexps',
1881 then `auto-mode-alist' is not processed.
1883 See also `interpreter-mode-alist', which detects executable script modes
1884 based on the interpreters they specify to run,
1888 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1889 ;; and pike-mode) are added through autoload directives in that
1890 ;; file. That way is discouraged since it spreads out the
1891 ;; definition of the initial value.
1929 "Alist mapping interpreter names to major modes.
1930 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
1931 Each element looks like (INTERPRETER . MODE).
1932 The car of each element is compared with
1933 the name of the interpreter specified in the first line.
1934 If it matches, mode MODE is selected.
1942 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1943 When checking `inhibit-first-line-modes-regexps', we first discard
1949 "Regular expression matching interpreters, for file mode determination.
1950 This regular expression is matched against the first line of a file
1951 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1952 a mode from the file's name. If it matches, the file is assumed to
1953 be interpreted by the interpreter matched by the second group of the
1954 regular expression. The mode is then determined as the mode associated
1959 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
1963 comment-re "*"
1966 . html-mode)
1967 ;; These two must come after html, because they are more general:
1972 . sgml-mode)
1975 "Alist of buffer beginnings vs. corresponding major mode functions.
1976 Each element looks like (REGEXP . FUNCTION). FUNCTION will be
1980 "Select major mode appropriate for current buffer.
1982 This checks for a -*- mode tag in the buffer's text, checks the
1983 interpreter that runs this file against `interpreter-mode-alist',
1984 compares the buffer beginning against `magic-mode-alist', or
1985 compares the filename against the entries in `auto-mode-alist'.
1987 It does not check for the `mode:' local variable in the
1988 Local Variables section of the file; for that, use `hack-local-variables'.
1990 If `enable-local-variables' is nil, this function does not check for a
1991 -*- mode tag.
1993 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
1994 only set the major mode, if that would change it."
1995 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1997 ;; Find a -*- mode tag
2004 ;; Find all specifications for the `mode:' variable
2005 ;; and execute them left to right.
2017 modes)))
2018 ;; Simple -*-MODE-*- case.
2021 modes))))
2022 ;; If we found modes to use, invoke them now, outside the save-excursion.
2030 ;; continuing would call minor modes again, toggling them off
2032 ;; If we didn't, look for an interpreter specified in the first line.
2033 ;; As a special case, allow for things like "#!/bin/env perl", which
2034 ;; finds the interpreter anywhere in $PATH.
2040 ;; Map interpreter name to a mode, signalling we're done at the
2041 ;; same time.
2043 interpreter-mode-alist))
2044 ;; If we found an interpreter mode to use, invoke it now.
2047 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2055 ;; Compare the filename against the entries in auto-mode-alist.
2058 ;; Remove backup-suffixes from file name.
2061 ;; Find first matching alist entry.
2074 ;; When `keep-mode-if-same' is set, we are working on behalf of
2075 ;; set-visited-file-name. In that case, if the major mode specified is the
2076 ;; same one we already have, don't actually reset it. We don't want to lose
2077 ;; minor modes such as Font Lock.
2079 "Apply MODE and return it.
2080 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2081 any aliases and compared to current major mode. If they are the
2082 same, do nothing and return nil."
2090 mode))
2093 "Find the -*- spec in the buffer.
2094 Call with point at the place to start searching from.
2095 If one is found, set point to the beginning
2096 and return the position of the end.
2097 Otherwise, return nil; point may be changed."
2100 ;; Don't look for -*- if this file name matches any
2101 ;; of the regexps in inhibit-first-line-modes-regexps.
2109 sufs)
2117 ;; If the file begins with "#!"
2118 ;; (exec interpreter magic), look
2119 ;; for mode frobs in the first two
2120 ;; lines. You cannot necessarily
2121 ;; put them in the first line of
2122 ;; such a file without screwing up
2123 ;; the interpreter invocation.
2131 t))
2137 end))))
2140 "Set local variables specified in the -*- line.
2141 Ignore any specification for `mode:' and `coding:';
2142 `set-auto-mode' should already have handled `mode:',
2143 `set-auto-coding' should already have handled `coding:'.
2144 If MODE-ONLY is non-nil, all we do is check whether the major mode
2145 is specified, returning t if it is specified."
2150 mode-specified
2153 ;; Parse the -*- line into the RESULT alist.
2154 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2156 nil)
2158 ;; Simple form: "-*- MODENAME -*-". Already handled.
2160 nil)
2162 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2163 ;; (last ";" is optional).
2168 ;; There used to be a downcase here,
2169 ;; but the manual didn't say so,
2170 ;; and people want to set var names that aren't all lc.
2177 ;; It is traditional to ignore
2178 ;; case when checking for `mode' in set-auto-mode,
2179 ;; so we must do that here as well.
2180 ;; That is inconsistent, but we're stuck with it.
2181 ;; The same can be said for `coding' in set-auto-coding.
2199 ;; If we fail to switch in the selected window,
2200 ;; it is probably a minibuffer.
2201 ;; So try another window.
2212 nil))))
2215 "Normal hook run after processing a file's local variables specs.
2216 Major modes can use this to examine user-specified local variables
2220 "Parse and put into effect this buffer's local variables spec.
2221 If MODE-ONLY is non-nil, all we do is check whether the major mode
2222 is specified, returning t if it is specified."
2224 ;; If MODE-ONLY is t, we check here for specifying the mode
2225 ;; in the -*- line. If MODE-ONLY is nil, we process
2226 ;; the -*- line here.
2230 ;; Look for "Local variables:" line in last page.
2237 mode-only
2247 buffer-file-name)
2252 ;; suffix is what comes after "local variables:" in its line.
2257 ;; prefix is what comes before "local variables:" in its line.
2262 beg)
2266 endpos
2272 nil t))
2282 ;; Discard the prefix.
2287 ;; Discard the suffix.
2295 ;; Find the variable name; strip whitespace.
2303 val)
2304 ;; Read the variable value.
2311 ;; Set the variable. "Variables" mode and eval are funny.
2317 mode-specified))
2322 ;; Get confirmation before setting these variables as locals in a file.
2347 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2377 ;; This case is safe because the user gets to check it before it is used.
2381 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2382 If VAL is nil or omitted, the question is whether any value might be
2383 dangerous."
2386 (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$"
2389 ;; If the safe-local-variable property isn't t or nil,
2390 ;; then it must return non-nil on the proposed value to be safe.
2397 Add expressions to this list if you want Emacs to evaluate them, when
2398 they appear in an `eval' local variable specification, without first
2399 asking you for confirmation."
2416 "Return t if it is safe to eval EXP when it is found in a file."
2418 ;; Detect certain `put' expressions.
2424 ;; Only allow safe values of lisp-indent-hook;
2425 ;; not functions.
2428 ;; Allow expressions that the user requested.
2430 ;; Certain functions can be allowed with safe arguments
2431 ;; or can specify verification functions to try.
2439 ok))
2447 ok)))))))
2451 A few patterns are specified so that any name which matches one
2452 is considered risky."
2457 ;; We have already handled coding: tag in set-auto-coding.
2458 nil)
2460 nil)
2461 ;; "Setting" eval means either eval it or do nothing.
2462 ;; Likewise for setting hook variables.
2464 ;; Permit evalling a put of a harmless property.
2465 ;; if the args do nothing tricky.
2468 ;; Permit eval if not root and user says ok.
2487 ;; Ordinary variable, really set it.
2489 ;; Make sure the string has no text properties.
2490 ;; Some text properties can get evaluated in various ways,
2491 ;; so it is risky to put them on with a local variable list.
2496 \f
2499 However, the mode will not be changed if
2500 \(1) a local variables list or the `-*-' line specifies a major mode, or
2502 \ not suitable for ordinary files, or
2503 \(3) the new file name does not particularly specify any mode."
2508 "Change name of file visited in current buffer to FILENAME.
2509 The next time the buffer is saved it will go in the newly specified file.
2510 FILENAME nil or an empty string means make buffer not be visiting any file.
2511 Remember to delete the initial contents of the minibuffer
2512 if you wish to pass an empty string as the argument.
2514 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2515 confirmation in the case where another buffer is already visiting FILENAME.
2517 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2518 the old visited file has been renamed to the new name FILENAME."
2526 nil
2537 filename)))
2551 ;; If new-name == old-name, renaming would add a spurious <2>
2552 ;; and it's considered as a feature in rename-buffer.
2558 ;; Abbreviate the file names of the buffer.
2567 nil)))
2568 ;; write-file-functions is normally used for things like ftp-find-file
2569 ;; that visit things that are not local files as if they were files.
2570 ;; Changing to visit an ordinary local file instead should flush the hook.
2575 ;; If buffer was read-only because of version control,
2576 ;; that reason is gone now, so make it writable.
2580 ;; Turn off backup files for certain file names.
2581 ;; Since this is a permanent local, the major mode won't eliminate it.
2588 ;; If auto-save was not already on, turn it on if appropriate.
2592 ;; If auto save is on, start using a new name.
2593 ;; We deliberately don't rename or delete the old auto save
2594 ;; for the old visited file name. This is because perhaps
2595 ;; the user wants to save the new state and then compare with the
2596 ;; previous state from the auto save file.
2599 ;; Rename the old auto save file if any.
2606 ;; Update the major mode, if the file name determines it.
2608 ;; Don't change the mode if it is special.
2611 ;; Don't change the mode if the local variable list specifies it.
2617 "Write current buffer into file FILENAME.
2618 This makes the buffer visit that file, and marks it as not modified.
2620 If you specify just a directory name as FILENAME, that means to use
2621 the default file name but in that directory. You can also yank
2622 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2624 If the buffer is not already visiting a file, the default file name
2625 for the output file is the buffer name.
2627 If optional second arg CONFIRM is non-nil, this function
2628 asks for confirmation before overwriting an existing file.
2629 Interactively, confirmation is required unless you supply a prefix argument."
2630 ;; (interactive "FWrite file: ")
2634 nil nil nil nil)
2638 default-directory)
2639 nil nil))
2643 ;; If arg is just a directory,
2644 ;; use the default file name, but in that directory.
2655 ;; Make buffer writable if file is writable.
2660 \f
2662 "Make a backup of the disk file visited by the current buffer, if appropriate.
2663 This is normally done before saving the buffer the first time.
2665 A backup may be done by renaming or by copying; see documentation of
2666 variable `make-backup-files'. If it's done by renaming, then the file is
2667 no longer accessible under its old name.
2669 The value is non-nil after a backup was made by renaming.
2670 It has the form (MODES . BACKUPNAME).
2671 MODES is the result of `file-modes' on the original
2672 file; this means that the caller, after saving the buffer, should change
2673 the modes of the new file to agree with the old modes.
2674 BACKUPNAME is the backup file name, which is the old file renamed."
2681 backup-info backupname targets setmodes)
2682 ;; If specified name is a symbolic link, chase it to the target.
2683 ;; Thus we make the backups in the directory where the real file is.
2688 ;; (if (file-directory-p buffer-file-name)
2689 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2693 ;; If have old versions to maybe delete,
2694 ;; ask the user to confirm now, before doing anything.
2695 ;; But don't actually delete til later.
2700 real-file-name)))))
2702 ;; Actually write the back up file.
2705 ; (file-symlink-p buffer-file-name)
2706 backup-by-copying
2707 ;; Don't rename a suid or sgid file.
2722 ;; rename-file should delete old backup.
2726 ;; If trouble writing the backup, write it in ~.
2735 ;; Now delete the old versions, if desired.
2742 setmodes)
2749 ;; If copying fails because file TO-NAME
2750 ;; is not writable, delete that file and try again.
2759 "Return file NAME sans backup versions or strings.
2760 This is a separate procedure so your site-init or startup file can
2761 redefine it.
2762 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2763 we do not remove backup version numbers, only true file version numbers."
2769 ;; VMS version number is (a) semicolon, optional
2770 ;; sign, zero or more digits or (b) period, option
2771 ;; sign, zero or more digits, provided this is the
2772 ;; second period encountered outside of the
2773 ;; device/directory part of the file name.
2776 name)
2786 "Return t if deleting FILE and rewriting it would preserve the owner."
2791 ;; Return t if the file doesn't exist, since it's true that no
2792 ;; information would be lost by an (attempted) delete and create.
2798 The extension, in a file name, is the part that follows the last `.',
2799 except that a leading `.', if any, doesn't count."
2802 directory)
2806 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2807 ;; we don't want to expand it.
2810 filename))))
2814 The extension, in a file name, is the part that follows the last `.',
2815 except that a leading `.', if any, doesn't count.
2816 Return nil for extensionless file names such as `foo'.
2817 Return the empty string for file names such as `foo.'.
2819 If PERIOD is non-nil, then the returned value includes the period
2820 that delimits the extension, and if FILENAME has no extension,
2831 "A function to use instead of the default `make-backup-file-name'.
2832 A value of nil gives the default `make-backup-file-name' behaviour.
2834 This could be buffer-local to do something special for specific
2835 files. If you define it, you may need to change `backup-file-name-p'
2836 and `file-name-sans-versions' too.
2838 See also `backup-directory-alist'."
2844 "Alist of filename patterns and backup directory names.
2845 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2846 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2847 relative or absolute. If it is absolute, so that all matching files
2848 are backed up into the same directory, the file names in this
2849 directory will be the full name of the file backed up with all
2850 directory separators changed to `!' to prevent clashes. This will not
2851 work correctly if your filesystem truncates the resulting name.
2853 For the common case of all backups going into one directory, the alist
2855 directory name.
2857 If this variable is nil, or it fails to match a filename, the backup
2858 is made in the original file's directory.
2860 On MS-DOS filesystems without long names this variable is always
2861 ignored."
2867 "Default `backup-enable-predicate' function.
2868 Checks for files in `temporary-file-directory',
2869 `small-temporary-file-directory', and /tmp."
2872 ;; Directory is under temporary-file-directory.
2877 ;; Directory is under /tmp.
2882 0 nil
2884 ;; Directory is under small-temporary-file-directory.
2889 "Create the non-numeric backup file name for FILE.
2890 Normally this will just be the file's name with `~' appended.
2891 Customization hooks are provided as follows.
2893 If the variable `make-backup-file-name-function' is non-nil, its value
2894 should be a function which will be called with FILE as its argument;
2895 the resulting name is used.
2897 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2898 the documentation of that variable. If the directory for the backup
2899 doesn't exist, it is created."
2913 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2915 elt backup-directory)
2920 alist nil)))
2926 file
2930 ;; Normalize DOSish file names: downcase the drive
2931 ;; letter, if any, and replace the leading "x:" with
2932 ;; "/drive_x".
2935 ;; Replace any invalid file-name characters (for the
2936 ;; case of backing up remote files).
2940 "drive_"
2943 ""
2946 ;; Make the name unique by substituting directory
2947 ;; separators. It may not really be worth bothering about
2948 ;; doubling `!'s in the original name...
2953 backup-directory))
2960 "Return non-nil if FILE is a backup file name (numeric or not).
2961 This is a separate function so you can redefine it for customization.
2962 You may need to redefine `file-name-sans-versions' as well."
2967 ;; This is used in various files.
2968 ;; The usage of backup-extract-version-start is not very clean,
2969 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2971 "Given the name of a numeric backup file, FN, return the backup number.
2972 Uses the free variable `backup-extract-version-start', whose value should be
2973 the index in the name where the version number begins."
2979 ;; I believe there is no need to alter this behavior for VMS;
2980 ;; since backup files are not made on VMS, it should not get called.
2982 "Find a file name for a backup file FN, and suggestions for deletions.
2983 Value is a list whose car is the name for the backup file
2984 and whose cdr is a list of old versions to consider deleting now.
2985 If the value is nil, don't make a backup.
2986 Uses `backup-directory-alist' in the same way as does
2987 `make-backup-file-name'."
2989 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2993 ;; We don't support numbered backups on plain MS-DOS
2994 ;; when long file names are unavailable.
3004 possibilities deserve-versions-p versions)
3007 base-versions
3010 possibilities)
3011 #'<)
3016 kept-old-versions
3017 kept-new-versions
3024 ;; Delete nothing if there is overflow
3025 ;; in the number of versions to keep.
3031 v))))))))))
3034 "Return number of names file FILENAME has."
3037 ;; (defun file-relative-name (filename &optional directory)
3038 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3039 ;; This function returns a relative file name which is equivalent to FILENAME
3040 ;; when used with that default directory as the default.
3041 ;; If this is impossible (which can happen on MSDOS and Windows
3042 ;; when the file name and directory use different drive names)
3043 ;; then it returns FILENAME."
3044 ;; (save-match-data
3045 ;; (let ((fname (expand-file-name filename)))
3046 ;; (setq directory (file-name-as-directory
3047 ;; (expand-file-name (or directory default-directory))))
3048 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3049 ;; ;; drive names, they can't be relative, so return the absolute name.
3050 ;; (if (and (or (eq system-type 'ms-dos)
3051 ;; (eq system-type 'cygwin)
3052 ;; (eq system-type 'windows-nt))
3053 ;; (not (string-equal (substring fname 0 2)
3054 ;; (substring directory 0 2))))
3055 ;; filename
3056 ;; (let ((ancestor ".")
3057 ;; (fname-dir (file-name-as-directory fname)))
3058 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3059 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3060 ;; (setq directory (file-name-directory (substring directory 0 -1))
3061 ;; ancestor (if (equal ancestor ".")
3062 ;; ".."
3063 ;; (concat "../" ancestor))))
3064 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3065 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3066 ;; ;; We matched within FNAME's directory part.
3067 ;; ;; Add the rest of FNAME onto ANCESTOR.
3068 ;; (let ((rest (substring fname (match-end 0))))
3069 ;; (if (and (equal ancestor ".")
3070 ;; (not (equal rest "")))
3071 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3072 ;; rest
3073 ;; (concat (file-name-as-directory ancestor) rest)))
3074 ;; ;; We matched FNAME's directory equivalent.
3075 ;; ancestor))))))
3078 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3079 This function returns a relative file name which is equivalent to FILENAME
3080 when used with that default directory as the default.
3081 If FILENAME and DIRECTORY lie on different machines or on different drives
3082 on a DOS/Windows machine, it returns FILENAME on expanded form."
3086 default-directory))))
3092 ;; Test for different drives on DOS/Windows
3094 ;; Should `cygwin' really be included here? --stef
3097 ;; Test for different remote file system identification
3099 filename
3105 directory nil nil case-fold-search))
3107 directory nil nil case-fold-search))))
3110 ".."
3112 ;; Now ancestor is empty, or .., or ../.., etc.
3114 directory nil nil case-fold-search))
3115 ;; We matched within FILENAME's directory part.
3116 ;; Add the rest of FILENAME onto ANCESTOR.
3119 ;; But don't bother with ANCESTOR if it would give us `./'.
3120 rest
3122 ;; We matched FILENAME's directory equivalent.
3123 ancestor))))))
3124 \f
3126 "Save current buffer in visited file if modified. Variations are described below.
3127 By default, makes the previous version into a backup file
3128 if previously requested or if this is the first save.
3130 to become a backup when the next save is done.
3132 unconditionally makes the previous version into a backup file.
3134 to become a backup when the next save is done,
3135 and unconditionally makes the previous version into a backup file.
3137 With a numeric argument of 0, never make the previous version
3138 into a backup file.
3140 If a file's name is FOO, the names of its numbered backup versions are
3141 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3142 Numeric backups (rather than FOO~) will be made if value of
3143 `version-control' is not the atom `never' and either there are already
3144 numeric versions of the file being backed up, or `version-control' is
3145 non-nil.
3146 We don't want excessive versions piling up, so there are variables
3147 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3148 and `kept-new-versions', which tells how many newest versions to keep.
3149 Defaults are 2 old versions and 2 new.
3150 `dired-kept-versions' controls dired's clean-directory (.) command.
3151 If `delete-old-versions' is nil, system will query user
3152 before trimming versions. Otherwise it does it silently.
3154 If `vc-make-backup-files' is nil, which is the default,
3155 no backup files are made for files managed by version control.
3156 (This is because the version control system itself records previous versions.)
3158 See the subroutine `basic-save-buffer' for more information."
3171 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3172 Normally delete only if the file was written by this Emacs since
3173 the last real save, but optional arg FORCE non-nil means delete anyway."
3187 "Normal hook that is run before a buffer is saved to its file."
3193 "Normal hook that is run after a buffer is saved to its file."
3199 "If non-nil, use this coding system for saving the buffer.
3200 More precisely, use this coding system in place of the
3201 value of `buffer-file-coding-system', when saving the buffer.
3202 Calling `write-region' for any purpose other than saving the buffer
3203 will still use `buffer-file-coding-system'; this variable has no effect
3210 "Save the current buffer in its visited file, if it has been modified.
3211 The hooks `write-contents-functions' and `write-file-functions' get a chance
3212 to do the job of saving; if they do not, then the buffer is saved in
3213 the visited file file in the usual way.
3214 Before and after saving the buffer, this function runs
3215 `before-save-hook' and `after-save-hook', respectively."
3218 ;; In an indirect buffer, save its base buffer instead.
3223 setmodes)
3224 ;; On VMS, rename file and buffer to get rid of version number.
3229 ;; Strip VMS version number before save.
3232 ;; Construct a (unique) buffer name to correspond.
3237 ;; If buffer has no file name, ask user for one.
3244 filename))
3270 ;; Support VC version backups.
3276 ;; If a hook returned t, file is already "written".
3277 ;; Otherwise, write it the usual way now.
3279 ;; Now we have saved the current buffer. Let's make sure
3280 ;; that buffer-file-coding-system is fixed to what
3281 ;; actually used for saving by binding it locally.
3291 ;; If the auto-save file was recent before this command,
3292 ;; delete it now.
3294 ;; Support VC `implicit' locking.
3299 ;; This does the "real job" of writing a buffer into its visited file
3300 ;; and making a backup file. This is what is normally done
3301 ;; but inhibited if one of write-file-functions returns non-nil.
3302 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3311 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3325 buffer-file-name)))
3333 ;; If file is precious, write temp name, then rename it.
3334 ;; This requires write access to the containing dir,
3335 ;; which is why we don't try it if we don't have that access.
3337 tempname nogood i succeed
3341 ;; Find the temporary name to write under.
3348 "%s$tmp$%d"
3350 dir i))
3356 tempname nil realname
3357 buffer-file-truename)
3359 ;; If writing the temp file fails,
3360 ;; delete the temp file.
3367 ;; Since we have created an entirely new file
3368 ;; and renamed it, make sure it gets the
3369 ;; right permission bits set.
3371 buffer-file-name)))
3372 ;; We succeeded in writing the temp file,
3373 ;; so rename it.
3375 ;; If file not writable, see if we can make it writable
3376 ;; temporarily while we write it.
3377 ;; But no need to do so if we have just backed it up
3378 ;; (setmodes is set) because that says we're superseding.
3380 ;; Change the mode back, after writing.
3387 buffer-file-name nil t buffer-file-truename)
3389 ;; If we get an error writing the new file, and we made
3390 ;; the backup by renaming, undo the backing-up.
3393 setmodes))
3396 "View the differences between BUFFER and its associated file.
3397 This requires the external program `diff' to be in your `exec-path'."
3412 ;; Display that message for 1 second so that user can read it
3413 ;; in the minibuffer.
3415 ;; return always nil, so that save-buffers-kill-emacs will not move
3416 ;; over to the next unsaved buffer when calling `d'.
3417 nil)
3420 '((?\C-r
3426 ;; Return nil to ask about BUF again.
3427 nil)
3429 (?d diff-buffer-with-file
3439 "Save some modified file-visiting buffers. Asks user about each one.
3440 You can answer `y' to save, `n' not to save, `C-r' to look at the
3441 buffer in question with `view-buffer' before deciding or `d' to
3442 view the differences using `diff-buffer-with-file'.
3444 Optional argument (the prefix) non-nil means save all with no questions.
3445 Optional second argument PRED determines which buffers are considered:
3446 If PRED is nil, all the file-visiting buffers are considered.
3447 If PRED is t, then certain non-file buffers will also be considered.
3448 If PRED is a zero-argument function, it indicates for each buffer whether
3449 to consider it or not when called with that buffer current.
3451 See `save-some-buffers-action-alist' if you want to
3452 change the additional actions you can take on files."
3456 files-done abbrevs-done)
3458 ;; First save any buffers that we're supposed to save unconditionally.
3459 ;; That way the following code won't ask about them.
3464 ;; Ask about those buffers that merit it,
3465 ;; and record the number thus saved.
3481 t
3494 save-some-buffers-action-alist))
3495 ;; Maybe to save abbrevs, and record whether
3496 ;; we either saved them or asked to.
3502 abbrev-file-name)))
3504 ;; Don't keep bothering user if he says no.
3509 "(Some special files were saved without asking)"
3511 \f
3513 "Mark current buffer as unmodified, not needing to be saved.
3516 It is not a good idea to use this function in Lisp programs, because it
3517 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3524 "Change whether this buffer is visiting its file read-only.
3525 With arg, set read-only iff arg is positive.
3526 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3531 nil ; do nothing.
3532 ;; Toggle.
3539 ;; If view-mode is already active, `view-mode-enter' is a nop.
3551 "Insert contents of file FILENAME into buffer after point.
3552 Set mark after the inserted text.
3554 This function is meant for the user to run interactively.
3555 Don't call it from programs! Use `insert-file-contents' instead.
3556 \(Its calling sequence is different; see its documentation)."
3561 "Append the contents of the region to the end of file FILENAME.
3562 When called from a function, expects three arguments,
3563 START, END and FILENAME. START and END are buffer positions
3564 saying what text to write."
3569 "Return most recent backup file for FILENAME or nil if no backups exist."
3570 ;; `make-backup-file-name' will get us the right directory for
3571 ;; ordinary or numeric backups. It might create a directory for
3572 ;; backups as a side-effect, according to `backup-directory-alist'.
3579 tem)
3588 newest))
3591 "Rename current buffer to a similar name not already taken.
3592 This function is useful for creating multiple shell process buffers
3593 or multiple mail buffers, etc."
3601 ;; If the existing buffer name has a <NNN>,
3602 ;; which isn't part of the file name (if any),
3603 ;; then get rid of that.
3609 "Create the directory DIR and any nonexistent parent dirs.
3610 Interactively, the default choice of directory to create
3611 is the current default directory for file names.
3612 That is useful when you have visited a file in a nonexistent directory.
3614 Noninteractively, the second (optional) argument PARENTS says whether
3615 to create parent directories if they don't exist. Interactively,
3616 this happens by default."
3619 nil nil)
3620 t))
3621 ;; If default-directory is a remote directory,
3622 ;; make sure we find its make-directory handler.
3630 create-list)
3637 \f
3640 "Function to use to revert this buffer, or nil to do the default.
3641 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3646 "Function to use to insert contents when reverting this buffer.
3647 Gets two args, first the nominal file name to use,
3648 and second, t if reading the auto-save file.
3653 "Function to check whether a non-file buffer needs reverting.
3654 This should be a function with one optional argument NOCONFIRM.
3655 Auto Revert Mode sets NOCONFIRM to t. The function should return
3656 non-nil if the buffer should be reverted. A return value of
3657 `fast' means that the need for reverting was not checked, but
3658 that reverting the buffer is fast. The buffer is current when
3659 this function is called.
3661 The idea behind the NOCONFIRM argument is that it should be
3662 non-nil if the buffer is going to be reverted without asking the
3663 user. In such situations, one has to be careful with potentially
3664 time consuming operations.
3666 For more information on how this variable is used by Auto Revert mode,
3670 "Normal hook for `revert-buffer' to run before reverting.
3671 If `revert-buffer-function' is used to override the normal revert
3675 "Normal hook for `revert-buffer' to run after reverting.
3676 Note that the hook value that it runs is the value that was in effect
3677 before reverting; that makes a difference if you have buffer-local
3678 hook functions.
3680 If `revert-buffer-function' is used to override the normal revert
3686 "Replace current buffer text with the text of the visited file on disk.
3687 This undoes all changes since the file was visited or saved.
3688 With a prefix argument, offer to revert from latest auto-save file, if
3689 that is more recent than the visited file.
3691 This command also works for special buffers that contain text which
3692 doesn't come from a file, but reflects some other data base instead:
3693 for example, Dired buffers and `buffer-list' buffers. In these cases,
3694 it reconstructs the buffer contents from the appropriate data base.
3696 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3697 to revert from the auto-save file when this is nil. Note that the
3698 sense of this argument is the reverse of the prefix argument, for the
3699 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3700 to nil.
3702 Optional second argument NOCONFIRM means don't ask for confirmation at
3703 all. (The local variable `revert-without-query', if non-nil, prevents
3704 confirmation.)
3706 Optional third argument PRESERVE-MODES non-nil means don't alter
3707 the files modes. Normally we reinitialize them using `normal-mode'.
3709 If the value of `revert-buffer-function' is non-nil, it is called to
3710 do all the work for this command. Otherwise, the hooks
3711 `before-revert-hook' and `after-revert-hook' are run at the beginning
3712 and the end, and if `revert-buffer-insert-file-contents-function' is
3713 non-nil, it is called instead of rereading visited file contents."
3715 ;; I admit it's odd to reverse the sense of the prefix argument, but
3716 ;; there is a lot of code out there which assumes that the first
3717 ;; argument should be t to avoid consulting the auto-save file, and
3718 ;; there's no straightforward way to encourage authors to notice a
3719 ;; reversal of the argument sense. So I'm just changing the user
3720 ;; interface, but leaving the programmatic interface the same.
3726 buffer-auto-save-file-name
3731 buffer-auto-save-file-name
3732 buffer-file-name)))
3743 found))
3745 file-name)))
3747 ;; If file was backed up but has changed since,
3748 ;; we shd make another backup.
3752 ;; Get rid of all undo records for this buffer.
3755 ;; Effectively copy the after-revert-hook status,
3756 ;; since after-find-file will clobber it.
3760 after-revert-hook)))
3762 ;; Don't make undo records for the reversion.
3766 file-name auto-save-p)
3769 "File %s no longer exists!"
3771 file-name))
3772 ;; Bind buffer-file-name to nil
3773 ;; so that we don't try to lock the file.
3779 ;; Auto-saved file shoule be read by Emacs'
3780 ;; internal coding.
3783 buffer-file-coding-system-explicit))))
3784 ;; This force after-insert-file-set-coding
3785 ;; (called from insert-file-contents) to set
3786 ;; buffer-file-coding-system to a proper value.
3789 ;; Note that this preserves point in an intelligent way.
3793 nil nil t))
3795 nil nil t)))))
3796 ;; Recompute the truename in case changes in symlinks
3797 ;; have changed the truename.
3801 ;; Run after-revert-hook as it was before we reverted.
3805 local-hook)
3808 t)))))
3811 "Recover the visited file--get contents from its last auto-save file."
3816 "Visit file FILE, but get contents from its last auto-save file."
3817 ;; Actually putting the file name in the minibuffer should be used
3818 ;; only rarely.
3819 ;; Not just because users often use the default.
3839 ;; Use insert-directory-safely, not insert-directory,
3840 ;; because these files might not exist. In particular,
3841 ;; FILE might not exist if the auto-save file was for
3842 ;; a buffer that didn't visit a file, such as "*mail*".
3843 ;; The code in v20.x called `ls' directly, so we need
3844 ;; to emulate what `ls' did in that case.
3850 ;; Keep the current buffer-file-coding-system.
3852 ;; Auto-saved file shoule be read with special coding.
3861 "Recover auto save files from a previous Emacs session.
3862 This command first displays a Dired buffer showing you the
3863 previous sessions that you could recover from.
3864 To choose one, move point to the proper line and then type C-c C-c.
3865 Then you'll be asked about a number of files to recover."
3875 auto-save-list-file-prefix)))
3876 t)
3885 ;; Each line starts with a space
3886 ;; so that Font Lock mode won't highlight the first character.
3895 "Choose one saved session to recover auto-save files from.
3896 This command is used in the special Dired buffer created by
3899 ;; Get the name of the session file to recover from.
3901 files
3907 ;; Read in the auto-save-list file.
3911 ;; Loop thru the text of that file
3912 ;; and get out the names of the files to recover.
3916 ;; This is a pair of lines for a non-file-visiting buffer.
3917 ;; Get the auto-save file name and manufacture
3918 ;; a "visited file name" from that.
3921 ;; If there is no auto-save file name, the
3922 ;; auto-save-list file is probably corrupted.
3937 ;; This pair of lines is a file-visiting
3938 ;; buffer. Use the visited file name.
3948 ;; Ignore a file if its auto-save file does not exist now.
3952 ;; The file contains a pair of line for each auto-saved buffer.
3953 ;; The first line of the pair contains the visited file name
3954 ;; or is empty if the buffer was not visiting a file.
3955 ;; The second line is the auto-save file name.
3963 files
3969 "Kill some buffers. Asks the user whether to kill each one of them.
3970 Non-interactively, if optional argument LIST is non-nil, it
3971 specifies the list of buffers to kill, asking for approval for each one."
3982 name
3987 \f
3989 "Toggle auto-saving of contents of current buffer.
3990 With prefix argument ARG, turn auto-saving on if positive, else off."
3995 ;; If auto-save is off because buffer has shrunk,
3996 ;; then toggling should turn it on.
4001 buffer-file-name
4003 ;; If -1 was stored here, to temporarily turn off saving,
4004 ;; turn it back on.
4010 buffer-auto-save-file-name)
4013 "Adjust current buffer's auto save file name for current conditions.
4014 Also rename any existing auto save file, if it was made in this session."
4026 "Return file name to use for auto-saves of current buffer.
4027 Does not consider `auto-save-visited-file-name' as that variable is checked
4028 before calling this function. You can redefine this for customization.
4029 See also `auto-save-file-name-p'."
4033 result uniq)
4034 ;; Apply user-specified translations
4035 ;; to the file name.
4039 filename)
4049 filename))))
4054 ;; We truncate the file name to DOS 8+3 limits
4055 ;; before doing anything else, because the regexp
4056 ;; passed to string-match below cannot handle
4057 ;; extensions longer than 3 characters, multiple
4058 ;; dots, and other atrocities.
4063 fn)
4068 "#"
4071 ;; Make sure auto-save file names don't contain characters
4072 ;; invalid for the underlying filesystem.
4074 ;; Don't modify remote (ange-ftp) filenames
4077 result))
4079 ;; Deal with buffers that don't have any associated files. (Mail
4080 ;; mode tends to create a good number of these.)
4084 file-name)
4085 ;; Eliminate all slashes and backslashes by
4086 ;; replacing them with sequences that start with %.
4087 ;; Quote % also, to keep distinct names distinct.
4096 ;; Generate the file name.
4102 ;; Try a few alternative directories, to get one we can
4103 ;; write it.
4109 ;; Don't modify remote (ange-ftp) filenames
4111 ;; The call to convert-standard-filename is in case
4112 ;; buffer-name includes characters not allowed by the
4113 ;; DOS/Windows filesystems. make-temp-file writes to the
4114 ;; file it creates, so we must fix the file name _before_
4115 ;; make-temp-file is called.
4117 fname))
4119 ;; make-temp-file creates the file,
4120 ;; but we don't want it to exist until we do an auto-save.
4124 file-name)))
4127 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4128 FILENAME should lack slashes. You can redefine this for customization."
4130 \f
4132 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4133 The generated regexp will match a filename iff the filename
4134 matches that wildcard according to shell rules. Only wildcards known
4135 by `sh' are supported."
4137 ;; Copy the initial run of non-special characters.
4140 ;; If no special characters, we're almost done.
4144 j)
4146 result
4167 ;; Found "[^". Insert a `\0' character
4168 ;; (which cannot happen in a filename)
4169 ;; into the character class, so that `^'
4170 ;; is not the first character after `[',
4171 ;; and thus non-special in a regexp.
4176 ;; I don't think `]' can appear in a
4177 ;; character class in a wildcard, but
4178 ;; let's be general here.
4185 i
4198 ;; Shell wildcards should match the entire filename,
4199 ;; not its part. Make the regexp say so.
4201 \f
4204 "*Switches for `list-directory' to pass to `ls' for brief listing."
4210 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4212 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4217 "Expand wildcard pattern PATTERN.
4218 This returns a list of file names which match the pattern.
4220 If PATTERN is written as an absolute file name,
4221 the values are absolute also.
4223 If PATTERN is written as a relative file name, it is interpreted
4224 relative to the current default directory, `default-directory'.
4225 The file names returned are normally also relative to the current
4226 default directory. However, if FULL is non-nil, they are absolute."
4230 ;; A list of all dirs that DIRPART specifies.
4231 ;; This can be more than one dir
4232 ;; if DIRPART contains wildcards.
4237 contents)
4242 ;; Filter out "." and ".."
4247 name))
4254 this-dir-contents)
4255 this-dir-contents)
4256 contents))))
4258 contents)))
4261 "Display a list of files in or matching DIRNAME, a la `ls'.
4262 DIRNAME is globbed by the shell if necessary.
4263 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4264 Actions controlled by variables `list-directory-brief-switches'
4265 and `list-directory-verbose-switches'."
4269 nil default-directory nil)
4270 pfx)))
4272 list-directory-brief-switches))
4273 buffer)
4286 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4294 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4296 PATTERN is assumed to represent a file-name wildcard suitable for the
4297 underlying filesystem. For Unix and GNU/Linux, the characters from the
4299 the parts of the pattern which don't include wildcard characters are
4300 quoted with double quotes.
4301 Existing quote characters in PATTERN are left alone, so you can pass
4302 PATTERN that already quotes some of the special characters."
4306 ;; DOS/Windows don't allow `"' in file names. So if the
4307 ;; argument has quotes, we can safely assume it is already
4308 ;; quoted by the caller.
4310 ;; We quote [&()#$'] in case their shell is a port of a
4311 ;; Unixy shell. We quote [,=+] because stock DOS and
4312 ;; Windows shells require that in some cases, such as
4313 ;; passing arguments to batch files that use positional
4314 ;; arguments like %1.
4316 pattern
4319 end)
4336 pattern))))
4343 "*Program to get the amount of free space on a file system.
4344 We assume the output has the format of `df'.
4345 The value of this variable must be just a command name or file name;
4346 if you want to specify options, use `directory-free-space-args'.
4348 A value of nil disables this feature.
4350 If the function `file-system-info' is defined, it is always used in
4351 preference to the program given by this variable."
4357 "*Options to use when running `directory-free-space-program'."
4362 "Return the mount of free space on directory DIR's file system.
4363 The result is a string that gives the number of free 1KB blocks,
4364 or nil if the system call or the program which retrieve the infornmation
4365 fail.
4367 This function calls `file-system-info' if it is available, or invokes the
4368 program specified by `directory-free-space-program' if that is non-nil."
4369 ;; Try to find the number of free blocks. Non-Posix systems don't
4370 ;; always have df, but might have an equivalent system call.
4379 nil t nil
4380 directory-free-space-args
4381 dir)))
4382 ;; Usual format is a header line followed by a line of
4383 ;; numbers.
4388 ;; Move to the end of the "available blocks" number.
4391 ;; Copy it into AVAILABLE.
4399 ;; insert-directory
4400 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4401 ;; FULL-DIRECTORY-P is nil.
4402 ;; The single line of output must display FILE's name as it was
4403 ;; given, namely, an absolute path name.
4404 ;; - must insert exactly one line for each file if WILDCARD or
4405 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4406 ;; before the file lines, plus optional text after the file lines.
4407 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4408 ;; allowed.
4409 ;; File lines should display the basename.
4410 ;; - must be consistent with
4411 ;; - functions dired-move-to-filename, (these two define what a file line is)
4412 ;; dired-move-to-end-of-filename,
4413 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4414 ;; dired-insert-headerline
4415 ;; dired-after-subdir-garbage (defines what a "total" line is)
4416 ;; - variable dired-subdir-regexp
4417 ;; - may be passed "--dired" as the first argument in SWITCHES.
4418 ;; Filename handlers might have to remove this switch if their
4419 ;; "ls" command does not support it.
4421 "Insert directory listing for FILE, formatted according to SWITCHES.
4422 Leaves point after the inserted text.
4423 SWITCHES may be a string of options, or a list of strings
4424 representing individual options.
4425 Optional third arg WILDCARD means treat FILE as shell wildcard.
4426 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4427 switches do not contain `d', so that a full listing is expected.
4429 This works by running a directory listing program
4430 whose name is in the variable `insert-directory-program'.
4431 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4433 When SWITCHES contains the long `--dired' option, this function
4434 treats it specially, for the sake of dired. However, the
4435 normally equivalent short `-D' option is just passed on to
4436 `insert-directory-program', as any other option."
4437 ;; We need the directory in order to find the right handler.
4442 wildcard full-directory-p)
4447 ;; Read the actual directory using `insert-directory-program'.
4448 ;; RESULT gets the status code.
4450 ;; putting text property `dired-filename, decode one
4451 ;; bunch by one to preserve that property.
4453 ;; This is to control encoding the arguments in call-process.
4457 default-file-name-coding-system))))
4460 ;; Run ls in the directory part of the file pattern
4461 ;; using the last component as argument.
4468 shell-file-name nil t nil
4469 "-c"
4471 ""
4473 insert-directory-program
4474 " -d "
4476 switches
4478 " -- "
4479 ;; Quote some characters that have
4480 ;; special meanings in shells; but
4481 ;; don't quote the wildcards--we want
4482 ;; them to be special. We also
4483 ;; currently don't quote the quoting
4484 ;; characters in case people want to
4485 ;; use them explicitly to quote
4486 ;; wildcard characters.
4488 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4489 ;; directory if FILE is a symbolic link.
4491 insert-directory-program nil t nil
4495 ;; Split the switches at any spaces so we can
4496 ;; pass separate options as separate args.
4498 ;; Avoid lossage if FILE starts with `-'.
4506 file))))))))
4508 ;; If we got "//DIRED//" in the output, it means we got a real
4509 ;; directory listing, even if `ls' returned nonzero.
4510 ;; So ignore any errors.
4523 ;; The first time ls returns an error,
4524 ;; find the version numbers of ls,
4525 ;; and set insert-directory-ls-version
4526 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4527 ;; is equal or if the info cannot be obtained.
4528 ;; (That can mean it isn't GNU ls.)
4538 comparison)
4554 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4558 ;; If `insert-directory-program' failed, signal an error.
4560 ;; Delete the error message it may have output.
4562 ;; On non-Posix systems, we cannot open a directory, so
4563 ;; don't even try, because that will always result in
4564 ;; the ubiquitous "Access denied". Instead, show the
4565 ;; command line so the user can try to guess what went wrong.
4570 insert-directory-program
4572 file result)
4573 ;; Unix. Access the file to get a suitable error.
4580 ;; The following overshoots by one line for an empty
4581 ;; directory listed with "--dired", but without "-a"
4582 ;; switch, where the ls output contains a
4583 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4584 ;; We take care of that case later.
4592 error-lines)
4593 ;; Find all the lines that are error messages,
4594 ;; and record the bounds of each one.
4601 ;; Now read the numeric positions of file names.
4608 error-lines))
4611 error-lines)))
4613 ;; End is followed by \n or by " -> ".
4615 ;; It seems that we can't trust ls's output as to
4616 ;; byte positions of filenames.
4622 ;; Take care of the case where the ls output contains a
4623 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4624 ;; and we went one line too far back (see above).
4629 ;; Now decode what read if necessary.
4631 file-name-coding-system
4632 default-file-name-coding-system
4634 coding-no-eol
4635 val pos)
4639 ;; If no coding system is specified or detection is
4640 ;; requested, detect the coding.
4654 ;; Force no eol conversion on a file name, so
4655 ;; that CR is preserved.
4663 ;; Try to insert the amount of free space.
4666 ;; First find the line to put it on.
4670 ;; Replace "total" with "used", to avoid confusion.
4676 "Convert `ls --dired' file name position value POS to a buffer position.
4677 File name position values returned in ls --dired output
4678 count only stdout; they don't count the error messages sent to stderr.
4679 So this function converts to them to real buffer positions.
4680 ERROR-LINES is a list of buffer positions of error message lines,
4681 of the form (START END)."
4685 pos)
4689 "Insert directory listing for FILE, formatted according to SWITCHES.
4691 Like `insert-directory', but if FILE does not exist, it inserts a
4692 message to that effect instead of signaling an error."
4695 ;; Simulate the message printed by `ls'.
4699 "Functions to call with no arguments to query about killing Emacs.
4700 If any of these functions returns nil, killing Emacs is cancelled.
4702 but `kill-emacs', the low level primitive, does not.
4706 "How to ask for confirmation when leaving Emacs.
4707 If nil, the default, don't ask at all. If the value is non-nil, it should
4708 be a predicate function such as `yes-or-no-p'."
4716 "Offer to save each buffer, then kill this Emacs process.
4717 With prefix arg, silently save all file-visiting buffers, then kill."
4726 ;; process-list is not defined on VMS.
4728 active)
4737 ;; Query the user for other things, perhaps.
4742 \f
4743 ;; We use /: as a prefix to "quote" a file name
4744 ;; so that magic file name handlers will not apply to it.
4748 file-name-handler-alist))
4750 ;; We depend on being the last handler on the list,
4751 ;; so that anything else which does need handling
4752 ;; has been handled already.
4753 ;; So it is safe for us to inhibit *all* magic file name handlers.
4762 default-directory))
4763 ;; Get a list of the indices of the args which are file names.
4766 ;; The first six are special because they
4767 ;; return a file name. We want to include the /:
4768 ;; in the return value.
4769 ;; So just avoid stripping it in the first place.
4776 ;; `identity' means just return the first arg
4777 ;; not stripped of its quoting.
4779 ;; `add' means add "/:" to the result.
4781 ;; `quote' means add "/:" to buffer-file-name.
4783 ;; `unquote-then-quote' means set buffer-file-name
4784 ;; temporarily to unquoted filename.
4786 ;; List the arguments which are filenames.
4794 ;; For all other operations, treat the first argument only
4795 ;; as the file name.
4797 method
4798 ;; Copy ARGUMENTS so we can replace elements in it.
4802 ;; Strip off the /: from the file names that have it.
4810 "/"
4825 res))
4828 \f
4852 ;;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
4853 ;;; files.el ends here