| blob | cb9720dc702e41d31dae3de6ef85f5a3edcf606a |
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, 2008 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 3 of the License, or
14 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
30 ;;; Code:
35 "Backups of edited data files."
39 "Finding files."
44 "Non-nil means delete auto-save file when a buffer is saved or killed.
46 Note that the auto-save file will not be deleted if the buffer is killed
47 when it has unsaved changes."
52 nil
53 "Alist of abbreviations for file directories.
54 A list of elements of the form (FROM . TO), each meaning to replace
55 FROM with TO when it appears in a directory name. This replacement is
56 done when setting up the default directory of a newly visited file.
57 *Every* FROM string should start with `^'.
59 FROM and TO should be equivalent names, which refer to the
60 same directory. Do not use `~' in the TO strings;
61 they should be ordinary absolute directory names.
63 Use this feature when you have directories which you normally refer to
64 via absolute symbolic links. Make TO the name of the link, and FROM
65 the name it is linked to."
73 ;; Turn off backup files on VMS since it has version numbers.
75 "Non-nil means make a backup of a file the first time it is saved.
76 This can be done by renaming the file or by copying.
78 Renaming means that Emacs renames the existing file so that it is a
79 backup file, then writes the buffer into a new file. Any other names
80 that the old file had will now refer to the backup file. The new file
81 is owned by you and its group is defaulted.
83 Copying means that Emacs copies the existing file into the backup
84 file, then writes the buffer on top of the existing file. Any other
85 names that the old file had will now refer to the new (edited) file.
86 The file's owner and group are unchanged.
88 The choice of renaming or copying is controlled by the variables
89 `backup-by-copying', `backup-by-copying-when-linked',
90 `backup-by-copying-when-mismatch' and
91 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
95 ;; Do this so that local variables based on the file name
96 ;; are not overridden by the major mode.
98 "Non-nil means don't make a backup, regardless of the other parameters.
99 This variable is intended for use by making it local to a buffer.
104 "Non-nil means always use copying to create backup files.
105 See documentation of variable `make-backup-files'."
110 "Non-nil means use copying to create backups for files with multiple names.
111 This causes the alternate names to refer to the latest version as edited.
112 This variable is relevant only if `backup-by-copying' is nil."
117 "Non-nil means create backups by copying if this preserves owner or group.
118 Renaming may still be used (subject to control of other variables)
119 when it would not result in changing the owner or group of the file;
120 that is, for files which are owned by you and whose group matches
121 the default for a new file created there by you.
122 This variable is relevant only if `backup-by-copying' is nil."
127 "Non-nil means create backups by copying to preserve a privileged owner.
128 Renaming may still be used (subject to control of other variables)
129 when it would not result in changing the owner of the file or if the owner
130 has a user id greater than the value of this variable. This is useful
131 when low-numbered uid's are used for special system users (such as root)
132 that must maintain ownership of certain files.
133 This variable is relevant only if `backup-by-copying' and
134 `backup-by-copying-when-mismatch' are nil."
139 "Predicate that looks at a file name and decides whether to make backups.
143 "Non-nil in a buffer means always offer to save buffer on exit.
144 Do so even if the buffer is not visiting a file.
145 Automatically local in all buffers."
151 "Non-nil means find a file under alternative names, in existing buffers.
152 This means if any existing buffer is visiting the file you want
153 under another name, you get the existing buffer instead of a new buffer."
158 "*Non-nil means visit a file under its truename.
159 The truename of a file is found by chasing all links
160 both at the file level and at the levels of the containing directories."
166 "Specify which files should be reverted without query.
167 The value is a list of regular expressions.
168 If the file name matches one of these regular expressions,
169 then `revert-buffer' reverts the file without querying
170 if the file has changed on disk and you have not edited the buffer."
175 "The device number and file number of the file visited in the current buffer.
176 The value is a list of the form (FILENUM DEVNUM).
177 This pair of numbers uniquely identifies the file.
197 "The directory for writing temporary files."
203 "The directory for writing small temporary files.
204 If non-nil, this directory is used instead of `temporary-file-directory'
205 by programs that create small temporary files. This is for systems that
206 have fast storage with limited space, such as a RAM disk."
210 ;; The system null device. (Should reference NULL_DEVICE from C.)
236 "Non-nil means protect against I/O errors while saving files.
237 Some modes set this non-nil in particular buffers.
239 This feature works by writing the new contents into a temporary file
240 and then renaming the temporary file to replace the original.
241 In this way, any I/O error in writing leaves the original untouched,
242 and there is never any instant where the file is nonexistent.
244 Note that this feature forces backups to be made by copying.
245 Yet, at the same time, saving a precious file
246 breaks any hard links between it and other files."
251 "Control use of version numbers for backup files.
252 When t, make numeric backup versions unconditionally.
253 When nil, make them for files that have some already.
254 The value `never' means do not make them."
264 "When cleaning directory, number of versions to keep."
270 "If t, delete excess backup versions silently.
271 If nil, ask confirmation. Any other value prevents any trimming."
278 "Number of oldest versions to keep when a new numbered backup is made."
284 "Number of newest versions to keep when a new numbered backup is made.
285 Includes the new backup. Must be > 0"
291 "Whether to add a newline automatically at the end of the file.
293 A value of t means do this only when the file is about to be saved.
294 A value of `visit' means do this right after the file is visited.
295 A value of `visit-save' means do it at both of those times.
296 Any other non-nil value means ask user whether to add a newline, when saving.
297 A value of nil means don't add newlines.
299 Certain major modes set this locally to the value obtained
300 from `mode-require-final-newline'."
309 "Whether to add a newline at end of file, in certain major modes.
310 Those modes set `require-final-newline' to this value when you enable them.
311 They do so because they are often used for files that are supposed
312 to end in newlines, and the question is how to arrange that.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
319 A value of nil means do not add newlines. That is a risky choice in this
320 variable since this value is used for modes for files that ought to have
321 final newlines. So if you set this to nil, you must explicitly check and
322 add a final newline, whenever you save a file that really needs one."
332 "Non-nil says by default do auto-saving of every file-visiting buffer."
337 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
338 Normally auto-save files are written under other names."
344 ;; Don't put "\\2" inside expand-file-name, since it will be
345 ;; transformed to "/2" on DOS/Windows.
347 "Transforms to apply to buffer file name before making auto-save file name.
348 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
349 REGEXP is a regular expression to match against the file name.
350 If it matches, `replace-match' is used to replace the
351 matching part with REPLACEMENT.
352 If the optional element UNIQUIFY is non-nil, the auto-save file name is
353 constructed by taking the directory part of the replaced file-name,
354 concatenated with the buffer file name with all directory separators
355 changed to `!' to prevent clashes. This will not work
356 correctly if your filesystem truncates the resulting name.
358 All the transforms in the list are tried, in the order they are listed.
359 When one transform applies, its result is final;
360 no further transforms are tried.
362 The default value is set up to put the auto-save file into the
363 temporary directory (see the variable `temporary-file-directory') for
364 editing a remote file.
366 On MS-DOS filesystems without long names this variable is always
367 ignored."
374 "Non-nil means save word abbrevs too when files are saved.
375 If `silently', don't ask the user before saving."
380 "Non-nil means allow `find-file' to visit directories.
381 To visit the directory, `find-file' runs `find-directory-functions'."
386 "List of functions to try in sequence to visit a directory.
387 Each function is called with the directory name as the sole argument
388 and should return either a buffer or nil."
392 ;;;It is not useful to make this a local variable.
393 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
395 "List of functions to be called for `find-file' on nonexistent file.
396 These functions are called as soon as the error is detected.
397 Variable `buffer-file-name' is already set up.
402 ;;;It is not useful to make this a local variable.
403 ;;;(put 'find-file-hooks 'permanent-local t)
406 "List of functions to be called after a buffer is loaded from a file.
407 The buffer's local variables (if any) will have been processed before the
408 functions are called."
415 "List of functions to be called before writing out a buffer to a file.
416 If one of them returns non-nil, the file is considered already written
417 and the rest are not called.
418 These hooks are considered to pertain to the visited file.
419 So any buffer-local binding of this variable is discarded if you change
421 change the major mode.
423 This hook is not run if any of the functions in
424 `write-contents-functions' returns non-nil. Both hooks pertain
425 to how to save a buffer to file, for instance, choosing a suitable
426 coding system and setting mode bits. (See Info
427 node `(elisp)Saving Buffers'.) To perform various checks or
438 "List of functions to be called before writing out a buffer to a file.
439 If one of them returns non-nil, the file is considered already written
440 and the rest are not called and neither are the functions in
441 `write-file-functions'.
443 This variable is meant to be used for hooks that pertain to the
444 buffer's contents, not to the particular visited file; thus,
445 `set-visited-file-name' does not clear this variable; but changing the
446 major mode does clear it.
448 For hooks that _do_ pertain to the particular visited file, use
449 `write-file-functions'. Both this variable and
450 `write-file-functions' relate to how a buffer is saved to file.
451 To perform various checks or updates before the buffer is saved,
458 "Control use of local variables in files you visit.
459 The value can be t, nil, :safe, :all, or something else.
461 A value of t means file local variables specifications are obeyed
462 if all the specified variable values are safe; if any values are
463 not safe, Emacs queries you, once, whether to set them all.
464 \(When you say yes to certain values, they are remembered as safe.)
466 :safe means set the safe variables, and ignore the rest.
467 :all means set all variables, whether safe or not.
468 (Don't set it permanently to :all.)
469 A value of nil means always ignore the file local variables.
471 Any other value means always query you once whether to set them all.
472 \(When you say yes to certain values, they are remembered as safe, but
475 This variable also controls use of major modes specified in
476 a -*- line.
479 always obeys file local variable specifications and the -*- line,
480 and ignores this variable."
489 "Like `enable-local-variables' but meant for buffer-local bindings.
490 The meaningful values are nil and non-nil. The default is non-nil.
491 If a major mode sets this to nil, buffer-locally, then any local
492 variables list in the file will be ignored.
494 This variable does not affect the use of major modes
499 The value can be t, nil or something else.
500 A value of t means obey `eval' variables;
501 A value of nil means ignore them; anything else means query."
507 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
516 "Non-nil means buffers visiting files read-only do so in view mode.
517 In fact, this means that all read-only buffers normally have
518 View mode enabled, including buffers that are read-only because
519 you visit a file you cannot alter, and buffers you make read-only
525 "History list of file names entered in the minibuffer.
527 Maximum length of the history list is determined by the value
529 \f
532 "Provides support for ange-ftp host name completion.
533 Runs the usual ange-ftp hook, but only for completion operations."
534 ;; Having this here avoids the need to load ange-ftp when it's not
535 ;; really in use.
541 inhibit-file-name-handlers)))
546 "Convert a standard file's name to something suitable for the OS.
547 This means to guarantee valid names and perhaps to canonicalize
548 certain patterns.
550 FILENAME should be an absolute file name since the conversion rules
551 sometimes vary depending on the position in the file name. E.g. c:/foo
552 is a valid DOS file name, but c:/bar/c:/foo is not.
554 This function's standard definition is trivial; it just returns
555 the argument. However, on Windows and DOS, replace invalid
556 characters. On DOS, make sure to obey the 8.3 limitations.
557 In the native Windows build, turn Cygwin names into native names,
558 and also turn slashes into backslashes if the shell requires it (see
559 `w32-shell-dos-semantics').
561 See Info node `(elisp)Standard File Names' for more details."
565 ;; Replace invalid filename characters with !
569 name)
570 filename))
573 "Read directory name, prompting with PROMPT and completing in directory DIR.
574 Value is not expanded---you must call `expand-file-name' yourself.
575 Default name to DEFAULT-DIRNAME if user exits with the same
576 non-empty string that was inserted by this function.
577 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
578 or just DIR if INITIAL is nil.)
579 If the user exits with an empty minibuffer, this function returns
580 an empty string. (This can only happen if the user erased the
581 pre-inserted contents or if `insert-default-directory' is nil.)
582 Fourth arg MUSTMATCH non-nil means require existing directory's name.
583 Non-nil and non-t means also require confirmation after completion.
584 Fifth arg INITIAL specifies text to start with.
585 DIR should be an absolute directory name. It defaults to
586 the value of `default-directory'."
591 dir))
592 mustmatch initial
595 \f
597 "Show the current default directory."
602 "Value of the CDPATH environment variable, as a list.
606 "Explode a search path into a list of directory names.
607 Directories are separated by occurrences of `path-separator'
608 \(which is colon in GNU and GNU-like systems)."
609 ;; We could use split-string here.
617 nil
622 cd-list)))
625 "Change current directory to given absolute file name DIR."
626 ;; Put the name into directory syntax now,
627 ;; because otherwise expand-file-name may give some bad results.
641 "Make DIR become the current buffer's default directory.
642 If your environment includes a `CDPATH' variable, try each one of
643 that list of directories (separated by occurrences of
644 `path-separator') when resolving a relative directory name.
645 The path separator is colon in GNU and GNU-like systems."
648 default-directory default-directory
664 cd-path)
665 nil))
669 "Load the Lisp file named FILE."
670 ;; This is a case where .elc makes a lot of sense.
677 "Search for FILENAME through PATH.
678 If found, return the absolute file name of FILENAME, with its suffixes;
679 otherwise return nil.
680 PATH should be a list of directories to look in, like the lists in
681 `exec-path' or `load-path'.
682 If SUFFIXES is non-nil, it should be a list of suffixes to append to
685 If non-nil, PREDICATE is used instead of `file-readable-p'.
686 PREDICATE can also be an integer to pass to the `access' system call,
687 in which case file-name handlers are ignored. This usage is deprecated.
689 For compatibility, PREDICATE can also be one of the symbols
690 `executable', `readable', `writable', or `exists', or a list of
691 one or more of those symbols."
702 "Do completion for file names passed to `locate-file'."
723 "Do completion for file names passed to `locate-file'.
724 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
727 string nil action))
731 "Look up the directory hierarchy from FILE for a file matching REGEXP."
733 ;; `user' is not initialized yet because `file' may not exist, so we may
734 ;; have to walk up part of the hierarchy before we find the "initial UID".
736 ;; Abbreviate, so as to stop when we cross ~/.
738 files)
740 ;; As a heuristic, we stop looking up the hierarchy of
741 ;; directories as soon as we find a directory belonging to
742 ;; another user. This should save us from looking in
743 ;; things like /net and /afs. This assumes that all the
744 ;; files inside a project belong to the same user.
755 nil)))
758 "Search for COMMAND in `exec-path' and return the absolute file name.
759 Return nil if COMMAND is not found anywhere in `exec-path'."
760 ;; Use 1 rather than file-executable-p to better match the behavior of
761 ;; call-process.
765 "Load the library named LIBRARY.
766 This is an interface to the function `load'."
770 load-path
775 "Test whether FILE specifies a location on a remote system.
776 Returns nil or a string identifying the remote connection (ideally
777 a prefix of FILE). For example, the remote identification for filename
780 less reliable than accessing local files.
781 Furthermore, relative file names do not work across remote connections.
783 IDENTIFICATION specifies which part of the identification shall
784 be returned as string. IDENTIFICATION can be the symbol
785 `method', `user' or `host'; any other value is handled like nil
786 and means to return the complete identification string.
788 If CONNECTED is non-nil, the function returns an identification only
789 if FILE is located on a remote system, and a connection is established
790 to that remote system.
792 `file-remote-p' will never open a connection on its own."
796 nil)))
799 "Copy the file FILE into a temporary file on this machine.
800 Returns the name of the local copy, or nil, if FILE is directly
801 accessible."
802 ;; This formerly had an optional BUFFER argument that wasn't used by
803 ;; anything.
807 nil)))
810 "Return the truename of FILENAME, which should be absolute.
811 The truename of a file name is found by chasing symbolic links
812 both at the level of the file and at the level of the directories
813 containing it, until no links are left at any level.
816 ;; COUNTER and PREV-DIRS are only used in recursive calls.
817 ;; COUNTER can be a cons cell whose car is the count of how many
818 ;; more links to chase before getting an error.
819 ;; PREV-DIRS can be a cons cell whose car is an alist
820 ;; of truenames we've just recently computed.
834 ;; For speed, remove the ange-ftp completion handler from the list.
835 ;; We know it's not needed here.
836 ;; For even more speed, do this only on the outermost call.
843 ;; andrewi@harlequin.co.uk - none of the following code (except for
844 ;; invoking the file-name handler) currently applies on Windows
845 ;; (ie. there are no native symlinks), but there is an issue with
846 ;; case differences being ignored by the OS, and short "8.3 DOS"
847 ;; name aliases existing for all files. (The short names are not
848 ;; reported by directory-files, but can be used to refer to files.)
849 ;; It seems appropriate for file-truename to resolve these issues in
850 ;; the most natural way, which on Windows is to call the function
851 ;; `w32-long-file-name' - this returns the exact name of a file as
852 ;; it is stored on disk (expanding short name aliases with the full
853 ;; name in the process).
856 ;; For file name that has a special handler, call handler.
857 ;; This is so that ange-ftp can save time by doing a no-op.
860 ;; If filename contains a wildcard, newname will be the old name.
862 ;; If filename exists, use the long name
866 ;; If this file directly leads to a link, process that iteratively
867 ;; so that we don't use lots of stack.
873 ;; For file name that has a special handler, call handler.
874 ;; This is so that ange-ftp can save time by doing a no-op.
877 done t)
879 target dirfile)
880 ;; Get the truename of the directory.
882 ;; If these are equal, we have the (or a) root directory.
884 ;; If this is the same dir we last got the truename for,
885 ;; save time--don't recalculate.
895 done t)
898 done t)
899 ;; Put it back on the file name.
901 ;; Is the file name the name of a link?
904 ;; Yes => chase that link, then start all over
905 ;; since the link may point to a directory name that uses links.
906 ;; We can't safely use expand-file-name here
907 ;; since target might look like foo/../bar where foo
908 ;; is itself a link. Instead, we handle . and .. above.
911 target
913 done nil)
914 ;; No, we are done!
916 filename))
919 "Chase links in FILENAME until a name that is not a link.
920 Unlike `file-truename', this does not check whether a parent
921 directory name is a symbolic link.
922 If the optional argument LIMIT is a number,
923 it means chase no more than that many links and then stop."
931 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
934 ;; Handle `..' by hand, since it needs to work in the
935 ;; target of any directory symlink.
936 ;; This code is not quite complete; it does not handle
937 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
941 ;; Chase links in the default dir of the symlink.
945 ;; Now find the parent of that dir.
949 newname))
952 "Create a temporary file.
953 The returned file name (created by appending some random characters at the end
954 of PREFIX, and expanding against `temporary-file-directory' if necessary),
955 is guaranteed to point to a newly created empty file.
956 You can then use `write-region' to write new data into the file.
958 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
960 If SUFFIX is non-nil, add that at the end of the file name."
962 file)
965 ;; Create temp files with strict access rights. It's easy to
966 ;; loosen them later, whereas it's impossible to close the
967 ;; time-window of loose permissions otherwise.
979 nil)
981 ;; the file was somehow created by someone else between
982 ;; `make-temp-name' and `write-region', let's try again.
983 nil)
984 file)
985 ;; Reset the umask.
989 "Change the encoding of FILE's name from CODING to NEW-CODING.
990 The value is a new name of FILE.
991 Signals a `file-already-exists' error if a file of the new name
992 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
993 is non-nil. A number as fourth arg means request confirmation if
994 the new name already exists. This is what happens in interactive
995 use with M-x."
998 default-file-name-coding-system))
1000 from-coding to-coding)
1002 ;; We provide the default coding only when it seems that
1003 ;; the filename is correctly decoded by the default
1004 ;; coding.
1010 filename default-coding)
1011 default-coding))
1015 ;; We provide the default coding only when a user is going to
1016 ;; change the encoding not from the default coding.
1020 filename from-coding)))
1023 filename from-coding default-coding)
1024 default-coding)))
1028 default-file-name-coding-system))
1029 ;; FILE should have been decoded by DEFAULT-CODING.
1033 ;; Suppress further encoding.
1038 newname))
1039 \f
1041 "Read the name of a buffer to switch to and return as a string.
1042 It is intended for `switch-to-buffer' family of commands since they
1043 need to omit the name of current buffer from the list of completions
1044 and default values."
1051 "Select buffer BUFFER in another window.
1052 If BUFFER does not identify an existing buffer, then this function
1053 creates a buffer with that name.
1055 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1056 or nil. If BUFFER is nil, then this function chooses a buffer
1057 using `other-buffer'.
1058 Optional second arg NORECORD non-nil means
1059 do not put this buffer at the front of the list of recently selected ones.
1060 This function returns the buffer it switched to.
1062 This uses the function `display-buffer' as a subroutine; see its
1063 documentation for additional customization information."
1067 ;; Don't let these interfere.
1068 same-window-buffer-names same-window-regexps)
1072 "Switch to buffer BUFFER in another frame.
1073 Optional second arg NORECORD non-nil means
1074 do not put this buffer at the front of the list of recently selected ones.
1075 This function returns the buffer it switched to.
1077 This uses the function `display-buffer' as a subroutine; see its
1078 documentation for additional customization information."
1082 same-window-buffer-names same-window-regexps)
1088 "Switch to buffer BUFFER in another frame.
1089 This uses the function `display-buffer' as a subroutine; see its
1090 documentation for additional customization information."
1093 same-window-buffer-names same-window-regexps
1095 new-window)
1097 ;; This may have been here in order to prevent the new frame from hiding
1098 ;; the old frame. But it does more harm than good.
1099 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1100 ;;(lower-frame (window-frame new-window))
1102 ;; This may have been here in order to make sure the old-frame gets the
1103 ;; focus. But not only can it cause an annoying flicker, with some
1104 ;; window-managers it just makes the window invisible, with no easy
1105 ;; way to recover it. --Stef
1106 ;;(make-frame-invisible (window-frame old-window))
1107 ;;(make-frame-visible (window-frame old-window))
1108 ))
1114 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1115 BODY should use the minibuffer at most once.
1116 Recursive uses of the minibuffer will not be affected."
1122 ;; Clear out this hook so it does not interfere
1123 ;; with any recursive minibuffer usage.
1133 "If non-nil, `find-file' requires confirmation before visiting a new file."
1145 t))
1148 "Edit file FILENAME.
1149 Switch to a buffer visiting file FILENAME,
1150 creating one if none already exists.
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 You can visit files on remote machines by specifying something
1156 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1157 also visit local files as a different user by specifying
1158 /sudo::FILE for the file name.
1159 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1160 manual, for more about this.
1162 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1163 expand wildcards (if any) and visit multiple files. You can
1164 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1166 To visit a file without any kind of conversion and without
1177 "Edit file FILENAME, in another window.
1180 an existing one. See the function `display-buffer'.
1182 Interactively, the default if you just type RET is the current directory,
1183 but the visited file name is available through the minibuffer history:
1184 type M-n to pull it into the minibuffer.
1186 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1187 expand wildcards (if any) and visit multiple files."
1200 "Edit file FILENAME, in another frame.
1203 an existing one. See the function `display-buffer'.
1205 Interactively, the default if you just type RET is the current directory,
1206 but the visited file name is available through the minibuffer history:
1207 type M-n to pull it into the minibuffer.
1209 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1210 expand wildcards (if any) and visit multiple files."
1223 "Edit the existing file FILENAME.
1225 file names with wildcards."
1233 "Edit file FILENAME but don't allow changes.
1247 value))
1250 "Edit file FILENAME in another window but don't allow changes.
1264 value))
1267 "Edit file FILENAME in another frame but don't allow changes.
1281 value))
1284 "Find file FILENAME as a replacement for the file in the next window.
1285 This command does not select that window.
1289 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1290 expand wildcards (if any) and replace the file with multiple files."
1302 t))))
1310 "Find file FILENAME, select its buffer, kill previous buffer.
1311 If the current buffer now contains an empty file that you just visited
1312 \(presumably by mistake), use this command to visit the file you really want.
1316 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1317 expand wildcards (if any) and replace the file with multiple files.
1319 If the current buffer is an indirect buffer, or the base buffer
1320 for one or more indirect buffers, the other buffer(s) are not
1321 killed."
1331 t)))
1352 ;; This prevents us from finding the same buffer
1353 ;; if we specified the same file again.
1357 ;; Likewise for dired buffers.
1361 ;; This executes if find-file gets an error
1362 ;; and does not really find anything.
1363 ;; We put things back as they were.
1364 ;; If find-file actually finds something, we kill obuf below.
1373 ;; We already asked; don't ask again.
1376 \f
1378 "Create a suitably named buffer for visiting FILENAME, and return it.
1379 FILENAME (sans directory) is used unchanged if that name is free;
1380 otherwise a string <2> or <3> or ... is appended to get an unused name.
1381 Spaces at the start of FILENAME (sans directory) are removed."
1390 "Create and return a buffer with a name based on NAME.
1391 Choose the buffer's name using `generate-new-buffer-name'."
1395 "Regexp to match the automounter prefix in a directory name."
1403 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1405 home directory is a root directory) and removes automounter prefixes
1406 \(see the variable `automount-dir-prefix')."
1407 ;; Get rid of the prefixes added by the automounter.
1415 ;; If any elt of directory-abbrev-alist matches this name,
1416 ;; abbreviate accordingly.
1422 ;; Compute and save the abbreviated homedir name.
1423 ;; We defer computing this until the first time it's needed, to
1424 ;; give time for directory-abbrev-alist to be set properly.
1425 ;; We include a slash at the end, to avoid spurious matches
1426 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1433 ;; If FILENAME starts with the abbreviated homedir,
1434 ;; make it start with `~' instead.
1436 ;; If the home dir is just /, don't change it.
1439 ;; MS-DOS root directories can come with a drive letter;
1440 ;; Novell Netware allows drive letters beyond `Z:'.
1450 filename)))
1453 "List of logical names for which visiting shouldn't save the true dirname.
1454 On VMS, when you visit a file using a logical name that searches a path,
1455 you may or may not want the visited file name to record the specific
1456 directory where the file was found. If you *do not* want that, add the logical
1457 name to this list as a string."
1462 "Return the buffer visiting file FILENAME (a string).
1463 This is like `get-file-buffer', except that it checks for any buffer
1464 visiting the same file, possibly under a different name.
1465 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1466 and others are ignored.
1467 If there is no such live buffer, return nil."
1481 found)
1491 ;; Verify this buffer's file number
1492 ;; still belongs to its file.
1495 attributes)
1499 found))))
1500 \f
1502 "Non-nil means file-visiting commands should handle wildcards.
1503 For example, if you specify `*.c', that would visit all the files
1504 whose names match the pattern."
1510 "Non-nil means suppress warning messages for symlinked files.
1511 When nil, Emacs prints a warning when visiting a file that is already
1512 visited, but with a different name. Setting this option to t
1513 suppresses this warning."
1519 "Maximum size of file above which a confirmation is requested.
1520 When nil, never request confirmation."
1527 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1528 OP-TYPE specifies the file operation being performed (for message to user)."
1538 "Read file FILENAME into a buffer and return the buffer.
1539 If a buffer exists visiting FILENAME, return that one, but
1540 verify that the file has not changed since visited or saved.
1541 The buffer is not selected, just returned to the caller.
1542 Optional second arg NOWARN non-nil means suppress any warning messages.
1543 Optional third arg RAWFILE non-nil means the file is read literally.
1544 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1545 and visit all the matching files. When wildcards are actually
1546 used and expanded, return a list of buffers that are visiting
1547 the various files."
1554 'find-directory-functions
1557 filename)))
1560 find-file-wildcards
1574 ;; Find any buffer for a file which has same truename.
1576 ;; Let user know if there is a buffer with the same truename.
1580 find-file-suppress-same-file-warnings
1584 ;; Optionally also find that buffer.
1587 ;; Check to see if the file looks uncommonly large.
1591 ;; We are using an existing buffer.
1598 ;; Certain files should be reverted automatically
1599 ;; if they have changed on disk and not in the buffer.
1607 found))
1617 "File %s changed on disk. Discard your edits? "
1622 "File %s changed on disk. Discard your edits in %s? "
1630 ;; Check if a formerly read-only file has become
1631 ;; writable and vice versa, but if the buffer agrees
1632 ;; with the new state of the file, that is ok too.
1640 buffer-file-name
1649 ;; It is confusing to ask whether to visit
1650 ;; non-literally if they have the file in
1651 ;; hexl-mode.
1657 "The file %s is already visited normally,
1658 and you have edited the buffer. Now you have asked to visit it literally,
1659 meaning no coding system handling, format conversion, or local variables.
1660 Emacs can only visit a file in one way at a time.
1662 Do you want to save the file, and visit it literally instead? "
1663 "The file %s is already visited literally,
1664 meaning no coding system handling, format conversion, or local variables.
1665 You have edited the buffer. Now you have asked to visit the file normally,
1666 but Emacs can only visit a file in one way at a time.
1673 rawfile truename number))
1677 "\
1678 Do you want to discard your changes, and visit the file literally now? "
1679 "\
1682 rawfile truename number)
1688 "The file %s is already visited normally.
1689 You have asked to visit it literally,
1690 meaning no coding system decoding, format conversion, or local variables.
1691 But Emacs can only visit a file in one way at a time.
1693 Do you want to revisit the file literally now? "
1694 "The file %s is already visited literally,
1695 meaning no coding system decoding, format conversion, or local variables.
1696 You have asked to visit it normally,
1697 but Emacs can only visit a file in one way at a time.
1702 rawfile truename number)
1705 ;; Return the buffer we are using.
1706 buf)
1707 ;; Create a new buffer.
1709 ;; find-file-noselect-1 may use a different buffer.
1711 rawfile truename number))))))
1717 ;; Needed in case we are re-visiting the file with a different
1718 ;; text representation.
1735 filename)))
1736 ;; Unconditionally set error
1746 filename)))
1747 ;; Run find-file-not-found-functions until one returns non-nil.
1749 ;; If they fail too, set error.
1751 ;; Record the file's truename, and maybe use that as visited name.
1757 ;; On VMS, we may want to remember which directory in a search list
1758 ;; the file was found in.
1768 ;; Set buffer's default directory to that of the file.
1770 ;; Turn off backup files for certain file names. Since
1771 ;; this is a permanent local, the major mode won't eliminate it.
1786 \f
1788 "Like `insert-file-contents', but only reads in the file literally.
1789 A buffer may be modified in several ways after reading into the buffer,
1790 to Emacs features such as format decoding, character code
1791 conversion, `find-file-hook', automatic uncompression, etc.
1793 This function ensures that none of these modifications will take place."
1801 nil))
1804 inhibit-file-name-handlers))
1817 filename)))
1818 ;; Check whether the file is uncommonly large
1829 "Insert contents of file FILENAME into buffer after point with no conversion.
1831 This function is meant for the user to run interactively.
1832 Don't call it from programs! Use `insert-file-contents-literally' instead.
1833 \(Its calling sequence is different; see its documentation)."
1838 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1843 "Visit file FILENAME with no conversion of any kind.
1844 Format conversion and character code conversion are both disabled,
1845 and multibyte characters are disabled in the resulting buffer.
1846 The major mode used is Fundamental mode regardless of the file name,
1847 and local variable specifications in the file are ignored.
1848 Automatic uncompression and adding a newline at the end of the
1849 file due to `require-final-newline' is also disabled.
1851 You cannot absolutely rely on this function to result in
1852 visiting the file literally. If Emacs already has a buffer
1853 which is visiting the file, you get the existing buffer,
1854 regardless of whether it was created literally or not.
1856 In a Lisp program, if you want to be sure of accessing a file's
1857 contents literally, you should create a temporary buffer and then read
1858 the file contents into it using `insert-file-contents-literally'."
1861 \f
1865 after-find-file-from-revert-buffer
1866 nomodes)
1867 "Called after finding a file and by the default revert function.
1868 Sets buffer mode, parses local variables.
1869 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1870 error in reading the file. WARN non-nil means warn if there
1871 exists an auto-save file more recent than the visited file.
1872 NOAUTO means don't mess with auto-save mode.
1873 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1874 means this call was from `revert-buffer'.
1875 Fifth arg NOMODES non-nil means don't alter the file's modes.
1876 Finishes by calling the functions in `find-file-hook'
1877 unless NOMODES is non-nil."
1880 nil
1890 ;; No need to warn if buffer is auto-saved
1891 ;; under the name of the visited file.
1893 auto-save-visited-file-name))
1896 buffer-file-name))
1916 ;; Make people do a little extra work (C-x C-q)
1917 ;; before altering a backup file.
1920 ;; When a file is marked read-only,
1921 ;; make the buffer read-only even if root is looking at it.
1929 ;; If requested, add a newline at the end of the file.
1939 view-read-only
1945 "Eval BODY and turn any error into a FORMAT message.
1946 FORMAT can have a %s escape which will be replaced with the actual error.
1947 If `debug-on-error' is set, errors are not caught, so that you can
1948 debug them.
1949 Avoid using a large BODY since it is duplicated."
1958 "Choose the major mode for this buffer automatically.
1959 Also sets up any specified local variables of the file.
1960 Uses the visited file name, the -*- line, and the local variables spec.
1962 This function is called automatically from `find-file'. In that case,
1963 we may set up the file-specified mode and local variables,
1964 depending on the value of `enable-local-variables'.
1965 In addition, if `local-enable-local-variables' is nil, we do
1966 not set local variables (though we do notice a mode specified with -*-.)
1968 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1969 or from Lisp without specifying the optional argument FIND-FILE;
1970 in that case, this function acts as if `enable-local-variables' were t."
1980 ;; Turn font lock off and on, to make sure it takes account of
1981 ;; whatever file local variables are relevant to it.
1983 ;; Font-lock-mode (now in font-core.el) can be ON when
1984 ;; font-lock.el still hasn't been loaded.
1994 "Non-nil means to try second pass through `auto-mode-alist'.
1995 This means that if the first case-sensitive search through the alist fails
1996 to find a matching major mode, a second case-insensitive search is made.
1997 On systems with case-insensitive file names, this variable is ignored,
1998 since only a single case-insensitive search through the alist is made."
2004 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2005 ;; c++-mode, java-mode and more) are added through autoload
2006 ;; directives in that file. That way is discouraged since it
2007 ;; spreads out the definition of the initial value.
2040 ;; Less common extensions come here
2041 ;; so more common ones above are found faster.
2080 ;; The list of archive file extensions should be in sync with
2081 ;; `auto-coding-alist' with `no-conversion' coding system.
2087 ;; Mailer puts message to be edited in
2088 ;; /tmp/Re.... or Message
2092 ;; some news reader is reported to use this
2101 ;; .emacs or .gnus or .viper following a directory delimiter in
2102 ;; Unix, MSDOG or VMS syntax.
2105 ;; _emacs following a directory delimiter
2106 ;; in MsDos syntax
2110 ;; Common Lisp ASDF package system.
2128 ;; Windows candidates may be opened case sensitively on Unix
2134 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2136 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2137 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2138 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2139 ;; this has lower priority to avoid matching changelog.sgml etc.
2141 ;; either user's dot-files or under /etc or some such
2143 ;; alas not all ~/.*rc files are like this
2144 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2149 ;; this contains everything twice, with space and with colon :-(
2151 ;; Get rid of any trailing .n.m and try again.
2152 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2153 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2154 ;; Using mode nil rather than `ignore' would let the search continue
2155 ;; through this list (with the shortened name) rather than start over.
2157 ;; The following should come after the ChangeLog pattern
2158 ;; for the sake of ChangeLog.1, etc.
2159 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2162 "Alist of filename patterns vs corresponding major mode functions.
2163 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2164 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2165 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2166 mode function to use. FUNCTION will be called, unless it is nil.
2168 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2169 calling FUNCTION (if it's not nil), we delete the suffix that matched
2170 REGEXP and search the list again for another match.
2172 If the file name matches `inhibit-first-line-modes-regexps',
2173 then `auto-mode-alist' is not processed.
2175 The extensions whose FUNCTION is `archive-mode' should also
2176 appear in `auto-coding-alist' with `no-conversion' coding system.
2178 See also `interpreter-mode-alist', which detects executable script modes
2179 based on the interpreters they specify to run,
2183 "Select Conf mode or XML mode according to start of file."
2193 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2194 ;; and pike-mode) are added through autoload directives in that
2195 ;; file. That way is discouraged since it spreads out the
2196 ;; definition of the initial value.
2234 "Alist mapping interpreter names to major modes.
2235 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2236 Each element looks like (INTERPRETER . MODE).
2237 If INTERPRETER matches the name of the interpreter specified in the first line
2238 of a script, mode MODE is enabled.
2246 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2247 When checking `inhibit-first-line-modes-regexps', we first discard
2253 "Regexp matching interpreters, for file mode determination.
2254 This regular expression is matched against the first line of a file
2255 to determine the file's mode in `set-auto-mode'. If it matches, the file
2256 is assumed to be interpreted by the interpreter matched by the second group
2257 of the regular expression. The mode is then determined as the mode
2261 "Alist of buffer beginnings vs. corresponding major mode functions.
2262 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2263 After visiting a file, if REGEXP matches the text at the beginning of the
2264 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2265 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2266 major mode.
2268 If FUNCTION is nil, then it is not called. (That is a way of saying
2274 ;; The < comes before the groups (but the first) to reduce backtracking.
2275 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2276 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2280 comment-re "*"
2283 . html-mode)
2285 ;; These two must come after html, because they are more general:
2290 . sgml-mode)
2293 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2294 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2295 After visiting a file, if REGEXP matches the text at the beginning of the
2296 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2297 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2298 have not specified a mode for this file.
2304 "Upper limit on `magic-mode-alist' regexp matches.
2308 "Select major mode appropriate for current buffer.
2310 To find the right major mode, this function checks for a -*- mode tag,
2311 checks if it uses an interpreter listed in `interpreter-mode-alist',
2312 matches the buffer beginning against `magic-mode-alist',
2313 compares the filename against the entries in `auto-mode-alist',
2314 then matches the buffer beginning against `magic-fallback-mode-alist'.
2316 It does not check for the `mode:' local variable in the
2317 Local Variables section of the file; for that, use `hack-local-variables'.
2319 If `enable-local-variables' is nil, this function does not check for a
2320 -*- mode tag.
2322 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2323 set the major mode only if that would change it. In other words
2324 we don't actually set it to the same mode the buffer already has."
2325 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2327 ;; Find a -*- mode tag
2334 ;; Find all specifications for the `mode:' variable
2335 ;; and execute them left to right.
2347 modes)))
2348 ;; Simple -*-MODE-*- case.
2351 modes))))
2352 ;; If we found modes to use, invoke them now, outside the save-excursion.
2360 ;; continuing would call minor modes again, toggling them off
2362 ;; If we didn't, look for an interpreter specified in the first line.
2363 ;; As a special case, allow for things like "#!/bin/env perl", which
2364 ;; finds the interpreter anywhere in $PATH.
2371 ;; Map interpreter name to a mode, signalling we're done at the
2372 ;; same time.
2374 interpreter-mode-alist))
2375 ;; If we found an interpreter mode to use, invoke it now.
2378 ;; Next try matching the buffer beginning against magic-mode-alist.
2392 ;; Next compare the filename against the entries in auto-mode-alist.
2397 ;; Remove remote file name identification.
2401 ;; Remove backup-suffixes from file name.
2404 ;; Find first matching alist entry.
2407 ;; System is case-insensitive.
2411 ;; System is case-sensitive.
2413 ;; First match case-sensitively.
2417 ;; Fallback to case-insensitive match.
2431 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2446 ;; When `keep-mode-if-same' is set, we are working on behalf of
2447 ;; set-visited-file-name. In that case, if the major mode specified is the
2448 ;; same one we already have, don't actually reset it. We don't want to lose
2449 ;; minor modes such as Font Lock.
2451 "Apply MODE and return it.
2452 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2453 any aliases and compared to current major mode. If they are the
2454 same, do nothing and return nil."
2460 mode)))
2463 "Find the -*- spec in the buffer.
2464 Call with point at the place to start searching from.
2465 If one is found, set point to the beginning
2466 and return the position of the end.
2467 Otherwise, return nil; point may be changed."
2470 ;; Don't look for -*- if this file name matches any
2471 ;; of the regexps in inhibit-first-line-modes-regexps.
2479 sufs)
2487 ;; If the file begins with "#!"
2488 ;; (exec interpreter magic), look
2489 ;; for mode frobs in the first two
2490 ;; lines. You cannot necessarily
2491 ;; put them in the first line of
2492 ;; such a file without screwing up
2493 ;; the interpreter invocation.
2494 ;; The same holds for
2495 ;; '\"
2496 ;; in man pages (preprocessor
2497 ;; magic for the `man' program).
2508 end))))
2509 \f
2510 ;;; Handling file local variables
2517 "Normal hook run after processing a file's local variables specs.
2518 Major modes can use this to examine user-specified local variables
2522 "List variable-value pairs that are considered safe.
2523 Each element is a cons cell (VAR . VAL), where VAR is a variable
2524 symbol and VAL is a value that is considered safe."
2529 "Expressions that are considered safe in an `eval:' local variable.
2530 Add expressions to this list if you want Emacs to evaluate them, when
2531 they appear in an `eval' local variable specification, without first
2532 asking you for confirmation."
2537 ;; Risky local variables:
2540 auto-mode-alist
2541 buffer-auto-save-file-name
2542 buffer-file-name
2543 buffer-file-truename
2544 buffer-undo-list
2545 dabbrev-case-fold-search
2546 dabbrev-case-replace
2547 debugger
2548 default-text-properties
2549 display-time-string
2550 enable-local-eval
2551 enable-local-variables
2552 eval
2553 exec-directory
2554 exec-path
2555 file-name-handler-alist
2556 font-lock-defaults
2557 format-alist
2558 frame-title-format
2559 global-mode-string
2560 header-line-format
2561 icon-title-format
2562 ignored-local-variables
2563 imenu--index-alist
2564 imenu-generic-expression
2565 inhibit-quit
2566 input-method-alist
2567 load-path
2568 max-lisp-eval-depth
2569 max-specpdl-size
2570 minor-mode-alist
2571 minor-mode-map-alist
2572 minor-mode-overriding-map-alist
2573 mode-line-buffer-identification
2574 mode-line-format
2575 mode-line-client
2576 mode-line-modes
2577 mode-line-modified
2578 mode-line-mule-info
2579 mode-line-position
2580 mode-line-process
2581 mode-line-remote
2582 mode-name
2583 outline-level
2584 overriding-local-map
2585 overriding-terminal-local-map
2586 parse-time-rules
2587 process-environment
2588 rmail-output-file-alist
2589 safe-local-variable-values
2590 safe-local-eval-forms
2591 save-some-buffers-action-alist
2592 special-display-buffer-names
2593 standard-input
2594 standard-output
2595 unread-command-events
2596 vc-mode))
2598 ;; Safe local variables:
2599 ;;
2600 ;; For variables defined by major modes, the safety declarations can go into
2601 ;; the major mode's file, since that will be loaded before file variables are
2602 ;; processed.
2603 ;;
2604 ;; For variables defined by minor modes, put the safety declarations in the
2605 ;; file defining the minor mode after the defcustom/defvar using an autoload
2606 ;; cookie, e.g.:
2607 ;;
2608 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2609 ;;
2610 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2611 ;; minor mode file may not be loaded yet.
2612 ;;
2613 ;; For variables defined in the C source code the declaration should go here:
2629 "Get confirmation before setting up local variable values.
2630 ALL-VARS is the list of all variables to be set up.
2631 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2632 RISKY-VARS is the list of those that are marked as risky.
2633 PROJECT is a directory name if these settings come from directory-local
2634 settings; nil otherwise."
2636 nil
2641 prompt char)
2651 ", and variables that are risky (**)."
2659 y -- to apply the local variables list.
2663 ! -- to apply the local variables list, and permanently mark these
2675 ;; Make strings with embedded whitespace easier to read.
2683 ""
2690 done)
2699 ;; read-event returns -1 if we are in a kbd
2700 ;; macro and there are no more events in the
2701 ;; macro. In that case, attempt to get an
2702 ;; event interactively.
2710 ;; When this is called from desktop-restore-file-buffer,
2711 ;; coding-system-for-read may be non-nil. Reset it before
2712 ;; writing to .emacs.
2716 'safe-local-variable-values
2717 safe-local-variable-values))))
2724 "Return local variables specified in the -*- line.
2725 Ignore any specification for `mode:' and `coding:';
2726 `set-auto-mode' should already have handled `mode:',
2727 `set-auto-coding' should already have handled `coding:'.
2729 If MODE-ONLY is non-nil, all we do is check whether the major
2730 mode is specified, returning t if it is specified. Otherwise,
2731 return an alist of elements (VAR . VAL), where VAR is a variable
2732 and VAL is the specified value."
2736 result mode-specified)
2737 ;; Parse the -*- line into the RESULT alist.
2738 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2740 nil)
2742 ;; Simple form: "-*- MODENAME -*-". Already handled.
2744 nil)
2746 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2747 ;; (last ";" is optional).
2752 ;; There used to be a downcase here,
2753 ;; but the manual didn't say so,
2754 ;; and people want to set var names that aren't all lc.
2759 ;; It is traditional to ignore
2760 ;; case when checking for `mode' in set-auto-mode,
2761 ;; so we must do that here as well.
2762 ;; That is inconsistent, but we're stuck with it.
2763 ;; The same can be said for `coding' in set-auto-coding.
2769 'eval
2776 mode-specified
2777 result))))
2780 "Apply an alist of local variable settings.
2781 RESULT is the alist.
2782 Will query the user when necessary."
2789 ;; Find those variables that we may want to save to
2790 ;; `safe-local-variable-values'.
2795 ;; Don't query about the fake variables.
2806 ;; If caller wants only the safe variables,
2807 ;; install only them.
2812 ;; Query, except in the case where all are known safe
2813 ;; if the user wants no query in that case.
2819 result unsafe-vars risky-vars project))
2824 "Parse and put into effect this buffer's local variables spec.
2825 If MODE-ONLY is non-nil, all we do is check whether the major mode
2826 is specified, returning t if it is specified."
2829 result)
2832 ;; Look for "Local variables:" line in last page.
2840 ;; suffix is what comes after "local variables:" in its line.
2841 ;; prefix is what comes before "local variables:" in its line.
2851 beg)
2855 endpos
2861 nil t))
2862 ;; This used to be an error, but really all it means is
2863 ;; that this may simply not be a local-variables section,
2864 ;; so just ignore it.
2874 ;; Discard the prefix.
2879 ;; Discard the suffix.
2887 ;; Find the variable name; strip whitespace.
2895 val)
2896 ;; Read the variable value.
2906 'eval
2912 ;; We've read all the local variables. Now, return whether the
2913 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2914 ;; variables (if MODE-ONLY is nil.)
2916 result
2921 "Non-nil if SYM is safe as a file-local variable with value VAL.
2922 It is safe if any of these conditions are met:
2924 * There is a matching entry (SYM . VAL) in the
2925 `safe-local-variable-values' user option.
2927 * The `safe-local-variable' property of SYM is a function that
2928 evaluates to a non-nil value with VAL as an argument."
2934 "Non-nil if SYM could be dangerous as a file-local variable.
2935 It is dangerous if either of these conditions are met:
2937 * Its `risky-local-variable' property is non-nil.
2943 ;; If this is an alias, check the base name.
2963 "Return t if it is safe to eval EXP when it is found in a file."
2965 ;; Detect certain `put' expressions.
2971 ;; Only allow safe values of lisp-indent-hook;
2972 ;; not functions.
2975 ;; Only allow indirect form specs.
2976 ;; During bootstrapping, edebug-basic-spec might not be
2977 ;; defined yet.
2981 ;; Allow expressions that the user requested.
2983 ;; Certain functions can be allowed with safe arguments
2984 ;; or can specify verification functions to try.
2992 ok))
3000 ok)))))))
3003 "Set local variable VAR with value VAL.
3004 If VAR is `mode', call `VAL-mode' as a function unless it's
3005 already the major mode."
3015 ;; Make sure the string has no text properties.
3016 ;; Some text properties can get evaluated in various ways,
3017 ;; so it is risky to put them on with a local variable list.
3021 \f
3022 ;;; Handling directory local variables, aka project settings.
3031 "Return the project variable list for project CLASS."
3035 "Collect local variable settings from MODE-ALIST.
3036 SETTINGS is the initial list of bindings.
3037 Returns the new list."
3044 ;; Need a new cons in case we setcdr later.
3048 "Collect entries from BINDING-LIST into SETTINGS.
3049 ROOT is the root directory of the project.
3050 Return the new settings list."
3058 ;; Don't include this in the previous condition, because we
3059 ;; want to filter all strings before the next condition.
3064 root settings))))
3068 settings))))))))
3071 "Declare that the project rooted at DIRECTORY is an instance of CLASS.
3072 DIRECTORY is the name of a directory, a string.
3073 CLASS is the name of a project class, a symbol.
3075 When a file beneath DIRECTORY is visited, the mode-specific
3076 settings from CLASS will be applied to the buffer. The settings
3077 for a class are defined using `define-project-bindings'."
3084 "Map the project type CLASS to a list of variable settings.
3085 CLASS is the project class, a symbol.
3086 LIST is a list that declares variable settings for the class.
3087 An element in LIST is either of the form:
3088 (MAJOR-MODE . ALIST)
3089 or
3090 (DIRECTORY . LIST)
3092 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3093 whose elements are of the form (VARIABLE . VALUE).
3095 In the second form, DIRECTORY is a directory name (a string), and
3096 LIST is a list of the form accepted by the function.
3098 When a file is visited, the file's class is found. A directory
3099 may be assigned a class using `set-directory-project'. Then
3100 variables are set in the file's buffer according to the class'
3101 LIST. The list is processed in order.
3103 * If the element is of the form (MAJOR-MODE . ALIST), and the
3104 buffer's major mode is derived from MAJOR-MODE (as determined
3105 by `derived-mode-p'), then all the settings in ALIST are
3106 applied. A MAJOR-MODE of nil may be used to match any buffer.
3107 `make-local-variable' is called for each variable before it is
3108 set.
3110 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3111 is an initial substring of the file's directory, then LIST is
3112 applied by recursively following these rules."
3119 "Find the settings file for FILE.
3120 This searches upward in the directory tree.
3121 If a settings file is found, the file name is returned.
3122 If the file is in a registered project, a cons from
3123 `project-directory-alist' is returned.
3124 Otherwise this returns nil."
3128 ;; `locate-dominating-file' may have abbreviated the name.
3138 settings pda)
3142 "Load a settings file and register a new project class and instance.
3143 SETTINGS-FILE is the name of the file holding the settings to apply.
3144 The new class name is the same as the directory in which SETTINGS-FILE
3145 is found. Returns the new class name."
3147 ;; We should probably store the modtime of SETTINGS-FILE and then
3148 ;; reload it whenever it changes.
3155 class-name)))
3160 "Set local variables in a buffer based on project settings."
3162 ;; Find the settings file.
3176 root-dir nil)))
3179 ;; Special case C and derived modes. Note that CC-based
3180 ;; modes don't work with derived-mode-p. In general I
3181 ;; think modes could use an auxiliary method which is
3182 ;; called after local variables are hacked.
3184 c-buffer-is-cc-mode
3187 \f
3190 However, the mode will not be changed if
3191 \(1) a local variables list or the `-*-' line specifies a major mode, or
3193 \ not suitable for ordinary files, or
3194 \(3) the new file name does not particularly specify any mode."
3199 "Change name of file visited in current buffer to FILENAME.
3200 This also renames the buffer to correspond to the new file.
3201 The next time the buffer is saved it will go in the newly specified file.
3202 FILENAME nil or an empty string means mark buffer as not visiting any file.
3203 Remember to delete the initial contents of the minibuffer
3204 if you wish to pass an empty string as the argument.
3206 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3207 confirmation in the case where another buffer is already visiting FILENAME.
3209 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3210 the old visited file has been renamed to the new name FILENAME."
3218 nil
3233 filename)))
3245 ;; If new-name == old-name, renaming would add a spurious <2>
3246 ;; and it's considered as a feature in rename-buffer.
3252 ;; Abbreviate the file names of the buffer.
3261 nil)))
3262 ;; write-file-functions is normally used for things like ftp-find-file
3263 ;; that visit things that are not local files as if they were files.
3264 ;; Changing to visit an ordinary local file instead should flush the hook.
3269 ;; If buffer was read-only because of version control,
3270 ;; that reason is gone now, so make it writable.
3274 ;; Turn off backup files for certain file names.
3275 ;; Since this is a permanent local, the major mode won't eliminate it.
3277 backup-enable-predicate
3283 ;; If auto-save was not already on, turn it on if appropriate.
3287 ;; If auto save is on, start using a new name.
3288 ;; We deliberately don't rename or delete the old auto save
3289 ;; for the old visited file name. This is because perhaps
3290 ;; the user wants to save the new state and then compare with the
3291 ;; previous state from the auto save file.
3294 ;; Rename the old auto save file if any.
3301 ;; Update the major mode, if the file name determines it.
3303 ;; Don't change the mode if it is special.
3306 ;; Don't change the mode if the local variable list specifies it.
3312 "Write current buffer into file FILENAME.
3313 This makes the buffer visit that file, and marks it as not modified.
3315 If you specify just a directory name as FILENAME, that means to use
3316 the default file name but in that directory. You can also yank
3317 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3319 If the buffer is not already visiting a file, the default file name
3320 for the output file is the buffer name.
3322 If optional second arg CONFIRM is non-nil, this function
3323 asks for confirmation before overwriting an existing file.
3324 Interactively, confirmation is required unless you supply a prefix argument."
3325 ;; (interactive "FWrite file: ")
3329 nil nil nil nil)
3333 default-directory)
3334 nil nil))
3338 ;; If arg is just a directory,
3339 ;; use the default file name, but in that directory.
3350 ;; Make buffer writable if file is writable.
3355 ;; It's likely that the VC status at the new location is different from
3356 ;; the one at the old location.
3358 \f
3360 "Make a backup of the disk file visited by the current buffer, if appropriate.
3361 This is normally done before saving the buffer the first time.
3363 A backup may be done by renaming or by copying; see documentation of
3364 variable `make-backup-files'. If it's done by renaming, then the file is
3365 no longer accessible under its old name.
3367 The value is non-nil after a backup was made by renaming.
3368 It has the form (MODES . BACKUPNAME).
3369 MODES is the result of `file-modes' on the original
3370 file; this means that the caller, after saving the buffer, should change
3371 the modes of the new file to agree with the old modes.
3372 BACKUPNAME is the backup file name, which is the old file renamed."
3379 backup-info backupname targets setmodes)
3380 ;; If specified name is a symbolic link, chase it to the target.
3381 ;; Thus we make the backups in the directory where the real file is.
3386 ;; (if (file-directory-p buffer-file-name)
3387 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3391 ;; If have old versions to maybe delete,
3392 ;; ask the user to confirm now, before doing anything.
3393 ;; But don't actually delete til later.
3398 real-file-name)))))
3400 ;; Actually write the back up file.
3403 ; (file-symlink-p buffer-file-name)
3404 backup-by-copying
3405 ;; Don't rename a suid or sgid file.
3420 ;; rename-file should delete old backup.
3424 ;; If trouble writing the backup, write it in ~.
3429 backupname)
3433 ;; Now delete the old versions, if desired.
3440 setmodes)
3447 ;; Create temp files with strict access rights. It's easy to
3448 ;; loosen them later, whereas it's impossible to close the
3449 ;; time-window of loose permissions otherwise.
3452 ;; Try to overwrite old backup first.
3460 nil)
3462 ;; The file was somehow created by someone else between
3463 ;; `delete-file' and `copy-file', so let's try again.
3464 ;; rms says "I think there is also a possible race
3465 ;; condition for making backup files" (emacs-devel 20070821).
3466 nil)))
3467 ;; Reset the umask.
3473 "Return file NAME sans backup versions or strings.
3474 This is a separate procedure so your site-init or startup file can
3475 redefine it.
3476 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3477 we do not remove backup version numbers, only true file version numbers."
3483 ;; VMS version number is (a) semicolon, optional
3484 ;; sign, zero or more digits or (b) period, option
3485 ;; sign, zero or more digits, provided this is the
3486 ;; second period encountered outside of the
3487 ;; device/directory part of the file name.
3490 name)
3500 "Return t if deleting FILE and rewriting it would preserve the owner."
3505 ;; Return t if the file doesn't exist, since it's true that no
3506 ;; information would be lost by an (attempted) delete and create.
3512 The extension, in a file name, is the part that follows the last `.',
3513 except that a leading `.', if any, doesn't count."
3516 directory)
3520 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3521 ;; we don't want to expand it.
3524 filename))))
3528 The extension, in a file name, is the part that follows the last `.',
3529 excluding version numbers and backup suffixes,
3530 except that a leading `.', if any, doesn't count.
3531 Return nil for extensionless file names such as `foo'.
3532 Return the empty string for file names such as `foo.'.
3534 If PERIOD is non-nil, then the returned value includes the period
3535 that delimits the extension, and if FILENAME has no extension,
3546 "A function to use instead of the default `make-backup-file-name'.
3547 A value of nil gives the default `make-backup-file-name' behavior.
3549 This could be buffer-local to do something special for specific
3550 files. If you define it, you may need to change `backup-file-name-p'
3551 and `file-name-sans-versions' too.
3553 See also `backup-directory-alist'."
3559 "Alist of filename patterns and backup directory names.
3560 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3561 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3562 relative or absolute. If it is absolute, so that all matching files
3563 are backed up into the same directory, the file names in this
3564 directory will be the full name of the file backed up with all
3565 directory separators changed to `!' to prevent clashes. This will not
3566 work correctly if your filesystem truncates the resulting name.
3568 For the common case of all backups going into one directory, the alist
3570 directory name.
3572 If this variable is nil, or it fails to match a filename, the backup
3573 is made in the original file's directory.
3575 On MS-DOS filesystems without long names this variable is always
3576 ignored."
3582 "Default `backup-enable-predicate' function.
3583 Checks for files in `temporary-file-directory',
3584 `small-temporary-file-directory', and /tmp."
3587 ;; Directory is under temporary-file-directory.
3592 ;; Directory is under /tmp.
3597 0 nil
3599 ;; Directory is under small-temporary-file-directory.
3604 "Create the non-numeric backup file name for FILE.
3605 Normally this will just be the file's name with `~' appended.
3606 Customization hooks are provided as follows.
3608 If the variable `make-backup-file-name-function' is non-nil, its value
3609 should be a function which will be called with FILE as its argument;
3610 the resulting name is used.
3612 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3613 the documentation of that variable. If the directory for the backup
3614 doesn't exist, it is created."
3628 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3630 elt backup-directory abs-backup-directory)
3635 alist nil)))
3636 ;; If backup-directory is relative, it should be relative to the
3637 ;; file's directory. By expanding explicitly here, we avoid
3638 ;; depending on default-directory.
3647 abs-backup-directory nil))))
3649 file
3653 ;; Normalize DOSish file names: downcase the drive
3654 ;; letter, if any, and replace the leading "x:" with
3655 ;; "/drive_x".
3658 ;; Replace any invalid file-name characters (for the
3659 ;; case of backing up remote files).
3663 "drive_"
3666 ""
3669 ;; Make the name unique by substituting directory
3670 ;; separators. It may not really be worth bothering about
3671 ;; doubling `!'s in the original name...
3676 backup-directory))
3681 "Return non-nil if FILE is a backup file name (numeric or not).
3682 This is a separate function so you can redefine it for customization.
3683 You may need to redefine `file-name-sans-versions' as well."
3688 ;; This is used in various files.
3689 ;; The usage of backup-extract-version-start is not very clean,
3690 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3692 "Given the name of a numeric backup file, FN, return the backup number.
3693 Uses the free variable `backup-extract-version-start', whose value should be
3694 the index in the name where the version number begins."
3700 ;; I believe there is no need to alter this behavior for VMS;
3701 ;; since backup files are not made on VMS, it should not get called.
3703 "Find a file name for a backup file FN, and suggestions for deletions.
3704 Value is a list whose car is the name for the backup file
3705 and whose cdr is a list of old versions to consider deleting now.
3706 If the value is nil, don't make a backup.
3707 Uses `backup-directory-alist' in the same way as does
3708 `make-backup-file-name'."
3710 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3714 ;; We don't support numbered backups on plain MS-DOS
3715 ;; when long file names are unavailable.
3725 possibilities deserve-versions-p versions)
3728 base-versions
3731 possibilities)
3732 #'<)
3737 kept-old-versions
3738 kept-new-versions
3745 ;; Delete nothing if there is overflow
3746 ;; in the number of versions to keep.
3752 v))))))))))
3755 "Return number of names file FILENAME has."
3758 ;; (defun file-relative-name (filename &optional directory)
3759 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3760 ;; This function returns a relative file name which is equivalent to FILENAME
3761 ;; when used with that default directory as the default.
3762 ;; If this is impossible (which can happen on MSDOS and Windows
3763 ;; when the file name and directory use different drive names)
3764 ;; then it returns FILENAME."
3765 ;; (save-match-data
3766 ;; (let ((fname (expand-file-name filename)))
3767 ;; (setq directory (file-name-as-directory
3768 ;; (expand-file-name (or directory default-directory))))
3769 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3770 ;; ;; drive names, they can't be relative, so return the absolute name.
3771 ;; (if (and (or (eq system-type 'ms-dos)
3772 ;; (eq system-type 'cygwin)
3773 ;; (eq system-type 'windows-nt))
3774 ;; (not (string-equal (substring fname 0 2)
3775 ;; (substring directory 0 2))))
3776 ;; filename
3777 ;; (let ((ancestor ".")
3778 ;; (fname-dir (file-name-as-directory fname)))
3779 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3780 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3781 ;; (setq directory (file-name-directory (substring directory 0 -1))
3782 ;; ancestor (if (equal ancestor ".")
3783 ;; ".."
3784 ;; (concat "../" ancestor))))
3785 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3786 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3787 ;; ;; We matched within FNAME's directory part.
3788 ;; ;; Add the rest of FNAME onto ANCESTOR.
3789 ;; (let ((rest (substring fname (match-end 0))))
3790 ;; (if (and (equal ancestor ".")
3791 ;; (not (equal rest "")))
3792 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3793 ;; rest
3794 ;; (concat (file-name-as-directory ancestor) rest)))
3795 ;; ;; We matched FNAME's directory equivalent.
3796 ;; ancestor))))))
3799 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3800 This function returns a relative file name which is equivalent to FILENAME
3801 when used with that default directory as the default.
3802 If FILENAME and DIRECTORY lie on different machines or on different drives
3803 on a DOS/Windows machine, it returns FILENAME in expanded form."
3807 default-directory))))
3813 ;; Test for different drives on DOS/Windows
3815 ;; Should `cygwin' really be included here? --stef
3818 ;; Test for different remote file system identification
3820 filename
3826 directory nil nil case-fold-search))
3828 directory nil nil case-fold-search))))
3831 ".."
3833 ;; Now ancestor is empty, or .., or ../.., etc.
3835 directory nil nil case-fold-search))
3836 ;; We matched within FILENAME's directory part.
3837 ;; Add the rest of FILENAME onto ANCESTOR.
3840 ;; But don't bother with ANCESTOR if it would give us `./'.
3841 rest
3843 ;; We matched FILENAME's directory equivalent.
3844 ancestor))))))
3845 \f
3847 "Save current buffer in visited file if modified.
3848 Variations are described below.
3850 By default, makes the previous version into a backup file
3851 if previously requested or if this is the first save.
3853 to become a backup when the next save is done.
3855 unconditionally makes the previous version into a backup file.
3857 to become a backup when the next save is done,
3858 and unconditionally makes the previous version into a backup file.
3860 With a numeric argument of 0, never make the previous version
3861 into a backup file.
3863 If a file's name is FOO, the names of its numbered backup versions are
3864 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3865 Numeric backups (rather than FOO~) will be made if value of
3866 `version-control' is not the atom `never' and either there are already
3867 numeric versions of the file being backed up, or `version-control' is
3868 non-nil.
3869 We don't want excessive versions piling up, so there are variables
3870 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3871 and `kept-new-versions', which tells how many newest versions to keep.
3872 Defaults are 2 old versions and 2 new.
3873 `dired-kept-versions' controls dired's clean-directory (.) command.
3874 If `delete-old-versions' is nil, system will query user
3875 before trimming versions. Otherwise it does it silently.
3877 If `vc-make-backup-files' is nil, which is the default,
3878 no backup files are made for files managed by version control.
3879 (This is because the version control system itself records previous versions.)
3881 See the subroutine `basic-save-buffer' for more information."
3894 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3895 Normally delete only if the file was written by this Emacs since
3896 the last real save, but optional arg FORCE non-nil means delete anyway."
3910 "Normal hook that is run before a buffer is saved to its file."
3916 "Normal hook that is run after a buffer is saved to its file."
3922 "If non-nil, use this coding system for saving the buffer.
3923 More precisely, use this coding system in place of the
3924 value of `buffer-file-coding-system', when saving the buffer.
3925 Calling `write-region' for any purpose other than saving the buffer
3926 will still use `buffer-file-coding-system'; this variable has no effect
3933 "Save the current buffer in its visited file, if it has been modified.
3934 The hooks `write-contents-functions' and `write-file-functions' get a chance
3935 to do the job of saving; if they do not, then the buffer is saved in
3936 the visited file in the usual way.
3937 Before and after saving the buffer, this function runs
3938 `before-save-hook' and `after-save-hook', respectively."
3941 ;; In an indirect buffer, save its base buffer instead.
3946 setmodes)
3947 ;; On VMS, rename file and buffer to get rid of version number.
3952 ;; Strip VMS version number before save.
3955 ;; Construct a (unique) buffer name to correspond.
3960 ;; If buffer has no file name, ask user for one.
3967 ;; Signal an error if the user specified the name of an
3968 ;; existing directory.
3971 filename))
3973 ;; Signal an error if the specified name refers to a
3974 ;; non-existing directory.
4004 ;; Support VC version backups.
4010 ;; If a hook returned t, file is already "written".
4011 ;; Otherwise, write it the usual way now.
4013 ;; Now we have saved the current buffer. Let's make sure
4014 ;; that buffer-file-coding-system is fixed to what
4015 ;; actually used for saving by binding it locally.
4025 ;; If the auto-save file was recent before this command,
4026 ;; delete it now.
4028 ;; Support VC `implicit' locking.
4033 ;; This does the "real job" of writing a buffer into its visited file
4034 ;; and making a backup file. This is what is normally done
4035 ;; but inhibited if one of write-file-functions returns non-nil.
4036 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4045 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4059 buffer-file-name)))
4067 ;; If file is precious, write temp name, then rename it.
4068 ;; This requires write access to the containing dir,
4069 ;; which is why we don't try it if we don't have that access.
4071 tempname succeed
4074 ;; Create temp files with strict access rights. It's easy to
4075 ;; loosen them later, whereas it's impossible to close the
4076 ;; time-window of loose permissions otherwise.
4081 ;; Try various temporary names.
4082 ;; This code follows the example of make-temp-file,
4083 ;; but it calls write-region in the appropriate way
4084 ;; for saving the buffer.
4090 ;; Pass in nil&nil rather than point-min&max
4091 ;; cause we're saving the whole buffer.
4092 ;; write-region-annotate-functions may use it.
4094 tempname nil realname
4096 nil)
4098 ;; The file was somehow created by someone else between
4099 ;; `make-temp-name' and `write-region', let's try again.
4100 nil)
4102 ;; Reset the umask.
4104 ;; If we failed, restore the buffer's modtime.
4107 ;; Since we have created an entirely new file,
4108 ;; make sure it gets the right permission bits set.
4112 buffer-file-name)))
4113 ;; We succeeded in writing the temp file,
4114 ;; so rename it.
4116 ;; If file not writable, see if we can make it writable
4117 ;; temporarily while we write it.
4118 ;; But no need to do so if we have just backed it up
4119 ;; (setmodes is set) because that says we're superseding.
4121 ;; Change the mode back, after writing.
4127 ;; Pass in nil&nil rather than point-min&max to indicate
4128 ;; we're saving the buffer rather than just a region.
4129 ;; write-region-annotate-functions may make us of it.
4131 buffer-file-name nil t buffer-file-truename)
4133 ;; If we get an error writing the new file, and we made
4134 ;; the backup by renaming, undo the backing-up.
4139 setmodes))
4142 "View the differences between BUFFER and its associated file.
4143 This requires the external program `diff' to be in your `exec-path'."
4157 ;; Display that message for 1 second so that user can read it
4158 ;; in the minibuffer.
4160 ;; return always nil, so that save-buffers-kill-emacs will not move
4161 ;; over to the next unsaved buffer when calling `d'.
4162 nil)
4165 `((?\C-r
4172 ;; Return nil to ask about BUF again.
4173 nil)
4185 ;; Return nil to ask about BUF again.
4186 nil)
4195 "Save some modified file-visiting buffers. Asks user about each one.
4196 You can answer `y' to save, `n' not to save, `C-r' to look at the
4197 buffer in question with `view-buffer' before deciding or `d' to
4198 view the differences using `diff-buffer-with-file'.
4200 Optional argument (the prefix) non-nil means save all with no questions.
4201 Optional second argument PRED determines which buffers are considered:
4202 If PRED is nil, all the file-visiting buffers are considered.
4203 If PRED is t, then certain non-file buffers will also be considered.
4204 If PRED is a zero-argument function, it indicates for each buffer whether
4205 to consider it or not when called with that buffer current.
4207 See `save-some-buffers-action-alist' if you want to
4208 change the additional actions you can take on files."
4212 files-done abbrevs-done)
4214 ;; First save any buffers that we're supposed to save unconditionally.
4215 ;; That way the following code won't ask about them.
4220 ;; Ask about those buffers that merit it,
4221 ;; and record the number thus saved.
4236 t
4248 save-some-buffers-action-alist))
4249 ;; Maybe to save abbrevs, and record whether
4250 ;; we either saved them or asked to.
4256 abbrev-file-name)))
4258 ;; Don't keep bothering user if he says no.
4263 "(Some special files were saved without asking)"
4265 \f
4267 "Mark current buffer as unmodified, not needing to be saved.
4270 It is not a good idea to use this function in Lisp programs, because it
4271 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4278 "Change whether this buffer is visiting its file read-only.
4279 With prefix argument ARG, make the buffer read-only if ARG is
4280 positive, otherwise make it writable. If visiting file read-only
4281 and `view-read-only' is non-nil, enter view mode."
4286 nil ; do nothing.
4287 ;; Toggle.
4294 ;; If view-mode is already active, `view-mode-enter' is a nop.
4306 "Insert contents of file FILENAME into buffer after point.
4307 Set mark after the inserted text.
4309 This function is meant for the user to run interactively.
4310 Don't call it from programs! Use `insert-file-contents' instead.
4311 \(Its calling sequence is different; see its documentation)."
4316 "Append the contents of the region to the end of file FILENAME.
4317 When called from a function, expects three arguments,
4318 START, END and FILENAME. START and END are buffer positions
4319 saying what text to write."
4324 "Return most recent backup file for FILENAME or nil if no backups exist."
4325 ;; `make-backup-file-name' will get us the right directory for
4326 ;; ordinary or numeric backups. It might create a directory for
4327 ;; backups as a side-effect, according to `backup-directory-alist'.
4334 tem)
4343 newest))
4346 "Rename current buffer to a similar name not already taken.
4347 This function is useful for creating multiple shell process buffers
4348 or multiple mail buffers, etc."
4356 ;; If the existing buffer name has a <NNN>,
4357 ;; which isn't part of the file name (if any),
4358 ;; then get rid of that.
4364 "Create the directory DIR and any nonexistent parent dirs.
4365 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4367 Interactively, the default choice of directory to create
4368 is the current default directory for file names.
4369 That is useful when you have visited a file in a nonexistent directory.
4371 Noninteractively, the second (optional) argument PARENTS says whether
4372 to create parent directories if they don't exist. Interactively,
4373 this happens by default."
4376 nil nil)
4377 t))
4378 ;; If default-directory is a remote directory,
4379 ;; make sure we find its make-directory handler.
4387 create-list)
4394 \f
4397 "Function to use to revert this buffer, or nil to do the default.
4398 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4403 "Function to use to insert contents when reverting this buffer.
4404 Gets two args, first the nominal file name to use,
4405 and second, t if reading the auto-save file.
4410 "Function to check whether a non-file buffer needs reverting.
4411 This should be a function with one optional argument NOCONFIRM.
4412 Auto Revert Mode passes t for NOCONFIRM. The function should return
4413 non-nil if the buffer should be reverted. A return value of
4414 `fast' means that the need for reverting was not checked, but
4415 that reverting the buffer is fast. The buffer is current when
4416 this function is called.
4418 The idea behind the NOCONFIRM argument is that it should be
4419 non-nil if the buffer is going to be reverted without asking the
4420 user. In such situations, one has to be careful with potentially
4421 time consuming operations.
4423 For more information on how this variable is used by Auto Revert mode,
4427 "Normal hook for `revert-buffer' to run before reverting.
4428 If `revert-buffer-function' is used to override the normal revert
4432 "Normal hook for `revert-buffer' to run after reverting.
4433 Note that the hook value that it runs is the value that was in effect
4434 before reverting; that makes a difference if you have buffer-local
4435 hook functions.
4437 If `revert-buffer-function' is used to override the normal revert
4443 "Replace current buffer text with the text of the visited file on disk.
4444 This undoes all changes since the file was visited or saved.
4445 With a prefix argument, offer to revert from latest auto-save file, if
4446 that is more recent than the visited file.
4448 This command also implements an interface for special buffers
4449 that contain text which doesn't come from a file, but reflects
4450 some other data instead (e.g. Dired buffers, `buffer-list'
4451 buffers). This is done via the variable
4452 `revert-buffer-function'. In these cases, it should reconstruct
4453 the buffer contents from the appropriate data.
4455 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4456 to revert from the auto-save file when this is nil. Note that the
4457 sense of this argument is the reverse of the prefix argument, for the
4458 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4459 to nil.
4461 Optional second argument NOCONFIRM means don't ask for confirmation at
4462 all. \(The variable `revert-without-query' offers another way to
4463 revert buffers without querying for confirmation.)
4465 Optional third argument PRESERVE-MODES non-nil means don't alter
4466 the files modes. Normally we reinitialize them using `normal-mode'.
4468 If the value of `revert-buffer-function' is non-nil, it is called to
4469 do all the work for this command. Otherwise, the hooks
4470 `before-revert-hook' and `after-revert-hook' are run at the beginning
4471 and the end, and if `revert-buffer-insert-file-contents-function' is
4472 non-nil, it is called instead of rereading visited file contents."
4474 ;; I admit it's odd to reverse the sense of the prefix argument, but
4475 ;; there is a lot of code out there which assumes that the first
4476 ;; argument should be t to avoid consulting the auto-save file, and
4477 ;; there's no straightforward way to encourage authors to notice a
4478 ;; reversal of the argument sense. So I'm just changing the user
4479 ;; interface, but leaving the programmatic interface the same.
4487 buffer-auto-save-file-name
4492 buffer-auto-save-file-name
4493 buffer-file-name)))
4503 file-name)))
4505 ;; If file was backed up but has changed since,
4506 ;; we shd make another backup.
4510 ;; Effectively copy the after-revert-hook status,
4511 ;; since after-find-file will clobber it.
4514 after-revert-hook))
4519 ;; Get rid of all undo records for this buffer.
4521 ;; Don't make undo records for the reversion.
4524 file-name auto-save-p)))
4527 "File %s no longer exists!"
4529 file-name))
4532 "File %s no longer readable!"
4534 file-name))
4536 ;; Bind buffer-file-name to nil
4537 ;; so that we don't try to lock the file.
4543 ;; Auto-saved file should be read by Emacs'
4544 ;; internal coding.
4547 buffer-file-coding-system-explicit))))
4549 coding-system-for-read
4551 coding-system-for-read)
4553 ;; As a coding system suitable for multibyte
4554 ;; buffer is specified, make the current
4555 ;; buffer multibyte.
4558 ;; This force after-insert-file-set-coding
4559 ;; (called from insert-file-contents) to set
4560 ;; buffer-file-coding-system to a proper value.
4563 ;; Note that this preserves point in an intelligent way.
4567 nil nil t))
4569 nil nil t)))))
4570 ;; Recompute the truename in case changes in symlinks
4571 ;; have changed the truename.
4575 ;; Run after-revert-hook as it was before we reverted.
4579 local-hook)
4582 t))))))
4585 "Recover the visited file--get contents from its last auto-save file."
4590 "Visit file FILE, but get contents from its last auto-save file."
4591 ;; Actually putting the file name in the minibuffer should be used
4592 ;; only rarely.
4593 ;; Not just because users often use the default.
4613 ;; Use insert-directory-safely, not insert-directory,
4614 ;; because these files might not exist. In particular,
4615 ;; FILE might not exist if the auto-save file was for
4616 ;; a buffer that didn't visit a file, such as "*mail*".
4617 ;; The code in v20.x called `ls' directly, so we need
4618 ;; to emulate what `ls' did in that case.
4624 ;; Keep the current buffer-file-coding-system.
4626 ;; Auto-saved file should be read with special coding.
4635 "Recover auto save files from a previous Emacs session.
4636 This command first displays a Dired buffer showing you the
4637 previous sessions that you could recover from.
4638 To choose one, move point to the proper line and then type C-c C-c.
4639 Then you'll be asked about a number of files to recover."
4649 auto-save-list-file-prefix)))
4650 t)
4659 ;; Each line starts with a space
4660 ;; so that Font Lock mode won't highlight the first character.
4669 "Choose one saved session to recover auto-save files from.
4670 This command is used in the special Dired buffer created by
4673 ;; Get the name of the session file to recover from.
4675 files
4681 ;; Read in the auto-save-list file.
4685 ;; Loop thru the text of that file
4686 ;; and get out the names of the files to recover.
4690 ;; This is a pair of lines for a non-file-visiting buffer.
4691 ;; Get the auto-save file name and manufacture
4692 ;; a "visited file name" from that.
4695 ;; If there is no auto-save file name, the
4696 ;; auto-save-list file is probably corrupted.
4709 ;; This pair of lines is a file-visiting
4710 ;; buffer. Use the visited file name.
4720 ;; Ignore a file if its auto-save file does not exist now.
4724 ;; The file contains a pair of line for each auto-saved buffer.
4725 ;; The first line of the pair contains the visited file name
4726 ;; or is empty if the buffer was not visiting a file.
4727 ;; The second line is the auto-save file name.
4735 files
4741 "Kill buffer if confirmed."
4749 "Kill some buffers. Asks the user whether to kill each one of them.
4750 Non-interactively, if optional argument LIST is non-nil, it
4751 specifies the list of buffers to kill, asking for approval for each one."
4759 ; if we killed the base buffer.
4766 "Kill buffers whose name matches the specified regexp.
4767 The optional second argument indicates whether to kill internal buffers too."
4776 \f
4778 "Toggle auto-saving of contents of current buffer.
4779 With prefix argument ARG, turn auto-saving on if positive, else off."
4784 ;; If auto-save is off because buffer has shrunk,
4785 ;; then toggling should turn it on.
4790 buffer-file-name
4792 ;; If -1 was stored here, to temporarily turn off saving,
4793 ;; turn it back on.
4799 buffer-auto-save-file-name)
4802 "Adjust current buffer's auto save file name for current conditions.
4803 Also rename any existing auto save file, if it was made in this session."
4815 "Return file name to use for auto-saves of current buffer.
4816 Does not consider `auto-save-visited-file-name' as that variable is checked
4817 before calling this function. You can redefine this for customization.
4818 See also `auto-save-file-name-p'."
4826 result uniq)
4827 ;; Apply user-specified translations
4828 ;; to the file name.
4832 filename)
4842 filename))))
4847 ;; We truncate the file name to DOS 8+3 limits
4848 ;; before doing anything else, because the regexp
4849 ;; passed to string-match below cannot handle
4850 ;; extensions longer than 3 characters, multiple
4851 ;; dots, and other atrocities.
4856 fn)
4861 "#"
4864 ;; Make sure auto-save file names don't contain characters
4865 ;; invalid for the underlying filesystem.
4867 ;; Don't modify remote (ange-ftp) filenames
4870 result))))
4872 ;; Deal with buffers that don't have any associated files. (Mail
4873 ;; mode tends to create a good number of these.)
4877 file-name)
4878 ;; Restrict the characters used in the file name to those which
4879 ;; are known to be safe on all filesystems, url-encoding the
4880 ;; rest.
4881 ;; We do this on all platforms, because even if we are not
4882 ;; running on DOS/Windows, the current directory may be on a
4883 ;; mounted VFAT filesystem, such as a USB memory stick.
4887 ;; For multibyte characters, this will produce more than
4888 ;; 2 hex digits, so is not true URL encoding.
4892 ;; Generate the file name.
4898 ;; Try a few alternative directories, to get one we can
4899 ;; write it.
4905 ;; Don't modify remote (ange-ftp) filenames
4907 ;; The call to convert-standard-filename is in case
4908 ;; buffer-name includes characters not allowed by the
4909 ;; DOS/Windows filesystems. make-temp-file writes to the
4910 ;; file it creates, so we must fix the file name _before_
4911 ;; make-temp-file is called.
4913 fname))
4915 ;; make-temp-file creates the file,
4916 ;; but we don't want it to exist until we do an auto-save.
4920 file-name)))
4923 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4924 FILENAME should lack slashes. You can redefine this for customization."
4926 \f
4928 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4929 The generated regexp will match a filename only if the filename
4930 matches that wildcard according to shell rules. Only wildcards known
4931 by `sh' are supported."
4933 ;; Copy the initial run of non-special characters.
4936 ;; If no special characters, we're almost done.
4940 j)
4942 result
4963 ;; Found "[^". Insert a `\0' character
4964 ;; (which cannot happen in a filename)
4965 ;; into the character class, so that `^'
4966 ;; is not the first character after `[',
4967 ;; and thus non-special in a regexp.
4972 ;; I don't think `]' can appear in a
4973 ;; character class in a wildcard, but
4974 ;; let's be general here.
4981 i
4994 ;; Shell wildcards should match the entire filename,
4995 ;; not its part. Make the regexp say so.
4997 \f
5000 "Switches for `list-directory' to pass to `ls' for brief listing."
5006 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
5008 "Switches for `list-directory' to pass to `ls' for verbose listing."
5013 "Expand wildcard pattern PATTERN.
5014 This returns a list of file names which match the pattern.
5016 If PATTERN is written as an absolute file name,
5017 the values are absolute also.
5019 If PATTERN is written as a relative file name, it is interpreted
5020 relative to the current default directory, `default-directory'.
5021 The file names returned are normally also relative to the current
5022 default directory. However, if FULL is non-nil, they are absolute."
5026 ;; A list of all dirs that DIRPART specifies.
5027 ;; This can be more than one dir
5028 ;; if DIRPART contains wildcards.
5033 contents)
5038 ;; Filter out "." and ".."
5043 name))
5050 this-dir-contents)
5051 this-dir-contents)
5052 contents))))
5054 contents)))
5057 "Display a list of files in or matching DIRNAME, a la `ls'.
5058 DIRNAME is globbed by the shell if necessary.
5059 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5060 Actions controlled by variables `list-directory-brief-switches'
5061 and `list-directory-verbose-switches'."
5065 nil default-directory nil)
5066 pfx)))
5068 list-directory-brief-switches))
5069 buffer)
5082 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5090 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5092 PATTERN is assumed to represent a file-name wildcard suitable for the
5093 underlying filesystem. For Unix and GNU/Linux, the characters from the
5095 the parts of the pattern which don't include wildcard characters are
5096 quoted with double quotes.
5097 Existing quote characters in PATTERN are left alone, so you can pass
5098 PATTERN that already quotes some of the special characters."
5102 ;; DOS/Windows don't allow `"' in file names. So if the
5103 ;; argument has quotes, we can safely assume it is already
5104 ;; quoted by the caller.
5106 ;; We quote [&()#$'] in case their shell is a port of a
5107 ;; Unixy shell. We quote [,=+] because stock DOS and
5108 ;; Windows shells require that in some cases, such as
5109 ;; passing arguments to batch files that use positional
5110 ;; arguments like %1.
5112 pattern
5115 end)
5132 pattern))))
5139 "Program to get the amount of free space on a file system.
5140 We assume the output has the format of `df'.
5141 The value of this variable must be just a command name or file name;
5142 if you want to specify options, use `directory-free-space-args'.
5144 A value of nil disables this feature.
5146 If the function `file-system-info' is defined, it is always used in
5147 preference to the program given by this variable."
5153 "Options to use when running `directory-free-space-program'."
5158 "Return the amount of free space on directory DIR's file system.
5159 The result is a string that gives the number of free 1KB blocks,
5160 or nil if the system call or the program which retrieve the information
5161 fail. It returns also nil when DIR is a remote directory.
5163 This function calls `file-system-info' if it is available, or invokes the
5164 program specified by `directory-free-space-program' if that is non-nil."
5166 ;; Try to find the number of free blocks. Non-Posix systems don't
5167 ;; always have df, but might have an equivalent system call.
5176 nil t nil
5177 directory-free-space-args
5178 dir)))
5179 ;; Usual format is a header line followed by a line of
5180 ;; numbers.
5185 ;; Move to the end of the "available blocks" number.
5188 ;; Copy it into AVAILABLE.
5193 ;; The following expression replaces `dired-move-to-filename-regexp'.
5197 ;; In some locales, month abbreviations are as short as 2 letters,
5198 ;; and they can be followed by ".".
5199 ;; In Breton, a month name can include a quote character.
5212 s "+"
5215 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5216 ;; omits the Kanji characters after month and day-of-month.
5217 ;; On Mac OS X 10.3, the date format in East Asian locales is
5218 ;; day-of-month digits followed by month digits.
5224 ;; The "[0-9]" below requires the previous column to end in a digit.
5225 ;; This avoids recognizing `1 may 1997' as a date in the line:
5226 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5228 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5229 ;; The ".*" below finds the last match if there are multiple matches.
5230 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5231 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5233 ;; vc dired listings provide the state or blanks between file
5234 ;; permissions and date. The state is always surrounded by
5235 ;; parantheses:
5236 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5237 ;; This is not supported yet.
5241 "Regular expression to match up to the file name in a directory listing.
5242 The default value is designed to recognize dates and times
5247 ;; insert-directory
5248 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5249 ;; FULL-DIRECTORY-P is nil.
5250 ;; The single line of output must display FILE's name as it was
5251 ;; given, namely, an absolute path name.
5252 ;; - must insert exactly one line for each file if WILDCARD or
5253 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5254 ;; before the file lines, plus optional text after the file lines.
5255 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5256 ;; allowed.
5257 ;; File lines should display the basename.
5258 ;; - must be consistent with
5259 ;; - functions dired-move-to-filename, (these two define what a file line is)
5260 ;; dired-move-to-end-of-filename,
5261 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5262 ;; dired-insert-headerline
5263 ;; dired-after-subdir-garbage (defines what a "total" line is)
5264 ;; - variable dired-subdir-regexp
5265 ;; - may be passed "--dired" as the first argument in SWITCHES.
5266 ;; Filename handlers might have to remove this switch if their
5267 ;; "ls" command does not support it.
5269 "Insert directory listing for FILE, formatted according to SWITCHES.
5270 Leaves point after the inserted text.
5271 SWITCHES may be a string of options, or a list of strings
5272 representing individual options.
5273 Optional third arg WILDCARD means treat FILE as shell wildcard.
5274 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5275 switches do not contain `d', so that a full listing is expected.
5277 This works by running a directory listing program
5278 whose name is in the variable `insert-directory-program'.
5279 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5281 When SWITCHES contains the long `--dired' option, this function
5282 treats it specially, for the sake of dired. However, the
5283 normally equivalent short `-D' option is just passed on to
5284 `insert-directory-program', as any other option."
5285 ;; We need the directory in order to find the right handler.
5290 wildcard full-directory-p)
5295 ;; Read the actual directory using `insert-directory-program'.
5296 ;; RESULT gets the status code.
5298 ;; putting text property `dired-filename, decode one
5299 ;; bunch by one to preserve that property.
5301 ;; This is to control encoding the arguments in call-process.
5305 default-file-name-coding-system))))
5308 ;; Run ls in the directory part of the file pattern
5309 ;; using the last component as argument.
5316 shell-file-name nil t nil
5317 "-c"
5319 ""
5321 insert-directory-program
5322 " -d "
5324 switches
5326 " -- "
5327 ;; Quote some characters that have
5328 ;; special meanings in shells; but
5329 ;; don't quote the wildcards--we want
5330 ;; them to be special. We also
5331 ;; currently don't quote the quoting
5332 ;; characters in case people want to
5333 ;; use them explicitly to quote
5334 ;; wildcard characters.
5336 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5337 ;; directory if FILE is a symbolic link.
5339 insert-directory-program nil t nil
5343 ;; Split the switches at any spaces so we can
5344 ;; pass separate options as separate args.
5346 ;; Avoid lossage if FILE starts with `-'.
5354 file))))))))
5356 ;; If we got "//DIRED//" in the output, it means we got a real
5357 ;; directory listing, even if `ls' returned nonzero.
5358 ;; So ignore any errors.
5371 ;; The first time ls returns an error,
5372 ;; find the version numbers of ls,
5373 ;; and set insert-directory-ls-version
5374 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5375 ;; is equal or if the info cannot be obtained.
5376 ;; (That can mean it isn't GNU ls.)
5386 comparison)
5402 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5406 ;; If `insert-directory-program' failed, signal an error.
5408 ;; Delete the error message it may have output.
5410 ;; On non-Posix systems, we cannot open a directory, so
5411 ;; don't even try, because that will always result in
5412 ;; the ubiquitous "Access denied". Instead, show the
5413 ;; command line so the user can try to guess what went wrong.
5418 insert-directory-program
5420 file result)
5421 ;; Unix. Access the file to get a suitable error.
5428 ;; The following overshoots by one line for an empty
5429 ;; directory listed with "--dired", but without "-a"
5430 ;; switch, where the ls output contains a
5431 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5432 ;; We take care of that case later.
5440 error-lines)
5441 ;; Find all the lines that are error messages,
5442 ;; and record the bounds of each one.
5449 ;; Now read the numeric positions of file names.
5456 error-lines))
5459 error-lines)))
5461 ;; End is followed by \n or by " -> ".
5463 ;; It seems that we can't trust ls's output as to
5464 ;; byte positions of filenames.
5470 ;; Take care of the case where the ls output contains a
5471 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5472 ;; and we went one line too far back (see above).
5477 ;; Now decode what read if necessary.
5479 file-name-coding-system
5480 default-file-name-coding-system
5482 coding-no-eol
5483 val pos)
5487 ;; If no coding system is specified or detection is
5488 ;; requested, detect the coding.
5502 ;; Force no eol conversion on a file name, so
5503 ;; that CR is preserved.
5511 ;; Try to insert the amount of free space.
5514 ;; First find the line to put it on.
5518 ;; Replace "total" with "used", to avoid confusion.
5524 "Convert `ls --dired' file name position value POS to a buffer position.
5525 File name position values returned in ls --dired output
5526 count only stdout; they don't count the error messages sent to stderr.
5527 So this function converts to them to real buffer positions.
5528 ERROR-LINES is a list of buffer positions of error message lines,
5529 of the form (START END)."
5533 pos)
5537 "Insert directory listing for FILE, formatted according to SWITCHES.
5539 Like `insert-directory', but if FILE does not exist, it inserts a
5540 message to that effect instead of signaling an error."
5543 ;; Simulate the message printed by `ls'.
5547 "Functions to call with no arguments to query about killing Emacs.
5548 If any of these functions returns nil, killing Emacs is cancelled.
5549 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5553 "How to ask for confirmation when leaving Emacs.
5554 If nil, the default, don't ask at all. If the value is non-nil, it should
5555 be a predicate function such as `yes-or-no-p'."
5563 "Offer to save each buffer, then kill this Emacs process.
5564 With prefix arg, silently save all file-visiting buffers, then kill."
5573 ;; process-list is not defined on VMS.
5575 active)
5584 ;; Query the user for other things, perhaps.
5591 "Offer to save each buffer, then kill the current connection.
5592 If the current frame has no client, kill Emacs itself.
5594 With prefix arg, silently save all file-visiting buffers, then kill.
5596 If emacsclient was started with a list of filenames to edit, then
5597 only these files will be asked to be saved."
5605 \f
5606 ;; We use /: as a prefix to "quote" a file name
5607 ;; so that magic file name handlers will not apply to it.
5611 file-name-handler-alist))
5613 ;; We depend on being the last handler on the list,
5614 ;; so that anything else which does need handling
5615 ;; has been handled already.
5616 ;; So it is safe for us to inhibit *all* magic file name handlers.
5625 default-directory))
5626 ;; Get a list of the indices of the args which are file names.
5629 ;; The first six are special because they
5630 ;; return a file name. We want to include the /:
5631 ;; in the return value.
5632 ;; So just avoid stripping it in the first place.
5639 ;; `identity' means just return the first arg
5640 ;; not stripped of its quoting.
5642 ;; `add' means add "/:" to the result.
5644 ;; `quote' means add "/:" to buffer-file-name.
5646 ;; `unquote-then-quote' means set buffer-file-name
5647 ;; temporarily to unquoted filename.
5649 ;; List the arguments which are filenames.
5657 ;; For all other operations, treat the first argument only
5658 ;; as the file name.
5660 method
5661 ;; Copy ARGUMENTS so we can replace elements in it.
5665 ;; Strip off the /: from the file names that have it.
5673 "/"
5689 res))
5692 \f
5693 ;; Symbolic modes and read-file-modes.
5696 "Convert CHAR to a who-mask from a symbolic mode notation.
5697 CHAR is in [ugoa] and represents the users on which rights are applied."
5705 "Convert CHAR to a right-mask from a symbolic mode notation.
5706 CHAR is in [rwxXstugo] and represents a right.
5707 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5714 ;; Rights relative to the previous file modes.
5725 "Convert a right string to a right-mask from a symbolic modes notation.
5727 WHO-MASK is the mask number of the users on which the rights are to be applied.
5728 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5734 char-right)
5741 num-rights
5745 op char-right)))
5746 num-rights))
5749 "Convert symbolic file modes to numeric file modes.
5750 MODES is the string to convert, it should match
5753 notation.
5754 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5767 num-who num-modes)
5770 num-modes)))
5773 "Read file modes in octal or symbolic notation.
5774 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5775 ORIG-FILE is the original file of which modes will be change."
5784 \f
5785 ;; Trash can handling.
5787 "Directory for `move-file-to-trash' to move files and directories to.
5788 This directory is only used when the function `system-move-file-to-trash' is
5789 not defined. Relative paths are interpreted relative to `default-directory'.
5790 See also `delete-by-moving-to-trash'."
5798 "Move file (or directory) name FILENAME to the trash.
5799 This function is called by `delete-file' and `delete-directory' when
5800 `delete-by-moving-to-trash' is non-nil. On platforms that define
5801 `system-move-file-to-trash', that function is used to move FILENAME to the
5802 system trash, otherwise FILENAME is moved to `trash-directory'.
5803 Returns nil on success."
5816 ;; make new-fn unique.
5817 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5820 ;; stop processing if fn is same or parent directory of trash-dir.
5823 filename))
5826 \f
5851 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5852 ;;; files.el ends here