| blob | 285cd50e6af72478238be8294f38af4797287a31 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
32 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "*Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "*Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 Do not use `~' in the TO strings.
63 They should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
75 ;; Turn off backup files on VMS since it has version numbers.
77 "*Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
106 "*Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
112 "*Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
119 "*Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
129 "*Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
141 "Predicate that looks at a file name and decides whether to make backups.
145 "*Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
153 "*Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
160 "*Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
167 "*Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
198 "The directory for writing temporary files."
204 "The directory for writing small temporary files.
205 If non-nil, this directory is used instead of `temporary-file-directory'
206 by programs that create small temporary files. This is for systems that
207 have fast storage with limited space, such as a RAM disk."
211 ;; The system null device. (Should reference NULL_DEVICE from C.)
228 "*Non-nil means protect against I/O errors while saving files.
229 Some modes set this non-nil in particular buffers.
231 This feature works by writing the new contents into a temporary file
232 and then renaming the temporary file to replace the original.
233 In this way, any I/O error in writing leaves the original untouched,
234 and there is never any instant where the file is nonexistent.
236 Note that this feature forces backups to be made by copying.
237 Yet, at the same time, saving a precious file
238 breaks any hard links between it and other files."
243 "*Control use of version numbers for backup files.
244 t means make numeric backup versions unconditionally.
245 nil means make them for files that have some already.
246 `never' means do not make them."
254 "*When cleaning directory, number of versions to keep."
260 "*If t, delete excess backup versions silently.
261 If nil, ask confirmation. Any other value prevents any trimming."
268 "*Number of oldest versions to keep when a new numbered backup is made."
273 "*Number of newest versions to keep when a new numbered backup is made.
274 Includes the new backup. Must be > 0"
279 "*Whether to add a newline automatically at the end of the file.
281 A value of t means do this only when the file is about to be saved.
282 A value of `visit' means do this right after the file is visited.
283 A value of `visit-save' means do it at both of those times.
284 Any other non-nil value means ask user whether to add a newline, when saving.
285 nil means don't add newlines.
287 Certain major modes set this locally to the value obtained
288 from `mode-require-final-newline'."
297 "*Whether to add a newline at end of file, in certain major modes.
298 Those modes set `require-final-newline' to this value when you enable them.
299 They do so because they are often used for files that are supposed
300 to end in newlines, and the question is how to arrange that.
302 A value of t means do this only when the file is about to be saved.
303 A value of `visit' means do this right after the file is visited.
304 A value of `visit-save' means do it at both of those times.
305 Any other non-nil value means ask user whether to add a newline, when saving.
307 nil means do not add newlines. That is a risky choice in this variable
308 since this value is used for modes for files that ought to have final newlines.
309 So if you set this to nil, you must explicitly check and add
310 a final newline, whenever you save a file that really needs one."
320 "*Non-nil says by default do auto-saving of every file-visiting buffer."
325 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
326 Normally auto-save files are written under other names."
332 ;; Don't put "\\2" inside expand-file-name, since it will be
333 ;; transformed to "/2" on DOS/Windows.
335 "*Transforms to apply to buffer file name before making auto-save file name.
336 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
337 REGEXP is a regular expression to match against the file name.
338 If it matches, `replace-match' is used to replace the
339 matching part with REPLACEMENT.
340 If the optional element UNIQUIFY is non-nil, the auto-save file name is
341 constructed by taking the directory part of the replaced file-name,
342 concatenated with the buffer file name with all directory separators
343 changed to `!' to prevent clashes. This will not work
344 correctly if your filesystem truncates the resulting name.
346 All the transforms in the list are tried, in the order they are listed.
347 When one transform applies, its result is final;
348 no further transforms are tried.
350 The default value is set up to put the auto-save file into the
351 temporary directory (see the variable `temporary-file-directory') for
352 editing a remote file.
354 On MS-DOS filesystems without long names this variable is always
355 ignored."
362 "*Non-nil means save word abbrevs too when files are saved.
363 If `silently', don't ask the user before saving."
368 "*Non-nil means allow `find-file' to visit directories.
369 To visit the directory, `find-file' runs `find-directory-functions'."
374 "*List of functions to try in sequence to visit a directory.
375 Each function is called with the directory name as the sole argument
376 and should return either a buffer or nil."
380 ;;;It is not useful to make this a local variable.
381 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
383 "List of functions to be called for `find-file' on nonexistent file.
384 These functions are called as soon as the error is detected.
385 Variable `buffer-file-name' is already set up.
390 ;;;It is not useful to make this a local variable.
391 ;;;(put 'find-file-hooks 'permanent-local t)
393 "List of functions to be called after a buffer is loaded from a file.
394 The buffer's local variables (if any) will have been processed before the
395 functions are called."
403 "List of functions to be called before writing out a buffer to a file.
404 If one of them returns non-nil, the file is considered already written
405 and the rest are not called.
406 These hooks are considered to pertain to the visited file.
407 So any buffer-local binding of this variable is discarded if you change
409 change the major mode.
411 This hook is not run if any of the functions in
412 `write-contents-functions' returns non-nil. Both hooks pertain
413 to how to save a buffer to file, for instance, choosing a suitable
414 coding system and setting mode bits. (See Info
415 node `(elisp)Saving Buffers'.) To perform various checks or
426 "List of functions to be called before writing out a buffer to a file.
427 If one of them returns non-nil, the file is considered already written
428 and the rest are not called and neither are the functions in
429 `write-file-functions'.
431 This variable is meant to be used for hooks that pertain to the
432 buffer's contents, not to the particular visited file; thus,
433 `set-visited-file-name' does not clear this variable; but changing the
434 major mode does clear it.
436 For hooks that _do_ pertain to the particular visited file, use
437 `write-file-functions'. Both this variable and
438 `write-file-functions' relate to how a buffer is saved to file.
439 To perform various checks or updates before the buffer is saved,
446 "*Control use of local variables in files you visit.
447 The value can be t, nil or something else.
449 A value of t means file local variables specifications are obeyed
450 if all the specified variables are safe. If any variables are
451 not safe, you will be queries before setting them.
452 A value of nil means file local variables are ignored.
453 Any other value means to always query.
455 This variable also controls use of major modes specified in
456 a -*- line.
459 always obeys file local variable specifications and the -*- line,
460 and ignores this variable."
467 "Like `enable-local-variables' but meant for buffer-local bindings.
468 The meaningful values are nil and non-nil. The default is non-nil.
469 If a major mode sets this to nil, buffer-locally, then any local
470 variables list in the file will be ignored.
472 This variable does not affect the use of major modes
477 The value can be t, nil or something else.
478 A value of t means obey `eval' variables;
479 nil means ignore them; anything else means query."
485 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
494 "*Non-nil means buffers visiting files read-only do so in view mode.
495 In fact, this means that all read-only buffers normally have
496 View mode enabled, including buffers that are read-only because
497 you visit a file you cannot alter, and buffers you make read-only
504 "Provides support for ange-ftp host name completion.
505 Runs the usual ange-ftp hook, but only for completion operations."
506 ;; Having this here avoids the need to load ange-ftp when it's not
507 ;; really in use.
513 inhibit-file-name-handlers)))
518 "Convert a standard file's name to something suitable for the OS.
519 This means to guarantee valid names and perhaps to canonicalize
520 certain patterns.
522 FILENAME should be an absolute file name since the conversion rules
523 sometimes vary depending on the position in the file name. E.g. c:/foo
524 is a valid DOS file name, but c:/bar/c:/foo is not.
526 This function's standard definition is trivial; it just returns
527 the argument. However, on Windows and DOS, replace invalid
528 characters. On DOS, make sure to obey the 8.3 limitations. On
529 Windows, turn Cygwin names into native names, and also turn
530 slashes into backslashes if the shell requires it (see
531 `w32-shell-dos-semantics').
533 See Info node `(elisp)Standard File Names' for more details."
534 filename)
537 "Read directory name, prompting with PROMPT and completing in directory DIR.
538 Value is not expanded---you must call `expand-file-name' yourself.
539 Default name to DEFAULT-DIRNAME if user exits with the same
540 non-empty string that was inserted by this function.
541 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
542 or just DIR if INITIAL is nil.)
543 If the user exits with an empty minibuffer, this function returns
544 an empty string. (This can only happen if the user erased the
545 pre-inserted contents or if `insert-default-directory' is nil.)
546 Fourth arg MUSTMATCH non-nil means require existing directory's name.
547 Non-nil and non-t means also require confirmation after completion.
548 Fifth arg INITIAL specifies text to start with.
549 DIR should be an absolute directory name. It defaults to
550 the value of `default-directory'."
555 dir))
556 mustmatch initial
559 \f
561 "Show the current default directory."
566 "Value of the CDPATH environment variable, as a list.
570 "Explode a search path into a list of directory names.
571 Directories are separated by occurrences of `path-separator'
572 \(which is colon in GNU and GNU-like systems)."
573 ;; We could use split-string here.
581 nil
586 cd-list)))
589 "Change current directory to given absolute file name DIR."
590 ;; Put the name into directory syntax now,
591 ;; because otherwise expand-file-name may give some bad results.
604 "Make DIR become the current buffer's default directory.
605 If your environment includes a `CDPATH' variable, try each one of
606 that list of directories (separated by occurrences of
607 `path-separator') when resolving a relative directory name.
608 The path separator is colon in GNU and GNU-like systems."
611 default-directory default-directory
627 cd-path)
628 nil))
632 "Load the Lisp file named FILE."
633 ;; This is a case where .elc makes a lot of sense.
640 "Search for FILENAME through PATH.
641 If found, return the absolute file name of FILENAME, with its suffixes;
642 otherwise return nil.
643 PATH should be a list of directories to look in, like the lists in
644 `exec-path' or `load-path'.
645 If SUFFIXES is non-nil, it should be a list of suffixes to append to
648 If non-nil, PREDICATE is used instead of `file-readable-p'.
649 PREDICATE can also be an integer to pass to the `access' system call,
650 in which case file-name handlers are ignored. This usage is deprecated.
652 For compatibility, PREDICATE can also be one of the symbols
653 `executable', `readable', `writable', or `exists', or a list of
654 one or more of those symbols."
665 "Do completion for file names passed to `locate-file'.
666 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
689 "Search for COMMAND in `exec-path' and return the absolute file name.
690 Return nil if COMMAND is not found anywhere in `exec-path'."
691 ;; Use 1 rather than file-executable-p to better match the behavior of
692 ;; call-process.
696 "Load the library named LIBRARY.
697 This is an interface to the function `load'."
700 'locate-file-completion
705 "Test whether FILE specifies a location on a remote system.
706 Return an identification of the system if the location is indeed
707 remote. The identification of the system may comprise a method
708 to access the system and its hostname, amongst other things.
715 nil)))
718 "Copy the file FILE into a temporary file on this machine.
719 Returns the name of the local copy, or nil, if FILE is directly
720 accessible."
721 ;; This formerly had an optional BUFFER argument that wasn't used by
722 ;; anything.
726 nil)))
729 "Return the truename of FILENAME, which should be absolute.
730 The truename of a file name is found by chasing symbolic links
731 both at the level of the file and at the level of the directories
732 containing it, until no links are left at any level.
735 ;; COUNTER and PREV-DIRS are only used in recursive calls.
736 ;; COUNTER can be a cons cell whose car is the count of how many
737 ;; more links to chase before getting an error.
738 ;; PREV-DIRS can be a cons cell whose car is an alist
739 ;; of truenames we've just recently computed.
753 ;; For speed, remove the ange-ftp completion handler from the list.
754 ;; We know it's not needed here.
755 ;; For even more speed, do this only on the outermost call.
762 ;; andrewi@harlequin.co.uk - none of the following code (except for
763 ;; invoking the file-name handler) currently applies on Windows
764 ;; (ie. there are no native symlinks), but there is an issue with
765 ;; case differences being ignored by the OS, and short "8.3 DOS"
766 ;; name aliases existing for all files. (The short names are not
767 ;; reported by directory-files, but can be used to refer to files.)
768 ;; It seems appropriate for file-truename to resolve these issues in
769 ;; the most natural way, which on Windows is to call the function
770 ;; `w32-long-file-name' - this returns the exact name of a file as
771 ;; it is stored on disk (expanding short name aliases with the full
772 ;; name in the process).
775 ;; For file name that has a special handler, call handler.
776 ;; This is so that ange-ftp can save time by doing a no-op.
779 ;; If filename contains a wildcard, newname will be the old name.
781 ;; If filename exists, use the long name
785 ;; If this file directly leads to a link, process that iteratively
786 ;; so that we don't use lots of stack.
792 ;; For file name that has a special handler, call handler.
793 ;; This is so that ange-ftp can save time by doing a no-op.
796 done t)
798 target dirfile)
799 ;; Get the truename of the directory.
801 ;; If these are equal, we have the (or a) root directory.
803 ;; If this is the same dir we last got the truename for,
804 ;; save time--don't recalculate.
814 done t)
817 done t)
818 ;; Put it back on the file name.
820 ;; Is the file name the name of a link?
823 ;; Yes => chase that link, then start all over
824 ;; since the link may point to a directory name that uses links.
825 ;; We can't safely use expand-file-name here
826 ;; since target might look like foo/../bar where foo
827 ;; is itself a link. Instead, we handle . and .. above.
830 target
832 done nil)
833 ;; No, we are done!
835 filename))
838 "Chase links in FILENAME until a name that is not a link.
839 Unlike `file-truename', this does not check whether a parent
840 directory name is a symbolic link.
841 If the optional argument LIMIT is a number,
842 it means chase no more than that many links and then stop."
850 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
853 ;; Handle `..' by hand, since it needs to work in the
854 ;; target of any directory symlink.
855 ;; This code is not quite complete; it does not handle
856 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
860 ;; Chase links in the default dir of the symlink.
864 ;; Now find the parent of that dir.
868 newname))
871 "Create a temporary file.
872 The returned file name (created by appending some random characters at the end
873 of PREFIX, and expanding against `temporary-file-directory' if necessary),
874 is guaranteed to point to a newly created empty file.
875 You can then use `write-region' to write new data into the file.
877 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
879 If SUFFIX is non-nil, add that at the end of the file name."
881 file)
884 ;; Create temp files with strict access rights. It's easy to
885 ;; loosen them later, whereas it's impossible to close the
886 ;; time-window of loose permissions otherwise.
898 nil)
900 ;; the file was somehow created by someone else between
901 ;; `make-temp-name' and `write-region', let's try again.
902 nil)
903 file)
904 ;; Reset the umask.
908 "Change the encoding of FILE's name from CODING to NEW-CODING.
909 The value is a new name of FILE.
910 Signals a `file-already-exists' error if a file of the new name
911 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
912 is non-nil. A number as fourth arg means request confirmation if
913 the new name already exists. This is what happens in interactive
914 use with M-x."
917 default-file-name-coding-system))
919 from-coding to-coding)
921 ;; We provide the default coding only when it seems that
922 ;; the filename is correctly decoded by the default
923 ;; coding.
929 filename default-coding)
930 default-coding))
934 ;; We provide the default coding only when a user is going to
935 ;; change the encoding not from the default coding.
939 filename from-coding)))
942 filename from-coding default-coding)
943 default-coding)))
947 default-file-name-coding-system))
948 ;; FILE should have been decoded by DEFAULT-CODING.
952 ;; Suppress further encoding.
957 newname))
958 \f
960 "Select buffer BUFFER in another window.
961 If BUFFER does not identify an existing buffer, then this function
962 creates a buffer with that name.
964 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
965 or nil. If BUFFER is nil, then this function chooses a buffer
966 using `other-buffer'.
967 Optional second arg NORECORD non-nil means
968 do not put this buffer at the front of the list of recently selected ones.
969 This function returns the buffer it switched to.
971 This uses the function `display-buffer' as a subroutine; see its
972 documentation for additional customization information."
975 ;; Don't let these interfere.
976 same-window-buffer-names same-window-regexps)
980 "Switch to buffer BUFFER in another frame.
981 Optional second arg NORECORD non-nil means
982 do not put this buffer at the front of the list of recently selected ones.
984 This uses the function `display-buffer' as a subroutine; see its
985 documentation for additional customization information."
988 same-window-buffer-names same-window-regexps)
996 "Add FUN to `minibuffer-setup-hook' while executing BODY.
997 BODY should use the minibuffer at most once.
998 Recursive uses of the minibuffer will not be affected."
1004 ;; Clear out this hook so it does not interfere
1005 ;; with any recursive minibuffer usage.
1021 t))
1024 "Edit file FILENAME.
1025 Switch to a buffer visiting file FILENAME,
1026 creating one if none already exists.
1027 Interactively, the default if you just type RET is the current directory,
1028 but the visited file name is available through the minibuffer history:
1029 type M-n to pull it into the minibuffer.
1031 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1032 expand wildcards (if any) and visit multiple files. You can
1033 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1035 To visit a file without any kind of conversion and without
1044 "Edit file FILENAME, in another window.
1045 May create a new window, or reuse an existing one.
1046 See the function `display-buffer'.
1048 Interactively, the default if you just type RET is the current directory,
1049 but the visited file name is available through the minibuffer history:
1050 type M-n to pull it into the minibuffer.
1052 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1053 expand wildcards (if any) and visit multiple files."
1064 "Edit file FILENAME, in another frame.
1065 May create a new frame, or reuse an existing one.
1066 See the function `display-buffer'.
1068 Interactively, the default if you just type RET is the current directory,
1069 but the visited file name is available through the minibuffer history:
1070 type M-n to pull it into the minibuffer.
1072 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1073 expand wildcards (if any) and visit multiple files."
1084 "Edit the existing file FILENAME.
1092 "Edit file FILENAME but don't allow changes.
1104 value))
1107 "Edit file FILENAME in another window but don't allow changes.
1119 value))
1122 "Edit file FILENAME in another frame but don't allow changes.
1134 value))
1137 "Find file FILENAME as a replacement for the file in the next window.
1138 This command does not select that window.
1140 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1141 expand wildcards (if any) and replace the file with multiple files."
1153 t))))
1161 "Find file FILENAME, select its buffer, kill previous buffer.
1162 If the current buffer now contains an empty file that you just visited
1163 \(presumably by mistake), use this command to visit the file you really want.
1165 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1166 expand wildcards (if any) and replace the file with multiple files."
1176 t)))
1197 ;; This prevents us from finding the same buffer
1198 ;; if we specified the same file again.
1202 ;; Likewise for dired buffers.
1206 ;; This executes if find-file gets an error
1207 ;; and does not really find anything.
1208 ;; We put things back as they were.
1209 ;; If find-file actually finds something, we kill obuf below.
1218 ;; We already asked; don't ask again.
1221 \f
1223 "Create a suitably named buffer for visiting FILENAME, and return it.
1224 FILENAME (sans directory) is used unchanged if that name is free;
1225 otherwise a string <2> or <3> or ... is appended to get an unused name."
1232 "Create and return a buffer with a name based on NAME.
1233 Choose the buffer's name using `generate-new-buffer-name'."
1237 "Regexp to match the automounter prefix in a directory name."
1245 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1247 removes automounter prefixes (see the variable `automount-dir-prefix')."
1248 ;; Get rid of the prefixes added by the automounter.
1255 ;; If any elt of directory-abbrev-alist matches this name,
1256 ;; abbreviate accordingly.
1262 ;; Compute and save the abbreviated homedir name.
1263 ;; We defer computing this until the first time it's needed, to
1264 ;; give time for directory-abbrev-alist to be set properly.
1265 ;; We include a slash at the end, to avoid spurious matches
1266 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1273 ;; If FILENAME starts with the abbreviated homedir,
1274 ;; make it start with `~' instead.
1276 ;; If the home dir is just /, don't change it.
1279 ;; MS-DOS root directories can come with a drive letter;
1280 ;; Novell Netware allows drive letters beyond `Z:'.
1290 filename))
1293 "*List of logical names for which visiting shouldn't save the true dirname.
1294 On VMS, when you visit a file using a logical name that searches a path,
1295 you may or may not want the visited file name to record the specific
1296 directory where the file was found. If you *do not* want that, add the logical
1297 name to this list as a string."
1302 "Return the buffer visiting file FILENAME (a string).
1303 This is like `get-file-buffer', except that it checks for any buffer
1304 visiting the same file, possibly under a different name.
1305 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1306 and others are ignored.
1307 If there is no such live buffer, return nil."
1321 found)
1326 number
1331 ;; Verify this buffer's file number
1332 ;; still belongs to its file.
1335 attributes)
1339 found))))
1340 \f
1342 "*Non-nil means file-visiting commands should handle wildcards.
1343 For example, if you specify `*.c', that would visit all the files
1344 whose names match the pattern."
1350 "*Non-nil means suppress warning messages for symlinked files.
1351 When nil, Emacs prints a warning when visiting a file that is already
1352 visited, but with a different name. Setting this option to t
1353 suppresses this warning."
1359 "Maximum size of file above which a confirmation is requested.
1360 When nil, never request confirmation."
1367 "Read file FILENAME into a buffer and return the buffer.
1368 If a buffer exists visiting FILENAME, return that one, but
1369 verify that the file has not changed since visited or saved.
1370 The buffer is not selected, just returned to the caller.
1371 Optional second arg NOWARN non-nil means suppress any warning messages.
1372 Optional third arg RAWFILE non-nil means the file is read literally.
1373 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1374 and visit all the matching files. When wildcards are actually
1375 used and expanded, return a list of buffers that are visiting
1376 the various files."
1383 'find-directory-functions
1386 filename)))
1389 find-file-wildcards
1403 ;; Find any buffer for a file which has same truename.
1405 ;; Let user know if there is a buffer with the same truename.
1409 find-file-suppress-same-file-warnings
1413 ;; Optionally also find that buffer.
1416 ;; Check to see if the file looks uncommonly large.
1418 ;; Don't ask again if we already have the file or
1419 ;; if we're asked to be quiet.
1428 ;; We are using an existing buffer.
1434 ;; Certain files should be reverted automatically
1435 ;; if they have changed on disk and not in the buffer.
1443 found))
1453 "File %s changed on disk. Discard your edits? "
1458 "File %s changed on disk. Discard your edits in %s? "
1466 ;; Check if a formerly read-only file has become
1467 ;; writable and vice versa, but if the buffer agrees
1468 ;; with the new state of the file, that is ok too.
1475 buffer-file-name
1483 ;; It is confusing to ask whether to visit
1484 ;; non-literally if they have the file in
1485 ;; hexl-mode.
1489 "Save file and revisit literally? "
1494 rawfile truename number))
1496 "Discard your edits and revisit file literally? "
1499 rawfile truename number)
1503 "Revisit file literally? "
1506 rawfile truename number)
1509 ;; Return the buffer we are using.
1510 buf)
1511 ;; Create a new buffer.
1513 ;; find-file-noselect-1 may use a different buffer.
1515 rawfile truename number))))))
1521 ;; Needed in case we are re-visiting the file with a different
1522 ;; text representation.
1539 filename)))
1540 ;; Unconditionally set error
1550 filename)))
1551 ;; Run find-file-not-found-hooks until one returns non-nil.
1553 ;; If they fail too, set error.
1555 ;; Record the file's truename, and maybe use that as visited name.
1561 ;; On VMS, we may want to remember which directory in a search list
1562 ;; the file was found in.
1574 ;; Set buffer's default directory to that of the file.
1576 ;; Turn off backup files for certain file names. Since
1577 ;; this is a permanent local, the major mode won't eliminate it.
1591 \f
1593 "Like `insert-file-contents', but only reads in the file literally.
1594 A buffer may be modified in several ways after reading into the buffer,
1595 to Emacs features such as format decoding, character code
1596 conversion, `find-file-hook', automatic uncompression, etc.
1598 This function ensures that none of these modifications will take place."
1606 nil))
1609 inhibit-file-name-handlers))
1622 filename)))
1632 "Insert contents of file FILENAME into buffer after point with no conversion.
1634 This function is meant for the user to run interactively.
1635 Don't call it from programs! Use `insert-file-contents-literally' instead.
1636 \(Its calling sequence is different; see its documentation)."
1641 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1646 "Visit file FILENAME with no conversion of any kind.
1647 Format conversion and character code conversion are both disabled,
1648 and multibyte characters are disabled in the resulting buffer.
1649 The major mode used is Fundamental mode regardless of the file name,
1650 and local variable specifications in the file are ignored.
1651 Automatic uncompression and adding a newline at the end of the
1652 file due to `require-final-newline' is also disabled.
1654 You cannot absolutely rely on this function to result in
1655 visiting the file literally. If Emacs already has a buffer
1656 which is visiting the file, you get the existing buffer,
1657 regardless of whether it was created literally or not.
1659 In a Lisp program, if you want to be sure of accessing a file's
1660 contents literally, you should create a temporary buffer and then read
1661 the file contents into it using `insert-file-contents-literally'."
1664 \f
1668 after-find-file-from-revert-buffer
1669 nomodes)
1670 "Called after finding a file and by the default revert function.
1671 Sets buffer mode, parses local variables.
1672 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1673 error in reading the file. WARN non-nil means warn if there
1674 exists an auto-save file more recent than the visited file.
1675 NOAUTO means don't mess with auto-save mode.
1676 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1677 means this call was from `revert-buffer'.
1678 Fifth arg NOMODES non-nil means don't alter the file's modes.
1679 Finishes by calling the functions in `find-file-hook'
1680 unless NOMODES is non-nil."
1683 nil
1693 ;; No need to warn if buffer is auto-saved
1694 ;; under the name of the visited file.
1696 auto-save-visited-file-name))
1699 buffer-file-name))
1719 ;; Make people do a little extra work (C-x C-q)
1720 ;; before altering a backup file.
1723 ;; When a file is marked read-only,
1724 ;; make the buffer read-only even if root is looking at it.
1732 ;; If requested, add a newline at the end of the file.
1742 view-read-only
1748 "Eval BODY and turn any error into a FORMAT message.
1749 FORMAT can have a %s escape which will be replaced with the actual error.
1750 If `debug-on-error' is set, errors are not caught, so that you can
1751 debug them.
1752 Avoid using a large BODY since it is duplicated."
1761 "Choose the major mode for this buffer automatically.
1762 Also sets up any specified local variables of the file.
1763 Uses the visited file name, the -*- line, and the local variables spec.
1765 This function is called automatically from `find-file'. In that case,
1766 we may set up the file-specified mode and local variables,
1767 depending on the value of `enable-local-variables': if it is t, we do;
1768 if it is nil, we don't; otherwise, we query.
1769 In addition, if `local-enable-local-variables' is nil, we do
1770 not set local variables (though we do notice a mode specified with -*-.)
1772 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1773 or from Lisp without specifying the optional argument FIND-FILE;
1774 in that case, this function acts as if `enable-local-variables' were t."
1782 ;; Turn font lock off and on, to make sure it takes account of
1783 ;; whatever file local variables are relevant to it.
1785 ;; Font-lock-mode (now in font-core.el) can be ON when
1786 ;; font-lock.el still hasn't been loaded.
1796 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1797 ;; c++-mode, java-mode and more) are added through autoload
1798 ;; directives in that file. That way is discouraged since it
1799 ;; spreads out the definition of the initial value.
1830 ;; Less common extensions come here
1831 ;; so more common ones above are found faster.
1870 ;; The list of archive file extensions should be in sync with
1871 ;; `auto-coding-alist' with `no-conversion' coding system.
1875 ;; Mailer puts message to be edited in
1876 ;; /tmp/Re.... or Message
1880 ;; some news reader is reported to use this
1889 ;; .emacs or .gnus or .viper following a directory delimiter in
1890 ;; Unix, MSDOG or VMS syntax.
1893 ;; _emacs following a directory delimiter
1894 ;; in MsDos syntax
1913 ;; Windows candidates may be opened case sensitively on Unix
1919 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1921 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1922 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
1923 ;; either user's dot-files or under /etc or some such
1925 ;; alas not all ~/.*rc files are like this
1926 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1931 ;; this contains everything twice, with space and with colon :-(
1933 ;; Get rid of any trailing .n.m and try again.
1934 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1935 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1936 ;; Using mode nil rather than `ignore' would let the search continue
1937 ;; through this list (with the shortened name) rather than start over.
1939 ;; The following should come after the ChangeLog pattern
1940 ;; for the sake of ChangeLog.1, etc.
1941 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1944 "Alist of filename patterns vs corresponding major mode functions.
1945 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1946 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1947 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1948 mode function to use. FUNCTION will be called, unless it is nil.
1950 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1951 calling FUNCTION (if it's not nil), we delete the suffix that matched
1952 REGEXP and search the list again for another match.
1954 If the file name matches `inhibit-first-line-modes-regexps',
1955 then `auto-mode-alist' is not processed.
1957 See also `interpreter-mode-alist', which detects executable script modes
1958 based on the interpreters they specify to run,
1962 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1963 ;; and pike-mode) are added through autoload directives in that
1964 ;; file. That way is discouraged since it spreads out the
1965 ;; definition of the initial value.
2003 "Alist mapping interpreter names to major modes.
2004 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2005 Each element looks like (INTERPRETER . MODE).
2006 If INTERPRETER matches the name of the interpreter specified in the first line
2007 of a script, mode MODE is enabled.
2015 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2016 When checking `inhibit-first-line-modes-regexps', we first discard
2022 "Regexp matching interpreters, for file mode determination.
2023 This regular expression is matched against the first line of a file
2024 to determine the file's mode in `set-auto-mode'. If it matches, the file
2025 is assumed to be interpreted by the interpreter matched by the second group
2026 of the regular expression. The mode is then determined as the mode
2031 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2032 ;; We use [ \t\n] instead of `\\s ' to make regex overflow less likely.
2036 comment-re "*"
2039 . html-mode)
2040 ;; These two must come after html, because they are more general:
2045 . sgml-mode)
2048 "Alist of buffer beginnings vs. corresponding major mode functions.
2049 Each element looks like (REGEXP . FUNCTION). After visiting a file,
2050 if REGEXP matches the text at the beginning of the buffer,
2051 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
2052 to decide the buffer's major mode.
2054 If FUNCTION is nil, then it is not called. (That is a way of saying
2061 "Select major mode appropriate for current buffer.
2063 This checks for a -*- mode tag in the buffer's text, checks the
2064 interpreter that runs this file against `interpreter-mode-alist',
2065 compares the buffer beginning against `magic-mode-alist', or
2066 compares the filename against the entries in `auto-mode-alist'.
2068 It does not check for the `mode:' local variable in the
2069 Local Variables section of the file; for that, use `hack-local-variables'.
2071 If `enable-local-variables' is nil, this function does not check for a
2072 -*- mode tag.
2074 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2075 only set the major mode, if that would change it."
2076 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2078 ;; Find a -*- mode tag
2085 ;; Find all specifications for the `mode:' variable
2086 ;; and execute them left to right.
2098 modes)))
2099 ;; Simple -*-MODE-*- case.
2102 modes))))
2103 ;; If we found modes to use, invoke them now, outside the save-excursion.
2111 ;; continuing would call minor modes again, toggling them off
2114 ;; If we didn't, look for an interpreter specified in the first line.
2115 ;; As a special case, allow for things like "#!/bin/env perl", which
2116 ;; finds the interpreter anywhere in $PATH.
2122 ;; Map interpreter name to a mode, signalling we're done at the
2123 ;; same time.
2125 interpreter-mode-alist))
2126 ;; If we found an interpreter mode to use, invoke it now.
2129 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2141 ;; Compare the filename against the entries in auto-mode-alist.
2144 ;; Remove backup-suffixes from file name.
2147 ;; Find first matching alist entry.
2160 ;; When `keep-mode-if-same' is set, we are working on behalf of
2161 ;; set-visited-file-name. In that case, if the major mode specified is the
2162 ;; same one we already have, don't actually reset it. We don't want to lose
2163 ;; minor modes such as Font Lock.
2165 "Apply MODE and return it.
2166 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2167 any aliases and compared to current major mode. If they are the
2168 same, do nothing and return nil."
2176 mode))
2179 "Find the -*- spec in the buffer.
2180 Call with point at the place to start searching from.
2181 If one is found, set point to the beginning
2182 and return the position of the end.
2183 Otherwise, return nil; point may be changed."
2186 ;; Don't look for -*- if this file name matches any
2187 ;; of the regexps in inhibit-first-line-modes-regexps.
2195 sufs)
2203 ;; If the file begins with "#!"
2204 ;; (exec interpreter magic), look
2205 ;; for mode frobs in the first two
2206 ;; lines. You cannot necessarily
2207 ;; put them in the first line of
2208 ;; such a file without screwing up
2209 ;; the interpreter invocation.
2220 end))))
2224 nil
2228 prompt char)
2238 ", and variables that are risky (**)."
2245 y -- to apply the local variables list.
2246 n -- to ignore the local variables list.
2247 ! -- to apply the local variables list, and mark these values (*) as
2266 done)
2284 'safe-local-variable-values
2285 safe-local-variable-values))
2292 "Return local variables specified in the -*- line.
2293 Ignore any specification for `mode:' and `coding:';
2294 `set-auto-mode' should already have handled `mode:',
2295 `set-auto-coding' should already have handled `coding:'.
2297 If MODE-ONLY is non-nil, all we do is check whether the major
2298 mode is specified, returning t if it is specified. Otherwise,
2299 return an alist of elements (VAR . VAL), where VAR is a variable
2300 and VAL is the specified value."
2304 result mode-specified)
2305 ;; Parse the -*- line into the RESULT alist.
2306 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2308 nil)
2310 ;; Simple form: "-*- MODENAME -*-". Already handled.
2312 nil)
2314 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2315 ;; (last ";" is optional).
2320 ;; There used to be a downcase here,
2321 ;; but the manual didn't say so,
2322 ;; and people want to set var names that aren't all lc.
2329 ;; It is traditional to ignore
2330 ;; case when checking for `mode' in set-auto-mode,
2331 ;; so we must do that here as well.
2332 ;; That is inconsistent, but we're stuck with it.
2333 ;; The same can be said for `coding' in set-auto-coding.
2339 'eval
2346 mode-specified
2347 result))))
2350 "Normal hook run after processing a file's local variables specs.
2351 Major modes can use this to examine user-specified local variables
2355 "List variable-value pairs that are considered safe.
2356 Each element is a cons cell (VAR . VAL), where VAR is a variable
2357 symbol and VAL is a value that is considered safe."
2362 "Parse and put into effect this buffer's local variables spec.
2363 If MODE-ONLY is non-nil, all we do is check whether the major mode
2364 is specified, returning t if it is specified."
2367 result)
2370 ;; Look for "Local variables:" line in last page.
2378 ;; suffix is what comes after "local variables:" in its line.
2379 ;; prefix is what comes before "local variables:" in its line.
2389 beg)
2393 endpos
2399 nil t))
2409 ;; Discard the prefix.
2414 ;; Discard the suffix.
2422 ;; Find the variable name; strip whitespace.
2430 val)
2431 ;; Read the variable value.
2441 'eval
2447 ;; We've read all the local variables. Now, return whether the
2448 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2449 ;; variables (if MODE-ONLY is nil.)
2451 result
2458 ;; Find those variables that we may want to save to
2459 ;; `safe-local-variable-values'.
2477 result unsafe-vars risky-vars))
2486 ;; Get confirmation before setting these variables as locals in a file.
2512 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2542 ;; Commonly-encountered local variables that are safe:
2569 "Non-nil if SYM is safe as a file-local variable with value VAL.
2570 It is safe if any of these conditions are met:
2572 * There is a matching entry (SYM . VAL) in the
2573 `safe-local-variable-values' user option.
2575 * The `safe-local-variable' property of SYM is t.
2577 * The `safe-local-variable' property of SYM is a function that
2578 evaluates to a non-nil value with VAL as an argument."
2586 "Non-nil if SYM could be dangerous as a file-local variable.
2587 It is dangerous if either of these conditions are met:
2589 * Its `risky-local-variable' property is non-nil.
2595 ;; If this is an alias, check the base name.
2607 Add expressions to this list if you want Emacs to evaluate them, when
2608 they appear in an `eval' local variable specification, without first
2609 asking you for confirmation."
2626 "Return t if it is safe to eval EXP when it is found in a file."
2628 ;; Detect certain `put' expressions.
2634 ;; Only allow safe values of lisp-indent-hook;
2635 ;; not functions.
2638 ;; Allow expressions that the user requested.
2640 ;; Certain functions can be allowed with safe arguments
2641 ;; or can specify verification functions to try.
2649 ok))
2657 ok)))))))
2660 "Set local variable VAR with value VAL."
2667 ;; Make sure the string has no text properties.
2668 ;; Some text properties can get evaluated in various ways,
2669 ;; so it is risky to put them on with a local variable list.
2674 \f
2677 However, the mode will not be changed if
2678 \(1) a local variables list or the `-*-' line specifies a major mode, or
2680 \ not suitable for ordinary files, or
2681 \(3) the new file name does not particularly specify any mode."
2686 "Change name of file visited in current buffer to FILENAME.
2687 This also renames the buffer to correspond to the new file.
2688 The next time the buffer is saved it will go in the newly specified file.
2689 FILENAME nil or an empty string means mark buffer as not visiting any file.
2690 Remember to delete the initial contents of the minibuffer
2691 if you wish to pass an empty string as the argument.
2693 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2694 confirmation in the case where another buffer is already visiting FILENAME.
2696 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2697 the old visited file has been renamed to the new name FILENAME."
2705 nil
2720 filename)))
2732 ;; If new-name == old-name, renaming would add a spurious <2>
2733 ;; and it's considered as a feature in rename-buffer.
2739 ;; Abbreviate the file names of the buffer.
2748 nil)))
2749 ;; write-file-functions is normally used for things like ftp-find-file
2750 ;; that visit things that are not local files as if they were files.
2751 ;; Changing to visit an ordinary local file instead should flush the hook.
2756 ;; If buffer was read-only because of version control,
2757 ;; that reason is gone now, so make it writable.
2761 ;; Turn off backup files for certain file names.
2762 ;; Since this is a permanent local, the major mode won't eliminate it.
2769 ;; If auto-save was not already on, turn it on if appropriate.
2773 ;; If auto save is on, start using a new name.
2774 ;; We deliberately don't rename or delete the old auto save
2775 ;; for the old visited file name. This is because perhaps
2776 ;; the user wants to save the new state and then compare with the
2777 ;; previous state from the auto save file.
2780 ;; Rename the old auto save file if any.
2787 ;; Update the major mode, if the file name determines it.
2789 ;; Don't change the mode if it is special.
2792 ;; Don't change the mode if the local variable list specifies it.
2798 "Write current buffer into file FILENAME.
2799 This makes the buffer visit that file, and marks it as not modified.
2801 If you specify just a directory name as FILENAME, that means to use
2802 the default file name but in that directory. You can also yank
2803 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2805 If the buffer is not already visiting a file, the default file name
2806 for the output file is the buffer name.
2808 If optional second arg CONFIRM is non-nil, this function
2809 asks for confirmation before overwriting an existing file.
2810 Interactively, confirmation is required unless you supply a prefix argument."
2811 ;; (interactive "FWrite file: ")
2815 nil nil nil nil)
2819 default-directory)
2820 nil nil))
2824 ;; If arg is just a directory,
2825 ;; use the default file name, but in that directory.
2836 ;; Make buffer writable if file is writable.
2841 ;; It's likely that the VC status at the new location is different from
2842 ;; the one at the old location.
2844 \f
2846 "Make a backup of the disk file visited by the current buffer, if appropriate.
2847 This is normally done before saving the buffer the first time.
2849 A backup may be done by renaming or by copying; see documentation of
2850 variable `make-backup-files'. If it's done by renaming, then the file is
2851 no longer accessible under its old name.
2853 The value is non-nil after a backup was made by renaming.
2854 It has the form (MODES . BACKUPNAME).
2855 MODES is the result of `file-modes' on the original
2856 file; this means that the caller, after saving the buffer, should change
2857 the modes of the new file to agree with the old modes.
2858 BACKUPNAME is the backup file name, which is the old file renamed."
2865 backup-info backupname targets setmodes)
2866 ;; If specified name is a symbolic link, chase it to the target.
2867 ;; Thus we make the backups in the directory where the real file is.
2872 ;; (if (file-directory-p buffer-file-name)
2873 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2877 ;; If have old versions to maybe delete,
2878 ;; ask the user to confirm now, before doing anything.
2879 ;; But don't actually delete til later.
2884 real-file-name)))))
2886 ;; Actually write the back up file.
2889 ; (file-symlink-p buffer-file-name)
2890 backup-by-copying
2891 ;; Don't rename a suid or sgid file.
2906 ;; rename-file should delete old backup.
2910 ;; If trouble writing the backup, write it in ~.
2919 ;; Now delete the old versions, if desired.
2926 setmodes)
2933 ;; Create temp files with strict access rights. It's easy to
2934 ;; loosen them later, whereas it's impossible to close the
2935 ;; time-window of loose permissions otherwise.
2943 nil)
2945 ;; The file was somehow created by someone else between
2946 ;; `delete-file' and `copy-file', so let's try again.
2947 nil))
2948 ;; Reset the umask.
2954 "Return file NAME sans backup versions or strings.
2955 This is a separate procedure so your site-init or startup file can
2956 redefine it.
2957 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2958 we do not remove backup version numbers, only true file version numbers."
2964 ;; VMS version number is (a) semicolon, optional
2965 ;; sign, zero or more digits or (b) period, option
2966 ;; sign, zero or more digits, provided this is the
2967 ;; second period encountered outside of the
2968 ;; device/directory part of the file name.
2971 name)
2981 "Return t if deleting FILE and rewriting it would preserve the owner."
2986 ;; Return t if the file doesn't exist, since it's true that no
2987 ;; information would be lost by an (attempted) delete and create.
2993 The extension, in a file name, is the part that follows the last `.',
2994 except that a leading `.', if any, doesn't count."
2997 directory)
3001 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3002 ;; we don't want to expand it.
3005 filename))))
3009 The extension, in a file name, is the part that follows the last `.',
3010 except that a leading `.', if any, doesn't count.
3011 Return nil for extensionless file names such as `foo'.
3012 Return the empty string for file names such as `foo.'.
3014 If PERIOD is non-nil, then the returned value includes the period
3015 that delimits the extension, and if FILENAME has no extension,
3026 "A function to use instead of the default `make-backup-file-name'.
3027 A value of nil gives the default `make-backup-file-name' behavior.
3029 This could be buffer-local to do something special for specific
3030 files. If you define it, you may need to change `backup-file-name-p'
3031 and `file-name-sans-versions' too.
3033 See also `backup-directory-alist'."
3039 "Alist of filename patterns and backup directory names.
3040 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3041 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3042 relative or absolute. If it is absolute, so that all matching files
3043 are backed up into the same directory, the file names in this
3044 directory will be the full name of the file backed up with all
3045 directory separators changed to `!' to prevent clashes. This will not
3046 work correctly if your filesystem truncates the resulting name.
3048 For the common case of all backups going into one directory, the alist
3050 directory name.
3052 If this variable is nil, or it fails to match a filename, the backup
3053 is made in the original file's directory.
3055 On MS-DOS filesystems without long names this variable is always
3056 ignored."
3062 "Default `backup-enable-predicate' function.
3063 Checks for files in `temporary-file-directory',
3064 `small-temporary-file-directory', and /tmp."
3067 ;; Directory is under temporary-file-directory.
3072 ;; Directory is under /tmp.
3077 0 nil
3079 ;; Directory is under small-temporary-file-directory.
3084 "Create the non-numeric backup file name for FILE.
3085 Normally this will just be the file's name with `~' appended.
3086 Customization hooks are provided as follows.
3088 If the variable `make-backup-file-name-function' is non-nil, its value
3089 should be a function which will be called with FILE as its argument;
3090 the resulting name is used.
3092 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3093 the documentation of that variable. If the directory for the backup
3094 doesn't exist, it is created."
3108 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3110 elt backup-directory)
3115 alist nil)))
3121 file
3125 ;; Normalize DOSish file names: downcase the drive
3126 ;; letter, if any, and replace the leading "x:" with
3127 ;; "/drive_x".
3130 ;; Replace any invalid file-name characters (for the
3131 ;; case of backing up remote files).
3135 "drive_"
3138 ""
3141 ;; Make the name unique by substituting directory
3142 ;; separators. It may not really be worth bothering about
3143 ;; doubling `!'s in the original name...
3148 backup-directory))
3155 "Return non-nil if FILE is a backup file name (numeric or not).
3156 This is a separate function so you can redefine it for customization.
3157 You may need to redefine `file-name-sans-versions' as well."
3162 ;; This is used in various files.
3163 ;; The usage of backup-extract-version-start is not very clean,
3164 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3166 "Given the name of a numeric backup file, FN, return the backup number.
3167 Uses the free variable `backup-extract-version-start', whose value should be
3168 the index in the name where the version number begins."
3174 ;; I believe there is no need to alter this behavior for VMS;
3175 ;; since backup files are not made on VMS, it should not get called.
3177 "Find a file name for a backup file FN, and suggestions for deletions.
3178 Value is a list whose car is the name for the backup file
3179 and whose cdr is a list of old versions to consider deleting now.
3180 If the value is nil, don't make a backup.
3181 Uses `backup-directory-alist' in the same way as does
3182 `make-backup-file-name'."
3184 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3188 ;; We don't support numbered backups on plain MS-DOS
3189 ;; when long file names are unavailable.
3199 possibilities deserve-versions-p versions)
3202 base-versions
3205 possibilities)
3206 #'<)
3211 kept-old-versions
3212 kept-new-versions
3219 ;; Delete nothing if there is overflow
3220 ;; in the number of versions to keep.
3226 v))))))))))
3229 "Return number of names file FILENAME has."
3232 ;; (defun file-relative-name (filename &optional directory)
3233 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3234 ;; This function returns a relative file name which is equivalent to FILENAME
3235 ;; when used with that default directory as the default.
3236 ;; If this is impossible (which can happen on MSDOS and Windows
3237 ;; when the file name and directory use different drive names)
3238 ;; then it returns FILENAME."
3239 ;; (save-match-data
3240 ;; (let ((fname (expand-file-name filename)))
3241 ;; (setq directory (file-name-as-directory
3242 ;; (expand-file-name (or directory default-directory))))
3243 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3244 ;; ;; drive names, they can't be relative, so return the absolute name.
3245 ;; (if (and (or (eq system-type 'ms-dos)
3246 ;; (eq system-type 'cygwin)
3247 ;; (eq system-type 'windows-nt))
3248 ;; (not (string-equal (substring fname 0 2)
3249 ;; (substring directory 0 2))))
3250 ;; filename
3251 ;; (let ((ancestor ".")
3252 ;; (fname-dir (file-name-as-directory fname)))
3253 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3254 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3255 ;; (setq directory (file-name-directory (substring directory 0 -1))
3256 ;; ancestor (if (equal ancestor ".")
3257 ;; ".."
3258 ;; (concat "../" ancestor))))
3259 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3260 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3261 ;; ;; We matched within FNAME's directory part.
3262 ;; ;; Add the rest of FNAME onto ANCESTOR.
3263 ;; (let ((rest (substring fname (match-end 0))))
3264 ;; (if (and (equal ancestor ".")
3265 ;; (not (equal rest "")))
3266 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3267 ;; rest
3268 ;; (concat (file-name-as-directory ancestor) rest)))
3269 ;; ;; We matched FNAME's directory equivalent.
3270 ;; ancestor))))))
3273 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3274 This function returns a relative file name which is equivalent to FILENAME
3275 when used with that default directory as the default.
3276 If FILENAME and DIRECTORY lie on different machines or on different drives
3277 on a DOS/Windows machine, it returns FILENAME in expanded form."
3281 default-directory))))
3287 ;; Test for different drives on DOS/Windows
3289 ;; Should `cygwin' really be included here? --stef
3292 ;; Test for different remote file system identification
3294 filename
3300 directory nil nil case-fold-search))
3302 directory nil nil case-fold-search))))
3305 ".."
3307 ;; Now ancestor is empty, or .., or ../.., etc.
3309 directory nil nil case-fold-search))
3310 ;; We matched within FILENAME's directory part.
3311 ;; Add the rest of FILENAME onto ANCESTOR.
3314 ;; But don't bother with ANCESTOR if it would give us `./'.
3315 rest
3317 ;; We matched FILENAME's directory equivalent.
3318 ancestor))))))
3319 \f
3321 "Save current buffer in visited file if modified.
3322 Variations are described below.
3324 By default, makes the previous version into a backup file
3325 if previously requested or if this is the first save.
3327 to become a backup when the next save is done.
3329 unconditionally makes the previous version into a backup file.
3331 to become a backup when the next save is done,
3332 and unconditionally makes the previous version into a backup file.
3334 With a numeric argument of 0, never make the previous version
3335 into a backup file.
3337 If a file's name is FOO, the names of its numbered backup versions are
3338 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3339 Numeric backups (rather than FOO~) will be made if value of
3340 `version-control' is not the atom `never' and either there are already
3341 numeric versions of the file being backed up, or `version-control' is
3342 non-nil.
3343 We don't want excessive versions piling up, so there are variables
3344 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3345 and `kept-new-versions', which tells how many newest versions to keep.
3346 Defaults are 2 old versions and 2 new.
3347 `dired-kept-versions' controls dired's clean-directory (.) command.
3348 If `delete-old-versions' is nil, system will query user
3349 before trimming versions. Otherwise it does it silently.
3351 If `vc-make-backup-files' is nil, which is the default,
3352 no backup files are made for files managed by version control.
3353 (This is because the version control system itself records previous versions.)
3355 See the subroutine `basic-save-buffer' for more information."
3368 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3369 Normally delete only if the file was written by this Emacs since
3370 the last real save, but optional arg FORCE non-nil means delete anyway."
3384 "Normal hook that is run before a buffer is saved to its file."
3390 "Normal hook that is run after a buffer is saved to its file."
3396 "If non-nil, use this coding system for saving the buffer.
3397 More precisely, use this coding system in place of the
3398 value of `buffer-file-coding-system', when saving the buffer.
3399 Calling `write-region' for any purpose other than saving the buffer
3400 will still use `buffer-file-coding-system'; this variable has no effect
3407 "Save the current buffer in its visited file, if it has been modified.
3408 The hooks `write-contents-functions' and `write-file-functions' get a chance
3409 to do the job of saving; if they do not, then the buffer is saved in
3410 the visited file in the usual way.
3411 Before and after saving the buffer, this function runs
3412 `before-save-hook' and `after-save-hook', respectively."
3415 ;; In an indirect buffer, save its base buffer instead.
3420 setmodes)
3421 ;; On VMS, rename file and buffer to get rid of version number.
3426 ;; Strip VMS version number before save.
3429 ;; Construct a (unique) buffer name to correspond.
3434 ;; If buffer has no file name, ask user for one.
3441 filename))
3467 ;; Support VC version backups.
3473 ;; If a hook returned t, file is already "written".
3474 ;; Otherwise, write it the usual way now.
3476 ;; Now we have saved the current buffer. Let's make sure
3477 ;; that buffer-file-coding-system is fixed to what
3478 ;; actually used for saving by binding it locally.
3488 ;; If the auto-save file was recent before this command,
3489 ;; delete it now.
3491 ;; Support VC `implicit' locking.
3496 ;; This does the "real job" of writing a buffer into its visited file
3497 ;; and making a backup file. This is what is normally done
3498 ;; but inhibited if one of write-file-functions returns non-nil.
3499 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3508 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3522 buffer-file-name)))
3530 ;; If file is precious, write temp name, then rename it.
3531 ;; This requires write access to the containing dir,
3532 ;; which is why we don't try it if we don't have that access.
3534 tempname succeed
3537 ;; Create temp files with strict access rights. It's easy to
3538 ;; loosen them later, whereas it's impossible to close the
3539 ;; time-window of loose permissions otherwise.
3544 ;; Try various temporary names.
3545 ;; This code follows the example of make-temp-file,
3546 ;; but it calls write-region in the appropriate way
3547 ;; for saving the buffer.
3554 tempname nil realname
3556 nil)
3558 ;; The file was somehow created by someone else between
3559 ;; `make-temp-name' and `write-region', let's try again.
3560 nil)
3562 ;; Reset the umask.
3564 ;; If we failed, restore the buffer's modtime.
3567 ;; Since we have created an entirely new file,
3568 ;; make sure it gets the right permission bits set.
3570 buffer-file-name)))
3571 ;; We succeeded in writing the temp file,
3572 ;; so rename it.
3574 ;; If file not writable, see if we can make it writable
3575 ;; temporarily while we write it.
3576 ;; But no need to do so if we have just backed it up
3577 ;; (setmodes is set) because that says we're superseding.
3579 ;; Change the mode back, after writing.
3586 buffer-file-name nil t buffer-file-truename)
3588 ;; If we get an error writing the new file, and we made
3589 ;; the backup by renaming, undo the backing-up.
3594 setmodes))
3597 "View the differences between BUFFER and its associated file.
3598 This requires the external program `diff' to be in your `exec-path'."
3613 ;; Display that message for 1 second so that user can read it
3614 ;; in the minibuffer.
3616 ;; return always nil, so that save-buffers-kill-emacs will not move
3617 ;; over to the next unsaved buffer when calling `d'.
3618 nil)
3621 '((?\C-r
3627 ;; Return nil to ask about BUF again.
3628 nil)
3630 (?d diff-buffer-with-file
3640 "Save some modified file-visiting buffers. Asks user about each one.
3641 You can answer `y' to save, `n' not to save, `C-r' to look at the
3642 buffer in question with `view-buffer' before deciding or `d' to
3643 view the differences using `diff-buffer-with-file'.
3645 Optional argument (the prefix) non-nil means save all with no questions.
3646 Optional second argument PRED determines which buffers are considered:
3647 If PRED is nil, all the file-visiting buffers are considered.
3648 If PRED is t, then certain non-file buffers will also be considered.
3649 If PRED is a zero-argument function, it indicates for each buffer whether
3650 to consider it or not when called with that buffer current.
3652 See `save-some-buffers-action-alist' if you want to
3653 change the additional actions you can take on files."
3657 files-done abbrevs-done)
3659 ;; First save any buffers that we're supposed to save unconditionally.
3660 ;; That way the following code won't ask about them.
3665 ;; Ask about those buffers that merit it,
3666 ;; and record the number thus saved.
3682 t
3695 save-some-buffers-action-alist))
3696 ;; Maybe to save abbrevs, and record whether
3697 ;; we either saved them or asked to.
3703 abbrev-file-name)))
3705 ;; Don't keep bothering user if he says no.
3710 "(Some special files were saved without asking)"
3712 \f
3714 "Mark current buffer as unmodified, not needing to be saved.
3717 It is not a good idea to use this function in Lisp programs, because it
3718 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3725 "Change whether this buffer is visiting its file read-only.
3726 With arg, set read-only iff arg is positive.
3727 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3732 nil ; do nothing.
3733 ;; Toggle.
3740 ;; If view-mode is already active, `view-mode-enter' is a nop.
3752 "Insert contents of file FILENAME into buffer after point.
3753 Set mark after the inserted text.
3755 This function is meant for the user to run interactively.
3756 Don't call it from programs! Use `insert-file-contents' instead.
3757 \(Its calling sequence is different; see its documentation)."
3762 "Append the contents of the region to the end of file FILENAME.
3763 When called from a function, expects three arguments,
3764 START, END and FILENAME. START and END are buffer positions
3765 saying what text to write."
3770 "Return most recent backup file for FILENAME or nil if no backups exist."
3771 ;; `make-backup-file-name' will get us the right directory for
3772 ;; ordinary or numeric backups. It might create a directory for
3773 ;; backups as a side-effect, according to `backup-directory-alist'.
3780 tem)
3789 newest))
3792 "Rename current buffer to a similar name not already taken.
3793 This function is useful for creating multiple shell process buffers
3794 or multiple mail buffers, etc."
3802 ;; If the existing buffer name has a <NNN>,
3803 ;; which isn't part of the file name (if any),
3804 ;; then get rid of that.
3810 "Create the directory DIR and any nonexistent parent dirs.
3811 Interactively, the default choice of directory to create
3812 is the current default directory for file names.
3813 That is useful when you have visited a file in a nonexistent directory.
3815 Noninteractively, the second (optional) argument PARENTS says whether
3816 to create parent directories if they don't exist. Interactively,
3817 this happens by default."
3820 nil nil)
3821 t))
3822 ;; If default-directory is a remote directory,
3823 ;; make sure we find its make-directory handler.
3831 create-list)
3838 \f
3841 "Function to use to revert this buffer, or nil to do the default.
3842 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3847 "Function to use to insert contents when reverting this buffer.
3848 Gets two args, first the nominal file name to use,
3849 and second, t if reading the auto-save file.
3854 "Function to check whether a non-file buffer needs reverting.
3855 This should be a function with one optional argument NOCONFIRM.
3856 Auto Revert Mode passes t for NOCONFIRM. The function should return
3857 non-nil if the buffer should be reverted. A return value of
3858 `fast' means that the need for reverting was not checked, but
3859 that reverting the buffer is fast. The buffer is current when
3860 this function is called.
3862 The idea behind the NOCONFIRM argument is that it should be
3863 non-nil if the buffer is going to be reverted without asking the
3864 user. In such situations, one has to be careful with potentially
3865 time consuming operations.
3867 For more information on how this variable is used by Auto Revert mode,
3871 "Normal hook for `revert-buffer' to run before reverting.
3872 If `revert-buffer-function' is used to override the normal revert
3876 "Normal hook for `revert-buffer' to run after reverting.
3877 Note that the hook value that it runs is the value that was in effect
3878 before reverting; that makes a difference if you have buffer-local
3879 hook functions.
3881 If `revert-buffer-function' is used to override the normal revert
3887 "Replace current buffer text with the text of the visited file on disk.
3888 This undoes all changes since the file was visited or saved.
3889 With a prefix argument, offer to revert from latest auto-save file, if
3890 that is more recent than the visited file.
3892 This command also works for special buffers that contain text which
3893 doesn't come from a file, but reflects some other data base instead:
3894 for example, Dired buffers and `buffer-list' buffers. In these cases,
3895 it reconstructs the buffer contents from the appropriate data base.
3897 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3898 to revert from the auto-save file when this is nil. Note that the
3899 sense of this argument is the reverse of the prefix argument, for the
3900 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3901 to nil.
3903 Optional second argument NOCONFIRM means don't ask for confirmation at
3904 all. \(The variable `revert-without-query' offers another way to
3905 revert buffers without querying for confirmation.)
3907 Optional third argument PRESERVE-MODES non-nil means don't alter
3908 the files modes. Normally we reinitialize them using `normal-mode'.
3910 If the value of `revert-buffer-function' is non-nil, it is called to
3911 do all the work for this command. Otherwise, the hooks
3912 `before-revert-hook' and `after-revert-hook' are run at the beginning
3913 and the end, and if `revert-buffer-insert-file-contents-function' is
3914 non-nil, it is called instead of rereading visited file contents."
3916 ;; I admit it's odd to reverse the sense of the prefix argument, but
3917 ;; there is a lot of code out there which assumes that the first
3918 ;; argument should be t to avoid consulting the auto-save file, and
3919 ;; there's no straightforward way to encourage authors to notice a
3920 ;; reversal of the argument sense. So I'm just changing the user
3921 ;; interface, but leaving the programmatic interface the same.
3929 buffer-auto-save-file-name
3934 buffer-auto-save-file-name
3935 buffer-file-name)))
3945 file-name)))
3947 ;; If file was backed up but has changed since,
3948 ;; we shd make another backup.
3952 ;; Effectively copy the after-revert-hook status,
3953 ;; since after-find-file will clobber it.
3956 after-revert-hook))
3961 ;; Get rid of all undo records for this buffer.
3963 ;; Don't make undo records for the reversion.
3966 file-name auto-save-p)))
3969 "File %s no longer exists!"
3971 file-name))
3973 ;; Bind buffer-file-name to nil
3974 ;; so that we don't try to lock the file.
3980 ;; Auto-saved file should be read by Emacs'
3981 ;; internal coding.
3984 buffer-file-coding-system-explicit))))
3985 ;; This force after-insert-file-set-coding
3986 ;; (called from insert-file-contents) to set
3987 ;; buffer-file-coding-system to a proper value.
3990 ;; Note that this preserves point in an intelligent way.
3994 nil nil t))
3996 nil nil t)))))
3997 ;; Recompute the truename in case changes in symlinks
3998 ;; have changed the truename.
4002 ;; Run after-revert-hook as it was before we reverted.
4006 local-hook)
4009 t))))))
4012 "Recover the visited file--get contents from its last auto-save file."
4017 "Visit file FILE, but get contents from its last auto-save file."
4018 ;; Actually putting the file name in the minibuffer should be used
4019 ;; only rarely.
4020 ;; Not just because users often use the default.
4040 ;; Use insert-directory-safely, not insert-directory,
4041 ;; because these files might not exist. In particular,
4042 ;; FILE might not exist if the auto-save file was for
4043 ;; a buffer that didn't visit a file, such as "*mail*".
4044 ;; The code in v20.x called `ls' directly, so we need
4045 ;; to emulate what `ls' did in that case.
4051 ;; Keep the current buffer-file-coding-system.
4053 ;; Auto-saved file shoule be read with special coding.
4062 "Recover auto save files from a previous Emacs session.
4063 This command first displays a Dired buffer showing you the
4064 previous sessions that you could recover from.
4065 To choose one, move point to the proper line and then type C-c C-c.
4066 Then you'll be asked about a number of files to recover."
4076 auto-save-list-file-prefix)))
4077 t)
4086 ;; Each line starts with a space
4087 ;; so that Font Lock mode won't highlight the first character.
4096 "Choose one saved session to recover auto-save files from.
4097 This command is used in the special Dired buffer created by
4100 ;; Get the name of the session file to recover from.
4102 files
4108 ;; Read in the auto-save-list file.
4112 ;; Loop thru the text of that file
4113 ;; and get out the names of the files to recover.
4117 ;; This is a pair of lines for a non-file-visiting buffer.
4118 ;; Get the auto-save file name and manufacture
4119 ;; a "visited file name" from that.
4122 ;; If there is no auto-save file name, the
4123 ;; auto-save-list file is probably corrupted.
4138 ;; This pair of lines is a file-visiting
4139 ;; buffer. Use the visited file name.
4149 ;; Ignore a file if its auto-save file does not exist now.
4153 ;; The file contains a pair of line for each auto-saved buffer.
4154 ;; The first line of the pair contains the visited file name
4155 ;; or is empty if the buffer was not visiting a file.
4156 ;; The second line is the auto-save file name.
4164 files
4170 "Kill some buffers. Asks the user whether to kill each one of them.
4171 Non-interactively, if optional argument LIST is non-nil, it
4172 specifies the list of buffers to kill, asking for approval for each one."
4180 ; if we killed the base buffer.
4185 name
4190 \f
4192 "Toggle auto-saving of contents of current buffer.
4193 With prefix argument ARG, turn auto-saving on if positive, else off."
4198 ;; If auto-save is off because buffer has shrunk,
4199 ;; then toggling should turn it on.
4204 buffer-file-name
4206 ;; If -1 was stored here, to temporarily turn off saving,
4207 ;; turn it back on.
4213 buffer-auto-save-file-name)
4216 "Adjust current buffer's auto save file name for current conditions.
4217 Also rename any existing auto save file, if it was made in this session."
4229 "Return file name to use for auto-saves of current buffer.
4230 Does not consider `auto-save-visited-file-name' as that variable is checked
4231 before calling this function. You can redefine this for customization.
4232 See also `auto-save-file-name-p'."
4240 result uniq)
4241 ;; Apply user-specified translations
4242 ;; to the file name.
4246 filename)
4256 filename))))
4261 ;; We truncate the file name to DOS 8+3 limits
4262 ;; before doing anything else, because the regexp
4263 ;; passed to string-match below cannot handle
4264 ;; extensions longer than 3 characters, multiple
4265 ;; dots, and other atrocities.
4270 fn)
4275 "#"
4278 ;; Make sure auto-save file names don't contain characters
4279 ;; invalid for the underlying filesystem.
4281 ;; Don't modify remote (ange-ftp) filenames
4284 result))))
4286 ;; Deal with buffers that don't have any associated files. (Mail
4287 ;; mode tends to create a good number of these.)
4291 file-name)
4292 ;; Eliminate all slashes and backslashes by
4293 ;; replacing them with sequences that start with %.
4294 ;; Quote % also, to keep distinct names distinct.
4303 ;; Generate the file name.
4309 ;; Try a few alternative directories, to get one we can
4310 ;; write it.
4316 ;; Don't modify remote (ange-ftp) filenames
4318 ;; The call to convert-standard-filename is in case
4319 ;; buffer-name includes characters not allowed by the
4320 ;; DOS/Windows filesystems. make-temp-file writes to the
4321 ;; file it creates, so we must fix the file name _before_
4322 ;; make-temp-file is called.
4324 fname))
4326 ;; make-temp-file creates the file,
4327 ;; but we don't want it to exist until we do an auto-save.
4331 file-name)))
4334 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4335 FILENAME should lack slashes. You can redefine this for customization."
4337 \f
4339 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4340 The generated regexp will match a filename iff the filename
4341 matches that wildcard according to shell rules. Only wildcards known
4342 by `sh' are supported."
4344 ;; Copy the initial run of non-special characters.
4347 ;; If no special characters, we're almost done.
4351 j)
4353 result
4374 ;; Found "[^". Insert a `\0' character
4375 ;; (which cannot happen in a filename)
4376 ;; into the character class, so that `^'
4377 ;; is not the first character after `[',
4378 ;; and thus non-special in a regexp.
4383 ;; I don't think `]' can appear in a
4384 ;; character class in a wildcard, but
4385 ;; let's be general here.
4392 i
4405 ;; Shell wildcards should match the entire filename,
4406 ;; not its part. Make the regexp say so.
4408 \f
4411 "*Switches for `list-directory' to pass to `ls' for brief listing."
4417 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4419 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4424 "Expand wildcard pattern PATTERN.
4425 This returns a list of file names which match the pattern.
4427 If PATTERN is written as an absolute file name,
4428 the values are absolute also.
4430 If PATTERN is written as a relative file name, it is interpreted
4431 relative to the current default directory, `default-directory'.
4432 The file names returned are normally also relative to the current
4433 default directory. However, if FULL is non-nil, they are absolute."
4437 ;; A list of all dirs that DIRPART specifies.
4438 ;; This can be more than one dir
4439 ;; if DIRPART contains wildcards.
4444 contents)
4449 ;; Filter out "." and ".."
4454 name))
4461 this-dir-contents)
4462 this-dir-contents)
4463 contents))))
4465 contents)))
4468 "Display a list of files in or matching DIRNAME, a la `ls'.
4469 DIRNAME is globbed by the shell if necessary.
4470 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4471 Actions controlled by variables `list-directory-brief-switches'
4472 and `list-directory-verbose-switches'."
4476 nil default-directory nil)
4477 pfx)))
4479 list-directory-brief-switches))
4480 buffer)
4493 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4501 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4503 PATTERN is assumed to represent a file-name wildcard suitable for the
4504 underlying filesystem. For Unix and GNU/Linux, the characters from the
4506 the parts of the pattern which don't include wildcard characters are
4507 quoted with double quotes.
4508 Existing quote characters in PATTERN are left alone, so you can pass
4509 PATTERN that already quotes some of the special characters."
4513 ;; DOS/Windows don't allow `"' in file names. So if the
4514 ;; argument has quotes, we can safely assume it is already
4515 ;; quoted by the caller.
4517 ;; We quote [&()#$'] in case their shell is a port of a
4518 ;; Unixy shell. We quote [,=+] because stock DOS and
4519 ;; Windows shells require that in some cases, such as
4520 ;; passing arguments to batch files that use positional
4521 ;; arguments like %1.
4523 pattern
4526 end)
4543 pattern))))
4550 "*Program to get the amount of free space on a file system.
4551 We assume the output has the format of `df'.
4552 The value of this variable must be just a command name or file name;
4553 if you want to specify options, use `directory-free-space-args'.
4555 A value of nil disables this feature.
4557 If the function `file-system-info' is defined, it is always used in
4558 preference to the program given by this variable."
4564 "*Options to use when running `directory-free-space-program'."
4569 "Return the amount of free space on directory DIR's file system.
4570 The result is a string that gives the number of free 1KB blocks,
4571 or nil if the system call or the program which retrieve the information
4572 fail.
4574 This function calls `file-system-info' if it is available, or invokes the
4575 program specified by `directory-free-space-program' if that is non-nil."
4576 ;; Try to find the number of free blocks. Non-Posix systems don't
4577 ;; always have df, but might have an equivalent system call.
4586 nil t nil
4587 directory-free-space-args
4588 dir)))
4589 ;; Usual format is a header line followed by a line of
4590 ;; numbers.
4595 ;; Move to the end of the "available blocks" number.
4598 ;; Copy it into AVAILABLE.
4603 ;; The following expression replaces `dired-move-to-filename-regexp'.
4607 ;; In some locales, month abbreviations are as short as 2 letters,
4608 ;; and they can be followed by ".".
4609 ;; In Breton, a month name can include a quote character.
4622 s "+"
4625 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4626 ;; omits the Kanji characters after month and day-of-month.
4627 ;; On Mac OS X 10.3, the date format in East Asian locales is
4628 ;; day-of-month digits followed by month digits.
4634 ;; The "[0-9]" below requires the previous column to end in a digit.
4635 ;; This avoids recognizing `1 may 1997' as a date in the line:
4636 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4638 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4639 ;; The ".*" below finds the last match if there are multiple matches.
4640 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4641 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4643 ;; vc dired listings provide the state or blanks between file
4644 ;; permissions and date. The state is always surrounded by
4645 ;; parantheses:
4646 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4647 ;; This is not supported yet.
4651 "Regular expression to match up to the file name in a directory listing.
4652 The default value is designed to recognize dates and times
4657 ;; insert-directory
4658 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4659 ;; FULL-DIRECTORY-P is nil.
4660 ;; The single line of output must display FILE's name as it was
4661 ;; given, namely, an absolute path name.
4662 ;; - must insert exactly one line for each file if WILDCARD or
4663 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4664 ;; before the file lines, plus optional text after the file lines.
4665 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4666 ;; allowed.
4667 ;; File lines should display the basename.
4668 ;; - must be consistent with
4669 ;; - functions dired-move-to-filename, (these two define what a file line is)
4670 ;; dired-move-to-end-of-filename,
4671 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4672 ;; dired-insert-headerline
4673 ;; dired-after-subdir-garbage (defines what a "total" line is)
4674 ;; - variable dired-subdir-regexp
4675 ;; - may be passed "--dired" as the first argument in SWITCHES.
4676 ;; Filename handlers might have to remove this switch if their
4677 ;; "ls" command does not support it.
4679 "Insert directory listing for FILE, formatted according to SWITCHES.
4680 Leaves point after the inserted text.
4681 SWITCHES may be a string of options, or a list of strings
4682 representing individual options.
4683 Optional third arg WILDCARD means treat FILE as shell wildcard.
4684 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4685 switches do not contain `d', so that a full listing is expected.
4687 This works by running a directory listing program
4688 whose name is in the variable `insert-directory-program'.
4689 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4691 When SWITCHES contains the long `--dired' option, this function
4692 treats it specially, for the sake of dired. However, the
4693 normally equivalent short `-D' option is just passed on to
4694 `insert-directory-program', as any other option."
4695 ;; We need the directory in order to find the right handler.
4700 wildcard full-directory-p)
4705 ;; Read the actual directory using `insert-directory-program'.
4706 ;; RESULT gets the status code.
4708 ;; putting text property `dired-filename, decode one
4709 ;; bunch by one to preserve that property.
4711 ;; This is to control encoding the arguments in call-process.
4715 default-file-name-coding-system))))
4718 ;; Run ls in the directory part of the file pattern
4719 ;; using the last component as argument.
4726 shell-file-name nil t nil
4727 "-c"
4729 ""
4731 insert-directory-program
4732 " -d "
4734 switches
4736 " -- "
4737 ;; Quote some characters that have
4738 ;; special meanings in shells; but
4739 ;; don't quote the wildcards--we want
4740 ;; them to be special. We also
4741 ;; currently don't quote the quoting
4742 ;; characters in case people want to
4743 ;; use them explicitly to quote
4744 ;; wildcard characters.
4746 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4747 ;; directory if FILE is a symbolic link.
4749 insert-directory-program nil t nil
4753 ;; Split the switches at any spaces so we can
4754 ;; pass separate options as separate args.
4756 ;; Avoid lossage if FILE starts with `-'.
4764 file))))))))
4766 ;; If we got "//DIRED//" in the output, it means we got a real
4767 ;; directory listing, even if `ls' returned nonzero.
4768 ;; So ignore any errors.
4781 ;; The first time ls returns an error,
4782 ;; find the version numbers of ls,
4783 ;; and set insert-directory-ls-version
4784 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4785 ;; is equal or if the info cannot be obtained.
4786 ;; (That can mean it isn't GNU ls.)
4796 comparison)
4812 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4816 ;; If `insert-directory-program' failed, signal an error.
4818 ;; Delete the error message it may have output.
4820 ;; On non-Posix systems, we cannot open a directory, so
4821 ;; don't even try, because that will always result in
4822 ;; the ubiquitous "Access denied". Instead, show the
4823 ;; command line so the user can try to guess what went wrong.
4828 insert-directory-program
4830 file result)
4831 ;; Unix. Access the file to get a suitable error.
4838 ;; The following overshoots by one line for an empty
4839 ;; directory listed with "--dired", but without "-a"
4840 ;; switch, where the ls output contains a
4841 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4842 ;; We take care of that case later.
4850 error-lines)
4851 ;; Find all the lines that are error messages,
4852 ;; and record the bounds of each one.
4859 ;; Now read the numeric positions of file names.
4866 error-lines))
4869 error-lines)))
4871 ;; End is followed by \n or by " -> ".
4873 ;; It seems that we can't trust ls's output as to
4874 ;; byte positions of filenames.
4880 ;; Take care of the case where the ls output contains a
4881 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4882 ;; and we went one line too far back (see above).
4887 ;; Now decode what read if necessary.
4889 file-name-coding-system
4890 default-file-name-coding-system
4892 coding-no-eol
4893 val pos)
4897 ;; If no coding system is specified or detection is
4898 ;; requested, detect the coding.
4912 ;; Force no eol conversion on a file name, so
4913 ;; that CR is preserved.
4921 ;; Try to insert the amount of free space.
4924 ;; First find the line to put it on.
4928 ;; Replace "total" with "used", to avoid confusion.
4934 "Convert `ls --dired' file name position value POS to a buffer position.
4935 File name position values returned in ls --dired output
4936 count only stdout; they don't count the error messages sent to stderr.
4937 So this function converts to them to real buffer positions.
4938 ERROR-LINES is a list of buffer positions of error message lines,
4939 of the form (START END)."
4943 pos)
4947 "Insert directory listing for FILE, formatted according to SWITCHES.
4949 Like `insert-directory', but if FILE does not exist, it inserts a
4950 message to that effect instead of signaling an error."
4953 ;; Simulate the message printed by `ls'.
4957 "Functions to call with no arguments to query about killing Emacs.
4958 If any of these functions returns nil, killing Emacs is cancelled.
4960 but `kill-emacs', the low level primitive, does not.
4964 "How to ask for confirmation when leaving Emacs.
4965 If nil, the default, don't ask at all. If the value is non-nil, it should
4966 be a predicate function such as `yes-or-no-p'."
4974 "Offer to save each buffer, then kill this Emacs process.
4975 With prefix arg, silently save all file-visiting buffers, then kill."
4984 ;; process-list is not defined on VMS.
4986 active)
4995 ;; Query the user for other things, perhaps.
5000 \f
5001 ;; We use /: as a prefix to "quote" a file name
5002 ;; so that magic file name handlers will not apply to it.
5006 file-name-handler-alist))
5008 ;; We depend on being the last handler on the list,
5009 ;; so that anything else which does need handling
5010 ;; has been handled already.
5011 ;; So it is safe for us to inhibit *all* magic file name handlers.
5020 default-directory))
5021 ;; Get a list of the indices of the args which are file names.
5024 ;; The first six are special because they
5025 ;; return a file name. We want to include the /:
5026 ;; in the return value.
5027 ;; So just avoid stripping it in the first place.
5034 ;; `identity' means just return the first arg
5035 ;; not stripped of its quoting.
5037 ;; `add' means add "/:" to the result.
5039 ;; `quote' means add "/:" to buffer-file-name.
5041 ;; `unquote-then-quote' means set buffer-file-name
5042 ;; temporarily to unquoted filename.
5044 ;; List the arguments which are filenames.
5052 ;; For all other operations, treat the first argument only
5053 ;; as the file name.
5055 method
5056 ;; Copy ARGUMENTS so we can replace elements in it.
5060 ;; Strip off the /: from the file names that have it.
5068 "/"
5084 res))
5087 \f
5111 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5112 ;;; files.el ends here