| blob | 07b8a0688ff11dbdb3a58669a4e5839ca9fb7516 |
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, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
32 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 FROM and TO should be equivalent names, which refer to the
63 same directory. Do not use `~' in the TO strings;
64 they should be ordinary absolute directory names.
66 Use this feature when you have directories which you normally refer to
67 via absolute symbolic links. Make TO the name of the link, and FROM
68 the name it is linked to."
76 ;; Turn off backup files on VMS since it has version numbers.
78 "Non-nil means make a backup of a file the first time it is saved.
79 This can be done by renaming the file or by copying.
81 Renaming means that Emacs renames the existing file so that it is a
82 backup file, then writes the buffer into a new file. Any other names
83 that the old file had will now refer to the backup file. The new file
84 is owned by you and its group is defaulted.
86 Copying means that Emacs copies the existing file into the backup
87 file, then writes the buffer on top of the existing file. Any other
88 names that the old file had will now refer to the new (edited) file.
89 The file's owner and group are unchanged.
91 The choice of renaming or copying is controlled by the variables
92 `backup-by-copying', `backup-by-copying-when-linked',
93 `backup-by-copying-when-mismatch' and
94 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
98 ;; Do this so that local variables based on the file name
99 ;; are not overridden by the major mode.
101 "Non-nil means don't make a backup, regardless of the other parameters.
102 This variable is intended for use by making it local to a buffer.
107 "Non-nil means always use copying to create backup files.
108 See documentation of variable `make-backup-files'."
113 "Non-nil means use copying to create backups for files with multiple names.
114 This causes the alternate names to refer to the latest version as edited.
115 This variable is relevant only if `backup-by-copying' is nil."
120 "Non-nil means create backups by copying if this preserves owner or group.
121 Renaming may still be used (subject to control of other variables)
122 when it would not result in changing the owner or group of the file;
123 that is, for files which are owned by you and whose group matches
124 the default for a new file created there by you.
125 This variable is relevant only if `backup-by-copying' is nil."
130 "Non-nil means create backups by copying to preserve a privileged owner.
131 Renaming may still be used (subject to control of other variables)
132 when it would not result in changing the owner of the file or if the owner
133 has a user id greater than the value of this variable. This is useful
134 when low-numbered uid's are used for special system users (such as root)
135 that must maintain ownership of certain files.
136 This variable is relevant only if `backup-by-copying' and
137 `backup-by-copying-when-mismatch' are nil."
142 "Predicate that looks at a file name and decides whether to make backups.
146 "Non-nil in a buffer means always offer to save buffer on exit.
147 Do so even if the buffer is not visiting a file.
148 Automatically local in all buffers."
154 "Non-nil means find a file under alternative names, in existing buffers.
155 This means if any existing buffer is visiting the file you want
156 under another name, you get the existing buffer instead of a new buffer."
161 "*Non-nil means visit a file under its truename.
162 The truename of a file is found by chasing all links
163 both at the file level and at the levels of the containing directories."
169 "Specify which files should be reverted without query.
170 The value is a list of regular expressions.
171 If the file name matches one of these regular expressions,
172 then `revert-buffer' reverts the file without querying
173 if the file has changed on disk and you have not edited the buffer."
178 "The device number and file number of the file visited in the current buffer.
179 The value is a list of the form (FILENUM DEVNUM).
180 This pair of numbers uniquely identifies the file.
200 "The directory for writing temporary files."
206 "The directory for writing small temporary files.
207 If non-nil, this directory is used instead of `temporary-file-directory'
208 by programs that create small temporary files. This is for systems that
209 have fast storage with limited space, such as a RAM disk."
213 ;; The system null device. (Should reference NULL_DEVICE from C.)
239 "Non-nil means protect against I/O errors while saving files.
240 Some modes set this non-nil in particular buffers.
242 This feature works by writing the new contents into a temporary file
243 and then renaming the temporary file to replace the original.
244 In this way, any I/O error in writing leaves the original untouched,
245 and there is never any instant where the file is nonexistent.
247 Note that this feature forces backups to be made by copying.
248 Yet, at the same time, saving a precious file
249 breaks any hard links between it and other files."
254 "Control use of version numbers for backup files.
255 When t, make numeric backup versions unconditionally.
256 When nil, make them for files that have some already.
257 The value `never' means do not make them."
267 "When cleaning directory, number of versions to keep."
273 "If t, delete excess backup versions silently.
274 If nil, ask confirmation. Any other value prevents any trimming."
281 "Number of oldest versions to keep when a new numbered backup is made."
287 "Number of newest versions to keep when a new numbered backup is made.
288 Includes the new backup. Must be > 0"
294 "Whether to add a newline automatically at the end of the file.
296 A value of t means do this only when the file is about to be saved.
297 A value of `visit' means do this right after the file is visited.
298 A value of `visit-save' means do it at both of those times.
299 Any other non-nil value means ask user whether to add a newline, when saving.
300 A value of nil means don't add newlines.
302 Certain major modes set this locally to the value obtained
303 from `mode-require-final-newline'."
312 "Whether to add a newline at end of file, in certain major modes.
313 Those modes set `require-final-newline' to this value when you enable them.
314 They do so because they are often used for files that are supposed
315 to end in newlines, and the question is how to arrange that.
317 A value of t means do this only when the file is about to be saved.
318 A value of `visit' means do this right after the file is visited.
319 A value of `visit-save' means do it at both of those times.
320 Any other non-nil value means ask user whether to add a newline, when saving.
322 A value of nil means do not add newlines. That is a risky choice in this
323 variable since this value is used for modes for files that ought to have
324 final newlines. So if you set this to nil, you must explicitly check and
325 add a final newline, whenever you save a file that really needs one."
335 "Non-nil says by default do auto-saving of every file-visiting buffer."
340 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
341 Normally auto-save files are written under other names."
347 ;; Don't put "\\2" inside expand-file-name, since it will be
348 ;; transformed to "/2" on DOS/Windows.
350 "Transforms to apply to buffer file name before making auto-save file name.
351 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
352 REGEXP is a regular expression to match against the file name.
353 If it matches, `replace-match' is used to replace the
354 matching part with REPLACEMENT.
355 If the optional element UNIQUIFY is non-nil, the auto-save file name is
356 constructed by taking the directory part of the replaced file-name,
357 concatenated with the buffer file name with all directory separators
358 changed to `!' to prevent clashes. This will not work
359 correctly if your filesystem truncates the resulting name.
361 All the transforms in the list are tried, in the order they are listed.
362 When one transform applies, its result is final;
363 no further transforms are tried.
365 The default value is set up to put the auto-save file into the
366 temporary directory (see the variable `temporary-file-directory') for
367 editing a remote file.
369 On MS-DOS filesystems without long names this variable is always
370 ignored."
377 "Non-nil means save word abbrevs too when files are saved.
378 If `silently', don't ask the user before saving."
383 "Non-nil means allow `find-file' to visit directories.
384 To visit the directory, `find-file' runs `find-directory-functions'."
389 "List of functions to try in sequence to visit a directory.
390 Each function is called with the directory name as the sole argument
391 and should return either a buffer or nil."
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
398 "List of functions to be called for `find-file' on nonexistent file.
399 These functions are called as soon as the error is detected.
400 Variable `buffer-file-name' is already set up.
405 ;;;It is not useful to make this a local variable.
406 ;;;(put 'find-file-hooks 'permanent-local t)
409 "List of functions to be called after a buffer is loaded from a file.
410 The buffer's local variables (if any) will have been processed before the
411 functions are called."
418 "List of functions to be called before writing out a buffer to a file.
419 If one of them returns non-nil, the file is considered already written
420 and the rest are not called.
421 These hooks are considered to pertain to the visited file.
422 So any buffer-local binding of this variable is discarded if you change
424 change the major mode.
426 This hook is not run if any of the functions in
427 `write-contents-functions' returns non-nil. Both hooks pertain
428 to how to save a buffer to file, for instance, choosing a suitable
429 coding system and setting mode bits. (See Info
430 node `(elisp)Saving Buffers'.) To perform various checks or
441 "List of functions to be called before writing out a buffer to a file.
442 If one of them returns non-nil, the file is considered already written
443 and the rest are not called and neither are the functions in
444 `write-file-functions'.
446 This variable is meant to be used for hooks that pertain to the
447 buffer's contents, not to the particular visited file; thus,
448 `set-visited-file-name' does not clear this variable; but changing the
449 major mode does clear it.
451 For hooks that _do_ pertain to the particular visited file, use
452 `write-file-functions'. Both this variable and
453 `write-file-functions' relate to how a buffer is saved to file.
454 To perform various checks or updates before the buffer is saved,
461 "Control use of local variables in files you visit.
462 The value can be t, nil, :safe, :all, or something else.
464 A value of t means file local variables specifications are obeyed
465 if all the specified variable values are safe; if any values are
466 not safe, Emacs queries you, once, whether to set them all.
467 \(When you say yes to certain values, they are remembered as safe.)
469 :safe means set the safe variables, and ignore the rest.
470 :all means set all variables, whether safe or not.
471 (Don't set it permanently to :all.)
472 A value of nil means always ignore the file local variables.
474 Any other value means always query you once whether to set them all.
475 \(When you say yes to certain values, they are remembered as safe, but
478 This variable also controls use of major modes specified in
479 a -*- line.
482 always obeys file local variable specifications and the -*- line,
483 and ignores this variable."
492 "Like `enable-local-variables' but meant for buffer-local bindings.
493 The meaningful values are nil and non-nil. The default is non-nil.
494 If a major mode sets this to nil, buffer-locally, then any local
495 variables list in the file will be ignored.
497 This variable does not affect the use of major modes
502 The value can be t, nil or something else.
503 A value of t means obey `eval' variables;
504 A value of nil means ignore them; anything else means query."
510 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
519 "Non-nil means buffers visiting files read-only do so in view mode.
520 In fact, this means that all read-only buffers normally have
521 View mode enabled, including buffers that are read-only because
522 you visit a file you cannot alter, and buffers you make read-only
528 "History list of file names entered in the minibuffer.
530 Maximum length of the history list is determined by the value
532 \f
535 "Provides support for ange-ftp host name completion.
536 Runs the usual ange-ftp hook, but only for completion operations."
537 ;; Having this here avoids the need to load ange-ftp when it's not
538 ;; really in use.
544 inhibit-file-name-handlers)))
549 "Convert a standard file's name to something suitable for the OS.
550 This means to guarantee valid names and perhaps to canonicalize
551 certain patterns.
553 FILENAME should be an absolute file name since the conversion rules
554 sometimes vary depending on the position in the file name. E.g. c:/foo
555 is a valid DOS file name, but c:/bar/c:/foo is not.
557 This function's standard definition is trivial; it just returns
558 the argument. However, on Windows and DOS, replace invalid
559 characters. On DOS, make sure to obey the 8.3 limitations.
560 In the native Windows build, turn Cygwin names into native names,
561 and also turn slashes into backslashes if the shell requires it (see
562 `w32-shell-dos-semantics').
564 See Info node `(elisp)Standard File Names' for more details."
568 ;; Replace invalid filename characters with !
572 name)
573 filename))
576 "Read directory name, prompting with PROMPT and completing in directory DIR.
577 Value is not expanded---you must call `expand-file-name' yourself.
578 Default name to DEFAULT-DIRNAME if user exits with the same
579 non-empty string that was inserted by this function.
580 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
581 or just DIR if INITIAL is nil.)
582 If the user exits with an empty minibuffer, this function returns
583 an empty string. (This can only happen if the user erased the
584 pre-inserted contents or if `insert-default-directory' is nil.)
585 Fourth arg MUSTMATCH non-nil means require existing directory's name.
586 Non-nil and non-t means also require confirmation after completion.
587 Fifth arg INITIAL specifies text to start with.
588 DIR should be an absolute directory name. It defaults to
589 the value of `default-directory'."
594 dir))
595 mustmatch initial
598 \f
600 "Show the current default directory."
605 "Value of the CDPATH environment variable, as a list.
609 "Explode a search path into a list of directory names.
610 Directories are separated by occurrences of `path-separator'
611 \(which is colon in GNU and GNU-like systems)."
612 ;; We could use split-string here.
620 nil
625 cd-list)))
628 "Change current directory to given absolute file name DIR."
629 ;; Put the name into directory syntax now,
630 ;; because otherwise expand-file-name may give some bad results.
644 "Make DIR become the current buffer's default directory.
645 If your environment includes a `CDPATH' variable, try each one of
646 that list of directories (separated by occurrences of
647 `path-separator') when resolving a relative directory name.
648 The path separator is colon in GNU and GNU-like systems."
651 default-directory default-directory
667 cd-path)
668 nil))
672 "Load the Lisp file named FILE."
673 ;; This is a case where .elc makes a lot of sense.
680 "Search for FILENAME through PATH.
681 If found, return the absolute file name of FILENAME, with its suffixes;
682 otherwise return nil.
683 PATH should be a list of directories to look in, like the lists in
684 `exec-path' or `load-path'.
685 If SUFFIXES is non-nil, it should be a list of suffixes to append to
688 If non-nil, PREDICATE is used instead of `file-readable-p'.
689 PREDICATE can also be an integer to pass to the `access' system call,
690 in which case file-name handlers are ignored. This usage is deprecated.
692 For compatibility, PREDICATE can also be one of the symbols
693 `executable', `readable', `writable', or `exists', or a list of
694 one or more of those symbols."
705 "Do completion for file names passed to `locate-file'.
706 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
729 "Look up the directory hierarchy from FILE for a file matching REGEXP."
731 ;; `user' is not initialized yet because `file' may not exist, so we may
732 ;; have to walk up part of the hierarchy before we find the "initial UID".
734 ;; Abbreviate, so as to stop when we cross ~/.
736 files)
738 ;; As a heuristic, we stop looking up the hierarchy of
739 ;; directories as soon as we find a directory belonging to
740 ;; another user. This should save us from looking in
741 ;; things like /net and /afs. This assumes that all the
742 ;; files inside a project belong to the same user.
752 nil)))
755 "Search for COMMAND in `exec-path' and return the absolute file name.
756 Return nil if COMMAND is not found anywhere in `exec-path'."
757 ;; Use 1 rather than file-executable-p to better match the behavior of
758 ;; call-process.
762 "Load the library named LIBRARY.
763 This is an interface to the function `load'."
766 'locate-file-completion
771 "Test whether FILE specifies a location on a remote system.
772 Returns nil or a string identifying the remote connection (ideally
773 a prefix of FILE). For example, the remote identification for filename
776 less reliable than accessing local files.
777 Furthermore, relative file names do not work across remote connections.
779 IDENTIFICATION specifies which part of the identification shall
780 be returned as string. IDENTIFICATION can be the symbol
781 `method', `user' or `host'; any other value is handled like nil
782 and means to return the complete identification string.
784 If CONNECTED is non-nil, the function returns an identification only
785 if FILE is located on a remote system, and a connection is established
786 to that remote system.
788 `file-remote-p' will never open a connection on its own."
792 nil)))
795 "Copy the file FILE into a temporary file on this machine.
796 Returns the name of the local copy, or nil, if FILE is directly
797 accessible."
798 ;; This formerly had an optional BUFFER argument that wasn't used by
799 ;; anything.
803 nil)))
806 "Return the truename of FILENAME, which should be absolute.
807 The truename of a file name is found by chasing symbolic links
808 both at the level of the file and at the level of the directories
809 containing it, until no links are left at any level.
812 ;; COUNTER and PREV-DIRS are only used in recursive calls.
813 ;; COUNTER can be a cons cell whose car is the count of how many
814 ;; more links to chase before getting an error.
815 ;; PREV-DIRS can be a cons cell whose car is an alist
816 ;; of truenames we've just recently computed.
830 ;; For speed, remove the ange-ftp completion handler from the list.
831 ;; We know it's not needed here.
832 ;; For even more speed, do this only on the outermost call.
839 ;; andrewi@harlequin.co.uk - none of the following code (except for
840 ;; invoking the file-name handler) currently applies on Windows
841 ;; (ie. there are no native symlinks), but there is an issue with
842 ;; case differences being ignored by the OS, and short "8.3 DOS"
843 ;; name aliases existing for all files. (The short names are not
844 ;; reported by directory-files, but can be used to refer to files.)
845 ;; It seems appropriate for file-truename to resolve these issues in
846 ;; the most natural way, which on Windows is to call the function
847 ;; `w32-long-file-name' - this returns the exact name of a file as
848 ;; it is stored on disk (expanding short name aliases with the full
849 ;; name in the process).
852 ;; For file name that has a special handler, call handler.
853 ;; This is so that ange-ftp can save time by doing a no-op.
856 ;; If filename contains a wildcard, newname will be the old name.
858 ;; If filename exists, use the long name
862 ;; If this file directly leads to a link, process that iteratively
863 ;; so that we don't use lots of stack.
869 ;; For file name that has a special handler, call handler.
870 ;; This is so that ange-ftp can save time by doing a no-op.
873 done t)
875 target dirfile)
876 ;; Get the truename of the directory.
878 ;; If these are equal, we have the (or a) root directory.
880 ;; If this is the same dir we last got the truename for,
881 ;; save time--don't recalculate.
891 done t)
894 done t)
895 ;; Put it back on the file name.
897 ;; Is the file name the name of a link?
900 ;; Yes => chase that link, then start all over
901 ;; since the link may point to a directory name that uses links.
902 ;; We can't safely use expand-file-name here
903 ;; since target might look like foo/../bar where foo
904 ;; is itself a link. Instead, we handle . and .. above.
907 target
909 done nil)
910 ;; No, we are done!
912 filename))
915 "Chase links in FILENAME until a name that is not a link.
916 Unlike `file-truename', this does not check whether a parent
917 directory name is a symbolic link.
918 If the optional argument LIMIT is a number,
919 it means chase no more than that many links and then stop."
927 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
930 ;; Handle `..' by hand, since it needs to work in the
931 ;; target of any directory symlink.
932 ;; This code is not quite complete; it does not handle
933 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
937 ;; Chase links in the default dir of the symlink.
941 ;; Now find the parent of that dir.
945 newname))
948 "Create a temporary file.
949 The returned file name (created by appending some random characters at the end
950 of PREFIX, and expanding against `temporary-file-directory' if necessary),
951 is guaranteed to point to a newly created empty file.
952 You can then use `write-region' to write new data into the file.
954 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
956 If SUFFIX is non-nil, add that at the end of the file name."
958 file)
961 ;; Create temp files with strict access rights. It's easy to
962 ;; loosen them later, whereas it's impossible to close the
963 ;; time-window of loose permissions otherwise.
975 nil)
977 ;; the file was somehow created by someone else between
978 ;; `make-temp-name' and `write-region', let's try again.
979 nil)
980 file)
981 ;; Reset the umask.
985 "Change the encoding of FILE's name from CODING to NEW-CODING.
986 The value is a new name of FILE.
987 Signals a `file-already-exists' error if a file of the new name
988 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
989 is non-nil. A number as fourth arg means request confirmation if
990 the new name already exists. This is what happens in interactive
991 use with M-x."
994 default-file-name-coding-system))
996 from-coding to-coding)
998 ;; We provide the default coding only when it seems that
999 ;; the filename is correctly decoded by the default
1000 ;; coding.
1006 filename default-coding)
1007 default-coding))
1011 ;; We provide the default coding only when a user is going to
1012 ;; change the encoding not from the default coding.
1016 filename from-coding)))
1019 filename from-coding default-coding)
1020 default-coding)))
1024 default-file-name-coding-system))
1025 ;; FILE should have been decoded by DEFAULT-CODING.
1029 ;; Suppress further encoding.
1034 newname))
1035 \f
1037 "Select buffer BUFFER in another window.
1038 If BUFFER does not identify an existing buffer, then this function
1039 creates a buffer with that name.
1041 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1042 or nil. If BUFFER is nil, then this function chooses a buffer
1043 using `other-buffer'.
1044 Optional second arg NORECORD non-nil means
1045 do not put this buffer at the front of the list of recently selected ones.
1046 This function returns the buffer it switched to.
1048 This uses the function `display-buffer' as a subroutine; see its
1049 documentation for additional customization information."
1052 ;; Don't let these interfere.
1053 same-window-buffer-names same-window-regexps)
1057 "Switch to buffer BUFFER in another frame.
1058 Optional second arg NORECORD non-nil means
1059 do not put this buffer at the front of the list of recently selected ones.
1060 This function returns the buffer it switched to.
1062 This uses the function `display-buffer' as a subroutine; see its
1063 documentation for additional customization information."
1066 same-window-buffer-names same-window-regexps)
1072 "Switch to buffer BUFFER in another frame.
1073 This uses the function `display-buffer' as a subroutine; see its
1074 documentation for additional customization information."
1077 same-window-buffer-names same-window-regexps
1079 new-window)
1081 ;; This may have been here in order to prevent the new frame from hiding
1082 ;; the old frame. But it does more harm than good.
1083 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1084 ;;(lower-frame (window-frame new-window))
1086 ;; This may have been here in order to make sure the old-frame gets the
1087 ;; focus. But not only can it cause an annoying flicker, with some
1088 ;; window-managers it just makes the window invisible, with no easy
1089 ;; way to recover it. --Stef
1090 ;;(make-frame-invisible (window-frame old-window))
1091 ;;(make-frame-visible (window-frame old-window))
1092 ))
1098 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1099 BODY should use the minibuffer at most once.
1100 Recursive uses of the minibuffer will not be affected."
1106 ;; Clear out this hook so it does not interfere
1107 ;; with any recursive minibuffer usage.
1117 "If non-nil, `find-file' requires confirmation before visiting a new file."
1129 t))
1132 "Edit file FILENAME.
1133 Switch to a buffer visiting file FILENAME,
1134 creating one if none already exists.
1135 Interactively, the default if you just type RET is the current directory,
1136 but the visited file name is available through the minibuffer history:
1137 type M-n to pull it into the minibuffer.
1139 You can visit files on remote machines by specifying something
1140 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1141 also visit local files as a different user by specifying
1142 /sudo::FILE for the file name.
1143 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1144 manual, for more about this.
1146 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1147 expand wildcards (if any) and visit multiple files. You can
1148 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1150 To visit a file without any kind of conversion and without
1161 "Edit file FILENAME, in another window.
1164 an existing one. See the function `display-buffer'.
1166 Interactively, the default if you just type RET is the current directory,
1167 but the visited file name is available through the minibuffer history:
1168 type M-n to pull it into the minibuffer.
1170 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1171 expand wildcards (if any) and visit multiple files."
1184 "Edit file FILENAME, in another frame.
1187 an existing one. See the function `display-buffer'.
1189 Interactively, the default if you just type RET is the current directory,
1190 but the visited file name is available through the minibuffer history:
1191 type M-n to pull it into the minibuffer.
1193 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1194 expand wildcards (if any) and visit multiple files."
1207 "Edit the existing file FILENAME.
1209 file names with wildcards."
1217 "Edit file FILENAME but don't allow changes.
1231 value))
1234 "Edit file FILENAME in another window but don't allow changes.
1248 value))
1251 "Edit file FILENAME in another frame but don't allow changes.
1265 value))
1268 "Find file FILENAME as a replacement for the file in the next window.
1269 This command does not select that window.
1273 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1274 expand wildcards (if any) and replace the file with multiple files."
1286 t))))
1294 "Find file FILENAME, select its buffer, kill previous buffer.
1295 If the current buffer now contains an empty file that you just visited
1296 \(presumably by mistake), use this command to visit the file you really want.
1300 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1301 expand wildcards (if any) and replace the file with multiple files.
1303 If the current buffer is an indirect buffer, or the base buffer
1304 for one or more indirect buffers, the other buffer(s) are not
1305 killed."
1315 t)))
1336 ;; This prevents us from finding the same buffer
1337 ;; if we specified the same file again.
1341 ;; Likewise for dired buffers.
1345 ;; This executes if find-file gets an error
1346 ;; and does not really find anything.
1347 ;; We put things back as they were.
1348 ;; If find-file actually finds something, we kill obuf below.
1357 ;; We already asked; don't ask again.
1360 \f
1362 "Create a suitably named buffer for visiting FILENAME, and return it.
1363 FILENAME (sans directory) is used unchanged if that name is free;
1364 otherwise a string <2> or <3> or ... is appended to get an unused name.
1365 Spaces at the start of FILENAME (sans directory) are removed."
1374 "Create and return a buffer with a name based on NAME.
1375 Choose the buffer's name using `generate-new-buffer-name'."
1379 "Regexp to match the automounter prefix in a directory name."
1387 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1389 home directory is a root directory) and removes automounter prefixes
1390 \(see the variable `automount-dir-prefix')."
1391 ;; Get rid of the prefixes added by the automounter.
1399 ;; If any elt of directory-abbrev-alist matches this name,
1400 ;; abbreviate accordingly.
1406 ;; Compute and save the abbreviated homedir name.
1407 ;; We defer computing this until the first time it's needed, to
1408 ;; give time for directory-abbrev-alist to be set properly.
1409 ;; We include a slash at the end, to avoid spurious matches
1410 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1417 ;; If FILENAME starts with the abbreviated homedir,
1418 ;; make it start with `~' instead.
1420 ;; If the home dir is just /, don't change it.
1423 ;; MS-DOS root directories can come with a drive letter;
1424 ;; Novell Netware allows drive letters beyond `Z:'.
1434 filename)))
1437 "List of logical names for which visiting shouldn't save the true dirname.
1438 On VMS, when you visit a file using a logical name that searches a path,
1439 you may or may not want the visited file name to record the specific
1440 directory where the file was found. If you *do not* want that, add the logical
1441 name to this list as a string."
1446 "Return the buffer visiting file FILENAME (a string).
1447 This is like `get-file-buffer', except that it checks for any buffer
1448 visiting the same file, possibly under a different name.
1449 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1450 and others are ignored.
1451 If there is no such live buffer, return nil."
1465 found)
1475 ;; Verify this buffer's file number
1476 ;; still belongs to its file.
1479 attributes)
1483 found))))
1484 \f
1486 "Non-nil means file-visiting commands should handle wildcards.
1487 For example, if you specify `*.c', that would visit all the files
1488 whose names match the pattern."
1494 "Non-nil means suppress warning messages for symlinked files.
1495 When nil, Emacs prints a warning when visiting a file that is already
1496 visited, but with a different name. Setting this option to t
1497 suppresses this warning."
1503 "Maximum size of file above which a confirmation is requested.
1504 When nil, never request confirmation."
1511 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1512 OP-TYPE specifies the file operation being performed (for message to user)."
1522 "Read file FILENAME into a buffer and return the buffer.
1523 If a buffer exists visiting FILENAME, return that one, but
1524 verify that the file has not changed since visited or saved.
1525 The buffer is not selected, just returned to the caller.
1526 Optional second arg NOWARN non-nil means suppress any warning messages.
1527 Optional third arg RAWFILE non-nil means the file is read literally.
1528 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1529 and visit all the matching files. When wildcards are actually
1530 used and expanded, return a list of buffers that are visiting
1531 the various files."
1538 'find-directory-functions
1541 filename)))
1544 find-file-wildcards
1558 ;; Find any buffer for a file which has same truename.
1560 ;; Let user know if there is a buffer with the same truename.
1564 find-file-suppress-same-file-warnings
1568 ;; Optionally also find that buffer.
1571 ;; Check to see if the file looks uncommonly large.
1575 ;; We are using an existing buffer.
1582 ;; Certain files should be reverted automatically
1583 ;; if they have changed on disk and not in the buffer.
1591 found))
1601 "File %s changed on disk. Discard your edits? "
1606 "File %s changed on disk. Discard your edits in %s? "
1614 ;; Check if a formerly read-only file has become
1615 ;; writable and vice versa, but if the buffer agrees
1616 ;; with the new state of the file, that is ok too.
1624 buffer-file-name
1633 ;; It is confusing to ask whether to visit
1634 ;; non-literally if they have the file in
1635 ;; hexl-mode.
1641 "The file %s is already visited normally,
1642 and you have edited the buffer. Now you have asked to visit it literally,
1643 meaning no coding system handling, format conversion, or local variables.
1644 Emacs can only visit a file in one way at a time.
1646 Do you want to save the file, and visit it literally instead? "
1647 "The file %s is already visited literally,
1648 meaning no coding system handling, format conversion, or local variables.
1649 You have edited the buffer. Now you have asked to visit the file normally,
1650 but Emacs can only visit a file in one way at a time.
1657 rawfile truename number))
1661 "\
1662 Do you want to discard your changes, and visit the file literally now? "
1663 "\
1666 rawfile truename number)
1672 "The file %s is already visited normally.
1673 You have asked to visit it literally,
1674 meaning no coding system decoding, format conversion, or local variables.
1675 But Emacs can only visit a file in one way at a time.
1677 Do you want to revisit the file literally now? "
1678 "The file %s is already visited literally,
1679 meaning no coding system decoding, format conversion, or local variables.
1680 You have asked to visit it normally,
1681 but Emacs can only visit a file in one way at a time.
1686 rawfile truename number)
1689 ;; Return the buffer we are using.
1690 buf)
1691 ;; Create a new buffer.
1693 ;; find-file-noselect-1 may use a different buffer.
1695 rawfile truename number))))))
1701 ;; Needed in case we are re-visiting the file with a different
1702 ;; text representation.
1719 filename)))
1720 ;; Unconditionally set error
1730 filename)))
1731 ;; Run find-file-not-found-functions until one returns non-nil.
1733 ;; If they fail too, set error.
1735 ;; Record the file's truename, and maybe use that as visited name.
1741 ;; On VMS, we may want to remember which directory in a search list
1742 ;; the file was found in.
1752 ;; Set buffer's default directory to that of the file.
1754 ;; Turn off backup files for certain file names. Since
1755 ;; this is a permanent local, the major mode won't eliminate it.
1770 \f
1772 "Like `insert-file-contents', but only reads in the file literally.
1773 A buffer may be modified in several ways after reading into the buffer,
1774 to Emacs features such as format decoding, character code
1775 conversion, `find-file-hook', automatic uncompression, etc.
1777 This function ensures that none of these modifications will take place."
1785 nil))
1788 inhibit-file-name-handlers))
1801 filename)))
1802 ;; Check whether the file is uncommonly large
1813 "Insert contents of file FILENAME into buffer after point with no conversion.
1815 This function is meant for the user to run interactively.
1816 Don't call it from programs! Use `insert-file-contents-literally' instead.
1817 \(Its calling sequence is different; see its documentation)."
1822 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1827 "Visit file FILENAME with no conversion of any kind.
1828 Format conversion and character code conversion are both disabled,
1829 and multibyte characters are disabled in the resulting buffer.
1830 The major mode used is Fundamental mode regardless of the file name,
1831 and local variable specifications in the file are ignored.
1832 Automatic uncompression and adding a newline at the end of the
1833 file due to `require-final-newline' is also disabled.
1835 You cannot absolutely rely on this function to result in
1836 visiting the file literally. If Emacs already has a buffer
1837 which is visiting the file, you get the existing buffer,
1838 regardless of whether it was created literally or not.
1840 In a Lisp program, if you want to be sure of accessing a file's
1841 contents literally, you should create a temporary buffer and then read
1842 the file contents into it using `insert-file-contents-literally'."
1845 \f
1849 after-find-file-from-revert-buffer
1850 nomodes)
1851 "Called after finding a file and by the default revert function.
1852 Sets buffer mode, parses local variables.
1853 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1854 error in reading the file. WARN non-nil means warn if there
1855 exists an auto-save file more recent than the visited file.
1856 NOAUTO means don't mess with auto-save mode.
1857 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1858 means this call was from `revert-buffer'.
1859 Fifth arg NOMODES non-nil means don't alter the file's modes.
1860 Finishes by calling the functions in `find-file-hook'
1861 unless NOMODES is non-nil."
1864 nil
1874 ;; No need to warn if buffer is auto-saved
1875 ;; under the name of the visited file.
1877 auto-save-visited-file-name))
1880 buffer-file-name))
1900 ;; Make people do a little extra work (C-x C-q)
1901 ;; before altering a backup file.
1904 ;; When a file is marked read-only,
1905 ;; make the buffer read-only even if root is looking at it.
1913 ;; If requested, add a newline at the end of the file.
1923 view-read-only
1929 "Eval BODY and turn any error into a FORMAT message.
1930 FORMAT can have a %s escape which will be replaced with the actual error.
1931 If `debug-on-error' is set, errors are not caught, so that you can
1932 debug them.
1933 Avoid using a large BODY since it is duplicated."
1942 "Choose the major mode for this buffer automatically.
1943 Also sets up any specified local variables of the file.
1944 Uses the visited file name, the -*- line, and the local variables spec.
1946 This function is called automatically from `find-file'. In that case,
1947 we may set up the file-specified mode and local variables,
1948 depending on the value of `enable-local-variables'.
1949 In addition, if `local-enable-local-variables' is nil, we do
1950 not set local variables (though we do notice a mode specified with -*-.)
1952 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1953 or from Lisp without specifying the optional argument FIND-FILE;
1954 in that case, this function acts as if `enable-local-variables' were t."
1962 ;; Turn font lock off and on, to make sure it takes account of
1963 ;; whatever file local variables are relevant to it.
1965 ;; Font-lock-mode (now in font-core.el) can be ON when
1966 ;; font-lock.el still hasn't been loaded.
1976 "Non-nil means to try second pass through `auto-mode-alist'.
1977 This means that if the first case-sensitive search through the alist fails
1978 to find a matching major mode, a second case-insensitive search is made.
1979 On systems with case-insensitive file names, this variable is ignored,
1980 since only a single case-insensitive search through the alist is made."
1986 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1987 ;; c++-mode, java-mode and more) are added through autoload
1988 ;; directives in that file. That way is discouraged since it
1989 ;; spreads out the definition of the initial value.
2022 ;; Less common extensions come here
2023 ;; so more common ones above are found faster.
2062 ;; The list of archive file extensions should be in sync with
2063 ;; `auto-coding-alist' with `no-conversion' coding system.
2069 ;; Mailer puts message to be edited in
2070 ;; /tmp/Re.... or Message
2074 ;; some news reader is reported to use this
2083 ;; .emacs or .gnus or .viper following a directory delimiter in
2084 ;; Unix, MSDOG or VMS syntax.
2087 ;; _emacs following a directory delimiter
2088 ;; in MsDos syntax
2092 ;; Common Lisp ASDF package system.
2110 ;; Windows candidates may be opened case sensitively on Unix
2116 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2118 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2119 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2120 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2121 ;; this has lower priority to avoid matching changelog.sgml etc.
2123 ;; either user's dot-files or under /etc or some such
2125 ;; alas not all ~/.*rc files are like this
2126 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2131 ;; this contains everything twice, with space and with colon :-(
2133 ;; Get rid of any trailing .n.m and try again.
2134 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2135 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2136 ;; Using mode nil rather than `ignore' would let the search continue
2137 ;; through this list (with the shortened name) rather than start over.
2139 ;; The following should come after the ChangeLog pattern
2140 ;; for the sake of ChangeLog.1, etc.
2141 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2144 "Alist of filename patterns vs corresponding major mode functions.
2145 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2146 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2147 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2148 mode function to use. FUNCTION will be called, unless it is nil.
2150 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2151 calling FUNCTION (if it's not nil), we delete the suffix that matched
2152 REGEXP and search the list again for another match.
2154 If the file name matches `inhibit-first-line-modes-regexps',
2155 then `auto-mode-alist' is not processed.
2157 The extensions whose FUNCTION is `archive-mode' should also
2158 appear in `auto-coding-alist' with `no-conversion' coding system.
2160 See also `interpreter-mode-alist', which detects executable script modes
2161 based on the interpreters they specify to run,
2165 "Select Conf mode or XML mode according to start of file."
2175 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2176 ;; and pike-mode) are added through autoload directives in that
2177 ;; file. That way is discouraged since it spreads out the
2178 ;; definition of the initial value.
2216 "Alist mapping interpreter names to major modes.
2217 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2218 Each element looks like (INTERPRETER . MODE).
2219 If INTERPRETER matches the name of the interpreter specified in the first line
2220 of a script, mode MODE is enabled.
2228 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2229 When checking `inhibit-first-line-modes-regexps', we first discard
2235 "Regexp matching interpreters, for file mode determination.
2236 This regular expression is matched against the first line of a file
2237 to determine the file's mode in `set-auto-mode'. If it matches, the file
2238 is assumed to be interpreted by the interpreter matched by the second group
2239 of the regular expression. The mode is then determined as the mode
2243 "Alist of buffer beginnings vs. corresponding major mode functions.
2244 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2245 After visiting a file, if REGEXP matches the text at the beginning of the
2246 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2247 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2248 major mode.
2250 If FUNCTION is nil, then it is not called. (That is a way of saying
2256 ;; The < comes before the groups (but the first) to reduce backtracking.
2257 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2258 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2262 comment-re "*"
2265 . html-mode)
2267 ;; These two must come after html, because they are more general:
2272 . sgml-mode)
2275 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2276 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2277 After visiting a file, if REGEXP matches the text at the beginning of the
2278 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2279 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2280 have not specified a mode for this file.
2286 "Upper limit on `magic-mode-alist' regexp matches.
2290 "Select major mode appropriate for current buffer.
2292 To find the right major mode, this function checks for a -*- mode tag,
2293 checks if it uses an interpreter listed in `interpreter-mode-alist',
2294 matches the buffer beginning against `magic-mode-alist',
2295 compares the filename against the entries in `auto-mode-alist',
2296 then matches the buffer beginning against `magic-fallback-mode-alist'.
2298 It does not check for the `mode:' local variable in the
2299 Local Variables section of the file; for that, use `hack-local-variables'.
2301 If `enable-local-variables' is nil, this function does not check for a
2302 -*- mode tag.
2304 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2305 set the major mode only if that would change it. In other words
2306 we don't actually set it to the same mode the buffer already has."
2307 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2309 ;; Find a -*- mode tag
2316 ;; Find all specifications for the `mode:' variable
2317 ;; and execute them left to right.
2329 modes)))
2330 ;; Simple -*-MODE-*- case.
2333 modes))))
2334 ;; If we found modes to use, invoke them now, outside the save-excursion.
2342 ;; continuing would call minor modes again, toggling them off
2344 ;; If we didn't, look for an interpreter specified in the first line.
2345 ;; As a special case, allow for things like "#!/bin/env perl", which
2346 ;; finds the interpreter anywhere in $PATH.
2353 ;; Map interpreter name to a mode, signalling we're done at the
2354 ;; same time.
2356 interpreter-mode-alist))
2357 ;; If we found an interpreter mode to use, invoke it now.
2360 ;; Next try matching the buffer beginning against magic-mode-alist.
2374 ;; Next compare the filename against the entries in auto-mode-alist.
2379 ;; Remove remote file name identification.
2383 ;; Remove backup-suffixes from file name.
2386 ;; Find first matching alist entry.
2389 ;; System is case-insensitive.
2393 ;; System is case-sensitive.
2395 ;; First match case-sensitively.
2399 ;; Fallback to case-insensitive match.
2413 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2428 ;; When `keep-mode-if-same' is set, we are working on behalf of
2429 ;; set-visited-file-name. In that case, if the major mode specified is the
2430 ;; same one we already have, don't actually reset it. We don't want to lose
2431 ;; minor modes such as Font Lock.
2433 "Apply MODE and return it.
2434 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2435 any aliases and compared to current major mode. If they are the
2436 same, do nothing and return nil."
2442 mode)))
2445 "Find the -*- spec in the buffer.
2446 Call with point at the place to start searching from.
2447 If one is found, set point to the beginning
2448 and return the position of the end.
2449 Otherwise, return nil; point may be changed."
2452 ;; Don't look for -*- if this file name matches any
2453 ;; of the regexps in inhibit-first-line-modes-regexps.
2461 sufs)
2469 ;; If the file begins with "#!"
2470 ;; (exec interpreter magic), look
2471 ;; for mode frobs in the first two
2472 ;; lines. You cannot necessarily
2473 ;; put them in the first line of
2474 ;; such a file without screwing up
2475 ;; the interpreter invocation.
2476 ;; The same holds for
2477 ;; '\"
2478 ;; in man pages (preprocessor
2479 ;; magic for the `man' program).
2490 end))))
2491 \f
2492 ;;; Handling file local variables
2499 "Normal hook run after processing a file's local variables specs.
2500 Major modes can use this to examine user-specified local variables
2504 "List variable-value pairs that are considered safe.
2505 Each element is a cons cell (VAR . VAL), where VAR is a variable
2506 symbol and VAL is a value that is considered safe."
2511 "Expressions that are considered safe in an `eval:' local variable.
2512 Add expressions to this list if you want Emacs to evaluate them, when
2513 they appear in an `eval' local variable specification, without first
2514 asking you for confirmation."
2519 ;; Risky local variables:
2522 auto-mode-alist
2523 buffer-auto-save-file-name
2524 buffer-file-name
2525 buffer-file-truename
2526 buffer-undo-list
2527 dabbrev-case-fold-search
2528 dabbrev-case-replace
2529 debugger
2530 default-text-properties
2531 display-time-string
2532 enable-local-eval
2533 enable-local-variables
2534 eval
2535 exec-directory
2536 exec-path
2537 file-name-handler-alist
2538 font-lock-defaults
2539 format-alist
2540 frame-title-format
2541 global-mode-string
2542 header-line-format
2543 icon-title-format
2544 ignored-local-variables
2545 imenu--index-alist
2546 imenu-generic-expression
2547 inhibit-quit
2548 input-method-alist
2549 load-path
2550 max-lisp-eval-depth
2551 max-specpdl-size
2552 minor-mode-alist
2553 minor-mode-map-alist
2554 minor-mode-overriding-map-alist
2555 mode-line-buffer-identification
2556 mode-line-format
2557 mode-line-client
2558 mode-line-modes
2559 mode-line-modified
2560 mode-line-mule-info
2561 mode-line-position
2562 mode-line-process
2563 mode-line-remote
2564 mode-name
2565 outline-level
2566 overriding-local-map
2567 overriding-terminal-local-map
2568 parse-time-rules
2569 process-environment
2570 rmail-output-file-alist
2571 safe-local-variable-values
2572 safe-local-eval-forms
2573 save-some-buffers-action-alist
2574 special-display-buffer-names
2575 standard-input
2576 standard-output
2577 unread-command-events
2578 vc-mode))
2580 ;; Safe local variables:
2581 ;;
2582 ;; For variables defined by major modes, the safety declarations can go into
2583 ;; the major mode's file, since that will be loaded before file variables are
2584 ;; processed.
2585 ;;
2586 ;; For variables defined by minor modes, put the safety declarations in the
2587 ;; file defining the minor mode after the defcustom/defvar using an autoload
2588 ;; cookie, e.g.:
2589 ;;
2590 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2591 ;;
2592 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2593 ;; minor mode file may not be loaded yet.
2594 ;;
2595 ;; For variables defined in the C source code the declaration should go here:
2611 "Get confirmation before setting up local variable values.
2612 ALL-VARS is the list of all variables to be set up.
2613 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2614 RISKY-VARS is the list of those that are marked as risky."
2616 nil
2621 prompt char)
2631 ", and variables that are risky (**)."
2638 y -- to apply the local variables list.
2642 ! -- to apply the local variables list, and permanently mark these
2654 ;; Make strings with embedded whitespace easier to read.
2662 ""
2669 done)
2678 ;; read-event returns -1 if we are in a kbd
2679 ;; macro and there are no more events in the
2680 ;; macro. In that case, attempt to get an
2681 ;; event interactively.
2689 ;; When this is called from desktop-restore-file-buffer,
2690 ;; coding-system-for-read may be non-nil. Reset it before
2691 ;; writing to .emacs.
2695 'safe-local-variable-values
2696 safe-local-variable-values))))
2703 "Return local variables specified in the -*- line.
2704 Ignore any specification for `mode:' and `coding:';
2705 `set-auto-mode' should already have handled `mode:',
2706 `set-auto-coding' should already have handled `coding:'.
2708 If MODE-ONLY is non-nil, all we do is check whether the major
2709 mode is specified, returning t if it is specified. Otherwise,
2710 return an alist of elements (VAR . VAL), where VAR is a variable
2711 and VAL is the specified value."
2715 result mode-specified)
2716 ;; Parse the -*- line into the RESULT alist.
2717 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2719 nil)
2721 ;; Simple form: "-*- MODENAME -*-". Already handled.
2723 nil)
2725 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2726 ;; (last ";" is optional).
2731 ;; There used to be a downcase here,
2732 ;; but the manual didn't say so,
2733 ;; and people want to set var names that aren't all lc.
2738 ;; It is traditional to ignore
2739 ;; case when checking for `mode' in set-auto-mode,
2740 ;; so we must do that here as well.
2741 ;; That is inconsistent, but we're stuck with it.
2742 ;; The same can be said for `coding' in set-auto-coding.
2748 'eval
2755 mode-specified
2756 result))))
2759 "Parse and put into effect this buffer's local variables spec.
2760 If MODE-ONLY is non-nil, all we do is check whether the major mode
2761 is specified, returning t if it is specified."
2764 result)
2767 ;; Look for "Local variables:" line in last page.
2775 ;; suffix is what comes after "local variables:" in its line.
2776 ;; prefix is what comes before "local variables:" in its line.
2786 beg)
2790 endpos
2796 nil t))
2806 ;; Discard the prefix.
2811 ;; Discard the suffix.
2819 ;; Find the variable name; strip whitespace.
2827 val)
2828 ;; Read the variable value.
2838 'eval
2844 ;; We've read all the local variables. Now, return whether the
2845 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2846 ;; variables (if MODE-ONLY is nil.)
2848 result
2855 ;; Find those variables that we may want to save to
2856 ;; `safe-local-variable-values'.
2861 ;; Don't query about the fake variables.
2872 ;; If caller wants only the safe variables,
2873 ;; install only them.
2878 ;; Query, except in the case where all are known safe
2879 ;; if the user wants no quuery in that case.
2885 result unsafe-vars risky-vars))
2891 "Non-nil if SYM is safe as a file-local variable with value VAL.
2892 It is safe if any of these conditions are met:
2894 * There is a matching entry (SYM . VAL) in the
2895 `safe-local-variable-values' user option.
2897 * The `safe-local-variable' property of SYM is a function that
2898 evaluates to a non-nil value with VAL as an argument."
2904 "Non-nil if SYM could be dangerous as a file-local variable.
2905 It is dangerous if either of these conditions are met:
2907 * Its `risky-local-variable' property is non-nil.
2913 ;; If this is an alias, check the base name.
2933 "Return t if it is safe to eval EXP when it is found in a file."
2935 ;; Detect certain `put' expressions.
2941 ;; Only allow safe values of lisp-indent-hook;
2942 ;; not functions.
2945 ;; Only allow indirect form specs.
2946 ;; During bootstrapping, edebug-basic-spec might not be
2947 ;; defined yet.
2951 ;; Allow expressions that the user requested.
2953 ;; Certain functions can be allowed with safe arguments
2954 ;; or can specify verification functions to try.
2962 ok))
2970 ok)))))))
2973 "Set local variable VAR with value VAL.
2974 If VAR is `mode', call `VAL-mode' as a function unless it's
2975 already the major mode."
2985 ;; Make sure the string has no text properties.
2986 ;; Some text properties can get evaluated in various ways,
2987 ;; so it is risky to put them on with a local variable list.
2992 \f
2995 However, the mode will not be changed if
2996 \(1) a local variables list or the `-*-' line specifies a major mode, or
2998 \ not suitable for ordinary files, or
2999 \(3) the new file name does not particularly specify any mode."
3004 "Change name of file visited in current buffer to FILENAME.
3005 This also renames the buffer to correspond to the new file.
3006 The next time the buffer is saved it will go in the newly specified file.
3007 FILENAME nil or an empty string means mark buffer as not visiting any file.
3008 Remember to delete the initial contents of the minibuffer
3009 if you wish to pass an empty string as the argument.
3011 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3012 confirmation in the case where another buffer is already visiting FILENAME.
3014 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3015 the old visited file has been renamed to the new name FILENAME."
3023 nil
3038 filename)))
3050 ;; If new-name == old-name, renaming would add a spurious <2>
3051 ;; and it's considered as a feature in rename-buffer.
3057 ;; Abbreviate the file names of the buffer.
3066 nil)))
3067 ;; write-file-functions is normally used for things like ftp-find-file
3068 ;; that visit things that are not local files as if they were files.
3069 ;; Changing to visit an ordinary local file instead should flush the hook.
3074 ;; If buffer was read-only because of version control,
3075 ;; that reason is gone now, so make it writable.
3079 ;; Turn off backup files for certain file names.
3080 ;; Since this is a permanent local, the major mode won't eliminate it.
3082 backup-enable-predicate
3088 ;; If auto-save was not already on, turn it on if appropriate.
3092 ;; If auto save is on, start using a new name.
3093 ;; We deliberately don't rename or delete the old auto save
3094 ;; for the old visited file name. This is because perhaps
3095 ;; the user wants to save the new state and then compare with the
3096 ;; previous state from the auto save file.
3099 ;; Rename the old auto save file if any.
3106 ;; Update the major mode, if the file name determines it.
3108 ;; Don't change the mode if it is special.
3111 ;; Don't change the mode if the local variable list specifies it.
3117 "Write current buffer into file FILENAME.
3118 This makes the buffer visit that file, and marks it as not modified.
3120 If you specify just a directory name as FILENAME, that means to use
3121 the default file name but in that directory. You can also yank
3122 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3124 If the buffer is not already visiting a file, the default file name
3125 for the output file is the buffer name.
3127 If optional second arg CONFIRM is non-nil, this function
3128 asks for confirmation before overwriting an existing file.
3129 Interactively, confirmation is required unless you supply a prefix argument."
3130 ;; (interactive "FWrite file: ")
3134 nil nil nil nil)
3138 default-directory)
3139 nil nil))
3143 ;; If arg is just a directory,
3144 ;; use the default file name, but in that directory.
3155 ;; Make buffer writable if file is writable.
3160 ;; It's likely that the VC status at the new location is different from
3161 ;; the one at the old location.
3163 \f
3165 "Make a backup of the disk file visited by the current buffer, if appropriate.
3166 This is normally done before saving the buffer the first time.
3168 A backup may be done by renaming or by copying; see documentation of
3169 variable `make-backup-files'. If it's done by renaming, then the file is
3170 no longer accessible under its old name.
3172 The value is non-nil after a backup was made by renaming.
3173 It has the form (MODES . BACKUPNAME).
3174 MODES is the result of `file-modes' on the original
3175 file; this means that the caller, after saving the buffer, should change
3176 the modes of the new file to agree with the old modes.
3177 BACKUPNAME is the backup file name, which is the old file renamed."
3184 backup-info backupname targets setmodes)
3185 ;; If specified name is a symbolic link, chase it to the target.
3186 ;; Thus we make the backups in the directory where the real file is.
3191 ;; (if (file-directory-p buffer-file-name)
3192 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3196 ;; If have old versions to maybe delete,
3197 ;; ask the user to confirm now, before doing anything.
3198 ;; But don't actually delete til later.
3203 real-file-name)))))
3205 ;; Actually write the back up file.
3208 ; (file-symlink-p buffer-file-name)
3209 backup-by-copying
3210 ;; Don't rename a suid or sgid file.
3225 ;; rename-file should delete old backup.
3229 ;; If trouble writing the backup, write it in ~.
3234 backupname)
3238 ;; Now delete the old versions, if desired.
3245 setmodes)
3252 ;; Create temp files with strict access rights. It's easy to
3253 ;; loosen them later, whereas it's impossible to close the
3254 ;; time-window of loose permissions otherwise.
3257 ;; Try to overwrite old backup first.
3265 nil)
3267 ;; The file was somehow created by someone else between
3268 ;; `delete-file' and `copy-file', so let's try again.
3269 ;; rms says "I think there is also a possible race
3270 ;; condition for making backup files" (emacs-devel 20070821).
3271 nil)))
3272 ;; Reset the umask.
3278 "Return file NAME sans backup versions or strings.
3279 This is a separate procedure so your site-init or startup file can
3280 redefine it.
3281 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3282 we do not remove backup version numbers, only true file version numbers."
3288 ;; VMS version number is (a) semicolon, optional
3289 ;; sign, zero or more digits or (b) period, option
3290 ;; sign, zero or more digits, provided this is the
3291 ;; second period encountered outside of the
3292 ;; device/directory part of the file name.
3295 name)
3305 "Return t if deleting FILE and rewriting it would preserve the owner."
3310 ;; Return t if the file doesn't exist, since it's true that no
3311 ;; information would be lost by an (attempted) delete and create.
3317 The extension, in a file name, is the part that follows the last `.',
3318 except that a leading `.', if any, doesn't count."
3321 directory)
3325 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3326 ;; we don't want to expand it.
3329 filename))))
3333 The extension, in a file name, is the part that follows the last `.',
3334 excluding version numbers and backup suffixes,
3335 except that a leading `.', if any, doesn't count.
3336 Return nil for extensionless file names such as `foo'.
3337 Return the empty string for file names such as `foo.'.
3339 If PERIOD is non-nil, then the returned value includes the period
3340 that delimits the extension, and if FILENAME has no extension,
3351 "A function to use instead of the default `make-backup-file-name'.
3352 A value of nil gives the default `make-backup-file-name' behavior.
3354 This could be buffer-local to do something special for specific
3355 files. If you define it, you may need to change `backup-file-name-p'
3356 and `file-name-sans-versions' too.
3358 See also `backup-directory-alist'."
3364 "Alist of filename patterns and backup directory names.
3365 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3366 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3367 relative or absolute. If it is absolute, so that all matching files
3368 are backed up into the same directory, the file names in this
3369 directory will be the full name of the file backed up with all
3370 directory separators changed to `!' to prevent clashes. This will not
3371 work correctly if your filesystem truncates the resulting name.
3373 For the common case of all backups going into one directory, the alist
3375 directory name.
3377 If this variable is nil, or it fails to match a filename, the backup
3378 is made in the original file's directory.
3380 On MS-DOS filesystems without long names this variable is always
3381 ignored."
3387 "Default `backup-enable-predicate' function.
3388 Checks for files in `temporary-file-directory',
3389 `small-temporary-file-directory', and /tmp."
3392 ;; Directory is under temporary-file-directory.
3397 ;; Directory is under /tmp.
3402 0 nil
3404 ;; Directory is under small-temporary-file-directory.
3409 "Create the non-numeric backup file name for FILE.
3410 Normally this will just be the file's name with `~' appended.
3411 Customization hooks are provided as follows.
3413 If the variable `make-backup-file-name-function' is non-nil, its value
3414 should be a function which will be called with FILE as its argument;
3415 the resulting name is used.
3417 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3418 the documentation of that variable. If the directory for the backup
3419 doesn't exist, it is created."
3433 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3435 elt backup-directory abs-backup-directory)
3440 alist nil)))
3441 ;; If backup-directory is relative, it should be relative to the
3442 ;; file's directory. By expanding explicitly here, we avoid
3443 ;; depending on default-directory.
3452 abs-backup-directory nil))))
3454 file
3458 ;; Normalize DOSish file names: downcase the drive
3459 ;; letter, if any, and replace the leading "x:" with
3460 ;; "/drive_x".
3463 ;; Replace any invalid file-name characters (for the
3464 ;; case of backing up remote files).
3468 "drive_"
3471 ""
3474 ;; Make the name unique by substituting directory
3475 ;; separators. It may not really be worth bothering about
3476 ;; doubling `!'s in the original name...
3481 backup-directory))
3486 "Return non-nil if FILE is a backup file name (numeric or not).
3487 This is a separate function so you can redefine it for customization.
3488 You may need to redefine `file-name-sans-versions' as well."
3493 ;; This is used in various files.
3494 ;; The usage of backup-extract-version-start is not very clean,
3495 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3497 "Given the name of a numeric backup file, FN, return the backup number.
3498 Uses the free variable `backup-extract-version-start', whose value should be
3499 the index in the name where the version number begins."
3505 ;; I believe there is no need to alter this behavior for VMS;
3506 ;; since backup files are not made on VMS, it should not get called.
3508 "Find a file name for a backup file FN, and suggestions for deletions.
3509 Value is a list whose car is the name for the backup file
3510 and whose cdr is a list of old versions to consider deleting now.
3511 If the value is nil, don't make a backup.
3512 Uses `backup-directory-alist' in the same way as does
3513 `make-backup-file-name'."
3515 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3519 ;; We don't support numbered backups on plain MS-DOS
3520 ;; when long file names are unavailable.
3530 possibilities deserve-versions-p versions)
3533 base-versions
3536 possibilities)
3537 #'<)
3542 kept-old-versions
3543 kept-new-versions
3550 ;; Delete nothing if there is overflow
3551 ;; in the number of versions to keep.
3557 v))))))))))
3560 "Return number of names file FILENAME has."
3563 ;; (defun file-relative-name (filename &optional directory)
3564 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3565 ;; This function returns a relative file name which is equivalent to FILENAME
3566 ;; when used with that default directory as the default.
3567 ;; If this is impossible (which can happen on MSDOS and Windows
3568 ;; when the file name and directory use different drive names)
3569 ;; then it returns FILENAME."
3570 ;; (save-match-data
3571 ;; (let ((fname (expand-file-name filename)))
3572 ;; (setq directory (file-name-as-directory
3573 ;; (expand-file-name (or directory default-directory))))
3574 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3575 ;; ;; drive names, they can't be relative, so return the absolute name.
3576 ;; (if (and (or (eq system-type 'ms-dos)
3577 ;; (eq system-type 'cygwin)
3578 ;; (eq system-type 'windows-nt))
3579 ;; (not (string-equal (substring fname 0 2)
3580 ;; (substring directory 0 2))))
3581 ;; filename
3582 ;; (let ((ancestor ".")
3583 ;; (fname-dir (file-name-as-directory fname)))
3584 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3585 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3586 ;; (setq directory (file-name-directory (substring directory 0 -1))
3587 ;; ancestor (if (equal ancestor ".")
3588 ;; ".."
3589 ;; (concat "../" ancestor))))
3590 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3591 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3592 ;; ;; We matched within FNAME's directory part.
3593 ;; ;; Add the rest of FNAME onto ANCESTOR.
3594 ;; (let ((rest (substring fname (match-end 0))))
3595 ;; (if (and (equal ancestor ".")
3596 ;; (not (equal rest "")))
3597 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3598 ;; rest
3599 ;; (concat (file-name-as-directory ancestor) rest)))
3600 ;; ;; We matched FNAME's directory equivalent.
3601 ;; ancestor))))))
3604 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3605 This function returns a relative file name which is equivalent to FILENAME
3606 when used with that default directory as the default.
3607 If FILENAME and DIRECTORY lie on different machines or on different drives
3608 on a DOS/Windows machine, it returns FILENAME in expanded form."
3612 default-directory))))
3618 ;; Test for different drives on DOS/Windows
3620 ;; Should `cygwin' really be included here? --stef
3623 ;; Test for different remote file system identification
3625 filename
3631 directory nil nil case-fold-search))
3633 directory nil nil case-fold-search))))
3636 ".."
3638 ;; Now ancestor is empty, or .., or ../.., etc.
3640 directory nil nil case-fold-search))
3641 ;; We matched within FILENAME's directory part.
3642 ;; Add the rest of FILENAME onto ANCESTOR.
3645 ;; But don't bother with ANCESTOR if it would give us `./'.
3646 rest
3648 ;; We matched FILENAME's directory equivalent.
3649 ancestor))))))
3650 \f
3652 "Save current buffer in visited file if modified.
3653 Variations are described below.
3655 By default, makes the previous version into a backup file
3656 if previously requested or if this is the first save.
3658 to become a backup when the next save is done.
3660 unconditionally makes the previous version into a backup file.
3662 to become a backup when the next save is done,
3663 and unconditionally makes the previous version into a backup file.
3665 With a numeric argument of 0, never make the previous version
3666 into a backup file.
3668 If a file's name is FOO, the names of its numbered backup versions are
3669 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3670 Numeric backups (rather than FOO~) will be made if value of
3671 `version-control' is not the atom `never' and either there are already
3672 numeric versions of the file being backed up, or `version-control' is
3673 non-nil.
3674 We don't want excessive versions piling up, so there are variables
3675 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3676 and `kept-new-versions', which tells how many newest versions to keep.
3677 Defaults are 2 old versions and 2 new.
3678 `dired-kept-versions' controls dired's clean-directory (.) command.
3679 If `delete-old-versions' is nil, system will query user
3680 before trimming versions. Otherwise it does it silently.
3682 If `vc-make-backup-files' is nil, which is the default,
3683 no backup files are made for files managed by version control.
3684 (This is because the version control system itself records previous versions.)
3686 See the subroutine `basic-save-buffer' for more information."
3699 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3700 Normally delete only if the file was written by this Emacs since
3701 the last real save, but optional arg FORCE non-nil means delete anyway."
3715 "Normal hook that is run before a buffer is saved to its file."
3721 "Normal hook that is run after a buffer is saved to its file."
3727 "If non-nil, use this coding system for saving the buffer.
3728 More precisely, use this coding system in place of the
3729 value of `buffer-file-coding-system', when saving the buffer.
3730 Calling `write-region' for any purpose other than saving the buffer
3731 will still use `buffer-file-coding-system'; this variable has no effect
3738 "Save the current buffer in its visited file, if it has been modified.
3739 The hooks `write-contents-functions' and `write-file-functions' get a chance
3740 to do the job of saving; if they do not, then the buffer is saved in
3741 the visited file in the usual way.
3742 Before and after saving the buffer, this function runs
3743 `before-save-hook' and `after-save-hook', respectively."
3746 ;; In an indirect buffer, save its base buffer instead.
3751 setmodes)
3752 ;; On VMS, rename file and buffer to get rid of version number.
3757 ;; Strip VMS version number before save.
3760 ;; Construct a (unique) buffer name to correspond.
3765 ;; If buffer has no file name, ask user for one.
3772 ;; Signal an error if the user specified the name of an
3773 ;; existing directory.
3776 filename))
3778 ;; Signal an error if the specified name refers to a
3779 ;; non-existing directory.
3809 ;; Support VC version backups.
3815 ;; If a hook returned t, file is already "written".
3816 ;; Otherwise, write it the usual way now.
3818 ;; Now we have saved the current buffer. Let's make sure
3819 ;; that buffer-file-coding-system is fixed to what
3820 ;; actually used for saving by binding it locally.
3830 ;; If the auto-save file was recent before this command,
3831 ;; delete it now.
3833 ;; Support VC `implicit' locking.
3838 ;; This does the "real job" of writing a buffer into its visited file
3839 ;; and making a backup file. This is what is normally done
3840 ;; but inhibited if one of write-file-functions returns non-nil.
3841 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3850 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3864 buffer-file-name)))
3872 ;; If file is precious, write temp name, then rename it.
3873 ;; This requires write access to the containing dir,
3874 ;; which is why we don't try it if we don't have that access.
3876 tempname succeed
3879 ;; Create temp files with strict access rights. It's easy to
3880 ;; loosen them later, whereas it's impossible to close the
3881 ;; time-window of loose permissions otherwise.
3886 ;; Try various temporary names.
3887 ;; This code follows the example of make-temp-file,
3888 ;; but it calls write-region in the appropriate way
3889 ;; for saving the buffer.
3896 tempname nil realname
3898 nil)
3900 ;; The file was somehow created by someone else between
3901 ;; `make-temp-name' and `write-region', let's try again.
3902 nil)
3904 ;; Reset the umask.
3906 ;; If we failed, restore the buffer's modtime.
3909 ;; Since we have created an entirely new file,
3910 ;; make sure it gets the right permission bits set.
3914 buffer-file-name)))
3915 ;; We succeeded in writing the temp file,
3916 ;; so rename it.
3918 ;; If file not writable, see if we can make it writable
3919 ;; temporarily while we write it.
3920 ;; But no need to do so if we have just backed it up
3921 ;; (setmodes is set) because that says we're superseding.
3923 ;; Change the mode back, after writing.
3930 buffer-file-name nil t buffer-file-truename)
3932 ;; If we get an error writing the new file, and we made
3933 ;; the backup by renaming, undo the backing-up.
3938 setmodes))
3941 "View the differences between BUFFER and its associated file.
3942 This requires the external program `diff' to be in your `exec-path'."
3957 ;; Display that message for 1 second so that user can read it
3958 ;; in the minibuffer.
3960 ;; return always nil, so that save-buffers-kill-emacs will not move
3961 ;; over to the next unsaved buffer when calling `d'.
3962 nil)
3965 '((?\C-r
3971 ;; Return nil to ask about BUF again.
3972 nil)
3980 nil)
3989 "Save some modified file-visiting buffers. Asks user about each one.
3990 You can answer `y' to save, `n' not to save, `C-r' to look at the
3991 buffer in question with `view-buffer' before deciding or `d' to
3992 view the differences using `diff-buffer-with-file'.
3994 Optional argument (the prefix) non-nil means save all with no questions.
3995 Optional second argument PRED determines which buffers are considered:
3996 If PRED is nil, all the file-visiting buffers are considered.
3997 If PRED is t, then certain non-file buffers will also be considered.
3998 If PRED is a zero-argument function, it indicates for each buffer whether
3999 to consider it or not when called with that buffer current.
4001 See `save-some-buffers-action-alist' if you want to
4002 change the additional actions you can take on files."
4006 files-done abbrevs-done)
4008 ;; First save any buffers that we're supposed to save unconditionally.
4009 ;; That way the following code won't ask about them.
4014 ;; Ask about those buffers that merit it,
4015 ;; and record the number thus saved.
4031 t
4044 save-some-buffers-action-alist))
4045 ;; Maybe to save abbrevs, and record whether
4046 ;; we either saved them or asked to.
4052 abbrev-file-name)))
4054 ;; Don't keep bothering user if he says no.
4059 "(Some special files were saved without asking)"
4061 \f
4063 "Mark current buffer as unmodified, not needing to be saved.
4066 It is not a good idea to use this function in Lisp programs, because it
4067 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4074 "Change whether this buffer is visiting its file read-only.
4075 With prefix argument ARG, make the buffer read-only if ARG is
4076 positive, otherwise make it writable. If visiting file read-only
4077 and `view-read-only' is non-nil, enter view mode."
4082 nil ; do nothing.
4083 ;; Toggle.
4090 ;; If view-mode is already active, `view-mode-enter' is a nop.
4102 "Insert contents of file FILENAME into buffer after point.
4103 Set mark after the inserted text.
4105 This function is meant for the user to run interactively.
4106 Don't call it from programs! Use `insert-file-contents' instead.
4107 \(Its calling sequence is different; see its documentation)."
4112 "Append the contents of the region to the end of file FILENAME.
4113 When called from a function, expects three arguments,
4114 START, END and FILENAME. START and END are buffer positions
4115 saying what text to write."
4120 "Return most recent backup file for FILENAME or nil if no backups exist."
4121 ;; `make-backup-file-name' will get us the right directory for
4122 ;; ordinary or numeric backups. It might create a directory for
4123 ;; backups as a side-effect, according to `backup-directory-alist'.
4130 tem)
4139 newest))
4142 "Rename current buffer to a similar name not already taken.
4143 This function is useful for creating multiple shell process buffers
4144 or multiple mail buffers, etc."
4152 ;; If the existing buffer name has a <NNN>,
4153 ;; which isn't part of the file name (if any),
4154 ;; then get rid of that.
4160 "Create the directory DIR and any nonexistent parent dirs.
4161 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4163 Interactively, the default choice of directory to create
4164 is the current default directory for file names.
4165 That is useful when you have visited a file in a nonexistent directory.
4167 Noninteractively, the second (optional) argument PARENTS says whether
4168 to create parent directories if they don't exist. Interactively,
4169 this happens by default."
4172 nil nil)
4173 t))
4174 ;; If default-directory is a remote directory,
4175 ;; make sure we find its make-directory handler.
4183 create-list)
4190 \f
4193 "Function to use to revert this buffer, or nil to do the default.
4194 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4199 "Function to use to insert contents when reverting this buffer.
4200 Gets two args, first the nominal file name to use,
4201 and second, t if reading the auto-save file.
4206 "Function to check whether a non-file buffer needs reverting.
4207 This should be a function with one optional argument NOCONFIRM.
4208 Auto Revert Mode passes t for NOCONFIRM. The function should return
4209 non-nil if the buffer should be reverted. A return value of
4210 `fast' means that the need for reverting was not checked, but
4211 that reverting the buffer is fast. The buffer is current when
4212 this function is called.
4214 The idea behind the NOCONFIRM argument is that it should be
4215 non-nil if the buffer is going to be reverted without asking the
4216 user. In such situations, one has to be careful with potentially
4217 time consuming operations.
4219 For more information on how this variable is used by Auto Revert mode,
4223 "Normal hook for `revert-buffer' to run before reverting.
4224 If `revert-buffer-function' is used to override the normal revert
4228 "Normal hook for `revert-buffer' to run after reverting.
4229 Note that the hook value that it runs is the value that was in effect
4230 before reverting; that makes a difference if you have buffer-local
4231 hook functions.
4233 If `revert-buffer-function' is used to override the normal revert
4239 "Replace current buffer text with the text of the visited file on disk.
4240 This undoes all changes since the file was visited or saved.
4241 With a prefix argument, offer to revert from latest auto-save file, if
4242 that is more recent than the visited file.
4244 This command also implements an interface for special buffers
4245 that contain text which doesn't come from a file, but reflects
4246 some other data instead (e.g. Dired buffers, `buffer-list'
4247 buffers). This is done via the variable
4248 `revert-buffer-function'. In these cases, it should reconstruct
4249 the buffer contents from the appropriate data.
4251 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4252 to revert from the auto-save file when this is nil. Note that the
4253 sense of this argument is the reverse of the prefix argument, for the
4254 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4255 to nil.
4257 Optional second argument NOCONFIRM means don't ask for confirmation at
4258 all. \(The variable `revert-without-query' offers another way to
4259 revert buffers without querying for confirmation.)
4261 Optional third argument PRESERVE-MODES non-nil means don't alter
4262 the files modes. Normally we reinitialize them using `normal-mode'.
4264 If the value of `revert-buffer-function' is non-nil, it is called to
4265 do all the work for this command. Otherwise, the hooks
4266 `before-revert-hook' and `after-revert-hook' are run at the beginning
4267 and the end, and if `revert-buffer-insert-file-contents-function' is
4268 non-nil, it is called instead of rereading visited file contents."
4270 ;; I admit it's odd to reverse the sense of the prefix argument, but
4271 ;; there is a lot of code out there which assumes that the first
4272 ;; argument should be t to avoid consulting the auto-save file, and
4273 ;; there's no straightforward way to encourage authors to notice a
4274 ;; reversal of the argument sense. So I'm just changing the user
4275 ;; interface, but leaving the programmatic interface the same.
4283 buffer-auto-save-file-name
4288 buffer-auto-save-file-name
4289 buffer-file-name)))
4299 file-name)))
4301 ;; If file was backed up but has changed since,
4302 ;; we shd make another backup.
4306 ;; Effectively copy the after-revert-hook status,
4307 ;; since after-find-file will clobber it.
4310 after-revert-hook))
4315 ;; Get rid of all undo records for this buffer.
4317 ;; Don't make undo records for the reversion.
4320 file-name auto-save-p)))
4323 "File %s no longer exists!"
4325 file-name))
4328 "File %s no longer readable!"
4330 file-name))
4332 ;; Bind buffer-file-name to nil
4333 ;; so that we don't try to lock the file.
4339 ;; Auto-saved file should be read by Emacs'
4340 ;; internal coding.
4343 buffer-file-coding-system-explicit))))
4345 coding-system-for-read
4347 coding-system-for-read)
4349 ;; As a coding system suitable for multibyte
4350 ;; buffer is specified, make the current
4351 ;; buffer multibyte.
4354 ;; This force after-insert-file-set-coding
4355 ;; (called from insert-file-contents) to set
4356 ;; buffer-file-coding-system to a proper value.
4359 ;; Note that this preserves point in an intelligent way.
4363 nil nil t))
4365 nil nil t)))))
4366 ;; Recompute the truename in case changes in symlinks
4367 ;; have changed the truename.
4371 ;; Run after-revert-hook as it was before we reverted.
4375 local-hook)
4378 t))))))
4381 "Recover the visited file--get contents from its last auto-save file."
4386 "Visit file FILE, but get contents from its last auto-save file."
4387 ;; Actually putting the file name in the minibuffer should be used
4388 ;; only rarely.
4389 ;; Not just because users often use the default.
4409 ;; Use insert-directory-safely, not insert-directory,
4410 ;; because these files might not exist. In particular,
4411 ;; FILE might not exist if the auto-save file was for
4412 ;; a buffer that didn't visit a file, such as "*mail*".
4413 ;; The code in v20.x called `ls' directly, so we need
4414 ;; to emulate what `ls' did in that case.
4420 ;; Keep the current buffer-file-coding-system.
4422 ;; Auto-saved file should be read with special coding.
4431 "Recover auto save files from a previous Emacs session.
4432 This command first displays a Dired buffer showing you the
4433 previous sessions that you could recover from.
4434 To choose one, move point to the proper line and then type C-c C-c.
4435 Then you'll be asked about a number of files to recover."
4445 auto-save-list-file-prefix)))
4446 t)
4455 ;; Each line starts with a space
4456 ;; so that Font Lock mode won't highlight the first character.
4465 "Choose one saved session to recover auto-save files from.
4466 This command is used in the special Dired buffer created by
4469 ;; Get the name of the session file to recover from.
4471 files
4477 ;; Read in the auto-save-list file.
4481 ;; Loop thru the text of that file
4482 ;; and get out the names of the files to recover.
4486 ;; This is a pair of lines for a non-file-visiting buffer.
4487 ;; Get the auto-save file name and manufacture
4488 ;; a "visited file name" from that.
4491 ;; If there is no auto-save file name, the
4492 ;; auto-save-list file is probably corrupted.
4505 ;; This pair of lines is a file-visiting
4506 ;; buffer. Use the visited file name.
4516 ;; Ignore a file if its auto-save file does not exist now.
4520 ;; The file contains a pair of line for each auto-saved buffer.
4521 ;; The first line of the pair contains the visited file name
4522 ;; or is empty if the buffer was not visiting a file.
4523 ;; The second line is the auto-save file name.
4531 files
4537 "Kill buffer if confirmed."
4545 "Kill some buffers. Asks the user whether to kill each one of them.
4546 Non-interactively, if optional argument LIST is non-nil, it
4547 specifies the list of buffers to kill, asking for approval for each one."
4555 ; if we killed the base buffer.
4562 "Kill buffers whose name matches the specified regexp.
4563 The optional second argument indicates whether to kill internal buffers too."
4572 \f
4574 "Toggle auto-saving of contents of current buffer.
4575 With prefix argument ARG, turn auto-saving on if positive, else off."
4580 ;; If auto-save is off because buffer has shrunk,
4581 ;; then toggling should turn it on.
4586 buffer-file-name
4588 ;; If -1 was stored here, to temporarily turn off saving,
4589 ;; turn it back on.
4595 buffer-auto-save-file-name)
4598 "Adjust current buffer's auto save file name for current conditions.
4599 Also rename any existing auto save file, if it was made in this session."
4611 "Return file name to use for auto-saves of current buffer.
4612 Does not consider `auto-save-visited-file-name' as that variable is checked
4613 before calling this function. You can redefine this for customization.
4614 See also `auto-save-file-name-p'."
4622 result uniq)
4623 ;; Apply user-specified translations
4624 ;; to the file name.
4628 filename)
4638 filename))))
4643 ;; We truncate the file name to DOS 8+3 limits
4644 ;; before doing anything else, because the regexp
4645 ;; passed to string-match below cannot handle
4646 ;; extensions longer than 3 characters, multiple
4647 ;; dots, and other atrocities.
4652 fn)
4657 "#"
4660 ;; Make sure auto-save file names don't contain characters
4661 ;; invalid for the underlying filesystem.
4663 ;; Don't modify remote (ange-ftp) filenames
4666 result))))
4668 ;; Deal with buffers that don't have any associated files. (Mail
4669 ;; mode tends to create a good number of these.)
4673 file-name)
4674 ;; Restrict the characters used in the file name to those which
4675 ;; are known to be safe on all filesystems, url-encoding the
4676 ;; rest.
4677 ;; We do this on all platforms, because even if we are not
4678 ;; running on DOS/Windows, the current directory may be on a
4679 ;; mounted VFAT filesystem, such as a USB memory stick.
4683 ;; For multibyte characters, this will produce more than
4684 ;; 2 hex digits, so is not true URL encoding.
4688 ;; Generate the file name.
4694 ;; Try a few alternative directories, to get one we can
4695 ;; write it.
4701 ;; Don't modify remote (ange-ftp) filenames
4703 ;; The call to convert-standard-filename is in case
4704 ;; buffer-name includes characters not allowed by the
4705 ;; DOS/Windows filesystems. make-temp-file writes to the
4706 ;; file it creates, so we must fix the file name _before_
4707 ;; make-temp-file is called.
4709 fname))
4711 ;; make-temp-file creates the file,
4712 ;; but we don't want it to exist until we do an auto-save.
4716 file-name)))
4719 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4720 FILENAME should lack slashes. You can redefine this for customization."
4722 \f
4724 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4725 The generated regexp will match a filename only if the filename
4726 matches that wildcard according to shell rules. Only wildcards known
4727 by `sh' are supported."
4729 ;; Copy the initial run of non-special characters.
4732 ;; If no special characters, we're almost done.
4736 j)
4738 result
4759 ;; Found "[^". Insert a `\0' character
4760 ;; (which cannot happen in a filename)
4761 ;; into the character class, so that `^'
4762 ;; is not the first character after `[',
4763 ;; and thus non-special in a regexp.
4768 ;; I don't think `]' can appear in a
4769 ;; character class in a wildcard, but
4770 ;; let's be general here.
4777 i
4790 ;; Shell wildcards should match the entire filename,
4791 ;; not its part. Make the regexp say so.
4793 \f
4796 "Switches for `list-directory' to pass to `ls' for brief listing."
4802 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4804 "Switches for `list-directory' to pass to `ls' for verbose listing."
4809 "Expand wildcard pattern PATTERN.
4810 This returns a list of file names which match the pattern.
4812 If PATTERN is written as an absolute file name,
4813 the values are absolute also.
4815 If PATTERN is written as a relative file name, it is interpreted
4816 relative to the current default directory, `default-directory'.
4817 The file names returned are normally also relative to the current
4818 default directory. However, if FULL is non-nil, they are absolute."
4822 ;; A list of all dirs that DIRPART specifies.
4823 ;; This can be more than one dir
4824 ;; if DIRPART contains wildcards.
4829 contents)
4834 ;; Filter out "." and ".."
4839 name))
4846 this-dir-contents)
4847 this-dir-contents)
4848 contents))))
4850 contents)))
4853 "Display a list of files in or matching DIRNAME, a la `ls'.
4854 DIRNAME is globbed by the shell if necessary.
4855 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4856 Actions controlled by variables `list-directory-brief-switches'
4857 and `list-directory-verbose-switches'."
4861 nil default-directory nil)
4862 pfx)))
4864 list-directory-brief-switches))
4865 buffer)
4878 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4886 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4888 PATTERN is assumed to represent a file-name wildcard suitable for the
4889 underlying filesystem. For Unix and GNU/Linux, the characters from the
4891 the parts of the pattern which don't include wildcard characters are
4892 quoted with double quotes.
4893 Existing quote characters in PATTERN are left alone, so you can pass
4894 PATTERN that already quotes some of the special characters."
4898 ;; DOS/Windows don't allow `"' in file names. So if the
4899 ;; argument has quotes, we can safely assume it is already
4900 ;; quoted by the caller.
4902 ;; We quote [&()#$'] in case their shell is a port of a
4903 ;; Unixy shell. We quote [,=+] because stock DOS and
4904 ;; Windows shells require that in some cases, such as
4905 ;; passing arguments to batch files that use positional
4906 ;; arguments like %1.
4908 pattern
4911 end)
4928 pattern))))
4935 "Program to get the amount of free space on a file system.
4936 We assume the output has the format of `df'.
4937 The value of this variable must be just a command name or file name;
4938 if you want to specify options, use `directory-free-space-args'.
4940 A value of nil disables this feature.
4942 If the function `file-system-info' is defined, it is always used in
4943 preference to the program given by this variable."
4949 "Options to use when running `directory-free-space-program'."
4954 "Return the amount of free space on directory DIR's file system.
4955 The result is a string that gives the number of free 1KB blocks,
4956 or nil if the system call or the program which retrieve the information
4957 fail. It returns also nil when DIR is a remote directory.
4959 This function calls `file-system-info' if it is available, or invokes the
4960 program specified by `directory-free-space-program' if that is non-nil."
4962 ;; Try to find the number of free blocks. Non-Posix systems don't
4963 ;; always have df, but might have an equivalent system call.
4972 nil t nil
4973 directory-free-space-args
4974 dir)))
4975 ;; Usual format is a header line followed by a line of
4976 ;; numbers.
4981 ;; Move to the end of the "available blocks" number.
4984 ;; Copy it into AVAILABLE.
4989 ;; The following expression replaces `dired-move-to-filename-regexp'.
4993 ;; In some locales, month abbreviations are as short as 2 letters,
4994 ;; and they can be followed by ".".
4995 ;; In Breton, a month name can include a quote character.
5008 s "+"
5011 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5012 ;; omits the Kanji characters after month and day-of-month.
5013 ;; On Mac OS X 10.3, the date format in East Asian locales is
5014 ;; day-of-month digits followed by month digits.
5020 ;; The "[0-9]" below requires the previous column to end in a digit.
5021 ;; This avoids recognizing `1 may 1997' as a date in the line:
5022 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5024 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5025 ;; The ".*" below finds the last match if there are multiple matches.
5026 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5027 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5029 ;; vc dired listings provide the state or blanks between file
5030 ;; permissions and date. The state is always surrounded by
5031 ;; parantheses:
5032 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5033 ;; This is not supported yet.
5037 "Regular expression to match up to the file name in a directory listing.
5038 The default value is designed to recognize dates and times
5043 ;; insert-directory
5044 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5045 ;; FULL-DIRECTORY-P is nil.
5046 ;; The single line of output must display FILE's name as it was
5047 ;; given, namely, an absolute path name.
5048 ;; - must insert exactly one line for each file if WILDCARD or
5049 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5050 ;; before the file lines, plus optional text after the file lines.
5051 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5052 ;; allowed.
5053 ;; File lines should display the basename.
5054 ;; - must be consistent with
5055 ;; - functions dired-move-to-filename, (these two define what a file line is)
5056 ;; dired-move-to-end-of-filename,
5057 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5058 ;; dired-insert-headerline
5059 ;; dired-after-subdir-garbage (defines what a "total" line is)
5060 ;; - variable dired-subdir-regexp
5061 ;; - may be passed "--dired" as the first argument in SWITCHES.
5062 ;; Filename handlers might have to remove this switch if their
5063 ;; "ls" command does not support it.
5065 "Insert directory listing for FILE, formatted according to SWITCHES.
5066 Leaves point after the inserted text.
5067 SWITCHES may be a string of options, or a list of strings
5068 representing individual options.
5069 Optional third arg WILDCARD means treat FILE as shell wildcard.
5070 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5071 switches do not contain `d', so that a full listing is expected.
5073 This works by running a directory listing program
5074 whose name is in the variable `insert-directory-program'.
5075 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5077 When SWITCHES contains the long `--dired' option, this function
5078 treats it specially, for the sake of dired. However, the
5079 normally equivalent short `-D' option is just passed on to
5080 `insert-directory-program', as any other option."
5081 ;; We need the directory in order to find the right handler.
5086 wildcard full-directory-p)
5091 ;; Read the actual directory using `insert-directory-program'.
5092 ;; RESULT gets the status code.
5094 ;; putting text property `dired-filename, decode one
5095 ;; bunch by one to preserve that property.
5097 ;; This is to control encoding the arguments in call-process.
5101 default-file-name-coding-system))))
5104 ;; Run ls in the directory part of the file pattern
5105 ;; using the last component as argument.
5112 shell-file-name nil t nil
5113 "-c"
5115 ""
5117 insert-directory-program
5118 " -d "
5120 switches
5122 " -- "
5123 ;; Quote some characters that have
5124 ;; special meanings in shells; but
5125 ;; don't quote the wildcards--we want
5126 ;; them to be special. We also
5127 ;; currently don't quote the quoting
5128 ;; characters in case people want to
5129 ;; use them explicitly to quote
5130 ;; wildcard characters.
5132 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5133 ;; directory if FILE is a symbolic link.
5135 insert-directory-program nil t nil
5139 ;; Split the switches at any spaces so we can
5140 ;; pass separate options as separate args.
5142 ;; Avoid lossage if FILE starts with `-'.
5150 file))))))))
5152 ;; If we got "//DIRED//" in the output, it means we got a real
5153 ;; directory listing, even if `ls' returned nonzero.
5154 ;; So ignore any errors.
5167 ;; The first time ls returns an error,
5168 ;; find the version numbers of ls,
5169 ;; and set insert-directory-ls-version
5170 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5171 ;; is equal or if the info cannot be obtained.
5172 ;; (That can mean it isn't GNU ls.)
5182 comparison)
5198 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5202 ;; If `insert-directory-program' failed, signal an error.
5204 ;; Delete the error message it may have output.
5206 ;; On non-Posix systems, we cannot open a directory, so
5207 ;; don't even try, because that will always result in
5208 ;; the ubiquitous "Access denied". Instead, show the
5209 ;; command line so the user can try to guess what went wrong.
5214 insert-directory-program
5216 file result)
5217 ;; Unix. Access the file to get a suitable error.
5224 ;; The following overshoots by one line for an empty
5225 ;; directory listed with "--dired", but without "-a"
5226 ;; switch, where the ls output contains a
5227 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5228 ;; We take care of that case later.
5236 error-lines)
5237 ;; Find all the lines that are error messages,
5238 ;; and record the bounds of each one.
5245 ;; Now read the numeric positions of file names.
5252 error-lines))
5255 error-lines)))
5257 ;; End is followed by \n or by " -> ".
5259 ;; It seems that we can't trust ls's output as to
5260 ;; byte positions of filenames.
5266 ;; Take care of the case where the ls output contains a
5267 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5268 ;; and we went one line too far back (see above).
5273 ;; Now decode what read if necessary.
5275 file-name-coding-system
5276 default-file-name-coding-system
5278 coding-no-eol
5279 val pos)
5283 ;; If no coding system is specified or detection is
5284 ;; requested, detect the coding.
5298 ;; Force no eol conversion on a file name, so
5299 ;; that CR is preserved.
5307 ;; Try to insert the amount of free space.
5310 ;; First find the line to put it on.
5314 ;; Replace "total" with "used", to avoid confusion.
5320 "Convert `ls --dired' file name position value POS to a buffer position.
5321 File name position values returned in ls --dired output
5322 count only stdout; they don't count the error messages sent to stderr.
5323 So this function converts to them to real buffer positions.
5324 ERROR-LINES is a list of buffer positions of error message lines,
5325 of the form (START END)."
5329 pos)
5333 "Insert directory listing for FILE, formatted according to SWITCHES.
5335 Like `insert-directory', but if FILE does not exist, it inserts a
5336 message to that effect instead of signaling an error."
5339 ;; Simulate the message printed by `ls'.
5343 "Functions to call with no arguments to query about killing Emacs.
5344 If any of these functions returns nil, killing Emacs is cancelled.
5345 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5349 "How to ask for confirmation when leaving Emacs.
5350 If nil, the default, don't ask at all. If the value is non-nil, it should
5351 be a predicate function such as `yes-or-no-p'."
5359 "Offer to save each buffer, then kill this Emacs process.
5360 With prefix arg, silently save all file-visiting buffers, then kill."
5369 ;; process-list is not defined on VMS.
5371 active)
5380 ;; Query the user for other things, perhaps.
5387 "Offer to save each buffer, then kill the current connection.
5388 If the current frame has no client, kill Emacs itself.
5390 With prefix arg, silently save all file-visiting buffers, then kill.
5392 If emacsclient was started with a list of filenames to edit, then
5393 only these files will be asked to be saved."
5401 \f
5402 ;; We use /: as a prefix to "quote" a file name
5403 ;; so that magic file name handlers will not apply to it.
5407 file-name-handler-alist))
5409 ;; We depend on being the last handler on the list,
5410 ;; so that anything else which does need handling
5411 ;; has been handled already.
5412 ;; So it is safe for us to inhibit *all* magic file name handlers.
5421 default-directory))
5422 ;; Get a list of the indices of the args which are file names.
5425 ;; The first six are special because they
5426 ;; return a file name. We want to include the /:
5427 ;; in the return value.
5428 ;; So just avoid stripping it in the first place.
5435 ;; `identity' means just return the first arg
5436 ;; not stripped of its quoting.
5438 ;; `add' means add "/:" to the result.
5440 ;; `quote' means add "/:" to buffer-file-name.
5442 ;; `unquote-then-quote' means set buffer-file-name
5443 ;; temporarily to unquoted filename.
5445 ;; List the arguments which are filenames.
5453 ;; For all other operations, treat the first argument only
5454 ;; as the file name.
5456 method
5457 ;; Copy ARGUMENTS so we can replace elements in it.
5461 ;; Strip off the /: from the file names that have it.
5469 "/"
5485 res))
5488 \f
5489 ;; Symbolic modes and read-file-modes.
5492 "Convert CHAR to a who-mask from a symbolic mode notation.
5493 CHAR is in [ugoa] and represents the users on which rights are applied."
5501 "Convert CHAR to a right-mask from a symbolic mode notation.
5502 CHAR is in [rwxXstugo] and represents a right.
5503 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5510 ;; Rights relative to the previous file modes.
5521 "Convert a right string to a right-mask from a symbolic modes notation.
5523 WHO-MASK is the mask number of the users on which the rights are to be applied.
5524 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5530 char-right)
5537 num-rights
5541 op char-right)))
5542 num-rights))
5545 "Convert symbolic file modes to numeric file modes.
5546 MODES is the string to convert, it should match
5549 notation.
5550 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5563 num-who num-modes)
5566 num-modes)))
5569 "Read file modes in octal or symbolic notation.
5570 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5571 ORIG-FILE is the original file of which modes will be change."
5580 \f
5605 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5606 ;;; files.el ends here