| blob | a7dd79b8a88be88a12222658379d767f9818c789 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 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.)
230 "Non-nil means protect against I/O errors while saving files.
231 Some modes set this non-nil in particular buffers.
233 This feature works by writing the new contents into a temporary file
234 and then renaming the temporary file to replace the original.
235 In this way, any I/O error in writing leaves the original untouched,
236 and there is never any instant where the file is nonexistent.
238 Note that this feature forces backups to be made by copying.
239 Yet, at the same time, saving a precious file
240 breaks any hard links between it and other files."
245 "Control use of version numbers for backup files.
246 When t, make numeric backup versions unconditionally.
247 When nil, make them for files that have some already.
248 The value `never' means do not make them."
258 "When cleaning directory, number of versions to keep."
264 "If t, delete excess backup versions silently.
265 If nil, ask confirmation. Any other value prevents any trimming."
272 "Number of oldest versions to keep when a new numbered backup is made."
278 "Number of newest versions to keep when a new numbered backup is made.
279 Includes the new backup. Must be > 0"
285 "Whether to add a newline automatically at the end of the file.
287 A value of t means do this only when the file is about to be saved.
288 A value of `visit' means do this right after the file is visited.
289 A value of `visit-save' means do it at both of those times.
290 Any other non-nil value means ask user whether to add a newline, when saving.
291 A value of nil means don't add newlines.
293 Certain major modes set this locally to the value obtained
294 from `mode-require-final-newline'."
303 "Whether to add a newline at end of file, in certain major modes.
304 Those modes set `require-final-newline' to this value when you enable them.
305 They do so because they are often used for files that are supposed
306 to end in newlines, and the question is how to arrange that.
308 A value of t means do this only when the file is about to be saved.
309 A value of `visit' means do this right after the file is visited.
310 A value of `visit-save' means do it at both of those times.
311 Any other non-nil value means ask user whether to add a newline, when saving.
313 A value of nil means do not add newlines. That is a risky choice in this
314 variable since this value is used for modes for files that ought to have
315 final newlines. So if you set this to nil, you must explicitly check and
316 add a final newline, whenever you save a file that really needs one."
326 "Non-nil says by default do auto-saving of every file-visiting buffer."
331 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
332 Normally auto-save files are written under other names."
338 ;; Don't put "\\2" inside expand-file-name, since it will be
339 ;; transformed to "/2" on DOS/Windows.
341 "Transforms to apply to buffer file name before making auto-save file name.
342 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
343 REGEXP is a regular expression to match against the file name.
344 If it matches, `replace-match' is used to replace the
345 matching part with REPLACEMENT.
346 If the optional element UNIQUIFY is non-nil, the auto-save file name is
347 constructed by taking the directory part of the replaced file-name,
348 concatenated with the buffer file name with all directory separators
349 changed to `!' to prevent clashes. This will not work
350 correctly if your filesystem truncates the resulting name.
352 All the transforms in the list are tried, in the order they are listed.
353 When one transform applies, its result is final;
354 no further transforms are tried.
356 The default value is set up to put the auto-save file into the
357 temporary directory (see the variable `temporary-file-directory') for
358 editing a remote file.
360 On MS-DOS filesystems without long names this variable is always
361 ignored."
368 "Non-nil means save word abbrevs too when files are saved.
369 If `silently', don't ask the user before saving."
374 "Non-nil means allow `find-file' to visit directories.
375 To visit the directory, `find-file' runs `find-directory-functions'."
380 "List of functions to try in sequence to visit a directory.
381 Each function is called with the directory name as the sole argument
382 and should return either a buffer or nil."
386 ;;;It is not useful to make this a local variable.
387 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
389 "List of functions to be called for `find-file' on nonexistent file.
390 These functions are called as soon as the error is detected.
391 Variable `buffer-file-name' is already set up.
396 ;;;It is not useful to make this a local variable.
397 ;;;(put 'find-file-hooks 'permanent-local t)
399 "List of functions to be called after a buffer is loaded from a file.
400 The buffer's local variables (if any) will have been processed before the
401 functions are called."
409 "List of functions to be called before writing out a buffer to a file.
410 If one of them returns non-nil, the file is considered already written
411 and the rest are not called.
412 These hooks are considered to pertain to the visited file.
413 So any buffer-local binding of this variable is discarded if you change
415 change the major mode.
417 This hook is not run if any of the functions in
418 `write-contents-functions' returns non-nil. Both hooks pertain
419 to how to save a buffer to file, for instance, choosing a suitable
420 coding system and setting mode bits. (See Info
421 node `(elisp)Saving Buffers'.) To perform various checks or
432 "List of functions to be called before writing out a buffer to a file.
433 If one of them returns non-nil, the file is considered already written
434 and the rest are not called and neither are the functions in
435 `write-file-functions'.
437 This variable is meant to be used for hooks that pertain to the
438 buffer's contents, not to the particular visited file; thus,
439 `set-visited-file-name' does not clear this variable; but changing the
440 major mode does clear it.
442 For hooks that _do_ pertain to the particular visited file, use
443 `write-file-functions'. Both this variable and
444 `write-file-functions' relate to how a buffer is saved to file.
445 To perform various checks or updates before the buffer is saved,
452 "Control use of local variables in files you visit.
453 The value can be t, nil, :safe, :all, or something else.
455 A value of t means file local variables specifications are obeyed
456 if all the specified variable values are safe; if any values are
457 not safe, Emacs queries you, once, whether to set them all.
458 \(When you say yes to certain values, they are remembered as safe.)
460 :safe means set the safe variables, and ignore the rest.
461 :all means set all variables, whether safe or not.
462 (Don't set it permanently to :all.)
463 A value of nil means always ignore the file local variables.
465 Any other value means always query you once whether to set them all.
466 \(When you say yes to certain values, they are remembered as safe, but
469 This variable also controls use of major modes specified in
470 a -*- line.
473 always obeys file local variable specifications and the -*- line,
474 and ignores this variable."
483 "Like `enable-local-variables' but meant for buffer-local bindings.
484 The meaningful values are nil and non-nil. The default is non-nil.
485 If a major mode sets this to nil, buffer-locally, then any local
486 variables list in the file will be ignored.
488 This variable does not affect the use of major modes
493 The value can be t, nil or something else.
494 A value of t means obey `eval' variables;
495 A value of nil means ignore them; anything else means query."
501 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
510 "Non-nil means buffers visiting files read-only do so in view mode.
511 In fact, this means that all read-only buffers normally have
512 View mode enabled, including buffers that are read-only because
513 you visit a file you cannot alter, and buffers you make read-only
520 \f
523 "Provides support for ange-ftp host name completion.
524 Runs the usual ange-ftp hook, but only for completion operations."
525 ;; Having this here avoids the need to load ange-ftp when it's not
526 ;; really in use.
532 inhibit-file-name-handlers)))
537 "Convert a standard file's name to something suitable for the OS.
538 This means to guarantee valid names and perhaps to canonicalize
539 certain patterns.
541 FILENAME should be an absolute file name since the conversion rules
542 sometimes vary depending on the position in the file name. E.g. c:/foo
543 is a valid DOS file name, but c:/bar/c:/foo is not.
545 This function's standard definition is trivial; it just returns
546 the argument. However, on Windows and DOS, replace invalid
547 characters. On DOS, make sure to obey the 8.3 limitations.
548 In the native Windows build, turn Cygwin names into native names,
549 and also turn slashes into backslashes if the shell requires it (see
550 `w32-shell-dos-semantics').
552 See Info node `(elisp)Standard File Names' for more details."
556 ;; Replace invalid filename characters with !
560 name)
561 filename))
564 "Read directory name, prompting with PROMPT and completing in directory DIR.
565 Value is not expanded---you must call `expand-file-name' yourself.
566 Default name to DEFAULT-DIRNAME if user exits with the same
567 non-empty string that was inserted by this function.
568 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
569 or just DIR if INITIAL is nil.)
570 If the user exits with an empty minibuffer, this function returns
571 an empty string. (This can only happen if the user erased the
572 pre-inserted contents or if `insert-default-directory' is nil.)
573 Fourth arg MUSTMATCH non-nil means require existing directory's name.
574 Non-nil and non-t means also require confirmation after completion.
575 Fifth arg INITIAL specifies text to start with.
576 DIR should be an absolute directory name. It defaults to
577 the value of `default-directory'."
582 dir))
583 mustmatch initial
586 \f
588 "Show the current default directory."
593 "Value of the CDPATH environment variable, as a list.
597 "Explode a search path into a list of directory names.
598 Directories are separated by occurrences of `path-separator'
599 \(which is colon in GNU and GNU-like systems)."
600 ;; We could use split-string here.
608 nil
613 cd-list)))
616 "Change current directory to given absolute file name DIR."
617 ;; Put the name into directory syntax now,
618 ;; because otherwise expand-file-name may give some bad results.
631 "Make DIR become the current buffer's default directory.
632 If your environment includes a `CDPATH' variable, try each one of
633 that list of directories (separated by occurrences of
634 `path-separator') when resolving a relative directory name.
635 The path separator is colon in GNU and GNU-like systems."
638 default-directory default-directory
654 cd-path)
655 nil))
659 "Load the Lisp file named FILE."
660 ;; This is a case where .elc makes a lot of sense.
667 "Search for FILENAME through PATH.
668 If found, return the absolute file name of FILENAME, with its suffixes;
669 otherwise return nil.
670 PATH should be a list of directories to look in, like the lists in
671 `exec-path' or `load-path'.
672 If SUFFIXES is non-nil, it should be a list of suffixes to append to
675 If non-nil, PREDICATE is used instead of `file-readable-p'.
676 PREDICATE can also be an integer to pass to the `access' system call,
677 in which case file-name handlers are ignored. This usage is deprecated.
679 For compatibility, PREDICATE can also be one of the symbols
680 `executable', `readable', `writable', or `exists', or a list of
681 one or more of those symbols."
692 "Do completion for file names passed to `locate-file'.
693 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
716 "Look up the directory hierarchy from FILE for a file matching REGEXP."
721 ;; Abbreviate, so as to stop when we cross ~/.
723 files)
724 ;; As a heuristic, we stop looking up the hierarchy of directories as
725 ;; soon as we find a directory belonging to another user. This should
726 ;; save us from looking in things like /net and /afs. This assumes
727 ;; that all the files inside a project belong to the same user.
735 nil)))
738 "Search for COMMAND in `exec-path' and return the absolute file name.
739 Return nil if COMMAND is not found anywhere in `exec-path'."
740 ;; Use 1 rather than file-executable-p to better match the behavior of
741 ;; call-process.
745 "Load the library named LIBRARY.
746 This is an interface to the function `load'."
749 'locate-file-completion
754 "Test whether FILE specifies a location on a remote system.
755 Return an identification of the system if the location is indeed
756 remote. The identification of the system may comprise a method
757 to access the system and its hostname, amongst other things.
762 IDENTIFICATION specifies which part of the identification shall
763 be returned as string. IDENTIFICATION can be the symbol
764 `method', `user' or `host'; any other value is handled like nil
765 and means to return the complete identification string.
767 If CONNECTED is non-nil, the function returns an identification only
768 if FILE is located on a remote system, and a connection is established
769 to that remote system.
771 `file-remote-p' will never open a connection on its own."
775 nil)))
778 "Copy the file FILE into a temporary file on this machine.
779 Returns the name of the local copy, or nil, if FILE is directly
780 accessible."
781 ;; This formerly had an optional BUFFER argument that wasn't used by
782 ;; anything.
786 nil)))
789 "Return the truename of FILENAME, which should be absolute.
790 The truename of a file name is found by chasing symbolic links
791 both at the level of the file and at the level of the directories
792 containing it, until no links are left at any level.
795 ;; COUNTER and PREV-DIRS are only used in recursive calls.
796 ;; COUNTER can be a cons cell whose car is the count of how many
797 ;; more links to chase before getting an error.
798 ;; PREV-DIRS can be a cons cell whose car is an alist
799 ;; of truenames we've just recently computed.
813 ;; For speed, remove the ange-ftp completion handler from the list.
814 ;; We know it's not needed here.
815 ;; For even more speed, do this only on the outermost call.
822 ;; andrewi@harlequin.co.uk - none of the following code (except for
823 ;; invoking the file-name handler) currently applies on Windows
824 ;; (ie. there are no native symlinks), but there is an issue with
825 ;; case differences being ignored by the OS, and short "8.3 DOS"
826 ;; name aliases existing for all files. (The short names are not
827 ;; reported by directory-files, but can be used to refer to files.)
828 ;; It seems appropriate for file-truename to resolve these issues in
829 ;; the most natural way, which on Windows is to call the function
830 ;; `w32-long-file-name' - this returns the exact name of a file as
831 ;; it is stored on disk (expanding short name aliases with the full
832 ;; name in the process).
835 ;; For file name that has a special handler, call handler.
836 ;; This is so that ange-ftp can save time by doing a no-op.
839 ;; If filename contains a wildcard, newname will be the old name.
841 ;; If filename exists, use the long name
845 ;; If this file directly leads to a link, process that iteratively
846 ;; so that we don't use lots of stack.
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 done t)
858 target dirfile)
859 ;; Get the truename of the directory.
861 ;; If these are equal, we have the (or a) root directory.
863 ;; If this is the same dir we last got the truename for,
864 ;; save time--don't recalculate.
874 done t)
877 done t)
878 ;; Put it back on the file name.
880 ;; Is the file name the name of a link?
883 ;; Yes => chase that link, then start all over
884 ;; since the link may point to a directory name that uses links.
885 ;; We can't safely use expand-file-name here
886 ;; since target might look like foo/../bar where foo
887 ;; is itself a link. Instead, we handle . and .. above.
890 target
892 done nil)
893 ;; No, we are done!
895 filename))
898 "Chase links in FILENAME until a name that is not a link.
899 Unlike `file-truename', this does not check whether a parent
900 directory name is a symbolic link.
901 If the optional argument LIMIT is a number,
902 it means chase no more than that many links and then stop."
910 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
913 ;; Handle `..' by hand, since it needs to work in the
914 ;; target of any directory symlink.
915 ;; This code is not quite complete; it does not handle
916 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
920 ;; Chase links in the default dir of the symlink.
924 ;; Now find the parent of that dir.
928 newname))
931 "Create a temporary file.
932 The returned file name (created by appending some random characters at the end
933 of PREFIX, and expanding against `temporary-file-directory' if necessary),
934 is guaranteed to point to a newly created empty file.
935 You can then use `write-region' to write new data into the file.
937 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
939 If SUFFIX is non-nil, add that at the end of the file name."
941 file)
944 ;; Create temp files with strict access rights. It's easy to
945 ;; loosen them later, whereas it's impossible to close the
946 ;; time-window of loose permissions otherwise.
958 nil)
960 ;; the file was somehow created by someone else between
961 ;; `make-temp-name' and `write-region', let's try again.
962 nil)
963 file)
964 ;; Reset the umask.
968 "Change the encoding of FILE's name from CODING to NEW-CODING.
969 The value is a new name of FILE.
970 Signals a `file-already-exists' error if a file of the new name
971 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
972 is non-nil. A number as fourth arg means request confirmation if
973 the new name already exists. This is what happens in interactive
974 use with M-x."
977 default-file-name-coding-system))
979 from-coding to-coding)
981 ;; We provide the default coding only when it seems that
982 ;; the filename is correctly decoded by the default
983 ;; coding.
989 filename default-coding)
990 default-coding))
994 ;; We provide the default coding only when a user is going to
995 ;; change the encoding not from the default coding.
999 filename from-coding)))
1002 filename from-coding default-coding)
1003 default-coding)))
1007 default-file-name-coding-system))
1008 ;; FILE should have been decoded by DEFAULT-CODING.
1012 ;; Suppress further encoding.
1017 newname))
1018 \f
1020 "Select buffer BUFFER in another window.
1021 If BUFFER does not identify an existing buffer, then this function
1022 creates a buffer with that name.
1024 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1025 or nil. If BUFFER is nil, then this function chooses a buffer
1026 using `other-buffer'.
1027 Optional second arg NORECORD non-nil means
1028 do not put this buffer at the front of the list of recently selected ones.
1029 This function returns the buffer it switched to.
1031 This uses the function `display-buffer' as a subroutine; see its
1032 documentation for additional customization information."
1035 ;; Don't let these interfere.
1036 same-window-buffer-names same-window-regexps)
1040 "Switch to buffer BUFFER in another frame.
1041 Optional second arg NORECORD non-nil means
1042 do not put this buffer at the front of the list of recently selected ones.
1044 This uses the function `display-buffer' as a subroutine; see its
1045 documentation for additional customization information."
1048 same-window-buffer-names same-window-regexps)
1053 "Switch to buffer BUFFER in another frame.
1054 This uses the function `display-buffer' as a subroutine; see its
1055 documentation for additional customization information."
1058 same-window-buffer-names same-window-regexps
1060 new-window)
1070 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1071 BODY should use the minibuffer at most once.
1072 Recursive uses of the minibuffer will not be affected."
1078 ;; Clear out this hook so it does not interfere
1079 ;; with any recursive minibuffer usage.
1089 "If non-nil, `find-file' requires confirmation before visiting a new file."
1101 t))
1104 "Edit file FILENAME.
1105 Switch to a buffer visiting file FILENAME,
1106 creating one if none already exists.
1107 Interactively, the default if you just type RET is the current directory,
1108 but the visited file name is available through the minibuffer history:
1109 type M-n to pull it into the minibuffer.
1111 You can visit files on remote machines by specifying something
1112 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1113 also visit local files as a different user by specifying
1114 /sudo::FILE for the file name.
1115 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1116 manual, for more about this.
1118 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1119 expand wildcards (if any) and visit multiple files. You can
1120 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1122 To visit a file without any kind of conversion and without
1133 "Edit file FILENAME, in another window.
1136 an existing one. See the function `display-buffer'.
1138 Interactively, the default if you just type RET is the current directory,
1139 but the visited file name is available through the minibuffer history:
1140 type M-n to pull it into the minibuffer.
1142 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1143 expand wildcards (if any) and visit multiple files."
1156 "Edit file FILENAME, in another frame.
1159 an existing one. See the function `display-buffer'.
1161 Interactively, the default if you just type RET is the current directory,
1162 but the visited file name is available through the minibuffer history:
1163 type M-n to pull it into the minibuffer.
1165 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1166 expand wildcards (if any) and visit multiple files."
1179 "Edit the existing file FILENAME.
1181 file names with wildcards."
1189 "Edit file FILENAME but don't allow changes.
1203 value))
1206 "Edit file FILENAME in another window but don't allow changes.
1220 value))
1223 "Edit file FILENAME in another frame but don't allow changes.
1237 value))
1240 "Find file FILENAME as a replacement for the file in the next window.
1241 This command does not select that window.
1245 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1246 expand wildcards (if any) and replace the file with multiple files."
1258 t))))
1266 "Find file FILENAME, select its buffer, kill previous buffer.
1267 If the current buffer now contains an empty file that you just visited
1268 \(presumably by mistake), use this command to visit the file you really want.
1272 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1273 expand wildcards (if any) and replace the file with multiple files.
1275 If the current buffer is an indirect buffer, or the base buffer
1276 for one or more indirect buffers, the other buffer(s) are not
1277 killed."
1287 t)))
1308 ;; This prevents us from finding the same buffer
1309 ;; if we specified the same file again.
1313 ;; Likewise for dired buffers.
1317 ;; This executes if find-file gets an error
1318 ;; and does not really find anything.
1319 ;; We put things back as they were.
1320 ;; If find-file actually finds something, we kill obuf below.
1329 ;; We already asked; don't ask again.
1332 \f
1334 "Create a suitably named buffer for visiting FILENAME, and return it.
1335 FILENAME (sans directory) is used unchanged if that name is free;
1336 otherwise a string <2> or <3> or ... is appended to get an unused name.
1337 Spaces at the start of FILENAME (sans directory) are removed."
1346 "Create and return a buffer with a name based on NAME.
1347 Choose the buffer's name using `generate-new-buffer-name'."
1351 "Regexp to match the automounter prefix in a directory name."
1359 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1361 home directory is a root directory) and removes automounter prefixes
1362 \(see the variable `automount-dir-prefix')."
1363 ;; Get rid of the prefixes added by the automounter.
1371 ;; If any elt of directory-abbrev-alist matches this name,
1372 ;; abbreviate accordingly.
1378 ;; Compute and save the abbreviated homedir name.
1379 ;; We defer computing this until the first time it's needed, to
1380 ;; give time for directory-abbrev-alist to be set properly.
1381 ;; We include a slash at the end, to avoid spurious matches
1382 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1389 ;; If FILENAME starts with the abbreviated homedir,
1390 ;; make it start with `~' instead.
1392 ;; If the home dir is just /, don't change it.
1395 ;; MS-DOS root directories can come with a drive letter;
1396 ;; Novell Netware allows drive letters beyond `Z:'.
1406 filename)))
1409 "List of logical names for which visiting shouldn't save the true dirname.
1410 On VMS, when you visit a file using a logical name that searches a path,
1411 you may or may not want the visited file name to record the specific
1412 directory where the file was found. If you *do not* want that, add the logical
1413 name to this list as a string."
1418 "Return the buffer visiting file FILENAME (a string).
1419 This is like `get-file-buffer', except that it checks for any buffer
1420 visiting the same file, possibly under a different name.
1421 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1422 and others are ignored.
1423 If there is no such live buffer, return nil."
1437 found)
1447 ;; Verify this buffer's file number
1448 ;; still belongs to its file.
1451 attributes)
1455 found))))
1456 \f
1458 "Non-nil means file-visiting commands should handle wildcards.
1459 For example, if you specify `*.c', that would visit all the files
1460 whose names match the pattern."
1466 "Non-nil means suppress warning messages for symlinked files.
1467 When nil, Emacs prints a warning when visiting a file that is already
1468 visited, but with a different name. Setting this option to t
1469 suppresses this warning."
1475 "Maximum size of file above which a confirmation is requested.
1476 When nil, never request confirmation."
1483 "Read file FILENAME into a buffer and return the buffer.
1484 If a buffer exists visiting FILENAME, return that one, but
1485 verify that the file has not changed since visited or saved.
1486 The buffer is not selected, just returned to the caller.
1487 Optional second arg NOWARN non-nil means suppress any warning messages.
1488 Optional third arg RAWFILE non-nil means the file is read literally.
1489 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1490 and visit all the matching files. When wildcards are actually
1491 used and expanded, return a list of buffers that are visiting
1492 the various files."
1499 'find-directory-functions
1502 filename)))
1505 find-file-wildcards
1519 ;; Find any buffer for a file which has same truename.
1521 ;; Let user know if there is a buffer with the same truename.
1525 find-file-suppress-same-file-warnings
1529 ;; Optionally also find that buffer.
1532 ;; Check to see if the file looks uncommonly large.
1534 ;; Don't ask again if we already have the file or
1535 ;; if we're asked to be quiet.
1544 ;; We are using an existing buffer.
1551 ;; Certain files should be reverted automatically
1552 ;; if they have changed on disk and not in the buffer.
1560 found))
1570 "File %s changed on disk. Discard your edits? "
1575 "File %s changed on disk. Discard your edits in %s? "
1583 ;; Check if a formerly read-only file has become
1584 ;; writable and vice versa, but if the buffer agrees
1585 ;; with the new state of the file, that is ok too.
1593 buffer-file-name
1602 ;; It is confusing to ask whether to visit
1603 ;; non-literally if they have the file in
1604 ;; hexl-mode.
1610 "The file %s is already visited normally,
1611 and you have edited the buffer. Now you have asked to visit it literally,
1612 meaning no coding system handling, format conversion, or local variables.
1613 Emacs can only visit a file in one way at a time.
1615 Do you want to save the file, and visit it literally instead? "
1616 "The file %s is already visited literally,
1617 meaning no coding system handling, format conversion, or local variables.
1618 You have edited the buffer. Now you have asked to visit the file normally,
1619 but Emacs can only visit a file in one way at a time.
1626 rawfile truename number))
1630 "\
1631 Do you want to discard your changes, and visit the file literally now? "
1632 "\
1635 rawfile truename number)
1641 "The file %s is already visited normally.
1642 You have asked to visit it literally,
1643 meaning no coding system decoding, format conversion, or local variables.
1644 But Emacs can only visit a file in one way at a time.
1646 Do you want to revisit the file literally now? "
1647 "The file %s is already visited literally,
1648 meaning no coding system decoding, format conversion, or local variables.
1649 You have asked to visit it normally,
1650 but Emacs can only visit a file in one way at a time.
1655 rawfile truename number)
1658 ;; Return the buffer we are using.
1659 buf)
1660 ;; Create a new buffer.
1662 ;; find-file-noselect-1 may use a different buffer.
1664 rawfile truename number))))))
1670 ;; Needed in case we are re-visiting the file with a different
1671 ;; text representation.
1688 filename)))
1689 ;; Unconditionally set error
1699 filename)))
1700 ;; Run find-file-not-found-functions until one returns non-nil.
1702 ;; If they fail too, set error.
1704 ;; Record the file's truename, and maybe use that as visited name.
1710 ;; On VMS, we may want to remember which directory in a search list
1711 ;; the file was found in.
1721 ;; Set buffer's default directory to that of the file.
1723 ;; Turn off backup files for certain file names. Since
1724 ;; this is a permanent local, the major mode won't eliminate it.
1739 \f
1741 "Like `insert-file-contents', but only reads in the file literally.
1742 A buffer may be modified in several ways after reading into the buffer,
1743 to Emacs features such as format decoding, character code
1744 conversion, `find-file-hook', automatic uncompression, etc.
1746 This function ensures that none of these modifications will take place."
1754 nil))
1757 inhibit-file-name-handlers))
1770 filename)))
1780 "Insert contents of file FILENAME into buffer after point with no conversion.
1782 This function is meant for the user to run interactively.
1783 Don't call it from programs! Use `insert-file-contents-literally' instead.
1784 \(Its calling sequence is different; see its documentation)."
1789 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1794 "Visit file FILENAME with no conversion of any kind.
1795 Format conversion and character code conversion are both disabled,
1796 and multibyte characters are disabled in the resulting buffer.
1797 The major mode used is Fundamental mode regardless of the file name,
1798 and local variable specifications in the file are ignored.
1799 Automatic uncompression and adding a newline at the end of the
1800 file due to `require-final-newline' is also disabled.
1802 You cannot absolutely rely on this function to result in
1803 visiting the file literally. If Emacs already has a buffer
1804 which is visiting the file, you get the existing buffer,
1805 regardless of whether it was created literally or not.
1807 In a Lisp program, if you want to be sure of accessing a file's
1808 contents literally, you should create a temporary buffer and then read
1809 the file contents into it using `insert-file-contents-literally'."
1812 \f
1816 after-find-file-from-revert-buffer
1817 nomodes)
1818 "Called after finding a file and by the default revert function.
1819 Sets buffer mode, parses local variables.
1820 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1821 error in reading the file. WARN non-nil means warn if there
1822 exists an auto-save file more recent than the visited file.
1823 NOAUTO means don't mess with auto-save mode.
1824 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1825 means this call was from `revert-buffer'.
1826 Fifth arg NOMODES non-nil means don't alter the file's modes.
1827 Finishes by calling the functions in `find-file-hook'
1828 unless NOMODES is non-nil."
1831 nil
1841 ;; No need to warn if buffer is auto-saved
1842 ;; under the name of the visited file.
1844 auto-save-visited-file-name))
1847 buffer-file-name))
1867 ;; Make people do a little extra work (C-x C-q)
1868 ;; before altering a backup file.
1871 ;; When a file is marked read-only,
1872 ;; make the buffer read-only even if root is looking at it.
1880 ;; If requested, add a newline at the end of the file.
1890 view-read-only
1896 "Eval BODY and turn any error into a FORMAT message.
1897 FORMAT can have a %s escape which will be replaced with the actual error.
1898 If `debug-on-error' is set, errors are not caught, so that you can
1899 debug them.
1900 Avoid using a large BODY since it is duplicated."
1909 "Choose the major mode for this buffer automatically.
1910 Also sets up any specified local variables of the file.
1911 Uses the visited file name, the -*- line, and the local variables spec.
1913 This function is called automatically from `find-file'. In that case,
1914 we may set up the file-specified mode and local variables,
1915 depending on the value of `enable-local-variables'.
1916 In addition, if `local-enable-local-variables' is nil, we do
1917 not set local variables (though we do notice a mode specified with -*-.)
1919 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1920 or from Lisp without specifying the optional argument FIND-FILE;
1921 in that case, this function acts as if `enable-local-variables' were t."
1929 ;; Turn font lock off and on, to make sure it takes account of
1930 ;; whatever file local variables are relevant to it.
1932 ;; Font-lock-mode (now in font-core.el) can be ON when
1933 ;; font-lock.el still hasn't been loaded.
1943 "Non-nil means to try second pass through `auto-mode-alist'.
1944 This means that if the first case-sensitive search through the alist fails
1945 to find a matching major mode, a second case-insensitive search is made.
1946 On systems with case-insensitive file names, this variable is ignored,
1947 since only a single case-insensitive search through the alist is made."
1953 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1954 ;; c++-mode, java-mode and more) are added through autoload
1955 ;; directives in that file. That way is discouraged since it
1956 ;; spreads out the definition of the initial value.
1989 ;; Less common extensions come here
1990 ;; so more common ones above are found faster.
2029 ;; The list of archive file extensions should be in sync with
2030 ;; `auto-coding-alist' with `no-conversion' coding system.
2035 ;; Mailer puts message to be edited in
2036 ;; /tmp/Re.... or Message
2040 ;; some news reader is reported to use this
2048 ;; .emacs or .gnus or .viper following a directory delimiter in
2049 ;; Unix, MSDOG or VMS syntax.
2052 ;; _emacs following a directory delimiter
2053 ;; in MsDos syntax
2057 ;; Common Lisp ASDF package system.
2075 ;; Windows candidates may be opened case sensitively on Unix
2081 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2083 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2084 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2085 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2086 ;; this has lower priority to avoid matching changelog.sgml etc.
2088 ;; either user's dot-files or under /etc or some such
2090 ;; alas not all ~/.*rc files are like this
2091 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2096 ;; this contains everything twice, with space and with colon :-(
2098 ;; Get rid of any trailing .n.m and try again.
2099 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2100 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2101 ;; Using mode nil rather than `ignore' would let the search continue
2102 ;; through this list (with the shortened name) rather than start over.
2104 ;; The following should come after the ChangeLog pattern
2105 ;; for the sake of ChangeLog.1, etc.
2106 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2109 "Alist of filename patterns vs corresponding major mode functions.
2110 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2111 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2112 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2113 mode function to use. FUNCTION will be called, unless it is nil.
2115 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2116 calling FUNCTION (if it's not nil), we delete the suffix that matched
2117 REGEXP and search the list again for another match.
2119 If the file name matches `inhibit-first-line-modes-regexps',
2120 then `auto-mode-alist' is not processed.
2122 The extensions whose FUNCTION is `archive-mode' should also
2123 appear in `auto-coding-alist' with `no-conversion' coding system.
2125 See also `interpreter-mode-alist', which detects executable script modes
2126 based on the interpreters they specify to run,
2130 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2131 ;; and pike-mode) are added through autoload directives in that
2132 ;; file. That way is discouraged since it spreads out the
2133 ;; definition of the initial value.
2171 "Alist mapping interpreter names to major modes.
2172 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2173 Each element looks like (INTERPRETER . MODE).
2174 If INTERPRETER matches the name of the interpreter specified in the first line
2175 of a script, mode MODE is enabled.
2183 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2184 When checking `inhibit-first-line-modes-regexps', we first discard
2190 "Regexp matching interpreters, for file mode determination.
2191 This regular expression is matched against the first line of a file
2192 to determine the file's mode in `set-auto-mode'. If it matches, the file
2193 is assumed to be interpreted by the interpreter matched by the second group
2194 of the regular expression. The mode is then determined as the mode
2198 "Alist of buffer beginnings vs. corresponding major mode functions.
2199 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2200 After visiting a file, if REGEXP matches the text at the beginning of the
2201 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2202 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2203 major mode.
2205 If FUNCTION is nil, then it is not called. (That is a way of saying
2211 ;; The < comes before the groups (but the first) to reduce backtracking.
2212 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2213 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2217 comment-re "*"
2220 . html-mode)
2222 ;; These two must come after html, because they are more general:
2227 . sgml-mode)
2230 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2231 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2232 After visiting a file, if REGEXP matches the text at the beginning of the
2233 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2234 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2235 have not specified a mode for this file.
2241 "Upper limit on `magic-mode-alist' regexp matches.
2245 "Select major mode appropriate for current buffer.
2247 To find the right major mode, this function checks for a -*- mode tag,
2248 checks if it uses an interpreter listed in `interpreter-mode-alist',
2249 matches the buffer beginning against `magic-mode-alist',
2250 compares the filename against the entries in `auto-mode-alist',
2251 then matches the buffer beginning against `magic-fallback-mode-alist'.
2253 It does not check for the `mode:' local variable in the
2254 Local Variables section of the file; for that, use `hack-local-variables'.
2256 If `enable-local-variables' is nil, this function does not check for a
2257 -*- mode tag.
2259 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2260 set the major mode only if that would change it. In other words
2261 we don't actually set it to the same mode the buffer already has."
2262 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2264 ;; Find a -*- mode tag
2271 ;; Find all specifications for the `mode:' variable
2272 ;; and execute them left to right.
2284 modes)))
2285 ;; Simple -*-MODE-*- case.
2288 modes))))
2289 ;; If we found modes to use, invoke them now, outside the save-excursion.
2297 ;; continuing would call minor modes again, toggling them off
2299 ;; If we didn't, look for an interpreter specified in the first line.
2300 ;; As a special case, allow for things like "#!/bin/env perl", which
2301 ;; finds the interpreter anywhere in $PATH.
2308 ;; Map interpreter name to a mode, signalling we're done at the
2309 ;; same time.
2311 interpreter-mode-alist))
2312 ;; If we found an interpreter mode to use, invoke it now.
2315 ;; Next try matching the buffer beginning against magic-mode-alist.
2329 ;; Next compare the filename against the entries in auto-mode-alist.
2334 ;; Remove remote file name identification.
2338 ;; Remove backup-suffixes from file name.
2341 ;; Find first matching alist entry.
2344 ;; System is case-insensitive.
2348 ;; System is case-sensitive.
2350 ;; First match case-sensitively.
2354 ;; Fallback to case-insensitive match.
2368 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2383 ;; When `keep-mode-if-same' is set, we are working on behalf of
2384 ;; set-visited-file-name. In that case, if the major mode specified is the
2385 ;; same one we already have, don't actually reset it. We don't want to lose
2386 ;; minor modes such as Font Lock.
2388 "Apply MODE and return it.
2389 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2390 any aliases and compared to current major mode. If they are the
2391 same, do nothing and return nil."
2397 mode)))
2400 "Find the -*- spec in the buffer.
2401 Call with point at the place to start searching from.
2402 If one is found, set point to the beginning
2403 and return the position of the end.
2404 Otherwise, return nil; point may be changed."
2407 ;; Don't look for -*- if this file name matches any
2408 ;; of the regexps in inhibit-first-line-modes-regexps.
2416 sufs)
2424 ;; If the file begins with "#!"
2425 ;; (exec interpreter magic), look
2426 ;; for mode frobs in the first two
2427 ;; lines. You cannot necessarily
2428 ;; put them in the first line of
2429 ;; such a file without screwing up
2430 ;; the interpreter invocation.
2441 end))))
2442 \f
2443 ;;; Handling file local variables
2450 "Normal hook run after processing a file's local variables specs.
2451 Major modes can use this to examine user-specified local variables
2455 "List variable-value pairs that are considered safe.
2456 Each element is a cons cell (VAR . VAL), where VAR is a variable
2457 symbol and VAL is a value that is considered safe."
2462 "Expressions that are considered safe in an `eval:' local variable.
2463 Add expressions to this list if you want Emacs to evaluate them, when
2464 they appear in an `eval' local variable specification, without first
2465 asking you for confirmation."
2470 ;; Risky local variables:
2473 auto-mode-alist
2474 buffer-auto-save-file-name
2475 buffer-file-name
2476 buffer-file-truename
2477 buffer-undo-list
2478 dabbrev-case-fold-search
2479 dabbrev-case-replace
2480 debugger
2481 default-text-properties
2482 display-time-string
2483 enable-local-eval
2484 enable-local-variables
2485 eval
2486 exec-directory
2487 exec-path
2488 file-name-handler-alist
2489 font-lock-defaults
2490 format-alist
2491 frame-title-format
2492 global-mode-string
2493 header-line-format
2494 icon-title-format
2495 ignored-local-variables
2496 imenu--index-alist
2497 imenu-generic-expression
2498 inhibit-quit
2499 input-method-alist
2500 load-path
2501 max-lisp-eval-depth
2502 max-specpdl-size
2503 minor-mode-alist
2504 minor-mode-map-alist
2505 minor-mode-overriding-map-alist
2506 mode-line-buffer-identification
2507 mode-line-format
2508 mode-line-client
2509 mode-line-modes
2510 mode-line-modified
2511 mode-line-mule-info
2512 mode-line-position
2513 mode-line-process
2514 mode-line-remote
2515 mode-name
2516 outline-level
2517 overriding-local-map
2518 overriding-terminal-local-map
2519 parse-time-rules
2520 process-environment
2521 rmail-output-file-alist
2522 safe-local-variable-values
2523 safe-local-eval-forms
2524 save-some-buffers-action-alist
2525 special-display-buffer-names
2526 standard-input
2527 standard-output
2528 unread-command-events
2529 vc-mode))
2531 ;; Safe local variables:
2532 ;;
2533 ;; For variables defined by major modes, the safety declarations can go into
2534 ;; the major mode's file, since that will be loaded before file variables are
2535 ;; processed.
2536 ;;
2537 ;; For variables defined by minor modes, put the safety declarations in the
2538 ;; file defining the minor mode after the defcustom/defvar using an autoload
2539 ;; cookie, e.g.:
2540 ;;
2541 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2542 ;;
2543 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2544 ;; minor mode file may not be loaded yet.
2545 ;;
2546 ;; For variables defined in the C source code the declaration should go here:
2562 "Get confirmation before setting up local variable values.
2563 ALL-VARS is the list of all variables to be set up.
2564 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2565 RISKY-VARS is the list of those that are marked as risky."
2567 nil
2572 prompt char)
2582 ", and variables that are risky (**)."
2589 y -- to apply the local variables list.
2593 ! -- to apply the local variables list, and permanently mark these
2605 ;; Make strings with embedded whitespace easier to read.
2613 ""
2620 done)
2629 ;; read-event returns -1 if we are in a kbd
2630 ;; macro and there are no more events in the
2631 ;; macro. In that case, attempt to get an
2632 ;; event interactively.
2640 ;; When this is called from desktop-restore-file-buffer,
2641 ;; coding-system-for-read may be non-nil. Reset it before
2642 ;; writing to .emacs.
2646 'safe-local-variable-values
2647 safe-local-variable-values))))
2654 "Return local variables specified in the -*- line.
2655 Ignore any specification for `mode:' and `coding:';
2656 `set-auto-mode' should already have handled `mode:',
2657 `set-auto-coding' should already have handled `coding:'.
2659 If MODE-ONLY is non-nil, all we do is check whether the major
2660 mode is specified, returning t if it is specified. Otherwise,
2661 return an alist of elements (VAR . VAL), where VAR is a variable
2662 and VAL is the specified value."
2666 result mode-specified)
2667 ;; Parse the -*- line into the RESULT alist.
2668 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2670 nil)
2672 ;; Simple form: "-*- MODENAME -*-". Already handled.
2674 nil)
2676 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2677 ;; (last ";" is optional).
2682 ;; There used to be a downcase here,
2683 ;; but the manual didn't say so,
2684 ;; and people want to set var names that aren't all lc.
2689 ;; It is traditional to ignore
2690 ;; case when checking for `mode' in set-auto-mode,
2691 ;; so we must do that here as well.
2692 ;; That is inconsistent, but we're stuck with it.
2693 ;; The same can be said for `coding' in set-auto-coding.
2699 'eval
2706 mode-specified
2707 result))))
2710 "Parse and put into effect this buffer's local variables spec.
2711 If MODE-ONLY is non-nil, all we do is check whether the major mode
2712 is specified, returning t if it is specified."
2715 result)
2718 ;; Look for "Local variables:" line in last page.
2726 ;; suffix is what comes after "local variables:" in its line.
2727 ;; prefix is what comes before "local variables:" in its line.
2737 beg)
2741 endpos
2747 nil t))
2757 ;; Discard the prefix.
2762 ;; Discard the suffix.
2770 ;; Find the variable name; strip whitespace.
2778 val)
2779 ;; Read the variable value.
2789 'eval
2795 ;; We've read all the local variables. Now, return whether the
2796 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2797 ;; variables (if MODE-ONLY is nil.)
2799 result
2806 ;; Find those variables that we may want to save to
2807 ;; `safe-local-variable-values'.
2822 ;; If caller wants only the safe variables,
2823 ;; install only them.
2828 ;; Query, except in the case where all are known safe
2829 ;; if the user wants no quuery in that case.
2835 result unsafe-vars risky-vars))
2841 "Non-nil if SYM is safe as a file-local variable with value VAL.
2842 It is safe if any of these conditions are met:
2844 * There is a matching entry (SYM . VAL) in the
2845 `safe-local-variable-values' user option.
2847 * The `safe-local-variable' property of SYM is a function that
2848 evaluates to a non-nil value with VAL as an argument."
2854 "Non-nil if SYM could be dangerous as a file-local variable.
2855 It is dangerous if either of these conditions are met:
2857 * Its `risky-local-variable' property is non-nil.
2863 ;; If this is an alias, check the base name.
2883 "Return t if it is safe to eval EXP when it is found in a file."
2885 ;; Detect certain `put' expressions.
2891 ;; Only allow safe values of lisp-indent-hook;
2892 ;; not functions.
2895 ;; Only allow indirect form specs.
2896 ;; During bootstrapping, edebug-basic-spec might not be
2897 ;; defined yet.
2901 ;; Allow expressions that the user requested.
2903 ;; Certain functions can be allowed with safe arguments
2904 ;; or can specify verification functions to try.
2912 ok))
2920 ok)))))))
2923 "Set local variable VAR with value VAL.
2924 If VAR is `mode', call `VAL-mode' as a function unless it's
2925 already the major mode."
2935 ;; Make sure the string has no text properties.
2936 ;; Some text properties can get evaluated in various ways,
2937 ;; so it is risky to put them on with a local variable list.
2942 \f
2945 However, the mode will not be changed if
2946 \(1) a local variables list or the `-*-' line specifies a major mode, or
2948 \ not suitable for ordinary files, or
2949 \(3) the new file name does not particularly specify any mode."
2954 "Change name of file visited in current buffer to FILENAME.
2955 This also renames the buffer to correspond to the new file.
2956 The next time the buffer is saved it will go in the newly specified file.
2957 FILENAME nil or an empty string means mark buffer as not visiting any file.
2958 Remember to delete the initial contents of the minibuffer
2959 if you wish to pass an empty string as the argument.
2961 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2962 confirmation in the case where another buffer is already visiting FILENAME.
2964 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2965 the old visited file has been renamed to the new name FILENAME."
2973 nil
2988 filename)))
3000 ;; If new-name == old-name, renaming would add a spurious <2>
3001 ;; and it's considered as a feature in rename-buffer.
3007 ;; Abbreviate the file names of the buffer.
3016 nil)))
3017 ;; write-file-functions is normally used for things like ftp-find-file
3018 ;; that visit things that are not local files as if they were files.
3019 ;; Changing to visit an ordinary local file instead should flush the hook.
3024 ;; If buffer was read-only because of version control,
3025 ;; that reason is gone now, so make it writable.
3029 ;; Turn off backup files for certain file names.
3030 ;; Since this is a permanent local, the major mode won't eliminate it.
3032 backup-enable-predicate
3038 ;; If auto-save was not already on, turn it on if appropriate.
3042 ;; If auto save is on, start using a new name.
3043 ;; We deliberately don't rename or delete the old auto save
3044 ;; for the old visited file name. This is because perhaps
3045 ;; the user wants to save the new state and then compare with the
3046 ;; previous state from the auto save file.
3049 ;; Rename the old auto save file if any.
3056 ;; Update the major mode, if the file name determines it.
3058 ;; Don't change the mode if it is special.
3061 ;; Don't change the mode if the local variable list specifies it.
3067 "Write current buffer into file FILENAME.
3068 This makes the buffer visit that file, and marks it as not modified.
3070 If you specify just a directory name as FILENAME, that means to use
3071 the default file name but in that directory. You can also yank
3072 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3074 If the buffer is not already visiting a file, the default file name
3075 for the output file is the buffer name.
3077 If optional second arg CONFIRM is non-nil, this function
3078 asks for confirmation before overwriting an existing file.
3079 Interactively, confirmation is required unless you supply a prefix argument."
3080 ;; (interactive "FWrite file: ")
3084 nil nil nil nil)
3088 default-directory)
3089 nil nil))
3093 ;; If arg is just a directory,
3094 ;; use the default file name, but in that directory.
3105 ;; Make buffer writable if file is writable.
3110 ;; It's likely that the VC status at the new location is different from
3111 ;; the one at the old location.
3113 \f
3115 "Make a backup of the disk file visited by the current buffer, if appropriate.
3116 This is normally done before saving the buffer the first time.
3118 A backup may be done by renaming or by copying; see documentation of
3119 variable `make-backup-files'. If it's done by renaming, then the file is
3120 no longer accessible under its old name.
3122 The value is non-nil after a backup was made by renaming.
3123 It has the form (MODES . BACKUPNAME).
3124 MODES is the result of `file-modes' on the original
3125 file; this means that the caller, after saving the buffer, should change
3126 the modes of the new file to agree with the old modes.
3127 BACKUPNAME is the backup file name, which is the old file renamed."
3134 backup-info backupname targets setmodes)
3135 ;; If specified name is a symbolic link, chase it to the target.
3136 ;; Thus we make the backups in the directory where the real file is.
3141 ;; (if (file-directory-p buffer-file-name)
3142 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3146 ;; If have old versions to maybe delete,
3147 ;; ask the user to confirm now, before doing anything.
3148 ;; But don't actually delete til later.
3153 real-file-name)))))
3155 ;; Actually write the back up file.
3158 ; (file-symlink-p buffer-file-name)
3159 backup-by-copying
3160 ;; Don't rename a suid or sgid file.
3175 ;; rename-file should delete old backup.
3179 ;; If trouble writing the backup, write it in ~.
3184 backupname)
3188 ;; Now delete the old versions, if desired.
3195 setmodes)
3202 ;; Create temp files with strict access rights. It's easy to
3203 ;; loosen them later, whereas it's impossible to close the
3204 ;; time-window of loose permissions otherwise.
3207 ;; Try to overwrite old backup first.
3215 nil)
3217 ;; The file was somehow created by someone else between
3218 ;; `delete-file' and `copy-file', so let's try again.
3219 ;; rms says "I think there is also a possible race
3220 ;; condition for making backup files" (emacs-devel 20070821).
3221 nil)))
3222 ;; Reset the umask.
3228 "Return file NAME sans backup versions or strings.
3229 This is a separate procedure so your site-init or startup file can
3230 redefine it.
3231 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3232 we do not remove backup version numbers, only true file version numbers."
3238 ;; VMS version number is (a) semicolon, optional
3239 ;; sign, zero or more digits or (b) period, option
3240 ;; sign, zero or more digits, provided this is the
3241 ;; second period encountered outside of the
3242 ;; device/directory part of the file name.
3245 name)
3255 "Return t if deleting FILE and rewriting it would preserve the owner."
3260 ;; Return t if the file doesn't exist, since it's true that no
3261 ;; information would be lost by an (attempted) delete and create.
3267 The extension, in a file name, is the part that follows the last `.',
3268 except that a leading `.', if any, doesn't count."
3271 directory)
3275 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3276 ;; we don't want to expand it.
3279 filename))))
3283 The extension, in a file name, is the part that follows the last `.',
3284 excluding version numbers and backup suffixes,
3285 except that a leading `.', if any, doesn't count.
3286 Return nil for extensionless file names such as `foo'.
3287 Return the empty string for file names such as `foo.'.
3289 If PERIOD is non-nil, then the returned value includes the period
3290 that delimits the extension, and if FILENAME has no extension,
3301 "A function to use instead of the default `make-backup-file-name'.
3302 A value of nil gives the default `make-backup-file-name' behavior.
3304 This could be buffer-local to do something special for specific
3305 files. If you define it, you may need to change `backup-file-name-p'
3306 and `file-name-sans-versions' too.
3308 See also `backup-directory-alist'."
3314 "Alist of filename patterns and backup directory names.
3315 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3316 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3317 relative or absolute. If it is absolute, so that all matching files
3318 are backed up into the same directory, the file names in this
3319 directory will be the full name of the file backed up with all
3320 directory separators changed to `!' to prevent clashes. This will not
3321 work correctly if your filesystem truncates the resulting name.
3323 For the common case of all backups going into one directory, the alist
3325 directory name.
3327 If this variable is nil, or it fails to match a filename, the backup
3328 is made in the original file's directory.
3330 On MS-DOS filesystems without long names this variable is always
3331 ignored."
3337 "Default `backup-enable-predicate' function.
3338 Checks for files in `temporary-file-directory',
3339 `small-temporary-file-directory', and /tmp."
3342 ;; Directory is under temporary-file-directory.
3347 ;; Directory is under /tmp.
3352 0 nil
3354 ;; Directory is under small-temporary-file-directory.
3359 "Create the non-numeric backup file name for FILE.
3360 Normally this will just be the file's name with `~' appended.
3361 Customization hooks are provided as follows.
3363 If the variable `make-backup-file-name-function' is non-nil, its value
3364 should be a function which will be called with FILE as its argument;
3365 the resulting name is used.
3367 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3368 the documentation of that variable. If the directory for the backup
3369 doesn't exist, it is created."
3383 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3385 elt backup-directory abs-backup-directory)
3390 alist nil)))
3391 ;; If backup-directory is relative, it should be relative to the
3392 ;; file's directory. By expanding explicitly here, we avoid
3393 ;; depending on default-directory.
3402 abs-backup-directory nil))))
3404 file
3408 ;; Normalize DOSish file names: downcase the drive
3409 ;; letter, if any, and replace the leading "x:" with
3410 ;; "/drive_x".
3413 ;; Replace any invalid file-name characters (for the
3414 ;; case of backing up remote files).
3418 "drive_"
3421 ""
3424 ;; Make the name unique by substituting directory
3425 ;; separators. It may not really be worth bothering about
3426 ;; doubling `!'s in the original name...
3431 backup-directory))
3436 "Return non-nil if FILE is a backup file name (numeric or not).
3437 This is a separate function so you can redefine it for customization.
3438 You may need to redefine `file-name-sans-versions' as well."
3443 ;; This is used in various files.
3444 ;; The usage of backup-extract-version-start is not very clean,
3445 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3447 "Given the name of a numeric backup file, FN, return the backup number.
3448 Uses the free variable `backup-extract-version-start', whose value should be
3449 the index in the name where the version number begins."
3455 ;; I believe there is no need to alter this behavior for VMS;
3456 ;; since backup files are not made on VMS, it should not get called.
3458 "Find a file name for a backup file FN, and suggestions for deletions.
3459 Value is a list whose car is the name for the backup file
3460 and whose cdr is a list of old versions to consider deleting now.
3461 If the value is nil, don't make a backup.
3462 Uses `backup-directory-alist' in the same way as does
3463 `make-backup-file-name'."
3465 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3469 ;; We don't support numbered backups on plain MS-DOS
3470 ;; when long file names are unavailable.
3480 possibilities deserve-versions-p versions)
3483 base-versions
3486 possibilities)
3487 #'<)
3492 kept-old-versions
3493 kept-new-versions
3500 ;; Delete nothing if there is overflow
3501 ;; in the number of versions to keep.
3507 v))))))))))
3510 "Return number of names file FILENAME has."
3513 ;; (defun file-relative-name (filename &optional directory)
3514 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3515 ;; This function returns a relative file name which is equivalent to FILENAME
3516 ;; when used with that default directory as the default.
3517 ;; If this is impossible (which can happen on MSDOS and Windows
3518 ;; when the file name and directory use different drive names)
3519 ;; then it returns FILENAME."
3520 ;; (save-match-data
3521 ;; (let ((fname (expand-file-name filename)))
3522 ;; (setq directory (file-name-as-directory
3523 ;; (expand-file-name (or directory default-directory))))
3524 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3525 ;; ;; drive names, they can't be relative, so return the absolute name.
3526 ;; (if (and (or (eq system-type 'ms-dos)
3527 ;; (eq system-type 'cygwin)
3528 ;; (eq system-type 'windows-nt))
3529 ;; (not (string-equal (substring fname 0 2)
3530 ;; (substring directory 0 2))))
3531 ;; filename
3532 ;; (let ((ancestor ".")
3533 ;; (fname-dir (file-name-as-directory fname)))
3534 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3535 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3536 ;; (setq directory (file-name-directory (substring directory 0 -1))
3537 ;; ancestor (if (equal ancestor ".")
3538 ;; ".."
3539 ;; (concat "../" ancestor))))
3540 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3541 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3542 ;; ;; We matched within FNAME's directory part.
3543 ;; ;; Add the rest of FNAME onto ANCESTOR.
3544 ;; (let ((rest (substring fname (match-end 0))))
3545 ;; (if (and (equal ancestor ".")
3546 ;; (not (equal rest "")))
3547 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3548 ;; rest
3549 ;; (concat (file-name-as-directory ancestor) rest)))
3550 ;; ;; We matched FNAME's directory equivalent.
3551 ;; ancestor))))))
3554 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3555 This function returns a relative file name which is equivalent to FILENAME
3556 when used with that default directory as the default.
3557 If FILENAME and DIRECTORY lie on different machines or on different drives
3558 on a DOS/Windows machine, it returns FILENAME in expanded form."
3562 default-directory))))
3568 ;; Test for different drives on DOS/Windows
3570 ;; Should `cygwin' really be included here? --stef
3573 ;; Test for different remote file system identification
3575 filename
3581 directory nil nil case-fold-search))
3583 directory nil nil case-fold-search))))
3586 ".."
3588 ;; Now ancestor is empty, or .., or ../.., etc.
3590 directory nil nil case-fold-search))
3591 ;; We matched within FILENAME's directory part.
3592 ;; Add the rest of FILENAME onto ANCESTOR.
3595 ;; But don't bother with ANCESTOR if it would give us `./'.
3596 rest
3598 ;; We matched FILENAME's directory equivalent.
3599 ancestor))))))
3600 \f
3602 "Save current buffer in visited file if modified.
3603 Variations are described below.
3605 By default, makes the previous version into a backup file
3606 if previously requested or if this is the first save.
3608 to become a backup when the next save is done.
3610 unconditionally makes the previous version into a backup file.
3612 to become a backup when the next save is done,
3613 and unconditionally makes the previous version into a backup file.
3615 With a numeric argument of 0, never make the previous version
3616 into a backup file.
3618 If a file's name is FOO, the names of its numbered backup versions are
3619 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3620 Numeric backups (rather than FOO~) will be made if value of
3621 `version-control' is not the atom `never' and either there are already
3622 numeric versions of the file being backed up, or `version-control' is
3623 non-nil.
3624 We don't want excessive versions piling up, so there are variables
3625 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3626 and `kept-new-versions', which tells how many newest versions to keep.
3627 Defaults are 2 old versions and 2 new.
3628 `dired-kept-versions' controls dired's clean-directory (.) command.
3629 If `delete-old-versions' is nil, system will query user
3630 before trimming versions. Otherwise it does it silently.
3632 If `vc-make-backup-files' is nil, which is the default,
3633 no backup files are made for files managed by version control.
3634 (This is because the version control system itself records previous versions.)
3636 See the subroutine `basic-save-buffer' for more information."
3649 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3650 Normally delete only if the file was written by this Emacs since
3651 the last real save, but optional arg FORCE non-nil means delete anyway."
3665 "Normal hook that is run before a buffer is saved to its file."
3671 "Normal hook that is run after a buffer is saved to its file."
3677 "If non-nil, use this coding system for saving the buffer.
3678 More precisely, use this coding system in place of the
3679 value of `buffer-file-coding-system', when saving the buffer.
3680 Calling `write-region' for any purpose other than saving the buffer
3681 will still use `buffer-file-coding-system'; this variable has no effect
3688 "Save the current buffer in its visited file, if it has been modified.
3689 The hooks `write-contents-functions' and `write-file-functions' get a chance
3690 to do the job of saving; if they do not, then the buffer is saved in
3691 the visited file in the usual way.
3692 Before and after saving the buffer, this function runs
3693 `before-save-hook' and `after-save-hook', respectively."
3696 ;; In an indirect buffer, save its base buffer instead.
3701 setmodes)
3702 ;; On VMS, rename file and buffer to get rid of version number.
3707 ;; Strip VMS version number before save.
3710 ;; Construct a (unique) buffer name to correspond.
3715 ;; If buffer has no file name, ask user for one.
3722 ;; Signal an error if the user specified the name of an
3723 ;; existing directory.
3726 filename))
3728 ;; Signal an error if the specified name refers to a
3729 ;; non-existing directory.
3759 ;; Support VC version backups.
3765 ;; If a hook returned t, file is already "written".
3766 ;; Otherwise, write it the usual way now.
3768 ;; Now we have saved the current buffer. Let's make sure
3769 ;; that buffer-file-coding-system is fixed to what
3770 ;; actually used for saving by binding it locally.
3780 ;; If the auto-save file was recent before this command,
3781 ;; delete it now.
3783 ;; Support VC `implicit' locking.
3788 ;; This does the "real job" of writing a buffer into its visited file
3789 ;; and making a backup file. This is what is normally done
3790 ;; but inhibited if one of write-file-functions returns non-nil.
3791 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3800 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3814 buffer-file-name)))
3822 ;; If file is precious, write temp name, then rename it.
3823 ;; This requires write access to the containing dir,
3824 ;; which is why we don't try it if we don't have that access.
3826 tempname succeed
3829 ;; Create temp files with strict access rights. It's easy to
3830 ;; loosen them later, whereas it's impossible to close the
3831 ;; time-window of loose permissions otherwise.
3836 ;; Try various temporary names.
3837 ;; This code follows the example of make-temp-file,
3838 ;; but it calls write-region in the appropriate way
3839 ;; for saving the buffer.
3846 tempname nil realname
3848 nil)
3850 ;; The file was somehow created by someone else between
3851 ;; `make-temp-name' and `write-region', let's try again.
3852 nil)
3854 ;; Reset the umask.
3856 ;; If we failed, restore the buffer's modtime.
3859 ;; Since we have created an entirely new file,
3860 ;; make sure it gets the right permission bits set.
3864 buffer-file-name)))
3865 ;; We succeeded in writing the temp file,
3866 ;; so rename it.
3868 ;; If file not writable, see if we can make it writable
3869 ;; temporarily while we write it.
3870 ;; But no need to do so if we have just backed it up
3871 ;; (setmodes is set) because that says we're superseding.
3873 ;; Change the mode back, after writing.
3880 buffer-file-name nil t buffer-file-truename)
3882 ;; If we get an error writing the new file, and we made
3883 ;; the backup by renaming, undo the backing-up.
3888 setmodes))
3891 "View the differences between BUFFER and its associated file.
3892 This requires the external program `diff' to be in your `exec-path'."
3907 ;; Display that message for 1 second so that user can read it
3908 ;; in the minibuffer.
3910 ;; return always nil, so that save-buffers-kill-emacs will not move
3911 ;; over to the next unsaved buffer when calling `d'.
3912 nil)
3915 '((?\C-r
3921 ;; Return nil to ask about BUF again.
3922 nil)
3930 nil)
3939 "Save some modified file-visiting buffers. Asks user about each one.
3940 You can answer `y' to save, `n' not to save, `C-r' to look at the
3941 buffer in question with `view-buffer' before deciding or `d' to
3942 view the differences using `diff-buffer-with-file'.
3944 Optional argument (the prefix) non-nil means save all with no questions.
3945 Optional second argument PRED determines which buffers are considered:
3946 If PRED is nil, all the file-visiting buffers are considered.
3947 If PRED is t, then certain non-file buffers will also be considered.
3948 If PRED is a zero-argument function, it indicates for each buffer whether
3949 to consider it or not when called with that buffer current.
3951 See `save-some-buffers-action-alist' if you want to
3952 change the additional actions you can take on files."
3956 files-done abbrevs-done)
3958 ;; First save any buffers that we're supposed to save unconditionally.
3959 ;; That way the following code won't ask about them.
3964 ;; Ask about those buffers that merit it,
3965 ;; and record the number thus saved.
3981 t
3994 save-some-buffers-action-alist))
3995 ;; Maybe to save abbrevs, and record whether
3996 ;; we either saved them or asked to.
4002 abbrev-file-name)))
4004 ;; Don't keep bothering user if he says no.
4009 "(Some special files were saved without asking)"
4011 \f
4013 "Mark current buffer as unmodified, not needing to be saved.
4016 It is not a good idea to use this function in Lisp programs, because it
4017 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4024 "Change whether this buffer is visiting its file read-only.
4025 With prefix argument ARG, make the buffer read-only if ARG is
4026 positive, otherwise make it writable. If visiting file read-only
4027 and `view-read-only' is non-nil, enter view mode."
4032 nil ; do nothing.
4033 ;; Toggle.
4040 ;; If view-mode is already active, `view-mode-enter' is a nop.
4052 "Insert contents of file FILENAME into buffer after point.
4053 Set mark after the inserted text.
4055 This function is meant for the user to run interactively.
4056 Don't call it from programs! Use `insert-file-contents' instead.
4057 \(Its calling sequence is different; see its documentation)."
4062 "Append the contents of the region to the end of file FILENAME.
4063 When called from a function, expects three arguments,
4064 START, END and FILENAME. START and END are buffer positions
4065 saying what text to write."
4070 "Return most recent backup file for FILENAME or nil if no backups exist."
4071 ;; `make-backup-file-name' will get us the right directory for
4072 ;; ordinary or numeric backups. It might create a directory for
4073 ;; backups as a side-effect, according to `backup-directory-alist'.
4080 tem)
4089 newest))
4092 "Rename current buffer to a similar name not already taken.
4093 This function is useful for creating multiple shell process buffers
4094 or multiple mail buffers, etc."
4102 ;; If the existing buffer name has a <NNN>,
4103 ;; which isn't part of the file name (if any),
4104 ;; then get rid of that.
4110 "Create the directory DIR and any nonexistent parent dirs.
4111 If DIR already exists as a directory, do nothing.
4113 Interactively, the default choice of directory to create
4114 is the current default directory for file names.
4115 That is useful when you have visited a file in a nonexistent directory.
4117 Noninteractively, the second (optional) argument PARENTS says whether
4118 to create parent directories if they don't exist. Interactively,
4119 this happens by default."
4122 nil nil)
4123 t))
4124 ;; If default-directory is a remote directory,
4125 ;; make sure we find its make-directory handler.
4133 create-list)
4140 \f
4143 "Function to use to revert this buffer, or nil to do the default.
4144 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4149 "Function to use to insert contents when reverting this buffer.
4150 Gets two args, first the nominal file name to use,
4151 and second, t if reading the auto-save file.
4156 "Function to check whether a non-file buffer needs reverting.
4157 This should be a function with one optional argument NOCONFIRM.
4158 Auto Revert Mode passes t for NOCONFIRM. The function should return
4159 non-nil if the buffer should be reverted. A return value of
4160 `fast' means that the need for reverting was not checked, but
4161 that reverting the buffer is fast. The buffer is current when
4162 this function is called.
4164 The idea behind the NOCONFIRM argument is that it should be
4165 non-nil if the buffer is going to be reverted without asking the
4166 user. In such situations, one has to be careful with potentially
4167 time consuming operations.
4169 For more information on how this variable is used by Auto Revert mode,
4173 "Normal hook for `revert-buffer' to run before reverting.
4174 If `revert-buffer-function' is used to override the normal revert
4178 "Normal hook for `revert-buffer' to run after reverting.
4179 Note that the hook value that it runs is the value that was in effect
4180 before reverting; that makes a difference if you have buffer-local
4181 hook functions.
4183 If `revert-buffer-function' is used to override the normal revert
4189 "Replace current buffer text with the text of the visited file on disk.
4190 This undoes all changes since the file was visited or saved.
4191 With a prefix argument, offer to revert from latest auto-save file, if
4192 that is more recent than the visited file.
4194 This command also works for special buffers that contain text which
4195 doesn't come from a file, but reflects some other data base instead:
4196 for example, Dired buffers and `buffer-list' buffers. In these cases,
4197 it reconstructs the buffer contents from the appropriate data base.
4199 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4200 to revert from the auto-save file when this is nil. Note that the
4201 sense of this argument is the reverse of the prefix argument, for the
4202 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4203 to nil.
4205 Optional second argument NOCONFIRM means don't ask for confirmation at
4206 all. \(The variable `revert-without-query' offers another way to
4207 revert buffers without querying for confirmation.)
4209 Optional third argument PRESERVE-MODES non-nil means don't alter
4210 the files modes. Normally we reinitialize them using `normal-mode'.
4212 If the value of `revert-buffer-function' is non-nil, it is called to
4213 do all the work for this command. Otherwise, the hooks
4214 `before-revert-hook' and `after-revert-hook' are run at the beginning
4215 and the end, and if `revert-buffer-insert-file-contents-function' is
4216 non-nil, it is called instead of rereading visited file contents."
4218 ;; I admit it's odd to reverse the sense of the prefix argument, but
4219 ;; there is a lot of code out there which assumes that the first
4220 ;; argument should be t to avoid consulting the auto-save file, and
4221 ;; there's no straightforward way to encourage authors to notice a
4222 ;; reversal of the argument sense. So I'm just changing the user
4223 ;; interface, but leaving the programmatic interface the same.
4231 buffer-auto-save-file-name
4236 buffer-auto-save-file-name
4237 buffer-file-name)))
4247 file-name)))
4249 ;; If file was backed up but has changed since,
4250 ;; we shd make another backup.
4254 ;; Effectively copy the after-revert-hook status,
4255 ;; since after-find-file will clobber it.
4258 after-revert-hook))
4263 ;; Get rid of all undo records for this buffer.
4265 ;; Don't make undo records for the reversion.
4268 file-name auto-save-p)))
4271 "File %s no longer exists!"
4273 file-name))
4276 "File %s no longer readable!"
4278 file-name))
4280 ;; Bind buffer-file-name to nil
4281 ;; so that we don't try to lock the file.
4287 ;; Auto-saved file should be read by Emacs'
4288 ;; internal coding.
4291 buffer-file-coding-system-explicit))))
4293 coding-system-for-read
4295 coding-system-for-read)
4297 ;; As a coding system suitable for multibyte
4298 ;; buffer is specified, make the current
4299 ;; buffer multibyte.
4302 ;; This force after-insert-file-set-coding
4303 ;; (called from insert-file-contents) to set
4304 ;; buffer-file-coding-system to a proper value.
4307 ;; Note that this preserves point in an intelligent way.
4311 nil nil t))
4313 nil nil t)))))
4314 ;; Recompute the truename in case changes in symlinks
4315 ;; have changed the truename.
4319 ;; Run after-revert-hook as it was before we reverted.
4323 local-hook)
4326 t))))))
4329 "Recover the visited file--get contents from its last auto-save file."
4334 "Visit file FILE, but get contents from its last auto-save file."
4335 ;; Actually putting the file name in the minibuffer should be used
4336 ;; only rarely.
4337 ;; Not just because users often use the default.
4357 ;; Use insert-directory-safely, not insert-directory,
4358 ;; because these files might not exist. In particular,
4359 ;; FILE might not exist if the auto-save file was for
4360 ;; a buffer that didn't visit a file, such as "*mail*".
4361 ;; The code in v20.x called `ls' directly, so we need
4362 ;; to emulate what `ls' did in that case.
4368 ;; Keep the current buffer-file-coding-system.
4370 ;; Auto-saved file should be read with special coding.
4379 "Recover auto save files from a previous Emacs session.
4380 This command first displays a Dired buffer showing you the
4381 previous sessions that you could recover from.
4382 To choose one, move point to the proper line and then type C-c C-c.
4383 Then you'll be asked about a number of files to recover."
4393 auto-save-list-file-prefix)))
4394 t)
4403 ;; Each line starts with a space
4404 ;; so that Font Lock mode won't highlight the first character.
4413 "Choose one saved session to recover auto-save files from.
4414 This command is used in the special Dired buffer created by
4417 ;; Get the name of the session file to recover from.
4419 files
4425 ;; Read in the auto-save-list file.
4429 ;; Loop thru the text of that file
4430 ;; and get out the names of the files to recover.
4434 ;; This is a pair of lines for a non-file-visiting buffer.
4435 ;; Get the auto-save file name and manufacture
4436 ;; a "visited file name" from that.
4439 ;; If there is no auto-save file name, the
4440 ;; auto-save-list file is probably corrupted.
4453 ;; This pair of lines is a file-visiting
4454 ;; buffer. Use the visited file name.
4464 ;; Ignore a file if its auto-save file does not exist now.
4468 ;; The file contains a pair of line for each auto-saved buffer.
4469 ;; The first line of the pair contains the visited file name
4470 ;; or is empty if the buffer was not visiting a file.
4471 ;; The second line is the auto-save file name.
4479 files
4485 "Kill buffer if confirmed."
4493 "Kill some buffers. Asks the user whether to kill each one of them.
4494 Non-interactively, if optional argument LIST is non-nil, it
4495 specifies the list of buffers to kill, asking for approval for each one."
4503 ; if we killed the base buffer.
4510 "Kill buffers whose name matches the specified regexp.
4511 The optional second argument indicates whether to kill internal buffers too."
4520 \f
4522 "Toggle auto-saving of contents of current buffer.
4523 With prefix argument ARG, turn auto-saving on if positive, else off."
4528 ;; If auto-save is off because buffer has shrunk,
4529 ;; then toggling should turn it on.
4534 buffer-file-name
4536 ;; If -1 was stored here, to temporarily turn off saving,
4537 ;; turn it back on.
4543 buffer-auto-save-file-name)
4546 "Adjust current buffer's auto save file name for current conditions.
4547 Also rename any existing auto save file, if it was made in this session."
4559 "Return file name to use for auto-saves of current buffer.
4560 Does not consider `auto-save-visited-file-name' as that variable is checked
4561 before calling this function. You can redefine this for customization.
4562 See also `auto-save-file-name-p'."
4570 result uniq)
4571 ;; Apply user-specified translations
4572 ;; to the file name.
4576 filename)
4586 filename))))
4591 ;; We truncate the file name to DOS 8+3 limits
4592 ;; before doing anything else, because the regexp
4593 ;; passed to string-match below cannot handle
4594 ;; extensions longer than 3 characters, multiple
4595 ;; dots, and other atrocities.
4600 fn)
4605 "#"
4608 ;; Make sure auto-save file names don't contain characters
4609 ;; invalid for the underlying filesystem.
4611 ;; Don't modify remote (ange-ftp) filenames
4614 result))))
4616 ;; Deal with buffers that don't have any associated files. (Mail
4617 ;; mode tends to create a good number of these.)
4621 file-name)
4622 ;; Eliminate all slashes and backslashes by
4623 ;; replacing them with sequences that start with %.
4624 ;; Quote % also, to keep distinct names distinct.
4633 ;; Generate the file name.
4639 ;; Try a few alternative directories, to get one we can
4640 ;; write it.
4646 ;; Don't modify remote (ange-ftp) filenames
4648 ;; The call to convert-standard-filename is in case
4649 ;; buffer-name includes characters not allowed by the
4650 ;; DOS/Windows filesystems. make-temp-file writes to the
4651 ;; file it creates, so we must fix the file name _before_
4652 ;; make-temp-file is called.
4654 fname))
4656 ;; make-temp-file creates the file,
4657 ;; but we don't want it to exist until we do an auto-save.
4661 file-name)))
4664 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4665 FILENAME should lack slashes. You can redefine this for customization."
4667 \f
4669 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4670 The generated regexp will match a filename only if the filename
4671 matches that wildcard according to shell rules. Only wildcards known
4672 by `sh' are supported."
4674 ;; Copy the initial run of non-special characters.
4677 ;; If no special characters, we're almost done.
4681 j)
4683 result
4704 ;; Found "[^". Insert a `\0' character
4705 ;; (which cannot happen in a filename)
4706 ;; into the character class, so that `^'
4707 ;; is not the first character after `[',
4708 ;; and thus non-special in a regexp.
4713 ;; I don't think `]' can appear in a
4714 ;; character class in a wildcard, but
4715 ;; let's be general here.
4722 i
4735 ;; Shell wildcards should match the entire filename,
4736 ;; not its part. Make the regexp say so.
4738 \f
4741 "Switches for `list-directory' to pass to `ls' for brief listing."
4747 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4749 "Switches for `list-directory' to pass to `ls' for verbose listing."
4754 "Expand wildcard pattern PATTERN.
4755 This returns a list of file names which match the pattern.
4757 If PATTERN is written as an absolute file name,
4758 the values are absolute also.
4760 If PATTERN is written as a relative file name, it is interpreted
4761 relative to the current default directory, `default-directory'.
4762 The file names returned are normally also relative to the current
4763 default directory. However, if FULL is non-nil, they are absolute."
4767 ;; A list of all dirs that DIRPART specifies.
4768 ;; This can be more than one dir
4769 ;; if DIRPART contains wildcards.
4774 contents)
4779 ;; Filter out "." and ".."
4784 name))
4791 this-dir-contents)
4792 this-dir-contents)
4793 contents))))
4795 contents)))
4798 "Display a list of files in or matching DIRNAME, a la `ls'.
4799 DIRNAME is globbed by the shell if necessary.
4800 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4801 Actions controlled by variables `list-directory-brief-switches'
4802 and `list-directory-verbose-switches'."
4806 nil default-directory nil)
4807 pfx)))
4809 list-directory-brief-switches))
4810 buffer)
4823 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4831 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4833 PATTERN is assumed to represent a file-name wildcard suitable for the
4834 underlying filesystem. For Unix and GNU/Linux, the characters from the
4836 the parts of the pattern which don't include wildcard characters are
4837 quoted with double quotes.
4838 Existing quote characters in PATTERN are left alone, so you can pass
4839 PATTERN that already quotes some of the special characters."
4843 ;; DOS/Windows don't allow `"' in file names. So if the
4844 ;; argument has quotes, we can safely assume it is already
4845 ;; quoted by the caller.
4847 ;; We quote [&()#$'] in case their shell is a port of a
4848 ;; Unixy shell. We quote [,=+] because stock DOS and
4849 ;; Windows shells require that in some cases, such as
4850 ;; passing arguments to batch files that use positional
4851 ;; arguments like %1.
4853 pattern
4856 end)
4873 pattern))))
4880 "Program to get the amount of free space on a file system.
4881 We assume the output has the format of `df'.
4882 The value of this variable must be just a command name or file name;
4883 if you want to specify options, use `directory-free-space-args'.
4885 A value of nil disables this feature.
4887 If the function `file-system-info' is defined, it is always used in
4888 preference to the program given by this variable."
4894 "Options to use when running `directory-free-space-program'."
4899 "Return the amount of free space on directory DIR's file system.
4900 The result is a string that gives the number of free 1KB blocks,
4901 or nil if the system call or the program which retrieve the information
4902 fail. It returns also nil when DIR is a remote directory.
4904 This function calls `file-system-info' if it is available, or invokes the
4905 program specified by `directory-free-space-program' if that is non-nil."
4907 ;; Try to find the number of free blocks. Non-Posix systems don't
4908 ;; always have df, but might have an equivalent system call.
4917 nil t nil
4918 directory-free-space-args
4919 dir)))
4920 ;; Usual format is a header line followed by a line of
4921 ;; numbers.
4926 ;; Move to the end of the "available blocks" number.
4929 ;; Copy it into AVAILABLE.
4934 ;; The following expression replaces `dired-move-to-filename-regexp'.
4938 ;; In some locales, month abbreviations are as short as 2 letters,
4939 ;; and they can be followed by ".".
4940 ;; In Breton, a month name can include a quote character.
4953 s "+"
4956 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4957 ;; omits the Kanji characters after month and day-of-month.
4958 ;; On Mac OS X 10.3, the date format in East Asian locales is
4959 ;; day-of-month digits followed by month digits.
4965 ;; The "[0-9]" below requires the previous column to end in a digit.
4966 ;; This avoids recognizing `1 may 1997' as a date in the line:
4967 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4969 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4970 ;; The ".*" below finds the last match if there are multiple matches.
4971 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4972 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4974 ;; vc dired listings provide the state or blanks between file
4975 ;; permissions and date. The state is always surrounded by
4976 ;; parantheses:
4977 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4978 ;; This is not supported yet.
4982 "Regular expression to match up to the file name in a directory listing.
4983 The default value is designed to recognize dates and times
4988 ;; insert-directory
4989 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4990 ;; FULL-DIRECTORY-P is nil.
4991 ;; The single line of output must display FILE's name as it was
4992 ;; given, namely, an absolute path name.
4993 ;; - must insert exactly one line for each file if WILDCARD or
4994 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4995 ;; before the file lines, plus optional text after the file lines.
4996 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4997 ;; allowed.
4998 ;; File lines should display the basename.
4999 ;; - must be consistent with
5000 ;; - functions dired-move-to-filename, (these two define what a file line is)
5001 ;; dired-move-to-end-of-filename,
5002 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5003 ;; dired-insert-headerline
5004 ;; dired-after-subdir-garbage (defines what a "total" line is)
5005 ;; - variable dired-subdir-regexp
5006 ;; - may be passed "--dired" as the first argument in SWITCHES.
5007 ;; Filename handlers might have to remove this switch if their
5008 ;; "ls" command does not support it.
5010 "Insert directory listing for FILE, formatted according to SWITCHES.
5011 Leaves point after the inserted text.
5012 SWITCHES may be a string of options, or a list of strings
5013 representing individual options.
5014 Optional third arg WILDCARD means treat FILE as shell wildcard.
5015 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5016 switches do not contain `d', so that a full listing is expected.
5018 This works by running a directory listing program
5019 whose name is in the variable `insert-directory-program'.
5020 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5022 When SWITCHES contains the long `--dired' option, this function
5023 treats it specially, for the sake of dired. However, the
5024 normally equivalent short `-D' option is just passed on to
5025 `insert-directory-program', as any other option."
5026 ;; We need the directory in order to find the right handler.
5031 wildcard full-directory-p)
5036 ;; Read the actual directory using `insert-directory-program'.
5037 ;; RESULT gets the status code.
5039 ;; putting text property `dired-filename, decode one
5040 ;; bunch by one to preserve that property.
5042 ;; This is to control encoding the arguments in call-process.
5046 default-file-name-coding-system))))
5049 ;; Run ls in the directory part of the file pattern
5050 ;; using the last component as argument.
5057 shell-file-name nil t nil
5058 "-c"
5060 ""
5062 insert-directory-program
5063 " -d "
5065 switches
5067 " -- "
5068 ;; Quote some characters that have
5069 ;; special meanings in shells; but
5070 ;; don't quote the wildcards--we want
5071 ;; them to be special. We also
5072 ;; currently don't quote the quoting
5073 ;; characters in case people want to
5074 ;; use them explicitly to quote
5075 ;; wildcard characters.
5077 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5078 ;; directory if FILE is a symbolic link.
5080 insert-directory-program nil t nil
5084 ;; Split the switches at any spaces so we can
5085 ;; pass separate options as separate args.
5087 ;; Avoid lossage if FILE starts with `-'.
5095 file))))))))
5097 ;; If we got "//DIRED//" in the output, it means we got a real
5098 ;; directory listing, even if `ls' returned nonzero.
5099 ;; So ignore any errors.
5112 ;; The first time ls returns an error,
5113 ;; find the version numbers of ls,
5114 ;; and set insert-directory-ls-version
5115 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5116 ;; is equal or if the info cannot be obtained.
5117 ;; (That can mean it isn't GNU ls.)
5127 comparison)
5143 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5147 ;; If `insert-directory-program' failed, signal an error.
5149 ;; Delete the error message it may have output.
5151 ;; On non-Posix systems, we cannot open a directory, so
5152 ;; don't even try, because that will always result in
5153 ;; the ubiquitous "Access denied". Instead, show the
5154 ;; command line so the user can try to guess what went wrong.
5159 insert-directory-program
5161 file result)
5162 ;; Unix. Access the file to get a suitable error.
5169 ;; The following overshoots by one line for an empty
5170 ;; directory listed with "--dired", but without "-a"
5171 ;; switch, where the ls output contains a
5172 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5173 ;; We take care of that case later.
5181 error-lines)
5182 ;; Find all the lines that are error messages,
5183 ;; and record the bounds of each one.
5190 ;; Now read the numeric positions of file names.
5197 error-lines))
5200 error-lines)))
5202 ;; End is followed by \n or by " -> ".
5204 ;; It seems that we can't trust ls's output as to
5205 ;; byte positions of filenames.
5211 ;; Take care of the case where the ls output contains a
5212 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5213 ;; and we went one line too far back (see above).
5218 ;; Now decode what read if necessary.
5220 file-name-coding-system
5221 default-file-name-coding-system
5223 coding-no-eol
5224 val pos)
5228 ;; If no coding system is specified or detection is
5229 ;; requested, detect the coding.
5243 ;; Force no eol conversion on a file name, so
5244 ;; that CR is preserved.
5252 ;; Try to insert the amount of free space.
5255 ;; First find the line to put it on.
5259 ;; Replace "total" with "used", to avoid confusion.
5265 "Convert `ls --dired' file name position value POS to a buffer position.
5266 File name position values returned in ls --dired output
5267 count only stdout; they don't count the error messages sent to stderr.
5268 So this function converts to them to real buffer positions.
5269 ERROR-LINES is a list of buffer positions of error message lines,
5270 of the form (START END)."
5274 pos)
5278 "Insert directory listing for FILE, formatted according to SWITCHES.
5280 Like `insert-directory', but if FILE does not exist, it inserts a
5281 message to that effect instead of signaling an error."
5284 ;; Simulate the message printed by `ls'.
5288 "Functions to call with no arguments to query about killing Emacs.
5289 If any of these functions returns nil, killing Emacs is cancelled.
5290 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5294 "How to ask for confirmation when leaving Emacs.
5295 If nil, the default, don't ask at all. If the value is non-nil, it should
5296 be a predicate function such as `yes-or-no-p'."
5304 "Offer to save each buffer, then kill this Emacs process.
5305 With prefix arg, silently save all file-visiting buffers, then kill."
5314 ;; process-list is not defined on VMS.
5316 active)
5325 ;; Query the user for other things, perhaps.
5332 "Offer to save each buffer, then kill the current connection.
5333 If the current frame has no client, kill Emacs itself.
5335 With prefix arg, silently save all file-visiting buffers, then kill.
5337 If emacsclient was started with a list of filenames to edit, then
5338 only these files will be asked to be saved."
5346 \f
5347 ;; We use /: as a prefix to "quote" a file name
5348 ;; so that magic file name handlers will not apply to it.
5352 file-name-handler-alist))
5354 ;; We depend on being the last handler on the list,
5355 ;; so that anything else which does need handling
5356 ;; has been handled already.
5357 ;; So it is safe for us to inhibit *all* magic file name handlers.
5366 default-directory))
5367 ;; Get a list of the indices of the args which are file names.
5370 ;; The first six are special because they
5371 ;; return a file name. We want to include the /:
5372 ;; in the return value.
5373 ;; So just avoid stripping it in the first place.
5380 ;; `identity' means just return the first arg
5381 ;; not stripped of its quoting.
5383 ;; `add' means add "/:" to the result.
5385 ;; `quote' means add "/:" to buffer-file-name.
5387 ;; `unquote-then-quote' means set buffer-file-name
5388 ;; temporarily to unquoted filename.
5390 ;; List the arguments which are filenames.
5398 ;; For all other operations, treat the first argument only
5399 ;; as the file name.
5401 method
5402 ;; Copy ARGUMENTS so we can replace elements in it.
5406 ;; Strip off the /: from the file names that have it.
5414 "/"
5430 res))
5433 \f
5434 ;; Symbolic modes and read-file-modes.
5437 "Convert CHAR to a who-mask from a symbolic mode notation.
5438 CHAR is in [ugoa] and represents the users on which rights are applied."
5446 "Convert CHAR to a right-mask from a symbolic mode notation.
5447 CHAR is in [rwxXstugo] and represents a right.
5448 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5455 ;; Rights relative to the previous file modes.
5466 "Convert a right string to a right-mask from a symbolic modes notation.
5468 WHO-MASK is the mask number of the users on which the rights are to be applied.
5469 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5475 char-right)
5482 num-rights
5486 op char-right)))
5487 num-rights))
5490 "Convert symbolic file modes to numeric file modes.
5491 MODES is the string to convert, it should match
5494 notation.
5495 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5508 num-who num-modes)
5511 num-modes)))
5514 "Read file modes in octal or symbolic notation.
5515 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5516 ORIG-FILE is the original file of which modes will be change."
5525 \f
5550 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5551 ;;; files.el ends here