| blob | a1fc1086654c6ed9784a30fa0458819b8f3a870d |
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 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').
492 See Info node `(elisp)Standard File Names' for more details."
493 filename)
496 "Read directory name, prompting with PROMPT and completing in directory DIR.
497 Value is not expanded---you must call `expand-file-name' yourself.
498 Default name to DEFAULT-DIRNAME if user exits with the same
499 non-empty string that was inserted by this function.
500 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
501 except that if INITIAL is specified, that combined with DIR is used.)
502 If the user exits with an empty minibuffer, this function returns
503 an empty string. (This can only happen if the user erased the
504 pre-inserted contents or if `insert-default-directory' is nil.)
505 Fourth arg MUSTMATCH non-nil means require existing directory's name.
506 Non-nil and non-t means also require confirmation after completion.
507 Fifth arg INITIAL specifies text to start with.
508 DIR should be an absolute directory name. It defaults to
509 the value of `default-directory'."
518 \f
520 "Show the current default directory."
525 "Value of the CDPATH environment variable, as a list.
529 "Explode a search path into a list of directory names.
530 Directories are separated by occurrences of `path-separator'
531 \(which is colon in GNU and GNU-like systems)."
532 ;; We could use split-string here.
540 nil
545 cd-list)))
548 "Change current directory to given absolute file name DIR."
549 ;; Put the name into directory syntax now,
550 ;; because otherwise expand-file-name may give some bad results.
563 "Make DIR become the current buffer's default directory.
564 If your environment includes a `CDPATH' variable, try each one of
565 that list of directories (separated by occurrences of
566 `path-separator') when resolving a relative directory name.
567 The path separator is colon in GNU and GNU-like systems."
570 default-directory default-directory
586 cd-path)
587 nil))
591 "Load the Lisp file named FILE."
592 ;; This is a case where .elc makes a lot of sense.
599 "Search for FILENAME through PATH.
600 If SUFFIXES is non-nil, it should be a list of suffixes to append to
602 If non-nil, PREDICATE is used instead of `file-readable-p'.
603 PREDICATE can also be an integer to pass to the `access' system call,
604 in which case file-name handlers are ignored. This usage is deprecated.
606 For compatibility, PREDICATE can also be one of the symbols
607 `executable', `readable', `writable', or `exists', or a list of
608 one or more of those symbols."
619 "Do completion for file names passed to `locate-file'.
620 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
643 "Load the library named LIBRARY.
644 This is an interface to the function `load'."
647 'locate-file-completion
652 "Test whether FILE specifies a location on a remote system.
653 Return an identification of the system if the location is indeed
654 remote. The identification of the system may comprise a method
655 to access the system and its hostname, amongst other things.
662 nil)))
665 "Copy the file FILE into a temporary file on this machine.
666 Returns the name of the local copy, or nil, if FILE is directly
667 accessible."
668 ;; This formerly had an optional BUFFER argument that wasn't used by
669 ;; anything.
673 nil)))
676 "Return the truename of FILENAME, which should be absolute.
677 The truename of a file name is found by chasing symbolic links
678 both at the level of the file and at the level of the directories
679 containing it, until no links are left at any level.
682 ;; COUNTER and PREV-DIRS are only used in recursive calls.
683 ;; COUNTER can be a cons cell whose car is the count of how many
684 ;; more links to chase before getting an error.
685 ;; PREV-DIRS can be a cons cell whose car is an alist
686 ;; of truenames we've just recently computed.
700 ;; For speed, remove the ange-ftp completion handler from the list.
701 ;; We know it's not needed here.
702 ;; For even more speed, do this only on the outermost call.
709 ;; andrewi@harlequin.co.uk - none of the following code (except for
710 ;; invoking the file-name handler) currently applies on Windows
711 ;; (ie. there are no native symlinks), but there is an issue with
712 ;; case differences being ignored by the OS, and short "8.3 DOS"
713 ;; name aliases existing for all files. (The short names are not
714 ;; reported by directory-files, but can be used to refer to files.)
715 ;; It seems appropriate for file-truename to resolve these issues in
716 ;; the most natural way, which on Windows is to call the function
717 ;; `w32-long-file-name' - this returns the exact name of a file as
718 ;; it is stored on disk (expanding short name aliases with the full
719 ;; name in the process).
722 ;; For file name that has a special handler, call handler.
723 ;; This is so that ange-ftp can save time by doing a no-op.
726 ;; If filename contains a wildcard, newname will be the old name.
728 ;; If filename exists, use the long name
732 ;; If this file directly leads to a link, process that iteratively
733 ;; so that we don't use lots of stack.
739 ;; For file name that has a special handler, call handler.
740 ;; This is so that ange-ftp can save time by doing a no-op.
743 done t)
745 target dirfile)
746 ;; Get the truename of the directory.
748 ;; If these are equal, we have the (or a) root directory.
750 ;; If this is the same dir we last got the truename for,
751 ;; save time--don't recalculate.
761 done t)
764 done t)
765 ;; Put it back on the file name.
767 ;; Is the file name the name of a link?
770 ;; Yes => chase that link, then start all over
771 ;; since the link may point to a directory name that uses links.
772 ;; We can't safely use expand-file-name here
773 ;; since target might look like foo/../bar where foo
774 ;; is itself a link. Instead, we handle . and .. above.
777 target
779 done nil)
780 ;; No, we are done!
782 filename))
785 "Chase links in FILENAME until a name that is not a link.
786 Unlike `file-truename', this does not check whether a parent
787 directory name is a symbolic link.
788 If the optional argument LIMIT is a number,
789 it means chase no more than that many links and then stop."
797 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
800 ;; Handle `..' by hand, since it needs to work in the
801 ;; target of any directory symlink.
802 ;; This code is not quite complete; it does not handle
803 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
807 ;; Chase links in the default dir of the symlink.
811 ;; Now find the parent of that dir.
815 newname))
818 "Change the encoding of FILE's name from CODING to NEW-CODING.
819 The value is a new name of FILE.
820 Signals a `file-already-exists' error if a file of the new name
821 already exists unless optional third argument OK-IF-ALREADY-EXISTS
822 is non-nil. A number as third arg means request confirmation if
823 the new name already exists. This is what happens in interactive
824 use with M-x."
827 default-file-name-coding-system))
829 from-coding to-coding)
831 ;; We provide the default coding only when it seems that
832 ;; the filename is correctly decoded by the default
833 ;; coding.
839 filename default-coding)
840 default-coding))
844 ;; We provide the default coding only when a user is going to
845 ;; change the encoding not from the default coding.
849 filename from-coding)))
852 filename from-coding default-coding)
853 default-coding)))
857 default-file-name-coding-system))
858 ;; FILE should have been decoded by DEFAULT-CODING.
862 ;; Suppress further encoding.
867 newname))
868 \f
870 "Select buffer BUFFER in another window.
871 If BUFFER does not identify an existing buffer, then this function
872 creates a buffer with that name.
874 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
875 or nil. If BUFFER is nil, then this function chooses a buffer
876 using `other-buffer'.
877 Optional second arg NORECORD non-nil means
878 do not put this buffer at the front of the list of recently selected ones.
879 This function returns the buffer it switched to.
881 This uses the function `display-buffer' as a subroutine; see its
882 documentation for additional customization information."
885 ;; Don't let these interfere.
886 same-window-buffer-names same-window-regexps)
890 "Switch to buffer BUFFER in another frame.
891 Optional second arg NORECORD non-nil means
892 do not put this buffer at the front of the list of recently selected ones.
894 This uses the function `display-buffer' as a subroutine; see its
895 documentation for additional customization information."
898 same-window-buffer-names same-window-regexps)
912 ;; Clear out this hook so it does not interfere
913 ;; with any recursive minibuffer usage.
916 minibuffer-setup-hook))
919 t))
922 "Edit file FILENAME.
923 Switch to a buffer visiting file FILENAME,
924 creating one if none already exists.
925 Interactively, the default if you just type RET is the current directory,
926 but the visited file name is available through the minibuffer history:
927 type M-n to pull it into the minibuffer.
929 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
930 expand wildcards (if any) and visit multiple files. You can
931 suppress wildcard expansion by setting `find-file-wildcards'.
933 To visit a file without any kind of conversion and without
943 "Edit file FILENAME, in another window.
944 May create a new window, or reuse an existing one.
945 See the function `display-buffer'.
947 Interactively, the default if you just type RET is the current directory,
948 but the visited file name is available through the minibuffer history:
949 type M-n to pull it into the minibuffer.
951 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
952 expand wildcards (if any) and visit multiple files."
963 "Edit file FILENAME, in another frame.
964 May create a new frame, or reuse an existing one.
965 See the function `display-buffer'.
967 Interactively, the default if you just type RET is the current directory,
968 but the visited file name is available through the minibuffer history:
969 type M-n to pull it into the minibuffer.
971 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
972 expand wildcards (if any) and visit multiple files."
983 "Edit the existing file FILENAME.
991 "Edit file FILENAME but don't allow changes.
1001 "Edit file FILENAME in another window but don't allow changes.
1011 "Edit file FILENAME in another frame but don't allow changes.
1021 "Find file FILENAME as a replacement for the file in the next window.
1022 This command does not select that window."
1041 "Find file FILENAME, select its buffer, kill previous buffer.
1042 If the current buffer now contains an empty file that you just visited
1043 \(presumably by mistake), use this command to visit the file you really want."
1073 ;; This prevents us from finding the same buffer
1074 ;; if we specified the same file again.
1078 ;; Likewise for dired buffers.
1082 ;; This executes if find-file gets an error
1083 ;; and does not really find anything.
1084 ;; We put things back as they were.
1085 ;; If find-file actually finds something, we kill obuf below.
1094 ;; We already asked; don't ask again.
1097 \f
1099 "Create a suitably named buffer for visiting FILENAME, and return it.
1100 FILENAME (sans directory) is used unchanged if that name is free;
1101 otherwise a string <2> or <3> or ... is appended to get an unused name."
1108 "Create and return a buffer with a name based on NAME.
1109 Choose the buffer's name using `generate-new-buffer-name'."
1113 "Regexp to match the automounter prefix in a directory name."
1121 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1123 removes automounter prefixes (see the variable `automount-dir-prefix')."
1124 ;; Get rid of the prefixes added by the automounter.
1131 ;; If any elt of directory-abbrev-alist matches this name,
1132 ;; abbreviate accordingly.
1138 ;; Compute and save the abbreviated homedir name.
1139 ;; We defer computing this until the first time it's needed, to
1140 ;; give time for directory-abbrev-alist to be set properly.
1141 ;; We include a slash at the end, to avoid spurious matches
1142 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1149 ;; If FILENAME starts with the abbreviated homedir,
1150 ;; make it start with `~' instead.
1152 ;; If the home dir is just /, don't change it.
1155 ;; MS-DOS root directories can come with a drive letter;
1156 ;; Novell Netware allows drive letters beyond `Z:'.
1166 filename))
1169 "*List of logical names for which visiting shouldn't save the true dirname.
1170 On VMS, when you visit a file using a logical name that searches a path,
1171 you may or may not want the visited file name to record the specific
1172 directory where the file was found. If you *do not* want that, add the logical
1173 name to this list as a string."
1178 "Return the buffer visiting file FILENAME (a string).
1179 This is like `get-file-buffer', except that it checks for any buffer
1180 visiting the same file, possibly under a different name.
1181 If PREDICATE is non-nil, only a buffer satisfying it can be returned.
1182 If there is no such live buffer, return nil."
1196 found)
1201 number
1206 ;; Verify this buffer's file number
1207 ;; still belongs to its file.
1210 attributes)
1214 found))))
1215 \f
1217 "*Non-nil means file-visiting commands should handle wildcards.
1218 For example, if you specify `*.c', that would visit all the files
1219 whose names match the pattern."
1225 "*Non-nil means suppress warning messages for symlinked files.
1226 When nil, Emacs prints a warning when visiting a file that is already
1227 visited, but with a different name. Setting this option to t
1228 suppresses this warning."
1234 "Maximum size of file above which a confirmation is requested.
1235 When nil, never request confirmation."
1242 "Read file FILENAME into a buffer and return the buffer.
1243 If a buffer exists visiting FILENAME, return that one, but
1244 verify that the file has not changed since visited or saved.
1245 The buffer is not selected, just returned to the caller.
1246 Optional first arg NOWARN non-nil means suppress any warning messages.
1247 Optional second arg RAWFILE non-nil means the file is read literally.
1248 Optional third arg WILDCARDS non-nil means do wildcard processing
1249 and visit all the matching files. When wildcards are actually
1250 used and expanded, the value is a list of buffers
1251 that are visiting the various files."
1258 'find-directory-functions
1261 filename)))
1264 find-file-wildcards
1278 ;; Find any buffer for a file which has same truename.
1280 ;; Let user know if there is a buffer with the same truename.
1284 find-file-suppress-same-file-warnings
1288 ;; Optionally also find that buffer.
1291 ;; Check to see if the file looks uncommonly large.
1293 ;; Don't ask again if we already have the file or
1294 ;; if we're asked to be quiet.
1303 ;; We are using an existing buffer.
1309 ;; Certain files should be reverted automatically
1310 ;; if they have changed on disk and not in the buffer.
1318 found))
1328 "File %s changed on disk. Discard your edits? "
1333 "File %s changed on disk. Discard your edits in %s? "
1341 ;; Check if a formerly read-only file has become
1342 ;; writable and vice versa, but if the buffer agrees
1343 ;; with the new state of the file, that is ok too.
1350 buffer-file-name
1358 ;; It is confusing to ask whether to visit
1359 ;; non-literally if they have the file in
1360 ;; hexl-mode.
1364 "Save file and revisit literally? "
1369 rawfile truename number))
1371 "Discard your edits and revisit file literally? "
1374 rawfile truename number)
1378 "Revisit file literally? "
1381 rawfile truename number)
1384 ;; Return the buffer we are using.
1385 buf)
1386 ;; Create a new buffer.
1389 ;; find-file-noselect-1 may use a different buffer.
1391 rawfile truename number))))))
1397 ;; Needed in case we are re-visiting the file with a different
1398 ;; text representation.
1415 filename)))
1416 ;; Unconditionally set error
1426 filename)))
1427 ;; Run find-file-not-found-hooks until one returns non-nil.
1429 ;; If they fail too, set error.
1431 ;; Record the file's truename, and maybe use that as visited name.
1437 ;; On VMS, we may want to remember which directory in a search list
1438 ;; the file was found in.
1450 ;; Set buffer's default directory to that of the file.
1452 ;; Turn off backup files for certain file names. Since
1453 ;; this is a permanent local, the major mode won't eliminate it.
1466 \f
1468 "Like `insert-file-contents', but only reads in the file literally.
1469 A buffer may be modified in several ways after reading into the buffer,
1470 to Emacs features such as format decoding, character code
1471 conversion, `find-file-hook', automatic uncompression, etc.
1473 This function ensures that none of these modifications will take place."
1481 nil))
1484 inhibit-file-name-handlers))
1497 filename)))
1507 "Insert contents of file FILENAME into buffer after point with no conversion.
1509 This function is meant for the user to run interactively.
1510 Don't call it from programs! Use `insert-file-contents-literally' instead.
1511 \(Its calling sequence is different; see its documentation)."
1516 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1521 "Visit file FILENAME with no conversion of any kind.
1522 Format conversion and character code conversion are both disabled,
1523 and multibyte characters are disabled in the resulting buffer.
1524 The major mode used is Fundamental mode regardless of the file name,
1525 and local variable specifications in the file are ignored.
1526 Automatic uncompression and adding a newline at the end of the
1527 file due to `require-final-newline' is also disabled.
1529 You cannot absolutely rely on this function to result in
1530 visiting the file literally. If Emacs already has a buffer
1531 which is visiting the file, you get the existing buffer,
1532 regardless of whether it was created literally or not.
1534 In a Lisp program, if you want to be sure of accessing a file's
1535 contents literally, you should create a temporary buffer and then read
1536 the file contents into it using `insert-file-contents-literally'."
1539 \f
1543 after-find-file-from-revert-buffer
1544 nomodes)
1545 "Called after finding a file and by the default revert function.
1546 Sets buffer mode, parses local variables.
1547 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1548 error in reading the file. WARN non-nil means warn if there
1549 exists an auto-save file more recent than the visited file.
1550 NOAUTO means don't mess with auto-save mode.
1551 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1552 means this call was from `revert-buffer'.
1553 Fifth arg NOMODES non-nil means don't alter the file's modes.
1554 Finishes by calling the functions in `find-file-hook'
1555 unless NOMODES is non-nil."
1558 nil
1568 ;; No need to warn if buffer is auto-saved
1569 ;; under the name of the visited file.
1571 auto-save-visited-file-name))
1574 buffer-file-name))
1594 ;; Make people do a little extra work (C-x C-q)
1595 ;; before altering a backup file.
1598 ;; When a file is marked read-only,
1599 ;; make the buffer read-only even if root is looking at it.
1608 view-read-only
1614 "Eval BODY and turn any error into a FORMAT message.
1615 FORMAT can have a %s escape which will be replaced with the actual error.
1616 If `debug-on-error' is set, errors are not caught, so that you can
1617 debug them.
1618 Avoid using a large BODY since it is duplicated."
1627 "Choose the major mode for this buffer automatically.
1628 Also sets up any specified local variables of the file.
1629 Uses the visited file name, the -*- line, and the local variables spec.
1631 This function is called automatically from `find-file'. In that case,
1632 we may set up the file-specified mode and local variables,
1633 depending on the value of `enable-local-variables': if it is t, we do;
1634 if it is nil, we don't; otherwise, we query.
1635 In addition, if `local-enable-local-variables' is nil, we do
1636 not set local variables (though we do notice a mode specified with -*-.)
1638 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1639 or from Lisp without specifying the optional argument FIND-FILE;
1640 in that case, this function acts as if `enable-local-variables' were t."
1652 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1653 ;; c++-mode, java-mode and more) are added through autoload
1654 ;; directives in that file. That way is discouraged since it
1655 ;; spreads out the definition of the initial value.
1680 ;; Less common extensions come here
1681 ;; so more common ones above are found faster.
1723 ;; Mailer puts message to be edited in
1724 ;; /tmp/Re.... or Message
1729 ;; some news reader is reported to use this
1738 ;; .emacs or .gnus or .viper following a directory delimiter in
1739 ;; Unix, MSDOG or VMS syntax.
1742 ;; _emacs following a directory delimiter
1743 ;; in MsDos syntax
1761 ;; Windows candidates may be opened case sensitively on Unix
1766 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1768 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1769 ("\\`/etc/\\(?:default/.*\\|aliases\\|group-?\\|hosts\\..+\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\)\\'" . conf-mode)
1770 ;; either user's dot-files or under /etc or some such
1772 ;; alas not all ~/.*rc files are like this
1773 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1778 ;; this contains everything twice, with space and with colon :-(
1780 ;; Get rid of any trailing .n.m and try again.
1781 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1782 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1783 ;; Using mode nil rather than `ignore' would let the search continue
1784 ;; through this list (with the shortened name) rather than start over.
1786 ;; The following should come after the ChangeLog pattern
1787 ;; for the sake of ChangeLog.1, etc.
1788 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1791 "Alist of filename patterns vs corresponding major mode functions.
1792 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1793 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1794 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1795 mode function to use. FUNCTION will be called, unless it is nil.
1797 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1798 calling FUNCTION (if it's not nil), we delete the suffix that matched
1803 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1804 ;; and pike-mode) are added through autoload directives in that
1805 ;; file. That way is discouraged since it spreads out the
1806 ;; definition of the initial value.
1844 "Alist mapping interpreter names to major modes.
1845 This alist applies to files whose first line starts with `#!'.
1846 Each element looks like (INTERPRETER . MODE).
1847 The car of each element is compared with
1848 the name of the interpreter specified in the first line.
1855 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1856 When checking `inhibit-first-line-modes-regexps', we first discard
1862 "Regular expression matching interpreters, for file mode determination.
1863 This regular expression is matched against the first line of a file
1864 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1865 a mode from the file's name. If it matches, the file is assumed to
1866 be interpreted by the interpreter matched by the second group of the
1867 regular expression. The mode is then determined as the mode associated
1872 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
1876 comment-re "*"
1879 ;; These two must come after html, because they are more general:
1886 "Alist of buffer beginnings vs. corresponding major mode functions.
1887 Each element looks like (REGEXP . FUNCTION). FUNCTION will be
1891 "Select major mode appropriate for current buffer.
1893 This checks for a -*- mode tag in the buffer's text, checks the
1894 interpreter that runs this file against `interpreter-mode-alist',
1895 compares the buffer beginning against `magic-mode-alist', or
1896 compares the filename against the entries in `auto-mode-alist'.
1898 It does not check for the `mode:' local variable in the
1899 Local Variables section of the file; for that, use `hack-local-variables'.
1901 If `enable-local-variables' is nil, this function does not check for a
1902 -*- mode tag.
1904 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
1905 only set the major mode, if that would change it."
1906 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1908 ;; Find a -*- mode tag
1915 ;; Find all specifications for the `mode:' variable
1916 ;; and execute them left to right.
1928 modes)))
1929 ;; Simple -*-MODE-*- case.
1932 modes))))
1933 ;; If we found modes to use, invoke them now, outside the save-excursion.
1941 ;; continuing would call minor modes again, toggling them off
1943 ;; If we didn't, look for an interpreter specified in the first line.
1944 ;; As a special case, allow for things like "#!/bin/env perl", which
1945 ;; finds the interpreter anywhere in $PATH.
1951 ;; Map interpreter name to a mode, signalling we're done at the
1952 ;; same time.
1954 interpreter-mode-alist))
1955 ;; If we found an interpreter mode to use, invoke it now.
1958 ;; If we didn't, match the buffer beginning against magic-mode-alist.
1966 ;; Compare the filename against the entries in auto-mode-alist.
1969 ;; Remove backup-suffixes from file name.
1972 ;; Find first matching alist entry.
1985 ;; When `keep-mode-if-same' is set, we are working on behalf of
1986 ;; set-visited-file-name. In that case, if the major mode specified is the
1987 ;; same one we already have, don't actually reset it. We don't want to lose
1988 ;; minor modes such as Font Lock.
1990 "Apply MODE and return it.
1991 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
1992 any aliases and compared to current major mode. If they are the
1993 same, do nothing and return nil."
2001 mode))
2004 "Find the -*- spec in the buffer.
2005 Call with point at the place to start searching from.
2006 If one is found, set point to the beginning
2007 and return the position of the end.
2008 Otherwise, return nil; point may be changed."
2011 ;; Don't look for -*- if this file name matches any
2012 ;; of the regexps in inhibit-first-line-modes-regexps.
2020 sufs)
2028 ;; If the file begins with "#!"
2029 ;; (exec interpreter magic), look
2030 ;; for mode frobs in the first two
2031 ;; lines. You cannot necessarily
2032 ;; put them in the first line of
2033 ;; such a file without screwing up
2034 ;; the interpreter invocation.
2042 t))
2048 end))))
2051 "Set local variables specified in the -*- line.
2052 Ignore any specification for `mode:' and `coding:';
2053 `set-auto-mode' should already have handled `mode:',
2054 `set-auto-coding' should already have handled `coding:'.
2055 If MODE-ONLY is non-nil, all we do is check whether the major mode
2056 is specified, returning t if it is specified."
2061 mode-specified
2064 ;; Parse the -*- line into the RESULT alist.
2065 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2067 nil)
2069 ;; Simple form: "-*- MODENAME -*-". Already handled.
2071 nil)
2073 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2074 ;; (last ";" is optional).
2079 ;; There used to be a downcase here,
2080 ;; but the manual didn't say so,
2081 ;; and people want to set var names that aren't all lc.
2088 ;; It is traditional to ignore
2089 ;; case when checking for `mode' in set-auto-mode,
2090 ;; so we must do that here as well.
2091 ;; That is inconsistent, but we're stuck with it.
2092 ;; The same can be said for `coding' in set-auto-coding.
2110 ;; If we fail to switch in the selected window,
2111 ;; it is probably a minibuffer.
2112 ;; So try another window.
2123 nil))))
2126 "Normal hook run after processing a file's local variables specs.
2127 Major modes can use this to examine user-specified local variables
2131 "Parse and put into effect this buffer's local variables spec.
2132 If MODE-ONLY is non-nil, all we do is check whether the major mode
2133 is specified, returning t if it is specified."
2135 ;; If MODE-ONLY is t, we check here for specifying the mode
2136 ;; in the -*- line. If MODE-ONLY is nil, we process
2137 ;; the -*- line here.
2141 ;; Look for "Local variables:" line in last page.
2148 mode-only
2158 buffer-file-name)
2163 ;; The prefix is what comes before "local variables:" in its line.
2164 ;; The suffix is what comes after "local variables:" in its line.
2180 endpos
2187 nil t))
2198 ;; Discard the prefix, if any.
2204 ;; Discard the suffix, if any.
2213 ;; Find the variable name; strip whitespace.
2221 val)
2222 ;; Read the variable value.
2229 ;; Set the variable. "Variables" mode and eval are funny.
2235 mode-specified))
2240 ;; Get confirmation before setting these variables as locals in a file.
2265 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2295 ;; This case is safe because the user gets to check it before it is used.
2299 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2300 If VAL is nil or omitted, the question is whether any value might be
2301 dangerous."
2304 (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$"
2307 ;; If the safe-local-variable property isn't t or nil,
2308 ;; then it must return non-nil on the proposed value to be safe.
2315 Add expressions to this list if you want Emacs to evaluate them, when
2316 they appear in an `eval' local variable specification, without first
2317 asking you for confirmation."
2334 "Return t if it is safe to eval EXP when it is found in a file."
2336 ;; Detect certain `put' expressions.
2342 ;; Only allow safe values of lisp-indent-hook;
2343 ;; not functions.
2346 ;; Allow expressions that the user requested.
2348 ;; Certain functions can be allowed with safe arguments
2349 ;; or can specify verification functions to try.
2357 ok))
2365 ok)))))))
2369 A few patterns are specified so that any name which matches one
2370 is considered risky."
2375 ;; We have already handled coding: tag in set-auto-coding.
2376 nil)
2378 nil)
2379 ;; "Setting" eval means either eval it or do nothing.
2380 ;; Likewise for setting hook variables.
2382 ;; Permit evalling a put of a harmless property.
2383 ;; if the args do nothing tricky.
2386 ;; Permit eval if not root and user says ok.
2405 ;; Ordinary variable, really set it.
2407 ;; Make sure the string has no text properties.
2408 ;; Some text properties can get evaluated in various ways,
2409 ;; so it is risky to put them on with a local variable list.
2414 \f
2417 However, the mode will not be changed if
2418 \(1) a local variables list or the `-*-' line specifies a major mode, or
2420 \ not suitable for ordinary files, or
2421 \(3) the new file name does not particularly specify any mode."
2426 "Change name of file visited in current buffer to FILENAME.
2427 The next time the buffer is saved it will go in the newly specified file.
2428 FILENAME nil or an empty string means make buffer not be visiting any file.
2429 Remember to delete the initial contents of the minibuffer
2430 if you wish to pass an empty string as the argument.
2432 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2433 confirmation in the case where another buffer is already visiting FILENAME.
2435 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2436 the old visited file has been renamed to the new name FILENAME."
2444 nil
2455 filename)))
2469 ;; If new-name == old-name, renaming would add a spurious <2>
2470 ;; and it's considered as a feature in rename-buffer.
2476 ;; Abbreviate the file names of the buffer.
2485 nil)))
2486 ;; write-file-functions is normally used for things like ftp-find-file
2487 ;; that visit things that are not local files as if they were files.
2488 ;; Changing to visit an ordinary local file instead should flush the hook.
2493 ;; If buffer was read-only because of version control,
2494 ;; that reason is gone now, so make it writable.
2498 ;; Turn off backup files for certain file names.
2499 ;; Since this is a permanent local, the major mode won't eliminate it.
2506 ;; If auto-save was not already on, turn it on if appropriate.
2510 ;; If auto save is on, start using a new name.
2511 ;; We deliberately don't rename or delete the old auto save
2512 ;; for the old visited file name. This is because perhaps
2513 ;; the user wants to save the new state and then compare with the
2514 ;; previous state from the auto save file.
2517 ;; Rename the old auto save file if any.
2524 ;; Update the major mode, if the file name determines it.
2526 ;; Don't change the mode if it is special.
2529 ;; Don't change the mode if the local variable list specifies it.
2535 "Write current buffer into file FILENAME.
2536 This makes the buffer visit that file, and marks it as not modified.
2538 If you specify just a directory name as FILENAME, that means to use
2539 the default file name but in that directory. You can also yank
2540 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2542 If the buffer is not already visiting a file, the default file name
2543 for the output file is the buffer name.
2545 If optional second arg CONFIRM is non-nil, this function
2546 asks for confirmation before overwriting an existing file.
2547 Interactively, confirmation is required unless you supply a prefix argument."
2548 ;; (interactive "FWrite file: ")
2552 nil nil nil nil)
2556 default-directory)
2557 nil nil))
2561 ;; If arg is just a directory,
2562 ;; use the default file name, but in that directory.
2573 ;; Make buffer writable if file is writable.
2578 \f
2580 "Make a backup of the disk file visited by the current buffer, if appropriate.
2581 This is normally done before saving the buffer the first time.
2583 A backup may be done by renaming or by copying; see documentation of
2584 variable `make-backup-files'. If it's done by renaming, then the file is
2585 no longer accessible under its old name.
2587 The value is non-nil after a backup was made by renaming.
2588 It has the form (MODES . BACKUPNAME).
2589 MODES is the result of `file-modes' on the original
2590 file; this means that the caller, after saving the buffer, should change
2591 the modes of the new file to agree with the old modes.
2592 BACKUPNAME is the backup file name, which is the old file renamed."
2599 backup-info backupname targets setmodes)
2600 ;; If specified name is a symbolic link, chase it to the target.
2601 ;; Thus we make the backups in the directory where the real file is.
2606 ;; (if (file-directory-p buffer-file-name)
2607 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2611 ;; If have old versions to maybe delete,
2612 ;; ask the user to confirm now, before doing anything.
2613 ;; But don't actually delete til later.
2618 real-file-name)))))
2620 ;; Actually write the back up file.
2623 ; (file-symlink-p buffer-file-name)
2624 backup-by-copying
2625 ;; Don't rename a suid or sgid file.
2639 ;; rename-file should delete old backup.
2643 ;; If trouble writing the backup, write it in ~.
2652 ;; Now delete the old versions, if desired.
2659 setmodes)
2666 ;; If copying fails because file TO-NAME
2667 ;; is not writable, delete that file and try again.
2676 "Return file NAME sans backup versions or strings.
2677 This is a separate procedure so your site-init or startup file can
2678 redefine it.
2679 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2680 we do not remove backup version numbers, only true file version numbers."
2686 ;; VMS version number is (a) semicolon, optional
2687 ;; sign, zero or more digits or (b) period, option
2688 ;; sign, zero or more digits, provided this is the
2689 ;; second period encountered outside of the
2690 ;; device/directory part of the file name.
2693 name)
2703 "Return t if deleting FILE and rewriting it would preserve the owner."
2708 ;; Return t if the file doesn't exist, since it's true that no
2709 ;; information would be lost by an (attempted) delete and create.
2715 The extension, in a file name, is the part that follows the last `.',
2716 except that a leading `.', if any, doesn't count."
2719 directory)
2723 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2724 ;; we don't want to expand it.
2727 filename))))
2731 The extension, in a file name, is the part that follows the last `.',
2732 except that a leading `.', if any, doesn't count.
2733 Return nil for extensionless file names such as `foo'.
2734 Return the empty string for file names such as `foo.'.
2736 If PERIOD is non-nil, then the returned value includes the period
2737 that delimits the extension, and if FILENAME has no extension,
2748 "A function to use instead of the default `make-backup-file-name'.
2749 A value of nil gives the default `make-backup-file-name' behaviour.
2751 This could be buffer-local to do something special for specific
2752 files. If you define it, you may need to change `backup-file-name-p'
2753 and `file-name-sans-versions' too.
2755 See also `backup-directory-alist'."
2761 "Alist of filename patterns and backup directory names.
2762 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2763 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2764 relative or absolute. If it is absolute, so that all matching files
2765 are backed up into the same directory, the file names in this
2766 directory will be the full name of the file backed up with all
2767 directory separators changed to `!' to prevent clashes. This will not
2768 work correctly if your filesystem truncates the resulting name.
2770 For the common case of all backups going into one directory, the alist
2772 directory name.
2774 If this variable is nil, or it fails to match a filename, the backup
2775 is made in the original file's directory.
2777 On MS-DOS filesystems without long names this variable is always
2778 ignored."
2784 "Default `backup-enable-predicate' function.
2785 Checks for files in `temporary-file-directory' or
2786 `small-temporary-file-directory'."
2789 ;; Directory is under temporary-file-directory.
2794 0 nil
2796 ;; Directory is under small-temporary-file-directory.
2801 "Create the non-numeric backup file name for FILE.
2802 Normally this will just be the file's name with `~' appended.
2803 Customization hooks are provided as follows.
2805 If the variable `make-backup-file-name-function' is non-nil, its value
2806 should be a function which will be called with FILE as its argument;
2807 the resulting name is used.
2809 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2810 the documentation of that variable. If the directory for the backup
2811 doesn't exist, it is created."
2825 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2827 elt backup-directory)
2832 alist nil)))
2838 file
2842 ;; Normalize DOSish file names: downcase the drive
2843 ;; letter, if any, and replace the leading "x:" with
2844 ;; "/drive_x".
2847 ;; Replace any invalid file-name characters (for the
2848 ;; case of backing up remote files).
2852 "drive_"
2855 ""
2858 ;; Make the name unique by substituting directory
2859 ;; separators. It may not really be worth bothering about
2860 ;; doubling `!'s in the original name...
2865 backup-directory))
2872 "Return non-nil if FILE is a backup file name (numeric or not).
2873 This is a separate function so you can redefine it for customization.
2874 You may need to redefine `file-name-sans-versions' as well."
2879 ;; This is used in various files.
2880 ;; The usage of backup-extract-version-start is not very clean,
2881 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2883 "Given the name of a numeric backup file, FN, return the backup number.
2884 Uses the free variable `backup-extract-version-start', whose value should be
2885 the index in the name where the version number begins."
2891 ;; I believe there is no need to alter this behavior for VMS;
2892 ;; since backup files are not made on VMS, it should not get called.
2894 "Find a file name for a backup file FN, and suggestions for deletions.
2895 Value is a list whose car is the name for the backup file
2896 and whose cdr is a list of old versions to consider deleting now.
2897 If the value is nil, don't make a backup.
2898 Uses `backup-directory-alist' in the same way as does
2899 `make-backup-file-name'."
2901 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2905 ;; We don't support numbered backups on plain MS-DOS
2906 ;; when long file names are unavailable.
2916 possibilities deserve-versions-p versions)
2919 base-versions
2922 possibilities)
2923 #'<)
2928 kept-old-versions
2929 kept-new-versions
2936 ;; Delete nothing if there is overflow
2937 ;; in the number of versions to keep.
2943 v))))))))))
2946 "Return number of names file FILENAME has."
2949 ;; (defun file-relative-name (filename &optional directory)
2950 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2951 ;; This function returns a relative file name which is equivalent to FILENAME
2952 ;; when used with that default directory as the default.
2953 ;; If this is impossible (which can happen on MSDOS and Windows
2954 ;; when the file name and directory use different drive names)
2955 ;; then it returns FILENAME."
2956 ;; (save-match-data
2957 ;; (let ((fname (expand-file-name filename)))
2958 ;; (setq directory (file-name-as-directory
2959 ;; (expand-file-name (or directory default-directory))))
2960 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2961 ;; ;; drive names, they can't be relative, so return the absolute name.
2962 ;; (if (and (or (eq system-type 'ms-dos)
2963 ;; (eq system-type 'cygwin)
2964 ;; (eq system-type 'windows-nt))
2965 ;; (not (string-equal (substring fname 0 2)
2966 ;; (substring directory 0 2))))
2967 ;; filename
2968 ;; (let ((ancestor ".")
2969 ;; (fname-dir (file-name-as-directory fname)))
2970 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2971 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
2972 ;; (setq directory (file-name-directory (substring directory 0 -1))
2973 ;; ancestor (if (equal ancestor ".")
2974 ;; ".."
2975 ;; (concat "../" ancestor))))
2976 ;; ;; Now ancestor is empty, or .., or ../.., etc.
2977 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
2978 ;; ;; We matched within FNAME's directory part.
2979 ;; ;; Add the rest of FNAME onto ANCESTOR.
2980 ;; (let ((rest (substring fname (match-end 0))))
2981 ;; (if (and (equal ancestor ".")
2982 ;; (not (equal rest "")))
2983 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
2984 ;; rest
2985 ;; (concat (file-name-as-directory ancestor) rest)))
2986 ;; ;; We matched FNAME's directory equivalent.
2987 ;; ancestor))))))
2990 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2991 This function returns a relative file name which is equivalent to FILENAME
2992 when used with that default directory as the default.
2993 If FILENAME and DIRECTORY lie on different machines or on different drives
2994 on a DOS/Windows machine, it returns FILENAME on expanded form."
2998 default-directory))))
3004 ;; Test for different drives on DOS/Windows
3006 ;; Should `cygwin' really be included here? --stef
3009 ;; Test for different remote file system identification
3011 filename
3017 directory nil nil case-fold-search))
3019 directory nil nil case-fold-search))))
3022 ".."
3024 ;; Now ancestor is empty, or .., or ../.., etc.
3026 directory nil nil case-fold-search))
3027 ;; We matched within FILENAME's directory part.
3028 ;; Add the rest of FILENAME onto ANCESTOR.
3031 ;; But don't bother with ANCESTOR if it would give us `./'.
3032 rest
3034 ;; We matched FILENAME's directory equivalent.
3035 ancestor))))))
3036 \f
3038 "Save current buffer in visited file if modified. Versions described below.
3039 By default, makes the previous version into a backup file
3040 if previously requested or if this is the first save.
3042 to become a backup when the next save is done.
3044 unconditionally makes the previous version into a backup file.
3046 to become a backup when the next save is done,
3047 and unconditionally makes the previous version into a backup file.
3049 With argument of 0, never make the previous version into a backup file.
3051 If a file's name is FOO, the names of its numbered backup versions are
3052 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3053 Numeric backups (rather than FOO~) will be made if value of
3054 `version-control' is not the atom `never' and either there are already
3055 numeric versions of the file being backed up, or `version-control' is
3056 non-nil.
3057 We don't want excessive versions piling up, so there are variables
3058 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3059 and `kept-new-versions', which tells how many newest versions to keep.
3060 Defaults are 2 old versions and 2 new.
3061 `dired-kept-versions' controls dired's clean-directory (.) command.
3062 If `delete-old-versions' is nil, system will query user
3063 before trimming versions. Otherwise it does it silently.
3065 If `vc-make-backup-files' is nil, which is the default,
3066 no backup files are made for files managed by version control.
3067 (This is because the version control system itself records previous versions.)
3069 See the subroutine `basic-save-buffer' for more information."
3082 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3083 Normally delete only if the file was written by this Emacs since
3084 the last real save, but optional arg FORCE non-nil means delete anyway."
3098 "Normal hook that is run before a buffer is saved to its file."
3104 "Normal hook that is run after a buffer is saved to its file."
3110 "If non-nil, use this coding system for saving the buffer.
3111 More precisely, use this coding system in place of the
3112 value of `buffer-file-coding-system', when saving the buffer.
3113 Calling `write-region' for any purpose other than saving the buffer
3114 will still use `buffer-file-coding-system'; this variable has no effect
3121 "Save the current buffer in its visited file, if it has been modified.
3122 The hooks `write-contents-functions' and `write-file-functions' get a chance
3123 to do the job of saving; if they do not, then the buffer is saved in
3124 the visited file file in the usual way.
3125 Before and after saving the buffer, this function runs
3126 `before-save-hook' and `after-save-hook', respectively."
3129 ;; In an indirect buffer, save its base buffer instead.
3134 setmodes)
3135 ;; On VMS, rename file and buffer to get rid of version number.
3140 ;; Strip VMS version number before save.
3143 ;; Construct a (unique) buffer name to correspond.
3148 ;; If buffer has no file name, ask user for one.
3155 filename))
3180 ;; Support VC version backups.
3186 ;; If a hook returned t, file is already "written".
3187 ;; Otherwise, write it the usual way now.
3189 ;; Now we have saved the current buffer. Let's make sure
3190 ;; that buffer-file-coding-system is fixed to what
3191 ;; actually used for saving by binding it locally.
3201 ;; If the auto-save file was recent before this command,
3202 ;; delete it now.
3204 ;; Support VC `implicit' locking.
3209 ;; This does the "real job" of writing a buffer into its visited file
3210 ;; and making a backup file. This is what is normally done
3211 ;; but inhibited if one of write-file-functions returns non-nil.
3212 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3219 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3233 buffer-file-name)))
3241 ;; If file is precious, write temp name, then rename it.
3242 ;; This requires write access to the containing dir,
3243 ;; which is why we don't try it if we don't have that access.
3245 tempname nogood i succeed
3249 ;; Find the temporary name to write under.
3256 "%s$tmp$%d"
3258 dir i))
3264 tempname nil realname
3265 buffer-file-truename)
3267 ;; If writing the temp file fails,
3268 ;; delete the temp file.
3275 ;; Since we have created an entirely new file
3276 ;; and renamed it, make sure it gets the
3277 ;; right permission bits set.
3279 buffer-file-name)))
3280 ;; We succeeded in writing the temp file,
3281 ;; so rename it.
3283 ;; If file not writable, see if we can make it writable
3284 ;; temporarily while we write it.
3285 ;; But no need to do so if we have just backed it up
3286 ;; (setmodes is set) because that says we're superseding.
3288 ;; Change the mode back, after writing.
3295 buffer-file-name nil t buffer-file-truename)
3297 ;; If we get an error writing the new file, and we made
3298 ;; the backup by renaming, undo the backing-up.
3301 setmodes))
3304 "View the differences between BUFFER and its associated file.
3305 This requires the external program `diff' to be in your `exec-path'."
3320 ;; Display that message for 1 second so that user can read it
3321 ;; in the minibuffer.
3323 ;; return always nil, so that save-buffers-kill-emacs will not move
3324 ;; over to the next unsaved buffer when calling `d'.
3325 nil)
3328 '((?\C-r
3334 ;; Return nil to ask about BUF again.
3335 nil)
3337 (?d diff-buffer-with-file
3343 "Save some modified file-visiting buffers. Asks user about each one.
3344 You can answer `y' to save, `n' not to save, `C-r' to look at the
3345 buffer in question with `view-buffer' before deciding or `d' to
3346 view the differences using `diff-buffer-to-file'.
3348 Optional argument (the prefix) non-nil means save all with no questions.
3349 Optional second argument PRED determines which buffers are considered:
3350 If PRED is nil, all the file-visiting buffers are considered.
3351 If PRED is t, then certain non-file buffers will also be considered.
3352 If PRED is a zero-argument function, it indicates for each buffer whether
3353 to consider it or not when called with that buffer current.
3355 See `save-some-buffers-action-alist' if you want to
3356 change the additional actions you can take on files."
3375 t
3388 save-some-buffers-action-alist))
3395 abbrev-file-name)))
3397 ;; Don't keep bothering user if he says no.
3399 t))))
3402 \f
3404 "Mark current buffer as unmodified, not needing to be saved.
3407 It is not a good idea to use this function in Lisp programs, because it
3408 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3415 "Change whether this buffer is visiting its file read-only.
3416 With arg, set read-only iff arg is positive.
3417 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3422 nil ; do nothing.
3423 ;; Toggle.
3430 ;; If view-mode is already active, `view-mode-enter' is a nop.
3442 "Insert contents of file FILENAME into buffer after point.
3443 Set mark after the inserted text.
3445 This function is meant for the user to run interactively.
3446 Don't call it from programs! Use `insert-file-contents' instead.
3447 \(Its calling sequence is different; see its documentation)."
3452 "Append the contents of the region to the end of file FILENAME.
3453 When called from a function, expects three arguments,
3454 START, END and FILENAME. START and END are buffer positions
3455 saying what text to write."
3460 "Return most recent backup file for FILENAME or nil if no backups exist."
3461 ;; `make-backup-file-name' will get us the right directory for
3462 ;; ordinary or numeric backups. It might create a directory for
3463 ;; backups as a side-effect, according to `backup-directory-alist'.
3470 tem)
3479 newest))
3482 "Rename current buffer to a similar name not already taken.
3483 This function is useful for creating multiple shell process buffers
3484 or multiple mail buffers, etc."
3492 ;; If the existing buffer name has a <NNN>,
3493 ;; which isn't part of the file name (if any),
3494 ;; then get rid of that.
3500 "Create the directory DIR and any nonexistent parent dirs.
3501 Interactively, the default choice of directory to create
3502 is the current default directory for file names.
3503 That is useful when you have visited a file in a nonexistent directory.
3505 Noninteractively, the second (optional) argument PARENTS says whether
3506 to create parent directories if they don't exist. Interactively,
3507 this happens by default."
3510 nil nil)
3511 t))
3512 ;; If default-directory is a remote directory,
3513 ;; make sure we find its make-directory handler.
3521 create-list)
3528 \f
3531 "Function to use to revert this buffer, or nil to do the default.
3532 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3537 "Function to use to insert contents when reverting this buffer.
3538 Gets two args, first the nominal file name to use,
3539 and second, t if reading the auto-save file.
3544 "Function to check whether a non-file buffer needs reverting.
3545 This should be a function with one optional argument NOCONFIRM.
3546 Auto Revert Mode sets NOCONFIRM to t. The function should return
3547 non-nil if the buffer should be reverted. A return value of
3548 `fast' means that the need for reverting was not checked, but
3549 that reverting the buffer is fast. The buffer is current when
3550 this function is called.
3552 The idea behind the NOCONFIRM argument is that it should be
3553 non-nil if the buffer is going to be reverted without asking the
3554 user. In such situations, one has to be careful with potentially
3555 time consuming operations.
3557 For more information on how this variable is used by Auto Revert mode,
3561 "Normal hook for `revert-buffer' to run before reverting.
3562 If `revert-buffer-function' is used to override the normal revert
3566 "Normal hook for `revert-buffer' to run after reverting.
3567 Note that the hook value that it runs is the value that was in effect
3568 before reverting; that makes a difference if you have buffer-local
3569 hook functions.
3571 If `revert-buffer-function' is used to override the normal revert
3577 "Replace current buffer text with the text of the visited file on disk.
3578 This undoes all changes since the file was visited or saved.
3579 With a prefix argument, offer to revert from latest auto-save file, if
3580 that is more recent than the visited file.
3582 This command also works for special buffers that contain text which
3583 doesn't come from a file, but reflects some other data base instead:
3584 for example, Dired buffers and `buffer-list' buffers. In these cases,
3585 it reconstructs the buffer contents from the appropriate data base.
3587 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3588 to revert from the auto-save file when this is nil. Note that the
3589 sense of this argument is the reverse of the prefix argument, for the
3590 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3591 to nil.
3593 Optional second argument NOCONFIRM means don't ask for confirmation at
3594 all. (The local variable `revert-without-query', if non-nil, prevents
3595 confirmation.)
3597 Optional third argument PRESERVE-MODES non-nil means don't alter
3598 the files modes. Normally we reinitialize them using `normal-mode'.
3600 If the value of `revert-buffer-function' is non-nil, it is called to
3601 do all the work for this command. Otherwise, the hooks
3602 `before-revert-hook' and `after-revert-hook' are run at the beginning
3603 and the end, and if `revert-buffer-insert-file-contents-function' is
3604 non-nil, it is called instead of rereading visited file contents."
3606 ;; I admit it's odd to reverse the sense of the prefix argument, but
3607 ;; there is a lot of code out there which assumes that the first
3608 ;; argument should be t to avoid consulting the auto-save file, and
3609 ;; there's no straightforward way to encourage authors to notice a
3610 ;; reversal of the argument sense. So I'm just changing the user
3611 ;; interface, but leaving the programmatic interface the same.
3617 buffer-auto-save-file-name
3622 buffer-auto-save-file-name
3623 buffer-file-name)))
3634 found))
3636 file-name)))
3638 ;; If file was backed up but has changed since,
3639 ;; we shd make another backup.
3643 ;; Get rid of all undo records for this buffer.
3646 ;; Effectively copy the after-revert-hook status,
3647 ;; since after-find-file will clobber it.
3651 after-revert-hook)))
3653 ;; Don't make undo records for the reversion.
3657 file-name auto-save-p)
3660 "File %s no longer exists!"
3662 file-name))
3663 ;; Bind buffer-file-name to nil
3664 ;; so that we don't try to lock the file.
3670 ;; Auto-saved file shoule be read without
3671 ;; any code conversion.
3674 buffer-file-coding-system))))
3675 ;; This force after-insert-file-set-coding
3676 ;; (called from insert-file-contents) to set
3677 ;; buffer-file-coding-system to a proper value.
3680 ;; Note that this preserves point in an intelligent way.
3684 nil nil t))
3686 nil nil t)))))
3687 ;; Recompute the truename in case changes in symlinks
3688 ;; have changed the truename.
3692 ;; Run after-revert-hook as it was before we reverted.
3696 local-hook)
3699 t)))))
3702 "Recover the visited file--get contents from its last auto-save file."
3707 "Visit file FILE, but get contents from its last auto-save file."
3708 ;; Actually putting the file name in the minibuffer should be used
3709 ;; only rarely.
3710 ;; Not just because users often use the default.
3730 ;; Use insert-directory-safely, not insert-directory,
3731 ;; because these files might not exist. In particular,
3732 ;; FILE might not exist if the auto-save file was for
3733 ;; a buffer that didn't visit a file, such as "*mail*".
3734 ;; The code in v20.x called `ls' directly, so we need
3735 ;; to emulate what `ls' did in that case.
3741 ;; Keep the current buffer-file-coding-system.
3743 ;; Auto-saved file shoule be read with special coding.
3752 "Recover auto save files from a previous Emacs session.
3753 This command first displays a Dired buffer showing you the
3754 previous sessions that you could recover from.
3755 To choose one, move point to the proper line and then type C-c C-c.
3756 Then you'll be asked about a number of files to recover."
3766 auto-save-list-file-prefix)))
3767 t)
3776 ;; Each line starts with a space
3777 ;; so that Font Lock mode won't highlight the first character.
3786 "Choose one saved session to recover auto-save files from.
3787 This command is used in the special Dired buffer created by
3790 ;; Get the name of the session file to recover from.
3792 files
3798 ;; Read in the auto-save-list file.
3802 ;; Loop thru the text of that file
3803 ;; and get out the names of the files to recover.
3807 ;; This is a pair of lines for a non-file-visiting buffer.
3808 ;; Get the auto-save file name and manufacture
3809 ;; a "visited file name" from that.
3812 ;; If there is no auto-save file name, the
3813 ;; auto-save-list file is probably corrupted.
3828 ;; This pair of lines is a file-visiting
3829 ;; buffer. Use the visited file name.
3839 ;; Ignore a file if its auto-save file does not exist now.
3843 ;; The file contains a pair of line for each auto-saved buffer.
3844 ;; The first line of the pair contains the visited file name
3845 ;; or is empty if the buffer was not visiting a file.
3846 ;; The second line is the auto-save file name.
3854 files
3860 "Kill some buffers. Asks the user whether to kill each one of them.
3861 Non-interactively, if optional argument LIST is non-nil, it
3862 specifies the list of buffers to kill, asking for approval for each one."
3873 name
3878 \f
3880 "Toggle auto-saving of contents of current buffer.
3881 With prefix argument ARG, turn auto-saving on if positive, else off."
3886 ;; If auto-save is off because buffer has shrunk,
3887 ;; then toggling should turn it on.
3892 buffer-file-name
3894 ;; If -1 was stored here, to temporarily turn off saving,
3895 ;; turn it back on.
3901 buffer-auto-save-file-name)
3904 "Adjust current buffer's auto save file name for current conditions.
3905 Also rename any existing auto save file, if it was made in this session."
3917 "Return file name to use for auto-saves of current buffer.
3918 Does not consider `auto-save-visited-file-name' as that variable is checked
3919 before calling this function. You can redefine this for customization.
3920 See also `auto-save-file-name-p'."
3924 result uniq)
3925 ;; Apply user-specified translations
3926 ;; to the file name.
3930 filename)
3940 filename))))
3945 ;; We truncate the file name to DOS 8+3 limits
3946 ;; before doing anything else, because the regexp
3947 ;; passed to string-match below cannot handle
3948 ;; extensions longer than 3 characters, multiple
3949 ;; dots, and other atrocities.
3954 fn)
3959 "#"
3962 ;; Make sure auto-save file names don't contain characters
3963 ;; invalid for the underlying filesystem.
3965 ;; Don't modify remote (ange-ftp) filenames
3968 result))
3970 ;; Deal with buffers that don't have any associated files. (Mail
3971 ;; mode tends to create a good number of these.)
3975 file-name)
3976 ;; Eliminate all slashes and backslashes by
3977 ;; replacing them with sequences that start with %.
3978 ;; Quote % also, to keep distinct names distinct.
3987 ;; Generate the file name.
3993 ;; Try a few alternative directories, to get one we can
3994 ;; write it.
4000 ;; Don't modify remote (ange-ftp) filenames
4002 ;; The call to convert-standard-filename is in case
4003 ;; buffer-name includes characters not allowed by the
4004 ;; DOS/Windows filesystems. make-temp-file writes to the
4005 ;; file it creates, so we must fix the file name _before_
4006 ;; make-temp-file is called.
4008 fname))
4010 ;; make-temp-file creates the file,
4011 ;; but we don't want it to exist until we do an auto-save.
4015 file-name)))
4018 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4019 FILENAME should lack slashes. You can redefine this for customization."
4021 \f
4023 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4024 The generated regexp will match a filename iff the filename
4025 matches that wildcard according to shell rules. Only wildcards known
4026 by `sh' are supported."
4028 ;; Copy the initial run of non-special characters.
4031 ;; If no special characters, we're almost done.
4035 j)
4037 result
4058 ;; Found "[^". Insert a `\0' character
4059 ;; (which cannot happen in a filename)
4060 ;; into the character class, so that `^'
4061 ;; is not the first character after `[',
4062 ;; and thus non-special in a regexp.
4067 ;; I don't think `]' can appear in a
4068 ;; character class in a wildcard, but
4069 ;; let's be general here.
4076 i
4089 ;; Shell wildcards should match the entire filename,
4090 ;; not its part. Make the regexp say so.
4092 \f
4095 "*Switches for `list-directory' to pass to `ls' for brief listing."
4101 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4103 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4108 "Expand wildcard pattern PATTERN.
4109 This returns a list of file names which match the pattern.
4111 If PATTERN is written as an absolute file name,
4112 the values are absolute also.
4114 If PATTERN is written as a relative file name, it is interpreted
4115 relative to the current default directory, `default-directory'.
4116 The file names returned are normally also relative to the current
4117 default directory. However, if FULL is non-nil, they are absolute."
4121 ;; A list of all dirs that DIRPART specifies.
4122 ;; This can be more than one dir
4123 ;; if DIRPART contains wildcards.
4128 contents)
4133 ;; Filter out "." and ".."
4138 name))
4145 this-dir-contents)
4146 this-dir-contents)
4147 contents))))
4149 contents)))
4152 "Display a list of files in or matching DIRNAME, a la `ls'.
4153 DIRNAME is globbed by the shell if necessary.
4154 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4155 Actions controlled by variables `list-directory-brief-switches'
4156 and `list-directory-verbose-switches'."
4160 nil default-directory nil)
4161 pfx)))
4163 list-directory-brief-switches))
4164 buffer)
4177 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4185 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4187 PATTERN is assumed to represent a file-name wildcard suitable for the
4188 underlying filesystem. For Unix and GNU/Linux, the characters from the
4190 the parts of the pattern which don't include wildcard characters are
4191 quoted with double quotes.
4192 Existing quote characters in PATTERN are left alone, so you can pass
4193 PATTERN that already quotes some of the special characters."
4197 ;; DOS/Windows don't allow `"' in file names. So if the
4198 ;; argument has quotes, we can safely assume it is already
4199 ;; quoted by the caller.
4201 ;; We quote [&()#$'] in case their shell is a port of a
4202 ;; Unixy shell. We quote [,=+] because stock DOS and
4203 ;; Windows shells require that in some cases, such as
4204 ;; passing arguments to batch files that use positional
4205 ;; arguments like %1.
4207 pattern
4210 end)
4227 pattern))))
4234 "*Program to get the amount of free space on a file system.
4235 We assume the output has the format of `df'.
4236 The value of this variable must be just a command name or file name;
4237 if you want to specify options, use `directory-free-space-args'.
4239 A value of nil disables this feature.
4241 If the function `file-system-info' is defined, it is always used in
4242 preference to the program given by this variable."
4248 "*Options to use when running `directory-free-space-program'."
4253 "Return the mount of free space on directory DIR's file system.
4254 The result is a string that gives the number of free 1KB blocks,
4255 or nil if the system call or the program which retrieve the infornmation
4256 fail.
4258 This function calls `file-system-info' if it is available, or invokes the
4259 program specified by `directory-free-space-program' if that is non-nil."
4260 ;; Try to find the number of free blocks. Non-Posix systems don't
4261 ;; always have df, but might have an equivalent system call.
4270 nil t nil
4271 directory-free-space-args
4272 dir)))
4273 ;; Usual format is a header line followed by a line of
4274 ;; numbers.
4279 ;; Move to the end of the "available blocks" number.
4282 ;; Copy it into AVAILABLE.
4288 ;; insert-directory
4289 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4290 ;; FULL-DIRECTORY-P is nil.
4291 ;; The single line of output must display FILE's name as it was
4292 ;; given, namely, an absolute path name.
4293 ;; - must insert exactly one line for each file if WILDCARD or
4294 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4295 ;; before the file lines, plus optional text after the file lines.
4296 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4297 ;; allowed.
4298 ;; File lines should display the basename.
4299 ;; - must be consistent with
4300 ;; - functions dired-move-to-filename, (these two define what a file line is)
4301 ;; dired-move-to-end-of-filename,
4302 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4303 ;; dired-insert-headerline
4304 ;; dired-after-subdir-garbage (defines what a "total" line is)
4305 ;; - variable dired-subdir-regexp
4306 ;; - may be passed "--dired" as the first argument in SWITCHES.
4307 ;; Filename handlers might have to remove this switch if their
4308 ;; "ls" command does not support it.
4310 "Insert directory listing for FILE, formatted according to SWITCHES.
4311 Leaves point after the inserted text.
4312 SWITCHES may be a string of options, or a list of strings
4313 representing individual options.
4314 Optional third arg WILDCARD means treat FILE as shell wildcard.
4315 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4316 switches do not contain `d', so that a full listing is expected.
4318 This works by running a directory listing program
4319 whose name is in the variable `insert-directory-program'.
4320 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4322 When SWITCHES contains the long `--dired' option, this function
4323 treats it specially, for the sake of dired. However, the
4324 normally equivalent short `-D' option is just passed on to
4325 `insert-directory-program', as any other option."
4326 ;; We need the directory in order to find the right handler.
4331 wildcard full-directory-p)
4336 ;; Read the actual directory using `insert-directory-program'.
4337 ;; RESULT gets the status code.
4339 ;; putting text property `dired-filename, decode one
4340 ;; bunch by one to preserve that property.
4342 ;; This is to control encoding the arguments in call-process.
4346 default-file-name-coding-system))))
4349 ;; Run ls in the directory part of the file pattern
4350 ;; using the last component as argument.
4357 shell-file-name nil t nil
4358 "-c"
4360 ""
4362 insert-directory-program
4363 " -d "
4365 switches
4367 " -- "
4368 ;; Quote some characters that have
4369 ;; special meanings in shells; but
4370 ;; don't quote the wildcards--we want
4371 ;; them to be special. We also
4372 ;; currently don't quote the quoting
4373 ;; characters in case people want to
4374 ;; use them explicitly to quote
4375 ;; wildcard characters.
4377 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4378 ;; directory if FILE is a symbolic link.
4380 insert-directory-program nil t nil
4384 ;; Split the switches at any spaces so we can
4385 ;; pass separate options as separate args.
4387 ;; Avoid lossage if FILE starts with `-'.
4395 file))))))))
4397 ;; If `insert-directory-program' failed, signal an error.
4399 ;; Delete the error message it may have output.
4401 ;; On non-Posix systems, we cannot open a directory, so
4402 ;; don't even try, because that will always result in
4403 ;; the ubiquitous "Access denied". Instead, show the
4404 ;; command line so the user can try to guess what went wrong.
4409 insert-directory-program
4411 file result)
4412 ;; Unix. Access the file to get a suitable error.
4431 ;; End is followed by \n or by " -> ".
4433 ;; It seems that we can't trust ls's output as to
4434 ;; byte positions of filenames.
4445 ;; Now decode what read if necessary.
4447 file-name-coding-system
4448 default-file-name-coding-system
4450 coding-no-eol
4451 val pos)
4455 ;; If no coding system is specified or detection is
4456 ;; requested, detect the coding.
4470 ;; Force no eol conversion on a file name, so
4471 ;; that CR is preserved.
4479 ;; Try to insert the amount of free space.
4482 ;; First find the line to put it on.
4486 ;; Replace "total" with "used", to avoid confusion.
4493 "Insert directory listing for FILE, formatted according to SWITCHES.
4495 Like `insert-directory', but if FILE does not exist, it inserts a
4496 message to that effect instead of signaling an error."
4499 ;; Simulate the message printed by `ls'.
4503 "Functions to call with no arguments to query about killing Emacs.
4504 If any of these functions returns nil, killing Emacs is cancelled.
4506 but `kill-emacs', the low level primitive, does not.
4510 "How to ask for confirmation when leaving Emacs.
4511 If nil, the default, don't ask at all. If the value is non-nil, it should
4512 be a predicate function such as `yes-or-no-p'."
4520 "Offer to save each buffer, then kill this Emacs process.
4521 With prefix arg, silently save all file-visiting buffers, then kill."
4530 ;; process-list is not defined on VMS.
4532 active)
4541 ;; Query the user for other things, perhaps.
4546 \f
4547 ;; We use /: as a prefix to "quote" a file name
4548 ;; so that magic file name handlers will not apply to it.
4552 file-name-handler-alist))
4554 ;; We depend on being the last handler on the list,
4555 ;; so that anything else which does need handling
4556 ;; has been handled already.
4557 ;; So it is safe for us to inhibit *all* magic file name handlers.
4566 default-directory))
4567 ;; Get a list of the indices of the args which are file names.
4570 ;; The first six are special because they
4571 ;; return a file name. We want to include the /:
4572 ;; in the return value.
4573 ;; So just avoid stripping it in the first place.
4580 ;; `identity' means just return the first arg
4581 ;; not stripped of its quoting.
4583 ;; `add' means add "/:" to the result.
4585 ;; `quote' means add "/:" to buffer-file-name.
4587 ;; `unquote-then-quote' means set buffer-file-name
4588 ;; temporarily to unquoted filename.
4590 ;; List the arguments which are filenames.
4598 ;; For all other operations, treat the first argument only
4599 ;; as the file name.
4601 method
4602 ;; Copy ARGUMENTS so we can replace elements in it.
4606 ;; Strip off the /: from the file names that have it.
4614 "/"
4629 res))
4632 \f
4656 ;;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
4657 ;;; files.el ends here