| blob | e9ae0fb834f05c77593be7d3c561bf2911589cd4 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985,86,87,92,93,94,95,96,97,98,99,2000,01,02,03,2004
4 ;;; 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 "*Value of t says silently ensure a file ends in a newline when it is saved.
277 Non-nil but not t says ask user whether to add a newline when there isn't one.
278 nil means don't add newlines."
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
291 Normally auto-save files are written under other names."
297 ;; Don't put "\\2" inside expand-file-name, since it will be
298 ;; transformed to "/2" on DOS/Windows.
300 "*Transforms to apply to buffer file name before making auto-save file name.
301 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
302 REGEXP is a regular expression to match against the file name.
303 If it matches, `replace-match' is used to replace the
304 matching part with REPLACEMENT.
305 If the optional element UNIQUIFY is non-nil, the auto-save file name is
306 constructed by taking the directory part of the replaced file-name,
307 concatenated with the buffer file name with all directory separators
308 changed to `!' to prevent clashes. This will not work
309 correctly if your filesystem truncates the resulting name.
311 All the transforms in the list are tried, in the order they are listed.
312 When one transform applies, its result is final;
313 no further transforms are tried.
315 The default value is set up to put the auto-save file into the
316 temporary directory (see the variable `temporary-file-directory') for
317 editing a remote file.
319 On MS-DOS filesystems without long names this variable is always
320 ignored."
327 "*Non-nil means save word abbrevs too when files are saved.
328 If `silently', don't ask the user before saving."
333 "*Non-nil means allow `find-file' to visit directories.
334 To visit the directory, `find-file' runs `find-directory-functions'."
339 "*List of functions to try in sequence to visit a directory.
340 Each function is called with the directory name as the sole argument
341 and should return either a buffer or nil."
345 ;;;It is not useful to make this a local variable.
346 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
348 "List of functions to be called for `find-file' on nonexistent file.
349 These functions are called as soon as the error is detected.
350 Variable `buffer-file-name' is already set up.
356 ;;;It is not useful to make this a local variable.
357 ;;;(put 'find-file-hooks 'permanent-local t)
359 "List of functions to be called after a buffer is loaded from a file.
360 The buffer's local variables (if any) will have been processed before the
361 functions are called."
370 "List of functions to be called before writing out a buffer to a file.
371 If one of them returns non-nil, the file is considered already written
372 and the rest are not called.
373 These hooks are considered to pertain to the visited file.
374 So any buffer-local binding of this variable is discarded if you change
376 change the major mode.
378 This hook is not run if any of the functions in
379 `write-contents-functions' returns non-nil. Both hooks pertain
380 to how to save a buffer to file, for instance, choosing a suitable
381 coding system and setting mode bits. (See Info
382 node `(elisp)Saving Buffers'.) To perform various checks or
394 "List of functions to be called before writing out a buffer to a file.
395 If one of them returns non-nil, the file is considered already written
396 and the rest are not called and neither are the functions in
397 `write-file-functions'.
399 This variable is meant to be used for hooks that pertain to the
400 buffer's contents, not to the particular visited file; thus,
401 `set-visited-file-name' does not clear this variable; but changing the
402 major mode does clear it.
404 For hooks that _do_ pertain to the particular visited file, use
405 `write-file-functions'. Both this variable and
406 `write-file-functions' relate to how a buffer is saved to file.
407 To perform various checks or updates before the buffer is saved,
414 "*Control use of local variables in files you visit.
415 The value can be t, nil or something else.
416 A value of t means file local variables specifications are obeyed;
417 nil means they are ignored; anything else means query.
418 This variable also controls use of major modes specified in
419 a -*- line.
422 always obeys file local variable specifications and the -*- line,
423 and ignores this variable."
430 "Like `enable-local-variables' but meant for buffer-local bindings.
431 The meaningful values are nil and non-nil. The default is non-nil.
432 If a major mode sets this to nil, buffer-locally, then any local
433 variables list in the file will be ignored.
435 This variable does not affect the use of major modes
440 The value can be t, nil or something else.
441 A value of t means obey `eval' variables;
442 nil means ignore them; anything else means query."
448 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
457 "*Non-nil means buffers visiting files read-only do so in view mode.
458 In fact, this means that all read-only buffers normally have
459 View mode enabled, including buffers that are read-only because
460 you visit a file you cannot alter, and buffers you make read-only
467 "Provides support for ange-ftp host name completion.
468 Runs the usual ange-ftp hook, but only for completion operations."
469 ;; Having this here avoids the need to load ange-ftp when it's not
470 ;; really in use.
476 inhibit-file-name-handlers)))
481 "Convert a standard file's name to something suitable for the current OS.
482 This means to guarantee valid names and perhaps to canonicalize
483 certain patterns.
485 This function's standard definition is trivial; it just returns
486 the argument. However, on Windows and DOS, replace invalid
487 characters. On DOS, make sure to obey the 8.3 limitations. On
488 Windows, turn Cygwin names into native names, and also turn
489 slashes into backslashes if the shell requires it (see
490 `w32-shell-dos-semantics')."
491 filename)
494 "Read directory name, prompting with PROMPT and completing in directory DIR.
495 Value is not expanded---you must call `expand-file-name' yourself.
496 Default name to DEFAULT-DIRNAME if user exits with the same
497 non-empty string that was inserted by this function.
498 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
499 except that if INITIAL is specified, that combined with DIR is used.)
500 If the user exits with an empty minibuffer, this function returns
501 an empty string. (This can only happen if the user erased the
502 pre-inserted contents or if `insert-default-directory' is nil.)
503 Fourth arg MUSTMATCH non-nil means require existing directory's name.
504 Non-nil and non-t means also require confirmation after completion.
505 Fifth arg INITIAL specifies text to start with.
506 DIR should be an absolute directory name. It defaults to
507 the value of `default-directory'."
516 \f
518 "Show the current default directory."
523 "Value of the CDPATH environment variable, as a list.
527 "Explode a search path into a list of directory names.
528 Directories are separated by occurrences of `path-separator'
529 \(which is colon in GNU and GNU-like systems)."
530 ;; We could use split-string here.
538 nil
543 cd-list)))
546 "Change current directory to given absolute file name DIR."
547 ;; Put the name into directory syntax now,
548 ;; because otherwise expand-file-name may give some bad results.
561 "Make DIR become the current buffer's default directory.
562 If your environment includes a `CDPATH' variable, try each one of
563 that list of directories (separated by occurrences of
564 `path-separator') when resolving a relative directory name.
565 The path separator is colon in GNU and GNU-like systems."
568 default-directory default-directory
584 cd-path)
585 nil))
589 "Load the Lisp file named FILE."
590 ;; This is a case where .elc makes a lot of sense.
597 "Search for FILENAME through PATH.
598 If SUFFIXES is non-nil, it should be a list of suffixes to append to
600 If non-nil, PREDICATE is used instead of `file-readable-p'.
601 PREDICATE can also be an integer to pass to the `access' system call,
602 in which case file-name handlers are ignored. This usage is deprecated.
604 For compatibility, PREDICATE can also be one of the symbols
605 `executable', `readable', `writable', or `exists', or a list of
606 one or more of those symbols."
617 "Do completion for file names passed to `locate-file'.
618 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
641 "Load the library named LIBRARY.
642 This is an interface to the function `load'."
645 'locate-file-completion
650 "Test whether FILE specifies a location on a remote system.
651 Return an identification of the system if the location is indeed
652 remote. The identification of the system may comprise a method
653 to access the system and its hostname, amongst other things.
660 nil)))
663 "Copy the file FILE into a temporary file on this machine.
664 Returns the name of the local copy, or nil, if FILE is directly
665 accessible."
666 ;; This formerly had an optional BUFFER argument that wasn't used by
667 ;; anything.
671 nil)))
674 "Return the truename of FILENAME, which should be absolute.
675 The truename of a file name is found by chasing symbolic links
676 both at the level of the file and at the level of the directories
677 containing it, until no links are left at any level.
680 ;; COUNTER and PREV-DIRS are only used in recursive calls.
681 ;; COUNTER can be a cons cell whose car is the count of how many
682 ;; more links to chase before getting an error.
683 ;; PREV-DIRS can be a cons cell whose car is an alist
684 ;; of truenames we've just recently computed.
698 ;; For speed, remove the ange-ftp completion handler from the list.
699 ;; We know it's not needed here.
700 ;; For even more speed, do this only on the outermost call.
707 ;; andrewi@harlequin.co.uk - none of the following code (except for
708 ;; invoking the file-name handler) currently applies on Windows
709 ;; (ie. there are no native symlinks), but there is an issue with
710 ;; case differences being ignored by the OS, and short "8.3 DOS"
711 ;; name aliases existing for all files. (The short names are not
712 ;; reported by directory-files, but can be used to refer to files.)
713 ;; It seems appropriate for file-truename to resolve these issues in
714 ;; the most natural way, which on Windows is to call the function
715 ;; `w32-long-file-name' - this returns the exact name of a file as
716 ;; it is stored on disk (expanding short name aliases with the full
717 ;; name in the process).
720 ;; For file name that has a special handler, call handler.
721 ;; This is so that ange-ftp can save time by doing a no-op.
724 ;; If filename contains a wildcard, newname will be the old name.
726 ;; If filename exists, use the long name
730 ;; If this file directly leads to a link, process that iteratively
731 ;; so that we don't use lots of stack.
737 ;; For file name that has a special handler, call handler.
738 ;; This is so that ange-ftp can save time by doing a no-op.
741 done t)
743 target dirfile)
744 ;; Get the truename of the directory.
746 ;; If these are equal, we have the (or a) root directory.
748 ;; If this is the same dir we last got the truename for,
749 ;; save time--don't recalculate.
759 done t)
762 done t)
763 ;; Put it back on the file name.
765 ;; Is the file name the name of a link?
768 ;; Yes => chase that link, then start all over
769 ;; since the link may point to a directory name that uses links.
770 ;; We can't safely use expand-file-name here
771 ;; since target might look like foo/../bar where foo
772 ;; is itself a link. Instead, we handle . and .. above.
775 target
777 done nil)
778 ;; No, we are done!
780 filename))
783 "Chase links in FILENAME until a name that is not a link.
784 Unlike `file-truename', this does not check whether a parent
785 directory name is a symbolic link.
786 If the optional argument LIMIT is a number,
787 it means chase no more than that many links and then stop."
795 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
798 ;; Handle `..' by hand, since it needs to work in the
799 ;; target of any directory symlink.
800 ;; This code is not quite complete; it does not handle
801 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
805 ;; Chase links in the default dir of the symlink.
809 ;; Now find the parent of that dir.
813 newname))
816 "Change the encoding of FILE's name from CODING to NEW-CODING.
817 The value is a new name of FILE.
818 Signals a `file-already-exists' error if a file of the new name
819 already exists unless optional third argument OK-IF-ALREADY-EXISTS
820 is non-nil. A number as third arg means request confirmation if
821 the new name already exists. This is what happens in interactive
822 use with M-x."
825 default-file-name-coding-system))
827 from-coding to-coding)
829 ;; We provide the default coding only when it seems that
830 ;; the filename is correctly decoded by the default
831 ;; coding.
837 filename default-coding)
838 default-coding))
842 ;; We provide the default coding only when a user is going to
843 ;; change the encoding not from the default coding.
847 filename from-coding)))
850 filename from-coding default-coding)
851 default-coding)))
855 default-file-name-coding-system))
856 ;; FILE should have been decoded by DEFAULT-CODING.
860 ;; Suppress further encoding.
865 newname))
866 \f
868 "Select buffer BUFFER in another window.
869 If BUFFER does not identify an existing buffer, then this function
870 creates a buffer with that name.
872 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
873 or nil. If BUFFER is nil, then this function chooses a buffer
874 using `other-buffer'.
875 Optional second arg NORECORD non-nil means
876 do not put this buffer at the front of the list of recently selected ones.
877 This function returns the buffer it switched to.
879 This uses the function `display-buffer' as a subroutine; see its
880 documentation for additional customization information."
883 ;; Don't let these interfere.
884 same-window-buffer-names same-window-regexps)
888 "Switch to buffer BUFFER in another frame.
889 Optional second arg NORECORD non-nil means
890 do not put this buffer at the front of the list of recently selected ones.
892 This uses the function `display-buffer' as a subroutine; see its
893 documentation for additional customization information."
896 same-window-buffer-names same-window-regexps)
910 ;; Clear out this hook so it does not interfere
911 ;; with any recursive minibuffer usage.
914 minibuffer-setup-hook))
917 t))
920 "Edit file FILENAME.
921 Switch to a buffer visiting file FILENAME,
922 creating one if none already exists.
923 Interactively, the default if you just type RET is the current directory,
924 but the visited file name is available through the minibuffer history:
925 type M-n to pull it into the minibuffer.
927 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
928 expand wildcards (if any) and visit multiple files. You can
929 suppress wildcard expansion by setting `find-file-wildcards'.
931 To visit a file without any kind of conversion and without
941 "Edit file FILENAME, in another window.
942 May create a new window, or reuse an existing one.
943 See the function `display-buffer'.
945 Interactively, the default if you just type RET is the current directory,
946 but the visited file name is available through the minibuffer history:
947 type M-n to pull it into the minibuffer.
949 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
950 expand wildcards (if any) and visit multiple files."
961 "Edit file FILENAME, in another frame.
962 May create a new frame, or reuse an existing one.
963 See the function `display-buffer'.
965 Interactively, the default if you just type RET is the current directory,
966 but the visited file name is available through the minibuffer history:
967 type M-n to pull it into the minibuffer.
969 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
970 expand wildcards (if any) and visit multiple files."
981 "Edit the existing file FILENAME.
989 "Edit file FILENAME but don't allow changes.
999 "Edit file FILENAME in another window but don't allow changes.
1009 "Edit file FILENAME in another frame but don't allow changes.
1019 "Find file FILENAME as a replacement for the file in the next window.
1020 This command does not select that window."
1039 "Find file FILENAME, select its buffer, kill previous buffer.
1040 If the current buffer now contains an empty file that you just visited
1041 \(presumably by mistake), use this command to visit the file you really want."
1071 ;; This prevents us from finding the same buffer
1072 ;; if we specified the same file again.
1076 ;; Likewise for dired buffers.
1080 ;; This executes if find-file gets an error
1081 ;; and does not really find anything.
1082 ;; We put things back as they were.
1083 ;; If find-file actually finds something, we kill obuf below.
1092 ;; We already asked; don't ask again.
1095 \f
1097 "Create a suitably named buffer for visiting FILENAME, and return it.
1098 FILENAME (sans directory) is used unchanged if that name is free;
1099 otherwise a string <2> or <3> or ... is appended to get an unused name."
1106 "Create and return a buffer with a name based on NAME.
1107 Choose the buffer's name using `generate-new-buffer-name'."
1111 "Regexp to match the automounter prefix in a directory name."
1119 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1121 removes automounter prefixes (see the variable `automount-dir-prefix')."
1122 ;; Get rid of the prefixes added by the automounter.
1129 ;; If any elt of directory-abbrev-alist matches this name,
1130 ;; abbreviate accordingly.
1136 ;; Compute and save the abbreviated homedir name.
1137 ;; We defer computing this until the first time it's needed, to
1138 ;; give time for directory-abbrev-alist to be set properly.
1139 ;; We include a slash at the end, to avoid spurious matches
1140 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1147 ;; If FILENAME starts with the abbreviated homedir,
1148 ;; make it start with `~' instead.
1150 ;; If the home dir is just /, don't change it.
1153 ;; MS-DOS root directories can come with a drive letter;
1154 ;; Novell Netware allows drive letters beyond `Z:'.
1164 filename))
1167 "*List of logical names for which visiting shouldn't save the true dirname.
1168 On VMS, when you visit a file using a logical name that searches a path,
1169 you may or may not want the visited file name to record the specific
1170 directory where the file was found. If you *do not* want that, add the logical
1171 name to this list as a string."
1176 "Return the buffer visiting file FILENAME (a string).
1177 This is like `get-file-buffer', except that it checks for any buffer
1178 visiting the same file, possibly under a different name.
1179 If PREDICATE is non-nil, only a buffer satisfying it can be returned.
1180 If there is no such live buffer, return nil."
1194 found)
1199 number
1204 ;; Verify this buffer's file number
1205 ;; still belongs to its file.
1208 attributes)
1212 found))))
1213 \f
1215 "*Non-nil means file-visiting commands should handle wildcards.
1216 For example, if you specify `*.c', that would visit all the files
1217 whose names match the pattern."
1223 "*Non-nil means suppress warning messages for symlinked files.
1224 When nil, Emacs prints a warning when visiting a file that is already
1225 visited, but with a different name. Setting this option to t
1226 suppresses this warning."
1232 "Maximum size of file above which a confirmation is requested.
1233 When nil, never request confirmation."
1240 "Read file FILENAME into a buffer and return the buffer.
1241 If a buffer exists visiting FILENAME, return that one, but
1242 verify that the file has not changed since visited or saved.
1243 The buffer is not selected, just returned to the caller.
1244 Optional first arg NOWARN non-nil means suppress any warning messages.
1245 Optional second arg RAWFILE non-nil means the file is read literally.
1246 Optional third arg WILDCARDS non-nil means do wildcard processing
1247 and visit all the matching files. When wildcards are actually
1248 used and expanded, the value is a list of buffers
1249 that are visiting the various files."
1256 'find-directory-functions
1259 filename)))
1262 find-file-wildcards
1276 ;; Find any buffer for a file which has same truename.
1278 ;; Let user know if there is a buffer with the same truename.
1282 find-file-suppress-same-file-warnings
1286 ;; Optionally also find that buffer.
1289 ;; Check to see if the file looks uncommonly large.
1291 ;; Don't ask again if we already have the file or
1292 ;; if we're asked to be quiet.
1301 ;; We are using an existing buffer.
1307 ;; Certain files should be reverted automatically
1308 ;; if they have changed on disk and not in the buffer.
1316 found))
1326 "File %s changed on disk. Discard your edits? "
1331 "File %s changed on disk. Discard your edits in %s? "
1339 ;; Check if a formerly read-only file has become
1340 ;; writable and vice versa, but if the buffer agrees
1341 ;; with the new state of the file, that is ok too.
1348 buffer-file-name
1356 ;; It is confusing to ask whether to visit
1357 ;; non-literally if they have the file in
1358 ;; hexl-mode.
1362 "Save file and revisit literally? "
1367 rawfile truename number))
1369 "Discard your edits and revisit file literally? "
1372 rawfile truename number)
1376 "Revisit file literally? "
1379 rawfile truename number)
1382 ;; Return the buffer we are using.
1383 buf)
1384 ;; Create a new buffer.
1387 ;; find-file-noselect-1 may use a different buffer.
1389 rawfile truename number))))))
1395 ;; Needed in case we are re-visiting the file with a different
1396 ;; text representation.
1413 filename)))
1414 ;; Unconditionally set error
1424 filename)))
1425 ;; Run find-file-not-found-hooks until one returns non-nil.
1427 ;; If they fail too, set error.
1429 ;; Record the file's truename, and maybe use that as visited name.
1435 ;; On VMS, we may want to remember which directory in a search list
1436 ;; the file was found in.
1448 ;; Set buffer's default directory to that of the file.
1450 ;; Turn off backup files for certain file names. Since
1451 ;; this is a permanent local, the major mode won't eliminate it.
1464 \f
1466 "Like `insert-file-contents', but only reads in the file literally.
1467 A buffer may be modified in several ways after reading into the buffer,
1468 to Emacs features such as format decoding, character code
1469 conversion, `find-file-hook', automatic uncompression, etc.
1471 This function ensures that none of these modifications will take place."
1479 nil))
1482 inhibit-file-name-handlers))
1495 filename)))
1505 "Insert contents of file FILENAME into buffer after point with no conversion.
1507 This function is meant for the user to run interactively.
1508 Don't call it from programs! Use `insert-file-contents-literally' instead.
1509 \(Its calling sequence is different; see its documentation)."
1514 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1519 "Visit file FILENAME with no conversion of any kind.
1520 Format conversion and character code conversion are both disabled,
1521 and multibyte characters are disabled in the resulting buffer.
1522 The major mode used is Fundamental mode regardless of the file name,
1523 and local variable specifications in the file are ignored.
1524 Automatic uncompression and adding a newline at the end of the
1525 file due to `require-final-newline' is also disabled.
1527 You cannot absolutely rely on this function to result in
1528 visiting the file literally. If Emacs already has a buffer
1529 which is visiting the file, you get the existing buffer,
1530 regardless of whether it was created literally or not.
1532 In a Lisp program, if you want to be sure of accessing a file's
1533 contents literally, you should create a temporary buffer and then read
1534 the file contents into it using `insert-file-contents-literally'."
1537 \f
1541 after-find-file-from-revert-buffer
1542 nomodes)
1543 "Called after finding a file and by the default revert function.
1544 Sets buffer mode, parses local variables.
1545 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1546 error in reading the file. WARN non-nil means warn if there
1547 exists an auto-save file more recent than the visited file.
1548 NOAUTO means don't mess with auto-save mode.
1549 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1550 means this call was from `revert-buffer'.
1551 Fifth arg NOMODES non-nil means don't alter the file's modes.
1552 Finishes by calling the functions in `find-file-hook'
1553 unless NOMODES is non-nil."
1556 nil
1566 ;; No need to warn if buffer is auto-saved
1567 ;; under the name of the visited file.
1569 auto-save-visited-file-name))
1572 buffer-file-name))
1592 ;; Make people do a little extra work (C-x C-q)
1593 ;; before altering a backup file.
1596 ;; When a file is marked read-only,
1597 ;; make the buffer read-only even if root is looking at it.
1606 view-read-only
1612 "Eval BODY and turn any error into a FORMAT message.
1613 FORMAT can have a %s escape which will be replaced with the actual error.
1614 If `debug-on-error' is set, errors are not caught, so that you can
1615 debug them.
1616 Avoid using a large BODY since it is duplicated."
1625 "Choose the major mode for this buffer automatically.
1626 Also sets up any specified local variables of the file.
1627 Uses the visited file name, the -*- line, and the local variables spec.
1629 This function is called automatically from `find-file'. In that case,
1630 we may set up the file-specified mode and local variables,
1631 depending on the value of `enable-local-variables': if it is t, we do;
1632 if it is nil, we don't; otherwise, we query.
1633 In addition, if `local-enable-local-variables' is nil, we do
1634 not set local variables (though we do notice a mode specified with -*-.)
1636 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1637 or from Lisp without specifying the optional argument FIND-FILE;
1638 in that case, this function acts as if `enable-local-variables' were t."
1650 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1651 ;; c++-mode, java-mode and more) are added through autoload
1652 ;; directives in that file. That way is discouraged since it
1653 ;; spreads out the definition of the initial value.
1678 ;; Less common extensions come here
1679 ;; so more common ones above are found faster.
1721 ;; Mailer puts message to be edited in
1722 ;; /tmp/Re.... or Message
1727 ;; some news reader is reported to use this
1736 ;; .emacs or .gnus or .viper following a directory delimiter in
1737 ;; Unix, MSDOG or VMS syntax.
1740 ;; _emacs following a directory delimiter
1741 ;; in MsDos syntax
1754 ;; Get rid of any trailing .n.m and try again.
1755 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1756 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1757 ;; Using mode nil rather than `ignore' would let the search continue
1758 ;; through this list (with the shortened name) rather than start over.
1760 ;; The following should come after the ChangeLog pattern
1761 ;; for the sake of ChangeLog.1, etc.
1762 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1769 "Alist of filename patterns vs corresponding major mode functions.
1770 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1771 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1772 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1773 mode function to use. FUNCTION will be called, unless it is nil.
1775 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1776 calling FUNCTION (if it's not nil), we delete the suffix that matched
1781 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1782 ;; and pike-mode) are added through autoload directives in that
1783 ;; file. That way is discouraged since it spreads out the
1784 ;; definition of the initial value.
1822 "Alist mapping interpreter names to major modes.
1823 This alist applies to files whose first line starts with `#!'.
1824 Each element looks like (INTERPRETER . MODE).
1825 The car of each element is compared with
1826 the name of the interpreter specified in the first line.
1833 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1834 When checking `inhibit-first-line-modes-regexps', we first discard
1840 "Regular expression matching interpreters, for file mode determination.
1841 This regular expression is matched against the first line of a file
1842 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1843 a mode from the file's name. If it matches, the file is assumed to
1844 be interpreted by the interpreter matched by the second group of the
1845 regular expression. The mode is then determined as the mode associated
1850 ;; Is there a nicer way of getting . including \n?
1851 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
1852 ("\\(?:<\\?xml\\s +[^>]*>\\)?\\s *<\\(?:!--\\(?:.\\|\n\\)*?-->\\s *<\\)*\\(?:!DOCTYPE\\s +[^>]*>\\s *<\\)?\\s *\\(?:!--\\(?:.\\|\n\\)*?-->\\s *<\\)*[Hh][Tt][Mm][Ll]" . html-mode)
1853 ;; These two must come after html, because they are more general:
1857 "Alist of buffer beginnings vs corresponding major mode functions.
1858 Each element looks like (REGEXP . FUNCTION). FUNCTION will be
1862 "Select major mode appropriate for current buffer.
1864 This checks for a -*- mode tag in the buffer's text, checks the
1865 interpreter that runs this file against `interpreter-mode-alist',
1866 compares the buffer beginning against `magic-mode-alist',
1867 or compares the filename against the entries in
1868 `auto-mode-alist'.
1870 It does not check for the `mode:' local variable in the
1871 Local Variables section of the file; for that, use `hack-local-variables'.
1873 If `enable-local-variables' is nil, this function does not check for a
1874 -*- mode tag.
1876 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
1877 only set the major mode, if that would change it."
1878 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1880 ;; Find a -*- mode tag
1884 ;; While we're at this point, check xml for later.
1889 ;; Find all specifications for the `mode:' variable
1890 ;; and execute them left to right.
1902 modes)))
1903 ;; Simple -*-MODE-*- case.
1906 modes))))
1907 ;; If we found modes to use, invoke them now, outside the save-excursion.
1916 ;; If we didn't, look for an interpreter specified in the first line.
1917 ;; As a special case, allow for things like "#!/bin/env perl", which
1918 ;; finds the interpreter anywhere in $PATH.
1924 ;; Map interpreter name to a mode, signalling we're done at the
1925 ;; same time.
1927 interpreter-mode-alist)))
1928 ;; If we found an interpreter mode to use, invoke it now.
1939 ;; Remove backup-suffixes from file name.
1942 ;; Find first matching alist entry.
1956 ;; When `keep-mode-if-same' is set, we are working on behalf of
1957 ;; set-visited-file-name. In that case, if the major mode specified is the
1958 ;; same one we already have, don't actually reset it. We don't want to lose
1959 ;; minor modes such as Font Lock.
1961 "Apply MODE and return it.
1962 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
1963 any aliases and compared to current major mode. If they are the
1964 same, do nothing and return nil."
1972 mode))
1976 "Find the -*- spec in the buffer.
1977 Call with point at the place to start searching from.
1978 If one is found, set point to the beginning
1979 and return the position of the end.
1980 Otherwise, return nil; point may be changed."
1983 ;; Don't look for -*- if this file name matches any
1984 ;; of the regexps in inhibit-first-line-modes-regexps.
1992 sufs)
2000 ;; If the file begins with "#!"
2001 ;; (exec interpreter magic), look
2002 ;; for mode frobs in the first two
2003 ;; lines. You cannot necessarily
2004 ;; put them in the first line of
2005 ;; such a file without screwing up
2006 ;; the interpreter invocation.
2014 t))
2020 end))))
2023 "Set local variables specified in the -*- line.
2024 Ignore any specification for `mode:' and `coding:';
2025 `set-auto-mode' should already have handled `mode:',
2026 `set-auto-coding' should already have handled `coding:'.
2027 If MODE-ONLY is non-nil, all we do is check whether the major mode
2028 is specified, returning t if it is specified."
2033 mode-specified
2036 ;; Parse the -*- line into the RESULT alist.
2037 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2039 nil)
2041 ;; Simple form: "-*- MODENAME -*-". Already handled.
2043 nil)
2045 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2046 ;; (last ";" is optional).
2051 ;; There used to be a downcase here,
2052 ;; but the manual didn't say so,
2053 ;; and people want to set var names that aren't all lc.
2060 ;; It is traditional to ignore
2061 ;; case when checking for `mode' in set-auto-mode,
2062 ;; so we must do that here as well.
2063 ;; That is inconsistent, but we're stuck with it.
2064 ;; The same can be said for `coding' in set-auto-coding.
2082 ;; If we fail to switch in the selected window,
2083 ;; it is probably a minibuffer.
2084 ;; So try another window.
2095 nil))))
2098 "Normal hook run after processing a file's local variables specs.
2099 Major modes can use this to examine user-specified local variables
2103 "Parse and put into effect this buffer's local variables spec.
2104 If MODE-ONLY is non-nil, all we do is check whether the major mode
2105 is specified, returning t if it is specified."
2107 ;; If MODE-ONLY is t, we check here for specifying the mode
2108 ;; in the -*- line. If MODE-ONLY is nil, we process
2109 ;; the -*- line here.
2113 ;; Look for "Local variables:" line in last page.
2120 mode-only
2130 buffer-file-name)
2135 ;; The prefix is what comes before "local variables:" in its line.
2136 ;; The suffix is what comes after "local variables:" in its line.
2152 endpos
2159 nil t))
2170 ;; Discard the prefix, if any.
2176 ;; Discard the suffix, if any.
2185 ;; Find the variable name; strip whitespace.
2193 val)
2194 ;; Read the variable value.
2201 ;; Set the variable. "Variables" mode and eval are funny.
2207 mode-specified))
2212 ;; Get confirmation before setting these variables as locals in a file.
2237 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2267 ;; This case is safe because the user gets to check it before it is used.
2271 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2272 If VAL is nil or omitted, the question is whether any value might be
2273 dangerous."
2276 (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$"
2279 ;; If the safe-local-variable property isn't t or nil,
2280 ;; then it must return non-nil on the proposed value to be safe.
2287 Add expressions to this list if you want Emacs to evaluate them, when
2288 they appear in an `eval' local variable specification, without first
2289 asking you for confirmation."
2306 "Return t if it is safe to eval EXP when it is found in a file."
2308 ;; Detect certain `put' expressions.
2314 ;; Only allow safe values of lisp-indent-hook;
2315 ;; not functions.
2318 ;; Allow expressions that the user requested.
2320 ;; Certain functions can be allowed with safe arguments
2321 ;; or can specify verification functions to try.
2329 ok))
2337 ok)))))))
2341 A few patterns are specified so that any name which matches one
2342 is considered risky."
2347 ;; We have already handled coding: tag in set-auto-coding.
2348 nil)
2350 nil)
2351 ;; "Setting" eval means either eval it or do nothing.
2352 ;; Likewise for setting hook variables.
2354 ;; Permit evalling a put of a harmless property.
2355 ;; if the args do nothing tricky.
2358 ;; Permit eval if not root and user says ok.
2377 ;; Ordinary variable, really set it.
2379 ;; Make sure the string has no text properties.
2380 ;; Some text properties can get evaluated in various ways,
2381 ;; so it is risky to put them on with a local variable list.
2386 \f
2389 However, the mode will not be changed if
2390 \(1) a local variables list or the `-*-' line specifies a major mode, or
2392 \ not suitable for ordinary files, or
2393 \(3) the new file name does not particularly specify any mode."
2398 "Change name of file visited in current buffer to FILENAME.
2399 The next time the buffer is saved it will go in the newly specified file.
2400 FILENAME nil or an empty string means make buffer not be visiting any file.
2401 Remember to delete the initial contents of the minibuffer
2402 if you wish to pass an empty string as the argument.
2404 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2405 confirmation in the case where another buffer is already visiting FILENAME.
2407 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2408 the old visited file has been renamed to the new name FILENAME."
2416 nil
2427 filename)))
2441 ;; If new-name == old-name, renaming would add a spurious <2>
2442 ;; and it's considered as a feature in rename-buffer.
2448 ;; Abbreviate the file names of the buffer.
2457 nil)))
2458 ;; write-file-functions is normally used for things like ftp-find-file
2459 ;; that visit things that are not local files as if they were files.
2460 ;; Changing to visit an ordinary local file instead should flush the hook.
2465 ;; If buffer was read-only because of version control,
2466 ;; that reason is gone now, so make it writable.
2470 ;; Turn off backup files for certain file names.
2471 ;; Since this is a permanent local, the major mode won't eliminate it.
2478 ;; If auto-save was not already on, turn it on if appropriate.
2482 ;; If auto save is on, start using a new name.
2483 ;; We deliberately don't rename or delete the old auto save
2484 ;; for the old visited file name. This is because perhaps
2485 ;; the user wants to save the new state and then compare with the
2486 ;; previous state from the auto save file.
2489 ;; Rename the old auto save file if any.
2496 ;; Update the major mode, if the file name determines it.
2498 ;; Don't change the mode if it is special.
2501 ;; Don't change the mode if the local variable list specifies it.
2507 "Write current buffer into file FILENAME.
2508 This makes the buffer visit that file, and marks it as not modified.
2510 If you specify just a directory name as FILENAME, that means to use
2511 the default file name but in that directory. You can also yank
2512 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2514 If the buffer is not already visiting a file, the default file name
2515 for the output file is the buffer name.
2517 If optional second arg CONFIRM is non-nil, this function
2518 asks for confirmation before overwriting an existing file.
2519 Interactively, confirmation is required unless you supply a prefix argument."
2520 ;; (interactive "FWrite file: ")
2524 nil nil nil nil)
2528 default-directory)
2529 nil nil))
2533 ;; If arg is just a directory,
2534 ;; use the default file name, but in that directory.
2545 ;; Make buffer writable if file is writable.
2550 \f
2552 "Make a backup of the disk file visited by the current buffer, if appropriate.
2553 This is normally done before saving the buffer the first time.
2555 A backup may be done by renaming or by copying; see documentation of
2556 variable `make-backup-files'. If it's done by renaming, then the file is
2557 no longer accessible under its old name.
2559 The value is non-nil after a backup was made by renaming.
2560 It has the form (MODES . BACKUPNAME).
2561 MODES is the result of `file-modes' on the original
2562 file; this means that the caller, after saving the buffer, should change
2563 the modes of the new file to agree with the old modes.
2564 BACKUPNAME is the backup file name, which is the old file renamed."
2571 backup-info backupname targets setmodes)
2572 ;; If specified name is a symbolic link, chase it to the target.
2573 ;; Thus we make the backups in the directory where the real file is.
2578 ;; (if (file-directory-p buffer-file-name)
2579 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2583 ;; If have old versions to maybe delete,
2584 ;; ask the user to confirm now, before doing anything.
2585 ;; But don't actually delete til later.
2590 real-file-name)))))
2592 ;; Actually write the back up file.
2595 ; (file-symlink-p buffer-file-name)
2596 backup-by-copying
2597 ;; Don't rename a suid or sgid file.
2611 ;; rename-file should delete old backup.
2615 ;; If trouble writing the backup, write it in ~.
2624 ;; Now delete the old versions, if desired.
2631 setmodes)
2638 ;; If copying fails because file TO-NAME
2639 ;; is not writable, delete that file and try again.
2648 "Return file NAME sans backup versions or strings.
2649 This is a separate procedure so your site-init or startup file can
2650 redefine it.
2651 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2652 we do not remove backup version numbers, only true file version numbers."
2658 ;; VMS version number is (a) semicolon, optional
2659 ;; sign, zero or more digits or (b) period, option
2660 ;; sign, zero or more digits, provided this is the
2661 ;; second period encountered outside of the
2662 ;; device/directory part of the file name.
2665 name)
2675 "Return t if deleting FILE and rewriting it would preserve the owner."
2680 ;; Return t if the file doesn't exist, since it's true that no
2681 ;; information would be lost by an (attempted) delete and create.
2687 The extension, in a file name, is the part that follows the last `.',
2688 except that a leading `.', if any, doesn't count."
2691 directory)
2695 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2696 ;; we don't want to expand it.
2699 filename))))
2703 The extension, in a file name, is the part that follows the last `.',
2704 except that a leading `.', if any, doesn't count.
2705 Return nil for extensionless file names such as `foo'.
2706 Return the empty string for file names such as `foo.'.
2708 If PERIOD is non-nil, then the returned value includes the period
2709 that delimits the extension, and if FILENAME has no extension,
2720 "A function to use instead of the default `make-backup-file-name'.
2721 A value of nil gives the default `make-backup-file-name' behaviour.
2723 This could be buffer-local to do something special for specific
2724 files. If you define it, you may need to change `backup-file-name-p'
2725 and `file-name-sans-versions' too.
2727 See also `backup-directory-alist'."
2733 "Alist of filename patterns and backup directory names.
2734 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2735 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2736 relative or absolute. If it is absolute, so that all matching files
2737 are backed up into the same directory, the file names in this
2738 directory will be the full name of the file backed up with all
2739 directory separators changed to `!' to prevent clashes. This will not
2740 work correctly if your filesystem truncates the resulting name.
2742 For the common case of all backups going into one directory, the alist
2744 directory name.
2746 If this variable is nil, or it fails to match a filename, the backup
2747 is made in the original file's directory.
2749 On MS-DOS filesystems without long names this variable is always
2750 ignored."
2756 "Default `backup-enable-predicate' function.
2757 Checks for files in `temporary-file-directory' or
2758 `small-temporary-file-directory'."
2761 ;; Directory is under temporary-file-directory.
2766 0 nil
2768 ;; Directory is under small-temporary-file-directory.
2773 "Create the non-numeric backup file name for FILE.
2774 Normally this will just be the file's name with `~' appended.
2775 Customization hooks are provided as follows.
2777 If the variable `make-backup-file-name-function' is non-nil, its value
2778 should be a function which will be called with FILE as its argument;
2779 the resulting name is used.
2781 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2782 the documentation of that variable. If the directory for the backup
2783 doesn't exist, it is created."
2797 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2799 elt backup-directory)
2804 alist nil)))
2810 file
2814 ;; Normalize DOSish file names: downcase the drive
2815 ;; letter, if any, and replace the leading "x:" with
2816 ;; "/drive_x".
2819 ;; Replace any invalid file-name characters (for the
2820 ;; case of backing up remote files).
2824 "drive_"
2827 ""
2830 ;; Make the name unique by substituting directory
2831 ;; separators. It may not really be worth bothering about
2832 ;; doubling `!'s in the original name...
2837 backup-directory))
2844 "Return non-nil if FILE is a backup file name (numeric or not).
2845 This is a separate function so you can redefine it for customization.
2846 You may need to redefine `file-name-sans-versions' as well."
2851 ;; This is used in various files.
2852 ;; The usage of backup-extract-version-start is not very clean,
2853 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2855 "Given the name of a numeric backup file, FN, return the backup number.
2856 Uses the free variable `backup-extract-version-start', whose value should be
2857 the index in the name where the version number begins."
2863 ;; I believe there is no need to alter this behavior for VMS;
2864 ;; since backup files are not made on VMS, it should not get called.
2866 "Find a file name for a backup file FN, and suggestions for deletions.
2867 Value is a list whose car is the name for the backup file
2868 and whose cdr is a list of old versions to consider deleting now.
2869 If the value is nil, don't make a backup.
2870 Uses `backup-directory-alist' in the same way as does
2871 `make-backup-file-name'."
2873 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2877 ;; We don't support numbered backups on plain MS-DOS
2878 ;; when long file names are unavailable.
2888 possibilities deserve-versions-p versions)
2891 base-versions
2894 possibilities)
2895 #'<)
2900 kept-old-versions
2901 kept-new-versions
2908 ;; Delete nothing if there is overflow
2909 ;; in the number of versions to keep.
2915 v))))))))))
2918 "Return number of names file FILENAME has."
2921 ;; (defun file-relative-name (filename &optional directory)
2922 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2923 ;; This function returns a relative file name which is equivalent to FILENAME
2924 ;; when used with that default directory as the default.
2925 ;; If this is impossible (which can happen on MSDOS and Windows
2926 ;; when the file name and directory use different drive names)
2927 ;; then it returns FILENAME."
2928 ;; (save-match-data
2929 ;; (let ((fname (expand-file-name filename)))
2930 ;; (setq directory (file-name-as-directory
2931 ;; (expand-file-name (or directory default-directory))))
2932 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2933 ;; ;; drive names, they can't be relative, so return the absolute name.
2934 ;; (if (and (or (eq system-type 'ms-dos)
2935 ;; (eq system-type 'cygwin)
2936 ;; (eq system-type 'windows-nt))
2937 ;; (not (string-equal (substring fname 0 2)
2938 ;; (substring directory 0 2))))
2939 ;; filename
2940 ;; (let ((ancestor ".")
2941 ;; (fname-dir (file-name-as-directory fname)))
2942 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2943 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
2944 ;; (setq directory (file-name-directory (substring directory 0 -1))
2945 ;; ancestor (if (equal ancestor ".")
2946 ;; ".."
2947 ;; (concat "../" ancestor))))
2948 ;; ;; Now ancestor is empty, or .., or ../.., etc.
2949 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
2950 ;; ;; We matched within FNAME's directory part.
2951 ;; ;; Add the rest of FNAME onto ANCESTOR.
2952 ;; (let ((rest (substring fname (match-end 0))))
2953 ;; (if (and (equal ancestor ".")
2954 ;; (not (equal rest "")))
2955 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
2956 ;; rest
2957 ;; (concat (file-name-as-directory ancestor) rest)))
2958 ;; ;; We matched FNAME's directory equivalent.
2959 ;; ancestor))))))
2962 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2963 This function returns a relative file name which is equivalent to FILENAME
2964 when used with that default directory as the default.
2965 If FILENAME and DIRECTORY lie on different machines or on different drives
2966 on a DOS/Windows machine, it returns FILENAME on expanded form."
2970 default-directory))))
2976 ;; Test for different drives on DOS/Windows
2978 ;; Should `cygwin' really be included here? --stef
2981 ;; Test for different remote file system identification
2983 filename
2989 directory nil nil case-fold-search))
2991 directory nil nil case-fold-search))))
2994 ".."
2996 ;; Now ancestor is empty, or .., or ../.., etc.
2998 directory nil nil case-fold-search))
2999 ;; We matched within FILENAME's directory part.
3000 ;; Add the rest of FILENAME onto ANCESTOR.
3003 ;; But don't bother with ANCESTOR if it would give us `./'.
3004 rest
3006 ;; We matched FILENAME's directory equivalent.
3007 ancestor))))))
3008 \f
3010 "Save current buffer in visited file if modified. Versions described below.
3011 By default, makes the previous version into a backup file
3012 if previously requested or if this is the first save.
3014 to become a backup when the next save is done.
3016 unconditionally makes the previous version into a backup file.
3018 to become a backup when the next save is done,
3019 and unconditionally makes the previous version into a backup file.
3021 With argument of 0, never make the previous version into a backup file.
3023 If a file's name is FOO, the names of its numbered backup versions are
3024 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3025 Numeric backups (rather than FOO~) will be made if value of
3026 `version-control' is not the atom `never' and either there are already
3027 numeric versions of the file being backed up, or `version-control' is
3028 non-nil.
3029 We don't want excessive versions piling up, so there are variables
3030 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3031 and `kept-new-versions', which tells how many newest versions to keep.
3032 Defaults are 2 old versions and 2 new.
3033 `dired-kept-versions' controls dired's clean-directory (.) command.
3034 If `delete-old-versions' is nil, system will query user
3035 before trimming versions. Otherwise it does it silently.
3037 If `vc-make-backup-files' is nil, which is the default,
3038 no backup files are made for files managed by version control.
3039 (This is because the version control system itself records previous versions.)
3041 See the subroutine `basic-save-buffer' for more information."
3054 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3055 Normally delete only if the file was written by this Emacs since
3056 the last real save, but optional arg FORCE non-nil means delete anyway."
3070 "Normal hook that is run before a buffer is saved to its file."
3076 "Normal hook that is run after a buffer is saved to its file."
3082 "If non-nil, use this coding system for saving the buffer.
3083 More precisely, use this coding system in place of the
3084 value of `buffer-file-coding-system', when saving the buffer.
3085 Calling `write-region' for any purpose other than saving the buffer
3086 will still use `buffer-file-coding-system'; this variable has no effect
3093 "Save the current buffer in its visited file, if it has been modified.
3094 The hooks `write-contents-functions' and `write-file-functions' get a chance
3095 to do the job of saving; if they do not, then the buffer is saved in
3096 the visited file file in the usual way.
3097 Before and after saving the buffer, this function runs
3098 `before-save-hook' and `after-save-hook', respectively."
3101 ;; In an indirect buffer, save its base buffer instead.
3106 setmodes)
3107 ;; On VMS, rename file and buffer to get rid of version number.
3112 ;; Strip VMS version number before save.
3115 ;; Construct a (unique) buffer name to correspond.
3120 ;; If buffer has no file name, ask user for one.
3127 filename))
3152 ;; Support VC version backups.
3158 ;; If a hook returned t, file is already "written".
3159 ;; Otherwise, write it the usual way now.
3161 ;; Now we have saved the current buffer. Let's make sure
3162 ;; that buffer-file-coding-system is fixed to what
3163 ;; actually used for saving by binding it locally.
3173 ;; If the auto-save file was recent before this command,
3174 ;; delete it now.
3176 ;; Support VC `implicit' locking.
3181 ;; This does the "real job" of writing a buffer into its visited file
3182 ;; and making a backup file. This is what is normally done
3183 ;; but inhibited if one of write-file-functions returns non-nil.
3184 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3191 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3205 buffer-file-name)))
3213 ;; If file is precious, write temp name, then rename it.
3214 ;; This requires write access to the containing dir,
3215 ;; which is why we don't try it if we don't have that access.
3217 tempname nogood i succeed
3221 ;; Find the temporary name to write under.
3228 "%s$tmp$%d"
3230 dir i))
3236 tempname nil realname
3237 buffer-file-truename)
3239 ;; If writing the temp file fails,
3240 ;; delete the temp file.
3247 ;; Since we have created an entirely new file
3248 ;; and renamed it, make sure it gets the
3249 ;; right permission bits set.
3251 buffer-file-name)))
3252 ;; We succeeded in writing the temp file,
3253 ;; so rename it.
3255 ;; If file not writable, see if we can make it writable
3256 ;; temporarily while we write it.
3257 ;; But no need to do so if we have just backed it up
3258 ;; (setmodes is set) because that says we're superseding.
3260 ;; Change the mode back, after writing.
3267 buffer-file-name nil t buffer-file-truename)
3269 ;; If we get an error writing the new file, and we made
3270 ;; the backup by renaming, undo the backing-up.
3273 setmodes))
3276 "View the differences between BUFFER and its associated file.
3277 This requires the external program `diff' to be in your `exec-path'."
3292 ;; Display that message for 1 second so that user can read it
3293 ;; in the minibuffer.
3295 ;; return always nil, so that save-buffers-kill-emacs will not move
3296 ;; over to the next unsaved buffer when calling `d'.
3297 nil)
3300 '((?\C-r
3306 ;; Return nil to ask about BUF again.
3307 nil)
3309 (?d diff-buffer-with-file
3315 "Save some modified file-visiting buffers. Asks user about each one.
3316 You can answer `y' to save, `n' not to save, `C-r' to look at the
3317 buffer in question with `view-buffer' before deciding or `d' to
3318 view the differences using `diff-buffer-to-file'.
3320 Optional argument (the prefix) non-nil means save all with no questions.
3321 Optional second argument PRED determines which buffers are considered:
3322 If PRED is nil, all the file-visiting buffers are considered.
3323 If PRED is t, then certain non-file buffers will also be considered.
3324 If PRED is a zero-argument function, it indicates for each buffer whether
3325 to consider it or not when called with that buffer current.
3327 See `save-some-buffers-action-alist' if you want to
3328 change the additional actions you can take on files."
3347 t
3360 save-some-buffers-action-alist))
3367 abbrev-file-name)))
3369 ;; Don't keep bothering user if he says no.
3371 t))))
3374 \f
3376 "Mark current buffer as unmodified, not needing to be saved.
3379 It is not a good idea to use this function in Lisp programs, because it
3380 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3387 "Change whether this buffer is visiting its file read-only.
3388 With arg, set read-only iff arg is positive.
3389 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3394 nil ; do nothing.
3395 ;; Toggle.
3402 ;; If view-mode is already active, `view-mode-enter' is a nop.
3414 "Insert contents of file FILENAME into buffer after point.
3415 Set mark after the inserted text.
3417 This function is meant for the user to run interactively.
3418 Don't call it from programs! Use `insert-file-contents' instead.
3419 \(Its calling sequence is different; see its documentation)."
3424 "Append the contents of the region to the end of file FILENAME.
3425 When called from a function, expects three arguments,
3426 START, END and FILENAME. START and END are buffer positions
3427 saying what text to write."
3432 "Return most recent backup file for FILENAME or nil if no backups exist."
3433 ;; `make-backup-file-name' will get us the right directory for
3434 ;; ordinary or numeric backups. It might create a directory for
3435 ;; backups as a side-effect, according to `backup-directory-alist'.
3442 tem)
3451 newest))
3454 "Rename current buffer to a similar name not already taken.
3455 This function is useful for creating multiple shell process buffers
3456 or multiple mail buffers, etc."
3464 ;; If the existing buffer name has a <NNN>,
3465 ;; which isn't part of the file name (if any),
3466 ;; then get rid of that.
3472 "Create the directory DIR and any nonexistent parent dirs.
3473 Interactively, the default choice of directory to create
3474 is the current default directory for file names.
3475 That is useful when you have visited a file in a nonexistent directory.
3477 Noninteractively, the second (optional) argument PARENTS says whether
3478 to create parent directories if they don't exist. Interactively,
3479 this happens by default."
3482 nil nil)
3483 t))
3484 ;; If default-directory is a remote directory,
3485 ;; make sure we find its make-directory handler.
3493 create-list)
3500 \f
3503 "Function to use to revert this buffer, or nil to do the default.
3504 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3509 "Function to use to insert contents when reverting this buffer.
3510 Gets two args, first the nominal file name to use,
3511 and second, t if reading the auto-save file.
3516 "Function to check whether a non-file buffer needs reverting.
3517 This should be a function with one optional argument NOCONFIRM.
3518 Auto Revert Mode sets NOCONFIRM to t. The function should return
3519 non-nil if the buffer should be reverted. A return value of
3520 `fast' means that the need for reverting was not checked, but
3521 that reverting the buffer is fast. The buffer is current when
3522 this function is called.
3524 The idea behind the NOCONFIRM argument is that it should be
3525 non-nil if the buffer is going to be reverted without asking the
3526 user. In such situations, one has to be careful with potentially
3527 time consuming operations.
3529 For more information on how this variable is used by Auto Revert mode,
3533 "Normal hook for `revert-buffer' to run before reverting.
3534 If `revert-buffer-function' is used to override the normal revert
3538 "Normal hook for `revert-buffer' to run after reverting.
3539 Note that the hook value that it runs is the value that was in effect
3540 before reverting; that makes a difference if you have buffer-local
3541 hook functions.
3543 If `revert-buffer-function' is used to override the normal revert
3549 "Replace current buffer text with the text of the visited file on disk.
3550 This undoes all changes since the file was visited or saved.
3551 With a prefix argument, offer to revert from latest auto-save file, if
3552 that is more recent than the visited file.
3554 This command also works for special buffers that contain text which
3555 doesn't come from a file, but reflects some other data base instead:
3556 for example, Dired buffers and `buffer-list' buffers. In these cases,
3557 it reconstructs the buffer contents from the appropriate data base.
3559 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3560 to revert from the auto-save file when this is nil. Note that the
3561 sense of this argument is the reverse of the prefix argument, for the
3562 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3563 to nil.
3565 Optional second argument NOCONFIRM means don't ask for confirmation at
3566 all. (The local variable `revert-without-query', if non-nil, prevents
3567 confirmation.)
3569 Optional third argument PRESERVE-MODES non-nil means don't alter
3570 the files modes. Normally we reinitialize them using `normal-mode'.
3572 If the value of `revert-buffer-function' is non-nil, it is called to
3573 do all the work for this command. Otherwise, the hooks
3574 `before-revert-hook' and `after-revert-hook' are run at the beginning
3575 and the end, and if `revert-buffer-insert-file-contents-function' is
3576 non-nil, it is called instead of rereading visited file contents."
3578 ;; I admit it's odd to reverse the sense of the prefix argument, but
3579 ;; there is a lot of code out there which assumes that the first
3580 ;; argument should be t to avoid consulting the auto-save file, and
3581 ;; there's no straightforward way to encourage authors to notice a
3582 ;; reversal of the argument sense. So I'm just changing the user
3583 ;; interface, but leaving the programmatic interface the same.
3589 buffer-auto-save-file-name
3594 buffer-auto-save-file-name
3595 buffer-file-name)))
3606 found))
3608 file-name)))
3610 ;; If file was backed up but has changed since,
3611 ;; we shd make another backup.
3615 ;; Get rid of all undo records for this buffer.
3618 ;; Effectively copy the after-revert-hook status,
3619 ;; since after-find-file will clobber it.
3623 after-revert-hook)))
3625 ;; Don't make undo records for the reversion.
3629 file-name auto-save-p)
3632 "File %s no longer exists!"
3634 file-name))
3635 ;; Bind buffer-file-name to nil
3636 ;; so that we don't try to lock the file.
3642 ;; Auto-saved file shoule be read without
3643 ;; any code conversion.
3646 buffer-file-coding-system))))
3647 ;; This force after-insert-file-set-coding
3648 ;; (called from insert-file-contents) to set
3649 ;; buffer-file-coding-system to a proper value.
3652 ;; Note that this preserves point in an intelligent way.
3656 nil nil t))
3658 nil nil t)))))
3659 ;; Recompute the truename in case changes in symlinks
3660 ;; have changed the truename.
3664 ;; Run after-revert-hook as it was before we reverted.
3668 local-hook)
3671 t)))))
3674 "Recover the visited file--get contents from its last auto-save file."
3679 "Visit file FILE, but get contents from its last auto-save file."
3680 ;; Actually putting the file name in the minibuffer should be used
3681 ;; only rarely.
3682 ;; Not just because users often use the default.
3702 ;; Use insert-directory-safely, not insert-directory,
3703 ;; because these files might not exist. In particular,
3704 ;; FILE might not exist if the auto-save file was for
3705 ;; a buffer that didn't visit a file, such as "*mail*".
3706 ;; The code in v20.x called `ls' directly, so we need
3707 ;; to emulate what `ls' did in that case.
3713 ;; Keep the current buffer-file-coding-system.
3715 ;; Auto-saved file shoule be read with special coding.
3724 "Recover auto save files from a previous Emacs session.
3725 This command first displays a Dired buffer showing you the
3726 previous sessions that you could recover from.
3727 To choose one, move point to the proper line and then type C-c C-c.
3728 Then you'll be asked about a number of files to recover."
3738 auto-save-list-file-prefix)))
3739 t)
3748 ;; Each line starts with a space
3749 ;; so that Font Lock mode won't highlight the first character.
3758 "Choose one saved session to recover auto-save files from.
3759 This command is used in the special Dired buffer created by
3762 ;; Get the name of the session file to recover from.
3764 files
3770 ;; Read in the auto-save-list file.
3774 ;; Loop thru the text of that file
3775 ;; and get out the names of the files to recover.
3779 ;; This is a pair of lines for a non-file-visiting buffer.
3780 ;; Get the auto-save file name and manufacture
3781 ;; a "visited file name" from that.
3784 ;; If there is no auto-save file name, the
3785 ;; auto-save-list file is probably corrupted.
3800 ;; This pair of lines is a file-visiting
3801 ;; buffer. Use the visited file name.
3811 ;; Ignore a file if its auto-save file does not exist now.
3815 ;; The file contains a pair of line for each auto-saved buffer.
3816 ;; The first line of the pair contains the visited file name
3817 ;; or is empty if the buffer was not visiting a file.
3818 ;; The second line is the auto-save file name.
3826 files
3832 "Kill some buffers. Asks the user whether to kill each one of them.
3833 Non-interactively, if optional argument LIST is non-nil, it
3834 specifies the list of buffers to kill, asking for approval for each one."
3845 name
3850 \f
3852 "Toggle auto-saving of contents of current buffer.
3853 With prefix argument ARG, turn auto-saving on if positive, else off."
3858 ;; If auto-save is off because buffer has shrunk,
3859 ;; then toggling should turn it on.
3864 buffer-file-name
3866 ;; If -1 was stored here, to temporarily turn off saving,
3867 ;; turn it back on.
3873 buffer-auto-save-file-name)
3876 "Adjust current buffer's auto save file name for current conditions.
3877 Also rename any existing auto save file, if it was made in this session."
3889 "Return file name to use for auto-saves of current buffer.
3890 Does not consider `auto-save-visited-file-name' as that variable is checked
3891 before calling this function. You can redefine this for customization.
3892 See also `auto-save-file-name-p'."
3896 result uniq)
3897 ;; Apply user-specified translations
3898 ;; to the file name.
3902 filename)
3912 filename))))
3917 ;; We truncate the file name to DOS 8+3 limits
3918 ;; before doing anything else, because the regexp
3919 ;; passed to string-match below cannot handle
3920 ;; extensions longer than 3 characters, multiple
3921 ;; dots, and other atrocities.
3926 fn)
3931 "#"
3934 ;; Make sure auto-save file names don't contain characters
3935 ;; invalid for the underlying filesystem.
3937 ;; Don't modify remote (ange-ftp) filenames
3940 result))
3942 ;; Deal with buffers that don't have any associated files. (Mail
3943 ;; mode tends to create a good number of these.)
3947 file-name)
3948 ;; Eliminate all slashes and backslashes by
3949 ;; replacing them with sequences that start with %.
3950 ;; Quote % also, to keep distinct names distinct.
3959 ;; Generate the file name.
3965 ;; Try a few alternative directories, to get one we can
3966 ;; write it.
3972 ;; Don't modify remote (ange-ftp) filenames
3974 ;; The call to convert-standard-filename is in case
3975 ;; buffer-name includes characters not allowed by the
3976 ;; DOS/Windows filesystems. make-temp-file writes to the
3977 ;; file it creates, so we must fix the file name _before_
3978 ;; make-temp-file is called.
3980 fname))
3982 ;; make-temp-file creates the file,
3983 ;; but we don't want it to exist until we do an auto-save.
3987 file-name)))
3990 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3991 FILENAME should lack slashes. You can redefine this for customization."
3993 \f
3995 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3996 The generated regexp will match a filename iff the filename
3997 matches that wildcard according to shell rules. Only wildcards known
3998 by `sh' are supported."
4000 ;; Copy the initial run of non-special characters.
4003 ;; If no special characters, we're almost done.
4007 j)
4009 result
4030 ;; Found "[^". Insert a `\0' character
4031 ;; (which cannot happen in a filename)
4032 ;; into the character class, so that `^'
4033 ;; is not the first character after `[',
4034 ;; and thus non-special in a regexp.
4039 ;; I don't think `]' can appear in a
4040 ;; character class in a wildcard, but
4041 ;; let's be general here.
4048 i
4061 ;; Shell wildcards should match the entire filename,
4062 ;; not its part. Make the regexp say so.
4064 \f
4067 "*Switches for `list-directory' to pass to `ls' for brief listing."
4073 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4075 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4080 "Expand wildcard pattern PATTERN.
4081 This returns a list of file names which match the pattern.
4083 If PATTERN is written as an absolute file name,
4084 the values are absolute also.
4086 If PATTERN is written as a relative file name, it is interpreted
4087 relative to the current default directory, `default-directory'.
4088 The file names returned are normally also relative to the current
4089 default directory. However, if FULL is non-nil, they are absolute."
4093 ;; A list of all dirs that DIRPART specifies.
4094 ;; This can be more than one dir
4095 ;; if DIRPART contains wildcards.
4100 contents)
4105 ;; Filter out "." and ".."
4110 name))
4117 this-dir-contents)
4118 this-dir-contents)
4119 contents))))
4121 contents)))
4124 "Display a list of files in or matching DIRNAME, a la `ls'.
4125 DIRNAME is globbed by the shell if necessary.
4126 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4127 Actions controlled by variables `list-directory-brief-switches'
4128 and `list-directory-verbose-switches'."
4132 nil default-directory nil)
4133 pfx)))
4135 list-directory-brief-switches))
4136 buffer)
4149 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4157 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4159 PATTERN is assumed to represent a file-name wildcard suitable for the
4160 underlying filesystem. For Unix and GNU/Linux, the characters from the
4162 the parts of the pattern which don't include wildcard characters are
4163 quoted with double quotes.
4164 Existing quote characters in PATTERN are left alone, so you can pass
4165 PATTERN that already quotes some of the special characters."
4169 ;; DOS/Windows don't allow `"' in file names. So if the
4170 ;; argument has quotes, we can safely assume it is already
4171 ;; quoted by the caller.
4173 ;; We quote [&()#$'] in case their shell is a port of a
4174 ;; Unixy shell. We quote [,=+] because stock DOS and
4175 ;; Windows shells require that in some cases, such as
4176 ;; passing arguments to batch files that use positional
4177 ;; arguments like %1.
4179 pattern
4182 end)
4199 pattern))))
4206 "*Program to get the amount of free space on a file system.
4207 We assume the output has the format of `df'.
4208 The value of this variable must be just a command name or file name;
4209 if you want to specify options, use `directory-free-space-args'.
4211 A value of nil disables this feature.
4213 If the function `file-system-info' is defined, it is always used in
4214 preference to the program given by this variable."
4220 "*Options to use when running `directory-free-space-program'."
4225 "Return the mount of free space on directory DIR's file system.
4226 The result is a string that gives the number of free 1KB blocks,
4227 or nil if the system call or the program which retrieve the infornmation
4228 fail.
4230 This function calls `file-system-info' if it is available, or invokes the
4231 program specified by `directory-free-space-program' if that is non-nil."
4232 ;; Try to find the number of free blocks. Non-Posix systems don't
4233 ;; always have df, but might have an equivalent system call.
4242 nil t nil
4243 directory-free-space-args
4244 dir)))
4245 ;; Usual format is a header line followed by a line of
4246 ;; numbers.
4251 ;; Move to the end of the "available blocks" number.
4254 ;; Copy it into AVAILABLE.
4260 ;; insert-directory
4261 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4262 ;; FULL-DIRECTORY-P is nil.
4263 ;; The single line of output must display FILE's name as it was
4264 ;; given, namely, an absolute path name.
4265 ;; - must insert exactly one line for each file if WILDCARD or
4266 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4267 ;; before the file lines, plus optional text after the file lines.
4268 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4269 ;; allowed.
4270 ;; File lines should display the basename.
4271 ;; - must be consistent with
4272 ;; - functions dired-move-to-filename, (these two define what a file line is)
4273 ;; dired-move-to-end-of-filename,
4274 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4275 ;; dired-insert-headerline
4276 ;; dired-after-subdir-garbage (defines what a "total" line is)
4277 ;; - variable dired-subdir-regexp
4278 ;; - may be passed "--dired" as the first argument in SWITCHES.
4279 ;; Filename handlers might have to remove this switch if their
4280 ;; "ls" command does not support it.
4282 "Insert directory listing for FILE, formatted according to SWITCHES.
4283 Leaves point after the inserted text.
4284 SWITCHES may be a string of options, or a list of strings
4285 representing individual options.
4286 Optional third arg WILDCARD means treat FILE as shell wildcard.
4287 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4288 switches do not contain `d', so that a full listing is expected.
4290 This works by running a directory listing program
4291 whose name is in the variable `insert-directory-program'.
4292 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4294 When SWITCHES contains the long `--dired' option, this function
4295 treats it specially, for the sake of dired. However, the
4296 normally equivalent short `-D' option is just passed on to
4297 `insert-directory-program', as any other option."
4298 ;; We need the directory in order to find the right handler.
4303 wildcard full-directory-p)
4308 ;; Read the actual directory using `insert-directory-program'.
4309 ;; RESULT gets the status code.
4311 ;; putting text property `dired-filename, decode one
4312 ;; bunch by one to preserve that property.
4314 ;; This is to control encoding the arguments in call-process.
4318 default-file-name-coding-system))))
4321 ;; Run ls in the directory part of the file pattern
4322 ;; using the last component as argument.
4329 shell-file-name nil t nil
4330 "-c"
4332 ""
4334 insert-directory-program
4335 " -d "
4337 switches
4339 " -- "
4340 ;; Quote some characters that have
4341 ;; special meanings in shells; but
4342 ;; don't quote the wildcards--we want
4343 ;; them to be special. We also
4344 ;; currently don't quote the quoting
4345 ;; characters in case people want to
4346 ;; use them explicitly to quote
4347 ;; wildcard characters.
4349 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4350 ;; directory if FILE is a symbolic link.
4352 insert-directory-program nil t nil
4356 ;; Split the switches at any spaces so we can
4357 ;; pass separate options as separate args.
4359 ;; Avoid lossage if FILE starts with `-'.
4367 file))))))))
4369 ;; If `insert-directory-program' failed, signal an error.
4371 ;; Delete the error message it may have output.
4373 ;; On non-Posix systems, we cannot open a directory, so
4374 ;; don't even try, because that will always result in
4375 ;; the ubiquitous "Access denied". Instead, show the
4376 ;; command line so the user can try to guess what went wrong.
4381 insert-directory-program
4383 file result)
4384 ;; Unix. Access the file to get a suitable error.
4403 ;; End is followed by \n or by " -> ".
4405 ;; It seems that we can't trust ls's output as to
4406 ;; byte positions of filenames.
4417 ;; Now decode what read if necessary.
4419 file-name-coding-system
4420 default-file-name-coding-system
4422 coding-no-eol
4423 val pos)
4427 ;; If no coding system is specified or detection is
4428 ;; requested, detect the coding.
4442 ;; Force no eol conversion on a file name, so
4443 ;; that CR is preserved.
4451 ;; Try to insert the amount of free space.
4454 ;; First find the line to put it on.
4458 ;; Replace "total" with "used", to avoid confusion.
4465 "Insert directory listing for FILE, formatted according to SWITCHES.
4467 Like `insert-directory', but if FILE does not exist, it inserts a
4468 message to that effect instead of signaling an error."
4471 ;; Simulate the message printed by `ls'.
4475 "Functions to call with no arguments to query about killing Emacs.
4476 If any of these functions returns nil, killing Emacs is cancelled.
4478 but `kill-emacs', the low level primitive, does not.
4482 "How to ask for confirmation when leaving Emacs.
4483 If nil, the default, don't ask at all. If the value is non-nil, it should
4484 be a predicate function such as `yes-or-no-p'."
4492 "Offer to save each buffer, then kill this Emacs process.
4493 With prefix arg, silently save all file-visiting buffers, then kill."
4502 ;; process-list is not defined on VMS.
4504 active)
4513 ;; Query the user for other things, perhaps.
4518 \f
4519 ;; We use /: as a prefix to "quote" a file name
4520 ;; so that magic file name handlers will not apply to it.
4524 file-name-handler-alist))
4526 ;; We depend on being the last handler on the list,
4527 ;; so that anything else which does need handling
4528 ;; has been handled already.
4529 ;; So it is safe for us to inhibit *all* magic file name handlers.
4538 default-directory))
4539 ;; Get a list of the indices of the args which are file names.
4542 ;; The first six are special because they
4543 ;; return a file name. We want to include the /:
4544 ;; in the return value.
4545 ;; So just avoid stripping it in the first place.
4552 ;; `identity' means just return the first arg
4553 ;; not stripped of its quoting.
4555 ;; `add' means add "/:" to the result.
4557 ;; `quote' means add "/:" to buffer-file-name.
4559 ;; `unquote-then-quote' means set buffer-file-name
4560 ;; temporarily to unquoted filename.
4562 ;; List the arguments which are filenames.
4570 ;; For all other operations, treat the first argument only
4571 ;; as the file name.
4573 method
4574 ;; Copy ARGUMENTS so we can replace elements in it.
4578 ;; Strip off the /: from the file names that have it.
4586 "/"
4601 res))
4604 \f
4628 ;;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
4629 ;;; files.el ends here