| blob | 0dc8ba20b2df9e92c087c238096f54fb53cf33b1 |
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:
36 "Backups of edited data files."
40 "Finding files."
45 "Non-nil means delete auto-save file when a buffer is saved or killed.
47 Note that the auto-save file will not be deleted if the buffer is killed
48 when it has unsaved changes."
53 nil
54 "Alist of abbreviations for file directories.
55 A list of elements of the form (FROM . TO), each meaning to replace
56 FROM with TO when it appears in a directory name. This replacement is
57 done when setting up the default directory of a newly visited file.
58 *Every* FROM string should start with `^'.
60 FROM and TO should be equivalent names, which refer to the
61 same directory. Do not use `~' in the TO strings;
62 they should be ordinary absolute directory names.
64 Use this feature when you have directories which you normally refer to
65 via absolute symbolic links. Make TO the name of the link, and FROM
66 the name it is linked to."
74 ;; Turn off backup files on VMS since it has version numbers.
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
128 "Non-nil means create backups by copying to preserve a privileged owner.
129 Renaming may still be used (subject to control of other variables)
130 when it would not result in changing the owner of the file or if the owner
131 has a user id greater than the value of this variable. This is useful
132 when low-numbered uid's are used for special system users (such as root)
133 that must maintain ownership of certain files.
134 This variable is relevant only if `backup-by-copying' and
135 `backup-by-copying-when-mismatch' are nil."
140 "Predicate that looks at a file name and decides whether to make backups.
144 "Non-nil in a buffer means always offer to save buffer on exit.
145 Do so even if the buffer is not visiting a file.
146 Automatically local in all buffers."
152 "Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
159 "*Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
167 "Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
198 "The directory for writing temporary files."
204 "The directory for writing small temporary files.
205 If non-nil, this directory is used instead of `temporary-file-directory'
206 by programs that create small temporary files. This is for systems that
207 have fast storage with limited space, such as a RAM disk."
211 ;; The system null device. (Should reference NULL_DEVICE from C.)
237 "Non-nil means protect against I/O errors while saving files.
238 Some modes set this non-nil in particular buffers.
240 This feature works by writing the new contents into a temporary file
241 and then renaming the temporary file to replace the original.
242 In this way, any I/O error in writing leaves the original untouched,
243 and there is never any instant where the file is nonexistent.
245 Note that this feature forces backups to be made by copying.
246 Yet, at the same time, saving a precious file
247 breaks any hard links between it and other files."
252 "Control use of version numbers for backup files.
253 When t, make numeric backup versions unconditionally.
254 When nil, make them for files that have some already.
255 The value `never' means do not make them."
265 "When cleaning directory, number of versions to keep."
271 "If t, delete excess backup versions silently.
272 If nil, ask confirmation. Any other value prevents any trimming."
279 "Number of oldest versions to keep when a new numbered backup is made."
285 "Number of newest versions to keep when a new numbered backup is made.
286 Includes the new backup. Must be > 0"
292 "Whether to add a newline automatically at the end of the file.
294 A value of t means do this only when the file is about to be saved.
295 A value of `visit' means do this right after the file is visited.
296 A value of `visit-save' means do it at both of those times.
297 Any other non-nil value means ask user whether to add a newline, when saving.
298 A value of nil means don't add newlines.
300 Certain major modes set this locally to the value obtained
301 from `mode-require-final-newline'."
310 "Whether to add a newline at end of file, in certain major modes.
311 Those modes set `require-final-newline' to this value when you enable them.
312 They do so because they are often used for files that are supposed
313 to end in newlines, and the question is how to arrange that.
315 A value of t means do this only when the file is about to be saved.
316 A value of `visit' means do this right after the file is visited.
317 A value of `visit-save' means do it at both of those times.
318 Any other non-nil value means ask user whether to add a newline, when saving.
320 A value of nil means do not add newlines. That is a risky choice in this
321 variable since this value is used for modes for files that ought to have
322 final newlines. So if you set this to nil, you must explicitly check and
323 add a final newline, whenever you save a file that really needs one."
333 "Non-nil says by default do auto-saving of every file-visiting buffer."
338 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
339 Normally auto-save files are written under other names."
345 ;; Don't put "\\2" inside expand-file-name, since it will be
346 ;; transformed to "/2" on DOS/Windows.
348 "Transforms to apply to buffer file name before making auto-save file name.
349 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
350 REGEXP is a regular expression to match against the file name.
351 If it matches, `replace-match' is used to replace the
352 matching part with REPLACEMENT.
353 If the optional element UNIQUIFY is non-nil, the auto-save file name is
354 constructed by taking the directory part of the replaced file-name,
355 concatenated with the buffer file name with all directory separators
356 changed to `!' to prevent clashes. This will not work
357 correctly if your filesystem truncates the resulting name.
359 All the transforms in the list are tried, in the order they are listed.
360 When one transform applies, its result is final;
361 no further transforms are tried.
363 The default value is set up to put the auto-save file into the
364 temporary directory (see the variable `temporary-file-directory') for
365 editing a remote file.
367 On MS-DOS filesystems without long names this variable is always
368 ignored."
375 "Non-nil means save word abbrevs too when files are saved.
376 If `silently', don't ask the user before saving."
381 "Non-nil means allow `find-file' to visit directories.
382 To visit the directory, `find-file' runs `find-directory-functions'."
387 "List of functions to try in sequence to visit a directory.
388 Each function is called with the directory name as the sole argument
389 and should return either a buffer or nil."
393 ;;;It is not useful to make this a local variable.
394 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
396 "List of functions to be called for `find-file' on nonexistent file.
397 These functions are called as soon as the error is detected.
398 Variable `buffer-file-name' is already set up.
403 ;;;It is not useful to make this a local variable.
404 ;;;(put 'find-file-hooks 'permanent-local t)
407 "List of functions to be called after a buffer is loaded from a file.
408 The buffer's local variables (if any) will have been processed before the
409 functions are called."
416 "List of functions to be called before writing out a buffer to a file.
417 If one of them returns non-nil, the file is considered already written
418 and the rest are not called.
419 These hooks are considered to pertain to the visited file.
420 So any buffer-local binding of this variable is discarded if you change
422 change the major mode.
424 This hook is not run if any of the functions in
425 `write-contents-functions' returns non-nil. Both hooks pertain
426 to how to save a buffer to file, for instance, choosing a suitable
427 coding system and setting mode bits. (See Info
428 node `(elisp)Saving Buffers'.) To perform various checks or
439 "List of functions to be called before writing out a buffer to a file.
440 If one of them returns non-nil, the file is considered already written
441 and the rest are not called and neither are the functions in
442 `write-file-functions'.
444 This variable is meant to be used for hooks that pertain to the
445 buffer's contents, not to the particular visited file; thus,
446 `set-visited-file-name' does not clear this variable; but changing the
447 major mode does clear it.
449 For hooks that _do_ pertain to the particular visited file, use
450 `write-file-functions'. Both this variable and
451 `write-file-functions' relate to how a buffer is saved to file.
452 To perform various checks or updates before the buffer is saved,
459 "Control use of local variables in files you visit.
460 The value can be t, nil, :safe, :all, or something else.
462 A value of t means file local variables specifications are obeyed
463 if all the specified variable values are safe; if any values are
464 not safe, Emacs queries you, once, whether to set them all.
465 \(When you say yes to certain values, they are remembered as safe.)
467 :safe means set the safe variables, and ignore the rest.
468 :all means set all variables, whether safe or not.
469 (Don't set it permanently to :all.)
470 A value of nil means always ignore the file local variables.
472 Any other value means always query you once whether to set them all.
473 \(When you say yes to certain values, they are remembered as safe, but
476 This variable also controls use of major modes specified in
477 a -*- line.
480 always obeys file local variable specifications and the -*- line,
481 and ignores this variable."
490 "Like `enable-local-variables' but meant for buffer-local bindings.
491 The meaningful values are nil and non-nil. The default is non-nil.
492 If a major mode sets this to nil, buffer-locally, then any local
493 variables list in the file will be ignored.
495 This variable does not affect the use of major modes
500 The value can be t, nil or something else.
501 A value of t means obey `eval' variables;
502 A value of nil means ignore them; anything else means query."
508 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
517 "Non-nil means buffers visiting files read-only do so in view mode.
518 In fact, this means that all read-only buffers normally have
519 View mode enabled, including buffers that are read-only because
520 you visit a file you cannot alter, and buffers you make read-only
526 "History list of file names entered in the minibuffer.
528 Maximum length of the history list is determined by the value
530 \f
533 "Provides support for ange-ftp host name completion.
534 Runs the usual ange-ftp hook, but only for completion operations."
535 ;; Having this here avoids the need to load ange-ftp when it's not
536 ;; really in use.
542 inhibit-file-name-handlers)))
547 "Convert a standard file's name to something suitable for the OS.
548 This means to guarantee valid names and perhaps to canonicalize
549 certain patterns.
551 FILENAME should be an absolute file name since the conversion rules
552 sometimes vary depending on the position in the file name. E.g. c:/foo
553 is a valid DOS file name, but c:/bar/c:/foo is not.
555 This function's standard definition is trivial; it just returns
556 the argument. However, on Windows and DOS, replace invalid
557 characters. On DOS, make sure to obey the 8.3 limitations.
558 In the native Windows build, turn Cygwin names into native names,
559 and also turn slashes into backslashes if the shell requires it (see
560 `w32-shell-dos-semantics').
562 See Info node `(elisp)Standard File Names' for more details."
566 ;; Replace invalid filename characters with !
570 name)
571 filename))
574 "Read directory name, prompting with PROMPT and completing in directory DIR.
575 Value is not expanded---you must call `expand-file-name' yourself.
576 Default name to DEFAULT-DIRNAME if user exits with the same
577 non-empty string that was inserted by this function.
578 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
579 or just DIR if INITIAL is nil.)
580 If the user exits with an empty minibuffer, this function returns
581 an empty string. (This can only happen if the user erased the
582 pre-inserted contents or if `insert-default-directory' is nil.)
583 Fourth arg MUSTMATCH non-nil means require existing directory's name.
584 Non-nil and non-t means also require confirmation after completion.
585 Fifth arg INITIAL specifies text to start with.
586 DIR should be an absolute directory name. It defaults to
587 the value of `default-directory'."
592 dir))
593 mustmatch initial
596 \f
598 "Show the current default directory."
603 "Value of the CDPATH environment variable, as a list.
607 "Explode a search path into a list of directory names.
608 Directories are separated by occurrences of `path-separator'
609 \(which is colon in GNU and GNU-like systems)."
610 ;; We could use split-string here.
618 nil
623 cd-list)))
626 "Change current directory to given absolute file name DIR."
627 ;; Put the name into directory syntax now,
628 ;; because otherwise expand-file-name may give some bad results.
642 "Make DIR become the current buffer's default directory.
643 If your environment includes a `CDPATH' variable, try each one of
644 that list of directories (separated by occurrences of
645 `path-separator') when resolving a relative directory name.
646 The path separator is colon in GNU and GNU-like systems."
649 default-directory default-directory
665 cd-path)
666 nil))
670 "Load the Lisp file named FILE."
671 ;; This is a case where .elc makes a lot of sense.
678 "Search for FILENAME through PATH.
679 If found, return the absolute file name of FILENAME, with its suffixes;
680 otherwise return nil.
681 PATH should be a list of directories to look in, like the lists in
682 `exec-path' or `load-path'.
683 If SUFFIXES is non-nil, it should be a list of suffixes to append to
686 If non-nil, PREDICATE is used instead of `file-readable-p'.
687 PREDICATE can also be an integer to pass to the `access' system call,
688 in which case file-name handlers are ignored. This usage is deprecated.
690 For compatibility, PREDICATE can also be one of the symbols
691 `executable', `readable', `writable', or `exists', or a list of
692 one or more of those symbols."
703 "Do completion for file names passed to `locate-file'."
724 "Do completion for file names passed to `locate-file'.
725 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
728 string nil action))
732 "Look up the directory hierarchy from FILE for a file matching REGEXP."
734 ;; `user' is not initialized yet because `file' may not exist, so we may
735 ;; have to walk up part of the hierarchy before we find the "initial UID".
737 ;; Abbreviate, so as to stop when we cross ~/.
739 files)
741 ;; As a heuristic, we stop looking up the hierarchy of
742 ;; directories as soon as we find a directory belonging to
743 ;; another user. This should save us from looking in
744 ;; things like /net and /afs. This assumes that all the
745 ;; files inside a project belong to the same user.
756 nil)))
759 "Search for COMMAND in `exec-path' and return the absolute file name.
760 Return nil if COMMAND is not found anywhere in `exec-path'."
761 ;; Use 1 rather than file-executable-p to better match the behavior of
762 ;; call-process.
766 "Load the library named LIBRARY.
767 This is an interface to the function `load'."
771 load-path
776 "Test whether FILE specifies a location on a remote system.
777 Returns nil or a string identifying the remote connection (ideally
778 a prefix of FILE). For example, the remote identification for filename
781 less reliable than accessing local files.
782 Furthermore, relative file names do not work across remote connections.
784 IDENTIFICATION specifies which part of the identification shall
785 be returned as string. IDENTIFICATION can be the symbol
786 `method', `user' or `host'; any other value is handled like nil
787 and means to return the complete identification string.
789 If CONNECTED is non-nil, the function returns an identification only
790 if FILE is located on a remote system, and a connection is established
791 to that remote system.
793 `file-remote-p' will never open a connection on its own."
797 nil)))
800 "Copy the file FILE into a temporary file on this machine.
801 Returns the name of the local copy, or nil, if FILE is directly
802 accessible."
803 ;; This formerly had an optional BUFFER argument that wasn't used by
804 ;; anything.
808 nil)))
811 "Return the truename of FILENAME, which should be absolute.
812 The truename of a file name is found by chasing symbolic links
813 both at the level of the file and at the level of the directories
814 containing it, until no links are left at any level.
817 ;; COUNTER and PREV-DIRS are only used in recursive calls.
818 ;; COUNTER can be a cons cell whose car is the count of how many
819 ;; more links to chase before getting an error.
820 ;; PREV-DIRS can be a cons cell whose car is an alist
821 ;; of truenames we've just recently computed.
835 ;; For speed, remove the ange-ftp completion handler from the list.
836 ;; We know it's not needed here.
837 ;; For even more speed, do this only on the outermost call.
844 ;; andrewi@harlequin.co.uk - none of the following code (except for
845 ;; invoking the file-name handler) currently applies on Windows
846 ;; (ie. there are no native symlinks), but there is an issue with
847 ;; case differences being ignored by the OS, and short "8.3 DOS"
848 ;; name aliases existing for all files. (The short names are not
849 ;; reported by directory-files, but can be used to refer to files.)
850 ;; It seems appropriate for file-truename to resolve these issues in
851 ;; the most natural way, which on Windows is to call the function
852 ;; `w32-long-file-name' - this returns the exact name of a file as
853 ;; it is stored on disk (expanding short name aliases with the full
854 ;; name in the process).
857 ;; For file name that has a special handler, call handler.
858 ;; This is so that ange-ftp can save time by doing a no-op.
861 ;; If filename contains a wildcard, newname will be the old name.
863 ;; If filename exists, use the long name
867 ;; If this file directly leads to a link, process that iteratively
868 ;; so that we don't use lots of stack.
874 ;; For file name that has a special handler, call handler.
875 ;; This is so that ange-ftp can save time by doing a no-op.
878 done t)
880 target dirfile)
881 ;; Get the truename of the directory.
883 ;; If these are equal, we have the (or a) root directory.
885 ;; If this is the same dir we last got the truename for,
886 ;; save time--don't recalculate.
896 done t)
899 done t)
900 ;; Put it back on the file name.
902 ;; Is the file name the name of a link?
905 ;; Yes => chase that link, then start all over
906 ;; since the link may point to a directory name that uses links.
907 ;; We can't safely use expand-file-name here
908 ;; since target might look like foo/../bar where foo
909 ;; is itself a link. Instead, we handle . and .. above.
912 target
914 done nil)
915 ;; No, we are done!
917 filename))
920 "Chase links in FILENAME until a name that is not a link.
921 Unlike `file-truename', this does not check whether a parent
922 directory name is a symbolic link.
923 If the optional argument LIMIT is a number,
924 it means chase no more than that many links and then stop."
932 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
935 ;; Handle `..' by hand, since it needs to work in the
936 ;; target of any directory symlink.
937 ;; This code is not quite complete; it does not handle
938 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
942 ;; Chase links in the default dir of the symlink.
946 ;; Now find the parent of that dir.
950 newname))
953 "Create a temporary file.
954 The returned file name (created by appending some random characters at the end
955 of PREFIX, and expanding against `temporary-file-directory' if necessary),
956 is guaranteed to point to a newly created empty file.
957 You can then use `write-region' to write new data into the file.
959 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
961 If SUFFIX is non-nil, add that at the end of the file name."
963 file)
966 ;; Create temp files with strict access rights. It's easy to
967 ;; loosen them later, whereas it's impossible to close the
968 ;; time-window of loose permissions otherwise.
980 nil)
982 ;; the file was somehow created by someone else between
983 ;; `make-temp-name' and `write-region', let's try again.
984 nil)
985 file)
986 ;; Reset the umask.
990 "Change the encoding of FILE's name from CODING to NEW-CODING.
991 The value is a new name of FILE.
992 Signals a `file-already-exists' error if a file of the new name
993 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
994 is non-nil. A number as fourth arg means request confirmation if
995 the new name already exists. This is what happens in interactive
996 use with M-x."
999 default-file-name-coding-system))
1001 from-coding to-coding)
1003 ;; We provide the default coding only when it seems that
1004 ;; the filename is correctly decoded by the default
1005 ;; coding.
1011 filename default-coding)
1012 default-coding))
1016 ;; We provide the default coding only when a user is going to
1017 ;; change the encoding not from the default coding.
1021 filename from-coding)))
1024 filename from-coding default-coding)
1025 default-coding)))
1029 default-file-name-coding-system))
1030 ;; FILE should have been decoded by DEFAULT-CODING.
1034 ;; Suppress further encoding.
1039 newname))
1040 \f
1042 "Read the name of a buffer to switch to and return as a string.
1043 It is intended for `switch-to-buffer' family of commands since they
1044 need to omit the name of current buffer from the list of completions
1045 and default values."
1052 "Select buffer BUFFER in another window.
1053 If BUFFER does not identify an existing buffer, then this function
1054 creates a buffer with that name.
1056 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1057 or nil. If BUFFER is nil, then this function chooses a buffer
1058 using `other-buffer'.
1059 Optional second arg NORECORD non-nil means
1060 do not put this buffer at the front of the list of recently selected ones.
1061 This function returns the buffer it switched to.
1063 This uses the function `display-buffer' as a subroutine; see its
1064 documentation for additional customization information."
1068 ;; Don't let these interfere.
1069 same-window-buffer-names same-window-regexps)
1073 "Switch to buffer BUFFER in another frame.
1074 Optional second arg NORECORD non-nil means
1075 do not put this buffer at the front of the list of recently selected ones.
1076 This function returns the buffer it switched to.
1078 This uses the function `display-buffer' as a subroutine; see its
1079 documentation for additional customization information."
1083 same-window-buffer-names same-window-regexps)
1089 "Switch to buffer BUFFER in another frame.
1090 This uses the function `display-buffer' as a subroutine; see its
1091 documentation for additional customization information."
1094 same-window-buffer-names same-window-regexps
1096 new-window)
1098 ;; This may have been here in order to prevent the new frame from hiding
1099 ;; the old frame. But it does more harm than good.
1100 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1101 ;;(lower-frame (window-frame new-window))
1103 ;; This may have been here in order to make sure the old-frame gets the
1104 ;; focus. But not only can it cause an annoying flicker, with some
1105 ;; window-managers it just makes the window invisible, with no easy
1106 ;; way to recover it. --Stef
1107 ;;(make-frame-invisible (window-frame old-window))
1108 ;;(make-frame-visible (window-frame old-window))
1109 ))
1115 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1116 BODY should use the minibuffer at most once.
1117 Recursive uses of the minibuffer will not be affected."
1123 ;; Clear out this hook so it does not interfere
1124 ;; with any recursive minibuffer usage.
1134 "If non-nil, `find-file' requires confirmation before visiting a new file."
1146 t))
1149 "Edit file FILENAME.
1150 Switch to a buffer visiting file FILENAME,
1151 creating one if none already exists.
1152 Interactively, the default if you just type RET is the current directory,
1153 but the visited file name is available through the minibuffer history:
1154 type M-n to pull it into the minibuffer.
1156 You can visit files on remote machines by specifying something
1157 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1158 also visit local files as a different user by specifying
1159 /sudo::FILE for the file name.
1160 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1161 manual, for more about this.
1163 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1164 expand wildcards (if any) and visit multiple files. You can
1165 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1167 To visit a file without any kind of conversion and without
1178 "Edit file FILENAME, in another window.
1181 an existing one. See the function `display-buffer'.
1183 Interactively, the default if you just type RET is the current directory,
1184 but the visited file name is available through the minibuffer history:
1185 type M-n to pull it into the minibuffer.
1187 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1188 expand wildcards (if any) and visit multiple files."
1201 "Edit file FILENAME, in another frame.
1204 an existing one. See the function `display-buffer'.
1206 Interactively, the default if you just type RET is the current directory,
1207 but the visited file name is available through the minibuffer history:
1208 type M-n to pull it into the minibuffer.
1210 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1211 expand wildcards (if any) and visit multiple files."
1224 "Edit the existing file FILENAME.
1226 file names with wildcards."
1234 "Edit file FILENAME but don't allow changes.
1248 value))
1251 "Edit file FILENAME in another window but don't allow changes.
1265 value))
1268 "Edit file FILENAME in another frame but don't allow changes.
1282 value))
1285 "Find file FILENAME as a replacement for the file in the next window.
1286 This command does not select that window.
1290 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1291 expand wildcards (if any) and replace the file with multiple files."
1303 t))))
1311 "Find file FILENAME, select its buffer, kill previous buffer.
1312 If the current buffer now contains an empty file that you just visited
1313 \(presumably by mistake), use this command to visit the file you really want.
1317 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1318 expand wildcards (if any) and replace the file with multiple files.
1320 If the current buffer is an indirect buffer, or the base buffer
1321 for one or more indirect buffers, the other buffer(s) are not
1322 killed."
1332 t)))
1353 ;; This prevents us from finding the same buffer
1354 ;; if we specified the same file again.
1358 ;; Likewise for dired buffers.
1362 ;; This executes if find-file gets an error
1363 ;; and does not really find anything.
1364 ;; We put things back as they were.
1365 ;; If find-file actually finds something, we kill obuf below.
1374 ;; We already asked; don't ask again.
1377 \f
1379 "Create a suitably named buffer for visiting FILENAME, and return it.
1380 FILENAME (sans directory) is used unchanged if that name is free;
1381 otherwise a string <2> or <3> or ... is appended to get an unused name.
1382 Spaces at the start of FILENAME (sans directory) are removed."
1391 "Create and return a buffer with a name based on NAME.
1392 Choose the buffer's name using `generate-new-buffer-name'."
1396 "Regexp to match the automounter prefix in a directory name."
1404 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1406 home directory is a root directory) and removes automounter prefixes
1407 \(see the variable `automount-dir-prefix')."
1408 ;; Get rid of the prefixes added by the automounter.
1416 ;; If any elt of directory-abbrev-alist matches this name,
1417 ;; abbreviate accordingly.
1423 ;; Compute and save the abbreviated homedir name.
1424 ;; We defer computing this until the first time it's needed, to
1425 ;; give time for directory-abbrev-alist to be set properly.
1426 ;; We include a slash at the end, to avoid spurious matches
1427 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1434 ;; If FILENAME starts with the abbreviated homedir,
1435 ;; make it start with `~' instead.
1437 ;; If the home dir is just /, don't change it.
1440 ;; MS-DOS root directories can come with a drive letter;
1441 ;; Novell Netware allows drive letters beyond `Z:'.
1451 filename)))
1454 "List of logical names for which visiting shouldn't save the true dirname.
1455 On VMS, when you visit a file using a logical name that searches a path,
1456 you may or may not want the visited file name to record the specific
1457 directory where the file was found. If you *do not* want that, add the logical
1458 name to this list as a string."
1463 "Return the buffer visiting file FILENAME (a string).
1464 This is like `get-file-buffer', except that it checks for any buffer
1465 visiting the same file, possibly under a different name.
1466 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1467 and others are ignored.
1468 If there is no such live buffer, return nil."
1482 found)
1492 ;; Verify this buffer's file number
1493 ;; still belongs to its file.
1496 attributes)
1500 found))))
1501 \f
1503 "Non-nil means file-visiting commands should handle wildcards.
1504 For example, if you specify `*.c', that would visit all the files
1505 whose names match the pattern."
1511 "Non-nil means suppress warning messages for symlinked files.
1512 When nil, Emacs prints a warning when visiting a file that is already
1513 visited, but with a different name. Setting this option to t
1514 suppresses this warning."
1520 "Maximum size of file above which a confirmation is requested.
1521 When nil, never request confirmation."
1528 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1529 OP-TYPE specifies the file operation being performed (for message to user)."
1539 "Read file FILENAME into a buffer and return the buffer.
1540 If a buffer exists visiting FILENAME, return that one, but
1541 verify that the file has not changed since visited or saved.
1542 The buffer is not selected, just returned to the caller.
1543 Optional second arg NOWARN non-nil means suppress any warning messages.
1544 Optional third arg RAWFILE non-nil means the file is read literally.
1545 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1546 and visit all the matching files. When wildcards are actually
1547 used and expanded, return a list of buffers that are visiting
1548 the various files."
1555 'find-directory-functions
1558 filename)))
1561 find-file-wildcards
1575 ;; Find any buffer for a file which has same truename.
1577 ;; Let user know if there is a buffer with the same truename.
1581 find-file-suppress-same-file-warnings
1585 ;; Optionally also find that buffer.
1588 ;; Check to see if the file looks uncommonly large.
1592 ;; We are using an existing buffer.
1599 ;; Certain files should be reverted automatically
1600 ;; if they have changed on disk and not in the buffer.
1608 found))
1618 "File %s changed on disk. Discard your edits? "
1623 "File %s changed on disk. Discard your edits in %s? "
1631 ;; Check if a formerly read-only file has become
1632 ;; writable and vice versa, but if the buffer agrees
1633 ;; with the new state of the file, that is ok too.
1641 buffer-file-name
1650 ;; It is confusing to ask whether to visit
1651 ;; non-literally if they have the file in
1652 ;; hexl-mode.
1658 "The file %s is already visited normally,
1659 and you have edited the buffer. Now you have asked to visit it literally,
1660 meaning no coding system handling, format conversion, or local variables.
1661 Emacs can only visit a file in one way at a time.
1663 Do you want to save the file, and visit it literally instead? "
1664 "The file %s is already visited literally,
1665 meaning no coding system handling, format conversion, or local variables.
1666 You have edited the buffer. Now you have asked to visit the file normally,
1667 but Emacs can only visit a file in one way at a time.
1674 rawfile truename number))
1678 "\
1679 Do you want to discard your changes, and visit the file literally now? "
1680 "\
1683 rawfile truename number)
1689 "The file %s is already visited normally.
1690 You have asked to visit it literally,
1691 meaning no coding system decoding, format conversion, or local variables.
1692 But Emacs can only visit a file in one way at a time.
1694 Do you want to revisit the file literally now? "
1695 "The file %s is already visited literally,
1696 meaning no coding system decoding, format conversion, or local variables.
1697 You have asked to visit it normally,
1698 but Emacs can only visit a file in one way at a time.
1703 rawfile truename number)
1706 ;; Return the buffer we are using.
1707 buf)
1708 ;; Create a new buffer.
1710 ;; find-file-noselect-1 may use a different buffer.
1712 rawfile truename number))))))
1718 ;; Needed in case we are re-visiting the file with a different
1719 ;; text representation.
1736 filename)))
1737 ;; Unconditionally set error
1747 filename)))
1748 ;; Run find-file-not-found-functions until one returns non-nil.
1750 ;; If they fail too, set error.
1752 ;; Record the file's truename, and maybe use that as visited name.
1758 ;; On VMS, we may want to remember which directory in a search list
1759 ;; the file was found in.
1769 ;; Set buffer's default directory to that of the file.
1771 ;; Turn off backup files for certain file names. Since
1772 ;; this is a permanent local, the major mode won't eliminate it.
1787 \f
1789 "Like `insert-file-contents', but only reads in the file literally.
1790 A buffer may be modified in several ways after reading into the buffer,
1791 to Emacs features such as format decoding, character code
1792 conversion, `find-file-hook', automatic uncompression, etc.
1794 This function ensures that none of these modifications will take place."
1802 nil))
1805 inhibit-file-name-handlers))
1818 filename)))
1819 ;; Check whether the file is uncommonly large
1830 "Insert contents of file FILENAME into buffer after point with no conversion.
1832 This function is meant for the user to run interactively.
1833 Don't call it from programs! Use `insert-file-contents-literally' instead.
1834 \(Its calling sequence is different; see its documentation)."
1839 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1844 "Visit file FILENAME with no conversion of any kind.
1845 Format conversion and character code conversion are both disabled,
1846 and multibyte characters are disabled in the resulting buffer.
1847 The major mode used is Fundamental mode regardless of the file name,
1848 and local variable specifications in the file are ignored.
1849 Automatic uncompression and adding a newline at the end of the
1850 file due to `require-final-newline' is also disabled.
1852 You cannot absolutely rely on this function to result in
1853 visiting the file literally. If Emacs already has a buffer
1854 which is visiting the file, you get the existing buffer,
1855 regardless of whether it was created literally or not.
1857 In a Lisp program, if you want to be sure of accessing a file's
1858 contents literally, you should create a temporary buffer and then read
1859 the file contents into it using `insert-file-contents-literally'."
1862 \f
1866 after-find-file-from-revert-buffer
1867 nomodes)
1868 "Called after finding a file and by the default revert function.
1869 Sets buffer mode, parses local variables.
1870 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1871 error in reading the file. WARN non-nil means warn if there
1872 exists an auto-save file more recent than the visited file.
1873 NOAUTO means don't mess with auto-save mode.
1874 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1875 means this call was from `revert-buffer'.
1876 Fifth arg NOMODES non-nil means don't alter the file's modes.
1877 Finishes by calling the functions in `find-file-hook'
1878 unless NOMODES is non-nil."
1881 nil
1891 ;; No need to warn if buffer is auto-saved
1892 ;; under the name of the visited file.
1894 auto-save-visited-file-name))
1897 buffer-file-name))
1917 ;; Make people do a little extra work (C-x C-q)
1918 ;; before altering a backup file.
1921 ;; When a file is marked read-only,
1922 ;; make the buffer read-only even if root is looking at it.
1930 ;; If requested, add a newline at the end of the file.
1940 view-read-only
1946 "Eval BODY and turn any error into a FORMAT message.
1947 FORMAT can have a %s escape which will be replaced with the actual error.
1948 If `debug-on-error' is set, errors are not caught, so that you can
1949 debug them.
1950 Avoid using a large BODY since it is duplicated."
1959 "Choose the major mode for this buffer automatically.
1960 Also sets up any specified local variables of the file.
1961 Uses the visited file name, the -*- line, and the local variables spec.
1963 This function is called automatically from `find-file'. In that case,
1964 we may set up the file-specified mode and local variables,
1965 depending on the value of `enable-local-variables'.
1966 In addition, if `local-enable-local-variables' is nil, we do
1967 not set local variables (though we do notice a mode specified with -*-.)
1969 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1970 or from Lisp without specifying the optional argument FIND-FILE;
1971 in that case, this function acts as if `enable-local-variables' were t."
1981 ;; Turn font lock off and on, to make sure it takes account of
1982 ;; whatever file local variables are relevant to it.
1984 ;; Font-lock-mode (now in font-core.el) can be ON when
1985 ;; font-lock.el still hasn't been loaded.
1995 "Non-nil means to try second pass through `auto-mode-alist'.
1996 This means that if the first case-sensitive search through the alist fails
1997 to find a matching major mode, a second case-insensitive search is made.
1998 On systems with case-insensitive file names, this variable is ignored,
1999 since only a single case-insensitive search through the alist is made."
2005 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2006 ;; c++-mode, java-mode and more) are added through autoload
2007 ;; directives in that file. That way is discouraged since it
2008 ;; spreads out the definition of the initial value.
2041 ;; Less common extensions come here
2042 ;; so more common ones above are found faster.
2081 ;; The list of archive file extensions should be in sync with
2082 ;; `auto-coding-alist' with `no-conversion' coding system.
2088 ;; Mailer puts message to be edited in
2089 ;; /tmp/Re.... or Message
2093 ;; some news reader is reported to use this
2102 ;; .emacs or .gnus or .viper following a directory delimiter in
2103 ;; Unix, MSDOG or VMS syntax.
2106 ;; _emacs following a directory delimiter
2107 ;; in MsDos syntax
2111 ;; Common Lisp ASDF package system.
2129 ;; Windows candidates may be opened case sensitively on Unix
2135 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2137 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2138 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2139 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2140 ;; this has lower priority to avoid matching changelog.sgml etc.
2142 ;; either user's dot-files or under /etc or some such
2144 ;; alas not all ~/.*rc files are like this
2145 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2150 ;; this contains everything twice, with space and with colon :-(
2152 ;; Get rid of any trailing .n.m and try again.
2153 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2154 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2155 ;; Using mode nil rather than `ignore' would let the search continue
2156 ;; through this list (with the shortened name) rather than start over.
2158 ;; The following should come after the ChangeLog pattern
2159 ;; for the sake of ChangeLog.1, etc.
2160 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2163 "Alist of filename patterns vs corresponding major mode functions.
2164 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2165 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2166 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2167 mode function to use. FUNCTION will be called, unless it is nil.
2169 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2170 calling FUNCTION (if it's not nil), we delete the suffix that matched
2171 REGEXP and search the list again for another match.
2173 If the file name matches `inhibit-first-line-modes-regexps',
2174 then `auto-mode-alist' is not processed.
2176 The extensions whose FUNCTION is `archive-mode' should also
2177 appear in `auto-coding-alist' with `no-conversion' coding system.
2179 See also `interpreter-mode-alist', which detects executable script modes
2180 based on the interpreters they specify to run,
2184 "Select Conf mode or XML mode according to start of file."
2194 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2195 ;; and pike-mode) are added through autoload directives in that
2196 ;; file. That way is discouraged since it spreads out the
2197 ;; definition of the initial value.
2235 "Alist mapping interpreter names to major modes.
2236 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2237 Each element looks like (INTERPRETER . MODE).
2238 If INTERPRETER matches the name of the interpreter specified in the first line
2239 of a script, mode MODE is enabled.
2247 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2248 When checking `inhibit-first-line-modes-regexps', we first discard
2254 "Regexp matching interpreters, for file mode determination.
2255 This regular expression is matched against the first line of a file
2256 to determine the file's mode in `set-auto-mode'. If it matches, the file
2257 is assumed to be interpreted by the interpreter matched by the second group
2258 of the regular expression. The mode is then determined as the mode
2262 "Alist of buffer beginnings vs. corresponding major mode functions.
2263 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2264 After visiting a file, if REGEXP matches the text at the beginning of the
2265 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2266 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2267 major mode.
2269 If FUNCTION is nil, then it is not called. (That is a way of saying
2275 ;; The < comes before the groups (but the first) to reduce backtracking.
2276 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2277 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2281 comment-re "*"
2284 . html-mode)
2286 ;; These two must come after html, because they are more general:
2291 . sgml-mode)
2294 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2295 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2296 After visiting a file, if REGEXP matches the text at the beginning of the
2297 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2298 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2299 have not specified a mode for this file.
2305 "Upper limit on `magic-mode-alist' regexp matches.
2309 "Select major mode appropriate for current buffer.
2311 To find the right major mode, this function checks for a -*- mode tag,
2312 checks if it uses an interpreter listed in `interpreter-mode-alist',
2313 matches the buffer beginning against `magic-mode-alist',
2314 compares the filename against the entries in `auto-mode-alist',
2315 then matches the buffer beginning against `magic-fallback-mode-alist'.
2317 It does not check for the `mode:' local variable in the
2318 Local Variables section of the file; for that, use `hack-local-variables'.
2320 If `enable-local-variables' is nil, this function does not check for a
2321 -*- mode tag.
2323 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2324 set the major mode only if that would change it. In other words
2325 we don't actually set it to the same mode the buffer already has."
2326 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2328 ;; Find a -*- mode tag
2335 ;; Find all specifications for the `mode:' variable
2336 ;; and execute them left to right.
2348 modes)))
2349 ;; Simple -*-MODE-*- case.
2352 modes))))
2353 ;; If we found modes to use, invoke them now, outside the save-excursion.
2361 ;; continuing would call minor modes again, toggling them off
2363 ;; If we didn't, look for an interpreter specified in the first line.
2364 ;; As a special case, allow for things like "#!/bin/env perl", which
2365 ;; finds the interpreter anywhere in $PATH.
2372 ;; Map interpreter name to a mode, signalling we're done at the
2373 ;; same time.
2375 interpreter-mode-alist))
2376 ;; If we found an interpreter mode to use, invoke it now.
2379 ;; Next try matching the buffer beginning against magic-mode-alist.
2393 ;; Next compare the filename against the entries in auto-mode-alist.
2398 ;; Remove remote file name identification.
2402 ;; Remove backup-suffixes from file name.
2405 ;; Find first matching alist entry.
2408 ;; System is case-insensitive.
2412 ;; System is case-sensitive.
2414 ;; First match case-sensitively.
2418 ;; Fallback to case-insensitive match.
2432 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2447 ;; When `keep-mode-if-same' is set, we are working on behalf of
2448 ;; set-visited-file-name. In that case, if the major mode specified is the
2449 ;; same one we already have, don't actually reset it. We don't want to lose
2450 ;; minor modes such as Font Lock.
2452 "Apply MODE and return it.
2453 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2454 any aliases and compared to current major mode. If they are the
2455 same, do nothing and return nil."
2461 mode)))
2464 "Find the -*- spec in the buffer.
2465 Call with point at the place to start searching from.
2466 If one is found, set point to the beginning
2467 and return the position of the end.
2468 Otherwise, return nil; point may be changed."
2471 ;; Don't look for -*- if this file name matches any
2472 ;; of the regexps in inhibit-first-line-modes-regexps.
2480 sufs)
2488 ;; If the file begins with "#!"
2489 ;; (exec interpreter magic), look
2490 ;; for mode frobs in the first two
2491 ;; lines. You cannot necessarily
2492 ;; put them in the first line of
2493 ;; such a file without screwing up
2494 ;; the interpreter invocation.
2495 ;; The same holds for
2496 ;; '\"
2497 ;; in man pages (preprocessor
2498 ;; magic for the `man' program).
2509 end))))
2510 \f
2511 ;;; Handling file local variables
2518 "Normal hook run after processing a file's local variables specs.
2519 Major modes can use this to examine user-specified local variables
2523 "List variable-value pairs that are considered safe.
2524 Each element is a cons cell (VAR . VAL), where VAR is a variable
2525 symbol and VAL is a value that is considered safe."
2530 "Expressions that are considered safe in an `eval:' local variable.
2531 Add expressions to this list if you want Emacs to evaluate them, when
2532 they appear in an `eval' local variable specification, without first
2533 asking you for confirmation."
2538 ;; Risky local variables:
2541 auto-mode-alist
2542 buffer-auto-save-file-name
2543 buffer-file-name
2544 buffer-file-truename
2545 buffer-undo-list
2546 dabbrev-case-fold-search
2547 dabbrev-case-replace
2548 debugger
2549 default-text-properties
2550 display-time-string
2551 enable-local-eval
2552 enable-local-variables
2553 eval
2554 exec-directory
2555 exec-path
2556 file-name-handler-alist
2557 font-lock-defaults
2558 format-alist
2559 frame-title-format
2560 global-mode-string
2561 header-line-format
2562 icon-title-format
2563 ignored-local-variables
2564 imenu--index-alist
2565 imenu-generic-expression
2566 inhibit-quit
2567 input-method-alist
2568 load-path
2569 max-lisp-eval-depth
2570 max-specpdl-size
2571 minor-mode-alist
2572 minor-mode-map-alist
2573 minor-mode-overriding-map-alist
2574 mode-line-buffer-identification
2575 mode-line-format
2576 mode-line-client
2577 mode-line-modes
2578 mode-line-modified
2579 mode-line-mule-info
2580 mode-line-position
2581 mode-line-process
2582 mode-line-remote
2583 mode-name
2584 outline-level
2585 overriding-local-map
2586 overriding-terminal-local-map
2587 parse-time-rules
2588 process-environment
2589 rmail-output-file-alist
2590 safe-local-variable-values
2591 safe-local-eval-forms
2592 save-some-buffers-action-alist
2593 special-display-buffer-names
2594 standard-input
2595 standard-output
2596 unread-command-events
2597 vc-mode))
2599 ;; Safe local variables:
2600 ;;
2601 ;; For variables defined by major modes, the safety declarations can go into
2602 ;; the major mode's file, since that will be loaded before file variables are
2603 ;; processed.
2604 ;;
2605 ;; For variables defined by minor modes, put the safety declarations in the
2606 ;; file defining the minor mode after the defcustom/defvar using an autoload
2607 ;; cookie, e.g.:
2608 ;;
2609 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2610 ;;
2611 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2612 ;; minor mode file may not be loaded yet.
2613 ;;
2614 ;; For variables defined in the C source code the declaration should go here:
2630 "Get confirmation before setting up local variable values.
2631 ALL-VARS is the list of all variables to be set up.
2632 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2633 RISKY-VARS is the list of those that are marked as risky.
2634 PROJECT is a directory name if these settings come from directory-local
2635 settings; nil otherwise."
2637 nil
2642 prompt char)
2652 ", and variables that are risky (**)."
2660 y -- to apply the local variables list.
2664 ! -- to apply the local variables list, and permanently mark these
2676 ;; Make strings with embedded whitespace easier to read.
2684 ""
2691 done)
2700 ;; read-event returns -1 if we are in a kbd
2701 ;; macro and there are no more events in the
2702 ;; macro. In that case, attempt to get an
2703 ;; event interactively.
2711 ;; When this is called from desktop-restore-file-buffer,
2712 ;; coding-system-for-read may be non-nil. Reset it before
2713 ;; writing to .emacs.
2717 'safe-local-variable-values
2718 safe-local-variable-values))))
2725 "Return local variables specified in the -*- line.
2726 Ignore any specification for `mode:' and `coding:';
2727 `set-auto-mode' should already have handled `mode:',
2728 `set-auto-coding' should already have handled `coding:'.
2730 If MODE-ONLY is non-nil, all we do is check whether the major
2731 mode is specified, returning t if it is specified. Otherwise,
2732 return an alist of elements (VAR . VAL), where VAR is a variable
2733 and VAL is the specified value."
2737 result mode-specified)
2738 ;; Parse the -*- line into the RESULT alist.
2739 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2741 nil)
2743 ;; Simple form: "-*- MODENAME -*-". Already handled.
2745 nil)
2747 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2748 ;; (last ";" is optional).
2753 ;; There used to be a downcase here,
2754 ;; but the manual didn't say so,
2755 ;; and people want to set var names that aren't all lc.
2760 ;; It is traditional to ignore
2761 ;; case when checking for `mode' in set-auto-mode,
2762 ;; so we must do that here as well.
2763 ;; That is inconsistent, but we're stuck with it.
2764 ;; The same can be said for `coding' in set-auto-coding.
2770 'eval
2777 mode-specified
2778 result))))
2781 "Apply an alist of local variable settings.
2782 RESULT is the alist.
2783 Will query the user when necessary."
2790 ;; Find those variables that we may want to save to
2791 ;; `safe-local-variable-values'.
2796 ;; Don't query about the fake variables.
2807 ;; If caller wants only the safe variables,
2808 ;; install only them.
2813 ;; Query, except in the case where all are known safe
2814 ;; if the user wants no query in that case.
2820 result unsafe-vars risky-vars project))
2825 "Parse and put into effect this buffer's local variables spec.
2826 If MODE-ONLY is non-nil, all we do is check whether the major mode
2827 is specified, returning t if it is specified."
2830 result)
2833 ;; Look for "Local variables:" line in last page.
2841 ;; suffix is what comes after "local variables:" in its line.
2842 ;; prefix is what comes before "local variables:" in its line.
2852 beg)
2856 endpos
2862 nil t))
2863 ;; This used to be an error, but really all it means is
2864 ;; that this may simply not be a local-variables section,
2865 ;; so just ignore it.
2875 ;; Discard the prefix.
2880 ;; Discard the suffix.
2888 ;; Find the variable name; strip whitespace.
2896 val)
2897 ;; Read the variable value.
2907 'eval
2913 ;; We've read all the local variables. Now, return whether the
2914 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2915 ;; variables (if MODE-ONLY is nil.)
2917 result
2922 "Non-nil if SYM is safe as a file-local variable with value VAL.
2923 It is safe if any of these conditions are met:
2925 * There is a matching entry (SYM . VAL) in the
2926 `safe-local-variable-values' user option.
2928 * The `safe-local-variable' property of SYM is a function that
2929 evaluates to a non-nil value with VAL as an argument."
2935 "Non-nil if SYM could be dangerous as a file-local variable.
2936 It is dangerous if either of these conditions are met:
2938 * Its `risky-local-variable' property is non-nil.
2944 ;; If this is an alias, check the base name.
2964 "Return t if it is safe to eval EXP when it is found in a file."
2966 ;; Detect certain `put' expressions.
2972 ;; Only allow safe values of lisp-indent-hook;
2973 ;; not functions.
2976 ;; Only allow indirect form specs.
2977 ;; During bootstrapping, edebug-basic-spec might not be
2978 ;; defined yet.
2982 ;; Allow expressions that the user requested.
2984 ;; Certain functions can be allowed with safe arguments
2985 ;; or can specify verification functions to try.
2993 ok))
3001 ok)))))))
3004 "Set local variable VAR with value VAL.
3005 If VAR is `mode', call `VAL-mode' as a function unless it's
3006 already the major mode."
3016 ;; Make sure the string has no text properties.
3017 ;; Some text properties can get evaluated in various ways,
3018 ;; so it is risky to put them on with a local variable list.
3022 \f
3023 ;;; Handling directory local variables, aka project settings.
3032 "Return the project variable list for project CLASS."
3036 "Collect local variable settings from MODE-ALIST.
3037 SETTINGS is the initial list of bindings.
3038 Returns the new list."
3045 ;; Need a new cons in case we setcdr later.
3049 "Collect entries from BINDING-LIST into SETTINGS.
3050 ROOT is the root directory of the project.
3051 Return the new settings list."
3059 ;; Don't include this in the previous condition, because we
3060 ;; want to filter all strings before the next condition.
3065 root settings))))
3069 settings))))))))
3072 "Declare that the project rooted at DIRECTORY is an instance of CLASS.
3073 DIRECTORY is the name of a directory, a string.
3074 CLASS is the name of a project class, a symbol.
3076 When a file beneath DIRECTORY is visited, the mode-specific
3077 settings from CLASS will be applied to the buffer. The settings
3078 for a class are defined using `define-project-bindings'."
3085 "Map the project type CLASS to a list of variable settings.
3086 CLASS is the project class, a symbol.
3087 LIST is a list that declares variable settings for the class.
3088 An element in LIST is either of the form:
3089 (MAJOR-MODE . ALIST)
3090 or
3091 (DIRECTORY . LIST)
3093 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3094 whose elements are of the form (VARIABLE . VALUE).
3096 In the second form, DIRECTORY is a directory name (a string), and
3097 LIST is a list of the form accepted by the function.
3099 When a file is visited, the file's class is found. A directory
3100 may be assigned a class using `set-directory-project'. Then
3101 variables are set in the file's buffer according to the class'
3102 LIST. The list is processed in order.
3104 * If the element is of the form (MAJOR-MODE . ALIST), and the
3105 buffer's major mode is derived from MAJOR-MODE (as determined
3106 by `derived-mode-p'), then all the settings in ALIST are
3107 applied. A MAJOR-MODE of nil may be used to match any buffer.
3108 `make-local-variable' is called for each variable before it is
3109 set.
3111 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3112 is an initial substring of the file's directory, then LIST is
3113 applied by recursively following these rules."
3120 "Find the settings file for FILE.
3121 This searches upward in the directory tree.
3122 If a settings file is found, the file name is returned.
3123 If the file is in a registered project, a cons from
3124 `project-directory-alist' is returned.
3125 Otherwise this returns nil."
3129 ;; `locate-dominating-file' may have abbreviated the name.
3139 settings pda)
3143 "Load a settings file and register a new project class and instance.
3144 SETTINGS-FILE is the name of the file holding the settings to apply.
3145 The new class name is the same as the directory in which SETTINGS-FILE
3146 is found. Returns the new class name."
3148 ;; We should probably store the modtime of SETTINGS-FILE and then
3149 ;; reload it whenever it changes.
3156 class-name)))
3161 "Set local variables in a buffer based on project settings."
3163 ;; Find the settings file.
3177 root-dir nil)))
3180 ;; Special case C and derived modes. Note that CC-based
3181 ;; modes don't work with derived-mode-p. In general I
3182 ;; think modes could use an auxiliary method which is
3183 ;; called after local variables are hacked.
3185 c-buffer-is-cc-mode
3188 \f
3191 However, the mode will not be changed if
3192 \(1) a local variables list or the `-*-' line specifies a major mode, or
3194 \ not suitable for ordinary files, or
3195 \(3) the new file name does not particularly specify any mode."
3200 "Change name of file visited in current buffer to FILENAME.
3201 This also renames the buffer to correspond to the new file.
3202 The next time the buffer is saved it will go in the newly specified file.
3203 FILENAME nil or an empty string means mark buffer as not visiting any file.
3204 Remember to delete the initial contents of the minibuffer
3205 if you wish to pass an empty string as the argument.
3207 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3208 confirmation in the case where another buffer is already visiting FILENAME.
3210 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3211 the old visited file has been renamed to the new name FILENAME."
3219 nil
3234 filename)))
3246 ;; If new-name == old-name, renaming would add a spurious <2>
3247 ;; and it's considered as a feature in rename-buffer.
3253 ;; Abbreviate the file names of the buffer.
3262 nil)))
3263 ;; write-file-functions is normally used for things like ftp-find-file
3264 ;; that visit things that are not local files as if they were files.
3265 ;; Changing to visit an ordinary local file instead should flush the hook.
3270 ;; If buffer was read-only because of version control,
3271 ;; that reason is gone now, so make it writable.
3275 ;; Turn off backup files for certain file names.
3276 ;; Since this is a permanent local, the major mode won't eliminate it.
3278 backup-enable-predicate
3284 ;; If auto-save was not already on, turn it on if appropriate.
3288 ;; If auto save is on, start using a new name.
3289 ;; We deliberately don't rename or delete the old auto save
3290 ;; for the old visited file name. This is because perhaps
3291 ;; the user wants to save the new state and then compare with the
3292 ;; previous state from the auto save file.
3295 ;; Rename the old auto save file if any.
3302 ;; Update the major mode, if the file name determines it.
3304 ;; Don't change the mode if it is special.
3307 ;; Don't change the mode if the local variable list specifies it.
3313 "Write current buffer into file FILENAME.
3314 This makes the buffer visit that file, and marks it as not modified.
3316 If you specify just a directory name as FILENAME, that means to use
3317 the default file name but in that directory. You can also yank
3318 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3320 If the buffer is not already visiting a file, the default file name
3321 for the output file is the buffer name.
3323 If optional second arg CONFIRM is non-nil, this function
3324 asks for confirmation before overwriting an existing file.
3325 Interactively, confirmation is required unless you supply a prefix argument."
3326 ;; (interactive "FWrite file: ")
3330 nil nil nil nil)
3334 default-directory)
3335 nil nil))
3339 ;; If arg is just a directory,
3340 ;; use the default file name, but in that directory.
3351 ;; Make buffer writable if file is writable.
3356 ;; It's likely that the VC status at the new location is different from
3357 ;; the one at the old location.
3359 \f
3361 "Make a backup of the disk file visited by the current buffer, if appropriate.
3362 This is normally done before saving the buffer the first time.
3364 A backup may be done by renaming or by copying; see documentation of
3365 variable `make-backup-files'. If it's done by renaming, then the file is
3366 no longer accessible under its old name.
3368 The value is non-nil after a backup was made by renaming.
3369 It has the form (MODES . BACKUPNAME).
3370 MODES is the result of `file-modes' on the original
3371 file; this means that the caller, after saving the buffer, should change
3372 the modes of the new file to agree with the old modes.
3373 BACKUPNAME is the backup file name, which is the old file renamed."
3380 backup-info backupname targets setmodes)
3381 ;; If specified name is a symbolic link, chase it to the target.
3382 ;; Thus we make the backups in the directory where the real file is.
3387 ;; (if (file-directory-p buffer-file-name)
3388 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3392 ;; If have old versions to maybe delete,
3393 ;; ask the user to confirm now, before doing anything.
3394 ;; But don't actually delete til later.
3399 real-file-name)))))
3401 ;; Actually write the back up file.
3404 ; (file-symlink-p buffer-file-name)
3405 backup-by-copying
3406 ;; Don't rename a suid or sgid file.
3421 ;; rename-file should delete old backup.
3425 ;; If trouble writing the backup, write it in ~.
3430 backupname)
3434 ;; Now delete the old versions, if desired.
3441 setmodes)
3448 ;; Create temp files with strict access rights. It's easy to
3449 ;; loosen them later, whereas it's impossible to close the
3450 ;; time-window of loose permissions otherwise.
3453 ;; Try to overwrite old backup first.
3461 nil)
3463 ;; The file was somehow created by someone else between
3464 ;; `delete-file' and `copy-file', so let's try again.
3465 ;; rms says "I think there is also a possible race
3466 ;; condition for making backup files" (emacs-devel 20070821).
3467 nil)))
3468 ;; Reset the umask.
3474 "Return file NAME sans backup versions or strings.
3475 This is a separate procedure so your site-init or startup file can
3476 redefine it.
3477 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3478 we do not remove backup version numbers, only true file version numbers."
3484 ;; VMS version number is (a) semicolon, optional
3485 ;; sign, zero or more digits or (b) period, option
3486 ;; sign, zero or more digits, provided this is the
3487 ;; second period encountered outside of the
3488 ;; device/directory part of the file name.
3491 name)
3501 "Return t if deleting FILE and rewriting it would preserve the owner."
3506 ;; Return t if the file doesn't exist, since it's true that no
3507 ;; information would be lost by an (attempted) delete and create.
3513 The extension, in a file name, is the part that follows the last `.',
3514 except that a leading `.', if any, doesn't count."
3517 directory)
3521 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3522 ;; we don't want to expand it.
3525 filename))))
3529 The extension, in a file name, is the part that follows the last `.',
3530 excluding version numbers and backup suffixes,
3531 except that a leading `.', if any, doesn't count.
3532 Return nil for extensionless file names such as `foo'.
3533 Return the empty string for file names such as `foo.'.
3535 If PERIOD is non-nil, then the returned value includes the period
3536 that delimits the extension, and if FILENAME has no extension,
3547 "A function to use instead of the default `make-backup-file-name'.
3548 A value of nil gives the default `make-backup-file-name' behavior.
3550 This could be buffer-local to do something special for specific
3551 files. If you define it, you may need to change `backup-file-name-p'
3552 and `file-name-sans-versions' too.
3554 See also `backup-directory-alist'."
3560 "Alist of filename patterns and backup directory names.
3561 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3562 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3563 relative or absolute. If it is absolute, so that all matching files
3564 are backed up into the same directory, the file names in this
3565 directory will be the full name of the file backed up with all
3566 directory separators changed to `!' to prevent clashes. This will not
3567 work correctly if your filesystem truncates the resulting name.
3569 For the common case of all backups going into one directory, the alist
3571 directory name.
3573 If this variable is nil, or it fails to match a filename, the backup
3574 is made in the original file's directory.
3576 On MS-DOS filesystems without long names this variable is always
3577 ignored."
3583 "Default `backup-enable-predicate' function.
3584 Checks for files in `temporary-file-directory',
3585 `small-temporary-file-directory', and /tmp."
3588 ;; Directory is under temporary-file-directory.
3593 ;; Directory is under /tmp.
3598 0 nil
3600 ;; Directory is under small-temporary-file-directory.
3605 "Create the non-numeric backup file name for FILE.
3606 Normally this will just be the file's name with `~' appended.
3607 Customization hooks are provided as follows.
3609 If the variable `make-backup-file-name-function' is non-nil, its value
3610 should be a function which will be called with FILE as its argument;
3611 the resulting name is used.
3613 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3614 the documentation of that variable. If the directory for the backup
3615 doesn't exist, it is created."
3629 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3631 elt backup-directory abs-backup-directory)
3636 alist nil)))
3637 ;; If backup-directory is relative, it should be relative to the
3638 ;; file's directory. By expanding explicitly here, we avoid
3639 ;; depending on default-directory.
3648 abs-backup-directory nil))))
3650 file
3654 ;; Normalize DOSish file names: downcase the drive
3655 ;; letter, if any, and replace the leading "x:" with
3656 ;; "/drive_x".
3659 ;; Replace any invalid file-name characters (for the
3660 ;; case of backing up remote files).
3664 "drive_"
3667 ""
3670 ;; Make the name unique by substituting directory
3671 ;; separators. It may not really be worth bothering about
3672 ;; doubling `!'s in the original name...
3677 backup-directory))
3682 "Return non-nil if FILE is a backup file name (numeric or not).
3683 This is a separate function so you can redefine it for customization.
3684 You may need to redefine `file-name-sans-versions' as well."
3689 ;; This is used in various files.
3690 ;; The usage of backup-extract-version-start is not very clean,
3691 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3693 "Given the name of a numeric backup file, FN, return the backup number.
3694 Uses the free variable `backup-extract-version-start', whose value should be
3695 the index in the name where the version number begins."
3701 ;; I believe there is no need to alter this behavior for VMS;
3702 ;; since backup files are not made on VMS, it should not get called.
3704 "Find a file name for a backup file FN, and suggestions for deletions.
3705 Value is a list whose car is the name for the backup file
3706 and whose cdr is a list of old versions to consider deleting now.
3707 If the value is nil, don't make a backup.
3708 Uses `backup-directory-alist' in the same way as does
3709 `make-backup-file-name'."
3711 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3715 ;; We don't support numbered backups on plain MS-DOS
3716 ;; when long file names are unavailable.
3726 possibilities deserve-versions-p versions)
3729 base-versions
3732 possibilities)
3733 #'<)
3738 kept-old-versions
3739 kept-new-versions
3746 ;; Delete nothing if there is overflow
3747 ;; in the number of versions to keep.
3753 v))))))))))
3756 "Return number of names file FILENAME has."
3759 ;; (defun file-relative-name (filename &optional directory)
3760 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3761 ;; This function returns a relative file name which is equivalent to FILENAME
3762 ;; when used with that default directory as the default.
3763 ;; If this is impossible (which can happen on MSDOS and Windows
3764 ;; when the file name and directory use different drive names)
3765 ;; then it returns FILENAME."
3766 ;; (save-match-data
3767 ;; (let ((fname (expand-file-name filename)))
3768 ;; (setq directory (file-name-as-directory
3769 ;; (expand-file-name (or directory default-directory))))
3770 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3771 ;; ;; drive names, they can't be relative, so return the absolute name.
3772 ;; (if (and (or (eq system-type 'ms-dos)
3773 ;; (eq system-type 'cygwin)
3774 ;; (eq system-type 'windows-nt))
3775 ;; (not (string-equal (substring fname 0 2)
3776 ;; (substring directory 0 2))))
3777 ;; filename
3778 ;; (let ((ancestor ".")
3779 ;; (fname-dir (file-name-as-directory fname)))
3780 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3781 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3782 ;; (setq directory (file-name-directory (substring directory 0 -1))
3783 ;; ancestor (if (equal ancestor ".")
3784 ;; ".."
3785 ;; (concat "../" ancestor))))
3786 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3787 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3788 ;; ;; We matched within FNAME's directory part.
3789 ;; ;; Add the rest of FNAME onto ANCESTOR.
3790 ;; (let ((rest (substring fname (match-end 0))))
3791 ;; (if (and (equal ancestor ".")
3792 ;; (not (equal rest "")))
3793 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3794 ;; rest
3795 ;; (concat (file-name-as-directory ancestor) rest)))
3796 ;; ;; We matched FNAME's directory equivalent.
3797 ;; ancestor))))))
3800 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3801 This function returns a relative file name which is equivalent to FILENAME
3802 when used with that default directory as the default.
3803 If FILENAME and DIRECTORY lie on different machines or on different drives
3804 on a DOS/Windows machine, it returns FILENAME in expanded form."
3808 default-directory))))
3814 ;; Test for different drives on DOS/Windows
3816 ;; Should `cygwin' really be included here? --stef
3819 ;; Test for different remote file system identification
3821 filename
3827 directory nil nil case-fold-search))
3829 directory nil nil case-fold-search))))
3832 ".."
3834 ;; Now ancestor is empty, or .., or ../.., etc.
3836 directory nil nil case-fold-search))
3837 ;; We matched within FILENAME's directory part.
3838 ;; Add the rest of FILENAME onto ANCESTOR.
3841 ;; But don't bother with ANCESTOR if it would give us `./'.
3842 rest
3844 ;; We matched FILENAME's directory equivalent.
3845 ancestor))))))
3846 \f
3848 "Save current buffer in visited file if modified.
3849 Variations are described below.
3851 By default, makes the previous version into a backup file
3852 if previously requested or if this is the first save.
3854 to become a backup when the next save is done.
3856 unconditionally makes the previous version into a backup file.
3858 to become a backup when the next save is done,
3859 and unconditionally makes the previous version into a backup file.
3861 With a numeric argument of 0, never make the previous version
3862 into a backup file.
3864 If a file's name is FOO, the names of its numbered backup versions are
3865 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3866 Numeric backups (rather than FOO~) will be made if value of
3867 `version-control' is not the atom `never' and either there are already
3868 numeric versions of the file being backed up, or `version-control' is
3869 non-nil.
3870 We don't want excessive versions piling up, so there are variables
3871 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3872 and `kept-new-versions', which tells how many newest versions to keep.
3873 Defaults are 2 old versions and 2 new.
3874 `dired-kept-versions' controls dired's clean-directory (.) command.
3875 If `delete-old-versions' is nil, system will query user
3876 before trimming versions. Otherwise it does it silently.
3878 If `vc-make-backup-files' is nil, which is the default,
3879 no backup files are made for files managed by version control.
3880 (This is because the version control system itself records previous versions.)
3882 See the subroutine `basic-save-buffer' for more information."
3895 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3896 Normally delete only if the file was written by this Emacs since
3897 the last real save, but optional arg FORCE non-nil means delete anyway."
3911 "Normal hook that is run before a buffer is saved to its file."
3917 "Normal hook that is run after a buffer is saved to its file."
3923 "If non-nil, use this coding system for saving the buffer.
3924 More precisely, use this coding system in place of the
3925 value of `buffer-file-coding-system', when saving the buffer.
3926 Calling `write-region' for any purpose other than saving the buffer
3927 will still use `buffer-file-coding-system'; this variable has no effect
3934 "Save the current buffer in its visited file, if it has been modified.
3935 The hooks `write-contents-functions' and `write-file-functions' get a chance
3936 to do the job of saving; if they do not, then the buffer is saved in
3937 the visited file in the usual way.
3938 Before and after saving the buffer, this function runs
3939 `before-save-hook' and `after-save-hook', respectively."
3942 ;; In an indirect buffer, save its base buffer instead.
3947 setmodes)
3948 ;; On VMS, rename file and buffer to get rid of version number.
3953 ;; Strip VMS version number before save.
3956 ;; Construct a (unique) buffer name to correspond.
3961 ;; If buffer has no file name, ask user for one.
3968 ;; Signal an error if the user specified the name of an
3969 ;; existing directory.
3972 filename))
3974 ;; Signal an error if the specified name refers to a
3975 ;; non-existing directory.
4005 ;; Support VC version backups.
4011 ;; If a hook returned t, file is already "written".
4012 ;; Otherwise, write it the usual way now.
4014 ;; Now we have saved the current buffer. Let's make sure
4015 ;; that buffer-file-coding-system is fixed to what
4016 ;; actually used for saving by binding it locally.
4026 ;; If the auto-save file was recent before this command,
4027 ;; delete it now.
4029 ;; Support VC `implicit' locking.
4034 ;; This does the "real job" of writing a buffer into its visited file
4035 ;; and making a backup file. This is what is normally done
4036 ;; but inhibited if one of write-file-functions returns non-nil.
4037 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4046 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4060 buffer-file-name)))
4068 ;; If file is precious, write temp name, then rename it.
4069 ;; This requires write access to the containing dir,
4070 ;; which is why we don't try it if we don't have that access.
4072 tempname succeed
4075 ;; Create temp files with strict access rights. It's easy to
4076 ;; loosen them later, whereas it's impossible to close the
4077 ;; time-window of loose permissions otherwise.
4082 ;; Try various temporary names.
4083 ;; This code follows the example of make-temp-file,
4084 ;; but it calls write-region in the appropriate way
4085 ;; for saving the buffer.
4091 ;; Pass in nil&nil rather than point-min&max
4092 ;; cause we're saving the whole buffer.
4093 ;; write-region-annotate-functions may use it.
4095 tempname nil realname
4097 nil)
4099 ;; The file was somehow created by someone else between
4100 ;; `make-temp-name' and `write-region', let's try again.
4101 nil)
4103 ;; Reset the umask.
4105 ;; If we failed, restore the buffer's modtime.
4108 ;; Since we have created an entirely new file,
4109 ;; make sure it gets the right permission bits set.
4113 buffer-file-name)))
4114 ;; We succeeded in writing the temp file,
4115 ;; so rename it.
4117 ;; If file not writable, see if we can make it writable
4118 ;; temporarily while we write it.
4119 ;; But no need to do so if we have just backed it up
4120 ;; (setmodes is set) because that says we're superseding.
4122 ;; Change the mode back, after writing.
4128 ;; Pass in nil&nil rather than point-min&max to indicate
4129 ;; we're saving the buffer rather than just a region.
4130 ;; write-region-annotate-functions may make us of it.
4132 buffer-file-name nil t buffer-file-truename)
4134 ;; If we get an error writing the new file, and we made
4135 ;; the backup by renaming, undo the backing-up.
4140 setmodes))
4143 "View the differences between BUFFER and its associated file.
4144 This requires the external program `diff' to be in your `exec-path'."
4158 ;; Display that message for 1 second so that user can read it
4159 ;; in the minibuffer.
4161 ;; return always nil, so that save-buffers-kill-emacs will not move
4162 ;; over to the next unsaved buffer when calling `d'.
4163 nil)
4166 '((?\C-r
4172 ;; Return nil to ask about BUF again.
4173 nil)
4181 nil)
4190 "Save some modified file-visiting buffers. Asks user about each one.
4191 You can answer `y' to save, `n' not to save, `C-r' to look at the
4192 buffer in question with `view-buffer' before deciding or `d' to
4193 view the differences using `diff-buffer-with-file'.
4195 Optional argument (the prefix) non-nil means save all with no questions.
4196 Optional second argument PRED determines which buffers are considered:
4197 If PRED is nil, all the file-visiting buffers are considered.
4198 If PRED is t, then certain non-file buffers will also be considered.
4199 If PRED is a zero-argument function, it indicates for each buffer whether
4200 to consider it or not when called with that buffer current.
4202 See `save-some-buffers-action-alist' if you want to
4203 change the additional actions you can take on files."
4207 files-done abbrevs-done)
4209 ;; First save any buffers that we're supposed to save unconditionally.
4210 ;; That way the following code won't ask about them.
4215 ;; Ask about those buffers that merit it,
4216 ;; and record the number thus saved.
4232 t
4245 save-some-buffers-action-alist))
4246 ;; Maybe to save abbrevs, and record whether
4247 ;; we either saved them or asked to.
4253 abbrev-file-name)))
4255 ;; Don't keep bothering user if he says no.
4260 "(Some special files were saved without asking)"
4262 \f
4264 "Mark current buffer as unmodified, not needing to be saved.
4267 It is not a good idea to use this function in Lisp programs, because it
4268 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4275 "Change whether this buffer is visiting its file read-only.
4276 With prefix argument ARG, make the buffer read-only if ARG is
4277 positive, otherwise make it writable. If visiting file read-only
4278 and `view-read-only' is non-nil, enter view mode."
4283 nil ; do nothing.
4284 ;; Toggle.
4291 ;; If view-mode is already active, `view-mode-enter' is a nop.
4303 "Insert contents of file FILENAME into buffer after point.
4304 Set mark after the inserted text.
4306 This function is meant for the user to run interactively.
4307 Don't call it from programs! Use `insert-file-contents' instead.
4308 \(Its calling sequence is different; see its documentation)."
4313 "Append the contents of the region to the end of file FILENAME.
4314 When called from a function, expects three arguments,
4315 START, END and FILENAME. START and END are buffer positions
4316 saying what text to write."
4321 "Return most recent backup file for FILENAME or nil if no backups exist."
4322 ;; `make-backup-file-name' will get us the right directory for
4323 ;; ordinary or numeric backups. It might create a directory for
4324 ;; backups as a side-effect, according to `backup-directory-alist'.
4331 tem)
4340 newest))
4343 "Rename current buffer to a similar name not already taken.
4344 This function is useful for creating multiple shell process buffers
4345 or multiple mail buffers, etc."
4353 ;; If the existing buffer name has a <NNN>,
4354 ;; which isn't part of the file name (if any),
4355 ;; then get rid of that.
4361 "Create the directory DIR and any nonexistent parent dirs.
4362 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4364 Interactively, the default choice of directory to create
4365 is the current default directory for file names.
4366 That is useful when you have visited a file in a nonexistent directory.
4368 Noninteractively, the second (optional) argument PARENTS says whether
4369 to create parent directories if they don't exist. Interactively,
4370 this happens by default."
4373 nil nil)
4374 t))
4375 ;; If default-directory is a remote directory,
4376 ;; make sure we find its make-directory handler.
4384 create-list)
4391 \f
4394 "Function to use to revert this buffer, or nil to do the default.
4395 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4400 "Function to use to insert contents when reverting this buffer.
4401 Gets two args, first the nominal file name to use,
4402 and second, t if reading the auto-save file.
4407 "Function to check whether a non-file buffer needs reverting.
4408 This should be a function with one optional argument NOCONFIRM.
4409 Auto Revert Mode passes t for NOCONFIRM. The function should return
4410 non-nil if the buffer should be reverted. A return value of
4411 `fast' means that the need for reverting was not checked, but
4412 that reverting the buffer is fast. The buffer is current when
4413 this function is called.
4415 The idea behind the NOCONFIRM argument is that it should be
4416 non-nil if the buffer is going to be reverted without asking the
4417 user. In such situations, one has to be careful with potentially
4418 time consuming operations.
4420 For more information on how this variable is used by Auto Revert mode,
4424 "Normal hook for `revert-buffer' to run before reverting.
4425 If `revert-buffer-function' is used to override the normal revert
4429 "Normal hook for `revert-buffer' to run after reverting.
4430 Note that the hook value that it runs is the value that was in effect
4431 before reverting; that makes a difference if you have buffer-local
4432 hook functions.
4434 If `revert-buffer-function' is used to override the normal revert
4440 "Replace current buffer text with the text of the visited file on disk.
4441 This undoes all changes since the file was visited or saved.
4442 With a prefix argument, offer to revert from latest auto-save file, if
4443 that is more recent than the visited file.
4445 This command also implements an interface for special buffers
4446 that contain text which doesn't come from a file, but reflects
4447 some other data instead (e.g. Dired buffers, `buffer-list'
4448 buffers). This is done via the variable
4449 `revert-buffer-function'. In these cases, it should reconstruct
4450 the buffer contents from the appropriate data.
4452 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4453 to revert from the auto-save file when this is nil. Note that the
4454 sense of this argument is the reverse of the prefix argument, for the
4455 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4456 to nil.
4458 Optional second argument NOCONFIRM means don't ask for confirmation at
4459 all. \(The variable `revert-without-query' offers another way to
4460 revert buffers without querying for confirmation.)
4462 Optional third argument PRESERVE-MODES non-nil means don't alter
4463 the files modes. Normally we reinitialize them using `normal-mode'.
4465 If the value of `revert-buffer-function' is non-nil, it is called to
4466 do all the work for this command. Otherwise, the hooks
4467 `before-revert-hook' and `after-revert-hook' are run at the beginning
4468 and the end, and if `revert-buffer-insert-file-contents-function' is
4469 non-nil, it is called instead of rereading visited file contents."
4471 ;; I admit it's odd to reverse the sense of the prefix argument, but
4472 ;; there is a lot of code out there which assumes that the first
4473 ;; argument should be t to avoid consulting the auto-save file, and
4474 ;; there's no straightforward way to encourage authors to notice a
4475 ;; reversal of the argument sense. So I'm just changing the user
4476 ;; interface, but leaving the programmatic interface the same.
4484 buffer-auto-save-file-name
4489 buffer-auto-save-file-name
4490 buffer-file-name)))
4500 file-name)))
4502 ;; If file was backed up but has changed since,
4503 ;; we shd make another backup.
4507 ;; Effectively copy the after-revert-hook status,
4508 ;; since after-find-file will clobber it.
4511 after-revert-hook))
4516 ;; Get rid of all undo records for this buffer.
4518 ;; Don't make undo records for the reversion.
4521 file-name auto-save-p)))
4524 "File %s no longer exists!"
4526 file-name))
4529 "File %s no longer readable!"
4531 file-name))
4533 ;; Bind buffer-file-name to nil
4534 ;; so that we don't try to lock the file.
4540 ;; Auto-saved file should be read by Emacs'
4541 ;; internal coding.
4544 buffer-file-coding-system-explicit))))
4546 coding-system-for-read
4548 coding-system-for-read)
4550 ;; As a coding system suitable for multibyte
4551 ;; buffer is specified, make the current
4552 ;; buffer multibyte.
4555 ;; This force after-insert-file-set-coding
4556 ;; (called from insert-file-contents) to set
4557 ;; buffer-file-coding-system to a proper value.
4560 ;; Note that this preserves point in an intelligent way.
4564 nil nil t))
4566 nil nil t)))))
4567 ;; Recompute the truename in case changes in symlinks
4568 ;; have changed the truename.
4572 ;; Run after-revert-hook as it was before we reverted.
4576 local-hook)
4579 t))))))
4582 "Recover the visited file--get contents from its last auto-save file."
4587 "Visit file FILE, but get contents from its last auto-save file."
4588 ;; Actually putting the file name in the minibuffer should be used
4589 ;; only rarely.
4590 ;; Not just because users often use the default.
4610 ;; Use insert-directory-safely, not insert-directory,
4611 ;; because these files might not exist. In particular,
4612 ;; FILE might not exist if the auto-save file was for
4613 ;; a buffer that didn't visit a file, such as "*mail*".
4614 ;; The code in v20.x called `ls' directly, so we need
4615 ;; to emulate what `ls' did in that case.
4621 ;; Keep the current buffer-file-coding-system.
4623 ;; Auto-saved file should be read with special coding.
4632 "Recover auto save files from a previous Emacs session.
4633 This command first displays a Dired buffer showing you the
4634 previous sessions that you could recover from.
4635 To choose one, move point to the proper line and then type C-c C-c.
4636 Then you'll be asked about a number of files to recover."
4646 auto-save-list-file-prefix)))
4647 t)
4656 ;; Each line starts with a space
4657 ;; so that Font Lock mode won't highlight the first character.
4666 "Choose one saved session to recover auto-save files from.
4667 This command is used in the special Dired buffer created by
4670 ;; Get the name of the session file to recover from.
4672 files
4678 ;; Read in the auto-save-list file.
4682 ;; Loop thru the text of that file
4683 ;; and get out the names of the files to recover.
4687 ;; This is a pair of lines for a non-file-visiting buffer.
4688 ;; Get the auto-save file name and manufacture
4689 ;; a "visited file name" from that.
4692 ;; If there is no auto-save file name, the
4693 ;; auto-save-list file is probably corrupted.
4706 ;; This pair of lines is a file-visiting
4707 ;; buffer. Use the visited file name.
4717 ;; Ignore a file if its auto-save file does not exist now.
4721 ;; The file contains a pair of line for each auto-saved buffer.
4722 ;; The first line of the pair contains the visited file name
4723 ;; or is empty if the buffer was not visiting a file.
4724 ;; The second line is the auto-save file name.
4732 files
4738 "Kill buffer if confirmed."
4746 "Kill some buffers. Asks the user whether to kill each one of them.
4747 Non-interactively, if optional argument LIST is non-nil, it
4748 specifies the list of buffers to kill, asking for approval for each one."
4756 ; if we killed the base buffer.
4763 "Kill buffers whose name matches the specified regexp.
4764 The optional second argument indicates whether to kill internal buffers too."
4773 \f
4775 "Toggle auto-saving of contents of current buffer.
4776 With prefix argument ARG, turn auto-saving on if positive, else off."
4781 ;; If auto-save is off because buffer has shrunk,
4782 ;; then toggling should turn it on.
4787 buffer-file-name
4789 ;; If -1 was stored here, to temporarily turn off saving,
4790 ;; turn it back on.
4796 buffer-auto-save-file-name)
4799 "Adjust current buffer's auto save file name for current conditions.
4800 Also rename any existing auto save file, if it was made in this session."
4812 "Return file name to use for auto-saves of current buffer.
4813 Does not consider `auto-save-visited-file-name' as that variable is checked
4814 before calling this function. You can redefine this for customization.
4815 See also `auto-save-file-name-p'."
4823 result uniq)
4824 ;; Apply user-specified translations
4825 ;; to the file name.
4829 filename)
4839 filename))))
4844 ;; We truncate the file name to DOS 8+3 limits
4845 ;; before doing anything else, because the regexp
4846 ;; passed to string-match below cannot handle
4847 ;; extensions longer than 3 characters, multiple
4848 ;; dots, and other atrocities.
4853 fn)
4858 "#"
4861 ;; Make sure auto-save file names don't contain characters
4862 ;; invalid for the underlying filesystem.
4864 ;; Don't modify remote (ange-ftp) filenames
4867 result))))
4869 ;; Deal with buffers that don't have any associated files. (Mail
4870 ;; mode tends to create a good number of these.)
4874 file-name)
4875 ;; Restrict the characters used in the file name to those which
4876 ;; are known to be safe on all filesystems, url-encoding the
4877 ;; rest.
4878 ;; We do this on all platforms, because even if we are not
4879 ;; running on DOS/Windows, the current directory may be on a
4880 ;; mounted VFAT filesystem, such as a USB memory stick.
4884 ;; For multibyte characters, this will produce more than
4885 ;; 2 hex digits, so is not true URL encoding.
4889 ;; Generate the file name.
4895 ;; Try a few alternative directories, to get one we can
4896 ;; write it.
4902 ;; Don't modify remote (ange-ftp) filenames
4904 ;; The call to convert-standard-filename is in case
4905 ;; buffer-name includes characters not allowed by the
4906 ;; DOS/Windows filesystems. make-temp-file writes to the
4907 ;; file it creates, so we must fix the file name _before_
4908 ;; make-temp-file is called.
4910 fname))
4912 ;; make-temp-file creates the file,
4913 ;; but we don't want it to exist until we do an auto-save.
4917 file-name)))
4920 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4921 FILENAME should lack slashes. You can redefine this for customization."
4923 \f
4925 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4926 The generated regexp will match a filename only if the filename
4927 matches that wildcard according to shell rules. Only wildcards known
4928 by `sh' are supported."
4930 ;; Copy the initial run of non-special characters.
4933 ;; If no special characters, we're almost done.
4937 j)
4939 result
4960 ;; Found "[^". Insert a `\0' character
4961 ;; (which cannot happen in a filename)
4962 ;; into the character class, so that `^'
4963 ;; is not the first character after `[',
4964 ;; and thus non-special in a regexp.
4969 ;; I don't think `]' can appear in a
4970 ;; character class in a wildcard, but
4971 ;; let's be general here.
4978 i
4991 ;; Shell wildcards should match the entire filename,
4992 ;; not its part. Make the regexp say so.
4994 \f
4997 "Switches for `list-directory' to pass to `ls' for brief listing."
5003 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
5005 "Switches for `list-directory' to pass to `ls' for verbose listing."
5010 "Expand wildcard pattern PATTERN.
5011 This returns a list of file names which match the pattern.
5013 If PATTERN is written as an absolute file name,
5014 the values are absolute also.
5016 If PATTERN is written as a relative file name, it is interpreted
5017 relative to the current default directory, `default-directory'.
5018 The file names returned are normally also relative to the current
5019 default directory. However, if FULL is non-nil, they are absolute."
5023 ;; A list of all dirs that DIRPART specifies.
5024 ;; This can be more than one dir
5025 ;; if DIRPART contains wildcards.
5030 contents)
5035 ;; Filter out "." and ".."
5040 name))
5047 this-dir-contents)
5048 this-dir-contents)
5049 contents))))
5051 contents)))
5054 "Display a list of files in or matching DIRNAME, a la `ls'.
5055 DIRNAME is globbed by the shell if necessary.
5056 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5057 Actions controlled by variables `list-directory-brief-switches'
5058 and `list-directory-verbose-switches'."
5062 nil default-directory nil)
5063 pfx)))
5065 list-directory-brief-switches))
5066 buffer)
5079 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5087 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5089 PATTERN is assumed to represent a file-name wildcard suitable for the
5090 underlying filesystem. For Unix and GNU/Linux, the characters from the
5092 the parts of the pattern which don't include wildcard characters are
5093 quoted with double quotes.
5094 Existing quote characters in PATTERN are left alone, so you can pass
5095 PATTERN that already quotes some of the special characters."
5099 ;; DOS/Windows don't allow `"' in file names. So if the
5100 ;; argument has quotes, we can safely assume it is already
5101 ;; quoted by the caller.
5103 ;; We quote [&()#$'] in case their shell is a port of a
5104 ;; Unixy shell. We quote [,=+] because stock DOS and
5105 ;; Windows shells require that in some cases, such as
5106 ;; passing arguments to batch files that use positional
5107 ;; arguments like %1.
5109 pattern
5112 end)
5129 pattern))))
5136 "Program to get the amount of free space on a file system.
5137 We assume the output has the format of `df'.
5138 The value of this variable must be just a command name or file name;
5139 if you want to specify options, use `directory-free-space-args'.
5141 A value of nil disables this feature.
5143 If the function `file-system-info' is defined, it is always used in
5144 preference to the program given by this variable."
5150 "Options to use when running `directory-free-space-program'."
5155 "Return the amount of free space on directory DIR's file system.
5156 The result is a string that gives the number of free 1KB blocks,
5157 or nil if the system call or the program which retrieve the information
5158 fail. It returns also nil when DIR is a remote directory.
5160 This function calls `file-system-info' if it is available, or invokes the
5161 program specified by `directory-free-space-program' if that is non-nil."
5163 ;; Try to find the number of free blocks. Non-Posix systems don't
5164 ;; always have df, but might have an equivalent system call.
5173 nil t nil
5174 directory-free-space-args
5175 dir)))
5176 ;; Usual format is a header line followed by a line of
5177 ;; numbers.
5182 ;; Move to the end of the "available blocks" number.
5185 ;; Copy it into AVAILABLE.
5190 ;; The following expression replaces `dired-move-to-filename-regexp'.
5194 ;; In some locales, month abbreviations are as short as 2 letters,
5195 ;; and they can be followed by ".".
5196 ;; In Breton, a month name can include a quote character.
5209 s "+"
5212 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5213 ;; omits the Kanji characters after month and day-of-month.
5214 ;; On Mac OS X 10.3, the date format in East Asian locales is
5215 ;; day-of-month digits followed by month digits.
5221 ;; The "[0-9]" below requires the previous column to end in a digit.
5222 ;; This avoids recognizing `1 may 1997' as a date in the line:
5223 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5225 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5226 ;; The ".*" below finds the last match if there are multiple matches.
5227 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5228 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5230 ;; vc dired listings provide the state or blanks between file
5231 ;; permissions and date. The state is always surrounded by
5232 ;; parantheses:
5233 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5234 ;; This is not supported yet.
5238 "Regular expression to match up to the file name in a directory listing.
5239 The default value is designed to recognize dates and times
5244 ;; insert-directory
5245 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5246 ;; FULL-DIRECTORY-P is nil.
5247 ;; The single line of output must display FILE's name as it was
5248 ;; given, namely, an absolute path name.
5249 ;; - must insert exactly one line for each file if WILDCARD or
5250 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5251 ;; before the file lines, plus optional text after the file lines.
5252 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5253 ;; allowed.
5254 ;; File lines should display the basename.
5255 ;; - must be consistent with
5256 ;; - functions dired-move-to-filename, (these two define what a file line is)
5257 ;; dired-move-to-end-of-filename,
5258 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5259 ;; dired-insert-headerline
5260 ;; dired-after-subdir-garbage (defines what a "total" line is)
5261 ;; - variable dired-subdir-regexp
5262 ;; - may be passed "--dired" as the first argument in SWITCHES.
5263 ;; Filename handlers might have to remove this switch if their
5264 ;; "ls" command does not support it.
5266 "Insert directory listing for FILE, formatted according to SWITCHES.
5267 Leaves point after the inserted text.
5268 SWITCHES may be a string of options, or a list of strings
5269 representing individual options.
5270 Optional third arg WILDCARD means treat FILE as shell wildcard.
5271 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5272 switches do not contain `d', so that a full listing is expected.
5274 This works by running a directory listing program
5275 whose name is in the variable `insert-directory-program'.
5276 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5278 When SWITCHES contains the long `--dired' option, this function
5279 treats it specially, for the sake of dired. However, the
5280 normally equivalent short `-D' option is just passed on to
5281 `insert-directory-program', as any other option."
5282 ;; We need the directory in order to find the right handler.
5287 wildcard full-directory-p)
5292 ;; Read the actual directory using `insert-directory-program'.
5293 ;; RESULT gets the status code.
5295 ;; putting text property `dired-filename, decode one
5296 ;; bunch by one to preserve that property.
5298 ;; This is to control encoding the arguments in call-process.
5302 default-file-name-coding-system))))
5305 ;; Run ls in the directory part of the file pattern
5306 ;; using the last component as argument.
5313 shell-file-name nil t nil
5314 "-c"
5316 ""
5318 insert-directory-program
5319 " -d "
5321 switches
5323 " -- "
5324 ;; Quote some characters that have
5325 ;; special meanings in shells; but
5326 ;; don't quote the wildcards--we want
5327 ;; them to be special. We also
5328 ;; currently don't quote the quoting
5329 ;; characters in case people want to
5330 ;; use them explicitly to quote
5331 ;; wildcard characters.
5333 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5334 ;; directory if FILE is a symbolic link.
5336 insert-directory-program nil t nil
5340 ;; Split the switches at any spaces so we can
5341 ;; pass separate options as separate args.
5343 ;; Avoid lossage if FILE starts with `-'.
5351 file))))))))
5353 ;; If we got "//DIRED//" in the output, it means we got a real
5354 ;; directory listing, even if `ls' returned nonzero.
5355 ;; So ignore any errors.
5368 ;; The first time ls returns an error,
5369 ;; find the version numbers of ls,
5370 ;; and set insert-directory-ls-version
5371 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5372 ;; is equal or if the info cannot be obtained.
5373 ;; (That can mean it isn't GNU ls.)
5383 comparison)
5399 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5403 ;; If `insert-directory-program' failed, signal an error.
5405 ;; Delete the error message it may have output.
5407 ;; On non-Posix systems, we cannot open a directory, so
5408 ;; don't even try, because that will always result in
5409 ;; the ubiquitous "Access denied". Instead, show the
5410 ;; command line so the user can try to guess what went wrong.
5415 insert-directory-program
5417 file result)
5418 ;; Unix. Access the file to get a suitable error.
5425 ;; The following overshoots by one line for an empty
5426 ;; directory listed with "--dired", but without "-a"
5427 ;; switch, where the ls output contains a
5428 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5429 ;; We take care of that case later.
5437 error-lines)
5438 ;; Find all the lines that are error messages,
5439 ;; and record the bounds of each one.
5446 ;; Now read the numeric positions of file names.
5453 error-lines))
5456 error-lines)))
5458 ;; End is followed by \n or by " -> ".
5460 ;; It seems that we can't trust ls's output as to
5461 ;; byte positions of filenames.
5467 ;; Take care of the case where the ls output contains a
5468 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5469 ;; and we went one line too far back (see above).
5474 ;; Now decode what read if necessary.
5476 file-name-coding-system
5477 default-file-name-coding-system
5479 coding-no-eol
5480 val pos)
5484 ;; If no coding system is specified or detection is
5485 ;; requested, detect the coding.
5499 ;; Force no eol conversion on a file name, so
5500 ;; that CR is preserved.
5508 ;; Try to insert the amount of free space.
5511 ;; First find the line to put it on.
5515 ;; Replace "total" with "used", to avoid confusion.
5521 "Convert `ls --dired' file name position value POS to a buffer position.
5522 File name position values returned in ls --dired output
5523 count only stdout; they don't count the error messages sent to stderr.
5524 So this function converts to them to real buffer positions.
5525 ERROR-LINES is a list of buffer positions of error message lines,
5526 of the form (START END)."
5530 pos)
5534 "Insert directory listing for FILE, formatted according to SWITCHES.
5536 Like `insert-directory', but if FILE does not exist, it inserts a
5537 message to that effect instead of signaling an error."
5540 ;; Simulate the message printed by `ls'.
5544 "Functions to call with no arguments to query about killing Emacs.
5545 If any of these functions returns nil, killing Emacs is cancelled.
5546 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5550 "How to ask for confirmation when leaving Emacs.
5551 If nil, the default, don't ask at all. If the value is non-nil, it should
5552 be a predicate function such as `yes-or-no-p'."
5560 "Offer to save each buffer, then kill this Emacs process.
5561 With prefix arg, silently save all file-visiting buffers, then kill."
5570 ;; process-list is not defined on VMS.
5572 active)
5581 ;; Query the user for other things, perhaps.
5588 "Offer to save each buffer, then kill the current connection.
5589 If the current frame has no client, kill Emacs itself.
5591 With prefix arg, silently save all file-visiting buffers, then kill.
5593 If emacsclient was started with a list of filenames to edit, then
5594 only these files will be asked to be saved."
5602 \f
5603 ;; We use /: as a prefix to "quote" a file name
5604 ;; so that magic file name handlers will not apply to it.
5608 file-name-handler-alist))
5610 ;; We depend on being the last handler on the list,
5611 ;; so that anything else which does need handling
5612 ;; has been handled already.
5613 ;; So it is safe for us to inhibit *all* magic file name handlers.
5622 default-directory))
5623 ;; Get a list of the indices of the args which are file names.
5626 ;; The first six are special because they
5627 ;; return a file name. We want to include the /:
5628 ;; in the return value.
5629 ;; So just avoid stripping it in the first place.
5636 ;; `identity' means just return the first arg
5637 ;; not stripped of its quoting.
5639 ;; `add' means add "/:" to the result.
5641 ;; `quote' means add "/:" to buffer-file-name.
5643 ;; `unquote-then-quote' means set buffer-file-name
5644 ;; temporarily to unquoted filename.
5646 ;; List the arguments which are filenames.
5654 ;; For all other operations, treat the first argument only
5655 ;; as the file name.
5657 method
5658 ;; Copy ARGUMENTS so we can replace elements in it.
5662 ;; Strip off the /: from the file names that have it.
5670 "/"
5686 res))
5689 \f
5690 ;; Symbolic modes and read-file-modes.
5693 "Convert CHAR to a who-mask from a symbolic mode notation.
5694 CHAR is in [ugoa] and represents the users on which rights are applied."
5702 "Convert CHAR to a right-mask from a symbolic mode notation.
5703 CHAR is in [rwxXstugo] and represents a right.
5704 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5711 ;; Rights relative to the previous file modes.
5722 "Convert a right string to a right-mask from a symbolic modes notation.
5724 WHO-MASK is the mask number of the users on which the rights are to be applied.
5725 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5731 char-right)
5738 num-rights
5742 op char-right)))
5743 num-rights))
5746 "Convert symbolic file modes to numeric file modes.
5747 MODES is the string to convert, it should match
5750 notation.
5751 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5764 num-who num-modes)
5767 num-modes)))
5770 "Read file modes in octal or symbolic notation.
5771 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5772 ORIG-FILE is the original file of which modes will be change."
5781 \f
5806 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5807 ;;; files.el ends here