| blob | ee9f6bb43bc6e5d3ffbd28f734d4a6e30a99c936 |
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."
74 "Non-nil means make a backup of a file the first time it is saved.
75 This can be done by renaming the file or by copying.
77 Renaming means that Emacs renames the existing file so that it is a
78 backup file, then writes the buffer into a new file. Any other names
79 that the old file had will now refer to the backup file. The new file
80 is owned by you and its group is defaulted.
82 Copying means that Emacs copies the existing file into the backup
83 file, then writes the buffer on top of the existing file. Any other
84 names that the old file had will now refer to the new (edited) file.
85 The file's owner and group are unchanged.
87 The choice of renaming or copying is controlled by the variables
88 `backup-by-copying', `backup-by-copying-when-linked',
89 `backup-by-copying-when-mismatch' and
90 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
94 ;; Do this so that local variables based on the file name
95 ;; are not overridden by the major mode.
97 "Non-nil means don't make a backup, regardless of the other parameters.
98 This variable is intended for use by making it local to a buffer.
103 "Non-nil means always use copying to create backup files.
104 See documentation of variable `make-backup-files'."
109 "Non-nil means use copying to create backups for files with multiple names.
110 This causes the alternate names to refer to the latest version as edited.
111 This variable is relevant only if `backup-by-copying' is nil."
116 "Non-nil means create backups by copying if this preserves owner or group.
117 Renaming may still be used (subject to control of other variables)
118 when it would not result in changing the owner or group of the file;
119 that is, for files which are owned by you and whose group matches
120 the default for a new file created there by you.
121 This variable is relevant only if `backup-by-copying' is nil."
126 "Non-nil means create backups by copying to preserve a privileged owner.
127 Renaming may still be used (subject to control of other variables)
128 when it would not result in changing the owner of the file or if the owner
129 has a user id greater than the value of this variable. This is useful
130 when low-numbered uid's are used for special system users (such as root)
131 that must maintain ownership of certain files.
132 This variable is relevant only if `backup-by-copying' and
133 `backup-by-copying-when-mismatch' are nil."
138 "Predicate that looks at a file name and decides whether to make backups.
142 "Non-nil in a buffer means always offer to save buffer on exit.
143 Do so even if the buffer is not visiting a file.
144 Automatically local in all buffers."
150 "Non-nil means find a file under alternative names, in existing buffers.
151 This means if any existing buffer is visiting the file you want
152 under another name, you get the existing buffer instead of a new buffer."
157 "*Non-nil means visit a file under its truename.
158 The truename of a file is found by chasing all links
159 both at the file level and at the levels of the containing directories."
165 "Specify which files should be reverted without query.
166 The value is a list of regular expressions.
167 If the file name matches one of these regular expressions,
168 then `revert-buffer' reverts the file without querying
169 if the file has changed on disk and you have not edited the buffer."
174 "The device number and file number of the file visited in the current buffer.
175 The value is a list of the form (FILENUM DEVNUM).
176 This pair of numbers uniquely identifies the file.
194 "The directory for writing temporary files."
200 "The directory for writing small temporary files.
201 If non-nil, this directory is used instead of `temporary-file-directory'
202 by programs that create small temporary files. This is for systems that
203 have fast storage with limited space, such as a RAM disk."
207 ;; The system null device. (Should reference NULL_DEVICE from C.)
232 "Non-nil means protect against I/O errors while saving files.
233 Some modes set this non-nil in particular buffers.
235 This feature works by writing the new contents into a temporary file
236 and then renaming the temporary file to replace the original.
237 In this way, any I/O error in writing leaves the original untouched,
238 and there is never any instant where the file is nonexistent.
240 Note that this feature forces backups to be made by copying.
241 Yet, at the same time, saving a precious file
242 breaks any hard links between it and other files."
247 "Control use of version numbers for backup files.
248 When t, make numeric backup versions unconditionally.
249 When nil, make them for files that have some already.
250 The value `never' means do not make them."
260 "When cleaning directory, number of versions to keep."
266 "If t, delete excess backup versions silently.
267 If nil, ask confirmation. Any other value prevents any trimming."
274 "Number of oldest versions to keep when a new numbered backup is made."
280 "Number of newest versions to keep when a new numbered backup is made.
281 Includes the new backup. Must be > 0"
287 "Whether to add a newline automatically at the end of the file.
289 A value of t means do this only when the file is about to be saved.
290 A value of `visit' means do this right after the file is visited.
291 A value of `visit-save' means do it at both of those times.
292 Any other non-nil value means ask user whether to add a newline, when saving.
293 A value of nil means don't add newlines.
295 Certain major modes set this locally to the value obtained
296 from `mode-require-final-newline'."
305 "Whether to add a newline at end of file, in certain major modes.
306 Those modes set `require-final-newline' to this value when you enable them.
307 They do so because they are often used for files that are supposed
308 to end in newlines, and the question is how to arrange that.
310 A value of t means do this only when the file is about to be saved.
311 A value of `visit' means do this right after the file is visited.
312 A value of `visit-save' means do it at both of those times.
313 Any other non-nil value means ask user whether to add a newline, when saving.
315 A value of nil means do not add newlines. That is a risky choice in this
316 variable since this value is used for modes for files that ought to have
317 final newlines. So if you set this to nil, you must explicitly check and
318 add a final newline, whenever you save a file that really needs one."
328 "Non-nil says by default do auto-saving of every file-visiting buffer."
333 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
334 Normally auto-save files are written under other names."
340 ;; Don't put "\\2" inside expand-file-name, since it will be
341 ;; transformed to "/2" on DOS/Windows.
343 "Transforms to apply to buffer file name before making auto-save file name.
344 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
345 REGEXP is a regular expression to match against the file name.
346 If it matches, `replace-match' is used to replace the
347 matching part with REPLACEMENT.
348 If the optional element UNIQUIFY is non-nil, the auto-save file name is
349 constructed by taking the directory part of the replaced file-name,
350 concatenated with the buffer file name with all directory separators
351 changed to `!' to prevent clashes. This will not work
352 correctly if your filesystem truncates the resulting name.
354 All the transforms in the list are tried, in the order they are listed.
355 When one transform applies, its result is final;
356 no further transforms are tried.
358 The default value is set up to put the auto-save file into the
359 temporary directory (see the variable `temporary-file-directory') for
360 editing a remote file.
362 On MS-DOS filesystems without long names this variable is always
363 ignored."
370 "Non-nil means save word abbrevs too when files are saved.
371 If `silently', don't ask the user before saving."
376 "Non-nil means allow `find-file' to visit directories.
377 To visit the directory, `find-file' runs `find-directory-functions'."
382 "List of functions to try in sequence to visit a directory.
383 Each function is called with the directory name as the sole argument
384 and should return either a buffer or nil."
388 ;;;It is not useful to make this a local variable.
389 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
391 "List of functions to be called for `find-file' on nonexistent file.
392 These functions are called as soon as the error is detected.
393 Variable `buffer-file-name' is already set up.
398 ;;;It is not useful to make this a local variable.
399 ;;;(put 'find-file-hooks 'permanent-local t)
402 "List of functions to be called after a buffer is loaded from a file.
403 The buffer's local variables (if any) will have been processed before the
404 functions are called."
411 "List of functions to be called before writing out a buffer to a file.
412 If one of them returns non-nil, the file is considered already written
413 and the rest are not called.
414 These hooks are considered to pertain to the visited file.
415 So any buffer-local binding of this variable is discarded if you change
417 change the major mode.
419 This hook is not run if any of the functions in
420 `write-contents-functions' returns non-nil. Both hooks pertain
421 to how to save a buffer to file, for instance, choosing a suitable
422 coding system and setting mode bits. (See Info
423 node `(elisp)Saving Buffers'.) To perform various checks or
434 "List of functions to be called before writing out a buffer to a file.
435 If one of them returns non-nil, the file is considered already written
436 and the rest are not called and neither are the functions in
437 `write-file-functions'.
439 This variable is meant to be used for hooks that pertain to the
440 buffer's contents, not to the particular visited file; thus,
441 `set-visited-file-name' does not clear this variable; but changing the
442 major mode does clear it.
444 For hooks that _do_ pertain to the particular visited file, use
445 `write-file-functions'. Both this variable and
446 `write-file-functions' relate to how a buffer is saved to file.
447 To perform various checks or updates before the buffer is saved,
454 "Control use of local variables in files you visit.
455 The value can be t, nil, :safe, :all, or something else.
457 A value of t means file local variables specifications are obeyed
458 if all the specified variable values are safe; if any values are
459 not safe, Emacs queries you, once, whether to set them all.
460 \(When you say yes to certain values, they are remembered as safe.)
462 :safe means set the safe variables, and ignore the rest.
463 :all means set all variables, whether safe or not.
464 (Don't set it permanently to :all.)
465 A value of nil means always ignore the file local variables.
467 Any other value means always query you once whether to set them all.
468 \(When you say yes to certain values, they are remembered as safe, but
471 This variable also controls use of major modes specified in
472 a -*- line.
475 always obeys file local variable specifications and the -*- line,
476 and ignores this variable."
485 "Like `enable-local-variables' but meant for buffer-local bindings.
486 The meaningful values are nil and non-nil. The default is non-nil.
487 If a major mode sets this to nil, buffer-locally, then any local
488 variables list in the file will be ignored.
490 This variable does not affect the use of major modes
495 The value can be t, nil or something else.
496 A value of t means obey `eval' variables;
497 A value of nil means ignore them; anything else means query."
503 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
512 "Non-nil means buffers visiting files read-only do so in view mode.
513 In fact, this means that all read-only buffers normally have
514 View mode enabled, including buffers that are read-only because
515 you visit a file you cannot alter, and buffers you make read-only
521 "History list of file names entered in the minibuffer.
523 Maximum length of the history list is determined by the value
525 \f
528 "Provides support for ange-ftp host name completion.
529 Runs the usual ange-ftp hook, but only for completion operations."
530 ;; Having this here avoids the need to load ange-ftp when it's not
531 ;; really in use.
537 inhibit-file-name-handlers)))
542 "Convert a standard file's name to something suitable for the OS.
543 This means to guarantee valid names and perhaps to canonicalize
544 certain patterns.
546 FILENAME should be an absolute file name since the conversion rules
547 sometimes vary depending on the position in the file name. E.g. c:/foo
548 is a valid DOS file name, but c:/bar/c:/foo is not.
550 This function's standard definition is trivial; it just returns
551 the argument. However, on Windows and DOS, replace invalid
552 characters. On DOS, make sure to obey the 8.3 limitations.
553 In the native Windows build, turn Cygwin names into native names,
554 and also turn slashes into backslashes if the shell requires it (see
555 `w32-shell-dos-semantics').
557 See Info node `(elisp)Standard File Names' for more details."
561 ;; Replace invalid filename characters with !
565 name)
566 filename))
569 "Read directory name, prompting with PROMPT and completing in directory DIR.
570 Value is not expanded---you must call `expand-file-name' yourself.
571 Default name to DEFAULT-DIRNAME if user exits with the same
572 non-empty string that was inserted by this function.
573 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
574 or just DIR if INITIAL is nil.)
575 If the user exits with an empty minibuffer, this function returns
576 an empty string. (This can only happen if the user erased the
577 pre-inserted contents or if `insert-default-directory' is nil.)
578 Fourth arg MUSTMATCH non-nil means require existing directory's name.
579 Non-nil and non-t means also require confirmation after completion.
580 Fifth arg INITIAL specifies text to start with.
581 DIR should be an absolute directory name. It defaults to
582 the value of `default-directory'."
587 dir))
588 mustmatch initial
591 \f
593 "Show the current default directory."
598 "Value of the CDPATH environment variable, as a list.
602 "Explode a search path into a list of directory names.
603 Directories are separated by occurrences of `path-separator'
604 \(which is colon in GNU and GNU-like systems)."
605 ;; We could use split-string here.
613 nil
618 cd-list)))
621 "Change current directory to given absolute file name DIR."
622 ;; Put the name into directory syntax now,
623 ;; because otherwise expand-file-name may give some bad results.
636 "Make DIR become the current buffer's default directory.
637 If your environment includes a `CDPATH' variable, try each one of
638 that list of directories (separated by occurrences of
639 `path-separator') when resolving a relative directory name.
640 The path separator is colon in GNU and GNU-like systems."
643 default-directory default-directory
659 cd-path)
660 nil))
664 "Load the Lisp file named FILE."
665 ;; This is a case where .elc makes a lot of sense.
672 "Search for FILENAME through PATH.
673 If found, return the absolute file name of FILENAME, with its suffixes;
674 otherwise return nil.
675 PATH should be a list of directories to look in, like the lists in
676 `exec-path' or `load-path'.
677 If SUFFIXES is non-nil, it should be a list of suffixes to append to
680 If non-nil, PREDICATE is used instead of `file-readable-p'.
681 PREDICATE can also be an integer to pass to the `access' system call,
682 in which case file-name handlers are ignored. This usage is deprecated.
684 For compatibility, PREDICATE can also be one of the symbols
685 `executable', `readable', `writable', or `exists', or a list of
686 one or more of those symbols."
697 "Do completion for file names passed to `locate-file'."
718 "Do completion for file names passed to `locate-file'.
719 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
722 string nil action))
726 "Look up the directory hierarchy from FILE for a file matching REGEXP."
728 ;; `user' is not initialized yet because `file' may not exist, so we may
729 ;; have to walk up part of the hierarchy before we find the "initial UID".
731 ;; Abbreviate, so as to stop when we cross ~/.
733 files)
735 ;; As a heuristic, we stop looking up the hierarchy of
736 ;; directories as soon as we find a directory belonging to
737 ;; another user. This should save us from looking in
738 ;; things like /net and /afs. This assumes that all the
739 ;; files inside a project belong to the same user.
750 nil)))
753 "Search for COMMAND in `exec-path' and return the absolute file name.
754 Return nil if COMMAND is not found anywhere in `exec-path'."
755 ;; Use 1 rather than file-executable-p to better match the behavior of
756 ;; call-process.
760 "Load the library named LIBRARY.
761 This is an interface to the function `load'."
765 load-path
770 "Test whether FILE specifies a location on a remote system.
771 Returns nil or a string identifying the remote connection (ideally
772 a prefix of FILE). For example, the remote identification for filename
775 less reliable than accessing local files.
776 Furthermore, relative file names do not work across remote connections.
778 IDENTIFICATION specifies which part of the identification shall
779 be returned as string. IDENTIFICATION can be the symbol
780 `method', `user' or `host'; any other value is handled like nil
781 and means to return the complete identification string.
783 If CONNECTED is non-nil, the function returns an identification only
784 if FILE is located on a remote system, and a connection is established
785 to that remote system.
787 `file-remote-p' will never open a connection on its own."
791 nil)))
794 "Copy the file FILE into a temporary file on this machine.
795 Returns the name of the local copy, or nil, if FILE is directly
796 accessible."
797 ;; This formerly had an optional BUFFER argument that wasn't used by
798 ;; anything.
802 nil)))
805 "Return the truename of FILENAME, which should be absolute.
806 The truename of a file name is found by chasing symbolic links
807 both at the level of the file and at the level of the directories
808 containing it, until no links are left at any level.
811 ;; COUNTER and PREV-DIRS are only used in recursive calls.
812 ;; COUNTER can be a cons cell whose car is the count of how many
813 ;; more links to chase before getting an error.
814 ;; PREV-DIRS can be a cons cell whose car is an alist
815 ;; of truenames we've just recently computed.
829 ;; For speed, remove the ange-ftp completion handler from the list.
830 ;; We know it's not needed here.
831 ;; For even more speed, do this only on the outermost call.
838 ;; andrewi@harlequin.co.uk - none of the following code (except for
839 ;; invoking the file-name handler) currently applies on Windows
840 ;; (ie. there are no native symlinks), but there is an issue with
841 ;; case differences being ignored by the OS, and short "8.3 DOS"
842 ;; name aliases existing for all files. (The short names are not
843 ;; reported by directory-files, but can be used to refer to files.)
844 ;; It seems appropriate for file-truename to resolve these issues in
845 ;; the most natural way, which on Windows is to call the function
846 ;; `w32-long-file-name' - this returns the exact name of a file as
847 ;; it is stored on disk (expanding short name aliases with the full
848 ;; name in the process).
851 ;; For file name that has a special handler, call handler.
852 ;; This is so that ange-ftp can save time by doing a no-op.
855 ;; If filename contains a wildcard, newname will be the old name.
857 ;; If filename exists, use the long name. If it doesn't exist,
858 ;; drill down until we find a directory that exists, and use
859 ;; the long name of that, with the extra non-existent path
860 ;; components concatenated.
862 missing rest)
865 ;; include the preceding directory separator in the missing
866 ;; part so subsequent recursion on the rest works.
872 ;; If this file directly leads to a link, process that iteratively
873 ;; so that we don't use lots of stack.
879 ;; For file name that has a special handler, call handler.
880 ;; This is so that ange-ftp can save time by doing a no-op.
883 done t)
885 target dirfile)
886 ;; Get the truename of the directory.
888 ;; If these are equal, we have the (or a) root directory.
890 ;; If this is the same dir we last got the truename for,
891 ;; save time--don't recalculate.
901 done t)
904 done t)
905 ;; Put it back on the file name.
907 ;; Is the file name the name of a link?
910 ;; Yes => chase that link, then start all over
911 ;; since the link may point to a directory name that uses links.
912 ;; We can't safely use expand-file-name here
913 ;; since target might look like foo/../bar where foo
914 ;; is itself a link. Instead, we handle . and .. above.
917 target
919 done nil)
920 ;; No, we are done!
922 filename))
925 "Chase links in FILENAME until a name that is not a link.
926 Unlike `file-truename', this does not check whether a parent
927 directory name is a symbolic link.
928 If the optional argument LIMIT is a number,
929 it means chase no more than that many links and then stop."
937 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
940 ;; Handle `..' by hand, since it needs to work in the
941 ;; target of any directory symlink.
942 ;; This code is not quite complete; it does not handle
943 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
947 ;; Chase links in the default dir of the symlink.
951 ;; Now find the parent of that dir.
955 newname))
958 "Create a temporary file.
959 The returned file name (created by appending some random characters at the end
960 of PREFIX, and expanding against `temporary-file-directory' if necessary),
961 is guaranteed to point to a newly created empty file.
962 You can then use `write-region' to write new data into the file.
964 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
966 If SUFFIX is non-nil, add that at the end of the file name."
968 file)
971 ;; Create temp files with strict access rights. It's easy to
972 ;; loosen them later, whereas it's impossible to close the
973 ;; time-window of loose permissions otherwise.
985 nil)
987 ;; the file was somehow created by someone else between
988 ;; `make-temp-name' and `write-region', let's try again.
989 nil)
990 file)
991 ;; Reset the umask.
995 "Change the encoding of FILE's name from CODING to NEW-CODING.
996 The value is a new name of FILE.
997 Signals a `file-already-exists' error if a file of the new name
998 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
999 is non-nil. A number as fourth arg means request confirmation if
1000 the new name already exists. This is what happens in interactive
1001 use with M-x."
1004 default-file-name-coding-system))
1006 from-coding to-coding)
1008 ;; We provide the default coding only when it seems that
1009 ;; the filename is correctly decoded by the default
1010 ;; coding.
1016 filename default-coding)
1017 default-coding))
1021 ;; We provide the default coding only when a user is going to
1022 ;; change the encoding not from the default coding.
1026 filename from-coding)))
1029 filename from-coding default-coding)
1030 default-coding)))
1034 default-file-name-coding-system))
1035 ;; FILE should have been decoded by DEFAULT-CODING.
1039 ;; Suppress further encoding.
1044 newname))
1045 \f
1047 "Read the name of a buffer to switch to and return as a string.
1048 It is intended for `switch-to-buffer' family of commands since they
1049 need to omit the name of current buffer from the list of completions
1050 and default values."
1057 "Select buffer BUFFER in another window.
1058 If BUFFER does not identify an existing buffer, then this function
1059 creates a buffer with that name.
1061 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1062 or nil. If BUFFER is nil, then this function chooses a buffer
1063 using `other-buffer'.
1064 Optional second arg NORECORD non-nil means
1065 do not put this buffer at the front of the list of recently selected ones.
1066 This function returns the buffer it switched to.
1068 This uses the function `display-buffer' as a subroutine; see its
1069 documentation for additional customization information."
1073 ;; Don't let these interfere.
1074 same-window-buffer-names same-window-regexps)
1078 "Switch to buffer BUFFER in another frame.
1079 Optional second arg NORECORD non-nil means
1080 do not put this buffer at the front of the list of recently selected ones.
1081 This function returns the buffer it switched to.
1083 This uses the function `display-buffer' as a subroutine; see its
1084 documentation for additional customization information."
1088 same-window-buffer-names same-window-regexps)
1094 "Switch to buffer BUFFER in another frame.
1095 This uses the function `display-buffer' as a subroutine; see its
1096 documentation for additional customization information."
1099 same-window-buffer-names same-window-regexps
1101 new-window)
1103 ;; This may have been here in order to prevent the new frame from hiding
1104 ;; the old frame. But it does more harm than good.
1105 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1106 ;;(lower-frame (window-frame new-window))
1108 ;; This may have been here in order to make sure the old-frame gets the
1109 ;; focus. But not only can it cause an annoying flicker, with some
1110 ;; window-managers it just makes the window invisible, with no easy
1111 ;; way to recover it. --Stef
1112 ;;(make-frame-invisible (window-frame old-window))
1113 ;;(make-frame-visible (window-frame old-window))
1114 ))
1120 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1121 BODY should use the minibuffer at most once.
1122 Recursive uses of the minibuffer will not be affected."
1128 ;; Clear out this hook so it does not interfere
1129 ;; with any recursive minibuffer usage.
1139 "If non-nil, `find-file' requires confirmation before visiting a new file."
1151 t))
1154 "Edit file FILENAME.
1155 Switch to a buffer visiting file FILENAME,
1156 creating one if none already exists.
1157 Interactively, the default if you just type RET is the current directory,
1158 but the visited file name is available through the minibuffer history:
1159 type M-n to pull it into the minibuffer.
1161 You can visit files on remote machines by specifying something
1162 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1163 also visit local files as a different user by specifying
1164 /sudo::FILE for the file name.
1165 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1166 manual, for more about this.
1168 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1169 expand wildcards (if any) and visit multiple files. You can
1170 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1172 To visit a file without any kind of conversion and without
1183 "Edit file FILENAME, in another window.
1186 an existing one. See the function `display-buffer'.
1188 Interactively, the default if you just type RET is the current directory,
1189 but the visited file name is available through the minibuffer history:
1190 type M-n to pull it into the minibuffer.
1192 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1193 expand wildcards (if any) and visit multiple files."
1206 "Edit file FILENAME, in another frame.
1209 an existing one. See the function `display-buffer'.
1211 Interactively, the default if you just type RET is the current directory,
1212 but the visited file name is available through the minibuffer history:
1213 type M-n to pull it into the minibuffer.
1215 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1216 expand wildcards (if any) and visit multiple files."
1229 "Edit the existing file FILENAME.
1231 file names with wildcards."
1239 "Edit file FILENAME but don't allow changes.
1253 value))
1256 "Edit file FILENAME in another window but don't allow changes.
1270 value))
1273 "Edit file FILENAME in another frame but don't allow changes.
1287 value))
1290 "Find file FILENAME as a replacement for the file in the next window.
1291 This command does not select that window.
1295 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1296 expand wildcards (if any) and replace the file with multiple files."
1308 t))))
1316 "Find file FILENAME, select its buffer, kill previous buffer.
1317 If the current buffer now contains an empty file that you just visited
1318 \(presumably by mistake), use this command to visit the file you really want.
1322 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1323 expand wildcards (if any) and replace the file with multiple files.
1325 If the current buffer is an indirect buffer, or the base buffer
1326 for one or more indirect buffers, the other buffer(s) are not
1327 killed."
1337 t)))
1358 ;; This prevents us from finding the same buffer
1359 ;; if we specified the same file again.
1363 ;; Likewise for dired buffers.
1367 ;; This executes if find-file gets an error
1368 ;; and does not really find anything.
1369 ;; We put things back as they were.
1370 ;; If find-file actually finds something, we kill obuf below.
1379 ;; We already asked; don't ask again.
1382 \f
1384 "Create a suitably named buffer for visiting FILENAME, and return it.
1385 FILENAME (sans directory) is used unchanged if that name is free;
1386 otherwise a string <2> or <3> or ... is appended to get an unused name.
1387 Spaces at the start of FILENAME (sans directory) are removed."
1396 "Create and return a buffer with a name based on NAME.
1397 Choose the buffer's name using `generate-new-buffer-name'."
1401 "Regexp to match the automounter prefix in a directory name."
1409 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1411 home directory is a root directory) and removes automounter prefixes
1412 \(see the variable `automount-dir-prefix')."
1413 ;; Get rid of the prefixes added by the automounter.
1420 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1421 ;; To fix this right, we need a `file-name-case-sensitive-p'
1422 ;; function, but we don't have that yet, so just guess.
1425 ;; If any elt of directory-abbrev-alist matches this name,
1426 ;; abbreviate accordingly.
1432 ;; Compute and save the abbreviated homedir name.
1433 ;; We defer computing this until the first time it's needed, to
1434 ;; give time for directory-abbrev-alist to be set properly.
1435 ;; We include a slash at the end, to avoid spurious matches
1436 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1443 ;; If FILENAME starts with the abbreviated homedir,
1444 ;; make it start with `~' instead.
1446 ;; If the home dir is just /, don't change it.
1449 ;; MS-DOS root directories can come with a drive letter;
1450 ;; Novell Netware allows drive letters beyond `Z:'.
1460 filename)))
1463 "List of logical names for which visiting shouldn't save the true dirname."
1468 "Return the buffer visiting file FILENAME (a string).
1469 This is like `get-file-buffer', except that it checks for any buffer
1470 visiting the same file, possibly under a different name.
1471 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1472 and others are ignored.
1473 If there is no such live buffer, return nil."
1487 found)
1497 ;; Verify this buffer's file number
1498 ;; still belongs to its file.
1501 attributes)
1505 found))))
1506 \f
1508 "Non-nil means file-visiting commands should handle wildcards.
1509 For example, if you specify `*.c', that would visit all the files
1510 whose names match the pattern."
1516 "Non-nil means suppress warning messages for symlinked files.
1517 When nil, Emacs prints a warning when visiting a file that is already
1518 visited, but with a different name. Setting this option to t
1519 suppresses this warning."
1525 "Maximum size of file above which a confirmation is requested.
1526 When nil, never request confirmation."
1533 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1534 OP-TYPE specifies the file operation being performed (for message to user)."
1544 "Read file FILENAME into a buffer and return the buffer.
1545 If a buffer exists visiting FILENAME, return that one, but
1546 verify that the file has not changed since visited or saved.
1547 The buffer is not selected, just returned to the caller.
1548 Optional second arg NOWARN non-nil means suppress any warning messages.
1549 Optional third arg RAWFILE non-nil means the file is read literally.
1550 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1551 and visit all the matching files. When wildcards are actually
1552 used and expanded, return a list of buffers that are visiting
1553 the various files."
1560 'find-directory-functions
1563 filename)))
1566 find-file-wildcards
1580 ;; Find any buffer for a file which has same truename.
1582 ;; Let user know if there is a buffer with the same truename.
1586 find-file-suppress-same-file-warnings
1590 ;; Optionally also find that buffer.
1593 ;; Check to see if the file looks uncommonly large.
1597 ;; We are using an existing buffer.
1604 ;; Certain files should be reverted automatically
1605 ;; if they have changed on disk and not in the buffer.
1613 found))
1623 "File %s changed on disk. Discard your edits? "
1628 "File %s changed on disk. Discard your edits in %s? "
1636 ;; Check if a formerly read-only file has become
1637 ;; writable and vice versa, but if the buffer agrees
1638 ;; with the new state of the file, that is ok too.
1646 buffer-file-name
1655 ;; It is confusing to ask whether to visit
1656 ;; non-literally if they have the file in
1657 ;; hexl-mode.
1663 "The file %s is already visited normally,
1664 and you have edited the buffer. Now you have asked to visit it literally,
1665 meaning no coding system handling, format conversion, or local variables.
1666 Emacs can only visit a file in one way at a time.
1668 Do you want to save the file, and visit it literally instead? "
1669 "The file %s is already visited literally,
1670 meaning no coding system handling, format conversion, or local variables.
1671 You have edited the buffer. Now you have asked to visit the file normally,
1672 but Emacs can only visit a file in one way at a time.
1679 rawfile truename number))
1683 "\
1684 Do you want to discard your changes, and visit the file literally now? "
1685 "\
1688 rawfile truename number)
1694 "The file %s is already visited normally.
1695 You have asked to visit it literally,
1696 meaning no coding system decoding, format conversion, or local variables.
1697 But Emacs can only visit a file in one way at a time.
1699 Do you want to revisit the file literally now? "
1700 "The file %s is already visited literally,
1701 meaning no coding system decoding, format conversion, or local variables.
1702 You have asked to visit it normally,
1703 but Emacs can only visit a file in one way at a time.
1708 rawfile truename number)
1711 ;; Return the buffer we are using.
1712 buf)
1713 ;; Create a new buffer.
1715 ;; find-file-noselect-1 may use a different buffer.
1717 rawfile truename number))))))
1723 ;; Needed in case we are re-visiting the file with a different
1724 ;; text representation.
1741 filename)))
1742 ;; Unconditionally set error
1752 filename)))
1753 ;; Run find-file-not-found-functions until one returns non-nil.
1755 ;; If they fail too, set error.
1757 ;; Record the file's truename, and maybe use that as visited name.
1765 ;; Set buffer's default directory to that of the file.
1767 ;; Turn off backup files for certain file names. Since
1768 ;; this is a permanent local, the major mode won't eliminate it.
1783 \f
1785 "Like `insert-file-contents', but only reads in the file literally.
1786 A buffer may be modified in several ways after reading into the buffer,
1787 to Emacs features such as format decoding, character code
1788 conversion, `find-file-hook', automatic uncompression, etc.
1790 This function ensures that none of these modifications will take place."
1798 nil))
1801 inhibit-file-name-handlers))
1814 filename)))
1815 ;; Check whether the file is uncommonly large
1826 "Insert contents of file FILENAME into buffer after point with no conversion.
1828 This function is meant for the user to run interactively.
1829 Don't call it from programs! Use `insert-file-contents-literally' instead.
1830 \(Its calling sequence is different; see its documentation)."
1835 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1840 "Visit file FILENAME with no conversion of any kind.
1841 Format conversion and character code conversion are both disabled,
1842 and multibyte characters are disabled in the resulting buffer.
1843 The major mode used is Fundamental mode regardless of the file name,
1844 and local variable specifications in the file are ignored.
1845 Automatic uncompression and adding a newline at the end of the
1846 file due to `require-final-newline' is also disabled.
1848 You cannot absolutely rely on this function to result in
1849 visiting the file literally. If Emacs already has a buffer
1850 which is visiting the file, you get the existing buffer,
1851 regardless of whether it was created literally or not.
1853 In a Lisp program, if you want to be sure of accessing a file's
1854 contents literally, you should create a temporary buffer and then read
1855 the file contents into it using `insert-file-contents-literally'."
1858 \f
1862 after-find-file-from-revert-buffer
1863 nomodes)
1864 "Called after finding a file and by the default revert function.
1865 Sets buffer mode, parses local variables.
1866 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1867 error in reading the file. WARN non-nil means warn if there
1868 exists an auto-save file more recent than the visited file.
1869 NOAUTO means don't mess with auto-save mode.
1870 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1871 means this call was from `revert-buffer'.
1872 Fifth arg NOMODES non-nil means don't alter the file's modes.
1873 Finishes by calling the functions in `find-file-hook'
1874 unless NOMODES is non-nil."
1877 nil
1887 ;; No need to warn if buffer is auto-saved
1888 ;; under the name of the visited file.
1890 auto-save-visited-file-name))
1893 buffer-file-name))
1913 ;; Make people do a little extra work (C-x C-q)
1914 ;; before altering a backup file.
1917 ;; When a file is marked read-only,
1918 ;; make the buffer read-only even if root is looking at it.
1926 ;; If requested, add a newline at the end of the file.
1936 view-read-only
1942 "Eval BODY and turn any error into a FORMAT message.
1943 FORMAT can have a %s escape which will be replaced with the actual error.
1944 If `debug-on-error' is set, errors are not caught, so that you can
1945 debug them.
1946 Avoid using a large BODY since it is duplicated."
1955 "Choose the major mode for this buffer automatically.
1956 Also sets up any specified local variables of the file.
1957 Uses the visited file name, the -*- line, and the local variables spec.
1959 This function is called automatically from `find-file'. In that case,
1960 we may set up the file-specified mode and local variables,
1961 depending on the value of `enable-local-variables'.
1962 In addition, if `local-enable-local-variables' is nil, we do
1963 not set local variables (though we do notice a mode specified with -*-.)
1965 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1966 or from Lisp without specifying the optional argument FIND-FILE;
1967 in that case, this function acts as if `enable-local-variables' were t."
1975 ;; Turn font lock off and on, to make sure it takes account of
1976 ;; whatever file local variables are relevant to it.
1978 ;; Font-lock-mode (now in font-core.el) can be ON when
1979 ;; font-lock.el still hasn't been loaded.
1989 "Non-nil means to try second pass through `auto-mode-alist'.
1990 This means that if the first case-sensitive search through the alist fails
1991 to find a matching major mode, a second case-insensitive search is made.
1992 On systems with case-insensitive file names, this variable is ignored,
1993 since only a single case-insensitive search through the alist is made."
1999 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2000 ;; c++-mode, java-mode and more) are added through autoload
2001 ;; directives in that file. That way is discouraged since it
2002 ;; spreads out the definition of the initial value.
2035 ;; Less common extensions come here
2036 ;; so more common ones above are found faster.
2075 ;; The list of archive file extensions should be in sync with
2076 ;; `auto-coding-alist' with `no-conversion' coding system.
2082 ;; Mailer puts message to be edited in
2083 ;; /tmp/Re.... or Message
2087 ;; some news reader is reported to use this
2096 ;; .emacs or .gnus or .viper following a directory delimiter in
2097 ;; Unix, MSDOG or VMS syntax.
2100 ;; _emacs following a directory delimiter
2101 ;; in MsDos syntax
2105 ;; Common Lisp ASDF package system.
2123 ;; Windows candidates may be opened case sensitively on Unix
2129 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2131 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2132 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2133 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2134 ;; this has lower priority to avoid matching changelog.sgml etc.
2136 ;; either user's dot-files or under /etc or some such
2138 ;; alas not all ~/.*rc files are like this
2139 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2144 ;; this contains everything twice, with space and with colon :-(
2146 ;; Get rid of any trailing .n.m and try again.
2147 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2148 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2149 ;; Using mode nil rather than `ignore' would let the search continue
2150 ;; through this list (with the shortened name) rather than start over.
2152 ;; The following should come after the ChangeLog pattern
2153 ;; for the sake of ChangeLog.1, etc.
2154 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2157 "Alist of filename patterns vs corresponding major mode functions.
2158 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2159 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2160 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2161 mode function to use. FUNCTION will be called, unless it is nil.
2163 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2164 calling FUNCTION (if it's not nil), we delete the suffix that matched
2165 REGEXP and search the list again for another match.
2167 If the file name matches `inhibit-first-line-modes-regexps',
2168 then `auto-mode-alist' is not processed.
2170 The extensions whose FUNCTION is `archive-mode' should also
2171 appear in `auto-coding-alist' with `no-conversion' coding system.
2173 See also `interpreter-mode-alist', which detects executable script modes
2174 based on the interpreters they specify to run,
2178 "Select Conf mode or XML mode according to start of file."
2188 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2189 ;; and pike-mode) are added through autoload directives in that
2190 ;; file. That way is discouraged since it spreads out the
2191 ;; definition of the initial value.
2229 "Alist mapping interpreter names to major modes.
2230 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2231 Each element looks like (INTERPRETER . MODE).
2232 If INTERPRETER matches the name of the interpreter specified in the first line
2233 of a script, mode MODE is enabled.
2241 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2242 When checking `inhibit-first-line-modes-regexps', we first discard
2248 "Regexp matching interpreters, for file mode determination.
2249 This regular expression is matched against the first line of a file
2250 to determine the file's mode in `set-auto-mode'. If it matches, the file
2251 is assumed to be interpreted by the interpreter matched by the second group
2252 of the regular expression. The mode is then determined as the mode
2256 "Alist of buffer beginnings vs. corresponding major mode functions.
2257 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2258 After visiting a file, if REGEXP matches the text at the beginning of the
2259 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2260 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2261 major mode.
2263 If FUNCTION is nil, then it is not called. (That is a way of saying
2269 ;; The < comes before the groups (but the first) to reduce backtracking.
2270 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2271 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2275 comment-re "*"
2278 . html-mode)
2280 ;; These two must come after html, because they are more general:
2285 . sgml-mode)
2288 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2289 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2290 After visiting a file, if REGEXP matches the text at the beginning of the
2291 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2292 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2293 have not specified a mode for this file.
2299 "Upper limit on `magic-mode-alist' regexp matches.
2303 "Select major mode appropriate for current buffer.
2305 To find the right major mode, this function checks for a -*- mode tag,
2306 checks if it uses an interpreter listed in `interpreter-mode-alist',
2307 matches the buffer beginning against `magic-mode-alist',
2308 compares the filename against the entries in `auto-mode-alist',
2309 then matches the buffer beginning against `magic-fallback-mode-alist'.
2311 It does not check for the `mode:' local variable in the
2312 Local Variables section of the file; for that, use `hack-local-variables'.
2314 If `enable-local-variables' is nil, this function does not check for a
2315 -*- mode tag.
2317 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2318 set the major mode only if that would change it. In other words
2319 we don't actually set it to the same mode the buffer already has."
2320 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2322 ;; Find a -*- mode tag
2329 ;; Find all specifications for the `mode:' variable
2330 ;; and execute them left to right.
2342 modes)))
2343 ;; Simple -*-MODE-*- case.
2346 modes))))
2347 ;; If we found modes to use, invoke them now, outside the save-excursion.
2355 ;; continuing would call minor modes again, toggling them off
2357 ;; If we didn't, look for an interpreter specified in the first line.
2358 ;; As a special case, allow for things like "#!/bin/env perl", which
2359 ;; finds the interpreter anywhere in $PATH.
2366 ;; Map interpreter name to a mode, signalling we're done at the
2367 ;; same time.
2369 interpreter-mode-alist))
2370 ;; If we found an interpreter mode to use, invoke it now.
2373 ;; Next try matching the buffer beginning against magic-mode-alist.
2387 ;; Next compare the filename against the entries in auto-mode-alist.
2392 ;; Remove remote file name identification.
2396 ;; Remove backup-suffixes from file name.
2399 ;; Find first matching alist entry.
2402 ;; System is case-insensitive.
2406 ;; System is case-sensitive.
2408 ;; First match case-sensitively.
2412 ;; Fallback to case-insensitive match.
2426 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2441 ;; When `keep-mode-if-same' is set, we are working on behalf of
2442 ;; set-visited-file-name. In that case, if the major mode specified is the
2443 ;; same one we already have, don't actually reset it. We don't want to lose
2444 ;; minor modes such as Font Lock.
2446 "Apply MODE and return it.
2447 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2448 any aliases and compared to current major mode. If they are the
2449 same, do nothing and return nil."
2455 mode)))
2458 "Find the -*- spec in the buffer.
2459 Call with point at the place to start searching from.
2460 If one is found, set point to the beginning
2461 and return the position of the end.
2462 Otherwise, return nil; point may be changed."
2465 ;; Don't look for -*- if this file name matches any
2466 ;; of the regexps in inhibit-first-line-modes-regexps.
2474 sufs)
2482 ;; If the file begins with "#!"
2483 ;; (exec interpreter magic), look
2484 ;; for mode frobs in the first two
2485 ;; lines. You cannot necessarily
2486 ;; put them in the first line of
2487 ;; such a file without screwing up
2488 ;; the interpreter invocation.
2489 ;; The same holds for
2490 ;; '\"
2491 ;; in man pages (preprocessor
2492 ;; magic for the `man' program).
2503 end))))
2504 \f
2505 ;;; Handling file local variables
2509 file-local-variables-alist)
2513 "Normal hook run after processing a file's local variables specs.
2514 Major modes can use this to examine user-specified local variables
2518 "List variable-value pairs that are considered safe.
2519 Each element is a cons cell (VAR . VAL), where VAR is a variable
2520 symbol and VAL is a value that is considered safe."
2525 "Expressions that are considered safe in an `eval:' local variable.
2526 Add expressions to this list if you want Emacs to evaluate them, when
2527 they appear in an `eval' local variable specification, without first
2528 asking you for confirmation."
2533 ;; Risky local variables:
2536 auto-mode-alist
2537 buffer-auto-save-file-name
2538 buffer-file-name
2539 buffer-file-truename
2540 buffer-undo-list
2541 dabbrev-case-fold-search
2542 dabbrev-case-replace
2543 debugger
2544 default-text-properties
2545 display-time-string
2546 enable-local-eval
2547 enable-local-variables
2548 eval
2549 exec-directory
2550 exec-path
2551 file-name-handler-alist
2552 font-lock-defaults
2553 format-alist
2554 frame-title-format
2555 global-mode-string
2556 header-line-format
2557 icon-title-format
2558 ignored-local-variables
2559 imenu--index-alist
2560 imenu-generic-expression
2561 inhibit-quit
2562 input-method-alist
2563 load-path
2564 max-lisp-eval-depth
2565 max-specpdl-size
2566 minor-mode-alist
2567 minor-mode-map-alist
2568 minor-mode-overriding-map-alist
2569 mode-line-buffer-identification
2570 mode-line-format
2571 mode-line-client
2572 mode-line-modes
2573 mode-line-modified
2574 mode-line-mule-info
2575 mode-line-position
2576 mode-line-process
2577 mode-line-remote
2578 mode-name
2579 outline-level
2580 overriding-local-map
2581 overriding-terminal-local-map
2582 parse-time-rules
2583 process-environment
2584 rmail-output-file-alist
2585 safe-local-variable-values
2586 safe-local-eval-forms
2587 save-some-buffers-action-alist
2588 special-display-buffer-names
2589 standard-input
2590 standard-output
2591 unread-command-events
2592 vc-mode))
2594 ;; Safe local variables:
2595 ;;
2596 ;; For variables defined by major modes, the safety declarations can go into
2597 ;; the major mode's file, since that will be loaded before file variables are
2598 ;; processed.
2599 ;;
2600 ;; For variables defined by minor modes, put the safety declarations in the
2601 ;; file defining the minor mode after the defcustom/defvar using an autoload
2602 ;; cookie, e.g.:
2603 ;;
2604 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2605 ;;
2606 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2607 ;; minor mode file may not be loaded yet.
2608 ;;
2609 ;; For variables defined in the C source code the declaration should go here:
2625 "Alist of file-local variable settings in the current buffer.
2626 Each element in this list has the form (VAR . VALUE), where VAR
2627 is a file-local variable (a symbol) and VALUE is the value
2628 specified. The actual value in the buffer may differ from VALUE,
2633 "Normal hook run before setting file-local variables.
2634 It is called after checking for unsafe/risky variables and
2635 setting `file-local-variables-alist', and before applying the
2636 variables stored in `file-local-variables-alist'. A hook
2637 function is allowed to change the contents of this alist.
2639 This hook is called only if there is at least one file-local
2643 "Get confirmation before setting up local variable values.
2644 ALL-VARS is the list of all variables to be set up.
2645 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2646 RISKY-VARS is the list of those that are marked as risky.
2647 PROJECT is a directory name if these settings come from directory-local
2648 settings, or nil otherwise."
2650 nil
2655 prompt char)
2665 ", and variables that are risky (**)."
2673 y -- to apply the local variables list.
2677 ! -- to apply the local variables list, and permanently mark these
2689 ;; Make strings with embedded whitespace easier to read.
2697 ""
2704 done)
2713 ;; read-event returns -1 if we are in a kbd
2714 ;; macro and there are no more events in the
2715 ;; macro. In that case, attempt to get an
2716 ;; event interactively.
2724 ;; When this is called from desktop-restore-file-buffer,
2725 ;; coding-system-for-read may be non-nil. Reset it before
2726 ;; writing to .emacs.
2730 'safe-local-variable-values
2731 safe-local-variable-values))))
2738 "Return local variables specified in the -*- line.
2739 Ignore any specification for `mode:' and `coding:';
2740 `set-auto-mode' should already have handled `mode:',
2741 `set-auto-coding' should already have handled `coding:'.
2743 If MODE-ONLY is non-nil, all we do is check whether the major
2744 mode is specified, returning t if it is specified. Otherwise,
2745 return an alist of elements (VAR . VAL), where VAR is a variable
2746 and VAL is the specified value."
2750 result mode-specified)
2751 ;; Parse the -*- line into the RESULT alist.
2752 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2754 nil)
2756 ;; Simple form: "-*- MODENAME -*-". Already handled.
2758 nil)
2760 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2761 ;; (last ";" is optional).
2766 ;; There used to be a downcase here,
2767 ;; but the manual didn't say so,
2768 ;; and people want to set var names that aren't all lc.
2773 ;; It is traditional to ignore
2774 ;; case when checking for `mode' in set-auto-mode,
2775 ;; so we must do that here as well.
2776 ;; That is inconsistent, but we're stuck with it.
2777 ;; The same can be said for `coding' in set-auto-coding.
2783 'eval
2790 mode-specified
2791 result))))
2794 "Filter local variable settings, querying the user if necessary.
2795 VARIABLES is the alist of variable-value settings. This alist is
2796 filtered based on the values of `ignored-local-variables',
2797 `enable-local-eval', `enable-local-variables', and (if necessary)
2798 user interaction. The results are added to
2799 `file-local-variables-alist', without applying them.
2800 PROJECT is a directory name if these settings come from
2801 directory-local settings, or nil otherwise."
2802 ;; Strip any variables that are in `ignored-local-variables'.
2805 ;; If `enable-local-eval' is nil, strip eval "variables".
2810 ;; Find those variables that we may want to save to
2811 ;; `safe-local-variable-values'.
2816 ;; Don't query about the fake variables.
2827 ;; If caller wants only safe variables, store only these.
2832 ;; Query, unless all are known safe or the user wants no
2833 ;; querying.
2839 variables unsafe-vars risky-vars project))
2844 "Parse and put into effect this buffer's local variables spec.
2845 If MODE-ONLY is non-nil, all we do is check whether the major mode
2846 is specified, returning t if it is specified."
2849 result)
2856 ;; Look for "Local variables:" line in last page.
2864 ;; suffix is what comes after "local variables:" in its line.
2865 ;; prefix is what comes before "local variables:" in its line.
2875 beg)
2879 endpos
2885 nil t))
2886 ;; This used to be an error, but really all it means is
2887 ;; that this may simply not be a local-variables section,
2888 ;; so just ignore it.
2898 ;; Discard the prefix.
2903 ;; Discard the suffix.
2911 ;; Find the variable name; strip whitespace.
2919 val)
2920 ;; Read the variable value.
2930 'eval
2935 ;; Now we've read all the local variables.
2936 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
2938 ;; Otherwise, set the variables.
2950 "Non-nil if SYM is safe as a file-local variable with value VAL.
2951 It is safe if any of these conditions are met:
2953 * There is a matching entry (SYM . VAL) in the
2954 `safe-local-variable-values' user option.
2956 * The `safe-local-variable' property of SYM is a function that
2957 evaluates to a non-nil value with VAL as an argument."
2963 "Non-nil if SYM could be dangerous as a file-local variable.
2964 It is dangerous if either of these conditions are met:
2966 * Its `risky-local-variable' property is non-nil.
2972 ;; If this is an alias, check the base name.
2992 "Return t if it is safe to eval EXP when it is found in a file."
2994 ;; Detect certain `put' expressions.
3000 ;; Only allow safe values of lisp-indent-hook;
3001 ;; not functions.
3004 ;; Only allow indirect form specs.
3005 ;; During bootstrapping, edebug-basic-spec might not be
3006 ;; defined yet.
3010 ;; Allow expressions that the user requested.
3012 ;; Certain functions can be allowed with safe arguments
3013 ;; or can specify verification functions to try.
3021 ok))
3029 ok)))))))
3032 "Set local variable VAR with value VAL.
3033 If VAR is `mode', call `VAL-mode' as a function unless it's
3034 already the major mode."
3044 ;; Make sure the string has no text properties.
3045 ;; Some text properties can get evaluated in various ways,
3046 ;; so it is risky to put them on with a local variable list.
3050 \f
3051 ;;; Handling directory local variables, aka project settings.
3060 "Return the project variable list for project CLASS."
3064 "Collect local variable settings from MODE-ALIST.
3065 SETTINGS is the initial list of bindings.
3066 Returns the new list."
3073 ;; Need a new cons in case we setcdr later.
3077 "Collect entries from BINDING-LIST into SETTINGS.
3078 ROOT is the root directory of the project.
3079 Return the new settings list."
3087 ;; Don't include this in the previous condition, because we
3088 ;; want to filter all strings before the next condition.
3093 root settings))))
3097 settings))))))))
3100 "Declare that the project rooted at DIRECTORY is an instance of CLASS.
3101 DIRECTORY is the name of a directory, a string.
3102 CLASS is the name of a project class, a symbol.
3104 When a file beneath DIRECTORY is visited, the mode-specific
3105 settings from CLASS will be applied to the buffer. The settings
3106 for a class are defined using `define-project-bindings'."
3113 "Map the project type CLASS to a list of variable settings.
3114 CLASS is the project class, a symbol.
3115 LIST is a list that declares variable settings for the class.
3116 An element in LIST is either of the form:
3117 (MAJOR-MODE . ALIST)
3118 or
3119 (DIRECTORY . LIST)
3121 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3122 whose elements are of the form (VARIABLE . VALUE).
3124 In the second form, DIRECTORY is a directory name (a string), and
3125 LIST is a list of the form accepted by the function.
3127 When a file is visited, the file's class is found. A directory
3128 may be assigned a class using `set-directory-project'. Then
3129 variables are set in the file's buffer according to the class'
3130 LIST. The list is processed in order.
3132 * If the element is of the form (MAJOR-MODE . ALIST), and the
3133 buffer's major mode is derived from MAJOR-MODE (as determined
3134 by `derived-mode-p'), then all the settings in ALIST are
3135 applied. A MAJOR-MODE of nil may be used to match any buffer.
3136 `make-local-variable' is called for each variable before it is
3137 set.
3139 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3140 is an initial substring of the file's directory, then LIST is
3141 applied by recursively following these rules."
3148 "Find the settings file for FILE.
3149 This searches upward in the directory tree.
3150 If a settings file is found, the file name is returned.
3151 If the file is in a registered project, a cons from
3152 `project-directory-alist' is returned.
3153 Otherwise this returns nil."
3157 ;; `locate-dominating-file' may have abbreviated the name.
3167 settings pda)
3171 "Load a settings file and register a new project class and instance.
3172 SETTINGS-FILE is the name of the file holding the settings to apply.
3173 The new class name is the same as the directory in which SETTINGS-FILE
3174 is found. Returns the new class name."
3176 ;; We should probably store the modtime of SETTINGS-FILE and then
3177 ;; reload it whenever it changes.
3184 class-name)))
3189 "Read local variables for the current buffer based on project settings.
3190 Store the project variables in `file-local-variables-alist',
3191 without applying them."
3195 ;; Find the settings file.
3209 root-dir nil)))
3213 \f
3216 However, the mode will not be changed if
3217 \(1) a local variables list or the `-*-' line specifies a major mode, or
3219 \ not suitable for ordinary files, or
3220 \(3) the new file name does not particularly specify any mode."
3225 "Change name of file visited in current buffer to FILENAME.
3226 This also renames the buffer to correspond to the new file.
3227 The next time the buffer is saved it will go in the newly specified file.
3228 FILENAME nil or an empty string means mark buffer as not visiting any file.
3229 Remember to delete the initial contents of the minibuffer
3230 if you wish to pass an empty string as the argument.
3232 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3233 confirmation in the case where another buffer is already visiting FILENAME.
3235 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3236 the old visited file has been renamed to the new name FILENAME."
3244 nil
3259 filename)))
3269 ;; If new-name == old-name, renaming would add a spurious <2>
3270 ;; and it's considered as a feature in rename-buffer.
3276 ;; Abbreviate the file names of the buffer.
3285 nil)))
3286 ;; write-file-functions is normally used for things like ftp-find-file
3287 ;; that visit things that are not local files as if they were files.
3288 ;; Changing to visit an ordinary local file instead should flush the hook.
3293 ;; If buffer was read-only because of version control,
3294 ;; that reason is gone now, so make it writable.
3298 ;; Turn off backup files for certain file names.
3299 ;; Since this is a permanent local, the major mode won't eliminate it.
3301 backup-enable-predicate
3307 ;; If auto-save was not already on, turn it on if appropriate.
3311 ;; If auto save is on, start using a new name.
3312 ;; We deliberately don't rename or delete the old auto save
3313 ;; for the old visited file name. This is because perhaps
3314 ;; the user wants to save the new state and then compare with the
3315 ;; previous state from the auto save file.
3318 ;; Rename the old auto save file if any.
3325 ;; Update the major mode, if the file name determines it.
3327 ;; Don't change the mode if it is special.
3330 ;; Don't change the mode if the local variable list specifies it.
3336 "Write current buffer into file FILENAME.
3337 This makes the buffer visit that file, and marks it as not modified.
3339 If you specify just a directory name as FILENAME, that means to use
3340 the default file name but in that directory. You can also yank
3341 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3343 If the buffer is not already visiting a file, the default file name
3344 for the output file is the buffer name.
3346 If optional second arg CONFIRM is non-nil, this function
3347 asks for confirmation before overwriting an existing file.
3348 Interactively, confirmation is required unless you supply a prefix argument."
3349 ;; (interactive "FWrite file: ")
3353 nil nil nil nil)
3357 default-directory)
3358 nil nil))
3362 ;; If arg is just a directory,
3363 ;; use the default file name, but in that directory.
3374 ;; Make buffer writable if file is writable.
3379 ;; It's likely that the VC status at the new location is different from
3380 ;; the one at the old location.
3382 \f
3384 "Make a backup of the disk file visited by the current buffer, if appropriate.
3385 This is normally done before saving the buffer the first time.
3387 A backup may be done by renaming or by copying; see documentation of
3388 variable `make-backup-files'. If it's done by renaming, then the file is
3389 no longer accessible under its old name.
3391 The value is non-nil after a backup was made by renaming.
3392 It has the form (MODES . BACKUPNAME).
3393 MODES is the result of `file-modes' on the original
3394 file; this means that the caller, after saving the buffer, should change
3395 the modes of the new file to agree with the old modes.
3396 BACKUPNAME is the backup file name, which is the old file renamed."
3403 backup-info backupname targets setmodes)
3404 ;; If specified name is a symbolic link, chase it to the target.
3405 ;; Thus we make the backups in the directory where the real file is.
3410 ;; (if (file-directory-p buffer-file-name)
3411 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3415 ;; If have old versions to maybe delete,
3416 ;; ask the user to confirm now, before doing anything.
3417 ;; But don't actually delete til later.
3422 real-file-name)))))
3424 ;; Actually write the back up file.
3427 ; (file-symlink-p buffer-file-name)
3428 backup-by-copying
3429 ;; Don't rename a suid or sgid file.
3444 ;; rename-file should delete old backup.
3448 ;; If trouble writing the backup, write it in ~.
3453 backupname)
3457 ;; Now delete the old versions, if desired.
3464 setmodes)
3471 ;; Create temp files with strict access rights. It's easy to
3472 ;; loosen them later, whereas it's impossible to close the
3473 ;; time-window of loose permissions otherwise.
3476 ;; Try to overwrite old backup first.
3484 nil)
3486 ;; The file was somehow created by someone else between
3487 ;; `delete-file' and `copy-file', so let's try again.
3488 ;; rms says "I think there is also a possible race
3489 ;; condition for making backup files" (emacs-devel 20070821).
3490 nil)))
3491 ;; Reset the umask.
3497 "Return file NAME sans backup versions or strings.
3498 This is a separate procedure so your site-init or startup file can
3499 redefine it.
3500 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3501 we do not remove backup version numbers, only true file version numbers."
3513 "Return t if deleting FILE and rewriting it would preserve the owner."
3518 ;; Return t if the file doesn't exist, since it's true that no
3519 ;; information would be lost by an (attempted) delete and create.
3525 The extension, in a file name, is the part that follows the last `.',
3526 except that a leading `.', if any, doesn't count."
3529 directory)
3533 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3534 ;; we don't want to expand it.
3537 filename))))
3541 The extension, in a file name, is the part that follows the last `.',
3542 excluding version numbers and backup suffixes,
3543 except that a leading `.', if any, doesn't count.
3544 Return nil for extensionless file names such as `foo'.
3545 Return the empty string for file names such as `foo.'.
3547 If PERIOD is non-nil, then the returned value includes the period
3548 that delimits the extension, and if FILENAME has no extension,
3559 "A function to use instead of the default `make-backup-file-name'.
3560 A value of nil gives the default `make-backup-file-name' behavior.
3562 This could be buffer-local to do something special for specific
3563 files. If you define it, you may need to change `backup-file-name-p'
3564 and `file-name-sans-versions' too.
3566 See also `backup-directory-alist'."
3572 "Alist of filename patterns and backup directory names.
3573 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3574 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3575 relative or absolute. If it is absolute, so that all matching files
3576 are backed up into the same directory, the file names in this
3577 directory will be the full name of the file backed up with all
3578 directory separators changed to `!' to prevent clashes. This will not
3579 work correctly if your filesystem truncates the resulting name.
3581 For the common case of all backups going into one directory, the alist
3583 directory name.
3585 If this variable is nil, or it fails to match a filename, the backup
3586 is made in the original file's directory.
3588 On MS-DOS filesystems without long names this variable is always
3589 ignored."
3595 "Default `backup-enable-predicate' function.
3596 Checks for files in `temporary-file-directory',
3597 `small-temporary-file-directory', and /tmp."
3600 ;; Directory is under temporary-file-directory.
3605 ;; Directory is under /tmp.
3610 0 nil
3612 ;; Directory is under small-temporary-file-directory.
3617 "Create the non-numeric backup file name for FILE.
3618 Normally this will just be the file's name with `~' appended.
3619 Customization hooks are provided as follows.
3621 If the variable `make-backup-file-name-function' is non-nil, its value
3622 should be a function which will be called with FILE as its argument;
3623 the resulting name is used.
3625 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3626 the documentation of that variable. If the directory for the backup
3627 doesn't exist, it is created."
3641 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3643 elt backup-directory abs-backup-directory)
3648 alist nil)))
3649 ;; If backup-directory is relative, it should be relative to the
3650 ;; file's directory. By expanding explicitly here, we avoid
3651 ;; depending on default-directory.
3660 abs-backup-directory nil))))
3662 file
3666 ;; Normalize DOSish file names: downcase the drive
3667 ;; letter, if any, and replace the leading "x:" with
3668 ;; "/drive_x".
3671 ;; Replace any invalid file-name characters (for the
3672 ;; case of backing up remote files).
3676 "drive_"
3679 ""
3682 ;; Make the name unique by substituting directory
3683 ;; separators. It may not really be worth bothering about
3684 ;; doubling `!'s in the original name...
3689 backup-directory))
3694 "Return non-nil if FILE is a backup file name (numeric or not).
3695 This is a separate function so you can redefine it for customization.
3696 You may need to redefine `file-name-sans-versions' as well."
3701 ;; This is used in various files.
3702 ;; The usage of backup-extract-version-start is not very clean,
3703 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3705 "Given the name of a numeric backup file, FN, return the backup number.
3706 Uses the free variable `backup-extract-version-start', whose value should be
3707 the index in the name where the version number begins."
3714 "Find a file name for a backup file FN, and suggestions for deletions.
3715 Value is a list whose car is the name for the backup file
3716 and whose cdr is a list of old versions to consider deleting now.
3717 If the value is nil, don't make a backup.
3718 Uses `backup-directory-alist' in the same way as does
3719 `make-backup-file-name'."
3721 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3725 ;; We don't support numbered backups on plain MS-DOS
3726 ;; when long file names are unavailable.
3736 possibilities deserve-versions-p versions)
3739 base-versions
3742 possibilities)
3743 #'<)
3748 kept-old-versions
3749 kept-new-versions
3756 ;; Delete nothing if there is overflow
3757 ;; in the number of versions to keep.
3763 v))))))))))
3766 "Return number of names file FILENAME has."
3769 ;; (defun file-relative-name (filename &optional directory)
3770 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3771 ;; This function returns a relative file name which is equivalent to FILENAME
3772 ;; when used with that default directory as the default.
3773 ;; If this is impossible (which can happen on MSDOS and Windows
3774 ;; when the file name and directory use different drive names)
3775 ;; then it returns FILENAME."
3776 ;; (save-match-data
3777 ;; (let ((fname (expand-file-name filename)))
3778 ;; (setq directory (file-name-as-directory
3779 ;; (expand-file-name (or directory default-directory))))
3780 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3781 ;; ;; drive names, they can't be relative, so return the absolute name.
3782 ;; (if (and (or (eq system-type 'ms-dos)
3783 ;; (eq system-type 'cygwin)
3784 ;; (eq system-type 'windows-nt))
3785 ;; (not (string-equal (substring fname 0 2)
3786 ;; (substring directory 0 2))))
3787 ;; filename
3788 ;; (let ((ancestor ".")
3789 ;; (fname-dir (file-name-as-directory fname)))
3790 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3791 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3792 ;; (setq directory (file-name-directory (substring directory 0 -1))
3793 ;; ancestor (if (equal ancestor ".")
3794 ;; ".."
3795 ;; (concat "../" ancestor))))
3796 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3797 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3798 ;; ;; We matched within FNAME's directory part.
3799 ;; ;; Add the rest of FNAME onto ANCESTOR.
3800 ;; (let ((rest (substring fname (match-end 0))))
3801 ;; (if (and (equal ancestor ".")
3802 ;; (not (equal rest "")))
3803 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3804 ;; rest
3805 ;; (concat (file-name-as-directory ancestor) rest)))
3806 ;; ;; We matched FNAME's directory equivalent.
3807 ;; ancestor))))))
3810 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3811 This function returns a relative file name which is equivalent to FILENAME
3812 when used with that default directory as the default.
3813 If FILENAME and DIRECTORY lie on different machines or on different drives
3814 on a DOS/Windows machine, it returns FILENAME in expanded form."
3818 default-directory))))
3824 ;; Test for different drives on DOS/Windows
3826 ;; Should `cygwin' really be included here? --stef
3829 ;; Test for different remote file system identification
3831 filename
3837 directory nil nil case-fold-search))
3839 directory nil nil case-fold-search))))
3842 ".."
3844 ;; Now ancestor is empty, or .., or ../.., etc.
3846 directory nil nil case-fold-search))
3847 ;; We matched within FILENAME's directory part.
3848 ;; Add the rest of FILENAME onto ANCESTOR.
3851 ;; But don't bother with ANCESTOR if it would give us `./'.
3852 rest
3854 ;; We matched FILENAME's directory equivalent.
3855 ancestor))))))
3856 \f
3858 "Save current buffer in visited file if modified.
3859 Variations are described below.
3861 By default, makes the previous version into a backup file
3862 if previously requested or if this is the first save.
3864 to become a backup when the next save is done.
3866 unconditionally makes the previous version into a backup file.
3868 to become a backup when the next save is done,
3869 and unconditionally makes the previous version into a backup file.
3871 With a numeric argument of 0, never make the previous version
3872 into a backup file.
3874 If a file's name is FOO, the names of its numbered backup versions are
3875 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3876 Numeric backups (rather than FOO~) will be made if value of
3877 `version-control' is not the atom `never' and either there are already
3878 numeric versions of the file being backed up, or `version-control' is
3879 non-nil.
3880 We don't want excessive versions piling up, so there are variables
3881 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3882 and `kept-new-versions', which tells how many newest versions to keep.
3883 Defaults are 2 old versions and 2 new.
3884 `dired-kept-versions' controls dired's clean-directory (.) command.
3885 If `delete-old-versions' is nil, system will query user
3886 before trimming versions. Otherwise it does it silently.
3888 If `vc-make-backup-files' is nil, which is the default,
3889 no backup files are made for files managed by version control.
3890 (This is because the version control system itself records previous versions.)
3892 See the subroutine `basic-save-buffer' for more information."
3905 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3906 Normally delete only if the file was written by this Emacs since
3907 the last real save, but optional arg FORCE non-nil means delete anyway."
3921 "Normal hook that is run before a buffer is saved to its file."
3927 "Normal hook that is run after a buffer is saved to its file."
3933 "If non-nil, use this coding system for saving the buffer.
3934 More precisely, use this coding system in place of the
3935 value of `buffer-file-coding-system', when saving the buffer.
3936 Calling `write-region' for any purpose other than saving the buffer
3937 will still use `buffer-file-coding-system'; this variable has no effect
3944 "Save the current buffer in its visited file, if it has been modified.
3945 The hooks `write-contents-functions' and `write-file-functions' get a chance
3946 to do the job of saving; if they do not, then the buffer is saved in
3947 the visited file in the usual way.
3948 Before and after saving the buffer, this function runs
3949 `before-save-hook' and `after-save-hook', respectively."
3952 ;; In an indirect buffer, save its base buffer instead.
3957 setmodes)
3958 ;; If buffer has no file name, ask user for one.
3965 ;; Signal an error if the user specified the name of an
3966 ;; existing directory.
3969 filename))
3971 ;; Signal an error if the specified name refers to a
3972 ;; non-existing directory.
4002 ;; Support VC version backups.
4008 ;; If a hook returned t, file is already "written".
4009 ;; Otherwise, write it the usual way now.
4011 ;; Now we have saved the current buffer. Let's make sure
4012 ;; that buffer-file-coding-system is fixed to what
4013 ;; actually used for saving by binding it locally.
4023 ;; If the auto-save file was recent before this command,
4024 ;; delete it now.
4026 ;; Support VC `implicit' locking.
4031 ;; This does the "real job" of writing a buffer into its visited file
4032 ;; and making a backup file. This is what is normally done
4033 ;; but inhibited if one of write-file-functions returns non-nil.
4034 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4043 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4057 buffer-file-name)))
4065 ;; If file is precious, write temp name, then rename it.
4066 ;; This requires write access to the containing dir,
4067 ;; which is why we don't try it if we don't have that access.
4069 tempname succeed
4072 ;; Create temp files with strict access rights. It's easy to
4073 ;; loosen them later, whereas it's impossible to close the
4074 ;; time-window of loose permissions otherwise.
4079 ;; Try various temporary names.
4080 ;; This code follows the example of make-temp-file,
4081 ;; but it calls write-region in the appropriate way
4082 ;; for saving the buffer.
4088 ;; Pass in nil&nil rather than point-min&max
4089 ;; cause we're saving the whole buffer.
4090 ;; write-region-annotate-functions may use it.
4092 tempname nil realname
4094 nil)
4096 ;; The file was somehow created by someone else between
4097 ;; `make-temp-name' and `write-region', let's try again.
4098 nil)
4100 ;; Reset the umask.
4102 ;; If we failed, restore the buffer's modtime.
4105 ;; Since we have created an entirely new file,
4106 ;; make sure it gets the right permission bits set.
4110 buffer-file-name)))
4111 ;; We succeeded in writing the temp file,
4112 ;; so rename it.
4114 ;; If file not writable, see if we can make it writable
4115 ;; temporarily while we write it.
4116 ;; But no need to do so if we have just backed it up
4117 ;; (setmodes is set) because that says we're superseding.
4119 ;; Change the mode back, after writing.
4125 ;; Pass in nil&nil rather than point-min&max to indicate
4126 ;; we're saving the buffer rather than just a region.
4127 ;; write-region-annotate-functions may make us of it.
4129 buffer-file-name nil t buffer-file-truename)
4131 ;; If we get an error writing the new file, and we made
4132 ;; the backup by renaming, undo the backing-up.
4137 setmodes))
4140 "View the differences between BUFFER and its associated file.
4141 This requires the external program `diff' to be in your `exec-path'."
4155 ;; Display that message for 1 second so that user can read it
4156 ;; in the minibuffer.
4158 ;; return always nil, so that save-buffers-kill-emacs will not move
4159 ;; over to the next unsaved buffer when calling `d'.
4160 nil)
4163 `((?\C-r
4170 ;; Return nil to ask about BUF again.
4171 nil)
4183 ;; Return nil to ask about BUF again.
4184 nil)
4193 "Save some modified file-visiting buffers. Asks user about each one.
4194 You can answer `y' to save, `n' not to save, `C-r' to look at the
4195 buffer in question with `view-buffer' before deciding or `d' to
4196 view the differences using `diff-buffer-with-file'.
4198 Optional argument (the prefix) non-nil means save all with no questions.
4199 Optional second argument PRED determines which buffers are considered:
4200 If PRED is nil, all the file-visiting buffers are considered.
4201 If PRED is t, then certain non-file buffers will also be considered.
4202 If PRED is a zero-argument function, it indicates for each buffer whether
4203 to consider it or not when called with that buffer current.
4205 See `save-some-buffers-action-alist' if you want to
4206 change the additional actions you can take on files."
4210 files-done abbrevs-done)
4212 ;; First save any buffers that we're supposed to save unconditionally.
4213 ;; That way the following code won't ask about them.
4218 ;; Ask about those buffers that merit it,
4219 ;; and record the number thus saved.
4234 t
4246 save-some-buffers-action-alist))
4247 ;; Maybe to save abbrevs, and record whether
4248 ;; we either saved them or asked to.
4254 abbrev-file-name)))
4256 ;; Don't keep bothering user if he says no.
4261 "(Some special files were saved without asking)"
4263 \f
4265 "Mark current buffer as unmodified, not needing to be saved.
4268 It is not a good idea to use this function in Lisp programs, because it
4269 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4276 "Change whether this buffer is visiting its file read-only.
4277 With prefix argument ARG, make the buffer read-only if ARG is
4278 positive, otherwise make it writable. If visiting file read-only
4279 and `view-read-only' is non-nil, enter view mode."
4284 nil ; do nothing.
4285 ;; Toggle.
4292 ;; If view-mode is already active, `view-mode-enter' is a nop.
4304 "Insert contents of file FILENAME into buffer after point.
4305 Set mark after the inserted text.
4307 This function is meant for the user to run interactively.
4308 Don't call it from programs! Use `insert-file-contents' instead.
4309 \(Its calling sequence is different; see its documentation)."
4314 "Append the contents of the region to the end of file FILENAME.
4315 When called from a function, expects three arguments,
4316 START, END and FILENAME. START and END are buffer positions
4317 saying what text to write."
4322 "Return most recent backup file for FILENAME or nil if no backups exist."
4323 ;; `make-backup-file-name' will get us the right directory for
4324 ;; ordinary or numeric backups. It might create a directory for
4325 ;; backups as a side-effect, according to `backup-directory-alist'.
4332 tem)
4341 newest))
4344 "Rename current buffer to a similar name not already taken.
4345 This function is useful for creating multiple shell process buffers
4346 or multiple mail buffers, etc."
4354 ;; If the existing buffer name has a <NNN>,
4355 ;; which isn't part of the file name (if any),
4356 ;; then get rid of that.
4362 "Create the directory DIR and any nonexistent parent dirs.
4363 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4365 Interactively, the default choice of directory to create
4366 is the current default directory for file names.
4367 That is useful when you have visited a file in a nonexistent directory.
4369 Noninteractively, the second (optional) argument PARENTS says whether
4370 to create parent directories if they don't exist. Interactively,
4371 this happens by default."
4374 nil nil)
4375 t))
4376 ;; If default-directory is a remote directory,
4377 ;; make sure we find its make-directory handler.
4385 create-list)
4392 \f
4395 "Function to use to revert this buffer, or nil to do the default.
4396 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4401 "Function to use to insert contents when reverting this buffer.
4402 Gets two args, first the nominal file name to use,
4403 and second, t if reading the auto-save file.
4408 "Function to check whether a non-file buffer needs reverting.
4409 This should be a function with one optional argument NOCONFIRM.
4410 Auto Revert Mode passes t for NOCONFIRM. The function should return
4411 non-nil if the buffer should be reverted. A return value of
4412 `fast' means that the need for reverting was not checked, but
4413 that reverting the buffer is fast. The buffer is current when
4414 this function is called.
4416 The idea behind the NOCONFIRM argument is that it should be
4417 non-nil if the buffer is going to be reverted without asking the
4418 user. In such situations, one has to be careful with potentially
4419 time consuming operations.
4421 For more information on how this variable is used by Auto Revert mode,
4425 "Normal hook for `revert-buffer' to run before reverting.
4426 If `revert-buffer-function' is used to override the normal revert
4430 "Normal hook for `revert-buffer' to run after reverting.
4431 Note that the hook value that it runs is the value that was in effect
4432 before reverting; that makes a difference if you have buffer-local
4433 hook functions.
4435 If `revert-buffer-function' is used to override the normal revert
4441 "Replace current buffer text with the text of the visited file on disk.
4442 This undoes all changes since the file was visited or saved.
4443 With a prefix argument, offer to revert from latest auto-save file, if
4444 that is more recent than the visited file.
4446 This command also implements an interface for special buffers
4447 that contain text which doesn't come from a file, but reflects
4448 some other data instead (e.g. Dired buffers, `buffer-list'
4449 buffers). This is done via the variable
4450 `revert-buffer-function'. In these cases, it should reconstruct
4451 the buffer contents from the appropriate data.
4453 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4454 to revert from the auto-save file when this is nil. Note that the
4455 sense of this argument is the reverse of the prefix argument, for the
4456 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4457 to nil.
4459 Optional second argument NOCONFIRM means don't ask for confirmation at
4460 all. \(The variable `revert-without-query' offers another way to
4461 revert buffers without querying for confirmation.)
4463 Optional third argument PRESERVE-MODES non-nil means don't alter
4464 the files modes. Normally we reinitialize them using `normal-mode'.
4466 If the value of `revert-buffer-function' is non-nil, it is called to
4467 do all the work for this command. Otherwise, the hooks
4468 `before-revert-hook' and `after-revert-hook' are run at the beginning
4469 and the end, and if `revert-buffer-insert-file-contents-function' is
4470 non-nil, it is called instead of rereading visited file contents."
4472 ;; I admit it's odd to reverse the sense of the prefix argument, but
4473 ;; there is a lot of code out there which assumes that the first
4474 ;; argument should be t to avoid consulting the auto-save file, and
4475 ;; there's no straightforward way to encourage authors to notice a
4476 ;; reversal of the argument sense. So I'm just changing the user
4477 ;; interface, but leaving the programmatic interface the same.
4485 buffer-auto-save-file-name
4490 buffer-auto-save-file-name
4491 buffer-file-name)))
4501 file-name)))
4503 ;; If file was backed up but has changed since,
4504 ;; we shd make another backup.
4508 ;; Effectively copy the after-revert-hook status,
4509 ;; since after-find-file will clobber it.
4512 after-revert-hook))
4517 ;; Get rid of all undo records for this buffer.
4519 ;; Don't make undo records for the reversion.
4522 file-name auto-save-p)))
4525 "File %s no longer exists!"
4527 file-name))
4530 "File %s no longer readable!"
4532 file-name))
4534 ;; Bind buffer-file-name to nil
4535 ;; so that we don't try to lock the file.
4541 ;; Auto-saved file should be read by Emacs'
4542 ;; internal coding.
4545 buffer-file-coding-system-explicit))))
4547 coding-system-for-read
4549 coding-system-for-read)
4551 ;; As a coding system suitable for multibyte
4552 ;; buffer is specified, make the current
4553 ;; buffer multibyte.
4556 ;; This force after-insert-file-set-coding
4557 ;; (called from insert-file-contents) to set
4558 ;; buffer-file-coding-system to a proper value.
4561 ;; Note that this preserves point in an intelligent way.
4565 nil nil t))
4567 nil nil t)))))
4568 ;; Recompute the truename in case changes in symlinks
4569 ;; have changed the truename.
4573 ;; Run after-revert-hook as it was before we reverted.
4577 local-hook)
4580 t))))))
4583 "Recover the visited file--get contents from its last auto-save file."
4588 "Visit file FILE, but get contents from its last auto-save file."
4589 ;; Actually putting the file name in the minibuffer should be used
4590 ;; only rarely.
4591 ;; Not just because users often use the default.
4611 ;; Use insert-directory-safely, not insert-directory,
4612 ;; because these files might not exist. In particular,
4613 ;; FILE might not exist if the auto-save file was for
4614 ;; a buffer that didn't visit a file, such as "*mail*".
4615 ;; The code in v20.x called `ls' directly, so we need
4616 ;; to emulate what `ls' did in that case.
4622 ;; Keep the current buffer-file-coding-system.
4624 ;; Auto-saved file should be read with special coding.
4633 "Recover auto save files from a previous Emacs session.
4634 This command first displays a Dired buffer showing you the
4635 previous sessions that you could recover from.
4636 To choose one, move point to the proper line and then type C-c C-c.
4637 Then you'll be asked about a number of files to recover."
4647 auto-save-list-file-prefix)))
4648 t)
4657 ;; Each line starts with a space
4658 ;; so that Font Lock mode won't highlight the first character.
4667 "Choose one saved session to recover auto-save files from.
4668 This command is used in the special Dired buffer created by
4671 ;; Get the name of the session file to recover from.
4673 files
4679 ;; Read in the auto-save-list file.
4683 ;; Loop thru the text of that file
4684 ;; and get out the names of the files to recover.
4688 ;; This is a pair of lines for a non-file-visiting buffer.
4689 ;; Get the auto-save file name and manufacture
4690 ;; a "visited file name" from that.
4693 ;; If there is no auto-save file name, the
4694 ;; auto-save-list file is probably corrupted.
4707 ;; This pair of lines is a file-visiting
4708 ;; buffer. Use the visited file name.
4718 ;; Ignore a file if its auto-save file does not exist now.
4722 ;; The file contains a pair of line for each auto-saved buffer.
4723 ;; The first line of the pair contains the visited file name
4724 ;; or is empty if the buffer was not visiting a file.
4725 ;; The second line is the auto-save file name.
4733 files
4739 "Kill buffer if confirmed."
4747 "Kill some buffers. Asks the user whether to kill each one of them.
4748 Non-interactively, if optional argument LIST is non-nil, it
4749 specifies the list of buffers to kill, asking for approval for each one."
4757 ; if we killed the base buffer.
4764 "Kill buffers whose name matches the specified regexp.
4765 The optional second argument indicates whether to kill internal buffers too."
4774 \f
4776 "Toggle auto-saving of contents of current buffer.
4777 With prefix argument ARG, turn auto-saving on if positive, else off."
4782 ;; If auto-save is off because buffer has shrunk,
4783 ;; then toggling should turn it on.
4788 buffer-file-name
4790 ;; If -1 was stored here, to temporarily turn off saving,
4791 ;; turn it back on.
4797 buffer-auto-save-file-name)
4800 "Adjust current buffer's auto save file name for current conditions.
4801 Also rename any existing auto save file, if it was made in this session."
4813 "Return file name to use for auto-saves of current buffer.
4814 Does not consider `auto-save-visited-file-name' as that variable is checked
4815 before calling this function. You can redefine this for customization.
4816 See also `auto-save-file-name-p'."
4824 result uniq)
4825 ;; Apply user-specified translations
4826 ;; to the file name.
4830 filename)
4840 filename))))
4845 ;; We truncate the file name to DOS 8+3 limits
4846 ;; before doing anything else, because the regexp
4847 ;; passed to string-match below cannot handle
4848 ;; extensions longer than 3 characters, multiple
4849 ;; dots, and other atrocities.
4854 fn)
4859 "#"
4862 ;; Make sure auto-save file names don't contain characters
4863 ;; invalid for the underlying filesystem.
4865 ;; Don't modify remote (ange-ftp) filenames
4868 result))))
4870 ;; Deal with buffers that don't have any associated files. (Mail
4871 ;; mode tends to create a good number of these.)
4875 file-name)
4876 ;; Restrict the characters used in the file name to those which
4877 ;; are known to be safe on all filesystems, url-encoding the
4878 ;; rest.
4879 ;; We do this on all platforms, because even if we are not
4880 ;; running on DOS/Windows, the current directory may be on a
4881 ;; mounted VFAT filesystem, such as a USB memory stick.
4885 ;; For multibyte characters, this will produce more than
4886 ;; 2 hex digits, so is not true URL encoding.
4890 ;; Generate the file name.
4896 ;; Try a few alternative directories, to get one we can
4897 ;; write it.
4903 ;; Don't modify remote (ange-ftp) filenames
4905 ;; The call to convert-standard-filename is in case
4906 ;; buffer-name includes characters not allowed by the
4907 ;; DOS/Windows filesystems. make-temp-file writes to the
4908 ;; file it creates, so we must fix the file name _before_
4909 ;; make-temp-file is called.
4911 fname))
4913 ;; make-temp-file creates the file,
4914 ;; but we don't want it to exist until we do an auto-save.
4918 file-name)))
4921 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4922 FILENAME should lack slashes. You can redefine this for customization."
4924 \f
4926 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4927 The generated regexp will match a filename only if the filename
4928 matches that wildcard according to shell rules. Only wildcards known
4929 by `sh' are supported."
4931 ;; Copy the initial run of non-special characters.
4934 ;; If no special characters, we're almost done.
4938 j)
4940 result
4961 ;; Found "[^". Insert a `\0' character
4962 ;; (which cannot happen in a filename)
4963 ;; into the character class, so that `^'
4964 ;; is not the first character after `[',
4965 ;; and thus non-special in a regexp.
4970 ;; I don't think `]' can appear in a
4971 ;; character class in a wildcard, but
4972 ;; let's be general here.
4979 i
4992 ;; Shell wildcards should match the entire filename,
4993 ;; not its part. Make the regexp say so.
4995 \f
4997 "-CF"
4998 "Switches for `list-directory' to pass to `ls' for brief listing."
5003 "-l"
5004 "Switches for `list-directory' to pass to `ls' for verbose listing."
5009 "Expand wildcard pattern PATTERN.
5010 This returns a list of file names which match the pattern.
5012 If PATTERN is written as an absolute file name,
5013 the values are absolute also.
5015 If PATTERN is written as a relative file name, it is interpreted
5016 relative to the current default directory, `default-directory'.
5017 The file names returned are normally also relative to the current
5018 default directory. However, if FULL is non-nil, they are absolute."
5022 ;; A list of all dirs that DIRPART specifies.
5023 ;; This can be more than one dir
5024 ;; if DIRPART contains wildcards.
5029 contents)
5034 ;; Filter out "." and ".."
5039 name))
5046 this-dir-contents)
5047 this-dir-contents)
5048 contents))))
5050 contents)))
5053 "Display a list of files in or matching DIRNAME, a la `ls'.
5054 DIRNAME is globbed by the shell if necessary.
5055 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5056 Actions controlled by variables `list-directory-brief-switches'
5057 and `list-directory-verbose-switches'."
5061 nil default-directory nil)
5062 pfx)))
5064 list-directory-brief-switches))
5065 buffer)
5078 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5086 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5088 PATTERN is assumed to represent a file-name wildcard suitable for the
5089 underlying filesystem. For Unix and GNU/Linux, the characters from the
5091 the parts of the pattern which don't include wildcard characters are
5092 quoted with double quotes.
5093 Existing quote characters in PATTERN are left alone, so you can pass
5094 PATTERN that already quotes some of the special characters."
5098 ;; DOS/Windows don't allow `"' in file names. So if the
5099 ;; argument has quotes, we can safely assume it is already
5100 ;; quoted by the caller.
5102 ;; We quote [&()#$'] in case their shell is a port of a
5103 ;; Unixy shell. We quote [,=+] because stock DOS and
5104 ;; Windows shells require that in some cases, such as
5105 ;; passing arguments to batch files that use positional
5106 ;; arguments like %1.
5108 pattern
5111 end)
5128 pattern))))
5135 "Program to get the amount of free space on a file system.
5136 We assume the output has the format of `df'.
5137 The value of this variable must be just a command name or file name;
5138 if you want to specify options, use `directory-free-space-args'.
5140 A value of nil disables this feature.
5142 If the function `file-system-info' is defined, it is always used in
5143 preference to the program given by this variable."
5149 "Options to use when running `directory-free-space-program'."
5154 "Return the amount of free space on directory DIR's file system.
5155 The result is a string that gives the number of free 1KB blocks,
5156 or nil if the system call or the program which retrieve the information
5157 fail. It returns also nil when DIR is a remote directory.
5159 This function calls `file-system-info' if it is available, or invokes the
5160 program specified by `directory-free-space-program' if that is non-nil."
5162 ;; Try to find the number of free blocks. Non-Posix systems don't
5163 ;; always have df, but might have an equivalent system call.
5172 nil t nil
5173 directory-free-space-args
5174 dir)))
5175 ;; Usual format is a header line followed by a line of
5176 ;; numbers.
5181 ;; Move to the end of the "available blocks" number.
5184 ;; Copy it into AVAILABLE.
5189 ;; The following expression replaces `dired-move-to-filename-regexp'.
5193 ;; In some locales, month abbreviations are as short as 2 letters,
5194 ;; and they can be followed by ".".
5195 ;; In Breton, a month name can include a quote character.
5208 s "+"
5211 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5212 ;; omits the Kanji characters after month and day-of-month.
5213 ;; On Mac OS X 10.3, the date format in East Asian locales is
5214 ;; day-of-month digits followed by month digits.
5220 ;; The "[0-9]" below requires the previous column to end in a digit.
5221 ;; This avoids recognizing `1 may 1997' as a date in the line:
5222 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5224 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5225 ;; The ".*" below finds the last match if there are multiple matches.
5226 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5227 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5229 ;; vc dired listings provide the state or blanks between file
5230 ;; permissions and date. The state is always surrounded by
5231 ;; parantheses:
5232 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5233 ;; This is not supported yet.
5237 "Regular expression to match up to the file name in a directory listing.
5238 The default value is designed to recognize dates and times
5243 ;; insert-directory
5244 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5245 ;; FULL-DIRECTORY-P is nil.
5246 ;; The single line of output must display FILE's name as it was
5247 ;; given, namely, an absolute path name.
5248 ;; - must insert exactly one line for each file if WILDCARD or
5249 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5250 ;; before the file lines, plus optional text after the file lines.
5251 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5252 ;; allowed.
5253 ;; File lines should display the basename.
5254 ;; - must be consistent with
5255 ;; - functions dired-move-to-filename, (these two define what a file line is)
5256 ;; dired-move-to-end-of-filename,
5257 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5258 ;; dired-insert-headerline
5259 ;; dired-after-subdir-garbage (defines what a "total" line is)
5260 ;; - variable dired-subdir-regexp
5261 ;; - may be passed "--dired" as the first argument in SWITCHES.
5262 ;; Filename handlers might have to remove this switch if their
5263 ;; "ls" command does not support it.
5265 "Insert directory listing for FILE, formatted according to SWITCHES.
5266 Leaves point after the inserted text.
5267 SWITCHES may be a string of options, or a list of strings
5268 representing individual options.
5269 Optional third arg WILDCARD means treat FILE as shell wildcard.
5270 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5271 switches do not contain `d', so that a full listing is expected.
5273 This works by running a directory listing program
5274 whose name is in the variable `insert-directory-program'.
5275 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5277 When SWITCHES contains the long `--dired' option, this function
5278 treats it specially, for the sake of dired. However, the
5279 normally equivalent short `-D' option is just passed on to
5280 `insert-directory-program', as any other option."
5281 ;; We need the directory in order to find the right handler.
5286 wildcard full-directory-p)
5289 ;; Read the actual directory using `insert-directory-program'.
5290 ;; RESULT gets the status code.
5292 ;; putting text property `dired-filename, decode one
5293 ;; bunch by one to preserve that property.
5295 ;; This is to control encoding the arguments in call-process.
5299 default-file-name-coding-system))))
5302 ;; Run ls in the directory part of the file pattern
5303 ;; using the last component as argument.
5310 shell-file-name nil t nil
5311 "-c"
5313 ""
5315 insert-directory-program
5316 " -d "
5318 switches
5320 " -- "
5321 ;; Quote some characters that have
5322 ;; special meanings in shells; but
5323 ;; don't quote the wildcards--we want
5324 ;; them to be special. We also
5325 ;; currently don't quote the quoting
5326 ;; characters in case people want to
5327 ;; use them explicitly to quote
5328 ;; wildcard characters.
5330 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5331 ;; directory if FILE is a symbolic link.
5333 insert-directory-program nil t nil
5337 ;; Split the switches at any spaces so we can
5338 ;; pass separate options as separate args.
5340 ;; Avoid lossage if FILE starts with `-'.
5348 file))))))))
5350 ;; If we got "//DIRED//" in the output, it means we got a real
5351 ;; directory listing, even if `ls' returned nonzero.
5352 ;; So ignore any errors.
5365 ;; The first time ls returns an error,
5366 ;; find the version numbers of ls,
5367 ;; and set insert-directory-ls-version
5368 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5369 ;; is equal or if the info cannot be obtained.
5370 ;; (That can mean it isn't GNU ls.)
5380 comparison)
5396 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5400 ;; If `insert-directory-program' failed, signal an error.
5402 ;; Delete the error message it may have output.
5404 ;; On non-Posix systems, we cannot open a directory, so
5405 ;; don't even try, because that will always result in
5406 ;; the ubiquitous "Access denied". Instead, show the
5407 ;; command line so the user can try to guess what went wrong.
5412 insert-directory-program
5414 file result)
5415 ;; Unix. Access the file to get a suitable error.
5422 ;; The following overshoots by one line for an empty
5423 ;; directory listed with "--dired", but without "-a"
5424 ;; switch, where the ls output contains a
5425 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5426 ;; We take care of that case later.
5434 error-lines)
5435 ;; Find all the lines that are error messages,
5436 ;; and record the bounds of each one.
5443 ;; Now read the numeric positions of file names.
5450 error-lines))
5453 error-lines)))
5455 ;; End is followed by \n or by " -> ".
5457 ;; It seems that we can't trust ls's output as to
5458 ;; byte positions of filenames.
5464 ;; Take care of the case where the ls output contains a
5465 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5466 ;; and we went one line too far back (see above).
5471 ;; Now decode what read if necessary.
5473 file-name-coding-system
5474 default-file-name-coding-system
5476 coding-no-eol
5477 val pos)
5481 ;; If no coding system is specified or detection is
5482 ;; requested, detect the coding.
5496 ;; Force no eol conversion on a file name, so
5497 ;; that CR is preserved.
5505 ;; Try to insert the amount of free space.
5508 ;; First find the line to put it on.
5512 ;; Replace "total" with "used", to avoid confusion.
5518 "Convert `ls --dired' file name position value POS to a buffer position.
5519 File name position values returned in ls --dired output
5520 count only stdout; they don't count the error messages sent to stderr.
5521 So this function converts to them to real buffer positions.
5522 ERROR-LINES is a list of buffer positions of error message lines,
5523 of the form (START END)."
5527 pos)
5531 "Insert directory listing for FILE, formatted according to SWITCHES.
5533 Like `insert-directory', but if FILE does not exist, it inserts a
5534 message to that effect instead of signaling an error."
5537 ;; Simulate the message printed by `ls'.
5541 "Functions to call with no arguments to query about killing Emacs.
5542 If any of these functions returns nil, killing Emacs is cancelled.
5543 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5547 "How to ask for confirmation when leaving Emacs.
5548 If nil, the default, don't ask at all. If the value is non-nil, it should
5549 be a predicate function such as `yes-or-no-p'."
5557 "Offer to save each buffer, then kill this Emacs process.
5558 With prefix arg, silently save all file-visiting buffers, then kill."
5567 ;; process-list is not defined on MSDOS.
5569 active)
5578 ;; Query the user for other things, perhaps.
5585 "Offer to save each buffer, then kill the current connection.
5586 If the current frame has no client, kill Emacs itself.
5588 With prefix arg, silently save all file-visiting buffers, then kill.
5590 If emacsclient was started with a list of filenames to edit, then
5591 only these files will be asked to be saved."
5599 \f
5600 ;; We use /: as a prefix to "quote" a file name
5601 ;; so that magic file name handlers will not apply to it.
5605 file-name-handler-alist))
5607 ;; We depend on being the last handler on the list,
5608 ;; so that anything else which does need handling
5609 ;; has been handled already.
5610 ;; So it is safe for us to inhibit *all* magic file name handlers.
5619 default-directory))
5620 ;; Get a list of the indices of the args which are file names.
5623 ;; The first six are special because they
5624 ;; return a file name. We want to include the /:
5625 ;; in the return value.
5626 ;; So just avoid stripping it in the first place.
5633 ;; `identity' means just return the first arg
5634 ;; not stripped of its quoting.
5636 ;; `add' means add "/:" to the result.
5638 ;; `quote' means add "/:" to buffer-file-name.
5640 ;; `unquote-then-quote' means set buffer-file-name
5641 ;; temporarily to unquoted filename.
5643 ;; List the arguments which are filenames.
5651 ;; For all other operations, treat the first argument only
5652 ;; as the file name.
5654 method
5655 ;; Copy ARGUMENTS so we can replace elements in it.
5659 ;; Strip off the /: from the file names that have it.
5667 "/"
5683 res))
5686 \f
5687 ;; Symbolic modes and read-file-modes.
5690 "Convert CHAR to a who-mask from a symbolic mode notation.
5691 CHAR is in [ugoa] and represents the users on which rights are applied."
5699 "Convert CHAR to a right-mask from a symbolic mode notation.
5700 CHAR is in [rwxXstugo] and represents a right.
5701 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5708 ;; Rights relative to the previous file modes.
5719 "Convert a right string to a right-mask from a symbolic modes notation.
5721 WHO-MASK is the mask number of the users on which the rights are to be applied.
5722 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5728 char-right)
5735 num-rights
5739 op char-right)))
5740 num-rights))
5743 "Convert symbolic file modes to numeric file modes.
5744 MODES is the string to convert, it should match
5747 notation.
5748 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5761 num-who num-modes)
5764 num-modes)))
5767 "Read file modes in octal or symbolic notation.
5768 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5769 ORIG-FILE is the original file of which modes will be changed."
5784 nil nil default)))
5790 \f
5791 ;; Trash can handling.
5793 "Directory for `move-file-to-trash' to move files and directories to.
5794 This directory is only used when the function `system-move-file-to-trash' is
5795 not defined. Relative paths are interpreted relative to `default-directory'.
5796 See also `delete-by-moving-to-trash'."
5804 "Move file (or directory) name FILENAME to the trash.
5805 This function is called by `delete-file' and `delete-directory' when
5806 `delete-by-moving-to-trash' is non-nil. On platforms that define
5807 `system-move-file-to-trash', that function is used to move FILENAME to the
5808 system trash, otherwise FILENAME is moved to `trash-directory'.
5809 Returns nil on success."
5822 ;; make new-fn unique.
5823 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5826 ;; stop processing if fn is same or parent directory of trash-dir.
5829 filename))
5832 \f
5857 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5858 ;;; files.el ends here