| blob | 3a922e3d7088cd2446e35da5fd5bfced6a7c96bb |
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, 2007 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."
168 "Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
199 "The directory for writing temporary files."
205 "The directory for writing small temporary files.
206 If non-nil, this directory is used instead of `temporary-file-directory'
207 by programs that create small temporary files. This is for systems that
208 have fast storage with limited space, such as a RAM disk."
212 ;; The system null device. (Should reference NULL_DEVICE from C.)
229 "Non-nil means protect against I/O errors while saving files.
230 Some modes set this non-nil in particular buffers.
232 This feature works by writing the new contents into a temporary file
233 and then renaming the temporary file to replace the original.
234 In this way, any I/O error in writing leaves the original untouched,
235 and there is never any instant where the file is nonexistent.
237 Note that this feature forces backups to be made by copying.
238 Yet, at the same time, saving a precious file
239 breaks any hard links between it and other files."
244 "Control use of version numbers for backup files.
245 When t, make numeric backup versions unconditionally.
246 When nil, make them for files that have some already.
247 The value `never' means do not make them."
257 "When cleaning directory, number of versions to keep."
263 "If t, delete excess backup versions silently.
264 If nil, ask confirmation. Any other value prevents any trimming."
271 "Number of oldest versions to keep when a new numbered backup is made."
277 "Number of newest versions to keep when a new numbered backup is made.
278 Includes the new backup. Must be > 0"
284 "Whether to add a newline automatically at the end of the file.
286 A value of t means do this only when the file is about to be saved.
287 A value of `visit' means do this right after the file is visited.
288 A value of `visit-save' means do it at both of those times.
289 Any other non-nil value means ask user whether to add a newline, when saving.
290 A value of nil means don't add newlines.
292 Certain major modes set this locally to the value obtained
293 from `mode-require-final-newline'."
302 "Whether to add a newline at end of file, in certain major modes.
303 Those modes set `require-final-newline' to this value when you enable them.
304 They do so because they are often used for files that are supposed
305 to end in newlines, and the question is how to arrange that.
307 A value of t means do this only when the file is about to be saved.
308 A value of `visit' means do this right after the file is visited.
309 A value of `visit-save' means do it at both of those times.
310 Any other non-nil value means ask user whether to add a newline, when saving.
312 A value of nil means do not add newlines. That is a risky choice in this
313 variable since this value is used for modes for files that ought to have
314 final newlines. So if you set this to nil, you must explicitly check and
315 add a final newline, whenever you save a file that really needs one."
325 "Non-nil says by default do auto-saving of every file-visiting buffer."
330 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
331 Normally auto-save files are written under other names."
337 ;; Don't put "\\2" inside expand-file-name, since it will be
338 ;; transformed to "/2" on DOS/Windows.
340 "Transforms to apply to buffer file name before making auto-save file name.
341 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
342 REGEXP is a regular expression to match against the file name.
343 If it matches, `replace-match' is used to replace the
344 matching part with REPLACEMENT.
345 If the optional element UNIQUIFY is non-nil, the auto-save file name is
346 constructed by taking the directory part of the replaced file-name,
347 concatenated with the buffer file name with all directory separators
348 changed to `!' to prevent clashes. This will not work
349 correctly if your filesystem truncates the resulting name.
351 All the transforms in the list are tried, in the order they are listed.
352 When one transform applies, its result is final;
353 no further transforms are tried.
355 The default value is set up to put the auto-save file into the
356 temporary directory (see the variable `temporary-file-directory') for
357 editing a remote file.
359 On MS-DOS filesystems without long names this variable is always
360 ignored."
367 "Non-nil means save word abbrevs too when files are saved.
368 If `silently', don't ask the user before saving."
373 "Non-nil means allow `find-file' to visit directories.
374 To visit the directory, `find-file' runs `find-directory-functions'."
379 "List of functions to try in sequence to visit a directory.
380 Each function is called with the directory name as the sole argument
381 and should return either a buffer or nil."
385 ;;;It is not useful to make this a local variable.
386 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
388 "List of functions to be called for `find-file' on nonexistent file.
389 These functions are called as soon as the error is detected.
390 Variable `buffer-file-name' is already set up.
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-hooks 'permanent-local t)
398 "List of functions to be called after a buffer is loaded from a file.
399 The buffer's local variables (if any) will have been processed before the
400 functions are called."
408 "List of functions to be called before writing out a buffer to a file.
409 If one of them returns non-nil, the file is considered already written
410 and the rest are not called.
411 These hooks are considered to pertain to the visited file.
412 So any buffer-local binding of this variable is discarded if you change
414 change the major mode.
416 This hook is not run if any of the functions in
417 `write-contents-functions' returns non-nil. Both hooks pertain
418 to how to save a buffer to file, for instance, choosing a suitable
419 coding system and setting mode bits. (See Info
420 node `(elisp)Saving Buffers'.) To perform various checks or
431 "List of functions to be called before writing out a buffer to a file.
432 If one of them returns non-nil, the file is considered already written
433 and the rest are not called and neither are the functions in
434 `write-file-functions'.
436 This variable is meant to be used for hooks that pertain to the
437 buffer's contents, not to the particular visited file; thus,
438 `set-visited-file-name' does not clear this variable; but changing the
439 major mode does clear it.
441 For hooks that _do_ pertain to the particular visited file, use
442 `write-file-functions'. Both this variable and
443 `write-file-functions' relate to how a buffer is saved to file.
444 To perform various checks or updates before the buffer is saved,
451 "Control use of local variables in files you visit.
452 The value can be t, nil, :safe, or something else.
454 A value of t means file local variables specifications are obeyed
455 if all the specified variable values are safe; if any values are
456 not safe, Emacs queries you, once, whether to set them all.
457 \(When you say yes to certain values, they are remembered as safe.)
459 :safe means set the safe variables, and ignore the rest.
460 :all means set all variables, whether safe or not.
461 (Don't set it permanently to :all.)
462 A value of nil means always ignore the file local variables.
464 Any other value means always query you once whether to set them all.
465 \(When you say yes to certain values, they are remembered as safe, but
468 This variable also controls use of major modes specified in
469 a -*- line.
472 always obeys file local variable specifications and the -*- line,
473 and ignores this variable."
482 "Like `enable-local-variables' but meant for buffer-local bindings.
483 The meaningful values are nil and non-nil. The default is non-nil.
484 If a major mode sets this to nil, buffer-locally, then any local
485 variables list in the file will be ignored.
487 This variable does not affect the use of major modes
492 The value can be t, nil or something else.
493 A value of t means obey `eval' variables;
494 A value of nil means ignore them; anything else means query."
500 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
509 "Non-nil means buffers visiting files read-only do so in view mode.
510 In fact, this means that all read-only buffers normally have
511 View mode enabled, including buffers that are read-only because
512 you visit a file you cannot alter, and buffers you make read-only
519 \f
522 "Provides support for ange-ftp host name completion.
523 Runs the usual ange-ftp hook, but only for completion operations."
524 ;; Having this here avoids the need to load ange-ftp when it's not
525 ;; really in use.
531 inhibit-file-name-handlers)))
536 "Convert a standard file's name to something suitable for the OS.
537 This means to guarantee valid names and perhaps to canonicalize
538 certain patterns.
540 FILENAME should be an absolute file name since the conversion rules
541 sometimes vary depending on the position in the file name. E.g. c:/foo
542 is a valid DOS file name, but c:/bar/c:/foo is not.
544 This function's standard definition is trivial; it just returns
545 the argument. However, on Windows and DOS, replace invalid
546 characters. On DOS, make sure to obey the 8.3 limitations.
547 In the native Windows build, turn Cygwin names into native names,
548 and also turn slashes into backslashes if the shell requires it (see
549 `w32-shell-dos-semantics').
551 See Info node `(elisp)Standard File Names' for more details."
555 ;; Replace invalid filename characters with !
559 name)
560 filename))
563 "Read directory name, prompting with PROMPT and completing in directory DIR.
564 Value is not expanded---you must call `expand-file-name' yourself.
565 Default name to DEFAULT-DIRNAME if user exits with the same
566 non-empty string that was inserted by this function.
567 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
568 or just DIR if INITIAL is nil.)
569 If the user exits with an empty minibuffer, this function returns
570 an empty string. (This can only happen if the user erased the
571 pre-inserted contents or if `insert-default-directory' is nil.)
572 Fourth arg MUSTMATCH non-nil means require existing directory's name.
573 Non-nil and non-t means also require confirmation after completion.
574 Fifth arg INITIAL specifies text to start with.
575 DIR should be an absolute directory name. It defaults to
576 the value of `default-directory'."
581 dir))
582 mustmatch initial
585 \f
587 "Show the current default directory."
592 "Value of the CDPATH environment variable, as a list.
596 "Explode a search path into a list of directory names.
597 Directories are separated by occurrences of `path-separator'
598 \(which is colon in GNU and GNU-like systems)."
599 ;; We could use split-string here.
607 nil
612 cd-list)))
615 "Change current directory to given absolute file name DIR."
616 ;; Put the name into directory syntax now,
617 ;; because otherwise expand-file-name may give some bad results.
630 "Make DIR become the current buffer's default directory.
631 If your environment includes a `CDPATH' variable, try each one of
632 that list of directories (separated by occurrences of
633 `path-separator') when resolving a relative directory name.
634 The path separator is colon in GNU and GNU-like systems."
637 default-directory default-directory
653 cd-path)
654 nil))
658 "Load the Lisp file named FILE."
659 ;; This is a case where .elc makes a lot of sense.
666 "Search for FILENAME through PATH.
667 If found, return the absolute file name of FILENAME, with its suffixes;
668 otherwise return nil.
669 PATH should be a list of directories to look in, like the lists in
670 `exec-path' or `load-path'.
671 If SUFFIXES is non-nil, it should be a list of suffixes to append to
674 If non-nil, PREDICATE is used instead of `file-readable-p'.
675 PREDICATE can also be an integer to pass to the `access' system call,
676 in which case file-name handlers are ignored. This usage is deprecated.
678 For compatibility, PREDICATE can also be one of the symbols
679 `executable', `readable', `writable', or `exists', or a list of
680 one or more of those symbols."
691 "Do completion for file names passed to `locate-file'.
692 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
715 "Look up the directory hierarchy from FILE for a file matching REGEXP."
720 ;; Abbreviate, so as to stop when we cross ~/.
722 files)
723 ;; As a heuristic, we stop looking up the hierarchy of directories as
724 ;; soon as we find a directory belonging to another user. This should
725 ;; save us from looking in things like /net and /afs. This assumes
726 ;; that all the files inside a project belong to the same user.
734 nil)))
737 "Search for COMMAND in `exec-path' and return the absolute file name.
738 Return nil if COMMAND is not found anywhere in `exec-path'."
739 ;; Use 1 rather than file-executable-p to better match the behavior of
740 ;; call-process.
744 "Load the library named LIBRARY.
745 This is an interface to the function `load'."
748 'locate-file-completion
753 "Test whether FILE specifies a location on a remote system.
754 Return an identification of the system if the location is indeed
755 remote. The identification of the system may comprise a method
756 to access the system and its hostname, amongst other things.
761 IDENTIFICATION specifies which part of the identification shall
762 be returned as string. IDENTIFICATION can be the symbol
763 `method', `user' or `host'; any other value is handled like nil
764 and means to return the complete identification string.
766 If CONNECTED is non-nil, the function returns an identification only
767 if FILE is located on a remote system, and a connection is established
768 to that remote system.
770 `file-remote-p' will never open a connection on its own."
774 nil)))
777 "Copy the file FILE into a temporary file on this machine.
778 Returns the name of the local copy, or nil, if FILE is directly
779 accessible."
780 ;; This formerly had an optional BUFFER argument that wasn't used by
781 ;; anything.
785 nil)))
788 "Return the truename of FILENAME, which should be absolute.
789 The truename of a file name is found by chasing symbolic links
790 both at the level of the file and at the level of the directories
791 containing it, until no links are left at any level.
794 ;; COUNTER and PREV-DIRS are only used in recursive calls.
795 ;; COUNTER can be a cons cell whose car is the count of how many
796 ;; more links to chase before getting an error.
797 ;; PREV-DIRS can be a cons cell whose car is an alist
798 ;; of truenames we've just recently computed.
812 ;; For speed, remove the ange-ftp completion handler from the list.
813 ;; We know it's not needed here.
814 ;; For even more speed, do this only on the outermost call.
821 ;; andrewi@harlequin.co.uk - none of the following code (except for
822 ;; invoking the file-name handler) currently applies on Windows
823 ;; (ie. there are no native symlinks), but there is an issue with
824 ;; case differences being ignored by the OS, and short "8.3 DOS"
825 ;; name aliases existing for all files. (The short names are not
826 ;; reported by directory-files, but can be used to refer to files.)
827 ;; It seems appropriate for file-truename to resolve these issues in
828 ;; the most natural way, which on Windows is to call the function
829 ;; `w32-long-file-name' - this returns the exact name of a file as
830 ;; it is stored on disk (expanding short name aliases with the full
831 ;; name in the process).
834 ;; For file name that has a special handler, call handler.
835 ;; This is so that ange-ftp can save time by doing a no-op.
838 ;; If filename contains a wildcard, newname will be the old name.
840 ;; If filename exists, use the long name
844 ;; If this file directly leads to a link, process that iteratively
845 ;; so that we don't use lots of stack.
851 ;; For file name that has a special handler, call handler.
852 ;; This is so that ange-ftp can save time by doing a no-op.
855 done t)
857 target dirfile)
858 ;; Get the truename of the directory.
860 ;; If these are equal, we have the (or a) root directory.
862 ;; If this is the same dir we last got the truename for,
863 ;; save time--don't recalculate.
873 done t)
876 done t)
877 ;; Put it back on the file name.
879 ;; Is the file name the name of a link?
882 ;; Yes => chase that link, then start all over
883 ;; since the link may point to a directory name that uses links.
884 ;; We can't safely use expand-file-name here
885 ;; since target might look like foo/../bar where foo
886 ;; is itself a link. Instead, we handle . and .. above.
889 target
891 done nil)
892 ;; No, we are done!
894 filename))
897 "Chase links in FILENAME until a name that is not a link.
898 Unlike `file-truename', this does not check whether a parent
899 directory name is a symbolic link.
900 If the optional argument LIMIT is a number,
901 it means chase no more than that many links and then stop."
909 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
912 ;; Handle `..' by hand, since it needs to work in the
913 ;; target of any directory symlink.
914 ;; This code is not quite complete; it does not handle
915 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
919 ;; Chase links in the default dir of the symlink.
923 ;; Now find the parent of that dir.
927 newname))
930 "Create a temporary file.
931 The returned file name (created by appending some random characters at the end
932 of PREFIX, and expanding against `temporary-file-directory' if necessary),
933 is guaranteed to point to a newly created empty file.
934 You can then use `write-region' to write new data into the file.
936 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
938 If SUFFIX is non-nil, add that at the end of the file name."
940 file)
943 ;; Create temp files with strict access rights. It's easy to
944 ;; loosen them later, whereas it's impossible to close the
945 ;; time-window of loose permissions otherwise.
957 nil)
959 ;; the file was somehow created by someone else between
960 ;; `make-temp-name' and `write-region', let's try again.
961 nil)
962 file)
963 ;; Reset the umask.
967 "Change the encoding of FILE's name from CODING to NEW-CODING.
968 The value is a new name of FILE.
969 Signals a `file-already-exists' error if a file of the new name
970 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
971 is non-nil. A number as fourth arg means request confirmation if
972 the new name already exists. This is what happens in interactive
973 use with M-x."
976 default-file-name-coding-system))
978 from-coding to-coding)
980 ;; We provide the default coding only when it seems that
981 ;; the filename is correctly decoded by the default
982 ;; coding.
988 filename default-coding)
989 default-coding))
993 ;; We provide the default coding only when a user is going to
994 ;; change the encoding not from the default coding.
998 filename from-coding)))
1001 filename from-coding default-coding)
1002 default-coding)))
1006 default-file-name-coding-system))
1007 ;; FILE should have been decoded by DEFAULT-CODING.
1011 ;; Suppress further encoding.
1016 newname))
1017 \f
1019 "Select buffer BUFFER in another window.
1020 If BUFFER does not identify an existing buffer, then this function
1021 creates a buffer with that name.
1023 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1024 or nil. If BUFFER is nil, then this function chooses a buffer
1025 using `other-buffer'.
1026 Optional second arg NORECORD non-nil means
1027 do not put this buffer at the front of the list of recently selected ones.
1028 This function returns the buffer it switched to.
1030 This uses the function `display-buffer' as a subroutine; see its
1031 documentation for additional customization information."
1034 ;; Don't let these interfere.
1035 same-window-buffer-names same-window-regexps)
1039 "Switch to buffer BUFFER in another frame.
1040 Optional second arg NORECORD non-nil means
1041 do not put this buffer at the front of the list of recently selected ones.
1043 This uses the function `display-buffer' as a subroutine; see its
1044 documentation for additional customization information."
1047 same-window-buffer-names same-window-regexps)
1052 "Switch to buffer BUFFER in another frame.
1053 This uses the function `display-buffer' as a subroutine; see its
1054 documentation for additional customization information."
1057 same-window-buffer-names same-window-regexps
1059 new-window)
1069 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1070 BODY should use the minibuffer at most once.
1071 Recursive uses of the minibuffer will not be affected."
1077 ;; Clear out this hook so it does not interfere
1078 ;; with any recursive minibuffer usage.
1088 "If non-nil, `find-file' requires confirmation before visiting a new file."
1100 t))
1103 "Edit file FILENAME.
1104 Switch to a buffer visiting file FILENAME,
1105 creating one if none already exists.
1106 Interactively, the default if you just type RET is the current directory,
1107 but the visited file name is available through the minibuffer history:
1108 type M-n to pull it into the minibuffer.
1110 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1111 expand wildcards (if any) and visit multiple files. You can
1112 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1114 To visit a file without any kind of conversion and without
1125 "Edit file FILENAME, in another window.
1126 May create a new window, or reuse an existing one.
1127 See the function `display-buffer'.
1129 Interactively, the default if you just type RET is the current directory,
1130 but the visited file name is available through the minibuffer history:
1131 type M-n to pull it into the minibuffer.
1133 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1134 expand wildcards (if any) and visit multiple files."
1147 "Edit file FILENAME, in another frame.
1148 May create a new frame, or reuse an existing one.
1149 See the function `display-buffer'.
1151 Interactively, the default if you just type RET is the current directory,
1152 but the visited file name is available through the minibuffer history:
1153 type M-n to pull it into the minibuffer.
1155 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1156 expand wildcards (if any) and visit multiple files."
1169 "Edit the existing file FILENAME.
1171 file names with wildcards."
1179 "Edit file FILENAME but don't allow changes.
1193 value))
1196 "Edit file FILENAME in another window but don't allow changes.
1210 value))
1213 "Edit file FILENAME in another frame but don't allow changes.
1227 value))
1230 "Find file FILENAME as a replacement for the file in the next window.
1231 This command does not select that window.
1233 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1234 expand wildcards (if any) and replace the file with multiple files."
1246 t))))
1254 "Find file FILENAME, select its buffer, kill previous buffer.
1255 If the current buffer now contains an empty file that you just visited
1256 \(presumably by mistake), use this command to visit the file you really want.
1258 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1259 expand wildcards (if any) and replace the file with multiple files.
1261 If the current buffer is an indirect buffer, or the base buffer
1262 for one or more indirect buffers, the other buffer(s) are not
1263 killed."
1273 t)))
1294 ;; This prevents us from finding the same buffer
1295 ;; if we specified the same file again.
1299 ;; Likewise for dired buffers.
1303 ;; This executes if find-file gets an error
1304 ;; and does not really find anything.
1305 ;; We put things back as they were.
1306 ;; If find-file actually finds something, we kill obuf below.
1315 ;; We already asked; don't ask again.
1318 \f
1320 "Create a suitably named buffer for visiting FILENAME, and return it.
1321 FILENAME (sans directory) is used unchanged if that name is free;
1322 otherwise a string <2> or <3> or ... is appended to get an unused name."
1329 "Create and return a buffer with a name based on NAME.
1330 Choose the buffer's name using `generate-new-buffer-name'."
1334 "Regexp to match the automounter prefix in a directory name."
1342 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1344 home directory is a root directory) and removes automounter prefixes
1345 \(see the variable `automount-dir-prefix')."
1346 ;; Get rid of the prefixes added by the automounter.
1354 ;; If any elt of directory-abbrev-alist matches this name,
1355 ;; abbreviate accordingly.
1361 ;; Compute and save the abbreviated homedir name.
1362 ;; We defer computing this until the first time it's needed, to
1363 ;; give time for directory-abbrev-alist to be set properly.
1364 ;; We include a slash at the end, to avoid spurious matches
1365 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1372 ;; If FILENAME starts with the abbreviated homedir,
1373 ;; make it start with `~' instead.
1375 ;; If the home dir is just /, don't change it.
1378 ;; MS-DOS root directories can come with a drive letter;
1379 ;; Novell Netware allows drive letters beyond `Z:'.
1389 filename)))
1392 "List of logical names for which visiting shouldn't save the true dirname.
1393 On VMS, when you visit a file using a logical name that searches a path,
1394 you may or may not want the visited file name to record the specific
1395 directory where the file was found. If you *do not* want that, add the logical
1396 name to this list as a string."
1401 "Return the buffer visiting file FILENAME (a string).
1402 This is like `get-file-buffer', except that it checks for any buffer
1403 visiting the same file, possibly under a different name.
1404 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1405 and others are ignored.
1406 If there is no such live buffer, return nil."
1420 found)
1430 ;; Verify this buffer's file number
1431 ;; still belongs to its file.
1434 attributes)
1438 found))))
1439 \f
1441 "Non-nil means file-visiting commands should handle wildcards.
1442 For example, if you specify `*.c', that would visit all the files
1443 whose names match the pattern."
1449 "Non-nil means suppress warning messages for symlinked files.
1450 When nil, Emacs prints a warning when visiting a file that is already
1451 visited, but with a different name. Setting this option to t
1452 suppresses this warning."
1458 "Maximum size of file above which a confirmation is requested.
1459 When nil, never request confirmation."
1466 "Read file FILENAME into a buffer and return the buffer.
1467 If a buffer exists visiting FILENAME, return that one, but
1468 verify that the file has not changed since visited or saved.
1469 The buffer is not selected, just returned to the caller.
1470 Optional second arg NOWARN non-nil means suppress any warning messages.
1471 Optional third arg RAWFILE non-nil means the file is read literally.
1472 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1473 and visit all the matching files. When wildcards are actually
1474 used and expanded, return a list of buffers that are visiting
1475 the various files."
1482 'find-directory-functions
1485 filename)))
1488 find-file-wildcards
1502 ;; Find any buffer for a file which has same truename.
1504 ;; Let user know if there is a buffer with the same truename.
1508 find-file-suppress-same-file-warnings
1512 ;; Optionally also find that buffer.
1515 ;; Check to see if the file looks uncommonly large.
1517 ;; Don't ask again if we already have the file or
1518 ;; if we're asked to be quiet.
1527 ;; We are using an existing buffer.
1534 ;; Certain files should be reverted automatically
1535 ;; if they have changed on disk and not in the buffer.
1543 found))
1553 "File %s changed on disk. Discard your edits? "
1558 "File %s changed on disk. Discard your edits in %s? "
1566 ;; Check if a formerly read-only file has become
1567 ;; writable and vice versa, but if the buffer agrees
1568 ;; with the new state of the file, that is ok too.
1576 buffer-file-name
1585 ;; It is confusing to ask whether to visit
1586 ;; non-literally if they have the file in
1587 ;; hexl-mode.
1593 "The file %s is already visited normally,
1594 and you have edited the buffer. Now you have asked to visit it literally,
1595 meaning no coding system handling, format conversion, or local variables.
1596 Emacs can only visit a file in one way at a time.
1598 Do you want to save the file, and visit it literally instead? "
1599 "The file %s is already visited literally,
1600 meaning no coding system handling, format conversion, or local variables.
1601 You have edited the buffer. Now you have asked to visit the file normally,
1602 but Emacs can only visit a file in one way at a time.
1609 rawfile truename number))
1613 "\
1614 Do you want to discard your changes, and visit the file literally now? "
1615 "\
1618 rawfile truename number)
1624 "The file %s is already visited normally.
1625 You have asked to visit it literally,
1626 meaning no coding system decoding, format conversion, or local variables.
1627 But Emacs can only visit a file in one way at a time.
1629 Do you want to revisit the file literally now? "
1630 "The file %s is already visited literally,
1631 meaning no coding system decoding, format conversion, or local variables.
1632 You have asked to visit it normally,
1633 but Emacs can only visit a file in one way at a time.
1638 rawfile truename number)
1641 ;; Return the buffer we are using.
1642 buf)
1643 ;; Create a new buffer.
1645 ;; find-file-noselect-1 may use a different buffer.
1647 rawfile truename number))))))
1653 ;; Needed in case we are re-visiting the file with a different
1654 ;; text representation.
1671 filename)))
1672 ;; Unconditionally set error
1682 filename)))
1683 ;; Run find-file-not-found-functions until one returns non-nil.
1685 ;; If they fail too, set error.
1687 ;; Record the file's truename, and maybe use that as visited name.
1693 ;; On VMS, we may want to remember which directory in a search list
1694 ;; the file was found in.
1704 ;; Set buffer's default directory to that of the file.
1706 ;; Turn off backup files for certain file names. Since
1707 ;; this is a permanent local, the major mode won't eliminate it.
1722 \f
1724 "Like `insert-file-contents', but only reads in the file literally.
1725 A buffer may be modified in several ways after reading into the buffer,
1726 to Emacs features such as format decoding, character code
1727 conversion, `find-file-hook', automatic uncompression, etc.
1729 This function ensures that none of these modifications will take place."
1737 nil))
1740 inhibit-file-name-handlers))
1753 filename)))
1763 "Insert contents of file FILENAME into buffer after point with no conversion.
1765 This function is meant for the user to run interactively.
1766 Don't call it from programs! Use `insert-file-contents-literally' instead.
1767 \(Its calling sequence is different; see its documentation)."
1772 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1777 "Visit file FILENAME with no conversion of any kind.
1778 Format conversion and character code conversion are both disabled,
1779 and multibyte characters are disabled in the resulting buffer.
1780 The major mode used is Fundamental mode regardless of the file name,
1781 and local variable specifications in the file are ignored.
1782 Automatic uncompression and adding a newline at the end of the
1783 file due to `require-final-newline' is also disabled.
1785 You cannot absolutely rely on this function to result in
1786 visiting the file literally. If Emacs already has a buffer
1787 which is visiting the file, you get the existing buffer,
1788 regardless of whether it was created literally or not.
1790 In a Lisp program, if you want to be sure of accessing a file's
1791 contents literally, you should create a temporary buffer and then read
1792 the file contents into it using `insert-file-contents-literally'."
1795 \f
1799 after-find-file-from-revert-buffer
1800 nomodes)
1801 "Called after finding a file and by the default revert function.
1802 Sets buffer mode, parses local variables.
1803 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1804 error in reading the file. WARN non-nil means warn if there
1805 exists an auto-save file more recent than the visited file.
1806 NOAUTO means don't mess with auto-save mode.
1807 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1808 means this call was from `revert-buffer'.
1809 Fifth arg NOMODES non-nil means don't alter the file's modes.
1810 Finishes by calling the functions in `find-file-hook'
1811 unless NOMODES is non-nil."
1814 nil
1824 ;; No need to warn if buffer is auto-saved
1825 ;; under the name of the visited file.
1827 auto-save-visited-file-name))
1830 buffer-file-name))
1850 ;; Make people do a little extra work (C-x C-q)
1851 ;; before altering a backup file.
1854 ;; When a file is marked read-only,
1855 ;; make the buffer read-only even if root is looking at it.
1863 ;; If requested, add a newline at the end of the file.
1873 view-read-only
1879 "Eval BODY and turn any error into a FORMAT message.
1880 FORMAT can have a %s escape which will be replaced with the actual error.
1881 If `debug-on-error' is set, errors are not caught, so that you can
1882 debug them.
1883 Avoid using a large BODY since it is duplicated."
1892 "Choose the major mode for this buffer automatically.
1893 Also sets up any specified local variables of the file.
1894 Uses the visited file name, the -*- line, and the local variables spec.
1896 This function is called automatically from `find-file'. In that case,
1897 we may set up the file-specified mode and local variables,
1898 depending on the value of `enable-local-variables'.
1899 In addition, if `local-enable-local-variables' is nil, we do
1900 not set local variables (though we do notice a mode specified with -*-.)
1902 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1903 or from Lisp without specifying the optional argument FIND-FILE;
1904 in that case, this function acts as if `enable-local-variables' were t."
1912 ;; Turn font lock off and on, to make sure it takes account of
1913 ;; whatever file local variables are relevant to it.
1915 ;; Font-lock-mode (now in font-core.el) can be ON when
1916 ;; font-lock.el still hasn't been loaded.
1926 "Non-nil means to try second pass through `auto-mode-alist'.
1927 This means that if the first case-sensitive search through the alist fails
1928 to find a matching major mode, a second case-insensitive search is made.
1929 On systems with case-insensitive file names, this variable is ignored,
1930 since only a single case-insensitive search through the alist is made."
1936 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1937 ;; c++-mode, java-mode and more) are added through autoload
1938 ;; directives in that file. That way is discouraged since it
1939 ;; spreads out the definition of the initial value.
1971 ;; Less common extensions come here
1972 ;; so more common ones above are found faster.
2011 ;; The list of archive file extensions should be in sync with
2012 ;; `auto-coding-alist' with `no-conversion' coding system.
2016 ;; Mailer puts message to be edited in
2017 ;; /tmp/Re.... or Message
2021 ;; some news reader is reported to use this
2030 ;; .emacs or .gnus or .viper following a directory delimiter in
2031 ;; Unix, MSDOG or VMS syntax.
2034 ;; _emacs following a directory delimiter
2035 ;; in MsDos syntax
2039 ;; Common Lisp ASDF package system.
2056 ;; Windows candidates may be opened case sensitively on Unix
2062 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2064 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2065 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2066 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2067 ;; this has lower priority to avoid matching changelog.sgml etc.
2069 ;; either user's dot-files or under /etc or some such
2071 ;; alas not all ~/.*rc files are like this
2072 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2077 ;; this contains everything twice, with space and with colon :-(
2079 ;; Get rid of any trailing .n.m and try again.
2080 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2081 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2082 ;; Using mode nil rather than `ignore' would let the search continue
2083 ;; through this list (with the shortened name) rather than start over.
2085 ;; The following should come after the ChangeLog pattern
2086 ;; for the sake of ChangeLog.1, etc.
2087 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2090 "Alist of filename patterns vs corresponding major mode functions.
2091 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2092 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2093 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2094 mode function to use. FUNCTION will be called, unless it is nil.
2096 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2097 calling FUNCTION (if it's not nil), we delete the suffix that matched
2098 REGEXP and search the list again for another match.
2100 If the file name matches `inhibit-first-line-modes-regexps',
2101 then `auto-mode-alist' is not processed.
2103 The extensions whose FUNCTION is `archive-mode' should also
2104 appear in `auto-coding-alist' with `no-conversion' coding system.
2106 See also `interpreter-mode-alist', which detects executable script modes
2107 based on the interpreters they specify to run,
2111 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2112 ;; and pike-mode) are added through autoload directives in that
2113 ;; file. That way is discouraged since it spreads out the
2114 ;; definition of the initial value.
2152 "Alist mapping interpreter names to major modes.
2153 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2154 Each element looks like (INTERPRETER . MODE).
2155 If INTERPRETER matches the name of the interpreter specified in the first line
2156 of a script, mode MODE is enabled.
2164 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2165 When checking `inhibit-first-line-modes-regexps', we first discard
2171 "Regexp matching interpreters, for file mode determination.
2172 This regular expression is matched against the first line of a file
2173 to determine the file's mode in `set-auto-mode'. If it matches, the file
2174 is assumed to be interpreted by the interpreter matched by the second group
2175 of the regular expression. The mode is then determined as the mode
2179 "Alist of buffer beginnings vs. corresponding major mode functions.
2180 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2181 After visiting a file, if REGEXP matches the text at the beginning of the
2182 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2183 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2184 major mode.
2186 If FUNCTION is nil, then it is not called. (That is a way of saying
2192 ;; The < comes before the groups (but the first) to reduce backtracking.
2193 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2194 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2198 comment-re "*"
2201 . html-mode)
2203 ;; These two must come after html, because they are more general:
2208 . sgml-mode)
2211 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2212 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2213 After visiting a file, if REGEXP matches the text at the beginning of the
2214 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2215 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2216 have not specified a mode for this file.
2222 "Upper limit on `magic-mode-alist' regexp matches.
2226 "Select major mode appropriate for current buffer.
2228 To find the right major mode, this function checks for a -*- mode tag,
2229 checks if it uses an interpreter listed in `interpreter-mode-alist',
2230 matches the buffer beginning against `magic-mode-alist',
2231 compares the filename against the entries in `auto-mode-alist',
2232 then matches the buffer beginning against `magic-fallback-mode-alist'.
2234 It does not check for the `mode:' local variable in the
2235 Local Variables section of the file; for that, use `hack-local-variables'.
2237 If `enable-local-variables' is nil, this function does not check for a
2238 -*- mode tag.
2240 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2241 set the major mode only if that would change it. In other words
2242 we don't actually set it to the same mode the buffer already has."
2243 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2245 ;; Find a -*- mode tag
2252 ;; Find all specifications for the `mode:' variable
2253 ;; and execute them left to right.
2265 modes)))
2266 ;; Simple -*-MODE-*- case.
2269 modes))))
2270 ;; If we found modes to use, invoke them now, outside the save-excursion.
2278 ;; continuing would call minor modes again, toggling them off
2280 ;; If we didn't, look for an interpreter specified in the first line.
2281 ;; As a special case, allow for things like "#!/bin/env perl", which
2282 ;; finds the interpreter anywhere in $PATH.
2289 ;; Map interpreter name to a mode, signalling we're done at the
2290 ;; same time.
2292 interpreter-mode-alist))
2293 ;; If we found an interpreter mode to use, invoke it now.
2296 ;; Next try matching the buffer beginning against magic-mode-alist.
2310 ;; Next compare the filename against the entries in auto-mode-alist.
2314 ;; Remove backup-suffixes from file name.
2317 ;; Find first matching alist entry.
2320 ;; System is case-insensitive.
2324 ;; System is case-sensitive.
2326 ;; First match case-sensitively.
2330 ;; Fallback to case-insensitive match.
2344 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2359 ;; When `keep-mode-if-same' is set, we are working on behalf of
2360 ;; set-visited-file-name. In that case, if the major mode specified is the
2361 ;; same one we already have, don't actually reset it. We don't want to lose
2362 ;; minor modes such as Font Lock.
2364 "Apply MODE and return it.
2365 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2366 any aliases and compared to current major mode. If they are the
2367 same, do nothing and return nil."
2373 mode)))
2376 "Find the -*- spec in the buffer.
2377 Call with point at the place to start searching from.
2378 If one is found, set point to the beginning
2379 and return the position of the end.
2380 Otherwise, return nil; point may be changed."
2383 ;; Don't look for -*- if this file name matches any
2384 ;; of the regexps in inhibit-first-line-modes-regexps.
2392 sufs)
2400 ;; If the file begins with "#!"
2401 ;; (exec interpreter magic), look
2402 ;; for mode frobs in the first two
2403 ;; lines. You cannot necessarily
2404 ;; put them in the first line of
2405 ;; such a file without screwing up
2406 ;; the interpreter invocation.
2417 end))))
2418 \f
2419 ;;; Handling file local variables
2426 "Normal hook run after processing a file's local variables specs.
2427 Major modes can use this to examine user-specified local variables
2431 "List variable-value pairs that are considered safe.
2432 Each element is a cons cell (VAR . VAL), where VAR is a variable
2433 symbol and VAL is a value that is considered safe."
2438 "Expressions that are considered safe in an `eval:' local variable.
2439 Add expressions to this list if you want Emacs to evaluate them, when
2440 they appear in an `eval' local variable specification, without first
2441 asking you for confirmation."
2446 ;; Risky local variables:
2449 auto-mode-alist
2450 buffer-auto-save-file-name
2451 buffer-file-name
2452 buffer-file-truename
2453 buffer-undo-list
2454 dabbrev-case-fold-search
2455 dabbrev-case-replace
2456 debugger
2457 default-text-properties
2458 display-time-string
2459 enable-local-eval
2460 enable-local-variables
2461 eval
2462 exec-directory
2463 exec-path
2464 file-name-handler-alist
2465 font-lock-defaults
2466 format-alist
2467 frame-title-format
2468 global-mode-string
2469 header-line-format
2470 icon-title-format
2471 ignored-local-variables
2472 imenu--index-alist
2473 imenu-generic-expression
2474 inhibit-quit
2475 input-method-alist
2476 load-path
2477 max-lisp-eval-depth
2478 max-specpdl-size
2479 minor-mode-alist
2480 minor-mode-map-alist
2481 minor-mode-overriding-map-alist
2482 mode-line-buffer-identification
2483 mode-line-format
2484 mode-line-modes
2485 mode-line-modified
2486 mode-line-mule-info
2487 mode-line-position
2488 mode-line-process
2489 mode-name
2490 outline-level
2491 overriding-local-map
2492 overriding-terminal-local-map
2493 parse-time-rules
2494 process-environment
2495 rmail-output-file-alist
2496 safe-local-variable-values
2497 safe-local-eval-forms
2498 save-some-buffers-action-alist
2499 special-display-buffer-names
2500 standard-input
2501 standard-output
2502 unread-command-events
2503 vc-mode))
2505 ;; Safe local variables:
2506 ;;
2507 ;; For variables defined by major modes, the safety declarations can go into
2508 ;; the major mode's file, since that will be loaded before file variables are
2509 ;; processed.
2510 ;;
2511 ;; For variables defined by minor modes, put the safety declarations in the
2512 ;; file defining the minor mode after the defcustom/defvar using an autoload
2513 ;; cookie, e.g.:
2514 ;;
2515 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2516 ;;
2517 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2518 ;; minor mode file may not be loaded yet.
2519 ;;
2520 ;; For variables defined in the C source code the declaration should go here:
2537 nil
2542 prompt char)
2552 ", and variables that are risky (**)."
2559 y -- to apply the local variables list.
2563 ! -- to apply the local variables list, and permanently mark these
2575 ;; Make strings with embedded whitespace easier to read.
2583 ""
2590 done)
2599 ;; read-event returns -1 if we are in a kbd
2600 ;; macro and there are no more events in the
2601 ;; macro. In that case, attempt to get an
2602 ;; event interactively.
2610 ;; When this is called from desktop-restore-file-buffer,
2611 ;; coding-system-for-read may be non-nil. Reset it before
2612 ;; writing to .emacs.
2616 'safe-local-variable-values
2617 safe-local-variable-values))))
2624 "Return local variables specified in the -*- line.
2625 Ignore any specification for `mode:' and `coding:';
2626 `set-auto-mode' should already have handled `mode:',
2627 `set-auto-coding' should already have handled `coding:'.
2629 If MODE-ONLY is non-nil, all we do is check whether the major
2630 mode is specified, returning t if it is specified. Otherwise,
2631 return an alist of elements (VAR . VAL), where VAR is a variable
2632 and VAL is the specified value."
2636 result mode-specified)
2637 ;; Parse the -*- line into the RESULT alist.
2638 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2640 nil)
2642 ;; Simple form: "-*- MODENAME -*-". Already handled.
2644 nil)
2646 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2647 ;; (last ";" is optional).
2652 ;; There used to be a downcase here,
2653 ;; but the manual didn't say so,
2654 ;; and people want to set var names that aren't all lc.
2659 ;; It is traditional to ignore
2660 ;; case when checking for `mode' in set-auto-mode,
2661 ;; so we must do that here as well.
2662 ;; That is inconsistent, but we're stuck with it.
2663 ;; The same can be said for `coding' in set-auto-coding.
2669 'eval
2676 mode-specified
2677 result))))
2680 "Parse and put into effect this buffer's local variables spec.
2681 If MODE-ONLY is non-nil, all we do is check whether the major mode
2682 is specified, returning t if it is specified."
2685 result)
2688 ;; Look for "Local variables:" line in last page.
2696 ;; suffix is what comes after "local variables:" in its line.
2697 ;; prefix is what comes before "local variables:" in its line.
2707 beg)
2711 endpos
2717 nil t))
2727 ;; Discard the prefix.
2732 ;; Discard the suffix.
2740 ;; Find the variable name; strip whitespace.
2748 val)
2749 ;; Read the variable value.
2759 'eval
2765 ;; We've read all the local variables. Now, return whether the
2766 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2767 ;; variables (if MODE-ONLY is nil.)
2769 result
2776 ;; Find those variables that we may want to save to
2777 ;; `safe-local-variable-values'.
2792 ;; If caller wants only the safe variables,
2793 ;; install only them.
2798 ;; Query, except in the case where all are known safe
2799 ;; if the user wants no quuery in that case.
2805 result unsafe-vars risky-vars))
2811 "Non-nil if SYM is safe as a file-local variable with value VAL.
2812 It is safe if any of these conditions are met:
2814 * There is a matching entry (SYM . VAL) in the
2815 `safe-local-variable-values' user option.
2817 * The `safe-local-variable' property of SYM is a function that
2818 evaluates to a non-nil value with VAL as an argument."
2824 "Non-nil if SYM could be dangerous as a file-local variable.
2825 It is dangerous if either of these conditions are met:
2827 * Its `risky-local-variable' property is non-nil.
2833 ;; If this is an alias, check the base name.
2853 "Return t if it is safe to eval EXP when it is found in a file."
2855 ;; Detect certain `put' expressions.
2861 ;; Only allow safe values of lisp-indent-hook;
2862 ;; not functions.
2865 ;; Only allow indirect form specs.
2866 ;; During bootstrapping, edebug-basic-spec might not be
2867 ;; defined yet.
2871 ;; Allow expressions that the user requested.
2873 ;; Certain functions can be allowed with safe arguments
2874 ;; or can specify verification functions to try.
2882 ok))
2890 ok)))))))
2893 "Set local variable VAR with value VAL.
2894 If VAR is `mode', call `VAL-mode' as a function unless it's
2895 already the major mode."
2905 ;; Make sure the string has no text properties.
2906 ;; Some text properties can get evaluated in various ways,
2907 ;; so it is risky to put them on with a local variable list.
2912 \f
2915 However, the mode will not be changed if
2916 \(1) a local variables list or the `-*-' line specifies a major mode, or
2918 \ not suitable for ordinary files, or
2919 \(3) the new file name does not particularly specify any mode."
2924 "Change name of file visited in current buffer to FILENAME.
2925 This also renames the buffer to correspond to the new file.
2926 The next time the buffer is saved it will go in the newly specified file.
2927 FILENAME nil or an empty string means mark buffer as not visiting any file.
2928 Remember to delete the initial contents of the minibuffer
2929 if you wish to pass an empty string as the argument.
2931 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2932 confirmation in the case where another buffer is already visiting FILENAME.
2934 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2935 the old visited file has been renamed to the new name FILENAME."
2943 nil
2958 filename)))
2970 ;; If new-name == old-name, renaming would add a spurious <2>
2971 ;; and it's considered as a feature in rename-buffer.
2977 ;; Abbreviate the file names of the buffer.
2986 nil)))
2987 ;; write-file-functions is normally used for things like ftp-find-file
2988 ;; that visit things that are not local files as if they were files.
2989 ;; Changing to visit an ordinary local file instead should flush the hook.
2994 ;; If buffer was read-only because of version control,
2995 ;; that reason is gone now, so make it writable.
2999 ;; Turn off backup files for certain file names.
3000 ;; Since this is a permanent local, the major mode won't eliminate it.
3002 backup-enable-predicate
3008 ;; If auto-save was not already on, turn it on if appropriate.
3012 ;; If auto save is on, start using a new name.
3013 ;; We deliberately don't rename or delete the old auto save
3014 ;; for the old visited file name. This is because perhaps
3015 ;; the user wants to save the new state and then compare with the
3016 ;; previous state from the auto save file.
3019 ;; Rename the old auto save file if any.
3026 ;; Update the major mode, if the file name determines it.
3028 ;; Don't change the mode if it is special.
3031 ;; Don't change the mode if the local variable list specifies it.
3037 "Write current buffer into file FILENAME.
3038 This makes the buffer visit that file, and marks it as not modified.
3040 If you specify just a directory name as FILENAME, that means to use
3041 the default file name but in that directory. You can also yank
3042 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3044 If the buffer is not already visiting a file, the default file name
3045 for the output file is the buffer name.
3047 If optional second arg CONFIRM is non-nil, this function
3048 asks for confirmation before overwriting an existing file.
3049 Interactively, confirmation is required unless you supply a prefix argument."
3050 ;; (interactive "FWrite file: ")
3054 nil nil nil nil)
3058 default-directory)
3059 nil nil))
3063 ;; If arg is just a directory,
3064 ;; use the default file name, but in that directory.
3075 ;; Make buffer writable if file is writable.
3080 ;; It's likely that the VC status at the new location is different from
3081 ;; the one at the old location.
3083 \f
3085 "Make a backup of the disk file visited by the current buffer, if appropriate.
3086 This is normally done before saving the buffer the first time.
3088 A backup may be done by renaming or by copying; see documentation of
3089 variable `make-backup-files'. If it's done by renaming, then the file is
3090 no longer accessible under its old name.
3092 The value is non-nil after a backup was made by renaming.
3093 It has the form (MODES . BACKUPNAME).
3094 MODES is the result of `file-modes' on the original
3095 file; this means that the caller, after saving the buffer, should change
3096 the modes of the new file to agree with the old modes.
3097 BACKUPNAME is the backup file name, which is the old file renamed."
3104 backup-info backupname targets setmodes)
3105 ;; If specified name is a symbolic link, chase it to the target.
3106 ;; Thus we make the backups in the directory where the real file is.
3111 ;; (if (file-directory-p buffer-file-name)
3112 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3116 ;; If have old versions to maybe delete,
3117 ;; ask the user to confirm now, before doing anything.
3118 ;; But don't actually delete til later.
3123 real-file-name)))))
3125 ;; Actually write the back up file.
3128 ; (file-symlink-p buffer-file-name)
3129 backup-by-copying
3130 ;; Don't rename a suid or sgid file.
3145 ;; rename-file should delete old backup.
3149 ;; If trouble writing the backup, write it in ~.
3154 backupname)
3158 ;; Now delete the old versions, if desired.
3165 setmodes)
3172 ;; Create temp files with strict access rights. It's easy to
3173 ;; loosen them later, whereas it's impossible to close the
3174 ;; time-window of loose permissions otherwise.
3182 nil)
3184 ;; The file was somehow created by someone else between
3185 ;; `delete-file' and `copy-file', so let's try again.
3186 nil))
3187 ;; Reset the umask.
3193 "Return file NAME sans backup versions or strings.
3194 This is a separate procedure so your site-init or startup file can
3195 redefine it.
3196 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3197 we do not remove backup version numbers, only true file version numbers."
3203 ;; VMS version number is (a) semicolon, optional
3204 ;; sign, zero or more digits or (b) period, option
3205 ;; sign, zero or more digits, provided this is the
3206 ;; second period encountered outside of the
3207 ;; device/directory part of the file name.
3210 name)
3220 "Return t if deleting FILE and rewriting it would preserve the owner."
3225 ;; Return t if the file doesn't exist, since it's true that no
3226 ;; information would be lost by an (attempted) delete and create.
3232 The extension, in a file name, is the part that follows the last `.',
3233 except that a leading `.', if any, doesn't count."
3236 directory)
3240 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3241 ;; we don't want to expand it.
3244 filename))))
3248 The extension, in a file name, is the part that follows the last `.',
3249 excluding version numbers and backup suffixes,
3250 except that a leading `.', if any, doesn't count.
3251 Return nil for extensionless file names such as `foo'.
3252 Return the empty string for file names such as `foo.'.
3254 If PERIOD is non-nil, then the returned value includes the period
3255 that delimits the extension, and if FILENAME has no extension,
3266 "A function to use instead of the default `make-backup-file-name'.
3267 A value of nil gives the default `make-backup-file-name' behavior.
3269 This could be buffer-local to do something special for specific
3270 files. If you define it, you may need to change `backup-file-name-p'
3271 and `file-name-sans-versions' too.
3273 See also `backup-directory-alist'."
3279 "Alist of filename patterns and backup directory names.
3280 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3281 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3282 relative or absolute. If it is absolute, so that all matching files
3283 are backed up into the same directory, the file names in this
3284 directory will be the full name of the file backed up with all
3285 directory separators changed to `!' to prevent clashes. This will not
3286 work correctly if your filesystem truncates the resulting name.
3288 For the common case of all backups going into one directory, the alist
3290 directory name.
3292 If this variable is nil, or it fails to match a filename, the backup
3293 is made in the original file's directory.
3295 On MS-DOS filesystems without long names this variable is always
3296 ignored."
3302 "Default `backup-enable-predicate' function.
3303 Checks for files in `temporary-file-directory',
3304 `small-temporary-file-directory', and /tmp."
3307 ;; Directory is under temporary-file-directory.
3312 ;; Directory is under /tmp.
3317 0 nil
3319 ;; Directory is under small-temporary-file-directory.
3324 "Create the non-numeric backup file name for FILE.
3325 Normally this will just be the file's name with `~' appended.
3326 Customization hooks are provided as follows.
3328 If the variable `make-backup-file-name-function' is non-nil, its value
3329 should be a function which will be called with FILE as its argument;
3330 the resulting name is used.
3332 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3333 the documentation of that variable. If the directory for the backup
3334 doesn't exist, it is created."
3348 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3350 elt backup-directory abs-backup-directory)
3355 alist nil)))
3356 ;; If backup-directory is relative, it should be relative to the
3357 ;; file's directory. By expanding explicitly here, we avoid
3358 ;; depending on default-directory.
3367 abs-backup-directory nil))))
3369 file
3373 ;; Normalize DOSish file names: downcase the drive
3374 ;; letter, if any, and replace the leading "x:" with
3375 ;; "/drive_x".
3378 ;; Replace any invalid file-name characters (for the
3379 ;; case of backing up remote files).
3383 "drive_"
3386 ""
3389 ;; Make the name unique by substituting directory
3390 ;; separators. It may not really be worth bothering about
3391 ;; doubling `!'s in the original name...
3396 backup-directory))
3401 "Return non-nil if FILE is a backup file name (numeric or not).
3402 This is a separate function so you can redefine it for customization.
3403 You may need to redefine `file-name-sans-versions' as well."
3408 ;; This is used in various files.
3409 ;; The usage of backup-extract-version-start is not very clean,
3410 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3412 "Given the name of a numeric backup file, FN, return the backup number.
3413 Uses the free variable `backup-extract-version-start', whose value should be
3414 the index in the name where the version number begins."
3420 ;; I believe there is no need to alter this behavior for VMS;
3421 ;; since backup files are not made on VMS, it should not get called.
3423 "Find a file name for a backup file FN, and suggestions for deletions.
3424 Value is a list whose car is the name for the backup file
3425 and whose cdr is a list of old versions to consider deleting now.
3426 If the value is nil, don't make a backup.
3427 Uses `backup-directory-alist' in the same way as does
3428 `make-backup-file-name'."
3430 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3434 ;; We don't support numbered backups on plain MS-DOS
3435 ;; when long file names are unavailable.
3445 possibilities deserve-versions-p versions)
3448 base-versions
3451 possibilities)
3452 #'<)
3457 kept-old-versions
3458 kept-new-versions
3465 ;; Delete nothing if there is overflow
3466 ;; in the number of versions to keep.
3472 v))))))))))
3475 "Return number of names file FILENAME has."
3478 ;; (defun file-relative-name (filename &optional directory)
3479 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3480 ;; This function returns a relative file name which is equivalent to FILENAME
3481 ;; when used with that default directory as the default.
3482 ;; If this is impossible (which can happen on MSDOS and Windows
3483 ;; when the file name and directory use different drive names)
3484 ;; then it returns FILENAME."
3485 ;; (save-match-data
3486 ;; (let ((fname (expand-file-name filename)))
3487 ;; (setq directory (file-name-as-directory
3488 ;; (expand-file-name (or directory default-directory))))
3489 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3490 ;; ;; drive names, they can't be relative, so return the absolute name.
3491 ;; (if (and (or (eq system-type 'ms-dos)
3492 ;; (eq system-type 'cygwin)
3493 ;; (eq system-type 'windows-nt))
3494 ;; (not (string-equal (substring fname 0 2)
3495 ;; (substring directory 0 2))))
3496 ;; filename
3497 ;; (let ((ancestor ".")
3498 ;; (fname-dir (file-name-as-directory fname)))
3499 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3500 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3501 ;; (setq directory (file-name-directory (substring directory 0 -1))
3502 ;; ancestor (if (equal ancestor ".")
3503 ;; ".."
3504 ;; (concat "../" ancestor))))
3505 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3506 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3507 ;; ;; We matched within FNAME's directory part.
3508 ;; ;; Add the rest of FNAME onto ANCESTOR.
3509 ;; (let ((rest (substring fname (match-end 0))))
3510 ;; (if (and (equal ancestor ".")
3511 ;; (not (equal rest "")))
3512 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3513 ;; rest
3514 ;; (concat (file-name-as-directory ancestor) rest)))
3515 ;; ;; We matched FNAME's directory equivalent.
3516 ;; ancestor))))))
3519 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3520 This function returns a relative file name which is equivalent to FILENAME
3521 when used with that default directory as the default.
3522 If FILENAME and DIRECTORY lie on different machines or on different drives
3523 on a DOS/Windows machine, it returns FILENAME in expanded form."
3527 default-directory))))
3533 ;; Test for different drives on DOS/Windows
3535 ;; Should `cygwin' really be included here? --stef
3538 ;; Test for different remote file system identification
3540 filename
3546 directory nil nil case-fold-search))
3548 directory nil nil case-fold-search))))
3551 ".."
3553 ;; Now ancestor is empty, or .., or ../.., etc.
3555 directory nil nil case-fold-search))
3556 ;; We matched within FILENAME's directory part.
3557 ;; Add the rest of FILENAME onto ANCESTOR.
3560 ;; But don't bother with ANCESTOR if it would give us `./'.
3561 rest
3563 ;; We matched FILENAME's directory equivalent.
3564 ancestor))))))
3565 \f
3567 "Save current buffer in visited file if modified.
3568 Variations are described below.
3570 By default, makes the previous version into a backup file
3571 if previously requested or if this is the first save.
3573 to become a backup when the next save is done.
3575 unconditionally makes the previous version into a backup file.
3577 to become a backup when the next save is done,
3578 and unconditionally makes the previous version into a backup file.
3580 With a numeric argument of 0, never make the previous version
3581 into a backup file.
3583 If a file's name is FOO, the names of its numbered backup versions are
3584 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3585 Numeric backups (rather than FOO~) will be made if value of
3586 `version-control' is not the atom `never' and either there are already
3587 numeric versions of the file being backed up, or `version-control' is
3588 non-nil.
3589 We don't want excessive versions piling up, so there are variables
3590 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3591 and `kept-new-versions', which tells how many newest versions to keep.
3592 Defaults are 2 old versions and 2 new.
3593 `dired-kept-versions' controls dired's clean-directory (.) command.
3594 If `delete-old-versions' is nil, system will query user
3595 before trimming versions. Otherwise it does it silently.
3597 If `vc-make-backup-files' is nil, which is the default,
3598 no backup files are made for files managed by version control.
3599 (This is because the version control system itself records previous versions.)
3601 See the subroutine `basic-save-buffer' for more information."
3614 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3615 Normally delete only if the file was written by this Emacs since
3616 the last real save, but optional arg FORCE non-nil means delete anyway."
3630 "Normal hook that is run before a buffer is saved to its file."
3636 "Normal hook that is run after a buffer is saved to its file."
3642 "If non-nil, use this coding system for saving the buffer.
3643 More precisely, use this coding system in place of the
3644 value of `buffer-file-coding-system', when saving the buffer.
3645 Calling `write-region' for any purpose other than saving the buffer
3646 will still use `buffer-file-coding-system'; this variable has no effect
3653 "Save the current buffer in its visited file, if it has been modified.
3654 The hooks `write-contents-functions' and `write-file-functions' get a chance
3655 to do the job of saving; if they do not, then the buffer is saved in
3656 the visited file in the usual way.
3657 Before and after saving the buffer, this function runs
3658 `before-save-hook' and `after-save-hook', respectively."
3661 ;; In an indirect buffer, save its base buffer instead.
3666 setmodes)
3667 ;; On VMS, rename file and buffer to get rid of version number.
3672 ;; Strip VMS version number before save.
3675 ;; Construct a (unique) buffer name to correspond.
3680 ;; If buffer has no file name, ask user for one.
3687 ;; Signal an error if the user specified the name of an
3688 ;; existing directory.
3691 filename))
3693 ;; Signal an error if the specified name refers to a
3694 ;; non-existing directory.
3724 ;; Support VC version backups.
3730 ;; If a hook returned t, file is already "written".
3731 ;; Otherwise, write it the usual way now.
3733 ;; Now we have saved the current buffer. Let's make sure
3734 ;; that buffer-file-coding-system is fixed to what
3735 ;; actually used for saving by binding it locally.
3745 ;; If the auto-save file was recent before this command,
3746 ;; delete it now.
3748 ;; Support VC `implicit' locking.
3753 ;; This does the "real job" of writing a buffer into its visited file
3754 ;; and making a backup file. This is what is normally done
3755 ;; but inhibited if one of write-file-functions returns non-nil.
3756 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3765 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3779 buffer-file-name)))
3787 ;; If file is precious, write temp name, then rename it.
3788 ;; This requires write access to the containing dir,
3789 ;; which is why we don't try it if we don't have that access.
3791 tempname succeed
3794 ;; Create temp files with strict access rights. It's easy to
3795 ;; loosen them later, whereas it's impossible to close the
3796 ;; time-window of loose permissions otherwise.
3801 ;; Try various temporary names.
3802 ;; This code follows the example of make-temp-file,
3803 ;; but it calls write-region in the appropriate way
3804 ;; for saving the buffer.
3811 tempname nil realname
3813 nil)
3815 ;; The file was somehow created by someone else between
3816 ;; `make-temp-name' and `write-region', let's try again.
3817 nil)
3819 ;; Reset the umask.
3821 ;; If we failed, restore the buffer's modtime.
3824 ;; Since we have created an entirely new file,
3825 ;; make sure it gets the right permission bits set.
3829 buffer-file-name)))
3830 ;; We succeeded in writing the temp file,
3831 ;; so rename it.
3833 ;; If file not writable, see if we can make it writable
3834 ;; temporarily while we write it.
3835 ;; But no need to do so if we have just backed it up
3836 ;; (setmodes is set) because that says we're superseding.
3838 ;; Change the mode back, after writing.
3845 buffer-file-name nil t buffer-file-truename)
3847 ;; If we get an error writing the new file, and we made
3848 ;; the backup by renaming, undo the backing-up.
3853 setmodes))
3856 "View the differences between BUFFER and its associated file.
3857 This requires the external program `diff' to be in your `exec-path'."
3872 ;; Display that message for 1 second so that user can read it
3873 ;; in the minibuffer.
3875 ;; return always nil, so that save-buffers-kill-emacs will not move
3876 ;; over to the next unsaved buffer when calling `d'.
3877 nil)
3880 '((?\C-r
3886 ;; Return nil to ask about BUF again.
3887 nil)
3895 nil)
3904 "Save some modified file-visiting buffers. Asks user about each one.
3905 You can answer `y' to save, `n' not to save, `C-r' to look at the
3906 buffer in question with `view-buffer' before deciding or `d' to
3907 view the differences using `diff-buffer-with-file'.
3909 Optional argument (the prefix) non-nil means save all with no questions.
3910 Optional second argument PRED determines which buffers are considered:
3911 If PRED is nil, all the file-visiting buffers are considered.
3912 If PRED is t, then certain non-file buffers will also be considered.
3913 If PRED is a zero-argument function, it indicates for each buffer whether
3914 to consider it or not when called with that buffer current.
3916 See `save-some-buffers-action-alist' if you want to
3917 change the additional actions you can take on files."
3921 files-done abbrevs-done)
3923 ;; First save any buffers that we're supposed to save unconditionally.
3924 ;; That way the following code won't ask about them.
3929 ;; Ask about those buffers that merit it,
3930 ;; and record the number thus saved.
3946 t
3959 save-some-buffers-action-alist))
3960 ;; Maybe to save abbrevs, and record whether
3961 ;; we either saved them or asked to.
3967 abbrev-file-name)))
3969 ;; Don't keep bothering user if he says no.
3974 "(Some special files were saved without asking)"
3976 \f
3978 "Mark current buffer as unmodified, not needing to be saved.
3981 It is not a good idea to use this function in Lisp programs, because it
3982 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3989 "Change whether this buffer is visiting its file read-only.
3990 With arg, set read-only iff arg is positive.
3991 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3996 nil ; do nothing.
3997 ;; Toggle.
4004 ;; If view-mode is already active, `view-mode-enter' is a nop.
4016 "Insert contents of file FILENAME into buffer after point.
4017 Set mark after the inserted text.
4019 This function is meant for the user to run interactively.
4020 Don't call it from programs! Use `insert-file-contents' instead.
4021 \(Its calling sequence is different; see its documentation)."
4026 "Append the contents of the region to the end of file FILENAME.
4027 When called from a function, expects three arguments,
4028 START, END and FILENAME. START and END are buffer positions
4029 saying what text to write."
4034 "Return most recent backup file for FILENAME or nil if no backups exist."
4035 ;; `make-backup-file-name' will get us the right directory for
4036 ;; ordinary or numeric backups. It might create a directory for
4037 ;; backups as a side-effect, according to `backup-directory-alist'.
4044 tem)
4053 newest))
4056 "Rename current buffer to a similar name not already taken.
4057 This function is useful for creating multiple shell process buffers
4058 or multiple mail buffers, etc."
4066 ;; If the existing buffer name has a <NNN>,
4067 ;; which isn't part of the file name (if any),
4068 ;; then get rid of that.
4074 "Create the directory DIR and any nonexistent parent dirs.
4075 If DIR already exists as a directory, do nothing.
4077 Interactively, the default choice of directory to create
4078 is the current default directory for file names.
4079 That is useful when you have visited a file in a nonexistent directory.
4081 Noninteractively, the second (optional) argument PARENTS says whether
4082 to create parent directories if they don't exist. Interactively,
4083 this happens by default."
4086 nil nil)
4087 t))
4088 ;; If default-directory is a remote directory,
4089 ;; make sure we find its make-directory handler.
4097 create-list)
4104 \f
4107 "Function to use to revert this buffer, or nil to do the default.
4108 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4113 "Function to use to insert contents when reverting this buffer.
4114 Gets two args, first the nominal file name to use,
4115 and second, t if reading the auto-save file.
4120 "Function to check whether a non-file buffer needs reverting.
4121 This should be a function with one optional argument NOCONFIRM.
4122 Auto Revert Mode passes t for NOCONFIRM. The function should return
4123 non-nil if the buffer should be reverted. A return value of
4124 `fast' means that the need for reverting was not checked, but
4125 that reverting the buffer is fast. The buffer is current when
4126 this function is called.
4128 The idea behind the NOCONFIRM argument is that it should be
4129 non-nil if the buffer is going to be reverted without asking the
4130 user. In such situations, one has to be careful with potentially
4131 time consuming operations.
4133 For more information on how this variable is used by Auto Revert mode,
4137 "Normal hook for `revert-buffer' to run before reverting.
4138 If `revert-buffer-function' is used to override the normal revert
4142 "Normal hook for `revert-buffer' to run after reverting.
4143 Note that the hook value that it runs is the value that was in effect
4144 before reverting; that makes a difference if you have buffer-local
4145 hook functions.
4147 If `revert-buffer-function' is used to override the normal revert
4153 "Replace current buffer text with the text of the visited file on disk.
4154 This undoes all changes since the file was visited or saved.
4155 With a prefix argument, offer to revert from latest auto-save file, if
4156 that is more recent than the visited file.
4158 This command also works for special buffers that contain text which
4159 doesn't come from a file, but reflects some other data base instead:
4160 for example, Dired buffers and `buffer-list' buffers. In these cases,
4161 it reconstructs the buffer contents from the appropriate data base.
4163 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4164 to revert from the auto-save file when this is nil. Note that the
4165 sense of this argument is the reverse of the prefix argument, for the
4166 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4167 to nil.
4169 Optional second argument NOCONFIRM means don't ask for confirmation at
4170 all. \(The variable `revert-without-query' offers another way to
4171 revert buffers without querying for confirmation.)
4173 Optional third argument PRESERVE-MODES non-nil means don't alter
4174 the files modes. Normally we reinitialize them using `normal-mode'.
4176 If the value of `revert-buffer-function' is non-nil, it is called to
4177 do all the work for this command. Otherwise, the hooks
4178 `before-revert-hook' and `after-revert-hook' are run at the beginning
4179 and the end, and if `revert-buffer-insert-file-contents-function' is
4180 non-nil, it is called instead of rereading visited file contents."
4182 ;; I admit it's odd to reverse the sense of the prefix argument, but
4183 ;; there is a lot of code out there which assumes that the first
4184 ;; argument should be t to avoid consulting the auto-save file, and
4185 ;; there's no straightforward way to encourage authors to notice a
4186 ;; reversal of the argument sense. So I'm just changing the user
4187 ;; interface, but leaving the programmatic interface the same.
4195 buffer-auto-save-file-name
4200 buffer-auto-save-file-name
4201 buffer-file-name)))
4211 file-name)))
4213 ;; If file was backed up but has changed since,
4214 ;; we shd make another backup.
4218 ;; Effectively copy the after-revert-hook status,
4219 ;; since after-find-file will clobber it.
4222 after-revert-hook))
4227 ;; Get rid of all undo records for this buffer.
4229 ;; Don't make undo records for the reversion.
4232 file-name auto-save-p)))
4235 "File %s no longer exists!"
4237 file-name))
4240 "File %s no longer readable!"
4242 file-name))
4244 ;; Bind buffer-file-name to nil
4245 ;; so that we don't try to lock the file.
4251 ;; Auto-saved file should be read by Emacs'
4252 ;; internal coding.
4255 buffer-file-coding-system-explicit))))
4257 coding-system-for-read
4259 coding-system-for-read)
4261 ;; As a coding system suitable for multibyte
4262 ;; buffer is specified, make the current
4263 ;; buffer multibyte.
4266 ;; This force after-insert-file-set-coding
4267 ;; (called from insert-file-contents) to set
4268 ;; buffer-file-coding-system to a proper value.
4271 ;; Note that this preserves point in an intelligent way.
4275 nil nil t))
4277 nil nil t)))))
4278 ;; Recompute the truename in case changes in symlinks
4279 ;; have changed the truename.
4283 ;; Run after-revert-hook as it was before we reverted.
4287 local-hook)
4290 t))))))
4293 "Recover the visited file--get contents from its last auto-save file."
4298 "Visit file FILE, but get contents from its last auto-save file."
4299 ;; Actually putting the file name in the minibuffer should be used
4300 ;; only rarely.
4301 ;; Not just because users often use the default.
4321 ;; Use insert-directory-safely, not insert-directory,
4322 ;; because these files might not exist. In particular,
4323 ;; FILE might not exist if the auto-save file was for
4324 ;; a buffer that didn't visit a file, such as "*mail*".
4325 ;; The code in v20.x called `ls' directly, so we need
4326 ;; to emulate what `ls' did in that case.
4332 ;; Keep the current buffer-file-coding-system.
4334 ;; Auto-saved file should be read with special coding.
4343 "Recover auto save files from a previous Emacs session.
4344 This command first displays a Dired buffer showing you the
4345 previous sessions that you could recover from.
4346 To choose one, move point to the proper line and then type C-c C-c.
4347 Then you'll be asked about a number of files to recover."
4357 auto-save-list-file-prefix)))
4358 t)
4367 ;; Each line starts with a space
4368 ;; so that Font Lock mode won't highlight the first character.
4377 "Choose one saved session to recover auto-save files from.
4378 This command is used in the special Dired buffer created by
4381 ;; Get the name of the session file to recover from.
4383 files
4389 ;; Read in the auto-save-list file.
4393 ;; Loop thru the text of that file
4394 ;; and get out the names of the files to recover.
4398 ;; This is a pair of lines for a non-file-visiting buffer.
4399 ;; Get the auto-save file name and manufacture
4400 ;; a "visited file name" from that.
4403 ;; If there is no auto-save file name, the
4404 ;; auto-save-list file is probably corrupted.
4417 ;; This pair of lines is a file-visiting
4418 ;; buffer. Use the visited file name.
4428 ;; Ignore a file if its auto-save file does not exist now.
4432 ;; The file contains a pair of line for each auto-saved buffer.
4433 ;; The first line of the pair contains the visited file name
4434 ;; or is empty if the buffer was not visiting a file.
4435 ;; The second line is the auto-save file name.
4443 files
4449 "Kill buffer if confirmed."
4457 "Kill some buffers. Asks the user whether to kill each one of them.
4458 Non-interactively, if optional argument LIST is non-nil, it
4459 specifies the list of buffers to kill, asking for approval for each one."
4467 ; if we killed the base buffer.
4474 "Kill buffers whose name matches the specified regexp.
4475 The optional second argument indicates whether to kill internal buffers too."
4484 \f
4486 "Toggle auto-saving of contents of current buffer.
4487 With prefix argument ARG, turn auto-saving on if positive, else off."
4492 ;; If auto-save is off because buffer has shrunk,
4493 ;; then toggling should turn it on.
4498 buffer-file-name
4500 ;; If -1 was stored here, to temporarily turn off saving,
4501 ;; turn it back on.
4507 buffer-auto-save-file-name)
4510 "Adjust current buffer's auto save file name for current conditions.
4511 Also rename any existing auto save file, if it was made in this session."
4523 "Return file name to use for auto-saves of current buffer.
4524 Does not consider `auto-save-visited-file-name' as that variable is checked
4525 before calling this function. You can redefine this for customization.
4526 See also `auto-save-file-name-p'."
4534 result uniq)
4535 ;; Apply user-specified translations
4536 ;; to the file name.
4540 filename)
4550 filename))))
4555 ;; We truncate the file name to DOS 8+3 limits
4556 ;; before doing anything else, because the regexp
4557 ;; passed to string-match below cannot handle
4558 ;; extensions longer than 3 characters, multiple
4559 ;; dots, and other atrocities.
4564 fn)
4569 "#"
4572 ;; Make sure auto-save file names don't contain characters
4573 ;; invalid for the underlying filesystem.
4575 ;; Don't modify remote (ange-ftp) filenames
4578 result))))
4580 ;; Deal with buffers that don't have any associated files. (Mail
4581 ;; mode tends to create a good number of these.)
4585 file-name)
4586 ;; Eliminate all slashes and backslashes by
4587 ;; replacing them with sequences that start with %.
4588 ;; Quote % also, to keep distinct names distinct.
4597 ;; Generate the file name.
4603 ;; Try a few alternative directories, to get one we can
4604 ;; write it.
4610 ;; Don't modify remote (ange-ftp) filenames
4612 ;; The call to convert-standard-filename is in case
4613 ;; buffer-name includes characters not allowed by the
4614 ;; DOS/Windows filesystems. make-temp-file writes to the
4615 ;; file it creates, so we must fix the file name _before_
4616 ;; make-temp-file is called.
4618 fname))
4620 ;; make-temp-file creates the file,
4621 ;; but we don't want it to exist until we do an auto-save.
4625 file-name)))
4628 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4629 FILENAME should lack slashes. You can redefine this for customization."
4631 \f
4633 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4634 The generated regexp will match a filename iff the filename
4635 matches that wildcard according to shell rules. Only wildcards known
4636 by `sh' are supported."
4638 ;; Copy the initial run of non-special characters.
4641 ;; If no special characters, we're almost done.
4645 j)
4647 result
4668 ;; Found "[^". Insert a `\0' character
4669 ;; (which cannot happen in a filename)
4670 ;; into the character class, so that `^'
4671 ;; is not the first character after `[',
4672 ;; and thus non-special in a regexp.
4677 ;; I don't think `]' can appear in a
4678 ;; character class in a wildcard, but
4679 ;; let's be general here.
4686 i
4699 ;; Shell wildcards should match the entire filename,
4700 ;; not its part. Make the regexp say so.
4702 \f
4705 "Switches for `list-directory' to pass to `ls' for brief listing."
4711 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4713 "Switches for `list-directory' to pass to `ls' for verbose listing."
4718 "Expand wildcard pattern PATTERN.
4719 This returns a list of file names which match the pattern.
4721 If PATTERN is written as an absolute file name,
4722 the values are absolute also.
4724 If PATTERN is written as a relative file name, it is interpreted
4725 relative to the current default directory, `default-directory'.
4726 The file names returned are normally also relative to the current
4727 default directory. However, if FULL is non-nil, they are absolute."
4731 ;; A list of all dirs that DIRPART specifies.
4732 ;; This can be more than one dir
4733 ;; if DIRPART contains wildcards.
4738 contents)
4743 ;; Filter out "." and ".."
4748 name))
4755 this-dir-contents)
4756 this-dir-contents)
4757 contents))))
4759 contents)))
4762 "Display a list of files in or matching DIRNAME, a la `ls'.
4763 DIRNAME is globbed by the shell if necessary.
4764 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4765 Actions controlled by variables `list-directory-brief-switches'
4766 and `list-directory-verbose-switches'."
4770 nil default-directory nil)
4771 pfx)))
4773 list-directory-brief-switches))
4774 buffer)
4787 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4795 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4797 PATTERN is assumed to represent a file-name wildcard suitable for the
4798 underlying filesystem. For Unix and GNU/Linux, the characters from the
4800 the parts of the pattern which don't include wildcard characters are
4801 quoted with double quotes.
4802 Existing quote characters in PATTERN are left alone, so you can pass
4803 PATTERN that already quotes some of the special characters."
4807 ;; DOS/Windows don't allow `"' in file names. So if the
4808 ;; argument has quotes, we can safely assume it is already
4809 ;; quoted by the caller.
4811 ;; We quote [&()#$'] in case their shell is a port of a
4812 ;; Unixy shell. We quote [,=+] because stock DOS and
4813 ;; Windows shells require that in some cases, such as
4814 ;; passing arguments to batch files that use positional
4815 ;; arguments like %1.
4817 pattern
4820 end)
4837 pattern))))
4844 "Program to get the amount of free space on a file system.
4845 We assume the output has the format of `df'.
4846 The value of this variable must be just a command name or file name;
4847 if you want to specify options, use `directory-free-space-args'.
4849 A value of nil disables this feature.
4851 If the function `file-system-info' is defined, it is always used in
4852 preference to the program given by this variable."
4858 "Options to use when running `directory-free-space-program'."
4863 "Return the amount of free space on directory DIR's file system.
4864 The result is a string that gives the number of free 1KB blocks,
4865 or nil if the system call or the program which retrieve the information
4866 fail. It returns also nil when DIR is a remote directory.
4868 This function calls `file-system-info' if it is available, or invokes the
4869 program specified by `directory-free-space-program' if that is non-nil."
4871 ;; Try to find the number of free blocks. Non-Posix systems don't
4872 ;; always have df, but might have an equivalent system call.
4881 nil t nil
4882 directory-free-space-args
4883 dir)))
4884 ;; Usual format is a header line followed by a line of
4885 ;; numbers.
4890 ;; Move to the end of the "available blocks" number.
4893 ;; Copy it into AVAILABLE.
4898 ;; The following expression replaces `dired-move-to-filename-regexp'.
4902 ;; In some locales, month abbreviations are as short as 2 letters,
4903 ;; and they can be followed by ".".
4904 ;; In Breton, a month name can include a quote character.
4917 s "+"
4920 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4921 ;; omits the Kanji characters after month and day-of-month.
4922 ;; On Mac OS X 10.3, the date format in East Asian locales is
4923 ;; day-of-month digits followed by month digits.
4929 ;; The "[0-9]" below requires the previous column to end in a digit.
4930 ;; This avoids recognizing `1 may 1997' as a date in the line:
4931 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4933 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4934 ;; The ".*" below finds the last match if there are multiple matches.
4935 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4936 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4938 ;; vc dired listings provide the state or blanks between file
4939 ;; permissions and date. The state is always surrounded by
4940 ;; parantheses:
4941 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4942 ;; This is not supported yet.
4946 "Regular expression to match up to the file name in a directory listing.
4947 The default value is designed to recognize dates and times
4952 ;; insert-directory
4953 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4954 ;; FULL-DIRECTORY-P is nil.
4955 ;; The single line of output must display FILE's name as it was
4956 ;; given, namely, an absolute path name.
4957 ;; - must insert exactly one line for each file if WILDCARD or
4958 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4959 ;; before the file lines, plus optional text after the file lines.
4960 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4961 ;; allowed.
4962 ;; File lines should display the basename.
4963 ;; - must be consistent with
4964 ;; - functions dired-move-to-filename, (these two define what a file line is)
4965 ;; dired-move-to-end-of-filename,
4966 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4967 ;; dired-insert-headerline
4968 ;; dired-after-subdir-garbage (defines what a "total" line is)
4969 ;; - variable dired-subdir-regexp
4970 ;; - may be passed "--dired" as the first argument in SWITCHES.
4971 ;; Filename handlers might have to remove this switch if their
4972 ;; "ls" command does not support it.
4974 "Insert directory listing for FILE, formatted according to SWITCHES.
4975 Leaves point after the inserted text.
4976 SWITCHES may be a string of options, or a list of strings
4977 representing individual options.
4978 Optional third arg WILDCARD means treat FILE as shell wildcard.
4979 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4980 switches do not contain `d', so that a full listing is expected.
4982 This works by running a directory listing program
4983 whose name is in the variable `insert-directory-program'.
4984 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4986 When SWITCHES contains the long `--dired' option, this function
4987 treats it specially, for the sake of dired. However, the
4988 normally equivalent short `-D' option is just passed on to
4989 `insert-directory-program', as any other option."
4990 ;; We need the directory in order to find the right handler.
4995 wildcard full-directory-p)
5000 ;; Read the actual directory using `insert-directory-program'.
5001 ;; RESULT gets the status code.
5003 ;; putting text property `dired-filename, decode one
5004 ;; bunch by one to preserve that property.
5006 ;; This is to control encoding the arguments in call-process.
5010 default-file-name-coding-system))))
5013 ;; Run ls in the directory part of the file pattern
5014 ;; using the last component as argument.
5021 shell-file-name nil t nil
5022 "-c"
5024 ""
5026 insert-directory-program
5027 " -d "
5029 switches
5031 " -- "
5032 ;; Quote some characters that have
5033 ;; special meanings in shells; but
5034 ;; don't quote the wildcards--we want
5035 ;; them to be special. We also
5036 ;; currently don't quote the quoting
5037 ;; characters in case people want to
5038 ;; use them explicitly to quote
5039 ;; wildcard characters.
5041 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5042 ;; directory if FILE is a symbolic link.
5044 insert-directory-program nil t nil
5048 ;; Split the switches at any spaces so we can
5049 ;; pass separate options as separate args.
5051 ;; Avoid lossage if FILE starts with `-'.
5059 file))))))))
5061 ;; If we got "//DIRED//" in the output, it means we got a real
5062 ;; directory listing, even if `ls' returned nonzero.
5063 ;; So ignore any errors.
5076 ;; The first time ls returns an error,
5077 ;; find the version numbers of ls,
5078 ;; and set insert-directory-ls-version
5079 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5080 ;; is equal or if the info cannot be obtained.
5081 ;; (That can mean it isn't GNU ls.)
5091 comparison)
5107 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5111 ;; If `insert-directory-program' failed, signal an error.
5113 ;; Delete the error message it may have output.
5115 ;; On non-Posix systems, we cannot open a directory, so
5116 ;; don't even try, because that will always result in
5117 ;; the ubiquitous "Access denied". Instead, show the
5118 ;; command line so the user can try to guess what went wrong.
5123 insert-directory-program
5125 file result)
5126 ;; Unix. Access the file to get a suitable error.
5133 ;; The following overshoots by one line for an empty
5134 ;; directory listed with "--dired", but without "-a"
5135 ;; switch, where the ls output contains a
5136 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5137 ;; We take care of that case later.
5145 error-lines)
5146 ;; Find all the lines that are error messages,
5147 ;; and record the bounds of each one.
5154 ;; Now read the numeric positions of file names.
5161 error-lines))
5164 error-lines)))
5166 ;; End is followed by \n or by " -> ".
5168 ;; It seems that we can't trust ls's output as to
5169 ;; byte positions of filenames.
5175 ;; Take care of the case where the ls output contains a
5176 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5177 ;; and we went one line too far back (see above).
5182 ;; Now decode what read if necessary.
5184 file-name-coding-system
5185 default-file-name-coding-system
5187 coding-no-eol
5188 val pos)
5192 ;; If no coding system is specified or detection is
5193 ;; requested, detect the coding.
5207 ;; Force no eol conversion on a file name, so
5208 ;; that CR is preserved.
5216 ;; Try to insert the amount of free space.
5219 ;; First find the line to put it on.
5223 ;; Replace "total" with "used", to avoid confusion.
5229 "Convert `ls --dired' file name position value POS to a buffer position.
5230 File name position values returned in ls --dired output
5231 count only stdout; they don't count the error messages sent to stderr.
5232 So this function converts to them to real buffer positions.
5233 ERROR-LINES is a list of buffer positions of error message lines,
5234 of the form (START END)."
5238 pos)
5242 "Insert directory listing for FILE, formatted according to SWITCHES.
5244 Like `insert-directory', but if FILE does not exist, it inserts a
5245 message to that effect instead of signaling an error."
5248 ;; Simulate the message printed by `ls'.
5252 "Functions to call with no arguments to query about killing Emacs.
5253 If any of these functions returns nil, killing Emacs is cancelled.
5255 but `kill-emacs', the low level primitive, does not.
5259 "How to ask for confirmation when leaving Emacs.
5260 If nil, the default, don't ask at all. If the value is non-nil, it should
5261 be a predicate function such as `yes-or-no-p'."
5269 "Offer to save each buffer, then kill this Emacs process.
5270 With prefix arg, silently save all file-visiting buffers, then kill."
5279 ;; process-list is not defined on VMS.
5281 active)
5290 ;; Query the user for other things, perhaps.
5295 \f
5296 ;; We use /: as a prefix to "quote" a file name
5297 ;; so that magic file name handlers will not apply to it.
5301 file-name-handler-alist))
5303 ;; We depend on being the last handler on the list,
5304 ;; so that anything else which does need handling
5305 ;; has been handled already.
5306 ;; So it is safe for us to inhibit *all* magic file name handlers.
5315 default-directory))
5316 ;; Get a list of the indices of the args which are file names.
5319 ;; The first six are special because they
5320 ;; return a file name. We want to include the /:
5321 ;; in the return value.
5322 ;; So just avoid stripping it in the first place.
5329 ;; `identity' means just return the first arg
5330 ;; not stripped of its quoting.
5332 ;; `add' means add "/:" to the result.
5334 ;; `quote' means add "/:" to buffer-file-name.
5336 ;; `unquote-then-quote' means set buffer-file-name
5337 ;; temporarily to unquoted filename.
5339 ;; List the arguments which are filenames.
5347 ;; For all other operations, treat the first argument only
5348 ;; as the file name.
5350 method
5351 ;; Copy ARGUMENTS so we can replace elements in it.
5355 ;; Strip off the /: from the file names that have it.
5363 "/"
5379 res))
5382 \f
5407 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5408 ;;; files.el ends here