| blob | 1ffd17eefd4039ff44f78291773b81bb1a323685 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
37 "Backups of edited data files."
41 "Finding files."
46 "*Non-nil means delete auto-save file when a buffer is saved or killed.
48 Note that the auto-save file will not be deleted if the buffer is killed
49 when it has unsaved changes."
54 nil
55 "*Alist of abbreviations for file directories.
56 A list of elements of the form (FROM . TO), each meaning to replace
57 FROM with TO when it appears in a directory name. This replacement is
58 done when setting up the default directory of a newly visited file.
59 *Every* FROM string should start with `^'.
61 Do not use `~' in the TO strings.
62 They should be ordinary absolute directory names.
64 Use this feature when you have directories which you normally refer to
65 via absolute symbolic links. Make TO the name of the link, and FROM
66 the name it is linked to."
74 ;; Turn off backup files on VMS since it has version numbers.
76 "*Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
105 "*Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
111 "*Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
118 "*Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
128 "*Non-nil means create backups by copying to preserve a privileged owner.
129 Renaming may still be used (subject to control of other variables)
130 when it would not result in changing the owner of the file or if the owner
131 has a user id greater than the value of this variable. This is useful
132 when low-numbered uid's are used for special system users (such as root)
133 that must maintain ownership of certain files.
134 This variable is relevant only if `backup-by-copying' and
135 `backup-by-copying-when-mismatch' are nil."
140 "Predicate that looks at a file name and decides whether to make backups.
144 "*Non-nil in a buffer means always offer to save buffer on exit.
145 Do so even if the buffer is not visiting a file.
146 Automatically local in all buffers."
152 "*Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
159 "*Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
166 "*Specify which files should be reverted without query.
167 The value is a list of regular expressions.
168 If the file name matches one of these regular expressions,
169 then `revert-buffer' reverts the file without querying
170 if the file has changed on disk and you have not edited the buffer."
175 "The device number and file number of the file visited in the current buffer.
176 The value is a list of the form (FILENUM DEVNUM).
177 This pair of numbers uniquely identifies the file.
197 "The directory for writing temporary files."
203 "The directory for writing small temporary files.
204 If non-nil, this directory is used instead of `temporary-file-directory'
205 by programs that create small temporary files. This is for systems that
206 have fast storage with limited space, such as a RAM disk."
210 ;; The system null device. (Should reference NULL_DEVICE from C.)
227 "*Non-nil means protect against I/O errors while saving files.
228 Some modes set this non-nil in particular buffers.
230 This feature works by writing the new contents into a temporary file
231 and then renaming the temporary file to replace the original.
232 In this way, any I/O error in writing leaves the original untouched,
233 and there is never any instant where the file is nonexistent.
235 Note that this feature forces backups to be made by copying.
236 Yet, at the same time, saving a precious file
237 breaks any hard links between it and other files."
242 "*Control use of version numbers for backup files.
243 t means make numeric backup versions unconditionally.
244 nil means make them for files that have some already.
245 `never' means do not make them."
253 "*When cleaning directory, number of versions to keep."
259 "*If t, delete excess backup versions silently.
260 If nil, ask confirmation. Any other value prevents any trimming."
267 "*Number of oldest versions to keep when a new numbered backup is made."
272 "*Number of newest versions to keep when a new numbered backup is made.
273 Includes the new backup. Must be > 0"
278 "*Whether to add a newline automatically at the end of the file.
280 A value of t means do this only when the file is about to be saved.
281 A value of `visit' means do this right after the file is visited.
282 A value of `visit-save' means do it at both of those times.
283 Any other non-nil value means ask user whether to add a newline, when saving.
284 nil means don't add newlines.
286 Certain major modes set this locally to the value obtained
287 from `mode-require-final-newline'."
296 "*Whether to add a newline at end of file, in certain major modes.
297 Those modes set `require-final-newline' to this value when you enable them.
298 They do so because they are often used for files that are supposed
299 to end in newlines, and the question is how to arrange that.
301 A value of t means do this only when the file is about to be saved.
302 A value of `visit' means do this right after the file is visited.
303 A value of `visit-save' means do it at both of those times.
304 Any other non-nil value means ask user whether to add a newline, when saving.
306 nil means do not add newlines. That is a risky choice in this variable
307 since this value is used for modes for files that ought to have final newlines.
308 So if you set this to nil, you must explicitly check and add
309 a final newline, whenever you save a file that really needs one."
319 "*Non-nil says by default do auto-saving of every file-visiting buffer."
324 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
325 Normally auto-save files are written under other names."
331 ;; Don't put "\\2" inside expand-file-name, since it will be
332 ;; transformed to "/2" on DOS/Windows.
334 "*Transforms to apply to buffer file name before making auto-save file name.
335 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
336 REGEXP is a regular expression to match against the file name.
337 If it matches, `replace-match' is used to replace the
338 matching part with REPLACEMENT.
339 If the optional element UNIQUIFY is non-nil, the auto-save file name is
340 constructed by taking the directory part of the replaced file-name,
341 concatenated with the buffer file name with all directory separators
342 changed to `!' to prevent clashes. This will not work
343 correctly if your filesystem truncates the resulting name.
345 All the transforms in the list are tried, in the order they are listed.
346 When one transform applies, its result is final;
347 no further transforms are tried.
349 The default value is set up to put the auto-save file into the
350 temporary directory (see the variable `temporary-file-directory') for
351 editing a remote file.
353 On MS-DOS filesystems without long names this variable is always
354 ignored."
361 "*Non-nil means save word abbrevs too when files are saved.
362 If `silently', don't ask the user before saving."
367 "*Non-nil means allow `find-file' to visit directories.
368 To visit the directory, `find-file' runs `find-directory-functions'."
373 "*List of functions to try in sequence to visit a directory.
374 Each function is called with the directory name as the sole argument
375 and should return either a buffer or nil."
379 ;;;It is not useful to make this a local variable.
380 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
382 "List of functions to be called for `find-file' on nonexistent file.
383 These functions are called as soon as the error is detected.
384 Variable `buffer-file-name' is already set up.
389 ;;;It is not useful to make this a local variable.
390 ;;;(put 'find-file-hooks 'permanent-local t)
392 "List of functions to be called after a buffer is loaded from a file.
393 The buffer's local variables (if any) will have been processed before the
394 functions are called."
402 "List of functions to be called before writing out a buffer to a file.
403 If one of them returns non-nil, the file is considered already written
404 and the rest are not called.
405 These hooks are considered to pertain to the visited file.
406 So any buffer-local binding of this variable is discarded if you change
408 change the major mode.
410 This hook is not run if any of the functions in
411 `write-contents-functions' returns non-nil. Both hooks pertain
412 to how to save a buffer to file, for instance, choosing a suitable
413 coding system and setting mode bits. (See Info
414 node `(elisp)Saving Buffers'.) To perform various checks or
425 "List of functions to be called before writing out a buffer to a file.
426 If one of them returns non-nil, the file is considered already written
427 and the rest are not called and neither are the functions in
428 `write-file-functions'.
430 This variable is meant to be used for hooks that pertain to the
431 buffer's contents, not to the particular visited file; thus,
432 `set-visited-file-name' does not clear this variable; but changing the
433 major mode does clear it.
435 For hooks that _do_ pertain to the particular visited file, use
436 `write-file-functions'. Both this variable and
437 `write-file-functions' relate to how a buffer is saved to file.
438 To perform various checks or updates before the buffer is saved,
445 "*Control use of local variables in files you visit.
446 The value can be t, nil or something else.
447 A value of t means file local variables specifications are obeyed;
448 nil means they are ignored; anything else means query.
449 This variable also controls use of major modes specified in
450 a -*- line.
453 always obeys file local variable specifications and the -*- line,
454 and ignores this variable."
461 "Like `enable-local-variables' but meant for buffer-local bindings.
462 The meaningful values are nil and non-nil. The default is non-nil.
463 If a major mode sets this to nil, buffer-locally, then any local
464 variables list in the file will be ignored.
466 This variable does not affect the use of major modes
471 The value can be t, nil or something else.
472 A value of t means obey `eval' variables;
473 nil means ignore them; anything else means query."
479 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
488 "*Non-nil means buffers visiting files read-only do so in view mode.
489 In fact, this means that all read-only buffers normally have
490 View mode enabled, including buffers that are read-only because
491 you visit a file you cannot alter, and buffers you make read-only
498 "Provides support for ange-ftp host name completion.
499 Runs the usual ange-ftp hook, but only for completion operations."
500 ;; Having this here avoids the need to load ange-ftp when it's not
501 ;; really in use.
507 inhibit-file-name-handlers)))
512 "Convert a standard file's name to something suitable for the OS.
513 This means to guarantee valid names and perhaps to canonicalize
514 certain patterns.
516 FILENAME should be an absolute file name since the conversion rules
517 sometimes vary depending on the position in the file name. E.g. c:/foo
518 is a valid DOS file name, but c:/bar/c:/foo is not.
520 This function's standard definition is trivial; it just returns
521 the argument. However, on Windows and DOS, replace invalid
522 characters. On DOS, make sure to obey the 8.3 limitations. On
523 Windows, turn Cygwin names into native names, and also turn
524 slashes into backslashes if the shell requires it (see
525 `w32-shell-dos-semantics').
527 See Info node `(elisp)Standard File Names' for more details."
528 filename)
531 "Read directory name, prompting with PROMPT and completing in directory DIR.
532 Value is not expanded---you must call `expand-file-name' yourself.
533 Default name to DEFAULT-DIRNAME if user exits with the same
534 non-empty string that was inserted by this function.
535 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
536 or just DIR if INITIAL is nil.)
537 If the user exits with an empty minibuffer, this function returns
538 an empty string. (This can only happen if the user erased the
539 pre-inserted contents or if `insert-default-directory' is nil.)
540 Fourth arg MUSTMATCH non-nil means require existing directory's name.
541 Non-nil and non-t means also require confirmation after completion.
542 Fifth arg INITIAL specifies text to start with.
543 DIR should be an absolute directory name. It defaults to
544 the value of `default-directory'."
549 dir))
550 mustmatch initial
553 \f
555 "Show the current default directory."
560 "Value of the CDPATH environment variable, as a list.
564 "Explode a search path into a list of directory names.
565 Directories are separated by occurrences of `path-separator'
566 \(which is colon in GNU and GNU-like systems)."
567 ;; We could use split-string here.
575 nil
580 cd-list)))
583 "Change current directory to given absolute file name DIR."
584 ;; Put the name into directory syntax now,
585 ;; because otherwise expand-file-name may give some bad results.
598 "Make DIR become the current buffer's default directory.
599 If your environment includes a `CDPATH' variable, try each one of
600 that list of directories (separated by occurrences of
601 `path-separator') when resolving a relative directory name.
602 The path separator is colon in GNU and GNU-like systems."
605 default-directory default-directory
621 cd-path)
622 nil))
626 "Load the Lisp file named FILE."
627 ;; This is a case where .elc makes a lot of sense.
634 "Search for FILENAME through PATH.
635 If found, return the absolute file name of FILENAME, with its suffixes;
636 otherwise return nil.
637 PATH should be a list of directories to look in, like the lists in
638 `exec-path' or `load-path'.
639 If SUFFIXES is non-nil, it should be a list of suffixes to append to
642 If non-nil, PREDICATE is used instead of `file-readable-p'.
643 PREDICATE can also be an integer to pass to the `access' system call,
644 in which case file-name handlers are ignored. This usage is deprecated.
646 For compatibility, PREDICATE can also be one of the symbols
647 `executable', `readable', `writable', or `exists', or a list of
648 one or more of those symbols."
659 "Do completion for file names passed to `locate-file'.
660 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
683 "Search for COMMAND in `exec-path' and return the absolute file name.
684 Return nil if COMMAND is not found anywhere in `exec-path'."
685 ;; Use 1 rather than file-executable-p to better match the behavior of
686 ;; call-process.
690 "Load the library named LIBRARY.
691 This is an interface to the function `load'."
694 'locate-file-completion
699 "Test whether FILE specifies a location on a remote system.
700 Return an identification of the system if the location is indeed
701 remote. The identification of the system may comprise a method
702 to access the system and its hostname, amongst other things.
709 nil)))
712 "Copy the file FILE into a temporary file on this machine.
713 Returns the name of the local copy, or nil, if FILE is directly
714 accessible."
715 ;; This formerly had an optional BUFFER argument that wasn't used by
716 ;; anything.
720 nil)))
723 "Return the truename of FILENAME, which should be absolute.
724 The truename of a file name is found by chasing symbolic links
725 both at the level of the file and at the level of the directories
726 containing it, until no links are left at any level.
729 ;; COUNTER and PREV-DIRS are only used in recursive calls.
730 ;; COUNTER can be a cons cell whose car is the count of how many
731 ;; more links to chase before getting an error.
732 ;; PREV-DIRS can be a cons cell whose car is an alist
733 ;; of truenames we've just recently computed.
747 ;; For speed, remove the ange-ftp completion handler from the list.
748 ;; We know it's not needed here.
749 ;; For even more speed, do this only on the outermost call.
756 ;; andrewi@harlequin.co.uk - none of the following code (except for
757 ;; invoking the file-name handler) currently applies on Windows
758 ;; (ie. there are no native symlinks), but there is an issue with
759 ;; case differences being ignored by the OS, and short "8.3 DOS"
760 ;; name aliases existing for all files. (The short names are not
761 ;; reported by directory-files, but can be used to refer to files.)
762 ;; It seems appropriate for file-truename to resolve these issues in
763 ;; the most natural way, which on Windows is to call the function
764 ;; `w32-long-file-name' - this returns the exact name of a file as
765 ;; it is stored on disk (expanding short name aliases with the full
766 ;; name in the process).
769 ;; For file name that has a special handler, call handler.
770 ;; This is so that ange-ftp can save time by doing a no-op.
773 ;; If filename contains a wildcard, newname will be the old name.
775 ;; If filename exists, use the long name
779 ;; If this file directly leads to a link, process that iteratively
780 ;; so that we don't use lots of stack.
786 ;; For file name that has a special handler, call handler.
787 ;; This is so that ange-ftp can save time by doing a no-op.
790 done t)
792 target dirfile)
793 ;; Get the truename of the directory.
795 ;; If these are equal, we have the (or a) root directory.
797 ;; If this is the same dir we last got the truename for,
798 ;; save time--don't recalculate.
808 done t)
811 done t)
812 ;; Put it back on the file name.
814 ;; Is the file name the name of a link?
817 ;; Yes => chase that link, then start all over
818 ;; since the link may point to a directory name that uses links.
819 ;; We can't safely use expand-file-name here
820 ;; since target might look like foo/../bar where foo
821 ;; is itself a link. Instead, we handle . and .. above.
824 target
826 done nil)
827 ;; No, we are done!
829 filename))
832 "Chase links in FILENAME until a name that is not a link.
833 Unlike `file-truename', this does not check whether a parent
834 directory name is a symbolic link.
835 If the optional argument LIMIT is a number,
836 it means chase no more than that many links and then stop."
844 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
847 ;; Handle `..' by hand, since it needs to work in the
848 ;; target of any directory symlink.
849 ;; This code is not quite complete; it does not handle
850 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
854 ;; Chase links in the default dir of the symlink.
858 ;; Now find the parent of that dir.
862 newname))
865 "Change the encoding of FILE's name from CODING to NEW-CODING.
866 The value is a new name of FILE.
867 Signals a `file-already-exists' error if a file of the new name
868 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
869 is non-nil. A number as fourth arg means request confirmation if
870 the new name already exists. This is what happens in interactive
871 use with M-x."
874 default-file-name-coding-system))
876 from-coding to-coding)
878 ;; We provide the default coding only when it seems that
879 ;; the filename is correctly decoded by the default
880 ;; coding.
886 filename default-coding)
887 default-coding))
891 ;; We provide the default coding only when a user is going to
892 ;; change the encoding not from the default coding.
896 filename from-coding)))
899 filename from-coding default-coding)
900 default-coding)))
904 default-file-name-coding-system))
905 ;; FILE should have been decoded by DEFAULT-CODING.
909 ;; Suppress further encoding.
914 newname))
915 \f
917 "Select buffer BUFFER in another window.
918 If BUFFER does not identify an existing buffer, then this function
919 creates a buffer with that name.
921 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
922 or nil. If BUFFER is nil, then this function chooses a buffer
923 using `other-buffer'.
924 Optional second arg NORECORD non-nil means
925 do not put this buffer at the front of the list of recently selected ones.
926 This function returns the buffer it switched to.
928 This uses the function `display-buffer' as a subroutine; see its
929 documentation for additional customization information."
932 ;; Don't let these interfere.
933 same-window-buffer-names same-window-regexps)
937 "Switch to buffer BUFFER in another frame.
938 Optional second arg NORECORD non-nil means
939 do not put this buffer at the front of the list of recently selected ones.
941 This uses the function `display-buffer' as a subroutine; see its
942 documentation for additional customization information."
945 same-window-buffer-names same-window-regexps)
953 "Add FUN to `minibuffer-setup-hook' while executing BODY.
954 BODY should use the minibuffer at most once.
955 Recursive uses of the minibuffer will not be affected."
961 ;; Clear out this hook so it does not interfere
962 ;; with any recursive minibuffer usage.
978 t))
981 "Edit file FILENAME.
982 Switch to a buffer visiting file FILENAME,
983 creating one if none already exists.
984 Interactively, the default if you just type RET is the current directory,
985 but the visited file name is available through the minibuffer history:
986 type M-n to pull it into the minibuffer.
988 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
989 expand wildcards (if any) and visit multiple files. You can
990 suppress wildcard expansion by setting `find-file-wildcards'.
992 To visit a file without any kind of conversion and without
1001 "Edit file FILENAME, in another window.
1002 May create a new window, or reuse an existing one.
1003 See the function `display-buffer'.
1005 Interactively, the default if you just type RET is the current directory,
1006 but the visited file name is available through the minibuffer history:
1007 type M-n to pull it into the minibuffer.
1009 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1010 expand wildcards (if any) and visit multiple files."
1021 "Edit file FILENAME, in another frame.
1022 May create a new frame, or reuse an existing one.
1023 See the function `display-buffer'.
1025 Interactively, the default if you just type RET is the current directory,
1026 but the visited file name is available through the minibuffer history:
1027 type M-n to pull it into the minibuffer.
1029 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1030 expand wildcards (if any) and visit multiple files."
1041 "Edit the existing file FILENAME.
1049 "Edit file FILENAME but don't allow changes.
1061 value))
1064 "Edit file FILENAME in another window but don't allow changes.
1076 value))
1079 "Edit file FILENAME in another frame but don't allow changes.
1091 value))
1094 "Find file FILENAME as a replacement for the file in the next window.
1095 This command does not select that window.
1097 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1098 expand wildcards (if any) and replace the file with multiple files."
1110 t))))
1118 "Find file FILENAME, select its buffer, kill previous buffer.
1119 If the current buffer now contains an empty file that you just visited
1120 \(presumably by mistake), use this command to visit the file you really want.
1122 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1123 expand wildcards (if any) and replace the file with multiple files."
1133 t)))
1154 ;; This prevents us from finding the same buffer
1155 ;; if we specified the same file again.
1159 ;; Likewise for dired buffers.
1163 ;; This executes if find-file gets an error
1164 ;; and does not really find anything.
1165 ;; We put things back as they were.
1166 ;; If find-file actually finds something, we kill obuf below.
1175 ;; We already asked; don't ask again.
1178 \f
1180 "Create a suitably named buffer for visiting FILENAME, and return it.
1181 FILENAME (sans directory) is used unchanged if that name is free;
1182 otherwise a string <2> or <3> or ... is appended to get an unused name."
1189 "Create and return a buffer with a name based on NAME.
1190 Choose the buffer's name using `generate-new-buffer-name'."
1194 "Regexp to match the automounter prefix in a directory name."
1202 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1204 removes automounter prefixes (see the variable `automount-dir-prefix')."
1205 ;; Get rid of the prefixes added by the automounter.
1212 ;; If any elt of directory-abbrev-alist matches this name,
1213 ;; abbreviate accordingly.
1219 ;; Compute and save the abbreviated homedir name.
1220 ;; We defer computing this until the first time it's needed, to
1221 ;; give time for directory-abbrev-alist to be set properly.
1222 ;; We include a slash at the end, to avoid spurious matches
1223 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1230 ;; If FILENAME starts with the abbreviated homedir,
1231 ;; make it start with `~' instead.
1233 ;; If the home dir is just /, don't change it.
1236 ;; MS-DOS root directories can come with a drive letter;
1237 ;; Novell Netware allows drive letters beyond `Z:'.
1247 filename))
1250 "*List of logical names for which visiting shouldn't save the true dirname.
1251 On VMS, when you visit a file using a logical name that searches a path,
1252 you may or may not want the visited file name to record the specific
1253 directory where the file was found. If you *do not* want that, add the logical
1254 name to this list as a string."
1259 "Return the buffer visiting file FILENAME (a string).
1260 This is like `get-file-buffer', except that it checks for any buffer
1261 visiting the same file, possibly under a different name.
1262 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1263 and others are ignored.
1264 If there is no such live buffer, return nil."
1278 found)
1283 number
1288 ;; Verify this buffer's file number
1289 ;; still belongs to its file.
1292 attributes)
1296 found))))
1297 \f
1299 "*Non-nil means file-visiting commands should handle wildcards.
1300 For example, if you specify `*.c', that would visit all the files
1301 whose names match the pattern."
1307 "*Non-nil means suppress warning messages for symlinked files.
1308 When nil, Emacs prints a warning when visiting a file that is already
1309 visited, but with a different name. Setting this option to t
1310 suppresses this warning."
1316 "Maximum size of file above which a confirmation is requested.
1317 When nil, never request confirmation."
1324 "Read file FILENAME into a buffer and return the buffer.
1325 If a buffer exists visiting FILENAME, return that one, but
1326 verify that the file has not changed since visited or saved.
1327 The buffer is not selected, just returned to the caller.
1328 Optional second arg NOWARN non-nil means suppress any warning messages.
1329 Optional third arg RAWFILE non-nil means the file is read literally.
1330 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1331 and visit all the matching files. When wildcards are actually
1332 used and expanded, return a list of buffers that are visiting
1333 the various files."
1340 'find-directory-functions
1343 filename)))
1346 find-file-wildcards
1360 ;; Find any buffer for a file which has same truename.
1362 ;; Let user know if there is a buffer with the same truename.
1366 find-file-suppress-same-file-warnings
1370 ;; Optionally also find that buffer.
1373 ;; Check to see if the file looks uncommonly large.
1375 ;; Don't ask again if we already have the file or
1376 ;; if we're asked to be quiet.
1385 ;; We are using an existing buffer.
1391 ;; Certain files should be reverted automatically
1392 ;; if they have changed on disk and not in the buffer.
1400 found))
1410 "File %s changed on disk. Discard your edits? "
1415 "File %s changed on disk. Discard your edits in %s? "
1423 ;; Check if a formerly read-only file has become
1424 ;; writable and vice versa, but if the buffer agrees
1425 ;; with the new state of the file, that is ok too.
1432 buffer-file-name
1440 ;; It is confusing to ask whether to visit
1441 ;; non-literally if they have the file in
1442 ;; hexl-mode.
1446 "Save file and revisit literally? "
1451 rawfile truename number))
1453 "Discard your edits and revisit file literally? "
1456 rawfile truename number)
1460 "Revisit file literally? "
1463 rawfile truename number)
1466 ;; Return the buffer we are using.
1467 buf)
1468 ;; Create a new buffer.
1470 ;; find-file-noselect-1 may use a different buffer.
1472 rawfile truename number))))))
1478 ;; Needed in case we are re-visiting the file with a different
1479 ;; text representation.
1496 filename)))
1497 ;; Unconditionally set error
1507 filename)))
1508 ;; Run find-file-not-found-hooks until one returns non-nil.
1510 ;; If they fail too, set error.
1512 ;; Record the file's truename, and maybe use that as visited name.
1518 ;; On VMS, we may want to remember which directory in a search list
1519 ;; the file was found in.
1531 ;; Set buffer's default directory to that of the file.
1533 ;; Turn off backup files for certain file names. Since
1534 ;; this is a permanent local, the major mode won't eliminate it.
1548 \f
1550 "Like `insert-file-contents', but only reads in the file literally.
1551 A buffer may be modified in several ways after reading into the buffer,
1552 to Emacs features such as format decoding, character code
1553 conversion, `find-file-hook', automatic uncompression, etc.
1555 This function ensures that none of these modifications will take place."
1563 nil))
1566 inhibit-file-name-handlers))
1579 filename)))
1589 "Insert contents of file FILENAME into buffer after point with no conversion.
1591 This function is meant for the user to run interactively.
1592 Don't call it from programs! Use `insert-file-contents-literally' instead.
1593 \(Its calling sequence is different; see its documentation)."
1598 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1603 "Visit file FILENAME with no conversion of any kind.
1604 Format conversion and character code conversion are both disabled,
1605 and multibyte characters are disabled in the resulting buffer.
1606 The major mode used is Fundamental mode regardless of the file name,
1607 and local variable specifications in the file are ignored.
1608 Automatic uncompression and adding a newline at the end of the
1609 file due to `require-final-newline' is also disabled.
1611 You cannot absolutely rely on this function to result in
1612 visiting the file literally. If Emacs already has a buffer
1613 which is visiting the file, you get the existing buffer,
1614 regardless of whether it was created literally or not.
1616 In a Lisp program, if you want to be sure of accessing a file's
1617 contents literally, you should create a temporary buffer and then read
1618 the file contents into it using `insert-file-contents-literally'."
1621 \f
1625 after-find-file-from-revert-buffer
1626 nomodes)
1627 "Called after finding a file and by the default revert function.
1628 Sets buffer mode, parses local variables.
1629 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1630 error in reading the file. WARN non-nil means warn if there
1631 exists an auto-save file more recent than the visited file.
1632 NOAUTO means don't mess with auto-save mode.
1633 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1634 means this call was from `revert-buffer'.
1635 Fifth arg NOMODES non-nil means don't alter the file's modes.
1636 Finishes by calling the functions in `find-file-hook'
1637 unless NOMODES is non-nil."
1640 nil
1650 ;; No need to warn if buffer is auto-saved
1651 ;; under the name of the visited file.
1653 auto-save-visited-file-name))
1656 buffer-file-name))
1676 ;; Make people do a little extra work (C-x C-q)
1677 ;; before altering a backup file.
1680 ;; When a file is marked read-only,
1681 ;; make the buffer read-only even if root is looking at it.
1689 ;; If requested, add a newline at the end of the file.
1699 view-read-only
1705 "Eval BODY and turn any error into a FORMAT message.
1706 FORMAT can have a %s escape which will be replaced with the actual error.
1707 If `debug-on-error' is set, errors are not caught, so that you can
1708 debug them.
1709 Avoid using a large BODY since it is duplicated."
1718 "Choose the major mode for this buffer automatically.
1719 Also sets up any specified local variables of the file.
1720 Uses the visited file name, the -*- line, and the local variables spec.
1722 This function is called automatically from `find-file'. In that case,
1723 we may set up the file-specified mode and local variables,
1724 depending on the value of `enable-local-variables': if it is t, we do;
1725 if it is nil, we don't; otherwise, we query.
1726 In addition, if `local-enable-local-variables' is nil, we do
1727 not set local variables (though we do notice a mode specified with -*-.)
1729 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1730 or from Lisp without specifying the optional argument FIND-FILE;
1731 in that case, this function acts as if `enable-local-variables' were t."
1739 ;; Turn font lock off and on, to make sure it takes account of
1740 ;; whatever file local variables are relevant to it.
1749 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1750 ;; c++-mode, java-mode and more) are added through autoload
1751 ;; directives in that file. That way is discouraged since it
1752 ;; spreads out the definition of the initial value.
1782 ;; Less common extensions come here
1783 ;; so more common ones above are found faster.
1822 ;; The list of archive file extensions should be in sync with
1823 ;; `auto-coding-alist' with `no-conversion' coding system.
1827 ;; Mailer puts message to be edited in
1828 ;; /tmp/Re.... or Message
1833 ;; some news reader is reported to use this
1842 ;; .emacs or .gnus or .viper following a directory delimiter in
1843 ;; Unix, MSDOG or VMS syntax.
1846 ;; _emacs following a directory delimiter
1847 ;; in MsDos syntax
1866 ;; Windows candidates may be opened case sensitively on Unix
1872 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1874 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1875 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
1876 ;; either user's dot-files or under /etc or some such
1878 ;; alas not all ~/.*rc files are like this
1879 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1884 ;; this contains everything twice, with space and with colon :-(
1886 ;; Get rid of any trailing .n.m and try again.
1887 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1888 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1889 ;; Using mode nil rather than `ignore' would let the search continue
1890 ;; through this list (with the shortened name) rather than start over.
1892 ;; The following should come after the ChangeLog pattern
1893 ;; for the sake of ChangeLog.1, etc.
1894 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1897 "Alist of filename patterns vs corresponding major mode functions.
1898 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1899 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1900 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1901 mode function to use. FUNCTION will be called, unless it is nil.
1903 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1904 calling FUNCTION (if it's not nil), we delete the suffix that matched
1905 REGEXP and search the list again for another match.
1907 If the file name matches `inhibit-first-line-modes-regexps',
1908 then `auto-mode-alist' is not processed.
1910 See also `interpreter-mode-alist', which detects executable script modes
1911 based on the interpreters they specify to run,
1915 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1916 ;; and pike-mode) are added through autoload directives in that
1917 ;; file. That way is discouraged since it spreads out the
1918 ;; definition of the initial value.
1956 "Alist mapping interpreter names to major modes.
1957 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
1958 Each element looks like (INTERPRETER . MODE).
1959 If INTERPRETER matches the name of the interpreter specified in the first line
1960 of a script, mode MODE is enabled.
1968 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1969 When checking `inhibit-first-line-modes-regexps', we first discard
1975 "Regexp matching interpreters, for file mode determination.
1976 This regular expression is matched against the first line of a file
1977 to determine the file's mode in `set-auto-mode'. If it matches, the file
1978 is assumed to be interpreted by the interpreter matched by the second group
1979 of the regular expression. The mode is then determined as the mode
1984 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
1988 comment-re "*"
1991 . html-mode)
1992 ;; These two must come after html, because they are more general:
1997 . sgml-mode)
2000 "Alist of buffer beginnings vs. corresponding major mode functions.
2001 Each element looks like (REGEXP . FUNCTION). After visiting a file,
2002 if REGEXP matches the text at the beginning of the buffer,
2003 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
2004 to decide the buffer's major mode.
2006 If FUNCTION is nil, then it is not called. (That is a way of saying
2010 "Select major mode appropriate for current buffer.
2012 This checks for a -*- mode tag in the buffer's text, checks the
2013 interpreter that runs this file against `interpreter-mode-alist',
2014 compares the buffer beginning against `magic-mode-alist', or
2015 compares the filename against the entries in `auto-mode-alist'.
2017 It does not check for the `mode:' local variable in the
2018 Local Variables section of the file; for that, use `hack-local-variables'.
2020 If `enable-local-variables' is nil, this function does not check for a
2021 -*- mode tag.
2023 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2024 only set the major mode, if that would change it."
2025 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2027 ;; Find a -*- mode tag
2034 ;; Find all specifications for the `mode:' variable
2035 ;; and execute them left to right.
2047 modes)))
2048 ;; Simple -*-MODE-*- case.
2051 modes))))
2052 ;; If we found modes to use, invoke them now, outside the save-excursion.
2060 ;; continuing would call minor modes again, toggling them off
2062 ;; If we didn't, look for an interpreter specified in the first line.
2063 ;; As a special case, allow for things like "#!/bin/env perl", which
2064 ;; finds the interpreter anywhere in $PATH.
2070 ;; Map interpreter name to a mode, signalling we're done at the
2071 ;; same time.
2073 interpreter-mode-alist))
2074 ;; If we found an interpreter mode to use, invoke it now.
2077 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2085 ;; Compare the filename against the entries in auto-mode-alist.
2088 ;; Remove backup-suffixes from file name.
2091 ;; Find first matching alist entry.
2104 ;; When `keep-mode-if-same' is set, we are working on behalf of
2105 ;; set-visited-file-name. In that case, if the major mode specified is the
2106 ;; same one we already have, don't actually reset it. We don't want to lose
2107 ;; minor modes such as Font Lock.
2109 "Apply MODE and return it.
2110 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2111 any aliases and compared to current major mode. If they are the
2112 same, do nothing and return nil."
2120 mode))
2123 "Find the -*- spec in the buffer.
2124 Call with point at the place to start searching from.
2125 If one is found, set point to the beginning
2126 and return the position of the end.
2127 Otherwise, return nil; point may be changed."
2130 ;; Don't look for -*- if this file name matches any
2131 ;; of the regexps in inhibit-first-line-modes-regexps.
2139 sufs)
2147 ;; If the file begins with "#!"
2148 ;; (exec interpreter magic), look
2149 ;; for mode frobs in the first two
2150 ;; lines. You cannot necessarily
2151 ;; put them in the first line of
2152 ;; such a file without screwing up
2153 ;; the interpreter invocation.
2164 end))))
2173 ;; If we fail to switch in the selected window,
2174 ;; it is probably a minibuffer or dedicated window.
2175 ;; So try another window.
2177 ;; Refrain from popping up frames since it can't
2178 ;; be undone by save-window-excursion.
2189 "Set local variables specified in the -*- line.
2190 Ignore any specification for `mode:' and `coding:';
2191 `set-auto-mode' should already have handled `mode:',
2192 `set-auto-coding' should already have handled `coding:'.
2193 If MODE-ONLY is non-nil, all we do is check whether the major mode
2194 is specified, returning t if it is specified."
2199 mode-specified
2202 ;; Parse the -*- line into the RESULT alist.
2203 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2205 nil)
2207 ;; Simple form: "-*- MODENAME -*-". Already handled.
2209 nil)
2211 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2212 ;; (last ";" is optional).
2217 ;; There used to be a downcase here,
2218 ;; but the manual didn't say so,
2219 ;; and people want to set var names that aren't all lc.
2226 ;; It is traditional to ignore
2227 ;; case when checking for `mode' in set-auto-mode,
2228 ;; so we must do that here as well.
2229 ;; That is inconsistent, but we're stuck with it.
2230 ;; The same can be said for `coding' in set-auto-coding.
2243 "Set local variables as specified in -*- line of %s? "
2244 enable-local-variables)))
2249 nil))))
2252 "Normal hook run after processing a file's local variables specs.
2253 Major modes can use this to examine user-specified local variables
2257 "Parse and put into effect this buffer's local variables spec.
2258 If MODE-ONLY is non-nil, all we do is check whether the major mode
2259 is specified, returning t if it is specified."
2261 ;; If MODE-ONLY is t, we check here for specifying the mode
2262 ;; in the -*- line. If MODE-ONLY is nil, we process
2263 ;; the -*- line here.
2267 ;; Look for "Local variables:" line in last page.
2275 "Set local variables as specified at end of %s? "
2276 enable-local-variables))))
2279 ;; suffix is what comes after "local variables:" in its line.
2284 ;; prefix is what comes before "local variables:" in its line.
2289 beg)
2293 endpos
2299 nil t))
2309 ;; Discard the prefix.
2314 ;; Discard the suffix.
2322 ;; Find the variable name; strip whitespace.
2330 val)
2331 ;; Read the variable value.
2338 ;; Set the variable. "Variables" mode and eval are funny.
2344 mode-specified))
2349 ;; Get confirmation before setting these variables as locals in a file.
2374 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2404 ;; This case is safe because the user gets to check it before it is used.
2408 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2409 If VAL is nil or omitted, the question is whether any value might be
2410 dangerous."
2413 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2416 ;; If the safe-local-variable property isn't t or nil,
2417 ;; then it must return non-nil on the proposed value to be safe.
2424 Add expressions to this list if you want Emacs to evaluate them, when
2425 they appear in an `eval' local variable specification, without first
2426 asking you for confirmation."
2443 "Return t if it is safe to eval EXP when it is found in a file."
2445 ;; Detect certain `put' expressions.
2451 ;; Only allow safe values of lisp-indent-hook;
2452 ;; not functions.
2455 ;; Allow expressions that the user requested.
2457 ;; Certain functions can be allowed with safe arguments
2458 ;; or can specify verification functions to try.
2466 ok))
2474 ok)))))))
2478 A few patterns are specified so that any name which matches one
2479 is considered risky."
2484 ;; We have already handled coding: tag in set-auto-coding.
2485 nil)
2487 nil)
2488 ;; "Setting" eval means either eval it or do nothing.
2489 ;; Likewise for setting hook variables.
2491 ;; Permit evalling a put of a harmless property.
2492 ;; if the args do nothing tricky.
2495 ;; Permit eval if not root and user says ok.
2498 "Process `eval' or hook local variables in %s? "
2499 enable-local-eval)))
2505 ;; Ordinary variable, really set it.
2507 ;; Make sure the string has no text properties.
2508 ;; Some text properties can get evaluated in various ways,
2509 ;; so it is risky to put them on with a local variable list.
2514 \f
2517 However, the mode will not be changed if
2518 \(1) a local variables list or the `-*-' line specifies a major mode, or
2520 \ not suitable for ordinary files, or
2521 \(3) the new file name does not particularly specify any mode."
2526 "Change name of file visited in current buffer to FILENAME.
2527 The next time the buffer is saved it will go in the newly specified file.
2528 FILENAME nil or an empty string means make buffer not be visiting any file.
2529 Remember to delete the initial contents of the minibuffer
2530 if you wish to pass an empty string as the argument.
2532 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2533 confirmation in the case where another buffer is already visiting FILENAME.
2535 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2536 the old visited file has been renamed to the new name FILENAME."
2544 nil
2559 filename)))
2571 ;; If new-name == old-name, renaming would add a spurious <2>
2572 ;; and it's considered as a feature in rename-buffer.
2578 ;; Abbreviate the file names of the buffer.
2587 nil)))
2588 ;; write-file-functions is normally used for things like ftp-find-file
2589 ;; that visit things that are not local files as if they were files.
2590 ;; Changing to visit an ordinary local file instead should flush the hook.
2595 ;; If buffer was read-only because of version control,
2596 ;; that reason is gone now, so make it writable.
2600 ;; Turn off backup files for certain file names.
2601 ;; Since this is a permanent local, the major mode won't eliminate it.
2608 ;; If auto-save was not already on, turn it on if appropriate.
2612 ;; If auto save is on, start using a new name.
2613 ;; We deliberately don't rename or delete the old auto save
2614 ;; for the old visited file name. This is because perhaps
2615 ;; the user wants to save the new state and then compare with the
2616 ;; previous state from the auto save file.
2619 ;; Rename the old auto save file if any.
2626 ;; Update the major mode, if the file name determines it.
2628 ;; Don't change the mode if it is special.
2631 ;; Don't change the mode if the local variable list specifies it.
2637 "Write current buffer into file FILENAME.
2638 This makes the buffer visit that file, and marks it as not modified.
2640 If you specify just a directory name as FILENAME, that means to use
2641 the default file name but in that directory. You can also yank
2642 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2644 If the buffer is not already visiting a file, the default file name
2645 for the output file is the buffer name.
2647 If optional second arg CONFIRM is non-nil, this function
2648 asks for confirmation before overwriting an existing file.
2649 Interactively, confirmation is required unless you supply a prefix argument."
2650 ;; (interactive "FWrite file: ")
2654 nil nil nil nil)
2658 default-directory)
2659 nil nil))
2663 ;; If arg is just a directory,
2664 ;; use the default file name, but in that directory.
2675 ;; Make buffer writable if file is writable.
2680 \f
2682 "Make a backup of the disk file visited by the current buffer, if appropriate.
2683 This is normally done before saving the buffer the first time.
2685 A backup may be done by renaming or by copying; see documentation of
2686 variable `make-backup-files'. If it's done by renaming, then the file is
2687 no longer accessible under its old name.
2689 The value is non-nil after a backup was made by renaming.
2690 It has the form (MODES . BACKUPNAME).
2691 MODES is the result of `file-modes' on the original
2692 file; this means that the caller, after saving the buffer, should change
2693 the modes of the new file to agree with the old modes.
2694 BACKUPNAME is the backup file name, which is the old file renamed."
2701 backup-info backupname targets setmodes)
2702 ;; If specified name is a symbolic link, chase it to the target.
2703 ;; Thus we make the backups in the directory where the real file is.
2708 ;; (if (file-directory-p buffer-file-name)
2709 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2713 ;; If have old versions to maybe delete,
2714 ;; ask the user to confirm now, before doing anything.
2715 ;; But don't actually delete til later.
2720 real-file-name)))))
2722 ;; Actually write the back up file.
2725 ; (file-symlink-p buffer-file-name)
2726 backup-by-copying
2727 ;; Don't rename a suid or sgid file.
2742 ;; rename-file should delete old backup.
2746 ;; If trouble writing the backup, write it in ~.
2755 ;; Now delete the old versions, if desired.
2762 setmodes)
2769 ;; Create temp files with strict access rights. It's easy to
2770 ;; loosen them later, whereas it's impossible to close the
2771 ;; time-window of loose permissions otherwise.
2779 nil)
2781 ;; The file was somehow created by someone else between
2782 ;; `delete-file' and `copy-file', so let's try again.
2783 nil))
2784 ;; Reset the umask.
2790 "Return file NAME sans backup versions or strings.
2791 This is a separate procedure so your site-init or startup file can
2792 redefine it.
2793 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2794 we do not remove backup version numbers, only true file version numbers."
2800 ;; VMS version number is (a) semicolon, optional
2801 ;; sign, zero or more digits or (b) period, option
2802 ;; sign, zero or more digits, provided this is the
2803 ;; second period encountered outside of the
2804 ;; device/directory part of the file name.
2807 name)
2817 "Return t if deleting FILE and rewriting it would preserve the owner."
2822 ;; Return t if the file doesn't exist, since it's true that no
2823 ;; information would be lost by an (attempted) delete and create.
2829 The extension, in a file name, is the part that follows the last `.',
2830 except that a leading `.', if any, doesn't count."
2833 directory)
2837 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2838 ;; we don't want to expand it.
2841 filename))))
2845 The extension, in a file name, is the part that follows the last `.',
2846 except that a leading `.', if any, doesn't count.
2847 Return nil for extensionless file names such as `foo'.
2848 Return the empty string for file names such as `foo.'.
2850 If PERIOD is non-nil, then the returned value includes the period
2851 that delimits the extension, and if FILENAME has no extension,
2862 "A function to use instead of the default `make-backup-file-name'.
2863 A value of nil gives the default `make-backup-file-name' behavior.
2865 This could be buffer-local to do something special for specific
2866 files. If you define it, you may need to change `backup-file-name-p'
2867 and `file-name-sans-versions' too.
2869 See also `backup-directory-alist'."
2875 "Alist of filename patterns and backup directory names.
2876 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2877 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2878 relative or absolute. If it is absolute, so that all matching files
2879 are backed up into the same directory, the file names in this
2880 directory will be the full name of the file backed up with all
2881 directory separators changed to `!' to prevent clashes. This will not
2882 work correctly if your filesystem truncates the resulting name.
2884 For the common case of all backups going into one directory, the alist
2886 directory name.
2888 If this variable is nil, or it fails to match a filename, the backup
2889 is made in the original file's directory.
2891 On MS-DOS filesystems without long names this variable is always
2892 ignored."
2898 "Default `backup-enable-predicate' function.
2899 Checks for files in `temporary-file-directory',
2900 `small-temporary-file-directory', and /tmp."
2903 ;; Directory is under temporary-file-directory.
2908 ;; Directory is under /tmp.
2913 0 nil
2915 ;; Directory is under small-temporary-file-directory.
2920 "Create the non-numeric backup file name for FILE.
2921 Normally this will just be the file's name with `~' appended.
2922 Customization hooks are provided as follows.
2924 If the variable `make-backup-file-name-function' is non-nil, its value
2925 should be a function which will be called with FILE as its argument;
2926 the resulting name is used.
2928 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2929 the documentation of that variable. If the directory for the backup
2930 doesn't exist, it is created."
2944 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2946 elt backup-directory)
2951 alist nil)))
2957 file
2961 ;; Normalize DOSish file names: downcase the drive
2962 ;; letter, if any, and replace the leading "x:" with
2963 ;; "/drive_x".
2966 ;; Replace any invalid file-name characters (for the
2967 ;; case of backing up remote files).
2971 "drive_"
2974 ""
2977 ;; Make the name unique by substituting directory
2978 ;; separators. It may not really be worth bothering about
2979 ;; doubling `!'s in the original name...
2984 backup-directory))
2991 "Return non-nil if FILE is a backup file name (numeric or not).
2992 This is a separate function so you can redefine it for customization.
2993 You may need to redefine `file-name-sans-versions' as well."
2998 ;; This is used in various files.
2999 ;; The usage of backup-extract-version-start is not very clean,
3000 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3002 "Given the name of a numeric backup file, FN, return the backup number.
3003 Uses the free variable `backup-extract-version-start', whose value should be
3004 the index in the name where the version number begins."
3010 ;; I believe there is no need to alter this behavior for VMS;
3011 ;; since backup files are not made on VMS, it should not get called.
3013 "Find a file name for a backup file FN, and suggestions for deletions.
3014 Value is a list whose car is the name for the backup file
3015 and whose cdr is a list of old versions to consider deleting now.
3016 If the value is nil, don't make a backup.
3017 Uses `backup-directory-alist' in the same way as does
3018 `make-backup-file-name'."
3020 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3024 ;; We don't support numbered backups on plain MS-DOS
3025 ;; when long file names are unavailable.
3035 possibilities deserve-versions-p versions)
3038 base-versions
3041 possibilities)
3042 #'<)
3047 kept-old-versions
3048 kept-new-versions
3055 ;; Delete nothing if there is overflow
3056 ;; in the number of versions to keep.
3062 v))))))))))
3065 "Return number of names file FILENAME has."
3068 ;; (defun file-relative-name (filename &optional directory)
3069 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3070 ;; This function returns a relative file name which is equivalent to FILENAME
3071 ;; when used with that default directory as the default.
3072 ;; If this is impossible (which can happen on MSDOS and Windows
3073 ;; when the file name and directory use different drive names)
3074 ;; then it returns FILENAME."
3075 ;; (save-match-data
3076 ;; (let ((fname (expand-file-name filename)))
3077 ;; (setq directory (file-name-as-directory
3078 ;; (expand-file-name (or directory default-directory))))
3079 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3080 ;; ;; drive names, they can't be relative, so return the absolute name.
3081 ;; (if (and (or (eq system-type 'ms-dos)
3082 ;; (eq system-type 'cygwin)
3083 ;; (eq system-type 'windows-nt))
3084 ;; (not (string-equal (substring fname 0 2)
3085 ;; (substring directory 0 2))))
3086 ;; filename
3087 ;; (let ((ancestor ".")
3088 ;; (fname-dir (file-name-as-directory fname)))
3089 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3090 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3091 ;; (setq directory (file-name-directory (substring directory 0 -1))
3092 ;; ancestor (if (equal ancestor ".")
3093 ;; ".."
3094 ;; (concat "../" ancestor))))
3095 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3096 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3097 ;; ;; We matched within FNAME's directory part.
3098 ;; ;; Add the rest of FNAME onto ANCESTOR.
3099 ;; (let ((rest (substring fname (match-end 0))))
3100 ;; (if (and (equal ancestor ".")
3101 ;; (not (equal rest "")))
3102 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3103 ;; rest
3104 ;; (concat (file-name-as-directory ancestor) rest)))
3105 ;; ;; We matched FNAME's directory equivalent.
3106 ;; ancestor))))))
3109 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3110 This function returns a relative file name which is equivalent to FILENAME
3111 when used with that default directory as the default.
3112 If FILENAME and DIRECTORY lie on different machines or on different drives
3113 on a DOS/Windows machine, it returns FILENAME on expanded form."
3117 default-directory))))
3123 ;; Test for different drives on DOS/Windows
3125 ;; Should `cygwin' really be included here? --stef
3128 ;; Test for different remote file system identification
3130 filename
3136 directory nil nil case-fold-search))
3138 directory nil nil case-fold-search))))
3141 ".."
3143 ;; Now ancestor is empty, or .., or ../.., etc.
3145 directory nil nil case-fold-search))
3146 ;; We matched within FILENAME's directory part.
3147 ;; Add the rest of FILENAME onto ANCESTOR.
3150 ;; But don't bother with ANCESTOR if it would give us `./'.
3151 rest
3153 ;; We matched FILENAME's directory equivalent.
3154 ancestor))))))
3155 \f
3157 "Save current buffer in visited file if modified. Variations are described below.
3158 By default, makes the previous version into a backup file
3159 if previously requested or if this is the first save.
3161 to become a backup when the next save is done.
3163 unconditionally makes the previous version into a backup file.
3165 to become a backup when the next save is done,
3166 and unconditionally makes the previous version into a backup file.
3168 With a numeric argument of 0, never make the previous version
3169 into a backup file.
3171 If a file's name is FOO, the names of its numbered backup versions are
3172 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3173 Numeric backups (rather than FOO~) will be made if value of
3174 `version-control' is not the atom `never' and either there are already
3175 numeric versions of the file being backed up, or `version-control' is
3176 non-nil.
3177 We don't want excessive versions piling up, so there are variables
3178 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3179 and `kept-new-versions', which tells how many newest versions to keep.
3180 Defaults are 2 old versions and 2 new.
3181 `dired-kept-versions' controls dired's clean-directory (.) command.
3182 If `delete-old-versions' is nil, system will query user
3183 before trimming versions. Otherwise it does it silently.
3185 If `vc-make-backup-files' is nil, which is the default,
3186 no backup files are made for files managed by version control.
3187 (This is because the version control system itself records previous versions.)
3189 See the subroutine `basic-save-buffer' for more information."
3202 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3203 Normally delete only if the file was written by this Emacs since
3204 the last real save, but optional arg FORCE non-nil means delete anyway."
3218 "Normal hook that is run before a buffer is saved to its file."
3224 "Normal hook that is run after a buffer is saved to its file."
3230 "If non-nil, use this coding system for saving the buffer.
3231 More precisely, use this coding system in place of the
3232 value of `buffer-file-coding-system', when saving the buffer.
3233 Calling `write-region' for any purpose other than saving the buffer
3234 will still use `buffer-file-coding-system'; this variable has no effect
3241 "Save the current buffer in its visited file, if it has been modified.
3242 The hooks `write-contents-functions' and `write-file-functions' get a chance
3243 to do the job of saving; if they do not, then the buffer is saved in
3244 the visited file in the usual way.
3245 Before and after saving the buffer, this function runs
3246 `before-save-hook' and `after-save-hook', respectively."
3249 ;; In an indirect buffer, save its base buffer instead.
3254 setmodes)
3255 ;; On VMS, rename file and buffer to get rid of version number.
3260 ;; Strip VMS version number before save.
3263 ;; Construct a (unique) buffer name to correspond.
3268 ;; If buffer has no file name, ask user for one.
3275 filename))
3301 ;; Support VC version backups.
3307 ;; If a hook returned t, file is already "written".
3308 ;; Otherwise, write it the usual way now.
3310 ;; Now we have saved the current buffer. Let's make sure
3311 ;; that buffer-file-coding-system is fixed to what
3312 ;; actually used for saving by binding it locally.
3322 ;; If the auto-save file was recent before this command,
3323 ;; delete it now.
3325 ;; Support VC `implicit' locking.
3330 ;; This does the "real job" of writing a buffer into its visited file
3331 ;; and making a backup file. This is what is normally done
3332 ;; but inhibited if one of write-file-functions returns non-nil.
3333 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3342 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3356 buffer-file-name)))
3364 ;; If file is precious, write temp name, then rename it.
3365 ;; This requires write access to the containing dir,
3366 ;; which is why we don't try it if we don't have that access.
3368 tempname succeed
3371 ;; Create temp files with strict access rights. It's easy to
3372 ;; loosen them later, whereas it's impossible to close the
3373 ;; time-window of loose permissions otherwise.
3378 ;; Try various temporary names.
3379 ;; This code follows the example of make-temp-file,
3380 ;; but it calls write-region in the appropriate way
3381 ;; for saving the buffer.
3388 tempname nil realname
3390 nil)
3392 ;; The file was somehow created by someone else between
3393 ;; `make-temp-name' and `write-region', let's try again.
3394 nil)
3396 ;; Reset the umask.
3398 ;; If we failed, restore the buffer's modtime.
3401 ;; Since we have created an entirely new file,
3402 ;; make sure it gets the right permission bits set.
3404 buffer-file-name)))
3405 ;; We succeeded in writing the temp file,
3406 ;; so rename it.
3408 ;; If file not writable, see if we can make it writable
3409 ;; temporarily while we write it.
3410 ;; But no need to do so if we have just backed it up
3411 ;; (setmodes is set) because that says we're superseding.
3413 ;; Change the mode back, after writing.
3420 buffer-file-name nil t buffer-file-truename)
3422 ;; If we get an error writing the new file, and we made
3423 ;; the backup by renaming, undo the backing-up.
3426 setmodes))
3429 "View the differences between BUFFER and its associated file.
3430 This requires the external program `diff' to be in your `exec-path'."
3445 ;; Display that message for 1 second so that user can read it
3446 ;; in the minibuffer.
3448 ;; return always nil, so that save-buffers-kill-emacs will not move
3449 ;; over to the next unsaved buffer when calling `d'.
3450 nil)
3453 '((?\C-r
3459 ;; Return nil to ask about BUF again.
3460 nil)
3462 (?d diff-buffer-with-file
3472 "Save some modified file-visiting buffers. Asks user about each one.
3473 You can answer `y' to save, `n' not to save, `C-r' to look at the
3474 buffer in question with `view-buffer' before deciding or `d' to
3475 view the differences using `diff-buffer-with-file'.
3477 Optional argument (the prefix) non-nil means save all with no questions.
3478 Optional second argument PRED determines which buffers are considered:
3479 If PRED is nil, all the file-visiting buffers are considered.
3480 If PRED is t, then certain non-file buffers will also be considered.
3481 If PRED is a zero-argument function, it indicates for each buffer whether
3482 to consider it or not when called with that buffer current.
3484 See `save-some-buffers-action-alist' if you want to
3485 change the additional actions you can take on files."
3489 files-done abbrevs-done)
3491 ;; First save any buffers that we're supposed to save unconditionally.
3492 ;; That way the following code won't ask about them.
3497 ;; Ask about those buffers that merit it,
3498 ;; and record the number thus saved.
3514 t
3527 save-some-buffers-action-alist))
3528 ;; Maybe to save abbrevs, and record whether
3529 ;; we either saved them or asked to.
3535 abbrev-file-name)))
3537 ;; Don't keep bothering user if he says no.
3542 "(Some special files were saved without asking)"
3544 \f
3546 "Mark current buffer as unmodified, not needing to be saved.
3549 It is not a good idea to use this function in Lisp programs, because it
3550 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3557 "Change whether this buffer is visiting its file read-only.
3558 With arg, set read-only iff arg is positive.
3559 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3564 nil ; do nothing.
3565 ;; Toggle.
3572 ;; If view-mode is already active, `view-mode-enter' is a nop.
3584 "Insert contents of file FILENAME into buffer after point.
3585 Set mark after the inserted text.
3587 This function is meant for the user to run interactively.
3588 Don't call it from programs! Use `insert-file-contents' instead.
3589 \(Its calling sequence is different; see its documentation)."
3594 "Append the contents of the region to the end of file FILENAME.
3595 When called from a function, expects three arguments,
3596 START, END and FILENAME. START and END are buffer positions
3597 saying what text to write."
3602 "Return most recent backup file for FILENAME or nil if no backups exist."
3603 ;; `make-backup-file-name' will get us the right directory for
3604 ;; ordinary or numeric backups. It might create a directory for
3605 ;; backups as a side-effect, according to `backup-directory-alist'.
3612 tem)
3621 newest))
3624 "Rename current buffer to a similar name not already taken.
3625 This function is useful for creating multiple shell process buffers
3626 or multiple mail buffers, etc."
3634 ;; If the existing buffer name has a <NNN>,
3635 ;; which isn't part of the file name (if any),
3636 ;; then get rid of that.
3642 "Create the directory DIR and any nonexistent parent dirs.
3643 Interactively, the default choice of directory to create
3644 is the current default directory for file names.
3645 That is useful when you have visited a file in a nonexistent directory.
3647 Noninteractively, the second (optional) argument PARENTS says whether
3648 to create parent directories if they don't exist. Interactively,
3649 this happens by default."
3652 nil nil)
3653 t))
3654 ;; If default-directory is a remote directory,
3655 ;; make sure we find its make-directory handler.
3663 create-list)
3670 \f
3673 "Function to use to revert this buffer, or nil to do the default.
3674 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3679 "Function to use to insert contents when reverting this buffer.
3680 Gets two args, first the nominal file name to use,
3681 and second, t if reading the auto-save file.
3686 "Function to check whether a non-file buffer needs reverting.
3687 This should be a function with one optional argument NOCONFIRM.
3688 Auto Revert Mode passes t for NOCONFIRM. The function should return
3689 non-nil if the buffer should be reverted. A return value of
3690 `fast' means that the need for reverting was not checked, but
3691 that reverting the buffer is fast. The buffer is current when
3692 this function is called.
3694 The idea behind the NOCONFIRM argument is that it should be
3695 non-nil if the buffer is going to be reverted without asking the
3696 user. In such situations, one has to be careful with potentially
3697 time consuming operations.
3699 For more information on how this variable is used by Auto Revert mode,
3703 "Normal hook for `revert-buffer' to run before reverting.
3704 If `revert-buffer-function' is used to override the normal revert
3708 "Normal hook for `revert-buffer' to run after reverting.
3709 Note that the hook value that it runs is the value that was in effect
3710 before reverting; that makes a difference if you have buffer-local
3711 hook functions.
3713 If `revert-buffer-function' is used to override the normal revert
3719 "Replace current buffer text with the text of the visited file on disk.
3720 This undoes all changes since the file was visited or saved.
3721 With a prefix argument, offer to revert from latest auto-save file, if
3722 that is more recent than the visited file.
3724 This command also works for special buffers that contain text which
3725 doesn't come from a file, but reflects some other data base instead:
3726 for example, Dired buffers and `buffer-list' buffers. In these cases,
3727 it reconstructs the buffer contents from the appropriate data base.
3729 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3730 to revert from the auto-save file when this is nil. Note that the
3731 sense of this argument is the reverse of the prefix argument, for the
3732 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3733 to nil.
3735 Optional second argument NOCONFIRM means don't ask for confirmation at
3736 all. (The local variable `revert-without-query', if non-nil, prevents
3737 confirmation.)
3739 Optional third argument PRESERVE-MODES non-nil means don't alter
3740 the files modes. Normally we reinitialize them using `normal-mode'.
3742 If the value of `revert-buffer-function' is non-nil, it is called to
3743 do all the work for this command. Otherwise, the hooks
3744 `before-revert-hook' and `after-revert-hook' are run at the beginning
3745 and the end, and if `revert-buffer-insert-file-contents-function' is
3746 non-nil, it is called instead of rereading visited file contents."
3748 ;; I admit it's odd to reverse the sense of the prefix argument, but
3749 ;; there is a lot of code out there which assumes that the first
3750 ;; argument should be t to avoid consulting the auto-save file, and
3751 ;; there's no straightforward way to encourage authors to notice a
3752 ;; reversal of the argument sense. So I'm just changing the user
3753 ;; interface, but leaving the programmatic interface the same.
3761 buffer-auto-save-file-name
3766 buffer-auto-save-file-name
3767 buffer-file-name)))
3778 found))
3780 file-name)))
3782 ;; If file was backed up but has changed since,
3783 ;; we shd make another backup.
3787 ;; Get rid of all undo records for this buffer.
3790 ;; Effectively copy the after-revert-hook status,
3791 ;; since after-find-file will clobber it.
3795 after-revert-hook)))
3797 ;; Don't make undo records for the reversion.
3801 file-name auto-save-p)
3804 "File %s no longer exists!"
3806 file-name))
3807 ;; Bind buffer-file-name to nil
3808 ;; so that we don't try to lock the file.
3814 ;; Auto-saved file shoule be read by Emacs'
3815 ;; internal coding.
3818 buffer-file-coding-system-explicit))))
3819 ;; This force after-insert-file-set-coding
3820 ;; (called from insert-file-contents) to set
3821 ;; buffer-file-coding-system to a proper value.
3824 ;; Note that this preserves point in an intelligent way.
3828 nil nil t))
3830 nil nil t)))))
3831 ;; Recompute the truename in case changes in symlinks
3832 ;; have changed the truename.
3836 ;; Run after-revert-hook as it was before we reverted.
3840 local-hook)
3843 t))))))
3846 "Recover the visited file--get contents from its last auto-save file."
3851 "Visit file FILE, but get contents from its last auto-save file."
3852 ;; Actually putting the file name in the minibuffer should be used
3853 ;; only rarely.
3854 ;; Not just because users often use the default.
3874 ;; Use insert-directory-safely, not insert-directory,
3875 ;; because these files might not exist. In particular,
3876 ;; FILE might not exist if the auto-save file was for
3877 ;; a buffer that didn't visit a file, such as "*mail*".
3878 ;; The code in v20.x called `ls' directly, so we need
3879 ;; to emulate what `ls' did in that case.
3885 ;; Keep the current buffer-file-coding-system.
3887 ;; Auto-saved file shoule be read with special coding.
3896 "Recover auto save files from a previous Emacs session.
3897 This command first displays a Dired buffer showing you the
3898 previous sessions that you could recover from.
3899 To choose one, move point to the proper line and then type C-c C-c.
3900 Then you'll be asked about a number of files to recover."
3910 auto-save-list-file-prefix)))
3911 t)
3920 ;; Each line starts with a space
3921 ;; so that Font Lock mode won't highlight the first character.
3930 "Choose one saved session to recover auto-save files from.
3931 This command is used in the special Dired buffer created by
3934 ;; Get the name of the session file to recover from.
3936 files
3942 ;; Read in the auto-save-list file.
3946 ;; Loop thru the text of that file
3947 ;; and get out the names of the files to recover.
3951 ;; This is a pair of lines for a non-file-visiting buffer.
3952 ;; Get the auto-save file name and manufacture
3953 ;; a "visited file name" from that.
3956 ;; If there is no auto-save file name, the
3957 ;; auto-save-list file is probably corrupted.
3972 ;; This pair of lines is a file-visiting
3973 ;; buffer. Use the visited file name.
3983 ;; Ignore a file if its auto-save file does not exist now.
3987 ;; The file contains a pair of line for each auto-saved buffer.
3988 ;; The first line of the pair contains the visited file name
3989 ;; or is empty if the buffer was not visiting a file.
3990 ;; The second line is the auto-save file name.
3998 files
4004 "Kill some buffers. Asks the user whether to kill each one of them.
4005 Non-interactively, if optional argument LIST is non-nil, it
4006 specifies the list of buffers to kill, asking for approval for each one."
4014 ; if we killed the base buffer.
4019 name
4024 \f
4026 "Toggle auto-saving of contents of current buffer.
4027 With prefix argument ARG, turn auto-saving on if positive, else off."
4032 ;; If auto-save is off because buffer has shrunk,
4033 ;; then toggling should turn it on.
4038 buffer-file-name
4040 ;; If -1 was stored here, to temporarily turn off saving,
4041 ;; turn it back on.
4047 buffer-auto-save-file-name)
4050 "Adjust current buffer's auto save file name for current conditions.
4051 Also rename any existing auto save file, if it was made in this session."
4063 "Return file name to use for auto-saves of current buffer.
4064 Does not consider `auto-save-visited-file-name' as that variable is checked
4065 before calling this function. You can redefine this for customization.
4066 See also `auto-save-file-name-p'."
4074 result uniq)
4075 ;; Apply user-specified translations
4076 ;; to the file name.
4080 filename)
4090 filename))))
4095 ;; We truncate the file name to DOS 8+3 limits
4096 ;; before doing anything else, because the regexp
4097 ;; passed to string-match below cannot handle
4098 ;; extensions longer than 3 characters, multiple
4099 ;; dots, and other atrocities.
4104 fn)
4109 "#"
4112 ;; Make sure auto-save file names don't contain characters
4113 ;; invalid for the underlying filesystem.
4115 ;; Don't modify remote (ange-ftp) filenames
4118 result))))
4120 ;; Deal with buffers that don't have any associated files. (Mail
4121 ;; mode tends to create a good number of these.)
4125 file-name)
4126 ;; Eliminate all slashes and backslashes by
4127 ;; replacing them with sequences that start with %.
4128 ;; Quote % also, to keep distinct names distinct.
4137 ;; Generate the file name.
4143 ;; Try a few alternative directories, to get one we can
4144 ;; write it.
4150 ;; Don't modify remote (ange-ftp) filenames
4152 ;; The call to convert-standard-filename is in case
4153 ;; buffer-name includes characters not allowed by the
4154 ;; DOS/Windows filesystems. make-temp-file writes to the
4155 ;; file it creates, so we must fix the file name _before_
4156 ;; make-temp-file is called.
4158 fname))
4160 ;; make-temp-file creates the file,
4161 ;; but we don't want it to exist until we do an auto-save.
4165 file-name)))
4168 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4169 FILENAME should lack slashes. You can redefine this for customization."
4171 \f
4173 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4174 The generated regexp will match a filename iff the filename
4175 matches that wildcard according to shell rules. Only wildcards known
4176 by `sh' are supported."
4178 ;; Copy the initial run of non-special characters.
4181 ;; If no special characters, we're almost done.
4185 j)
4187 result
4208 ;; Found "[^". Insert a `\0' character
4209 ;; (which cannot happen in a filename)
4210 ;; into the character class, so that `^'
4211 ;; is not the first character after `[',
4212 ;; and thus non-special in a regexp.
4217 ;; I don't think `]' can appear in a
4218 ;; character class in a wildcard, but
4219 ;; let's be general here.
4226 i
4239 ;; Shell wildcards should match the entire filename,
4240 ;; not its part. Make the regexp say so.
4242 \f
4245 "*Switches for `list-directory' to pass to `ls' for brief listing."
4251 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4253 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4258 "Expand wildcard pattern PATTERN.
4259 This returns a list of file names which match the pattern.
4261 If PATTERN is written as an absolute file name,
4262 the values are absolute also.
4264 If PATTERN is written as a relative file name, it is interpreted
4265 relative to the current default directory, `default-directory'.
4266 The file names returned are normally also relative to the current
4267 default directory. However, if FULL is non-nil, they are absolute."
4271 ;; A list of all dirs that DIRPART specifies.
4272 ;; This can be more than one dir
4273 ;; if DIRPART contains wildcards.
4278 contents)
4283 ;; Filter out "." and ".."
4288 name))
4295 this-dir-contents)
4296 this-dir-contents)
4297 contents))))
4299 contents)))
4302 "Display a list of files in or matching DIRNAME, a la `ls'.
4303 DIRNAME is globbed by the shell if necessary.
4304 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4305 Actions controlled by variables `list-directory-brief-switches'
4306 and `list-directory-verbose-switches'."
4310 nil default-directory nil)
4311 pfx)))
4313 list-directory-brief-switches))
4314 buffer)
4327 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4335 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4337 PATTERN is assumed to represent a file-name wildcard suitable for the
4338 underlying filesystem. For Unix and GNU/Linux, the characters from the
4340 the parts of the pattern which don't include wildcard characters are
4341 quoted with double quotes.
4342 Existing quote characters in PATTERN are left alone, so you can pass
4343 PATTERN that already quotes some of the special characters."
4347 ;; DOS/Windows don't allow `"' in file names. So if the
4348 ;; argument has quotes, we can safely assume it is already
4349 ;; quoted by the caller.
4351 ;; We quote [&()#$'] in case their shell is a port of a
4352 ;; Unixy shell. We quote [,=+] because stock DOS and
4353 ;; Windows shells require that in some cases, such as
4354 ;; passing arguments to batch files that use positional
4355 ;; arguments like %1.
4357 pattern
4360 end)
4377 pattern))))
4384 "*Program to get the amount of free space on a file system.
4385 We assume the output has the format of `df'.
4386 The value of this variable must be just a command name or file name;
4387 if you want to specify options, use `directory-free-space-args'.
4389 A value of nil disables this feature.
4391 If the function `file-system-info' is defined, it is always used in
4392 preference to the program given by this variable."
4398 "*Options to use when running `directory-free-space-program'."
4403 "Return the amount of free space on directory DIR's file system.
4404 The result is a string that gives the number of free 1KB blocks,
4405 or nil if the system call or the program which retrieve the information
4406 fail.
4408 This function calls `file-system-info' if it is available, or invokes the
4409 program specified by `directory-free-space-program' if that is non-nil."
4410 ;; Try to find the number of free blocks. Non-Posix systems don't
4411 ;; always have df, but might have an equivalent system call.
4420 nil t nil
4421 directory-free-space-args
4422 dir)))
4423 ;; Usual format is a header line followed by a line of
4424 ;; numbers.
4429 ;; Move to the end of the "available blocks" number.
4432 ;; Copy it into AVAILABLE.
4440 ;; insert-directory
4441 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4442 ;; FULL-DIRECTORY-P is nil.
4443 ;; The single line of output must display FILE's name as it was
4444 ;; given, namely, an absolute path name.
4445 ;; - must insert exactly one line for each file if WILDCARD or
4446 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4447 ;; before the file lines, plus optional text after the file lines.
4448 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4449 ;; allowed.
4450 ;; File lines should display the basename.
4451 ;; - must be consistent with
4452 ;; - functions dired-move-to-filename, (these two define what a file line is)
4453 ;; dired-move-to-end-of-filename,
4454 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4455 ;; dired-insert-headerline
4456 ;; dired-after-subdir-garbage (defines what a "total" line is)
4457 ;; - variable dired-subdir-regexp
4458 ;; - may be passed "--dired" as the first argument in SWITCHES.
4459 ;; Filename handlers might have to remove this switch if their
4460 ;; "ls" command does not support it.
4462 "Insert directory listing for FILE, formatted according to SWITCHES.
4463 Leaves point after the inserted text.
4464 SWITCHES may be a string of options, or a list of strings
4465 representing individual options.
4466 Optional third arg WILDCARD means treat FILE as shell wildcard.
4467 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4468 switches do not contain `d', so that a full listing is expected.
4470 This works by running a directory listing program
4471 whose name is in the variable `insert-directory-program'.
4472 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4474 When SWITCHES contains the long `--dired' option, this function
4475 treats it specially, for the sake of dired. However, the
4476 normally equivalent short `-D' option is just passed on to
4477 `insert-directory-program', as any other option."
4478 ;; We need the directory in order to find the right handler.
4483 wildcard full-directory-p)
4488 ;; Read the actual directory using `insert-directory-program'.
4489 ;; RESULT gets the status code.
4491 ;; putting text property `dired-filename, decode one
4492 ;; bunch by one to preserve that property.
4494 ;; This is to control encoding the arguments in call-process.
4498 default-file-name-coding-system))))
4501 ;; Run ls in the directory part of the file pattern
4502 ;; using the last component as argument.
4509 shell-file-name nil t nil
4510 "-c"
4512 ""
4514 insert-directory-program
4515 " -d "
4517 switches
4519 " -- "
4520 ;; Quote some characters that have
4521 ;; special meanings in shells; but
4522 ;; don't quote the wildcards--we want
4523 ;; them to be special. We also
4524 ;; currently don't quote the quoting
4525 ;; characters in case people want to
4526 ;; use them explicitly to quote
4527 ;; wildcard characters.
4529 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4530 ;; directory if FILE is a symbolic link.
4532 insert-directory-program nil t nil
4536 ;; Split the switches at any spaces so we can
4537 ;; pass separate options as separate args.
4539 ;; Avoid lossage if FILE starts with `-'.
4547 file))))))))
4549 ;; If we got "//DIRED//" in the output, it means we got a real
4550 ;; directory listing, even if `ls' returned nonzero.
4551 ;; So ignore any errors.
4564 ;; The first time ls returns an error,
4565 ;; find the version numbers of ls,
4566 ;; and set insert-directory-ls-version
4567 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4568 ;; is equal or if the info cannot be obtained.
4569 ;; (That can mean it isn't GNU ls.)
4579 comparison)
4595 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4599 ;; If `insert-directory-program' failed, signal an error.
4601 ;; Delete the error message it may have output.
4603 ;; On non-Posix systems, we cannot open a directory, so
4604 ;; don't even try, because that will always result in
4605 ;; the ubiquitous "Access denied". Instead, show the
4606 ;; command line so the user can try to guess what went wrong.
4611 insert-directory-program
4613 file result)
4614 ;; Unix. Access the file to get a suitable error.
4621 ;; The following overshoots by one line for an empty
4622 ;; directory listed with "--dired", but without "-a"
4623 ;; switch, where the ls output contains a
4624 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4625 ;; We take care of that case later.
4633 error-lines)
4634 ;; Find all the lines that are error messages,
4635 ;; and record the bounds of each one.
4642 ;; Now read the numeric positions of file names.
4649 error-lines))
4652 error-lines)))
4654 ;; End is followed by \n or by " -> ".
4656 ;; It seems that we can't trust ls's output as to
4657 ;; byte positions of filenames.
4663 ;; Take care of the case where the ls output contains a
4664 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4665 ;; and we went one line too far back (see above).
4670 ;; Now decode what read if necessary.
4672 file-name-coding-system
4673 default-file-name-coding-system
4675 coding-no-eol
4676 val pos)
4680 ;; If no coding system is specified or detection is
4681 ;; requested, detect the coding.
4695 ;; Force no eol conversion on a file name, so
4696 ;; that CR is preserved.
4704 ;; Try to insert the amount of free space.
4707 ;; First find the line to put it on.
4711 ;; Replace "total" with "used", to avoid confusion.
4717 "Convert `ls --dired' file name position value POS to a buffer position.
4718 File name position values returned in ls --dired output
4719 count only stdout; they don't count the error messages sent to stderr.
4720 So this function converts to them to real buffer positions.
4721 ERROR-LINES is a list of buffer positions of error message lines,
4722 of the form (START END)."
4726 pos)
4730 "Insert directory listing for FILE, formatted according to SWITCHES.
4732 Like `insert-directory', but if FILE does not exist, it inserts a
4733 message to that effect instead of signaling an error."
4736 ;; Simulate the message printed by `ls'.
4740 "Functions to call with no arguments to query about killing Emacs.
4741 If any of these functions returns nil, killing Emacs is cancelled.
4743 but `kill-emacs', the low level primitive, does not.
4747 "How to ask for confirmation when leaving Emacs.
4748 If nil, the default, don't ask at all. If the value is non-nil, it should
4749 be a predicate function such as `yes-or-no-p'."
4757 "Offer to save each buffer, then kill this Emacs process.
4758 With prefix arg, silently save all file-visiting buffers, then kill."
4767 ;; process-list is not defined on VMS.
4769 active)
4778 ;; Query the user for other things, perhaps.
4783 \f
4784 ;; We use /: as a prefix to "quote" a file name
4785 ;; so that magic file name handlers will not apply to it.
4789 file-name-handler-alist))
4791 ;; We depend on being the last handler on the list,
4792 ;; so that anything else which does need handling
4793 ;; has been handled already.
4794 ;; So it is safe for us to inhibit *all* magic file name handlers.
4803 default-directory))
4804 ;; Get a list of the indices of the args which are file names.
4807 ;; The first six are special because they
4808 ;; return a file name. We want to include the /:
4809 ;; in the return value.
4810 ;; So just avoid stripping it in the first place.
4817 ;; `identity' means just return the first arg
4818 ;; not stripped of its quoting.
4820 ;; `add' means add "/:" to the result.
4822 ;; `quote' means add "/:" to buffer-file-name.
4824 ;; `unquote-then-quote' means set buffer-file-name
4825 ;; temporarily to unquoted filename.
4827 ;; List the arguments which are filenames.
4835 ;; For all other operations, treat the first argument only
4836 ;; as the file name.
4838 method
4839 ;; Copy ARGUMENTS so we can replace elements in it.
4843 ;; Strip off the /: from the file names that have it.
4851 "/"
4867 res))
4870 \f
4894 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
4895 ;;; files.el ends here